LogoLogo
Tutorial VideosScripting DocumentationLegalHome
Breakroom
Breakroom
  • Welcome to Breakroom
  • GETTING STARTED
    • Helpful terms
    • UI tour
    • Keyboard shortcuts
    • Customizing your avatar
      • Choosing a starter avatar
      • Editing avatars in the Outfit window
      • Using the Sine Wave Shop
    • Controlling your avatar
    • Controlling your camera
    • Communicating with other users
    • Using the conference system
      • Troubleshooting audio and video issues
    • Using Breakroom for Training
    • Settings
    • Language and accessibility
    • Reporting issues
  • EXPLORING BREAKROOM
    • Region navigation tools
    • Bookmarks and teleport invites
    • Using the Explore window
    • Using the Meetings window
    • Networking with other users
      • People
      • Groups
    • Snapshots
  • BUILDING NEW WORLDS
    • Breakroom Dashboard tour
    • Creating and managing Regions
    • Default Landing and Orientation Regions
    • Region settings
    • Region template descriptions
  • CREATING CUSTOM EXPERIENCES
    • Branding tools
    • UI customization options
    • Filtering the Sine Wave Shop
    • Selecting default avatars
      • Default avatar collections
    • Using the Region Editor
      • Editing and moving objects
      • Editing terrain and sky
      • The Region Editor ADVANCED window
    • Exploring the Breakroom Toolkit
      • Breakroom Video Player
      • Breakroom Web Browser
      • Breakroom Image Viewer
      • Breakroom Info Kiosk
      • Breakroom Teleport Portal
      • Breakroom Web Collab
      • Breakroom Note Board
      • Breakroom Games
      • Breakroom Reactives
      • Breakroom Orientation Quest
      • Breakroom Tour Cameras
      • Conference rooms and booths
      • Add-on seats
      • Breakroom Start Here UI
      • Breakroom Basic Emojis
      • Breakroom 360° Video Player
    • Managing your Media Library
  • OPENING THE DOORS
    • Seats and concurrency
    • Creating and managing user accounts
      • World-level user permissions
      • Region-level user permissions
      • Single sign-on
      • Eventbrite integration
    • World Stream
      • Purchasing and managing World Credits
      • Pre-allocation campaigns
      • World Stream viewer toolbars
      • World Stream keyboard shortcuts
      • Troubleshooting World Stream issues on Chrome
      • Troubleshooting World Stream issues on macOS
    • Desktop viewers
    • Privacy Policies, EULAs, and data collection
    • Analytics
    • Toggling World availability
  • RUNNING YOUR EVENT
    • Understanding the conference system
      • Voice zones, zone types, and conference permissions
      • Voice chat and spatial audio
    • Customizing the conference system components
      • Adding breakout areas
      • Creating custom voice zones
      • Setting up Presenter and Audience zones
      • Designating triage zones
      • Troubleshooting duplicate zone errors
      • The RoomFurniture component
    • Setting up Breakroom for Training courses
    • Moderator tools
      • Broadcast messages
      • Crowd management
      • Audience questions
      • Raised hands
      • Presentation controls
      • Hidden UI toggle
      • Participation
      • Audio streams
  • TIPS FOR SUCCESS
    • Region Editor best practices
    • Onboarding new users
  • ADVANCED TUTORIALS
    • Uploading your own Region
      • Installing Unity and the Breakroom SDK
      • Reducing poly counts on CAD files
      • Uploading a Region from Unity to Breakroom
      • Creating and uploading custom chairs
      • Testing items on the preview server
      • Pushing items to the live server
      • Installing the conference system components
    • Uploading your own virtual objects
    • Uploading your own virtual clothing
    • Creating and copying avatar shapes
    • Installing the Quest System
    • Registration and grid APIs
    • Video streaming
    • Sinespace scripting documentation
  • HELP
    • Where to find support
    • Tutorial video playlists
      • Platform basics
      • Dashboard
      • Moderator tools
      • Breakroom Games
      • Creator Core
      • Breakroom for Training - Students
      • Breakroom for Training - Instructors
      • Breakroom for Training - Dashboard and Backend
    • Account management
    • System requirements
    • Troubleshooting network ports and firewalls
  • RELEASE NOTES
    • Breakroom SDK
    • Breakroom Viewer
    • Breakroom Dashboard
Powered by GitBook

©2008-2024 Sine Wave Entertainment Ltd. All Rights Reserved.

On this page
  • Overview
  • Downloading Unity
  • Installing Unity
  • Downloading the Breakroom SDK
  • Installing the Breakroom SDK
  • Special tips for Mac users
Export as PDF
  1. ADVANCED TUTORIALS
  2. Uploading your own Region

Installing Unity and the Breakroom SDK

Through the combined power of Unity and the Breakroom SDK, you can create custom Regions, clothing items, 3D models, and branded promotional materials for your Breakroom World.

PreviousUploading your own RegionNextReducing poly counts on CAD files

Last updated 9 months ago

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.

Only can upload custom items to Breakroom.

The virtual asset files that were used to create Breakroom's (e.g., the plants, buildings, furniture, etc.) are not available for individual distribution. 3D assets for use in Unity can be purchased through the , or any other 3D content warehouse.

Downloading Unity

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 . Later versions of Unity may work, but we cannot guarantee their compatibility. Please review Breakroom's for more information.

Installing Unity

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.

Downloading the Breakroom SDK

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

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.

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

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

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

During the installation process, you may see a Restart button appear. This is normal. Click the Restart button to continue the install.

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

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.

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 in order to sign up.

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 .

The Breakroom SDK comes packaged as a standard .unitypackage file. You can find the file download link under the Your Apps tab on the.

Unity website
Unity website
Dashboard
World Owners, World Administrators, and World Developers
Region templates
Unity Asset Store
Unity download archive
system requirements
Pictured: The Unity download assistant.
Pictured: The Unity download assistant, with the standard install of Unity selected.
Pictured: The Unity ID sign-in panel. Click the "create one" link if you do not have a Unity ID.
Highlighted: The location of the Dashboard > Your Apps tab and the Breakroom SDK download button.
Pictured: The project creation window, with the 3D template selected.
Pictured: The Custom Package import window, with the Breakroom SDK selected for import.
Pictured: The Import Unity Package window, with asset files expanded.
Highlighted: The location of the Sinespace > Install Editor Pack Settings function.
Highlighted: The location of the Sinespace > Sign In function.
Pictured: The location of the Sinespace > Tools > Install > Native Mac Uploader.