Uploading a Region from Unity to Breakroom
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 steps.
Overview
After you've created a Region or other 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, and that you must have Unity and the Breakroom SDK installed on your computer.
Only World Owners, World Administrators, and World Developers can upload custom items to Breakroom.
The instructions provided in this section presume an advanced working knowledge of Breakroom, virtual assets, and third-party 3D software.
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 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'll 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.
From here, you'll need to navigate through the Virtual Good component tabs and edit their contents to complete setup of your Region. Here are the key steps you'll 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
After you're done editing the Basic tab, 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, which is highlighted in the image above. Using the drop-down menu, set this to Full.
3. Edit the Pricing information
Next, click the Pricing tab and 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, 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 either your account name or the Advanced button located at the top of the page. This will take you to Curator.
In the Curator window that opens, click the Grids heading.
Locate the grid card for your World. Your grid ID will be displayed next to the World name.
6. The Scene Save Settings component
While still in the Upload tab, locate the Scene Save Settings component. Here 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 uploaded 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.
Last updated