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

If your project already includes Hololight Stream, remove any files left over from previous versions before installing the latest version. After removing all older files, you can continue with the installation.

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, review the supported Unity versions listed below. Newer versions of Unity may work but aren’t fully tested.

Install Unity and create a project

This guide shows how to install Hololight Stream into a Unity template project and connect to that project in the editor. You'll need Unity Hub to proceed.

1. Install Unity Hub on your Windows computer and sign in or create an account.
2. Select 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 select Install.
   1. During the installation, a Visual Studio pop-up might appear.
   2. Select Continue and follow the instructions to reach the install window.
   3. Check the box for Game development with Unity and select Install.
      
      
4. After Unity and Visual Studio are installed, you can create your project.
5. Select Projects in the left sidebar and navigate to New Project > Core > VR Core > Download Template.
   
   
6. 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.

A warning may appear asking if you want to enable the native platform backends for the new input system. Select Yes and Unity will restart.

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.
   1. Make sure only Hololight Stream is selected.
4. Select File > Build Settings.
5. In the Build Settings panel, set the following options:

Run Hololight Stream for the first time

After setting up Hololight Stream, select Play. If setup was successful, you'll be able to connect to the application using the Hololight Stream client.

1. Download and install the 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
   1. Press Windows Key > Enter Command Prompt > Open Command Prompt
   2. Type ipconfig > Press Enter > Look for IPv4
   3. The IPv4 is your IP adress and looks something like this: 192.168.110.84.
      
4. Select Play in your Unity Editor.
5. Open the Hololight Stream client on your device.
6. Enter your PC's IP adress in the client.
7. Select Connect.

When connected with Hololight Stream Client, you’ll see the contents of the first scene under Scenes to Build. If your scene is empty, you won’t see anything. In Unity, you will see the Main Camera move in sync with your 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

The Hololight Stream SDK for Unity includes a wide range of features. For details, refer to the documentation in the downloaded SDK package.

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.