How do I get started with Hololight Stream SDK for Unity?

Setup

If your project already has Hololight Stream installed, you need to remove any files left over from previous versions before installing the newest version. When you’ve removed all files from older versions of Hololight Stream, you can continue on to installing the latest version.

1. In the Unity Editor menu bar select Window > Package Manager.
2. Find any Hololight Stream packages and select Remove.

Before working with Hololight Stream, please see our supported Unity versions below. Hololight Stream may support newer versions of Unity, but they are not fully tested.

Install Unity and create a project

This guide shows you the process of installing Hololight Stream into a Unity Template project and connect to that project in the editor. In order to proceed you will need Unity Hub.

1. Install Unity Hub on your Windows computer and log in or create an account.
2. Click “Installs” in the left sidebar, then click “Install Editor” in the top right corner.
   
3. Choose a Unity Editor version that Hololight Stream supports and click “Install.”
4. During the installation, a Visual Studio pop-up might appear.
5. Click “Continue” and follow the instructions to reach the install window.
6. Check the box for “Game development with Unity” and click “Install.”
   
   
7. After Unity and Visual Studio are installed, you can create your project.
8. Click “Projects” in the left sidebar and select New Project > Core > VR Core > Download Template.
   
   
9. Unity will now create the project. This may take a few minutes.

First Installation

1. Open your Unity VR Core template, if not already open
2. Make sure your Unity Version is supported by Hololight Stream
3. Select Window > Package Manager.
   
4. In the Package Manger, select + > Add package from tarball.
   
5. Find the Hololight Stream Folder you downloaded and unzipped earlier
6. Open the "Packages" folder. Select the file "com.hololight.stream-<version>.tgz" where <version> is the current version of Hololight Stream.

Configure the project

1. Select Edit > Project Settings > XR Plug-in Management.
   
2. Check the box next to Initialize XR on Startup.
3. Under Plug-in Providers, check the box next to Hololight Stream.
4. Make sure only Hololight Stream has a checked box
5. Select File > Build Settings
6. On the Build Settings panel, make sure to set the following options:

Run Hololight Stream for the first time

After you finish setting up Hololight Stream, select Play. If you did everything correctly, you will now be able to connect to the application with Hololight Stream Client.

1. Download and Install Hololight Stream Client on your XR device.
2. Make sure your PC and your XR device are in the same network
3. Get the PC's IP adress by Pressing Windows Key > Enter "Command Prompt" > Open command prompt > Type "ipconfig" > Press Enter > Look for IPv4
   
   
4. The IPv4 is your IP adress and looks something like this: 192.168.110.84.
5. Hit Play in your Unity Editor.
6. Open Hololight Stream Client on your device.
7. Type the IP adress of your PC in the Client.
8. Hit Connect.

When connected with Hololight Stream Client, you will see the contents of the first scene under Scenes to Build. If your scene is empty, you won’t see anything. In Unity though, you will see the Main Camera move with the client device’s movements. You can also build and run a standalone application to test.

Connection Details

To see information about your current Hololight Stream connection status, select Hololight > Hololight Stream > Connection Details. Here you can see the following:

Features

Hololight Stream SDK for Unity offers a wide range of features, but this would lead too much into detail for this article. Please refer to the documentation inside the downloaded package for detailed guidance.

Summary

Use this guide to set up your Unity 3D project with Hololight Stream. For step-by-step instructions, please refer to the documentation included in the Hololight Stream SDK for Unity folder.

If you need additional help, don’t hesitate to contact us or explore the Troubleshooting section.