Creating and managing regions
Your Breakroom world can consist of multiple independent regions. Learn how to create, manage, feature, and distribute users between scores of custom virtual spaces.
Overview
Making a region accessible to your users is a multi-step process. At its most basic, it consists of:
On this page you will find detailed instructions for accomplishing these tasks, as well as an explanation of the various region management options available.
Creating and managing regions
Creating a new region
To create a new region, follow the steps below.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Click the Create Region button located in the upper right corner. This will launch the Create Region panel.
In the Create Region panel, start by giving your region a name and a description.
Next, choose a region template. If you have uploaded any custom regions, you can find them by using the Template drop-down menu to show All Templates or Uploaded Templates. (Tip: You can also use the search bar to locate a region template by name.)
Finally, if you want to replace the loading image (which will be displayed in the Explore window and appear while users are teleporting to the region), you can do so by clicking the Browse button. This will launch a standard file import window. Find the image you want to use on your computer, click on it to select it, and then click the Open button.
When you are finished, scroll down and click the Create button.
It's important to note that new regions created through the Dashboard are not enabled or featured automatically, which means that users—including the world Owner—will not be able to find or access them in-world. You can learn more about enabling and featuring regions below.
Breakroom supports JPG and PNG images. The recommended dimensions for loading images are 1920x1080, or a 2:1 ratio, with a maximum file size of 5MB.
Note: You can use the Dashboard to create multiple regions that use the same template. (For example, you can have multiple Conference or Desert Island regions.)
However, you cannot use the Dashboard to create a copy of an existing region setup. (For example, if you set out items for a birthday party in one Desert Island region, those items and details will not transfer should you then create a second Desert Island region.)
Editing a region
To make changes to a region after you have created it, follow these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the region you want to edit and click on the vertical ellipses icon next to the region's name.
In the action menu that appears, click Edit region. This will take you back to the Create Region panel.
Perform your desired changes. You can enter a new region name, edit the region description, upload a new loading image, or select a new region template.
When you are finished, click the Save button.
If you use the Edit region function to change a region's default template, all changes made to the previous template will be deleted. Your deleted changes will be unrecoverable. Please think carefully before taking this step.
Deleting a region
To delete a region after you have created it, follow these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the region you want to delete and click on the vertical ellipses icon next to the region's name.
In the action menu that appears, click Remove.
In the confirmation pop-up that appears, click Yes.
Note: Your default landing regions are protected, and will not display the Remove action automatically. To delete a default landing region, you will first need to toggle the region's "Set as default landing" option off.
Note: You must have at least one active default landing region. Your final default landing region is protected, and cannot be disabled or deleted. To disable it, you will first need to appoint another region as your replacement default landing region.
Locating region IDs
Each region in your world has a unique region ID. If you need to locate and copy this number, you can do so by following these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the region ID you need. This number is displayed below each region loading image.
To copy a region ID to your computer clipboard, click the copy icon located to the right of the number.
Enabling regions
When regions are first created, they are not automatically enabled. In order to access a region or open it to other users, you will first need to enable it through the Dashboard or the Breakroom viewer.
Once enabled, users can search for a region if they know it exists, but may not otherwise be able to easily discover it. This can prove useful—for example, if you want to set up private areas for VIP functions. If you want to make a region easier for users to find, you may want to feature it.
Enabling regions through the Dashboard
You can enable a region through the Dashboard by following these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the region you want to enable. In the upper right corner of the region loading image, you will see the "Enable Region" toggle.
Click this toggle to enable the region. You will see the region loading image display in full color to indicate that the region is enabled and accessible.
Enabling regions through the viewer
You can enable a region through the viewer by following these steps.
Click on the Regions button located in the bottom toolbar. This will launch the Region List window.
Locate the region you want to enable and click the Enable button. You will see the Enter button display in full color to indicate that the region is now enabled and accessible.
Disabling regions
To disable an enabled region through the Dashboard, repeat the steps outlined above. After you click the toggle, you will see the region loading image desaturate and the "Enable Region" toggle return to gray. These visual cues indicate that the region is now disabled.
To disable an enabled region through the viewer, repeat the steps outlined above and click the Disable button in the Region List window.
Note: Any custom changes you make to a region will be preserved if you disable it without deleting it. This gives you the ability to create, "store," and activate custom regions as necessary.
Featuring regions
By featuring your regions, you can make them easier for users to discover. Featured regions will appear under the Featured tab in the Explore window, and users can visit them with a single click.
Breakroom account Owners can disable access to the Explore button through the Dashboard. If you do not see an Explore button in the lower left-hand corner of your screen, the account Owner may have elected to turn it off.
Activating featured regions
You can feature a region by following the steps below.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the region you want to feature. (Tip: If you know the region name, you can enter it into the search field.)
When you find the region you want to feature, make sure that the "Enable Region" option is toggled on.
Click on the vertical ellipses icon next to the region's name. In the action menu that appears, toggle the "Featured" option on.
On the Dashboard, featured regions will be indicated by a star icon in the top left corner, as pictured below.
Deactivating featured regions
To return a featured region to enabled status, follow these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the Regions tab.
Locate the featured region you want to un-feature. (Tip: If you know the region name, you can enter it into the search field.)
When you find the featured region, click on the vertical ellipses icon next to the region's name. In the action menu that appears, toggle the "Featured" option off.
Last updated
