Breakroom
Search…
⌃K
Links

ADVANCED - Uploading your own region items

If you have a specific design vision for your Breakroom world, you may want to upload your own furniture, animations, and decor through Unity. Learn how to import and edit room items here.

Overview

A room item is any item that is not a full region. Common room items include chairs and other pieces of furniture, but you might also want to upload a special piece of virtual decor, an avatar animation, or a 3D model (such as your company logo). Once these items are uploaded to your world, you can deploy them through the use of the Region Editor and other means.
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 uploading clothing items and uploading custom regions.
In order to upload custom regions and items, your Breakroom subscription must include a Developer seat.
In order to follow the steps outlined below, you must already have Unity and the Breakroom SDK installed on your computer. See here for instructions.

Import or create your region item in Unity

Merging items in Unity

Here we have created a simple sculpture—a globe on top of a cube.
As an example object, we will take the globe sculpture pictured above. It consists of two items—a sphere placed on top of a cube. To merge these two items into a single item and upload it to your world, first right click on an empty area in the Hierarchy panel and select Create Empty in the menu that appears. Rename this object to something meaningful—for example, "My First Object."
Now drag the cube and the sphere into this object.
The original sphere and cube items, now merged under "My First Object."

Turning your item into a virtual good

The Sinespace menu, with the Virtual Goods sub-menu expanded.
Click on My First Object to highlight it, and then click on the Sinespace menu and navigate to Virtual Goods > Turn selection into furniture. Clicking this action will convert your object into a virtual good that can be uploaded to your world. You do not need to alter the Room Furniture component that was just added.
"My First Object," with the Virtual Good and Room Furniture components added.

Editing the Virtual Good component

Scroll down to the Virtual Good component. To complete setup of your item, you will need to navigate through the Virtual Good component tabs and edit certain information. Here are the key steps you will need to take.

1. Provide basic item information

In the Virtual Good component, under the Basic tab, you will need to select the item type and category. The category you select will influence where your item appears in your inventory.
The Virtual Good component, with the Basic tab active. Note that the item type is set to Furniture.
There are additional details under the Basic tab that you will need to provide:
  • Name: The item's name.
  • Description: A brief description of the item.
  • Brand: Your brand name. Corporate clients may want to use their company name.

2. Edit the item details

Next, click on the Detail tab. The settings listed under this tab are optional, and usually can be left in their default state—except for the Inworld Customization setting. You will need to set this to Full.
The Inworld Customization setting, under the Detail tab. This must be set to Full.

3. Edit the Pricing information.

Next, click on the Pricing tab. Check the box to enable the "Not for Sale" option.
The Pricing tab, with the "Not for Sale" option checked.

4. Edit the Icons information

You can skip the Icons tab, as this is only used if the item will be sold in the in-world Shop.

5. Edit the Author information

Click on the Author tab. Fill in the details that best suit your upload. If in doubt, leave the item's Unique Status as Available Elsewhere, edit the Developer's Name field to include your name (as the world owner), and edit the Copyright field to include your company name.
The Author tab, where you can specify creation details about your item.

6. Edit the Upload information

Lastly, click the Upload tab. In the Grid ID field, enter your Breakroom world's unique grid ID number. There are multiple places where you can obtain your grid ID number.
The Upload tab, with the Grid ID field highlighted.

Finding your grid ID on Dashboard

  1. 1.
    Navigate to your Dashboard.
  2. 2.
    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

  1. 1.
    Navigate to your Dashboard.
  2. 2.
    Click the Advanced button at the top of the page. This will take you to Curator.
  3. 3.
    In the Curator window that appears, locate the Grid listing to your world. Your grid ID will be displayed next to the world name.
An example of what you might see in Curator.
Now that you have your grid ID, it can be entered into the Grid ID field under the Upload tab as shown.

Converting your item to a Unity prefab

Create a new folder in your Unity project by right clicking on the Project Assets panel. Call this folder "Uploads," and double click on it.
How to create a new folder in your Unity project.
Now drag the parent object from the Hierarchy to the "Uploads" folder in the Project panel.
Dragging the parent object from the Hierarchy into the "Uploads" folder.
Next, right click on this new prefab object and select Upload to Sinespace in the menu that appears.
The location of the Upload to Sinespace action.
Finally, confirm the upload.
Confirm the upload by clicking the Upload Item button.
You will be asked to save the scene before the upload can proceed. We do recommend saving, as you may have other items in the scene and this will make editing easier in the future.

More Information

For your next steps, you'll want to test your item on the preview server and then push it to the live server. You can find instructions for doing both at the links below.