How do I get started with Hololight Stream SDK for Unreal?
Set up your Unreal Engine project with Hololight Stream, configure the demo scene, and run your first interactive connection
Download Trial Version |
Download Clients |
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.
Supported Unreal Engine versions |
||
Unreal Engine 5.3 | Unreal Engine 5.4 | Unreal Engine 5.5 |
Before integrating the Hololight Stream SDK into your project, review the system, software, and network recommendations and requirements.
Requirements and recommendations |
||
System | Software | Network |
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 the Epic Games Launcher and run the installation wizard.
- Start the Epic Games Launcher.
- Sign in or create an Epic Account.
- After a successful Login, select Unreal Engine in the left sidebar.
- Select Library in the top bar.
- Select the yellow + button next to Engine Versions.
- Select the version number and select 5.5.4.
- Select Install and accept the End User Agreement.
- Choose the install location (default is
C:\Program Files
). - Once installed, select Launch.
Create a project
- Launch the Unreal Engine 5.5.4.
- In the Unreal Project Browser select Games, name your project and select Create.
- After the project opens, close it and continue with the next steps.
Download and setup the Hololight Stream SDK
- Download the Hololight Stream SDK Trial for Unreal Engine 5.5.
- Open File Explorer in Windows.
- Navigate to the downloaded .zip, right-click it, and select Extract All.
- After extracting, open the new folder.
- Copy the entire folder called HololightStream.
- Navigate to your Unreal Projects Folder (default:
C:\Users\Documents
). - Double-click your project folder.
- Create a folder named Plugins, if there isn't one already.
- Open the newly created folder.
- Paste the HololightStream folder you copied earlier here.
Activate Hololight Stream in your 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 to activate Hololight Stream (if not already checked).
- When prompted, restart the project.
Open the Hololight Stream Unreal demo scene
- Select Content Drawer in the bottom left corner.
- In the Content Drawer, select the Plugins folder on the left side.
- If the Plugins folder isn't visible:
- Select Settings on the top right corner of the Content Drawer.
- Check Show Plugin Content.
- In the Plugins folder navigate to:
Plugins > Hololight Stream Content > VR Template > Maps - Double-click VR Template Map and wait for the map to load.
Project settings configuration
- Select Settings in the top right corner of the Unreal Editor and select Project Settings.
- Under Maps and Modes, ensure 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. Verifying the configuration ensures a smooth startup and helps prevent common issues.
- Select 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
- Select the three dots next to the play button at the top.
- Select 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 your PC's IP adress:
-
- Press 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 the Hololight Stream client on your device.
- Enter your PC's IP adress in the client.
- Select 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