Quickstart
Let's get started with the Spatial Reality Display (SR Display) app in Unreal Engine!
Prerequisites
-
Set up your SR Display, if not, see: Setup SR Display, Setup SR Display Settings
- Connect your SR Display to PC
- Configure the settings of your SR Display
- Install SR Display Settings
-
Installed Epic Games Launcher and Unreal Engine, see: Installing Unreal Engine.
- Now we support 4.26, 4.27, 5.0 and 5.1
Note
Only one SR Display app can be run at a time. Additional apps will fail to launch.
Install SR Display Plugin and Templates
- Download latest SR Display Plugin and SR Display Templates from Download Page.
-
Install SR 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_4.26\Engine\Plugins\Developer\.
-
Install SR 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_4.26\Templates\.
Build and run the SR Display app
- Download Sample Projects.
- Unzip SRDisplaySamples_x.y.z.nnnnn.zip into your any folder.
-
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 SR Display Plugin.
-
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.
-
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.
-
Run "MainMenu" via VR Preview mode.
Select VR Preview from the drop down menu next to Play button.