Quickstart

Let's get started with the Spatial Reality Display app in Unreal Engine!

Prerequisites

If you are using Unreal Engine version 5.3 or later, an error will occur when you open a sample project.

To solve this problem, you need to update the Plugin in the sample project to 5.3 or later. See When the Spatial Reality Display plugin is placed in the project plugin search path on the Updating Unreal Engine page for instructions on how to update your plugin.

Only one Spatial Reality Display app can be run at a time. Additional apps will fail to launch.

Install Spatial Reality Display Plugin and Templates

  1. Download latest Spatial Reality Display Plugin and Spatial Reality Display Templates from Download Page.

  2. Install Spatial Reality Display Plugin.

    Unzip srd-ue-plugin-4.XX-x.y.z.nnnnn.zip and copy extracted folder SRDisplayPlugin into one of the search paths for Plugins, either in your project or in the Engine itself. See here for instructions on installing Plugins. For simplicity of explanation, we assume you have copied SRDisplayPlugin into C:\Program Files\Epic Games\UE_x.xx\Engine\Plugins\Marketplace\. (If there is no Marketplace folder, create one.)

  3. Install Spatial Reality Display Templates.

    Unzip srdisplay-ue-templates-x.y.z.nnnnn.zip and copy extracted folders TP_SRDisplay and TP_SRDisplayBP into the Engine's Templates directory. See here for instructions on installing Templates. For simplicity of explanation, we assume you have copied TP_SRDisplay and TP_SRDisplayBP into C:\Program Files\Epic Games\UE_x.xx\Templates\.

Build and run the Spatial Reality Display app

  1. Download Unreal Engine Samples Project of Spatial Reality Display from Download Page.

  2. Unzip SRDisplaySamplesProject_x.y.z.nnnnn.zip into your any folder.

  3. Open the samples with your UE Editor.

    Right click SRDisplaySamples.uproject and select "Switch Unreal Engine version..." from context menu.

    A dialog window called "Select Unreal Engine Version" will open. Select the Engine you have installed on the Spatial Reality Display Plugin.

    Select Unreal Engine Version Dialog

  4. Open SRDisplaySamples project.

    Double click SRDisplaySamples.uproject and open it with UE Editor. A dialog window called "Missing SRDisplaySamples Modules" will open. Click "Yes" to start rebuilding the c++ source codes in the sample project.

    Missing SRDisplaySamples Modules Dialog Window

  5. Open the sample map "MainMenu".

    It may take some time to build the source code. The Editor and the sample map "MainMenu" will open automatically after building completes.

    Sample map of MainMenu

  6. Run "MainMenu" via VR Preview mode.

    Select VR Preview from the drop down menu next to Play button.

    drop down menu of MainMenu