# Installing Unity and the Breakroom SDK

## Overview

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 Breakroom SDK. Instructions for downloading and installing these components can be found below.

{% hint style="warning" %}
Only [World Owners, World Administrators, and World Developers](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/world-level-user-permissions) can upload custom items to Breakroom.
{% endhint %}

{% hint style="info" %}
The virtual asset files that were used to create Breakroom's [Region templates](https://docs.breakroom.tech/building-new-worlds/region-template-descriptions) (e.g., the plants, buildings, furniture, etc.) are not available for individual distribution. 3D assets for use in Unity can be purchased through the [Unity Asset Store](https://assetstore.unity.com/), or any other 3D content warehouse.
{% endhint %}

## Downloading Unity <a href="#downloading-unity" id="downloading-unity"></a>

For the best possible development experience, we recommend that creators use Unity version 2018.4.x up to and including 2018.4.36. This software can be obtained by visiting the [Unity download archive](https://unity3d.com/get-unity/download/archive). Later versions of Unity may work, but we cannot guarantee their compatibility. Please review Breakroom's [system requirements](https://docs.breakroom.tech/help/system-requirements#unity-and-sinespace-sdk-requirements) for more information.

## Installing Unity

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FYfOokeEPWhawdWkf8pFn%2FUnity_SDK_001.png?alt=media&#x26;token=e050d50d-8dd2-4130-964a-96c86162e436" alt=""><figcaption><p>Pictured: The Unity download assistant.</p></figcaption></figure>

Once you've downloaded a compatible version of Unity, launch the download assistant. Click the **Next button**, and follow the installation instructions. A standard install of Unity is all that is required to begin creating in Breakroom.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FiQRzzfu8pW9LiW9YzXrR%2FUnity_SDK_002.png?alt=media&#x26;token=57882096-c28c-4081-96f2-044b7238b66c" alt=""><figcaption><p>Pictured: The Unity download assistant, with the standard install of Unity selected.</p></figcaption></figure>

To begin using Unity, you will need to register for a Unity ID. You can create one during the sign-in process, or visit the [Unity website](https://store.unity.com/#plans-individual) in order to sign up.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FEdEW4WzQP76kdqA3aSbe%2FUnity_SDK_003.png?alt=media&#x26;token=0f14f00f-c665-4a9f-ac2b-7f4911e6acbc" alt="" width="563"><figcaption><p>Pictured: The Unity ID sign-in panel. Click the "create one" link if you do not have a Unity ID.</p></figcaption></figure>

{% hint style="info" %}
Unity is free to use for individuals earning under $100K USD in revenue or funding per year. Please review all of the terms and conditions published on the [Unity website](https://store.unity.com/#plans-individual).
{% endhint %}

## Downloading the Breakroom SDK <a href="#downloading-the-breakroom-sdk" id="downloading-the-breakroom-sdk"></a>

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2F9Wxe3J7uderOkYJqiAWq%2FUnity_SDK_004.png?alt=media&#x26;token=c5ee2323-af5f-4c27-97b6-904f1bb7fcc4" alt=""><figcaption><p>Highlighted: The location of the Dashboard > Your Apps tab and the Breakroom SDK download button.</p></figcaption></figure>

The Breakroom SDK comes packaged as a standard .unitypackage file. You can find the file download link under the **Your Apps tab** on the[ Dashboard](https://docs.breakroom.tech/building-new-worlds/breakroom-dashboard-tour).

To download the SDK, click the **Breakroom SDK button** and save the file to your local drive. You can also copy the download link to share with collaborators who may not have access to the Dashboard.

## Installing the Breakroom SDK <a href="#installing-the-breakroom-sdk" id="installing-the-breakroom-sdk"></a>

Once you have installed Unity and signed in, you can create a new project by clicking the **Create button**. Give your project a name. Make sure the 3D template is selected, and then click the **Create button** again to start Unity.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FGrotlWKZsJJK1mdaxfsj%2FUnity_SDK_005.png?alt=media&#x26;token=3f381bb3-ce75-460d-8749-d65e4329c681" alt="" width="563"><figcaption><p>Pictured: The project creation window, with the 3D template selected.</p></figcaption></figure>

Once Unity has fully launched, navigate to **Assets > Import Package > Custom Package**. This will launch a standard file import window.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2Fjv6g6psW5Y409Fi68vG3%2FUnity_SDK_007.png?alt=media&#x26;token=35006ebd-deb6-443f-8b90-df3b0378c371" alt="" width="563"><figcaption><p>Pictured: The Custom Package import window, with the Breakroom SDK selected for import.</p></figcaption></figure>

Locate the Breakroom SDK file on your computer's hard drive and select it. Then click the **Open button**.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2Fo6RjoEQ5128MTLFlctXr%2FUnity_SDK_008.png?alt=media&#x26;token=6bd3fcf4-b5e0-42ab-a8d7-2db0dc6c73b4" alt="" width="404"><figcaption><p>Pictured: The Import Unity Package window, with asset files expanded.</p></figcaption></figure>

Next, a window will appear listing the assets that will be installed with the SDK. Click the **Import button** to continue the install.

{% hint style="info" %}
During the installation process, you may see a Restart button appear. This is normal. Click the **Restart button** to continue the install.
{% endhint %}

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FRaQjkicVzYHDYQAO8YFZ%2FUnity_SDK_009.png?alt=media&#x26;token=145964de-9150-474f-a4be-6f1605b658d3" alt=""><figcaption><p>Highlighted: The location of the Sinespace > Install Editor Pack Settings function.</p></figcaption></figure>

Once the SDK install has completed, click on the **Sinespace menu** located at the top of the screen and select **Install Editor Pack Settings**.

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FVQHiq73s05qA6qbNMr1w%2FUnity_SDK_010.png?alt=media&#x26;token=c1bf8291-eb24-4c76-b1ce-8409e4cdb1a8" alt=""><figcaption><p>Highlighted: The location of the Sinespace > Sign In function.</p></figcaption></figure>

Click on the **Sinespace menu** again and select **Sign In**. You will be prompted to sign in to 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 panel on the right. If you have already signed up for a creator account, you can log in using your pre-existing 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 navigate to **Tools > Install > Native Mac Uploader.**

<figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FcBhdSEDxirgwVTSCo1rs%2FUnity_SDK_011.png?alt=media&#x26;token=5a438184-2a05-42a8-bbf5-fe25a87a9c09" alt=""><figcaption><p>Pictured: The location of the Sinespace > Tools > Install > Native Mac Uploader.</p></figcaption></figure>