Unity 2022.3.15f1 or higher (Unity 6+ is recommended)
A Meta Quest 2, Quest Pro, or Quest 3.
PC: You can run the Unity Editor using Link if you are on a PC. Keep in mind that the Passthrough image only appears in the headset. For Scene API, room data must exist before connecting the device. Disconnect Link, run Room Setup on your Quest, then reconnect Link.
Mac: If you are on a Mac, you must build an apk and deploy it to your device. You can use our MRUK.prefab to load an artificial room prefab in Editor.
Because MRUK is based on Scene API, first ensure you are familiar with the concepts.
Prerequisites
Before you begin working with Scene, do the following:
Download and install the MR Utility Kit package (if you installed the Meta XR All-in-One SDK you can skip this step):
Either add to your assets from the Unity Asset store, then select Packages: My Assets from the Unity Package Manager, click on Meta MR Utility Kit and install.
Or download from Meta as a tarball, extract it to your computer, choose Add package from disk from the Unity Package Manager, and select the package.json you unzipped.
Use OVRCameraRig and configure permissions
In order for a Unity project to use Scene, you need to enable permissions which allow access to Scene data. You can modify permissions using the OVRCameraRig prefab.
Create a new Unity scene, or open an existing one from your project.
Remove the Main Camera from your scene.
Add the OVRCameraRig prefab. Search for OVRCameraRig in the Project tab, and drag it into your scene.
If you use the Project Setup Tool, you will receive automatic warnings and suggested fixes for the permissions.
To set permissions manually, select OVRCameraRig in the Hierarchy tab. In the Inspector tab, under the OVRManager component, do the following:
Under the Quest Features > General tab, find Scene Support and select either Required or Supported.
When selecting Scene Support, Anchor Support should automatically be enabled.
Further below, find the section Permission Requests On Startup, and toggle the Scene checkbox. This will request the permission when the app starts.
In the toolbar, select Meta > Tools > Update AndroidManifest.xml or Create AndroidManifest.xml if you don’t already have one. The AndroidManifest.xml is updated or created to let the OS know that your app would like to use the Scene permission. You can locate AndroidManifest.xml on the Project tab through search or in the folder Assets/Plugins/Android/AndroidManifest.xml.
The Spatial Data Permission page contains further information and guidelines on how to manage permissions.
Creating a new scene
In addition to the OVRCameraRig, ensure your scene contains the MRUK prefab. The MRUK class is a singleton that should exist only once within the scene. When using Scene API data, you must wait until the room has loaded, or your app likely will not function properly. This loading event is conveyed by MRUK’s SceneLoadedEvent event. For simplicity, this is exposed in the Inspector for you to drop your public functions.
To properly initialize your own game objects:
In your code, add public initialization functions:
Click the “+” to add a new field to this Scene Loaded Event list.
Drag the game object with your initialization code to the empty field, selecting your component and pointing to your function.
Keep in mind that list order matters; if you have initialization dependencies between scripts, make sure that the functions you’d like to execute first are at the top of the event list.
Note: You do NOT need OVRSceneManager in your scene, MRUK serves as a replacement for it. In v60 there is an issue that can cause your camera to flicker back and forth when both are used together.
Press play
A benefit of MRUK is that it can fall back to imitation anchor data during play in Editor mode, allowing for quicker iteration than building an apk. For example, when pressing Play on the MRUKBase scene, you can see a list of anchors and a visualization of the room:
(The room choice is random by default, and specified on the MRUK prefab)
For other development options in Editor, you can also use Link for your real room, or the Meta XR Simulator with simulated rooms.
