Installing Unity and the Sinespace SDK
Through the combined power of Unity and the Sinespace SDK, you can create custom regions, clothing items, and branded promotional materials for your Breakroom world.


If you would like to create and upload custom items to the Breakroom platform, you will need to download a compatible version of the Unity real-time development platform and install the Sinespace SDK. Instructions for downloading and installing these components can be found below.
In order to upload custom regions and items, your Breakroom subscription must include a Developer seat. To upgrade your subscription plan, please reach out to our Sales Team.

Downloading Unity

For the best possible development experience, we recommend the use of Unity version 2018.4.x up to and including 2018.4.36. This can be obtained by visiting the Unity download archive. Later versions of Unity may work, but we cannot guarantee their compatibility. Please see our technical specifications documentation for more information.

Installing Unity

The Unity download assistant.
Once you've downloaded a compatible version of Unity, launch the download assistant. Click the Next button, and follow the install instructions. A standard install of Unity is all that is required to begin creating in Breakroom.
The Unity download assistant, with the standard install of Unity selected.
In order to begin using Unity, you will need to register for a Unity ID by using the Sign In button. Alternatively, you can visit the Unity website in order to sign up.
The Unity ID sign-up form.
Unity is free to use for for individuals earning under $100k per year in revenue. Please review all terms and conditions at the Unity website.

Installing the Sinespace SDK

Create a new Unity project by clicking the Create button, and give your project a name. Make sure the 3D template is selected, and then click Create again to start Unity.
The project creation page, with the 3D template selected.
Once Unity has fully launched, locate the Asset Store tab along the top of the main window. Type "Sinespace" into the search box, and click on the Sinespace icon that appears.
The Unity Asset Store tab, displaying a successful search for the Sinespace SDK.
In the new window that appears, click on the blue download icon to start downloading the SDK. When the download has completed, click the blue Import button to start the install.
The Sinespace SDK, ready to import from the Unity Asset Store.
Click the Install button at the bottom of the Import window that is displayed. You are not required to uncheck any of the boxes in this window, as our SDK will determine what version of Unity you are using.
During the installation process you may see the restart button appear. This is normal. Click the restart button to continue the install.
The Import Unity Package window, with asset files expanded.
Next, a window will appear listing the assets that will be installed with the SDK. Click the Import button again to continue the install.
The location of the "Install Editor Pack Settings" function.
Now that the install has completed, click on the Sinespace drop-down menu located at the top of the screen and select Install Editor Pack Settings.
The location of the "Sign In" function.
Click on the Sinespace drop-down menu again and select Sign In to sign into the SDK. As a new creator, you will be required to sign up for a creator account. You can do this by clicking the Create Account button located in the Inspector window on the right. If you have already signed up for a creator account, you can log in using your preexisting username and password.

Special tips for Mac users

Mac users are required to use the native Mac uploader. To access this, click the Sinespace menu at the top of the screen and select Tools > Install > Native Mac Uploader.
The location of the "Native Mac Uploader."
Last modified 2mo ago