How do I get started with Hololight Stream SDK for Unreal?
Learn to set up your Unreal Engine project with Hololight Stream, configure the demo scene, and run your first interactive connection.
Setup
Download Trial Version |
Download Clients |
Unreal Engine 5.3 | Unreal Engine 5.4 | Unreal Engine 5.5 |
System | Software | Network |
This article guides you through the complete process of setting up a project in Unreal Engine, installing Hololight Stream, configuring the demo scene, and establishing your first connection — including interactive functionality.
Install Unreal Engine
You can download and install Unreal Engine by using the Epic Games launcher. The Epic Games Launcher functions as a central location for your Unreal Engine versions and projects. For this Guide we will work with Unreal Engine 5.5.
- Download Epic Games Launcher and run the installation wizard
- Start the Epic Games Launcher
- Sign in or create an Epic Account
- After a successful Login, click Unreal Engine in the left sidebar
- Click Library in the top bar
- Click the yellow + button next to Engine Versions
- Click the version number and select 5.5.4
- Click install and accept the End User Agreement
- Choose the install location - default is C:\Program Files
- Once installed, click launch
Create a Project
- Launch the Unreal Engine 5.5
- In the Unreal Project Browser select Games > Name your project > Create
- Unreal Engine begins to create the project
- After the project opened up - close it again and continue with the next steps
Download and setup Hololight Stream
- Download Hololight Stream SDK Trial for Unreal Engine 5.5
- Open Windows File Explorer
- Navigate to the downloaded .zip, right click the file and click "Extract All"
- After extracting the .zip open the newly created Folder
- Copy the entire folder called "HololightStream"
- Navigate in the windows explorer to your Unreal Projects Folder. Default location is C:\Users\Documents
- Double Click your Project Folder
- Create a folder named "Plugin", if there isn't one already
- Open the newly created Folder
- Paste "HololightStream" you copied earlier here
Activate Hololight Stream in the Unreal Project
- Open your project within the Epic Games Launcher
- Navigate in the top left corner to Edit > Plugins
- Search for "Hololight Stream"
- Check the box, if not already checked, to activate Hololight Stream
- A prompt will show up to restart the project
- Restart now
Open the Hololight Stream Unreal Demo Scene
- Click Content Drawer in the bottom left corner
- Click the folder Plugins on the left side of your Content Drawer
- If there is no plugin folder showing up:
- Click Settings on the top right corner of your Content Drawer
- Check the box "Show Plugin Content"
- In the Plugins folder click through the folder Plugins > Hololight Stream Content > VR Template > Maps
- Double Click the "VR Template Map"
- Wait for the map to load
Project Settings Configuration
- Click Settings in the top right corner of the Unreal Editor and open Project Settings
- Under Maps and Modes make sure the Game Instance Class is set to GameInstance
- Under Enhanced Input add 4 Array elements
- Add all Input Mapping Context files to the Arrays
Blueprint Settings Configuration
These settings are enabled by default, but it’s a good idea to double-check them before proceeding. Verifying the configuration ensures a smooth startup and helps prevent common issues when launching your application.
- Click the Blueprint Icon in the top left of the editor
- Navigate to World Override Gamemode > Select GameModeBase Class > Select VRGameMode
Run your Project for the first time
- Click the three dots right next to the play button at the top
- Click VR Preview
Connect with your XR Device
After you finish setting up Hololight Stream and starting the VR Preview. If you did everything correctly, you will now be able to connect to the application with Hololight Stream Client.
- Download and Install Hololight Stream Client on your XR device.
- Make sure your PC and your XR device are in the same network
- Get the PC's IP adress by Pressing Windows Key > Enter "Command Prompt" > Open command prompt > Type "ipconfig" > Press Enter > Look for IPv4
- The IPv4 is your IP adress and looks something like this: 192.168.110.84.
- Open Hololight Stream Client on your device.
- Type the IP adress of your PC in the Client.
- Hit Connect.
Summary
Use this guide to set up a Unreal Engine project with Hololight Stream. For more detailed instructions, please refer to the documentation included in the Hololight Stream SDK for Unreal folder.
If you need additional help, don’t hesitate to contact us or explore the Troubleshooting section