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.
After you've created a region or object, 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 and uploading your own outfits for more information about the various windows and functions available in Unity.
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.
In order to follow the steps outlined below, you must already have Unity and the Sinespace SDK installed. See here for instructions.
Starting a new scene in Unity
From the Unity File menu, click New Sinespace Scene. This will add the necessary components to a new scene to begin your region upload.
The location of File > New Sinespace Scene.
When you create a new standard Unity scene, you will of course have access to a Main Camera and a Directional Light. A new Sinespace scene creates a specific setup for use in Breakroom, and has some additional elements:
Landmark: This controls where your users will land in 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 in the sections that follow.
Post Processing Settings: You will normally not need to make changes to these settings.
In the instructions that follow, the default cube pictured is representative of a scene. Remember that normally, this cube will be replaced by your own custom models.
An example of how Unity may appear during this process, with the example cube.
The VirtualGood component
In order to upload your region, you will need to make some changes to the VirtualGood component. To begin, click on the Scene Export Settings component in the hierarchy. In the Inspector window, you will see the VirtualGood component.
The VirtualGood component, featuring a number of tabs and information fields.
From here, you will access the various tabs and information fields in order to complete setup of the 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
The Detail 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 for the indicated Inworld Customization setting. Using the drop-down menu, set this to Full.
3. Edit the Pricing information
The Pricing tab.
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
The Author tab.
Click the Author tab, and then provide the relevant information for your upload. If in doubt, leave the status as "Available Elsewhere," set the Developer to your name (as the grid owner), and set the copyright to your company name.
5. Add your grid number
The Upload tab and Scene Save Settings.
Under the Upload tab, add your grid number to the Grid field. Your grid number is available through Curator. 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 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.
Logo: The image should be 512x256, PNG format preferred.
Once you have entered these images, click on the Automatic Submission button to complete your upload.
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.