Tutorial: Running ImmVisClientLibraryUnity Samples

This tutorial covers how to set up and run the ImmVis Unity client library samples.

Requirements

Operating system: Windows, Linux, or macOS
Unity 2020.3.8f1. We recommend the usage of Unity Hub to perform the installation.
Optional but recommended: Visual Studio Code. Follow these instructions to make Unity work with Visual Studio Code. Some operating systems might have problems with Intellisense (code auto-completion) and if that is your case, consider installing these softwares:
- .NET Framework 4.7.1 (Windows)
- .NET 5.0 (Linux, Mac OS)
- Mono (Linux).

Follow the setup steps from ImmVisServerPython to set up and run the server project.
Clone ImmVisClientLibraryUnity or download its source code
Open ImmVisClientLibraryUnity project using Unity or Unity Hub
If Unity shows errors when opening the project, please consider using the Package Manager to install the XR Interaction Toolkit. Please note that you might need to select to search inside the Unity Registry for the packages. If XR Interaction Toolkit is not appearing on your Package Manager, consider enabling Enable Preview Packages inside the package manager advanced settings.
On Unity Project tab, navigate to folder Assets/ImmVisClientLibraryUnity/Examples to find the samples included with this client library:
- BasicUsage: simple Unity scene that shows how to use the ImmVisGrpcClientManager prefab
- DataAnalysis: an advanced sample that shows a VR application that uses ImmVis to create an interactive scatterplot
Open the main scene inside the selected sample folder (ExampleScene.unity for BasicUsage or DataAnalysis.unity for DataAnalysis). If Unity displays a TextMesh Pro dialog, click on Import TMP Essentials.
Run the ImmVisServerPython as described here
Go back to Unity and press the "play" button to run the sample.