Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 2.91 KB

tutorial_integrating_library.md

File metadata and controls

25 lines (21 loc) · 2.91 KB

Tutorial: Integrating ImmVisClientLibraryUnity to a Unity project

This tutorial covers how to integrate the ImmVisClientLibraryUnity library into a Unity project.

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:

Steps

  1. Follow the setup steps from ImmVisServerPython to set up and run the server project.
  2. Open your project and use one of the following alternatives to import the ImmVisClientLibraryUnity:
    • Download the latest version of ImmVisClientLibraryUnity.unitypackage available on the Releases page and importing the asset into your project
    • Download or clone this repository and copy the Assets/ImmVisClientLibraryUnity folder to the Assets folder of your project
  3. Use the Package Manager to install the XR Interaction Toolkit package to your project. Please note that you might need to select to search inside the Unity Registry for these packages. If XR Interaction Toolkit is not appearing on your Package Manager, consider enabling Enable Preview Packages inside the package manager advanced settings.
  4. Follow these steps to check if everything worked fine:
    • Run the ImmVisServerPython as described here
    • On the Unity Project tab, navigate to the Basic Usage sample folder (Assets/ImmVisClientGrpcUnity/Examples/BasicUsage)
    • Open the main scene of the sample (ExampleScene.unity). If Unity displays a TextMesh Pro dialog, click on Import TMP Essentials.
    • Press play to run the sample and check if any messages appeared on the Unity console.
  5. You are now ready to use the ImmVis Framework inside your Unity project, including the ImmVisGrpcClientManager prefab (Assets/ImmVisClientGrpcUnity/Prefabs/ImmVisGrpcClientManager.unity). Check out the samples inside Assets/ImmVisClientGrpcUnity/Examples to understand how to use the framework.