LogoLogo
Tutorial VideosScripting DocumentationLegalHome
Breakroom
Breakroom
  • Welcome to Breakroom
  • GETTING STARTED
    • Helpful terms
    • UI tour
    • Keyboard shortcuts
    • Customizing your avatar
      • Choosing a starter avatar
      • Editing avatars in the Outfit window
      • Using the Sine Wave Shop
    • Controlling your avatar
    • Controlling your camera
    • Communicating with other users
    • Using the conference system
      • Troubleshooting audio and video issues
    • Using Breakroom for Training
    • Settings
    • Language and accessibility
    • Reporting issues
  • EXPLORING BREAKROOM
    • Region navigation tools
    • Bookmarks and teleport invites
    • Using the Explore window
    • Using the Meetings window
    • Networking with other users
      • People
      • Groups
    • Snapshots
  • BUILDING NEW WORLDS
    • Breakroom Dashboard tour
    • Creating and managing Regions
    • Default Landing and Orientation Regions
    • Region settings
    • Region template descriptions
  • CREATING CUSTOM EXPERIENCES
    • Branding tools
    • UI customization options
    • Filtering the Sine Wave Shop
    • Selecting default avatars
      • Default avatar collections
    • Using the Region Editor
      • Editing and moving objects
      • Editing terrain and sky
      • The Region Editor ADVANCED window
    • Exploring the Breakroom Toolkit
      • Breakroom Video Player
      • Breakroom Web Browser
      • Breakroom Image Viewer
      • Breakroom Info Kiosk
      • Breakroom Teleport Portal
      • Breakroom Web Collab
      • Breakroom Note Board
      • Breakroom Games
      • Breakroom Reactives
      • Breakroom Orientation Quest
      • Breakroom Tour Cameras
      • Conference rooms and booths
      • Add-on seats
      • Breakroom Start Here UI
      • Breakroom Basic Emojis
      • Breakroom 360° Video Player
    • Managing your Media Library
  • OPENING THE DOORS
    • Seats and concurrency
    • Creating and managing user accounts
      • World-level user permissions
      • Region-level user permissions
      • Single sign-on
      • Eventbrite integration
    • World Stream
      • Purchasing and managing World Credits
      • Pre-allocation campaigns
      • World Stream viewer toolbars
      • World Stream keyboard shortcuts
      • Troubleshooting World Stream issues on Chrome
      • Troubleshooting World Stream issues on macOS
    • Desktop viewers
    • Privacy Policies, EULAs, and data collection
    • Analytics
    • Toggling World availability
  • RUNNING YOUR EVENT
    • Understanding the conference system
      • Voice zones, zone types, and conference permissions
      • Voice chat and spatial audio
    • Customizing the conference system components
      • Adding breakout areas
      • Creating custom voice zones
      • Setting up Presenter and Audience zones
      • Designating triage zones
      • Troubleshooting duplicate zone errors
      • The RoomFurniture component
    • Setting up Breakroom for Training courses
    • Moderator tools
      • Broadcast messages
      • Crowd management
      • Audience questions
      • Raised hands
      • Presentation controls
      • Hidden UI toggle
      • Participation
      • Audio streams
  • TIPS FOR SUCCESS
    • Region Editor best practices
    • Onboarding new users
  • ADVANCED TUTORIALS
    • Uploading your own Region
      • Installing Unity and the Breakroom SDK
      • Reducing poly counts on CAD files
      • Uploading a Region from Unity to Breakroom
      • Creating and uploading custom chairs
      • Testing items on the preview server
      • Pushing items to the live server
      • Installing the conference system components
    • Uploading your own virtual objects
    • Uploading your own virtual clothing
    • Creating and copying avatar shapes
    • Installing the Quest System
    • Registration and grid APIs
    • Video streaming
    • Sinespace scripting documentation
  • HELP
    • Where to find support
    • Tutorial video playlists
      • Platform basics
      • Dashboard
      • Moderator tools
      • Breakroom Games
      • Creator Core
      • Breakroom for Training - Students
      • Breakroom for Training - Instructors
      • Breakroom for Training - Dashboard and Backend
    • Account management
    • System requirements
    • Troubleshooting network ports and firewalls
  • RELEASE NOTES
    • Breakroom SDK
    • Breakroom Viewer
    • Breakroom Dashboard
Powered by GitBook

©2008-2024 Sine Wave Entertainment Ltd. All Rights Reserved.

On this page
  • Overview
  • Viewing your Regions
  • Creating a new Region
  • Editing Region details
  • Locating a Region ID
  • Enabling a Region
  • Through the Dashboard
  • Through the viewer
  • Disabling a Region
  • Featuring a Region
  • Deactivating Featured Regions
  • Hiding Featured Regions
  • Deleting a Region
Export as PDF
  1. BUILDING NEW WORLDS

Creating and managing Regions

With Breakroom, you can create virtual spaces where real work gets done. Learn the basics of editing, enabling, featuring, and deleting Regions via the Breakroom Dashboard.

PreviousBreakroom Dashboard tourNextDefault Landing and Orientation Regions

Last updated 11 months ago

Overview

Every Breakroom World consists of one or more Regions, or self-contained virtual "rooms." To help you get started, we offer a variety of plug-and-play that come fully equipped with decorations, signage, and Breakroom's robust . and can create and manage these Regions via the .

Viewing your Regions

By default, Regions can accommodate up to 500 simultaneous users.

Creating a new Region

To create a new Region, follow these steps.

  1. Click on the World Customization > Regions tab.

  2. Click the Create Region button. This will launch the Create Region panel.

  3. In the Create Region panel, start by giving your Region a name and a description.

  4. When you are finished, scroll down and click the Create button.

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.

Editing Region details

To make changes to a Region after you have created it, follow these steps.

  1. Click on the World Customization > Regions tab.

  2. Locate the Region you want to edit and click on the vertical ellipses icon in the Region card.

  3. In the action menu that appears, click Edit Region. This will take you back to the Create Region panel.

  4. Perform your desired changes. You can enter a new name, edit the description, upload a new loading image, or select a new Region template.

  5. 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.

Locating a Region ID

Each Region in your World has a unique ID number. If you need to locate and copy this number, you can do so by following these steps.

  1. Click on the World Customization > Regions tab.

  2. Locate the Region ID you need. This number is displayed in the Region card.

  3. To copy a Region ID to your clipboard, click the copy icon located to the right of the number.

Enabling a Region

When Regions are first created, they are not automatically enabled. In order to access a Region or make it available to other users, you will first need to enable it through the Dashboard or the Breakroom viewer.

Through the Dashboard

You can enable a Region through the Dashboard by following these steps.

  1. Click on the World Customization > Regions tab.

  2. Locate the Region you want to enable. In the upper right corner of the Region card, you will see the "Enable Region" toggle.

  3. 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.

Through the viewer

You can enable a Region through the viewer by following these steps.

  1. 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 a Region

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 a Region

You can feature a Region by following these steps.

  1. Click on the World Customization > Regions tab.

  2. Locate the Region you want to feature. (Tip: If you know the Region name, you can enter it into the search field.)

  3. Click on the vertical ellipses icon in the Region card. 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 of the Region card, as pictured below.

Deactivating Featured Regions

  1. Click on the World Customization > Regions tab.

  2. Locate the Featured Region you want to deactivate. (Tip: If you know the Region name, you can enter it into the search field.)

  3. Click on the vertical ellipses icon in the Region card. In the action menu that appears, toggle the "Featured" option off.

Hiding Featured Regions

  1. Log in to your Breakroom World and navigate your avatar to the Region you would like to edit.

  2. Click the Region Information button located above the mini map.

  3. Click the Edit button in the Permissions panel.

  4. Check the box beside the "Hide the Region from search and Explore etc." option.

  5. Click the Save button.

To make a Featured Region viewable again, repeat these steps and uncheck the "Hide the Region from search and Explore etc." option.

Deleting a Region

To delete a Region after you have created it, follow these steps.

  1. Click on the World Customization > Regions tab.

  2. Locate the Region you want to edit and click on the vertical ellipses icon in the Region card.

  3. In the action menu that appears, click Remove.

  4. In the confirmation pop-up that appears, click Yes.

Once you understand how to deploy pre-built Regions, you can customize them by your own virtual objects and media. Breakroom provides a of in-world branding and media components such as video players, free-standing browser panels, interactive posters, and more.

You can view all of the Regions you have created under the > World Customization > Regions tab.

When you purchase a Breakroom subscription, your World will be activated and populated by a single . Because your subscription includes an unlimited number of Regions, you can add and additional Regions as needed. your Regions will make them easy for your users to find.

Navigate to your .

Next, choose a . If you have uploaded any , 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 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.

It's important to note that new Regions created through the Dashboard are not enabled or featured by default, which means that users—including the World Owner—will not be able to locate or access them when logged in. To make Regions accessible, you will need to and/or them.

Note: You can use the Dashboard to create multiple Regions that use the same base . However, once you customize a Region, those details will not copy over to new Regions made from the same template.

Navigate to your .

Navigate to your .

Once enabled, users can 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 it.

Navigate to your .

Click on the Regions button located in the . This will launch the Region List window.

To disable a Region through the Dashboard, repeat the steps . 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 a Region through the viewer, repeat the steps and click the Disable button in the Region List window.

Featured Regions will appear under the Featured tab in the , making them easier for users to discover.

Navigate to your .

When you find the Region you want to feature, make sure that the is toggled on.

To return a Featured Region to status, follow these steps.

Navigate to your .

Users with advanced can prevent a Region they administrate from appearing in search or the Explore window, even if that Region has been featured using the Dashboard, by following these steps.

Navigate to your .

Note: You must always have at least one active . 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 its replacement. To delete a Default Landing Region, you will first need to toggle its "Set as Default Landing" status to off.

adding
Toolkit
Dashboard
Region template
custom Regions
Explore window
template
Explore window
Region-level permissions
Default Landing Region
Default Landing Region
enable
Featuring
feature
enable
outlined above
outlined above
"Enable Region" option
enabled
Region templates
conference system
World Owners
World Administrators
Dashboard
feature
search
bottom toolbar
Dashboard
Dashboard
Dashboard
Dashboard
Dashboard
Dashboard
Dashboard
Pictured: The Dashboard > World Customization > Regions tab.
Pictured: The Create Region panel.
Highlighted: The Edit Region button.
Pictured: A brand new Region. Note how it is not enabled, featured, or set as a Default Landing Region.
Pictured: An example of how the Region List window may appear.
Pictured: The Explore window.
Pictured: A Region card on the Dashboard. The star icon shows that this is a Featured Region.
A screenshot of World Customization > Regions tab on Dashboard, featuring six Region cards.
A screenshot of the Creation Region panel. Instructions for using this panel are described below.
A screenshot of a Desert Island region card, with the location of the Edit Region action highlighted.
A screenshot of a freshly created Region. The action menu is open, showing that the Region is not Enabled, Featured, or in any way activated.
A screenshot of an example Region List window, with six Region cards and their associated buttons displayed.
A closeup of the Explore window, with twelve different Region listing cards.
A Breakroom Delphi Region card. An orange star icon in the topmost left corner indicates that this is a Featured Region.