Preparing for Mod Creation

These are some initial steps you will need to take in order to start creating mods for CollabXR.

Creating a Unity Project

You will want to create a new Universal Render Pipeline project in Unity 6000.0, to best ensure mod compatibility with CollabXR. Mods built in other versions of Unity may be forward-compatible, but are unlikely to be backwards-compatible. The patch number should not matter.

Configure Unity for XR

Without this step, you may notice odd, unintended behavior with your mods, such as

Not staying in place when moving the camera around.
Colliders being off-center.
Only showing up in 1 of the 2 eye viewports.

This is because CollabXR is an XR application, and XR rendering differs from traditional rendering in some ways. To fix these issues, you must add XR to your Unity project.

Add the Meta XR SDK package from the Unity Asset Store.
Add the Oculus XR Plugin (should be searchable in the Unity Package Registry in editor).
In Project Settings > XR Plug-in Management > Android Settings, check the box with Oculus in Plug-in providers.
Fix any remaining outstanding issues that the Meta XR Tools window prompts you to.

Installing Mod Packager

The CollabXR Mod Packager is necessary to bundle your content into Asset Bundles with additional metadata for distribution. We recommend reading up on Asset Bundles to understand to their limitations before creating your mod.

Once installed, while in Unity Editor, click CollabXR Modding Tools > Open Mod Packager. Upon first opening, the Mod Packager will build a database of all assets in your project. This may take a few minutes.

Afterwards, a small window titled “CollabXR Mod Packager” should pop up. This means the packager is fully set up! Close it for now until you are ready to upload.

Mod Extras

Because Asset Bundles cannot contain code, we created the CollabXR Mod Extras package. This package provides various components you can add to your mods, which will retain or add functionality when spawned into CollabXR.