Develop
Develop
Select your platform

Meta XR Simulator JSON Format Rooms

Updated: Aug 28, 2024
Outdated XR Simulator Version
This information applies to an older version of the XR Simulator, for new projects use the Standalone XR Simulator which supports any OpenXR application.

Overview

Built-in rooms or rooms created using the Synthetic Environment Builder are ideal for development and testing, offering data for passthrough, scene, and depth. However, if you only require scene data, lightweight JSON-based rooms are the perfect solution for your needs.

Built-in JSON format rooms

Meta XR Simulator ships with two built-in rooms in JSON format. The JSON files for these rooms are located at: MetaXRSimulator/config/anchors/scene_anchors_room_with_furnitures.json and MetaXRSimulator/config/anchors/scene_anchors_empty_room.json. You can load them into Meta XR Simulator by following these steps:
  1. To use Scene JSON in the Meta XR Simulator go to Mixed Reality. Go to Meta XR Simulator settings
  2. Click the button and select the new scene JSON file.
  3. Click the Load button.
  4. Click the Exit Simulator button. The scene will now stop and the simulator window will correctly disappear.
  5. Play the game again. When the simulator window appears, you will see your new scene now appearing in the simulator. Enable scene API using Meta XR Simulator
When SES is running, you will see both the SES environment, and the data from the scene JSON file at the same time. To see only the data from your scene JSON, do the following:
  1. Exit the simulator.
  2. Stop the SES server, then press play.
You will now see the scene JSON data independently of the SES environment.
Stop scene JSON
To stop scene JSON, you will need to go to %user%\AppData\Roaming\MetaXR\MetaXrSimulator\persistent_data.json to remove scene_anchor_data from the JSON.

Export room setup from Quest device

Alternatively, you can set up a room using your Quest device by navigating to Settings > Physical Space > Space Setup > Set Up and exporting it into a JSON file for use in Meta XR Simulator. For details, please refer to Scene Recorder.

Create your own JSON rooms

If you wish to construct a JSON room, it is necessary to understand the JSON schema. Please refer to Meta XR Simulator Room JSON Syntax for more details.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon