Uploading a region from Unity to your Breakroom world
By combining Unity with Breakroom, you can unlock almost limitless creative potential. Learn how to upload a custom region to Breakroom with just a few simple steps.
Overview
After you've created a region or 3D model, only a few additional steps are required to upload it to Breakroom. Please note that the instructions below presume a basic working knowledge of Unity. If you are new to the program, in addition to Unity's own resources, it may be helpful to review our documentation on creating and uploading custom chairs, uploading your own region items, and uploading your own outfits.
Only World Owners, World Administrators, and World Developers can upload custom items to Breakroom.
In order to follow the steps outlined below, you must already have Unity and the Breakroom SDK installed on your computer.
Upload permissions
Only user accounts assigned the Developer role can upload regions and 3D models to Breakroom. Please see this page for more information about assigning and managing user permissions.
Starting a new scene in Unity
In Unity, click on the File menu, and then click New Sinespace Scene. This will add the necessary components to a new scene to begin your region upload.
When you create a new standard Unity scene, it will include a Main Camera and a Directional Light. A new Sinespace scene creates a specific setup for use in Breakroom, and includes some additional elements:
Landmark: This controls where your users will land when they teleport to the region.
Sun: This is a renamed Directional Light.
Cube: This is a simple floor. This would normally be replaced by your region's models and designs.
Scene Export Settings: This contains specific information that you will need to edit. This is covered in more detail below.
Post Processing Settings: You will normally not need to make changes to these settings.
Throughout this document, the default cube pictured is representative of a scene. Remember that normally, this cube will be replaced by your own custom models.
Editing the Virtual Good component
In order to upload your region, you will need to make some changes to the Virtual Good component. To begin, click on the Scene Export Settings component in the Hierarchy. In the Inspector panel, you will see the Virtual Good component. (See above image.)
From here, you will need to navigate through the Virtual Good component tabs and edit certain information to complete setup of your region. Here are the key steps you will need to take.
1. Provide basic item information
Under the Basic tab, you must:
Specify the item type and category (e.g. Region) using the Type drop-down menu and Category search field.
Enter a name for the region in the Name field.
Enter a description in the Description field.
And finally, enter a brand name in the Brand field. If you don't have an in-world brand, this would normally be your company name.
2. Edit the Inworld Customization setting
Click on the Detail tab. The settings located under this tab are optional, and usually left in their default state. The sole exception is the Inworld Customization setting, as indicated above. Using the drop-down menu, set this to Full.
3. Edit the Pricing information
Under the Pricing tab, check the box beside the "Not for Sale" option.
You can skip the Icons tab, as this tab is only used if you intend to sell your region as a product in the Breakroom Shop.
4. Edit the Author information
Click the Author tab, and then enter the relevant information for your upload. If in doubt, leave the Unique Status drop-down menu set to Available Elsewhere, enter your name into the Developer Name field (as the grid Owner), and set the Copyright field to your company name.
5. Add your grid number
Under the Upload tab, add your grid number to the Grid field. You can obtain your grid ID from multiple places.
Finding your grid ID on Dashboard
Navigate to your Dashboard.
Look in the top left corner of the screen. You will see your world name followed by an ID number. This ID number is your grid ID.
Finding your grid ID on Curator
Navigate to your Dashboard.
Click the Advanced button at the top of the page. This will take you to Curator.
In the Curator window that appears, locate the Grid listing to your world. Your grid ID will be displayed next to the world name.
The Scene Save Settings component will be covered in more detail in the section that follows.
The Scene Save Settings component
Under the Scene Save Settings component, you will need to add two images. One will be your region-specific "splash screen," and the smaller one will be your logo.
Splash screen: This image will appear in the Explore window, and when users are teleporting to your region. It should be 1920x1080, PNG format preferred, and no larger than 5MB.
Logo: The image should be 512x256, PNG format preferred, and no larger than 5MB.
Once you have entered these images, click on the Automatic Submission button to complete your upload.
Video tutorial
The tutorial below is designed for Sinespace, but the advice is consistent with Breakroom.
The Sinespace Wiki page also contains useful information about uploading and managing regions.
Last updated
