This project is an example of a client library implementation for the ImmVis Framework.

Samples

We included two samples inside this client library:

• Basic Usage: 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

Please refer to the tutorials below to run the samples.

Tutorials

• Running ImmVisClientLibraryUnity Samples
• Integrating ImmVisClientLibraryUnity to a Unity project

Supported Platforms

Developers can use this library to create games/applications for the following platforms:

• Windows
• Linux
• macOS
• Android (ARM and x86)

If you need support for iOS, please consider downloading the Grpc.Core Package 2.26.0 and copy the iOS binaries to the Assets/ImmVisClientLibraryUnity/Plugins/Grpc.Core/native/ios folder.

Development Setup

Recommended tools for development:

• 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).

Contributing

Our contribution model is similar to the one described on https://github.com/firstcontributions/first-contributions, with the difference that members of IMDAVI don't need to create a fork from this repository, only create a branch here to submit their pull-requests.