Building CollabXR

If you would like to use CollabXR for large-scale or secure applications, you may need to recompile it with your own API keys.

These steps will walk you through cloning the CollabXR repository and getting it set up on your system.

Prerequisites

Install Unity

You will need to install Unity Hub in order to set up the CollabXR project. From their site, install Unity hub and select a license. Installing the Unity Editor is covered later in this guide.

Git LFS

Ensure Git LFS is installed before cloning the repository in order to pull necessary binary files.

Project Setup

Getting the Unity Project

  1. Clone the CollabXR repository. Take note of where you installed it!

  2. Setup git submodules. If cloned with Github Desktop, this has been done automatically. Otherwise, run $ git submodule update --init --recursive in the project directory.

  3. Ensure Git LFS files are pulled by running these commands in the project directory: $ git lfs install, then $ git lfs pull

  4. Add the project to Unity Hub and install the associated editor version. You may need the Android Build Support and Windows Build Support (IL2CPP) editor modules in order to compile the project.

Getting Photon Fusion

  1. Create a Photon account (required to download their SDKs).

  2. Download Photon Fusion 2.0.12.

  3. Download Fusion Physics 2.0.5.

  4. Download Unity Voice SDK 2.6.3.

You should now have 3 Unity package files.

Resolving Errors

  1. Open the Unity Project in unsafe mode.

  2. Go to Assets > Import Package > Custom Package. Then add the 3 Photon Unity Package Files one at a time. Approve any “Script Updating Consent” windows that appear in this step.

  3. You may get 1 or more MetaXR errors. Ignore the error about passthrough enabled. Anything else you may fix.

Photon Fusion and API Keys

Photon Fusion and Photon Voice App IDs are required for base CollabXR functionality. Free plans are available for up to 20 concurrent users for testing and development.

  1. In Photon App Settings, enter your Fusion App ID and Voice App ID into their respective fields.

  2. Open the PUN Wizard via Window > Photon > Unity Networking > PUN Wizard. Then, click PUN setup, and paste your Photon App ID and Photon Voice ID.

  3. Optionally add credentials for Cesium Ion (for geospatial integration) at Assets/Keys/Resources/ion.cesium.com and OpenSky (for live ADSB data on top of geospatial integration) at Assets/Keys/Resources/OpenSky API.

  4. Finally, open the Photon Fusion Hub via Tools > Fusion > Fusion Hub. This should resolve any last errors you may have.

Making a Build

See Unity’s documentation on creating a build. We have some pre-made Build Profiles that should already be configured. However, for Android platforms, users may need to change their Bundle ID and Bundle Version Code inside the Player Settings. See Unity’s documentation on building for Android for more information.