Skip to main content

Setup

Prerequisites / Dependencies​

  • Unity version 2021.18.18f1 (Other versions may work, but this is the one that we explicitly support at the moment)

We'll install other dependencies later using the Foundry setup wizard.

Installing Foundry​

The recommended way to install foundry packages is through importing our GitHub repos.

To import foundry core, got to the Unity Package Manager, click the add button from the top left corner, and select "Add package from git URL", then paste in this:

https://github.com/CyberHubXR/FoundryCore.git?path=Assets/Package

This can be done for any foundry repo, just replace the url of the package and make sure to keep the ?path=Assets/Package at the end.

We also need to import a network provider, so repeat the above steps but with this url:

https://github.com/CyberHubXR/FusionNetworkProvider.git?path=Assets/Package

After you have both those installed, please follow the steps inside the setup wizard to finish the installation. This should pop up automatically but if it doesn't it can be opened from the menus at Foundry -> Setup Wizard

Networking

Foundry is a a networked framework at heart, and thus requires a networking solution to be installed, currently our most stable module for this is our Fusion Networking for Foundry package. This package is a wrapper around the Fusion networking framework, and provides a simple interface for Foundry users to use, while still allowing you to use Fusion specific features if you wish.

For it to work you'll need to install these two libraries into your project, either through these links or the ones in the setup wizard.

Follow the provided docs provided by Photon for each to get them set up, including setting up network keys and you should be good to go for networking.

XR Manager

Foundry has a simple Desktop fallback mode for when an XR runtime is not found, to enable this just make sure that in the XR Package Manager settings auto-initialize is disabled to allow our systems to handle that.

Additionally make sure to Enable openXR under the XR Runtimes and make sure to add the interaction profiles for the devices you plan to support.

Samples​

Many of Foundry's core features are pre-implemented in some prefabs provided in the package samples.

After installation head back into your package manager and install the samples listed under foundry core and use those for testing.

Open up the offline scene and add it to your build settings (CTRL+SHIFT+B) and then click “add open scenes” button.

Then do the same for the online scene.

Then go back to the offline scene press play and it should all work.

You will join a blank environment with a blue table and a simple interaction prefab.

Build it to an apk or exe and send it to another person. If you both press play you will end up in a multiplayer scene together with voice chat and synced interactions.

Troubleshooting​

If you cant load from offline to online ensure you completed the openXR step and the fusion key step.

If you and another person cannot load into the same lobby ensure you have the same fusion key and voice key (will be in the build anyway) and ensure your on the same region / fixed region.

Finally if nothing works, join our discord and ping @Staff