Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 143 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

Breakroom

Loading...

GETTING STARTED

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

EXPLORING BREAKROOM

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

BUILDING NEW WORLDS

Loading...

Loading...

Loading...

Loading...

Loading...

CREATING CUSTOM EXPERIENCES

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Breakroom for Training

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

OPENING THE DOORS

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

RUNNING YOUR EVENT

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Choosing a starter avatar

Conservative, casual, or charming—Breakroom's starter avatars make an excellent first impression. Here's how to pick a starter avatar from your curated lineup.

Overview

You can pick a starter avatar when you register for a Breakroom account or log in for the first time. If your Breakroom World allows users to customize their avatars, you can then edit your starter avatar's appearance and browse for additional clothing and accessory items in the Sine Wave Shop.

World Owners and World Administrators can enable and disable parts of the UI and self-registration via the Dashboard. You may not have access to every avatar customization option described in this section.

Selecting a starter avatar upon registration

If self-registration is enabled, you can pick a starter avatar by following the prompts during the sign-up process. World Owners and World Administrators can change the starter avatar collection at any time through the Dashboard, so the collection of avatars you see may vary.

Selecting a starter avatar upon login

The Start Here panel is a part of the Breakroom conference system. If installed in a Region, this panel lets you browse through the starter avatar collection by clicking the Avatar button. To change your look, click the Click to select button corresponding to the avatar you'd like to use.

Customizing your avatar

Breakroom allows users to truly represent themselves in the Metaverse. Learn more about our avatar customization tools, and use them to create an avatar as special and unique as you are.

Overview

Breakroom is a multi-person simulation that uses avatars to represent where people are—and, perhaps more importantly, who they are. Breakroom offers many options for customizing your avatar, so you can feel comfortable in your own virtual skin.

If your goal is to pick an avatar and get on your way, you can select a starter avatar with just a few clicks. If you're looking to create your own digital doppelgänger, you can use the Outfit window to customize your avatar's shape, skin, hair, and clothing.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every avatar customization option described in this section.

Our Commitment to Inclusivity

Breakroom is committed to hosting events where everyone feels included. Our powerful avatar customization system and in-world content library are designed to offer users the tools they need to accurately represent themselves in virtual space. If you would like guidance on using either the Outfit window tools or the Sine Wave Shop contents to create a more diverse and welcoming space, please reach out to our Customer Success Team. We would be happy to assist you.

Welcome to Breakroom

The Metaverse is a powerful tool where opportunities for connection, education, and engagement abound. Breakroom makes it easy to customize your virtual World and invite others to explore it.

Breakroom is a Metaverse platform where institutions can organize online events, provide remote training, and create shared spaces for teams and communities. Whether you're looking to host an inspiring multi-day conference, bring your team together to tackle an important project, or create a dynamic classroom environment, Breakroom has the tools you need.

If you're new to Metaverse platforms like Breakroom, one of the best ways to get started is by putting yourself in the virtual shoes of an end user. Our Getting Started section will show you how to get around and communicate with other people, as well as how to manage your personal viewer settings for improved performance and accessibility.

If you're ready to bring your Metaverse vision to life, our Building New Worlds section will teach you how to create custom Breakroom Regions. Opening the Doors will show you how to manage user accounts and control access to your World, and the Running Your Event section contains tutorials for customizing the conference system components and accessing moderation tools.

Keyboard shortcuts

Many actions in Breakroom are tied to easy keyboard shortcuts. Here's a cheat sheet.

Overview

In addition to the many point-and-click functions built into Breakroom, there are dozens of keyboard shortcuts that can make getting around the Metaverse a bit easier. World Stream also features variations on these.

Toggle full-screen

To toggle between full-screen and windowed mode, press the F11 key on Windows, or Command (⌘) + F on MacOS.

Toggle the UI

Press the F9 key or Alt + U on Windows, or Command (⌘) + U on MacOS to toggle the user interface on and off. This will also clear any seat tags that may be hovering over unoccupied chairs—useful for decluttering Regions when you want to take photographs or capture video.

Additional shortcuts

Windows Command
MacOS Command
Result

F1

FN + F1

Calls up the Support Center.

F5

F5

Calls up the bug report/feedback window. You can also use Ctrl + Shift + P.

F12

FN + F12

Ctrl + T

Ctrl + T

Ctrl + M or Ctrl + ;

Ctrl + M or Ctrl + ;

Ctrl + F

Ctrl + F

Ctrl + E

Ctrl + E

Ctrl + Q

Ctrl + Q

Toggles the Quest window.

Ctrl + I

Ctrl + I

Ctrl + O

Ctrl + O

Ctrl + S

Ctrl + S

Ctrl + Space

Ctrl + Enter

Ctrl + H

Ctrl + H

Ctrl + `

Ctrl + \

Ctrl + /

Ctrl + /

Helpful terms

How is a World different from a Region? Check out our guide to Breakroom-speak, and learn how to define your virtual experience.

Overview

If you're new to the Breakroom platform (or to virtual worlds in general), you'll need to master some new tech jargon. Here are some key terms that will help you understand the concepts detailed in our Getting Started section, as well as communicate with our Customer Success Team and other Breakroom users.

Virtual experience terms

World

When Breakroom World Owners purchase a subscription, we provide access to a standalone instance of Breakroom, which we call a World. Client Worlds are completely disconnected from one another, and users can't enter your World unless you invite them or otherwise grant access. Breakroom Worlds can contain multiple Regions.

In our older technical documentation, you may see Worlds referred to as Grids.

Region

Breakroom Worlds can contain multiple Regions. It may be helpful to think of Regions as separate "rooms" within a World. Regions are generally disconnected from one another, but you can enable ways for users to travel between them (such as activating the Explore window or setting up Teleport Portals).

Breakroom offers a wide selection of Region templates, which are plug-and-play areas designed to host different kinds of events—everything from corporate conference halls to neon-lit music venues. Clients with access to 3D assets can also design custom Regions and upload them to their World.

Avatar

When you log in to Breakroom, you are given control over a graphical representation of yourself called an avatar. Avatars can be used to explore the virtual World and interact with other people. You can customize the way your avatar looks by selecting a starter avatar or by using the tools available in the Outfit window.

UI

This abbreviation stands for user interface, and refers to all of the menus, maps, buttons, and windows that appear on your screen. World Owners can use the Dashboard to enable or disable specific UI elements for end users. A key part of the UI consists of Breakroom's conference tools, which allow users to access voice chat, webcam and screen share, emojis, and other communication tools.

Sine Wave Shop

The Sine Wave Shop allows users to browse through a content library full of avatar accessories, gestures, animations, and virtual furniture, much of it provided by community creators or by Breakroom. World Owners and World Administrators can filter the Shop contents for end users, or disable access to the Shop entirely.

Inventory

Your Inventory contains all of your virtual belongings, such as any clothing or other accessories you've purchased to use on your avatar. Any virtual assets you upload to Breakroom will also appear in your Inventory.

Gestures

Gestures are animations that can be acted out by one or more avatars. By dancing, laughing, and interacting with other users, you can enrich your virtual experience and forge connections.

Administrative terms

Dashboard

The Dashboard is a web portal that allows World Owners and World Administrators to customize their Breakroom World, prepare for events, and manage user accounts. Our Dashboard tour offers a concise overview of the available options.

Seats

Seats are otherwise known as user licenses, and represent the number of active user accounts that a Breakroom World can accommodate. In addition to the persistent seats included with a Breakroom subscription, World Owners and World Administrators can add temporary seats through the use of Daily Passes.

Each seat is assigned a specific type. Seat types include Administrators, Developers, etc., and correspond to different World-level user permission levels.

Concurrency

Concurrency refers to the number of simultaneous users a Breakroom World can accommodate. Please note that a Breakroom account's concurrency cap may be different than its total seat count.

Desktop applications or desktop viewers

Breakroom provides desktop applications for both Windows and macOS. When using a desktop viewer, there are no additional fees for user access. However, users will need to install the Breakroom app on a computer equipped with hardware that can effectively render 3D worlds.

World Stream

World Stream is a cloud-based streaming solution for users who might not have access to advanced graphics processing hardware. World Stream can be run on any supported Internet browser, so users can access Breakroom from both desktop and mobile devices. World Stream access must be purchased on a per user/per time basis using a digital currency known as World Credits.

Breakroom Toolkit

The Breakroom Toolkit consists of plug-and-play items designed to help World Owners, Administrators, and Developers add branding, media, and functional engagement to Regions. The Toolkit includes media displays, collaborative tools, interactive effects, and no-code gamification.

Conference tools

Breakroom's conference tools consist of voice chat, webcam streaming, and screen sharing, as well as navigation, moderation, interaction, and scheduling tools. Conference tools come pre-installed in most Region templates, and can be added to any Region.

Moderator tools

Key event coordinators and stakeholders will have access to moderator tools, which allow Moderators to broadcast messages, teleport single users or crowds, manage audience questions, control the audio stream, and assist with presentations.

Breakroom for Training

Breakroom for Training is a comprehensive learning management system that allows World Owners and World Administrators to facilitate live online learning. Create touchback points and track student progress via the Dashboard, and manage instructor access to in-world tools.

Calls up your own .

Toggles the window.

Toggles the Breakroom .

Toggles the .

Toggles the .

Toggles the .

Toggles the .

Toggles the .

Moves your cursor into the search field in the .

your avatar back home.

Launches the .

Calls up the .

user profile
text chat
email window
People window
Explore window
Inventory window
Outfit window
Shop window
top toolbar
Teleports
Snapshot feature
Settings panel

UI tour

Breakroom's UI gives you the tools you need to thrive in the Metaverse. Learn how to find your way around, manage your personal connections, and access various types of media.

Overview

Breakroom's UI, or user interface, contains almost all of the information and tools you'll need to interact in virtual space. When enabled, the UI components will frame the screen.

The tables below are designed to serve as a quick reference guide for the basic UI components and their functions. You can learn more about using Breakroom's conference system in our Getting Started section.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every component of the UI pictured above.

The bottom toolbar

UI Component
Function

Show/Hide Chat

Hot Bar

Profile icon

People

Explore

Meetings

Regions

Inventory

Outfit

Shop

Snapshot

Edit Region

The top toolbar

UI Component
Function

Connection icon

Indicates your connection status and strength when clicked.

Search bar

Allows you to search for Regions, users, and Sine Wave Shop items.

Clock

Displays the current UTC time, as well as other time zones if clicked.

Gold icon

Buy button

Allows you to purchase additional Gold currency.

Silver icon

Displays the amount of Silver currency you currently own.

Notification icon

Displays and allows you to manage notifications.

Envelope icon

The mini map

UI Component
Function

Region Information button (name)

Bookmark button

Hamburger menu

Contains version information for Breakroom, as well as buttons to enter full screen mode, log out, and exit the app.

Magnifying glasses

Allow you to zoom in and out of the local mini map.

Mini map

Provides a general overview of the immediate area.

Quests button

Opens the Quests window, where you can track your progress on any quests you've started.

The settings toolbar

UI Component
Function

Settings button

Volume button

Offers quick access to volume settings.

Help button

Opens Breakroom's in-world Support Center.

Microphone button

Radio button

Enables or disables the audio stream.

Controlling your avatar

Breakroom really helps you get around! Learn how to walk, fly, dance, and interact with other users through your virtual avatar.

Overview

Just as we rely on our physical bodies to help us experience the world, your avatar serves as your main point of reference within the Metaverse. In order to explore, create, and socialize within Breakroom, you will need to move your avatar through virtual space. On this page you'll learn how to navigate Regions by walking and flying, as well as how to animate your avatar through the use of gestures.

Controlling your avatar

Walking

You can direct your avatar to walk using the arrow keys on your keyboard. The up and down arrow keys will move your avatar forward and backward, while the right and left arrow keys will turn your avatar to the right or left.

If you're familiar with playing video games on a PC, you can also use the WASD keys the same way. The Q and E keys will shuffle your avatar to the left and right.

Running

To run, press and hold down the Shift key while walking.

Jumping and crouching

To jump, press the space bar. To crouch down, press the C key while your avatar is standing on the ground.

Flying

To start flying, press the F key. This will lift your avatar into the air, where it will hover. You can then use the arrow keys or WASD keys to soar around. Press the R key (or Pg Up key) to fly higher, and the C key (or Pg Down key) to fly lower. Press the F key again to land.

Click to walk

You can also move around by pointing your mouse cursor at a spot on the ground and clicking the left mouse button. Your avatar will walk to the specified point and stop. This is called the "click to walk" setting, and you can turn it off in the Settings window if you prefer.

The Settings window contains additional options related to avatar movement—you can change the default speed of your avatar, enable "always run" mode, and more.

Gestures

In addition to basic locomotion, Breakroom offers users the ability to play gestures. Gestures can add a spark of humor and energy to in-world activities, allowing people to express themselves and experience the immersive magic of the Metaverse.

Purchasing gestures

Gestures can be purchased through the Sine Wave Shop. Under the Gestures tab, you'll find gestures designed to foster connection (such as waving, bowing, shaking hands, etc.), single-user and multi-user dances, interactive objects, and more.

To locate the Gestures tab and purchase gestures, follow these steps.

  1. Open the Sine Wave Shop by clicking the Shop button located in the bottom toolbar.

  2. Click the Gestures tab located at the top of the Sine Wave Shop window.

  3. Scroll through the gesture listings, or click on one of the gesture categories in the sidebar to narrow down your search.

  4. When you find a gesture that interests you, click on the listing. You'll be be given the opportunity to watch a preview of the gesture using your own avatar.

  5. If you like the gesture, you can purchase it immediately by clicking either the Buy with Gold or Buy with Silver button, or add it to your cart by clicking the Add to Cart button.

Locating and playing gestures

To locate your purchased gestures and play them directly from your Inventory, follow these steps.

  1. Open the Inventory window by clicking the Inventory button located in the bottom toolbar.

  2. Click on the Gestures category. Find the gesture you want to use, and click on it.

  3. Click the Use button in the action menu that appears.

Installing gestures in the Hot Bar

You can also keep your favorite gestures right at your fingertips by adding them to the Hot Bar. To do so, click and drag the gesture from your Inventory window to a Hot Bar space. To play a gesture from the Hot Bar, click on the gesture icon.

Stopping gestures

You can stop a gesture at any time by clicking the Stop Gesture button located at the bottom of the screen.

Multi-user gestures

Single-user gestures affect only your avatar. Multi-user gestures can be played with other people, allowing you to high-five, hug, and dance with your Breakroom colleagues. There are several ways to invite others to join you in the fun.

Closed gesture invitations

To invite a specific individual to play a gesture with you, follow these steps.

  1. Click on the other user's avatar, and then click Play Gesture in the action menu that appears.

  2. An Inventory window will open. Click on the gesture you want to play.

The other user will see a pop-up asking whether they want to participate in the gesture with you. Once they give their consent, the gesture will play. Keep in mind that many multi-user gestures will temporarily take control of your camera in order to follow the gesture.

Either user can stop the gesture at any time by clicking the Stop Gesture button.

Open gesture invitations

If you play a multi-user gesture without specifying a particular partner, glowing blue rings will surround your avatar. Other users with avatars located within this "gesture zone" will then be asked if they want to participate in the gesture with you, and any of them may accept.

You can rescind an open gesture invitation or stop the gesture at any time by clicking the Stop Gesture button.

Using the Sine Wave Shop

The Sine Wave Shop is full of clothes, accessories, and fun avatar details that are just waiting to be discovered. Here you'll learn more about navigating the Shop and purchasing items.

Overview

Breakroom currencies

Breakroom offers two types of in-world currency: Silver and Gold.

Silver is Breakroom's in-world promotional currency, and cannot be exchanged for legal tender. Each user will receive a gift of Silver upon joining Breakroom. Additional Silver can be earned by completing quests and engaging in other activities.

Gold is a premium currency that can be purchased (and in limited cases, exchanged) for legal tender. Some Sine Wave Shop items can only be purchased with Gold currency.

Buying Gold currency

Shop window walkthrough

Opening the Shop window

Browsing the Shop categories

Along the top edge of the Sine Wave Shop window, you'll see several category tabs. Click these to explore the different types of content that Breakroom offers for purchase. You'll find tabs devoted to Clothing, Vehicles, Furniture, and more.

When you click on a category tab, you'll see a subcategory menu appear in the left corner of the Sine Wave Shop window. Use this to refine your search even further.

Searching for items

Each category tab includes a search field. When searching within the Clothes category, you can also specify whether you want to see items intended for masculine avatars, items intended for feminine avatars, or both.

Previewing clothing items

When you find a clothing item that you want to learn more about (such as the shirt pictured above), click on the item image in the Sine Wave Shop window. If the item is compatible with your current avatar, you'll be given a chance to "try on" the item in real time.

In order for the preview window to work, the preview item must be compatible with your current avatar. If you are wearing an animal avatar, for example, you will not be given the option to preview human clothing. Likewise, if you are wearing a feminine avatar, you may not be given the option to preview clothing or shoes designed for masculine avatars.

You can use the camera controls located in the bottom right corner to inspect your avatar from all angles.

Completing your purchase

Once you're satisfied with the way the item looks, you can purchase it directly by clicking the Buy button. You will be asked to confirm your purchase. If the item is an article of clothing, you'll be given the option to wear the item immediately or file it away in your Inventory.

Opening bundles

Some items come packaged in bundles. Bundles can contain multiple items, and will need to be unpacked before you can access their contents.

To open a newly purchased bundle, follow these steps.

  1. In the Inventory window, locate the bundle you want to open and click on it. In the action menu that appears, click the Use button.

A second window will appear, containing information about the items inside the bundle. Click the Get button at the bottom of this second window. This will extract the items into your Inventory.

Editing avatars in the Outfit window

Bigger ears, brighter lipstick—it's time to let your virtual stand-in truly stand out. Using the Outfit window, you can edit your avatar's appearance and outfits with ease.

Overview

Breakroom's Outfit window offers an impressive level of control over the physical appearance of your avatar. Completed outfits (including shape, skin, hairstyle, etc.) can be saved for future use. Once you've created a library of outfits, you can switch between them at will.

Opening the Outfit window

The Outfit window UI

Once you open the Outfit window, your avatar's current look will be displayed in the preview window on the left side. Before we discuss the various editing tools, let's review the Outfit window UI.

The camera tools

The camera tools can be found in the bottom left corner of the Outfit window. Use them to position your camera for optimum viewing while you edit your avatar or outfit.

Creating a new outfit

In Breakroom, the term outfit refers to a unique avatar configuration. It may help to think of an outfit as an avatar that you have saved at a particular moment in time, including all details such as hair, skin, eye color, shape, clothes, shoes, jewelry, etc.

For example, you may craft a basic "Me" avatar and then save several variations on this avatar as separate outfits, such as "Formal Me" and "Sporty Me." Or you may choose to create a diverse collection of outfits, including quadruped dragons, hovering ghosts, and more.

To create a new outfit or avatar, follow the steps below.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click the Create New Outfit button located at the bottom of the preview window.

  1. A pop-up will appear, prompting you to select a basic body morphology. Make your choice by clicking either the Masculine or Feminine button.

  2. Enter a name for your new outfit, and click the Save button.

Following these steps will replace your current avatar with a default masculine or feminine human avatar. You can then edit this avatar in detail to create a new outfit.

The Appearance tab

The Appearance tab contains a suite of convenient tools that allow you to change your avatar's body and face presets with a single click. You can also use the Head, Bodies, and Skin interfaces located under the Appearance > Details subtab to further customize your virtual look.

Applying preset shapes

Presets are built-in shapes designed to change your avatar's appearance with a single click. Using presets can help you achieve your avatar appearance goals more quickly, as they can be customized after you apply them.

To apply a new preset to your avatar, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Appearance tab. Make sure the Body & Shape subtab is active.

  3. Click on a body preset or a face preset to apply it to your avatar.

  4. When you are satisfied with your changes, click the Save button.

Customizing your head and body shape

The Appearance tab contains two subtabs, which are located in the top right corner. The Details tab contains three subtabs of its own—the Head tab, the Bodies tab, and the Skins tab. In this section, we will focus on the Head and Bodies tabs.

The Head tab

Under the Appearance > Details > Head tab, you will find a number of facial features with nested slider controls. To expand a facial feature control panel, click the > arrow located to the left of its name. You will also see options to Minimize All or Expand All panels near the top of the window.

Each slider controls a single aspect of your avatar's facial configuration. The level of detail you can achieve with these sliders is astonishing, and the best way to learn how to use them is to experiment. You can always Undo your last step or Reset your avatar entirely by clicking the relevant buttons at the bottom of the window.

The Randomize feature

Of particular interest is the Randomize feature, which allows you to "roll the dice" and see what kind of face you get. If you chance upon a set of facial features you like, you can then refine your look using the facial feature sliders.

To use the Randomize feature, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Appearance tab, and then navigate to the Details > Head tab.

  3. Click on the > arrow located to the right of the Randomize control panel to expand it.

  4. Increase or decrease the "randomness factor" by adjusting the associated slider. The larger the randomness factor, the more dramatically different each random generation will appear.

  5. When you are ready, click the Randomize button.

If you end up with an avatar that looks a little too random, you can always click the Undo Randomization button to restore your avatar's previous appearance, or click the Reset button to revert your avatar to the default masculine or feminine human settings.

When you are happy with your changes, be sure to click the Save button. If you prefer to throw away all of your changes and keep your last saved appearance, click the Discard button.

The Bodies tab

When you are happy with your changes, be sure to click the Save button. If you prefer to throw away all of your changes and keep your last saved appearance, click the Discard button.

Choosing an avatar skin

To change your avatar's skin, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Appearance tab, and then navigate to the Details > Skins tab.

  3. Click on the skin you want to use.

After choosing a new skin for your avatar, you can refine its texture using the Skin Bumpiness slider. Decreasing bumpiness will make your avatar's skin look smooth, while increasing bumpiness will make it look more matte or rough, depending on the lighting.

When you are happy with your changes, be sure to click the Save button. If you prefer to throw away all of your changes and keep your last saved appearance, click the Discard button.

Skin Shade and Skin Shininess

The Skin Shade and Skin Shininess features are available through the Appearance > Details > Skins tab. While these interfaces look the same, each controls a slightly different aspect of your overall skin color.

  • Skin Shade refers to the general tint of your chosen skin. For instance, you could use this feature to tint a pale skin deep green for an alien costume contest.

  • Skin Shininess refers to the tint of the shine that appears when light hits your skin. To continue our example, you might add a red shine to your alien avatar's green skin for added "otherworldliness" and dimension.

To edit either the Skin Shade or Skin Shininess features, follow the steps below.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Appearance tab, and then navigate to the Details > Skins tab.

  3. Click on the skin you want to apply to your avatar.

  4. Click on the > arrow located to the right of either the Skin Shade panel or the Skin Shininess panel, or both.

  5. Select your tint color(s) using the color palette and HSB sliders, or enter a hex or RGB code into the relevant boxes.

  6. When you are done, click the OK button. To discard your changes, click the Cancel button.

The Wardrobe tab

Wearing and removing avatar components

The Wardrobe tab contains a number of avatar component categories. You can expand any category by clicking on the > arrow to the right. You can also search for an item using the search field at the top.

To wear an item, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Wardrobe tab.

  3. Expand the category you need by clicking the > arrow to the right of its name. For example, you can expand the Accessory category to find any bracelets, glasses, and rings you own, or expand the Top category to find a suit jacket.

  4. In the window that appears, locate the item you want to wear. Click on the item to add it to your avatar.

  5. When you are satisfied with your changes, click the Save button. To discard your changes, click the Discard button.

Editing avatar components

Some avatar components have features that can be edited or customized by the user, which may include:

  • Object position, size, and rotation

  • Material transparency and texture

  • Color or tint

To edit an avatar component, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click on the Wardrobe tab or the Wearing tab, and locate the worn item you want to edit.

    1. If you are using the Wardrobe tab, click the pencil icon in the bottom right corner of the avatar component tile to access customization options.

    2. If you are using the Wearing tab, customization options will be displayed automatically.

  3. Within the customization options, you may see:

    1. Material Alpha and Smoothness sliders that allow you to customize the transparency and texture of the item.

    2. Color palettes that allow you to customize the color or tint of the item.

  4. Once you're done customizing an item, be sure to click the Save button to save any changes you make. You can also remove the item from your avatar by clicking the Remove button.

Using avatar morphs

Morphs are another way you can apply predefined body shape settings to your avatar. If you own any morphs, you will find them listed under the Wardrobe tab > Bodies category.

The Wearing tab

The Outfit List tab

The Outfit List tab contains all of your saved outfits. Here you can switch between outfits, delete them, or copy the outfit ID number should you need it.

Here's a brief overview of the UI.

Selecting a saved outfit

To select one of your saved outfits to wear or for further editing, follow these steps.

  1. Open the Outfit window by clicking the Outfit button at the bottom of your screen.

  2. Click the Outfit List tab.

  3. Click on the outfit you would like to wear or edit.

  4. When you are satisfied with your changes, click the Save button. To discard your changes, click the Discard button.

Communicating with other users

You didn't come all the way to the Metaverse to hang out by yourself! Learn how to communicate with other users using text chat, voice chat, and in-world email.

Overview

Voice chat

Text chat

Direct message

To send a direct text message to another user, click on their avatar and select Instant Message in the action menu that appears. A new tab will open in the Chat window labeled with that user's name. After typing out your message in the text field, you can hit the Enter key on your keyboard or click the Send button to submit it.

In-world email

Receiving email

Here's a brief overview of the Mail window UI.

To open an email, click on the email preview in the Mail window. Once you're done reading, you can click the Delete button to delete the email forever, or click the Cancel button to return to the main window.

Sending email

There are multiple ways to send email within Breakroom.

Sending email to another user in the same Region

To send email to a user who is currently in the same Region as you, click on their avatar and then click Send Mail in the action menu that appears.

Sending email to a contact in your People list

Replying to a received email

Searching for an email recipient

No matter the contact method you use, the email composition window UI is the same.

Attaching items

You can also use in-world email to share virtual items with other users. To attach an item to your email, follow these steps.

  1. Click the Open Inventory button in the email composition window.

  2. An Inventory window will open. Click on the item you want to send.

    1. Breakroom will take 10% of the selling price as a fee for doing business on the platform.

    2. If the other user declines to purchase the item, they will not receive it.

  3. Once you're done composing your email, click the Send button.

  4. If you don't want to sell the attachment, click the OK button to confirm your choice.

To accept an attachment, click the Accept It or Buy It button after opening the email.

Toggles the window.

Allows you to from your Inventory (clothing, gestures, etc.) for one-click deployment.

Opens your .

Opens the .

Opens the .

Opens the .

Displays a list of that you own, along with various management options.

Opens the .

Opens the .

Opens the .

Launches the .

Opens the . Only visible to users with the appropriate .

Displays the amount of Gold you currently own.

Opens the Breakroom .

Opens the window. (Note that this name may appear abbreviated.)

Allows you to a Region.

Opens the .

Enables or disables .

If the Sine Wave Shop is enabled in your World, you can purchase virtual items using either Silver or Gold . These components can then be added to your avatar using the . With our huge selection of clothing and accessories—everything from business suits to fairy wings to nail polish—you can truly make your virtual stand-in stand out.

The Sine Wave Shop also contains a wide selection of vehicles, furniture items, gestures, and other tools. If you have the correct , you can add these items to Regions using the .

World Owners and World Administrators can via the . You may not have access to every function described in this section.

If your Breakroom World permits users to take advantage of Gold currency, you can replenish your wallet by clicking the Buy button in the . Breakroom accepts payment via credit card and PayPal.

You can open the Sine Wave Shop by clicking the Shop button located in the , or by pressing Ctrl + S on your keyboard.

Your avatar will appear in the preview window wearing the chosen clothing item. You'll see the cost in Silver and Gold listed, as well as the item's review score and its creator. Scrolling down will reveal item variations, if available.

Button
Function

If you prefer, you can add the item to your shopping cart by clicking the Add To Cart button. Once you're ready to check out, you can click the Cart button in the top right corner of the Sine Wave Shop window, or click the shopping cart icon in your . Both will take you to the same checkout window, where you can review your shopping cart, change the type of currency you want to spend (if applicable), and finalize your purchase.

Click the Inventory button located in the . This will launch the Inventory window.

World Owners and World Administrators can via the . You may not have access to every avatar customization option described in this section.

You can open the Outfit window by clicking the Outfit button located in the , or by pressing Ctrl + O on your keyboard.

Button
Function

Make sure the avatar you want to edit is currently active, or to edit.

Make sure the avatar you want to edit is currently active, or to edit.

The Appearance > Details > Bodies tab appears and functions much like the . You can adjust the relevant sliders to change your avatar's body shape and size, right down to the length of your fingers. You can also use the Randomize feature to generate a random physical appearance.

The Appearance tab also allows you to apply a skin to your avatar and edit it. Additional skins can be purchased through the .

Make sure the avatar you want to edit is currently active, or to edit.

Make sure the avatar you want to edit is currently active, or to edit.

Clothing items and other avatar components can be worn or edited through the Wardrobe tab. You can also access and apply to further customize your avatar shape.

Make sure the avatar you want to edit is currently active, or to edit.

To remove an item from your avatar, repeat the steps outlined above. When you click on a currently worn item in the Wardrobe tab, it will be removed from your avatar. Alternatively, you can remove worn items using the .

Customization options must be approved by the original item creator or uploader. You can check to see which customization options have been enabled for a particular item using either the or .

Make sure the avatar you want to edit is currently active, or . If you create a new avatar, you want to edit.

buttons that allow you to customize the item to better fit your avatar.

You can just like any other avatar component. Even when wearing a morph, you can still customize your appearance using the and settings available under the .

What is the difference between a preset and a morph? Presets contain different values for the face and body shape sliders available under the Appearance tab, while morphs actually change the default shape of the mesh that makes up your avatar. Imagine that you want to design a classic "gray alien" avatar with oversized black eyes. If you use the Appearance sliders to shape the eyes, then you have created a preset. If you use to create a new mesh head shape that includes the oversized eyes, and apply that to your avatar, then you have created a morph. You can use the Appearance sliders to make further adjustments to any morphs that you apply to your avatar. However, to return to the default human shape, you will need to remove any morphs that you are wearing.

The Wearing tab lists all of the items you are currently wearing to create your outfit. Here you can quickly access these items in order toor them.

Button or UI component
Function

Every professional starts with a single conversation—and Breakroom offers multiple ways to connect. Here you'll learn how to participate in public text chat, send direct text messages, access voice chat, and send in-world emails with attachments.

World Owners can to text chat and in-world email. If these features are disabled, users will only be able to communicate using voice chat.

Voice chat is available on a zone-by-zone basis. If you're in an area that permits voice chat, you will see a button that says Microphone Off at the top of your screen. Click on it, and its appearance will change to indicate that your microphone is now active. Alternatively, you can toggle voice chat by clicking the Microphone button located in the .

You can learn more about voice chat by reviewing our .

To access text chat, click the Show Chat button located in the . This will launch the Chat window. If there are multiple text chat channels available to you, you will see these listed as tabs across the top of the window. Once you've selected the channel you want to use, click on the text field at the bottom of the window and type out your message. You can then hit the Enter key on your keyboard or click the Send button to submit it.

If you've added other users to your , you can direct message them at any time by clicking the People button and then clicking on their name. Select Chat in the action menu that appears, and a direct chat tab will open as described above.

You can also for a user, open their , and click the Chat button in their profile to start a direct text conversation.

Breakroom's in-world email service allows you to send longform messages to multiple recipients. You can also distribute virtual objects, such as and , by attaching them to in-world emails.

If you receive an email from another user, a pop-up message on your screen will alert you. Click on the envelope icon in the to open the Mail window.

Button or UI component
Function

If an item is to the email, you can receive it by clicking the Accept It or Buy It button. If you don't want the item, you can close or delete the email without taking further action.

You can also send email by clicking on the name of a contact in your , and then clicking Send Mail in the action menu that appears.

To reply to an email someone else has sent you, click the in the Mail window.

If the user with whom you wish to communicate is located in another Region or is offline, you can use the search field in the to search for their name. If you like, you can filter the search results by checking the User option under Refine Search.

Once you've found the right person, click on their name in the search results. The other user's will open on your screen. Click the Mail button, and an email composition window will open.

Button or UI component
Function

Open the email composition window using your preferred method, as .

If you like, you can set a sale price for the item using either . If you do this, there are two important things to keep in mind:

Legs/feet zoom button

Camera will focus on the avatar's feet.

Body zoom button

Camera will focus on the avatar's body.

Head zoom button

Camera will focus on the avatar's head/face.

Zoom in

Camera will zoom in closer to the avatar.

Zoom out

Camera will pull back from the avatar.

Rotate left

The avatar will rotate left.

Rotate right

The avatar will rotate right.

Pan up

The camera will pan upward.

Pan down

The camera will pan downward.

Button or UI component

Function

Current Outfit Bar (top center)

Displays details about the current outfit (name, outfit ID).

Save As button (top center)

Saves a copy of the current outfit under a new name.

Delete button (top center)

Deletes the current outfit.

Create New Outfit button (bottom center)

Creates a new base avatar for customization.

Avatar height slider (bottom left)

Adjusts the overall height of the avatar, while maintaining its current proportions.

Appearance tab

Displays avatar appearance and customization options.

Wardrobe tab

Displays a user's full collection of avatar components and accessories.

Wearing tab

Displays only the items a particular avatar is currently wearing.

Outfit List tab

Displays saved Outfits.

Camera panel (bottom left)

Adjusts the camera angle and focus point within the Outfit window.

Discard button

Discards any unsaved changes and reverts the avatar to its previous appearance.

Save button

Saves any changes made to the outfit and exits the Outfit window.

Pan up

The camera will pan upward.

Pan down

The camera will pan downward.

Rotate left

The avatar will rotate left.

Rotate right

The avatar will rotate right.

Zoom in

Camera will zoom in closer to the avatar.

Zoom out

Camera will pull back from the avatar.

Legs/feet zoom button

Camera will focus on the avatar's feet.

Body zoom button

Camera will focus on the avatar's body.

Head zoom button

Camera will focus on the avatar's head/face.

Refresh List button

Refreshes the Outfit List.

Add Outfit button

Creates a new default human avatar for customization.

Delete button

Deletes the outfit you are currently wearing.

Search field

Allows you to search for a saved outfit.

Avatar icon (male or female head)

Loads the chosen outfit.

Copy ID button

Copies the ID number that identifies that unique outfit.

New Mail button

Opens the email composition window.

Manage button

Allows you to select and delete multiple emails.

Email preview

Opens the selected email.

Reply icon

Starts a new email and auto-fills the recipient field.

Trash icon

Deletes the relevant email.

Back button

Takes you to the main Mail window.

Recipient field

Lists the recipient(s) you wish to contact.

Select More button

Allows you to select additional recipients.

Content field

Contains the contents of your email.

Open Inventory button

Allows you to attach virtual items to your email.

Send button

Sends the email.

Cancel button

Cancels the email and deletes your draft.

text chat
bookmark items
user profile
People window
Explore window
Meetings window
Regions
Inventory window
Outfit window
Sine Wave Shop
Snapshot feature
Region Editor
permissions
currency
email window
Region Information
bookmark
Settings window
voice chat
currency
Outfit window
user permissions
Region Editor
enable and disable parts of the UI
Dashboard
top toolbar
bottom toolbar
currency
top toolbar
bottom toolbar
enable and disable parts of the UI
Dashboard
bottom toolbar
create a new avatar
create a new avatar
Head tab
Sine Wave Shop
create a new avatar
create a new avatar
morphs
create a new avatar
Wearing tab
Wardrobe
Wearing tabs
create a new avatar
add the avatar component
Move, Rotate, and Resize
add or remove a morph
Head
Bodies
Appearance tab
Unity
edit
remove
network
enable or disable access
Settings toolbar
conference system quick-start guide
bottom toolbar
People list
search
user profile
bookmarks
camera settings
top toolbar
attached
People list
Reply icon
top toolbar
profile
detailed above
Silver or Gold currency

Using the conference system

Breakroom's conference system is the foundation upon which virtual events are built. Learn how to access voice chat, screen share, emojis, and other important features.

Overview

Breakroom's conference system consists of several collaborative and interactive tools, as well as in-world seating options and breakout areas. This quick-start guide is intended for new event attendees, and explains:

  • Where to find the conference system tools

  • How to use voice chat

  • How to turn on your webcam

  • How to share your screen

  • How to change the location of your on-screen video feed

  • How to use the "raise hand" and emoji reactions

  • How to submit a question to the Moderators

  • How to sit down in an audience seat and use the built-in gestures and camera system

  • How to use presenter seats

  • How to use breakout areas

  • How to get around an event Region

Users with Moderator permissions can find more information about the moderator tools in our Running Your Event section. If you encounter any technical problems, you can also find more information on troubleshooting common audio and video issues.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every function described in this section.

Conference system controls

Upon entering a conference Region, you'll see the conference system control panel appear at the top of your screen. For most attendees, these tools fall into two categories—communication and navigation.

Communicating at an event

The conference system communication panel allows you to access voice chat, share your screen, react with emojis, collaborate with other users on web-based applications, and more. Here's a brief overview of the UI (read left to right, top row to bottom row).

Button
Function

Microphone Off / On

Video Off / On

Screenshare Off / On

Device Options

Screen Appearance ("See in World / See on Screen")

Raise Hand

Causes a hand icon to appear over your head until dismissed. Useful for impromptu polls, audience questions, and more.

Emoji

Web Collab

Question

Voice chat

If voice chat is available in your current location, you will see the Microphone button appear at the top of your screen. To get started with voice chat, follow these steps.

  1. Click the Microphone button. A pop-up will appear asking you to grant Breakroom permission to access your microphone. To continue, click the Enable button.

  2. Once activated, the microphone icon will turn green and the button text will change to "Microphone On." This indicates that your microphone is live, and that other users can hear you in voice chat.

  3. To mute your microphone, click the Microphone button again.

You can also control your microphone using the Settings toolbar located in the bottom right corner of your screen. Click the Microphone button to turn your microphone on, and you'll see a checkmark appear to indicate that your microphone is live. Click the button again to turn your microphone off.

Depending on the setup of your Breakroom World, you may have access to additional communication options, such as text chat and in-world email.

Webcam streaming

If you move your avatar into an area where you have permission to share your webcam, you'll see the Video button appear at the top of your screen. To start streaming video, follow these steps.

  1. Click the Video button. A pop-up may appear asking you to grant Breakroom permission to access your camera. To continue, click the Accept button.

  2. Once activated, the camera icon will turn green and the button text will change to "Video On." This indicates that your webcam is live, and that other users can see and hear you.

  3. To turn off your webcam, click the Video button again.

Screen share

If you move your avatar into an area where you have permission to share your computer screen, you'll see the Screenshare button appear in the conference controls. To get started, follow these steps.

  1. Click the Screenshare button. A pop-up may appear asking you to grant Breakroom permission to access your computer. To continue, click the Accept button.

  1. The screenshare control panel will appear on your screen. Here you can choose a desktop or individual screen to share. You can also choose whether or not to share your computer audio by toggling the Share system audio option.

  2. When you are satisfied with your choices, click the Share button. If you've elected to leave voice chat off, you may be asked to confirm this decision.

  3. Once activated, the screen icon will turn green and the button text will change to "Screenshare On." This indicates that your screen is live, and that other users can see what is happening on your computer.

  4. To stop sharing your screen, click the Screenshare button again.

Screen appearance

By default, when users share their webcam or computer screen the video will be displayed on an in-world screen. The Screen Appearance button allows you to "detach" streaming media from the in-world screen for better viewing. The button text will change based on the setting you select.

By toggling "See on Screen" mode, you can view streaming media in a separate window. You can expand this window by clicking the full screen toggle in the upper right corner.

If multiple presenters are streaming media at the same time, you will see multiple preview windows parked underneath the conference controls while in "See on Screen" mode. You can switch between webcam and screen share feeds by clicking on these windows.

Raise Hand and Emoji buttons

Clicking the Raise Hand button animates your avatar, allowing them to raise their hand. A colorful hand icon will also appear over your avatar's head, and remain there until you dismiss it by clicking the Raise Hand button again. Moderators can take note of who raises their hands, and may reach out to assist or collaborate with you.

Hovering your cursor over the Emoji button reveals a menu of various emojis. When one is clicked, the emoji will be displayed in an animated burst above your avatar's head.

Submitting questions

You can submit a question to the Moderator queue by clicking the Question button located at the top of the screen. Enter your question in the dialogue box that appears, and then click the Submit button.

Seats and gestures

When you enter an auditorium, breakout space, or any area that contains furniture designed to work with the Breakroom conference system, you will see blue tags hovering over the available seats. To sit down, click on a blue seat tag.

Once you are seated, two panels will appear on the left side of the screen. These panels allow you to emote via single-person gestures and adjust your current camera angle. The Free Look button releases your camera so that you can control it manually, using Breakroom's standard camera controls.

To stand up again, click the Stand Up button that appears at the bottom of your screen.

If the camera control buttons become unresponsive while you're seated in a chair, press the Esc key to exit fly camera mode.

Presenter seats

If you have been invited to make a presentation or participate in a roundtable discussion, you may be asked to stand or sit on a presenter seat. By using a presenter seat, you'll gain access to voice chat and media sharing functions within a particular voice zone, even if these functions are restricted for most visitors.

To take up a presenter seat, click on the blue seat tag indicated to you. Presenter seats are normally located in an obvious place, like on a stage or at the front of a breakout area. To leave the presenter seat, click the Stand Up button that appears at the bottom of your screen.

Breakout areas

Most Breakroom Regions contain multiple voice zones. Only users with avatars located inside a particular voice zone can use voice chat, webcam streaming, and screen share to communicate with other users in that zone. This design makes it possible for different meetings or events to be held concurrently in the same Region without technical interference or audio competition.

When you approach the edge of a voice zone, a transparent blue boundary indicator will appear. This serves as a reminder that you are leaving your current voice zone and entering a new one.

Keep in mind that you may not be able to hear or speak with avatars located on the other side of a boundary indictor, even if you can see them. To use a breakout area, you will need to move your avatar inside.

Navigating an event

In addition to Breakroom's Region navigation tools, the conference system includes several panels designed to help you travel between important event spaces.

The General Navigation panel

The General Navigation panel contains quick teleport links to key areas in the event Region. If seats are available, you will be seated automatically upon arrival.

Button

Target location

Auditorium

Teleports your avatar to the auditorium.

Entrance

Teleports your avatar to the Region entrance or to a designated information booth.

Networking

Teleports your avatar to the designated lounge or networking area.

Floor

Teleports your avatar to the main "floor" of the event (e.g. vendor booths, game area).

The General Navigation panel's appearance can vary. Based on the contents of a particular Region, you may not see all of the teleport links pictured above. You may also see different icons for each area type (e.g., a cocktail glass instead of a coffee cup).

The Breakout Rooms panel

The Breakout Rooms panel allows you to teleport your avatar directly to a numbered breakout area.

The Areas of Interest panel

This panel is visible on the right side of the screen when activated, and can be set up to offer direct teleport links to any voice zone that is not listed in either the General Navigation panel or Breakout Rooms panel.

Using Breakroom for Training

The Breakroom for Training system can be added to any Region to facilitate student- or teacher-led instruction. Learn how to track your learning progress, take quizzes, and access in-world tools.

Overview

The Breakroom for Training system is designed to support online learning through the streamlined management of educational content. World Owners and other stakeholders can create student- or instructor-led courses consisting of structured learning modules, waivers, and quizzes, and integrate these touchpoints into live online instruction.

This section will show you how to access the Breakroom for Training tools as a student. For more information about creating Breakroom for Training courses or administering courses as an Instructor, please see our Breakroom for Training section.

Logging in

When you enter a Region that contains the Breakroom for Training system, you'll see the Breakroom for Training widget appear automatically on your screen. This widget can be dragged around the screen by clicking and holding the center button.

Upon login, you'll be guided through a quick tour of the widget tools. For reference, here's an overview of the four buttons, starting in the upper right corner and moving clockwise.

Button
Purpose

Quiz Activity

Allows you to review your quiz activity and progress for all active courses.

Opens your own personal in-world notepad, where you can take notes for each course.

Notifications

Contains notices, alerts, and messages about your course activity.

Allows you to view descriptions of all offered courses.

It's important to note that Breakroom for Training notifications will not persist between user sessions. When you log off, this information will no longer be accessible to you.

Taking quizzes

As Breakroom for Training courses are live and instructor-led, all quizzes are pushed forward by the teacher. Quizzes may contain a mix of timed and untimed material, multiple choice questions, free answer spaces, and matching games.

Question cards may contain See Reference Links or See Reference Images buttons. Clicking on these buttons will allow you to review material that may be necessary to answer a question, such as charts or writing excerpts.

The top portion of each question card contains grading requirements. Here you can see:

  • Whether the question is required or optional

  • What the answer requirements are (for example, you may need to make two choices, or write a minimum number of words)

  • Whether the answer requirements have been met (denoted by a red light or a green light)

  • How many points the question is worth

  • How many total questions are on the quiz

You can navigate between questions by using the forward and back arrows in the top right corner, or by clicking the Previous and Next buttons at the bottom of the quiz screen.

When you're done taking a quiz and click the final Next button, you'll be asked to confirm whether you want to submit your quiz for a final grade. Click the Submit button to do so, or click the Review button to continue working.

Completing waivers

Waivers can consist of syllabus information, content warnings, disclaimers, or requests for feedback. Just like quizzes, Instructors can push waivers to students. When you receive one, review the included information and click the relevant button to register your response.

Language and accessibility

Breakroom is for everyone—period. Learn more about our language support and visual accessibility options, and access the tools you need to make communication easier.

Overview

Breakroom is committed to hosting events where everyone feels included. This includes offering language support and visual accessibility options to help foster meaningful communication.

Language support options

Language support is built directly into Breakroom. Support offerings may vary based on:

  • Whether you're logging in on a desktop application or using World Stream.

  • Whether your device is running Windows or macOS.

Currently, we offer display language support (such as translated UI components) and keyboard support. Below you will find tables detailing which options are available based on your login method and your computer operating system.

Desktop app support

Language
Desktop app

Korean

Language & keyboard

Brazilian Portuguese

Language & keyboard

German

Language & keyboard

French

Language & keyboard

Spanish

Language & keyboard

Mandarin

Language & keyboard

Japanese

Language & keyboard

World Stream support

Language
Windows
macOS

Korean

Language only

Language only

Brazilian Portuguese

Language & keyboard

Language & keyboard

German

Language & keyboard

Language only

French

Language & keyboard

Language & keyboard

Spanish

Language & keyboard

Language & partial keyboard

Mandarin

Language only

Language only

Japanese

Language only

Language only

Changing the Breakroom display language

To select your Breakroom display language, follow these steps:

  1. Launch the Breakroom desktop application or World Stream.

  2. On the login page, click the Language drop-down menu and select the display language you would like to use.

  3. Enter your account credentials and click the Login button.

Visual accessibility options

This section is currently under construction. In the meantime, the following links may be of assistance.

For individual users:

  • Changing the default UI scale

For World Owners and World Administrators

  • Changing the default UI scale

  • Customizing the UI colors

  • Enabling and disabling UI elements

Reporting issues

True technological innovation never did run smooth. If you encounter technical issues or problematic users while accessing the Breakroom platform, here's how to let someone know.

Overview

Despite our best efforts, sometimes things in the Metaverse can get a little wonky. If you run into a glitch on your journey, or if you encounter an abusive user, the best thing you can do is file a report. Our team will review your information and take action if necessary.

Reporting bugs

Bug reports help our team identify and address tech issues on the platform. When filing a report, please be sure to include as much information as possible about the bug, including:

  • What you were trying to accomplish when the bug occurred

  • What you expected to happen, and what happened instead

  • Any steps you took prior to encountering the bug

Including a log file and a screenshot of the bug can be very helpful. You can do this by ensuring that the "Include a log file" and "Include a screenshot" options are checked before you click the Send Feedback button.

Reporting a bug on the desktop app

If you're using the Breakroom desktop viewer, you can access the bug report window by pressing the F5 button on your keyboard, or by pressing Ctrl + Shift + P.

Reporting a bug on World Stream

If you're accessing Breakroom using World Stream, you can access the bug report window by clicking the FN or FN Keys button at the top of the screen, and then clicking the F5 button.

Reporting users

If you encounter a user who is behaving in a rude, aggressive, or demeaning way, or who is otherwise violating Breakroom's Terms of Service, we encourage you to file an abuse report. You can do so by clicking on the problematic user and selecting Abuse Report in the action menu that appears.

You can also mute the user by repeating the steps above, and selecting Mute/Unmute in the action menu.

If the user is no longer available for you to click, you can file an abuse report using the bug report form, which can be accessed using the steps detailed above. Please uncheck the "This is a bug report" option when submitting the form.

In addition to contacting Breakroom about abusive users, we encourage you to contact your own Breakroom World team in accordance with your institution's policies and support procedures.

Bookmarks and teleport invites

There's no need for airports or carpool lanes in the Metaverse—with Breakroom's suite of teleportation tools, you can get exactly where you need to go fast.

Overview

Teleportation lets you travel instantly to different locations both within and between Regions. In this section, we'll take a look at bookmarks and teleport invites and explain how they can be used to get around.

Bookmarks

Bookmarks are like virtual "pins" tacked on Breakroom's Metaverse map. By creating a bookmark, you can save the coordinates of a particular Region you might like to revisit. You can also share bookmarks with other users and use them to set specific landing points for any meetings that you schedule.

Creating bookmarks

To create a bookmark, follow these steps.

  1. Navigate your avatar to the area you want to bookmark. Keep in mind that the bookmark coordinates will point to the exact point where your avatar is positioned.

  2. When your avatar is in the right spot, click the Bookmark button located above the mini map.

  3. In the dialog box that appears, enter a name for your bookmark and click the OK button. This will create a bookmark object in your Inventory.

Using bookmarks

Once you've created a bookmark, you can use it to travel to a saved area by following these steps.

  1. Open your Inventory by clicking the Inventory button in the bottom toolbar. Click on the Bookmark category to expand it.

  2. Locate the bookmark you want to use, and click on it. In the action menu that appears, click the Teleport button.

Editing bookmarks

There are additional management functions available through the bookmark action menu.

  • To rename a bookmark, click the Rename button and enter the new name when prompted.

  • To rate the quality of a bookmark, click the Rate button. Choose your rating, and then click the OK button.

  • To delete a bookmark from your Inventory, click the Delete button.

Sharing bookmarks

The only way to share a bookmark is by attaching it to an in-world email. Once the recipient has accepted your attachment, they'll be able to use and edit their copy of the bookmark as described above.

To attach a bookmark to an in-world email, follow these steps.

  1. Open the email composition window using your preferred method.

  2. Click the Open Inventory button in the email composition window.

  3. An Inventory window will open. Click on the item you want to send.

  4. If you like, you can set a sale price for the item using either Silver or Gold currency. If you do this, there are two important things to keep in mind:

    1. Breakroom will take 10% of the selling price as a fee for doing business on the platform.

    2. If the other user declines to purchase the item, they will not receive it.

  5. Once you're done composing your email, click the Send button.

  6. If you don't want to sell the attachment, click the OK button to confirm your choice.

Teleport invites

You can meet up with other users in real time by teleporting to their location, or by inviting them to teleport to yours. There are multiple ways to accomplish this.

Teleporting to other users

  1. If the other user is listed as a contact in your People list, click on their name and then click Teleport to User in the action menu that appears. Your contact will see a pop-up asking them to grant or deny your request.

  2. If the other user is not yet one of your contacts, you can use the search field in the top toolbar to search for a full or partial name. Once you've found the right person, click on their name to open their user profile, then click More > Teleport to User. The other user will be see a pop-up asking them to grant or deny your request.

Inviting users to teleport to you

To ask a user to join you, repeat the steps outlined above, but click the Invite Here button. The other user will receive your teleport invitation, and will have the option to accept or dismiss it.

Region navigation tools

The Metaverse is meant to be explored—so don't just stand there! Here we'll review some basic movement commands before showing you new ways to explore your Breakroom World.

Overview

This section is designed to serve as a quick overview of the in-world navigation tools. You'll learn how to read the Region mini map, how to teleport between important areas using the conference system navigation panels, and how to use search, teleport portals, and the Explore window to visit new Regions.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every function described in this section.

Basic movement commands

As a refresher, here's a rundown of Breakroom's avatar movement controls. You can find more detailed information about controlling your avatar in our Getting Started section.

Button or command
Function

WASD or arrow keys

Pressing the WASD or arrow keys will cause your avatar to walk or turn in the specified direction.

Shift + WASD or arrow keys

Holding down the Shift key while moving will cause your avatar to run.

Space bar

Pressing the space bar will cause your avatar to jump.

C key

Pressing the C key will cause your avatar to crouch.

F key

Pressing the F key will cause your avatar to start or stop flying.

While flying > WASD or arrow keys

While your avatar is flying, you can move them through space using the WASD or arrow keys.

While flying > R and C keys

While your avatar is flying, press the R key (or Pg Up key) to fly higher, and the C key (or Pg Down key) to fly lower.

If the "click to walk" feature is enabled, you can move your avatar to a specific spot by pointing your mouse cursor at the ground and clicking the left mouse button. You can also change your default walking speed in the Settings window.

Conference system navigation panels

As noted in our conference system quick-start guide, the system includes several panels designed to help you travel between important areas within an event Region. You can find these panels arranged along the top and sides of your screen. Click any button to teleport your avatar to that area.

The General Navigation panel

The General Navigation panel contains teleport links to key event areas. If seats are available in a particular area, your avatar will be seated automatically upon arrival.

Button

Target location

Auditorium

Teleports your avatar to the auditorium.

Entrance

Teleports your avatar to the Region entrance or to a designated information booth.

Networking

Teleports your avatar to the designated lounge or networking area.

Floor

Teleports your avatar to the main "floor" of the event (e.g. vendor booths, game area).

The General Navigation panel's appearance can vary. Based on the contents of a particular Region, you may not see all of the teleport buttons pictured above. You may also see different icons for each area type (e.g., a cocktail glass instead of a coffee cup).

The Breakroom Rooms panel

The Breakout Rooms panel allows you to teleport your avatar directly to a numbered breakout area.

The Areas of Interest panel

This panel is visible on the right side of the screen when activated, and can be set up to offer direct teleport links to any voice zone that is not listed in either the General Navigation panel or Breakout Rooms panel.

The mini map

The mini map in the top right corner of the screen displays a top-down view of your current Region. You can use the magnifying glass buttons to zoom in and out. Clicking on the mini map itself will open the Region Information window.

On the mini map, you will see landing areas marked with a pink dot. The location of your avatar is marked with a blue dot, while other avatars are represented by green dots.

Region search

The search field located in the top toolbar can be used to search for Regions by name. Clicking on a Region in the search results will open the Region Information window. You can then teleport to that Region by clicking the "Enter the region" button.

Teleport portals

Breakroom Teleport Portals can be set up to enable travel between different Regions. If you see a Breakroom Teleport Portal, you can activate it by walking your avatar "into" it. A pop-up will appear containing a list of accessible Regions, and you can click on any destination tile to learn more about that Region. If you wish to teleport there, click the Teleport button.

The Explore window

The Explore window allows you to browse through a list of Featured Regions. You can learn more about a Region by clicking its listing card, and teleport there by clicking the Enter button.

Bookmarks

If someone sends you a bookmark through Breakroom's in-world email system, you can use it to travel to a new area or Region by following these steps.

  1. If you haven't yet accepted the bookmark, click the Envelope button in the top toolbar to open the Mail window. Click on the relevant email, and then click the Accept It or Buy It button for the bookmark attachment.

  2. Open your Inventory by clicking the Inventory button in the bottom toolbar. Click on the Bookmark category to expand it.

  3. Locate the bookmark you want to use, and click on it. In the action menu that appears, click the Teleport button.

Teleport invites

If another user invites you to teleport to their location, a pop-up will appear asking for your consent. You can click the Refuse button to decline the invitation, or click the Teleport button to accept.

Using the Meetings window

Stay on task using Breakroom's built-in Meetings calendar, and never miss a virtual beat. Advertise events, invite users to RSVP, and provide handy teleport bookmarks.

Overview

Opening the Meetings window

The Meetings window UI

In the Meetings window, you will see events listed in chronological order. Here's a brief overview of the UI.

Finding and attending meetings

To learn more about a meeting, click on the listing in the Meetings window. If the meeting is of interest to you, click the Attend button to RSVP. Doing so will add the event to the My Meetings tab.

Scheduling meetings

To schedule a meeting, follow these steps.

  1. Open the Meetings window by clicking the Meetings button located in the bottom toolbar.

  2. In the Meetings window, click the Create button located in the top right corner.

  3. Enter the required information:

    1. Enter the meeting name.

    2. Select a date, start time, and duration for the meeting. (Note: Please enter the start time in your local time.)

    3. Click the Select a Region button. In the menu that appears, select the Region where you want your meeting to take place. (Note: You can use the search field to locate a specific region.) Click the Confirm button when you are satisfied with your choice.

    4. Select a privacy setting for your event by ticking either the Public or Only Invited checkbox.

    5. Enter a meeting description.

  4. Click the Save button.

If you set your meeting to Public, anyone will be able to view the event in the Meetings window, RSVP, and attend. If you set your meeting to Only Invited, you will need to invite attendees using these additional steps.

  1. Click the Add Attendees button. This will open the Invite Attendees window.

  2. To invite individual users: Using the tabs on the left, locate the users you want to invite. Click on each attendee's name to highlight it, or check the Select All box at the top of a user category to invite all of the listed users. You can also use the search field to locate users.

    1. Category listings include:

      1. Invited List: All users currently invited to the meeting.

      2. All Attendees: All users who have accounts on your World.

  3. When you have chosen all the attendees you want to invite, click the Select button.

Once you have scheduled an invite-only meeting, invitations will go out on the Breakroom platform, allowing users to RSVP. Public meetings will immediately be published in the Meetings window.

Editing meeting details

To edit a meeting you've already published, open the Meeting window and click on the meeting listing. Then click on the... button to edit or delete the event.

Using direct bookmarks

  1. Navigate your avatar to the Region you want to use. Make sure your avatar is standing exactly where you want attendees to land.

  2. In the dialog box that appears, enter a name for your bookmark and click the OK button. This will create a bookmark object in your Inventory.

Once you have your bookmark prepared, you can add it to the meeting details.

  1. After you select the event Region, use the Select Bookmark drop-down menu to choose the bookmark you just created.

  2. Once you are satisfied with your meeting details, click the Save button.

Using the Explore window

Regions are so fun, you can't visit just one. Learn how to use the Explore window to locate, learn about, and travel to Featured Regions.

Overview

Opening the Explore window

The Explore window UI

The Explore window contains a search bar, as well as several category tabs designed to assist with Region navigation and promotion. Here's a brief overview of the UI.

To learn more about a Region, click on its listing card. To visit a Region, click the Enter button located in the listing card.

Networking with other users

In Breakroom, networking is everything. Learn how to curate your contact list, join and create in-world groups, and turn your user profile into your digital calling card.

Overview

Breakroom's networking tools are designed to help you make the most of the very real relationships forged in your virtual World. By combining the power of your user profile, the People window, and the Groups window, you can:

  • Make it easy for other users to access your professional information

Accessing your user profile

Editing your user profile

In Breakroom, user profiles function much like virtual business cards or employee badges. When you access a user profile, including your own, the first thing you'll see is the Details tab. This tab contains helpful information that you may want others to know, such as:

  • Your job title

  • Your location

  • Links to your social media pages

  • Your activities and interests

In addition to the information listed on the Details tab, when other users view your profile they can navigate to:

  • The Regions tab, which displays all of the Regions that you own.

  • The Badges tab, which lists your achievement badges.

Accessing another user's profile

Snapshots

Build a library of virtual memories with Breakroom's Snapshot feature. Learn how to take pictures, share them with people both in and out of Breakroom, and add pictures to your user profile.

Overview

Breakroom's Snapshot feature is a convenient tool that allows you to take and share virtual photographs. Whether you need to capture a moment for use in your company's marketing materials or want to post a selfie of your avatar on social media, you can do so with a few clicks.

Taking photos

The Snapshot toolbar allows you to focus your camera, pose your avatar, and edit and embellish the photo itself. In the tables below, we'll locate and review each of these functions.

Snapshot UI overview

The six main tabs located along the top of the Snapshot toolbar lead to various options. Most of these buttons will change the contents of the horizontal scrolling menu when clicked.

Be sure to scroll through all of the options to see what's available—as with many things in Breakroom, the best way to learn is through experimentation. You can always undo a staged photo by clicking the Cancel or Exit Photo buttons in the top right corner of the screen.

Meanwhile, the options located at the bottom of the Snapshot toolbar allow you to fine tune and finalize your perfect shot.

Saving and sharing your photos

Once you've taken the perfect photo and chosen the format you want to save it in, it's time to decide where you want to save it. After clicking the Take Photo button, you will progress to the final save menu.

In the final save menu, you can enter a name and description for your photo before deciding how you would like to distribute it. You can select as many options as you like.

  • Check the "Email to" box and enter a valid email address to send a copy of the photo to yourself or someone else.

  • Check the "Save to this computer" box to save a copy to your local hard drive.

Click the Upload/Save button after you've made your choices. You can also click the Make Profile Pic button, which will showcase your photo in the top header of your user profile. The Retake Photo button lets you exit the save menu and start fresh.

Managing your photo library

To see and manage your photo comments, follow these steps.

  1. In your user profile, click on the Photos tab. Locate and click on the relevant photo in your gallery.

  2. Check the Comments box in the bottom right corner of the enlarged photo to display comments.

    1. Click the trash can icon next to any user comment you want to delete.

    2. Click the reply button next to any user comment you want to answer.

To delete a photo from your library entirely, click on the photo. Then click the trash can button in the bottom left corner.

If you want to delete multiple photos at once, you can check the box inside each photo in your gallery before clicking the trash can button.

Toggles your within voice-enabled zones.

Toggles your within video-enabled zones.

Toggles within video-enabled zones.

Allows you to and common audio and video issues.

Allows you to where video streamed by other users appears on your screen.

Opens the , where you can choose from several animated emojis (such as clapping hands). These emojis will float over your avatar's head.

Launches .

Allows you to submit a question for .

The Meetings window allows users with the to schedule virtual events and publish them for review. Attendees can manage their own calendars and teleport to the venue when it's time to meet, saving staff the hassle of teleporting users individually.

World Owners and World Administrators can via the . You may not have access to the Meetings window and other tools described in this section.

You can open the Explore window by clicking the Meetings button in the .

UI component
Function

When it comes time for the meeting, a notification will appear in the . Clicking the Enter button contained in this notification will teleport you directly to the meeting. You can also open the listing again and click the Enter button to teleport to the meeting space.

If desired, use the Select Landmark drop-down menu to select a for your Region visitors.

Contacts: All users in your .

To invite all members of a : Using the group tabs on the left, locate the group(s) you want to invite. Click on each group member's name to highlight it, or check the Select All box at the top of the group tab to invite every member of that group.

In addition to selecting a Region for your meeting, you can choose the precise location attendees will arrive. To get started, you will first need to your chosen landing spot by following these steps.

When your avatar is in the right area, click the Bookmark button located above the .

Using the, schedule a new meeting.

Breakroom World Owners and World Administrators can opt to list certain areas as . This has the benefit of adding them to the Explore window, where users can find them more easily.

World Owners and World Administrators can via the . You may not have access to the Explore window and other tools described in this section.

You can open the Explore window by clicking the Explore button in the , or by pressing Ctrl + E on your keyboard.

Button or UI component
Function

Build a list to facilitate in-world communication

Create in order to promote networking, organize events, or to specific areas

On this page, we'll explain how to locate your user profile and edit your personal details. In the sections that follow, we'll explore the and windows in more detail.

World Owners and World Administrators can via the . You may not have access to every function described in this section.

You can open your own user profile by clicking the Profile icon in the , or by pressing the F12 key on your keyboard.

You can edit these fields at any time by clicking the Edit buttons. An animated headshot of your avatar is also included, and will automatically update to reflect your avatar's current .

The Photos tab, which showcases any you've chosen to make public.

The Wearing tab, which lists the that you're wearing.

Other users will also see options to send you a or , remove you from their , or send a invite or request.

To view another user's profile, click on their avatar and select View Profile in the action menu that appears. You can also search for a specific person using the , or click on a user's name in your .

This section is designed to serve as a basic overview of the Snapshot tool. You'll learn how to take, edit, and share photos, as well as how to collect and display your favorite images in your .

World Owners and World Administrators can via the . You may not have access to the Snapshot feature and other tools described in this section.

You can open the Snapshot feature by clicking the Snapshot button in the , or by pressing Ctrl + ` on your Windows keyboard or Ctrl + \ on your Mac keyboard.

When the Snapshot feature is open, it will replace much of the existing on your screen. You will see the main Snapshot toolbar centered at the bottom of your screen, and an Exit Photo button appear in the top right corner.

Button or Tab
Function
Button or Check Option
Function

Check the "Upload to library" box to add the photo to your photo library.

After you've saved your photo, you'll be given the option to share it on social media. Click on the relevant button to post your photo on , , or .

If you choose to upload a snapshot to your photo library, it will appear under the Photos tab in your . This tab and any photos posted on it are visible to the general public. Other users can access your profile, click on your photos to access a higher resolution version, and leave comments.

Click the round Profile icon on the leftmost side of the . This will open your own user profile.

If you need to report an abusive comment, please do so before deleting the comment, as it will help to have a screenshot. You can learn more about filing in our section.

All Meetings tab

Displays all upcoming meetings.

My Meetings tab

Displays only meetings you have scheduled or indicated you will attend.

Search field

Allows you to search for a specific meeting.

Refresh button

Refreshes the meeting list.

Timeline view button

Lists meetings in a linear timeline.

Category view button

Lists Featured and Upcoming meetings.

Create button

Allows you to create a new meeting.

Attend/Attending button

Allows you to confirm or cancel your attendance at a meeting.

Search bar

Allows you to search for a Region by name.

Featured tab

Displays all of the Featured Regions in a particular Breakroom World.

Busy tab

Displays the World's busiest Regions (defined by current number of users).

Popular tab

Displays the World's most popular Regions (defined by number of user visits).

Contact's tab

Displays enabled, public Regions created by the contacts in your People list.

Region listing card

Opens the Region Information window for the chosen Region.

Enter button

Teleports you to the chosen Region.

Camera

Lets you select from a variety of photo angles.

Poses

Opens a menu of static poses that you can use to position your avatar.

Filters

Applies a photo filter to your chosen shot.

Overlays

Applies a variety of fun foregrounds and backgrounds to your chosen shot.

Target

Lets you click on an avatar or specific piece of scenery and zoom in on it.

Focal Point

Lets you click on a location to manually change the focal point of your shot.

Capture as animated GIF

Allows you to save your image as an animated GIF instead of a static photo. Once this option is checked, you can customize the GIF length by entering a number in the Seconds field.

Capture as 360° image

Allows you to save your chosen shot as a wide-angle 360° image.

Take Photo

Finalizes your shot, and takes you to the save menu.

microphone
webcam
screen sharing
change your device settings
troubleshoot
control
emoji menu
Breakroom Web Collab
Moderator review
My Notes
Course Info
appropriate
permissions
enable and disable parts of the UI
Dashboard
bottom toolbar
top toolbar
specific arrival point
People list
group
bookmark
mini map
steps outlined above
Featured Regions
enable and disable parts of the UI
Dashboard
bottom toolbar
contact
groups
control access
People
Groups
enable and disable parts of the UI
Dashboard
bottom toolbar
appearance
snapshots
avatar components
direct message
in-world email
People list
teleport
search field
People list
user profile
enable and disable parts of the UI
Dashboard
bottom toolbar
UI
user profile
Facebook
X
LinkedIn
user profile
bottom toolbar
abuse reports
Getting Started

People

The People window makes it easy to build your Metaverse network. Learn how to add and remove contacts, send messages and in-world emails, and invite others to join you in the fun.

Overview

The People window allows you to create and manage your own personal list of Breakroom contacts. If a contact is currently online, a pink dot will be displayed beside their name. Clicking on a username opens an action menu, allowing you to send messages, issue teleport invites, and access the contact's user profile with just a few clicks.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every function described in this section.

Opening the People window

You can open the People window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the People tab.

Adding a contact to your People list

In person

If you want to add a nearby user to your People list, you have a few options.

Option one: Click on that person's avatar and then click Add/Delete Contact in the action menu that appears. An invitation will be sent to the other user, which they will need to confirm before they are added to your contact list.

Option two: Click the People button to open the People window. If other users are close by, their names will be listed under the Nearby category. Click the > arrow to the left of the Nearby category to expand it, and then click on the user's name. Click Add Contact in the action menu that appears.

User search

To find a specific user, use the search field in the top toolbar to search for a full or partial name. If you like, you can filter the search results by checking the Refine Search > User option.

Once you've found the right person, click on their name to open their user profile, and then click the Add Contact button.

Managing your People list

Once you've connected with another user, you'll find their name listed in the People window. By clicking on a contact's name, you can:

  • View the contact's user profile

  • Send a direct message

  • Send in-world email

  • Invite the contact to teleport to your location, or ask to join them

  • Delete, mute, or report the contact

As a brief overview, the menu actions include:

Action

Function

View Profile

Opens the contact's user profile.

Chat

Opens a direct text chat with the contact.

Send Mail

Opens the in-world email window and automatically fills out the recipient field with the contact's name.

Invite Here

Extends a teleport invitation, allowing the contact to join you at your current location.

Teleport to Player

Sends a teleport request, allowing you to travel to the contact's current location if approved.

Delete Contact

Deletes the contact from your People list.

Mute

Mutes the individual, preventing further communication.

Report Abuse

Reports an abusive contact.

Groups

In-world groups aren't just virtual social clubs—they can also be used as powerful tools for event management. Learn how to join, create, and manage Breakroom groups.

Overview

Groups serve several functions in Breakroom, including:

  • Casual and professional networking

  • Streamlining the invitation process for private meetings

  • Region access control

The Groups window lists all of your current groups. You can search for a particular group using the search field located at the top of the window.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every function described in this section.

Opening the Groups window

You can open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

Accessing group information

If you belong to a group, clicking on its name will open the Group Information window. In addition to reviewing details about the group under the Info tab, you can click the "Chat in the group" button to begin a global text chat with all online members.

If you have the appropriate permissions, you may also see an Edit button in the Info tab > Permissions section. Clicking this button will allow you to make changes to the group's name, description, and group access type.

Finding and joining existing groups

If you know the name of a group you want to join, you can search for it using the search field in the top toolbar. If you like, you can filter the search results by checking the Refine Search > Group option.

Once you've found the right group, click the Detail button to open the Group Information window. Then click the "Apply to join" button. If the group is set to Public access, then congrats—you're officially a member! If the group is set to Contact Only or Approved Only access, your application will be submitted for review.

Creating a group

If you want to create a new group, open the Groups window and click the Create New Group button. This will open the Groups dialog box.

Here you can enter a name and description for your group. You can also change your group access type to Public, Contact Only, or Approved Only. When you're done, click the Save button.

Group access types

Group access type

Description

Public

Contact Only

Approved Only

Deleting a group

To delete a group, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Locate the group you want to delete, and click on its name to launch the Group Information window. Then click on the Members tab.

  3. Scroll to the bottom of the page, and click the "Delete this group" button. Follow the prompts to confirm deletion.

Managing group members

Approving group applicants

If you are the Owner, Administrator, or Moderator of a group that requires member approval, you will see membership requests appear in the Group Information window under the Members tab > Requests category. Here you can click the Edit button located to the far right of the individual's name in order to approve, block, or delete the user request.

To approve multiple users at once, check the boxes located to the left of their names and then use the Set Role drop-down menu to assign them all the same role. (For instance, you could select five users and approve them all at once by assigning them "Member" status.)

Adding and removing group members

To add a user to your group manually, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Click on the name of the group you want to edit. This will open the Group Information window.

  3. In the Group Information window, click on the Members tab, and then click the Add Members button. This will open the "Add new members" dialog box.

  4. Use the search field to search for the user's name. Once you find it, click the Add button.

To remove a user from the group entirely, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Click on the name of the group you want to edit. This will open the Group Information window.

  3. In the Group Information window, click on the Members tab, and use the search field to search for the user's name.

  4. Once you locate the user you want to remove, click the Edit button located to the right of their name. In the action menu that appears, click Delete.

You can remove multiple group members simultaneously by checking the boxes located to the left of their names, clicking the Set Status drop-down menu, and selecting Delete.

Deleted members can reapply for membership to the group. To ban a user from reapplying, select Block instead of Delete.

Assigning group roles

Within groups, there are several roles that members can be assigned. Some roles confer special powers and privileges, both within the group and when Regions are assigned to a particular group using the "Groups Only" Region access option.

In brief, these roles are:

Group Owners have absolute control over the group and its settings. If a group is set to Contact Only permissions, then any contacts on the Group Owner's People list will automatically be granted access to the group.

Owners can:

  • Manage and delete the group

  • Manage the group member list and deal with disruptive group members

  • Assign group members advanced permissions

When a Region is set to the "Groups Only" region access option, Group Owners have all the rights and permissions of a Region Owner.

Group Administrators can perform many of the same tasks as Group Owners. Administrators can invite users to Contact Only and Approved Only groups, and approve membership requests. They cannot appoint additional Administrators.

Administrators can:

  • Manage the group member list and deal with disruptive group members

  • Assign and manage advanced group permissions below the Administrator level

When a Region is set to the "Groups Only" Region access option, Group Admins have all the rights and permissions of a Region Admin.

Group Moderators can approve membership requests. They can mute, block, and reinstate members. They cannot appoint additional Moderators.

Moderators can:

  • Manage the group member list and deal with disruptive group members

  • Assign and manage advanced group permissions below the Moderator level

When a Region is set to the "Groups Only" Region access option, Group Moderators have all the rights and permissions of a Region Moderator.

When a Region is set to the "Groups Only" Region access option, Group Developers have all the rights and permissions of a Region Developer. Otherwise, they have no special powers.

Group Members have no special privileges, but they will be permitted to enter any Region that has been set to "Groups Only" Region access for that group.

Coming soon.

Designating a user as a VIP gives them no special powers. Currently, this role is only useful for Lua script functionality and presenter seats in Regions set to "Groups Only" Region access.

To assign a group member a different role, check the box located next to the member's name in the Members tab. Then use the Set Role drop-down menu to select the new role. You can assign users the Member role to revoke advanced permissions at any time.

You can assign multiple users the same role simultaneously by checking the boxes located to the left of their names and then using the Set Role drop-down menu to assign them all the same role.

Muting and banning group members

In order to mute or ban/block a user, that user must be a current member of your group.

Muting users

To mute a single user on group text chat, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Click on the name of the group you want to edit. This will open the Group Information window.

  3. In the Group Information window, click on the Members tab, and use the search field to search for the user's name.

  4. Once you locate the user you want to mute, you can either:

    1. Click the Edit button located to the far right of the user's name. In the action menu that appears, select Mute Chat.

    2. Toggle the Speech bubble icon located to the right of the user's name. When the blue check mark disappears, the user is muted.

To restore communication to a previously muted user, repeat steps 1-4 above, and either:

  1. Click the Edit button located to the right of the user's name. In the action menu that appears, select Unmute Chat.

  2. Toggle the Speech bubble icon located to the right of the user's name. When a blue check mark appears, the user can communicate over text chat.

To mute multiple users at once, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Click on the name of the group you want to edit. This will open the Group Information window.

  3. In the Group Information window, click on the Members tab, and locate the users you want to mute. Check the box located to the left of each user's name.

  4. Click the Set Status drop-down menu, and select Mute Chat.

To restore communication to multiple users, repeat steps 1-3 above. Then, click the Set Status drop-down menu, and select Unmute Chat.

Banning users

To block a user from participating in your group or reapplying for membership, follow these steps.

  1. Open the Groups window by clicking the People button in the bottom toolbar, or by pressing Ctrl + F on your keyboard. Then click the Groups tab.

  2. Click on the name of the group you want to edit. This will open the Group Information window.

  3. In the Group Information window, click on the Members tab, and use the search field to search for the user's name.

  4. Once you locate the user you want to ban, click the Edit button located to the far right of the user's name. In the action menu that appears, select Block.

To undo a ban, repeat steps 1-3 above. Locate the user under the Ban List, and then click the Edit button located to the far right of their name. In the action menu that appears, select Unblock.

To ban multiple users at once, follow these steps.

  1. Repeat steps 1-2 above.

  2. In the Group Information window, click on the Members tab, and locate the users you want to ban. Check the box located to the left of each user's name.

  3. Click the Set Status drop-down menu, and then click Block.

To undo a ban for multiple users, repeat steps 1-2 above. Then click the Set Status drop-down menu, and select Unblock.

Banning a member with Administrator, Moderator, Developer, or VIP permissions will revoke this special role. If you choose to unban such a user and reinstate them in the members list, please take a moment to ensure that they have been assigned the proper role.

Region settings

The Region Information window allows team members to customize settings for individual Regions. Learn how to restrict access to individuals or groups, mute users, add an audio stream, and more.

Overview

The Region Information window can be viewed by anyone, and contains useful information for Region visitors. Users with advanced World- or Region-level permissions can also find Region access, user moderation, and media tools in this window.

World Owners and World Administrators can enable and disable parts of the UI via the Dashboard. You may not have access to every function described in this section.

Opening the Region Information window

You can open the Region Information window by clicking the Region Information button located above the in-world mini map. This button will be labeled with the name of the Region itself, which may be abbreviated.

Users can access this window in any Region where the mini map is enabled. In addition to reviewing the Region's name, description, and permissions settings, users can also "Like" the region or create a bookmark so they can easily return. The Region Owner and Administrators are identified in the List of Admins section, giving users a way to reach out for assistance.

Changing Region settings and permissions

In addition to the universal functionality described above, Region Owners and Region Administrators can access advanced Region settings by clicking the Edit button located in the Permissions panel.

Here team members can:

  • Edit basic information about the Region, such as its name and description

  • Choose a Region-wide audio stream, or turn it off

  • Control who can access the Region

  • Control who can spawn items, and how long those items will exist in the Region before they are automatically deleted

  • Control who can use voice chat, or disable voice chat altogether

  • Control whether the Region shows up in search or can be found via the Explore window

Most of these advanced settings can be enabled by checking the box beside the setting and then clicking the Save button. To disable a setting, uncheck the relevant box and then click the Save button.

For more detailed information about Region access settings, please review the relevant section on this page.

Region-wide audio streams

Using the Region Information window, Region Owners and Region Administrators can enable a Region-wide audio stream. This stream will play automatically for users upon entry to the Region, and can be controlled using the audio stream and volume controls located in the settings toolbar.

Enabling an audio stream

To enable a Region-wide audio stream, follow the steps below.

  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. Click the Select button next to the Shoutcast field.

  5. In the menu that opens, click on one of the listed streams to select it. You can also search for a stream using the search field. When you click on a stream, its address will appear in the stream field at the top of the menu.

    1. Alternatively, you can enter an audio stream address directly into the stream field.

  6. Click the Set Stream button. This will return you to the Region Information window.

  7. Click the Save button.

You can also enter a known audio stream address using the Breakroom moderator tools.

If you can't immediately hear your chosen audio, try toggling the stream. You can do this by clicking the Radio icon in the settings toolbar several times.

The streams listed in the Region Information window are created and maintained by independent entertainment companies. Breakroom is not affiliated with any of these third parties, and cannot alter or endorse any station's content.

Disabling an audio stream

To disable an active Region-wide audio stream, follow these steps.

  1. Repeat steps 1-4 above.

  2. In the menu that opens, select and delete the current audio stream address.

  3. Click the Set Stream button. This will return you to the Region Information window.

  4. Click the Save button.

You can also enter a known audio stream address or delete using the Breakroom moderator tools.

Controlling Region access

Regions can either be open to the public or offer various degrees of controlled access. When it comes to letting users visit a Region, your options are:

  • Public: Any user in the World can access your Region

  • Contact Only: All users listed in the Region Owner's People list and whitelisted users can access the Region

  • Approved Only: Only whitelisted users can access the Region

  • Groups Only: Only users in whitelisted groups can access and control the Region

To select a Region access type, follow these steps.

  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. Scroll down to the Region Access panel, and check the box beside the access type you prefer.

  5. Click the Save button.

For detailed information about each Region access type, please review the following sections.

Approving Region members

Some Region access types require visitors to be approved (or whitelisted). To do so, please refer to the following instructions.

Approving users

  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 on the Members tab in the Region Information window.

  4. Click the Add Members button to open the "Add new members" dialog box. Locate the user you want to whitelist by using the search field, and then click the Add button beside their name.

Removing approved users

To remove a user from the Region members list, follow these steps.

  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 on the Members tab in the Region Information window, and use the search field to search for the user's name.

  4. Once you locate the user you want to remove, click the Edit button located to the right of their name. In the action menu that appears, click Delete.

Region access types

Contact Only

By making a Region "Contact Only," you are limiting access to the contacts in the Region Owner's People list and specific users approved (or whitelisted) to visit the Region.

Approved Only

By making a Region "Approved Only," you are limiting access to only those users included in your Region members list. No other users will be allowed to enter the Region.

Groups Only

In the Region Information window, you'll notice that the "Groups Only" Region access option is grayed out, and therefore unclickable. In order to restrict Region access to one or more groups, you will need to first join or create those groups.

To limit Region access to one or more groups, you can then follow these steps.

  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 on the Groups tab in the Region Information window. This tab will initially appear empty; to populate it with your groups, click the Manage button located at the bottom.

  4. Check the box beside each group you want to offer Region access.

  5. Click the Save button.

  6. Click on the Info tab, and then the Edit button. You will see that Region access is now restricted to "Groups Only."

When a Region is set to "Groups Only," the group member lists will override the Region's existing members list, including any region members with advanced permissions.

This means that only Group Administrators, Group Moderators, Group Developers, etc. will be able to exercise their powers over the Region as a whole. Additionally, only group members will be permitted to visit the Region. Any users in the Region member list will be ignored.

To disable group control over the Region, select a different Region access option. Doing so will restore access and advanced permissions to any users in the Region members list.

Muting and banning Region visitors

In order to mute or ban a Region visitor, that user must either be:

  1. Currently located within the Region (with the Guest user role)

  2. Included in the Region members list (with the Member user role or better)

If the user is not currently located within the Region, but you would like to preemptively mute or ban them, you will first need to whitelist the user. You can then edit that user's status using the following methods.

Muting visitors

To mute a single Region visitor (on either text or voice chat), follow these steps.

  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 on the Members tab in the Region Information window, and use the search field to search for the user's name.

  4. Once you locate the user you want to mute, you can either:

    1. Click the Edit button located to the right of the user's name. In the action menu that appears, click Mute Voice and/or Mute Chat.

    2. Toggle the Microphone icon and/or the Speech bubble icon located to the right of the user's name. When the blue check mark disappears, the user is muted.

To restore communication to a previously muted user, repeat steps 1-4 above, and either:

  1. Click the Edit button located to the right of the user's name. In the action menu that appears, click Unmute Voice and/or Unmute Chat.

  2. Toggle the Microphone icon and/or the Speech bubble icon located to the right of the user's name. When a blue check mark appears, the user can communicate over voice or text chat.

To mute multiple users at once, follow these steps.

  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 on the Members tab in the Region Information window, and locate the users you want to mute. Check the box located to the left of each user's name.

  4. Click the Set Status drop-down menu, and then click Mute Voice and/or Mute Chat.

To restore communication to multiple muted users, repeat steps 1-3 above. Then, click the Set Status drop-down menu, and click Unmute Voice and/or Unmute Chat.

Banning visitors

To ban a single user from entering your Region, follow these steps.

  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 on the Members tab in the Region Information window, and use the search field to search for the user's name.

  4. Once you locate the user you want to ban, click the Edit button located to the right of the user's name. In the action menu that appears, click Block.

To undo a ban, repeat steps 1-3 above. The user will be filed under the Ban List. Click the Edit button located to the right of the user's name. In the action menu that appears, click Unblock.

To ban multiple users at once, follow these steps.

  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 on the Members tab in the Region Information window, and locate the users you want to ban. Check the box located to the left of each user's name.

  4. Click the Set Status drop-down menu, and then click Block.

To undo a ban for multiple users, repeat steps 1-3 above. Banned users will be filed under the Ban List. Check the boxes beside the users you want to unban, click the Set Status drop-down menu, and then click Unblock.

Branding tools

Customize your Breakroom World's login screen, application logo, and viewer installer image to create a polished, professional, and user-friendly experience.

Overview

As part of building a unique Breakroom World, World Owners and World Administrators can upload custom graphics to create a cohesive brand experience for end users. This includes the splash screen users see when they log in, the favicon that appears when users access World Stream, and the application icon and installer image for the Breakroom desktop viewers.

Uploading a custom login screen

To upload a custom login screen image, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab. Scroll down to the "Branding" panel.

  3. Click the Browse link located underneath the Branding > World Background image panel. This will launch a standard file import window on your computer.

  4. Locate the image file you want to use as your login screen and click on it. Then click the Open button.

  5. Once your image is uploaded, you will see it appear as a thumbnail.

  6. Click the Save Changes button.

Breakroom supports JPG, JPEG, and PNG images. The recommended dimensions for a login splash screen are 1920x1080, or a 16:9 ratio, with a maximum file size of 5MB.

Branding the application logo or favicon

Your custom application logo will replace the default application icon when users install your Breakroom desktop app. It will also replace the default favicon in the World Stream browser tab.

To upload a custom app logo or favicon, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab. Scroll down to the "Branding" panel.

  3. Click the Browse link located underneath the Branding > Application logo panel. This will launch a standard file import window on your computer.

  4. Locate the image file you want to use as your login screen and click on it. Then click the Open button.

  5. Once your image is uploaded, you will see it appear as a thumbnail.

  6. Click the Save Changes button.

Breakroom supports JPG, JPEG and PNG images. The recommended dimensions for an application logo are 256x256, or a 1:1 ratio, with a maximum file size of 5MB.

Application logo best practices

Application logos are very small images—only 256x256 pixels. Depending on the device, your logo may not even be displayed at full size. For these reasons, it's important to follow some best practice tips when creating your application logo.

  1. Go text-free if you can. Small letters and dense text will not be visible to most users.

  2. Pick something bold and attention-grabbing. Your company logo or your company's first initial is a great place to start.

  3. Pick contrasting colors. A hot pink logo on a tropical orange background may be difficult for users to see.

Let's compare these example logos from two fictional companies—Best World and Happy Water. Here we can see that the logo for Best World (left) features small text and an even smaller image. There's also a lot of empty space, and the pink text almost disappears into the red background. Meanwhile, the Happy Water logo (right) is bold and welcoming, with colors that stand out from one another.

Here are the same logos reduced to 32x32 pixels, mimicking what users may see when running your Breakroom app in their system tray. You can see how the Best World logo is unreadable, while the Happy Water logo is still recognizable.

Branding the installer image

Users will see your custom installer image when they download your desktop app and install it on their computers.

To upload a custom installer image, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab. Scroll down to the "Branding" panel.

  3. Click the Browse link located underneath the Branding > Installer image panel. This will launch a standard file import window on your computer.

  4. Locate the image file you want to use as your login screen and click on it. Then click the Open button.

  5. Once your image is uploaded, you will see it appear as a thumbnail.

  6. Click the Save Changes button.

Install images must be in PNG format. The recommended dimensions for an install image are 163x314, with a maximum file size of 5MB.

Region template descriptions

Need help deciding which Region to use? Read on for more information about Breakroom's Region templates, including navigation options and built-in features.

Overview

Each of Breakroom's Region templates offers a different selection of features designed to maximize convenience, flexibility, and fun. Once you add a Region to your World, you can customize it with additional decor items, no-code media and gamification, and more.

The virtual asset files that were used to create our Region templates (e.g. the plants, buildings, furniture, etc.) are not available for individual distribution. If you are interested in decorating your Region, we recommend browsing through the Sine Wave Shop for virtual content.

Breakroom Town Square

Description: A playful alternative to traditional workspaces, full of quirky details. Use the central park for large gatherings, or set up breakout zones in unexpected places.

General Navigation panel teleport targets:

  • Auditorium: Empty central park space.

  • Info: Road space facing the central park.

  • Networking: Empty central park space.

  • Floor: Road space at the crossroads.

Built-in breakout spaces:

  • None.

Breakroom Conference

Description: A sleek, modern conference hall with plenty of room for breakout rooms and vendor booths. Perfect for large crowds.

General Navigation panel teleport targets:

  • Auditorium: Full 90-seat auditorium.

  • Info: Built-in info booth.

  • Networking: Open area in front of auditorium.

  • Floor: Central concourse.

Built-in breakout spaces:

  • Two Breakroom Breakout Area B booths.

  • One Breakroom Workshop.

Breakroom Boardroom

Description: An dedicated conference room with a stunning view. The large screen makes it an ideal setting for meetings that require video and screen sharing.

General Navigation panel teleport targets:

  • Floor: Central 14-seat conference table.

Built-in breakout spaces:

  • None.

Breakroom Campus

Description: This welcoming work environment features four dedicated meeting spaces and an amphitheater, as well as cozy breakout areas.

General Navigation panel teleport targets:

  • Auditorium: Amphitheater space.

  • Info: Front office desk.

  • Networking: Central seating area.

Built-in breakout spaces:

  • Four Breakroom Low Poly Office rooms.

  • An elevated boardroom with a 14-seat conference table.

Breakroom Campus Large

Description: Love the Breakroom Campus, but need more space? This iteration offers eight dedicated meeting areas, plus an amphitheater and breakout spaces.

General Navigation panel teleport targets:

  • Auditorium: Amphitheater space.

  • Info: Front office desk.

  • Networking: Coffee pavilion.

Built-in breakout spaces:

  • Eight Breakroom Low Poly Office rooms.

Built-in Areas of Interest (separate panel):

  • Two networking areas.

  • An elevated boardroom with a 14-seat conference table.

Neon Club

Description: Want to put on a show? This exciting club features hangout areas, multiple bars, and plenty of room to cut loose.

General Navigation panel teleport targets:

  • Info: Entrance hall.

  • Networking: Elevated bar.

  • Floor: Dance floor.

Built-in breakout spaces:

  • None.

Built-in Areas of Interest (separate panel):

  • Standing room VIP lounge with screen.

Breakroom City Townhall

Description: A fun, blocky pixel city with endless details to explore. Great for featured speakers or large presentations.

General Navigation panel teleport targets:

  • Auditorium: Central presentation space.

  • Floor: Fountain courtyard.

Built-in breakout spaces:

  • None.

Breakroom Canvas

Description: A colorful amphitheater with a wide, inviting stage. Great for presentations, networking, and Q&A sessions.

General Navigation panel teleport targets:

  • Auditorium: Amphitheater space.

  • Info: Side of the amphitheater.

  • Floor: Wider presentation floor.

Built-in breakout spaces:

  • None.

Desert Island

Description: This lush tropical island features an open-air auditorium and sunny seaside breakout zones. A DJ station adds to the fun.

General Navigation panel teleport targets:

  • Auditorium: Full 90-seat auditorium.

  • Info: Central island landing area.

  • Networking: Picnic/DJ area.

  • Floor: Beachside volleyball court.

Built-in breakout spaces:

  • None.

Advanced Region Editor options:

  • Material swap points: Stage.

  • Decorative options: Hot air balloons, tree density, sand texture.

Breakroom Gallery

Description: A serene meeting space that showcases the beauty of Breakroom through inspiring architecture and modern art. Equipped with an info desk and customizable displays.

General Navigation panel teleport targets:

  • Auditorium: Central 14-seat conference table.

  • Info: Front-facing information desk.

  • Networking: Art gallery space.

  • Floor: Art gallery space.

Built-in breakout spaces:

  • None.

Breakroom Zone 54B

Description: A dynamic region that lets your users play along the edge of tomorrow. Multiple sci-fi themed breakout pods make this an exciting setting for conventions or learning experiences.

General Navigation panel teleport targets:

  • Auditorium: Central gathering floor.

  • Info: Lower info desk.

  • Networking: Upper concourse.

  • Floor: Dystopian city street.

Built-in Areas of Interest (separate panel):

  • Two 6-seat breakout pods.

  • Nine 4-seat breakout pods.

  • A standing bar.

Breakroom Alpine Retreat

Description: A bracing winter wonderland, perfect for Fire & Ice-themed festivities. Connect with other users around a cozy campfire, or host live performances in the comedy club!

General Navigation panel teleport targets:

  • Auditorium: Full 196-seat main stage auditorium.

  • Info: Welcome Center main entrance.

  • Networking: 73-seat "comedy club"-themed space in Welcome Center.

  • Floor: 28-seat "game room"-themed space in Welcome Center.

Built-in breakout spaces:

  • Six 10-seat outdoor fire pits.

Breakroom Holiday

A variation on the Breakroom Alpine Retreat, our Breakroom Holiday Region offers even more frosty fun. In addition to the seating and teleport options detailed above, Breakroom Holiday includes:

  • Traditional Christmas decorations.

  • A built-in holiday scavenger hunt with collapsible HUD.

  • Clickable fireworks.

  • Animated rides in Santa's sleigh.

Breakroom Delphi

Description: The ruins of Delphi offer an inspirational setting for your next talk. Recharge in the rustic Greek countryside, or catch up with colleagues in the shadow of ancient temples.

General Navigation panel teleport targets:

  • Auditorium: 46-seat open-air amphitheater. (Fun tip: Try clicking on the birds for a change in perspective!)

  • Info: Central ruins.

  • Networking: Temple of Apollo.

  • Floor: Farmhouse with picnic seating for 44 and a screen.

Built-in Areas of Interest (separate panel):

  • Temple of Tholos with picnic seating for 28 and a screen.

  • Temple of Apollo.

  • Farmhouse with picnic seating for 44 and a screen.

Breakroom Cabin

Description: This on-trend conference space offers a stage with five built-in presenter seats and seating for 100 users along sunlit, rustic-chic tables. Fairy lights and classic art prints add to the charm.

General Navigation panel teleport targets:

  • None.

Built-in breakout spaces:

  • None.

Breakroom Azalea Garden

Description: This vivacious, artistic "village" contains a multitude of quirky breakout spaces connected by winding pathways. A 350-user auditorium with five built-in presenter seats comfortably accommodates conference or symposium attendees.

General Navigation panel teleport targets:

  • Auditorium: 350-seat open-air auditorium.

  • Info: Central welcome station.

  • Networking: The Container Cafe, with seating for 32.

  • Floor: Open green leading to the auditorium.

Built-in breakout spaces:

  • None.

Built-in Areas of Interest (separate panel):

  • Archway: A sophisticated 10-seat breakout area with a screen.

  • Cubes: Open-air art installation with standing room and a screen.

  • Polygon: Open amphitheater with seating for 12 and a screen.

  • White Dome: A sunny, engaging breakout area with a 10-seat table and a screen.

  • Elephant: The largest art installation on the map, with a 10-seat breakout area and screen located beneath.

  • Serpentine: A strikingly beautiful breakout area, with a 10-seat table and screen.

  • Wood Roof: An organic breakout area featuring a 10-seat table and a screen.

  • Container Cafe: This engaging shipping container cafe, with seating for 32 people, shows how we can reclaim existing objects and make something new!

Breakroom Executive Boardroom

Description: This gorgeous, gleaming professional conference space lets you conduct meetings in style. With 13 chairs at the conference table and 18 additional seats positioned along the walls, you can invite everyone to weigh in.

General Navigation panel teleport targets:

  • None.

Built-in breakout spaces:

  • None.

Built-in Areas of Interest (separate panel):

  • Meeting: The head of the central conference table.

Advanced Region Editor options:

  • Material swap points: Multiple areas of the floor, walls, ceilings, etc.

Breakroom Ballroom

Description: A sophisticated ballroom with seating for 96 guests and five built-in presenter spots arranged in front of a central screen. Only one-third of the space is occupied with furniture, leaving the rest free for dancing, networking, or vendor booths.

General Navigation panel teleport targets:

  • Auditorium: Ballroom tables, with seating for 96.

  • Info: Central floor space.

Built-in breakout spaces:

  • None.

Advanced Region Editor options:

  • None.

Campfire Talks

Description: A serene and solemn space, filled with several organic "auditoriums" designed to accommodate different group sizes. Foster engagement, reflection, and deep thinking.

General Navigation panel teleport targets:

  • Auditorium: Campfire presentation zone with five built-in presenter seats, a hidden screen, and amphitheater-style seating for 81 users.

  • Info: Entrance area on the beach.

  • Networking: The rocky area bordering the campfire.

  • Floor: The starlit shallows, with picnic-style seating for 160 users.

Built-in breakout spaces:

  • None.

Advanced Region Editor options:

  • None.

Breakroom Starbase

Description: This luxe space station is designed to feel like a little slice of "home" among the stars. With six breakout rooms and multiple meeting spaces to explore, as well as exciting animated scenery, your users will never want to jet off!

General Navigation panel teleport targets:

  • Info: A main landing point in the central "aquarium hub," also referred to as the bridge.

Built-in breakout spaces:

  • Five 8-seat conference rooms.

Built-in Areas of Interest (separate panel):

  • Constellation Rooms: 6-seat conference rooms

  • Waiting Room: An open, inviting lounge space.

  • The Bridge: An elevated portion of the central hub, featuring a futuristic bar.

Advanced Region Editor options:

  • Material swap points: Multiple areas of the floor, walls, ceilings, etc.

  • Decorative options: Custom holographic signage can be displayed on the Bridge Center Banner, Bridge Bar Banner, Tall Holograms, and flatscreen Terminal displays. To do this, you will need to provide our Customer Success Team with the appropriate images.

Pixel Pines

Description: The fun of the fair meets the magic of the Metaverse in Pixel Pines. Featuring fully operational midway and water rides, Pixel Pines is the perfect setting for virtual parties and teambuilding exercises. Use the Breakroom Games package to set up trivia and scavenger hunts for even more fun—and don’t forget to take a selfie with the park’s resident zebra.

General Navigation panel teleport targets:

  • None.

Built-in breakout spaces:

  • None.

Built-in Areas of Interest (separate panel):

  • Fifteen park rides.

  • Entrance to Complex: The main entrance.

  • Deer Country: A picturesque wildlife park.

  • Event Area: An open clearing ideal for setting up picnics, games, etc.

Advanced Region Editor options:

  • None.

The Breakroom Show

Description: This exciting, TV-inspired set contains stadium seating for 90 audience members, as well as five presenter seats for hosts, team leaders, or interviewees. Perfect for live podcast or event streams!

General Navigation panel teleport targets:

  • None.

Built-in breakout spaces:

  • None.

Advanced Region Editor options:

  • Material swap points: All existing Breakroom branding can be swapped out for materials or graphics of your choice, including the monitors and circular floor emblems.

Breakroom Large Stage

Description: This dramatically lit stage forms the perfect backdrop for announcements, keynotes, and VIP presentations. The stage comes with five presenter spots by default, while the audience can accommodate approximately 470 users.

General Navigation panel teleport targets:

  • None.

Built-in breakout spaces:

  • None.

Advanced Region Editor options:

  • Lighting: Light intensity and color presets.

  • Decorative options: Disable screen emissiveness, toggle side stage lights. The 300 seats located on either side of the stage can also be filled with non-interactive NPCs, reducing the number of active user seats to 170.

Default Landing and Orientation Regions

By making key decisions about your Default Landing Regions, your users can log in to an orientation zone, a friendly welcome center, or the heart of the action.

Overview

Default Landing and Orientation Regions are the areas where users will arrive upon login. Default Landing Regions can be used to funnel users toward a specific area, or to distribute visitor "traffic" across multiple arrival points. Orientation Regions allow World Owners and World Administrators to activate a no-code, interactive presentation for newcomers so they can hit the virtual ground running.

Default Landing Regions

Default Landing Regions can be as unique as your Breakroom World. You could make your Default Landing Region the main gathering point of your event—for example, a bustling exposition hall. You could also make your Default Landing Region something fun and casual, providing new users with a safe place to explore Breakroom's features and customize their avatars.

If you prefer, you can enable multiple Default Landing Regions in the same World. In such cases, users will be evenly distributed between your active Default Landing Regions. This can be a convenient way to manage crowd logistics, especially if you are running a Metaverse event that calls for many people to log in at the same time.

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

Activating a Default Landing Region

After creating and enabling a Region, you can make it a Default Landing Region by following these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

  3. Locate the Region you want to turn into a Default Landing Region. (Tip: If you know the Region name, you can enter it into the search field.)

    1. When you find the Region you want to use, make sure that the "Enable Region" option is toggled on.

  4. Click on the vertical ellipses icon in the Region card. In the action menu that appears, toggle the "Set as Default Landing" option on.

  5. If you already have a Default Landing Region, a pop-up will appear asking you to confirm whether you want to create an additional Default Landing Region. Click the Confirm button to do so.

On the Dashboard, Default Landing Regions will be indicated by a house icon in the top left corner of the Region card, as pictured below.

Deactivating a Default Landing Region

To deactivate a Default Landing Region, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

  4. Click on the vertical ellipses icon in the Region card. In the action menu that appears, toggle the "Set as Default Landing" option off.

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

Orientation Regions

If you want to provide platform training for first-time Breakroom users, you can create one or more Orientation Regions using the Breakroom Orientation Quest. First-time users will be directed toward one of your Orientation Regions upon login, and will not be able to exit that Region until they have successfully completed the orientation program.

Instructions for installing the Breakroom Orientation Quest can be found in our Toolkit documentation. After you have added the Breakroom Orientation Quest object to a Region, you can then finish setup by following the steps below.

Activating an Orientation Region

After creating and enabling a Region and installing the Breakroom Orientation Quest object, you can make it an official Orientation Region by following these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

  3. Locate the Region you want to turn into an Orientation Region. (Tip: If you know the Region name, you can enter it into the search field.)

    1. When you find the Region you want to use, make sure that the "Enable Region" option is toggled on.

  4. Click on the vertical ellipses icon in the Region card. In the action menu that appears, toggle the "Set as Orientation" option on.

  5. If you already have an Orientation Region, a pop-up will appear asking you to confirm whether you want to create an additional Orientation Region. Click the Confirm button to do so.

On the Dashboard, Orientation Regions will be indicated by a signpost icon in the top left corner of the Region card, as pictured below.

Deactivating an Orientation Region

To deactivate an Orientation Region, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

  4. Click on the vertical ellipses icon in the Region card. In the action menu that appears, toggle the "Set as Orientation" option off.

    1. If you only have one Orientation Region, a pop-up will appear asking you to confirm your decision. Click the Confirm button to do so.

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.

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 Region templates that come fully equipped with decorations, signage, and Breakroom's robust conference system. World Owners and World Administrators can create and manage these Regions via the Dashboard.

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

Viewing your Regions

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

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

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

Creating a new Region

To create a new Region, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

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

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

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

  7. 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 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 enable and/or feature them.

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 base template. However, once you customize a Region, those details will not copy over to new Regions made from the same template.

Editing Region details

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

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

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

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

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

  2. Click on the World Customization > Regions tab.

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

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

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.

Through the Dashboard

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

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

  4. 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. Click on the Regions button located in the bottom toolbar. This will launch the Region List window.

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

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

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

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

You can feature a Region by following these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

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

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

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

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Regions tab.

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

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

Hiding Featured Regions

Users with advanced Region-level permissions 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.

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

  2. Click on the World Customization > Regions tab.

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

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

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

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

Controlling your camera

Skilled camera work can open your eyes to the limitless possibilities of the Metaverse. Learn more about Breakroom's camera options here.

Overview

Controlling your camera

Adjusting the camera angle

When you first log in, your camera will be positioned behind your avatar in third-person view. You can control your camera with the following key and mouse button combinations.

Sometimes when you use the Esc key to return the camera to its default position, you may find that you are either zoomed out from your avatar or focused in on them very tightly. You can use the mouse scroll wheel to adjust the camera position back to a comfortable angle.

Latch cam

Fly cam

Fly cam is another useful way to explore your surroundings. To enable it, hold down your right mouse button (RMB). You can then use the A and D keys to pan from side, the R and C keys to pan up and down, and the W and S keys to zoom in and out. You can also orbit items in this mode by moving your mouse.

Mouselook

By activating mouselook, you can "lock" your camera to your mouse and take on a first-person perspective. This may be helpful during games, quests, or other in-world activities. There are two ways to turn mouselook on:

  • Press the M button on your keyboard. You can then use your mouse to direct your camera. Press the M button again to exit mouselook.

  • Use your scroll wheel to zoom in as tightly as you can on the scene in front of you. A dialog box will appear, asking whether you wish to enter mouselook. If you confirm your choice, you will enter mouselook at that time. Press the M button when you want to return your camera to third-person view.

Camera settings

UI customization options

Control the information and tools available to your users by building a custom Breakroom UI. We'll show you how to toggle UI options, change the default UI scale, and create a custom color palette.

Overview

Enabling or disabling UI functions

To enable or disable UI features, follow these steps.

  1. Click on the World Customization > Features tab.

  2. Check the box beside each UI component you want to make available to your users. Uncheck the box beside each component you want to hide from the UI.

  3. Click the Save Changes button.

End user impact

The following UI components can be toggled on or off via the Dashboard. Here's how removing each UI component may affect your users.

Changing the default UI scale

In order to improve accessibility for your users, you may wish to change the default scale of the UI. Scale changes implemented through the Dashboard will apply to every Region in your Breakroom World.

To adjust the default UI scale, follow these steps.

  1. Click on the World Customization > Features tab.

  2. Scroll down to the "Default Scale" panel. Click one of the percentage buttons to choose a new UI scale. (Note: 100% represents the default UI scale.)

  3. Click the Save Changes button.

Customizing the UI colors

The UI Color Setting panel allows you to customize the UI color palette. With just a few clicks, the UI can instantly harmonize with your corporate branding guidelines or event colors, or even complement your Region design. UI color changes implemented through the Dashboard will apply to every Region in your Breakroom World.

To customize the UI colors, follow these steps.

  1. Click on the World Customization > Color Theme tab.

  2. In the UI Color Setting panel, you'll see six color swatches. Click on any of these swatches, and a color picker will appear.

    1. You can use the color spectrum tools to generate different colors and explore your options. Your choices will be displayed on the mockup UI in real time, so feel free to experiment.

    2. Click on the arrow icons in the bottom right corner of the color picker to cycle the fields through RGB, HSL, and HEX. Enter values or codes into any of these fields to apply a specific color to a chosen UI element.

  3. When you are satisfied, click the Save Changes button.

Troubleshooting audio and video issues

Running into audio or video issues? Learn how to test your connection, troubleshoot minor problems, and change your input and output devices.

Overview

In the sections that follow, we'll explore these tools and explain how they can be used to resolve issues and customize your media setup.

The Mic & Cam Test button

Desktop viewer Mic & Cam Test overview

To access the Audio Test panel through the Breakroom desktop viewer, follow these steps.

  1. Click the Device Options button in the conference controls.

  2. Click the Mic & Cam Test button.

You will then see the panel pictured above. Here's an overview of the key UI components.

Once the Audio Test panel is open, you can open the Video Test panel by clicking the Next button. Here's an overview of the key UI components.

World Stream Mic & Cam Test UI overview

To access the AV testing panel through World Stream, follow these steps. The testing panel will open as a new tab in your browser.

  1. Click the Device Options button in the conference controls.

  2. Click the Mic & Cam Test button.

Basic troubleshooting tips

  1. As a first step, make sure that Breakroom can detect the input devices you want to use. All of the devices you've given Breakroom permission to access are listed in the relevant drop-down menus. If a device is working and detectable, its name will be listed under the Audio or Video Device Check section when you select it, and a green check mark will be displayed.

  2. If your devices aren't working despite being selected, or you do not see them listed at all, you may need to troubleshoot your computer or AV equipment to learn more about the problem.

  3. Next, make sure that the Audio and Video Networking checks are successful. If you do not see a green check mark confirming this, it means that your equipment is not currently connected to the Internet. This may indicate a device or networking problem.

  4. You can also test your speaker by clicking on the test button at the bottom of the Audio Test panel. This will play a tone, allowing you to test your speaker volume or identify which audio output device is currently active.

Audio feedback

One common issue users encounter is audio feedback, or hearing themselves echo when they talk. This can happen if you're using a microphone to speak, but listening to audio through your computer speakers.

Important note concerning voice chat

Users who log in via the same method can communicate freely over voice chat. Therefore, we strongly suggest that World Owners take this into consideration when planning events, and require all guests to use the same login method.

We apologize for the inconvenience, and hope to provide a solution soon.

The Change Devices button

Changing devices in the Breakroom desktop app

Clicking the Change Devices button will open the Audio Settings panel. There you can use the drop-down menus to select the audio and video devices you want to use. You can also independently adjust the volume for different audio types.

Changing devices in World Stream

Clicking the Change Devices button will launch the Device Management panel. There you can use the drop-down menus to select the audio and video devices you want to use. You can also refresh your connection and settings, or submit a report about your issue.

Breakroom Dashboard tour

You've got a whole World to play with—so let's start from the top. Use the Breakroom Dashboard to customize settings, manage user accounts, and access helpful analytics.

Overview

When it comes to managing your subscription and making high-level decisions about your virtual World, Breakroom's Dashboard is designed to make things easy. This quick-start guide will show you how to access your Dashboard and locate the information you need.

Accessing your Dashboard

  1. Enter your login credentials and click the Sign In button.

  2. Click the Grids tab at the top of the page.

  3. Navigate to the World you want to edit and click the Dashboard button located in the lower right corner.

The Dashboard tabs

Dashboard

The main Dashboard tab contains a number of widgets and quick links to other areas of the Dashboard. In terms of live information, here you can review:

  • Your subscription status and your next billing date

World Customization

Basic Information

Features

Regions

Avatars

Color Theme

World Access

World Credits

The World Credits tab is where you can track your World Credit transactions, manage your World Credit purchase cap, and generate detailed transaction history and World Stream access reports.

Manage Users

The Manage Users tab is where you can add users to your account, assign them special administrative permissions, and monitor how your seats are being used. You can also purchase and manage Daily Passes.

World Stream

The World Stream tab is where you can find usage statistics for your account, impose caps on World Stream usage, pre-allocate server time for events, and manage your server type.

Integration

Learning Management

The Learning Management tab allows you to create and manage online educational courses using the Breakroom for Training system.

Media Library

Billing

The Billing tab allows you to manage and upgrade your current subscription and support plans, review your order history, access previous invoices, and edit your payment details.

Your Apps

Analytics

Support Tickets

Knowledge Base

Activity Log

The Activity Log tab allows you to keep track of key changes made to your Breakroom World or account, noting the time, type, and author of each change. You can also export change reports by type or date range.

Settings

Settings

The Settings window allows you to optimize your in-world Breakroom experience. Learn how to configure media and graphics settings, customize your camera behavior, and more.

Overview

Opening the Settings window

You can open the Settings window by clicking the Settings button in the bottom right corner toolbar, or by typing Ctrl + / on your keyboard.

You can also access the Settings window prior to logging in by clicking the Settings button in the top right corner of the Breakroom login screen.

The Settings window contains several tabs. Below, you'll find a brief overview of the options available under each tab.

Graphics settings

The Graphics tab allows you to customize your visual experience in Breakroom. You can maximize your graphics settings in order to fully enjoy Breakroom's virtual Regions, or reduce your graphics requirements to accommodate lower-end hardware.

Key settings include:

UI settings

Controls settings

The Controls tab allows you to toggle various input options. You can also adjust your mouse and input sensitivity and customize the way your avatar responds to certain movement commands.

Audio settings

Miscellaneous settings

The Misc tab allows you to enable or disable additional functions within Breakroom.

VR settings

In general, we do not recommend the use of VR equipment with Breakroom at this time.

Camera Controls settings

The Camera Controls tab allows you to customize the way your in-world camera behaves. You can also save your custom settings for future use and to share with others.

Profile settings vs. global settings

Under the Camera Controls tab, you will see two groups of camera settings—Profile Settings and Global Settings.

On the other hand, the camera settings listed under Global Settings will persist no matter what changes are made to your camera profile. Global settings cannot be saved or exchanged, and will be applied in addition to any camera profile that you create or load. They also cannot be reset to their default configuration with a single click.

Saving camera profiles

To save your current camera profile, follow these steps:

  1. Log in to your Breakroom World.

  2. Open the Settings window by clicking the Settings button in the bottom right corner toolbar, or by typing Ctrl + / on your keyboard.

  3. Click on the Camera Controls tab.

  4. Click the Save Profile to New Inventory Item button.

  5. A pop-up will appear confirming that a new Camera Settings Group object has been added to your Inventory. Click the Okay button to proceed.

Loading camera profiles

To load a saved camera profile, follow the steps below.

  1. Log in to your Breakroom World.

  2. Click the Inventory button in the bottom toolbar.

  3. In the Inventory window that appears, locate the Camera Settings Group object you want to use.

  4. Click on the Camera Settings Group object, and an action menu will appear. Click the Use button.

Resetting the camera profile to default

To reset your camera profile, follow these steps.

  1. Log in to your Breakroom World.

  2. Open the Settings window by clicking the Settings button in the bottom right corner toolbar, or by typing Ctrl + / on your keyboard.

  3. Click on the Camera Controls tab.

  4. Click the Reset Camera Profile to Default button.

Analytics and Marketing Preferences settings

The Analytics and Marketing Preferences tab allows you to change your privacy and marketing preferences whenever you like. You can also review Breakroom's Privacy Policy.

Filtering the Sine Wave Shop

Control what your users see, wear, and spend in Breakroom. Here you'll find more information about filtering the Shop to meet your specific needs, as well as a discussion of Silver and Gold currency.

Overview

It's important to note that without one or more Shop filters enabled, users will have access to everything currently listed for sale in the Sine Wave Shop. If you enable a filter, only items within that category will be displayed in the Shop. Multiple filters can be activated at the same time.

Filtering the Shop contents

  1. Click on the World Customization > Features tab.

  2. Scroll down to the "Filter your Shop" panel. Check the box beside each collection you want to make available to your users.

  3. Click the Save Changes button.

Filter category definitions

Silver and Gold currencies

Silver is Breakroom's in-world promotional currency, and cannot be exchanged for legal tender. Each user will receive a gift of Silver upon joining Breakroom. Additional Silver can be earned by completing quests and engaging in other activities.

Gold is a premium currency that can be purchased (and in limited cases, exchanged) for legal tender. Some Sine Wave Shop items can only be purchased with Gold currency. In order to make these items available to your users, you will need to give your users a Gold "allowance," or make it possible for them to purchase quantities of Gold with their own money.

You can enable or disable the UI currency displays and associated purchase buttons through the Dashboard. To do so, follow the steps below.

  1. Click on the World Customization > Features tab.

  2. Scroll down to the "Currencies" panel.

    1. If you wish to disable all of the currency displays, uncheck the box labeled Currency.

    2. Alternatively, if you want to disable the Gold display alone, uncheck the box labeled Gold Purchase.

  3. Click the Save Changes button.

Disabling the currency displays will not affect the current contents of your users' wallets. If users have a Gold or Silver balance, they will still be able to use this money if you give them access to the Shop.

Editing and moving objects

Whether you enter precise location data or freestyle it—Breakroom helps you put everything into its proper place. Learn how to manipulate and position virtual objects using the Region Editor.

Overview

Getting started

In order to make changes to a virtual object in Breakroom, you'll first need to open the Region Editor and select that object. To do so, follow these steps.

  1. Navigate to the Region that contains the object you want to edit.

Moving objects using the Region Editor

Movement

The movement gizmo is a tool that allows you to manually reposition items in your Region. In the image above, you can see the movement gizmo represented by a set of colorful arrows attached to the picnic table object.

Once the movement gizmo is activated, you can move your chosen object using the steps below.

  1. To move the object along the X, Y, or Z axis, hover your cursor over the appropriate arrow. That arrow will turn yellow.

  2. Click on the arrow and hold down the left mouse button.

  3. With the arrow selected and the left mouse button held down, move your cursor to slide the object back and forth along your chosen axis.

  4. To set the object in place, release the left mouse button.

  5. To move the object along multiple axes simultaneously, click and hold on one of the squares located at the gizmo's root. You can then drag the object to your desired location.

You can also "free move" an object along a plane set at 90° to the current camera angle (as if you were "washing" the camera lens in front of you).

  1. Hold down the Shift key on your keyboard. A single highlighted box will appear at the root of the movement gizmo.

  2. Click on the box and hold down the left mouse button. Continue to hold down the Shift key.

  3. Use your cursor to freely position the object.

  4. To set the object in place, release both the left mouse button and the Shift key.

Rotation

The rotation gizmo allows you to rotate an object around one or more axes. In the image above, you can see the rotation gizmo represented by a set of colorful rails attached to the picnic table object.

Once the rotation gizmo is activated, you can rotate your chosen object using the steps below.

  1. To rotate the object along the X, Y, or Z axis, hover your cursor over the appropriate colored rail. That rail will turn yellow.

  2. Click on the rail and hold down the left mouse button.

  3. With the rail selected and the left mouse button held down, move your cursor to rotate the object.

  4. To freeze the object in your desired position, release the left mouse button.

You can rotate the object on a plane facing your camera by manipulating the outer white rail instead of the colored rails, following the directions above.

Finally, you can "free rotate" an object along all three axes at once by clicking and holding on any part of the object itself, instead of the rails.

Scaling

The scaling gizmo allows you to resize an object along one or more axes. In the image above, you can see the scaling gizmo represented by a set of colorful markers attached to the picnic table object.

Once the scaling gizmo is activated, you can resize your chosen object using the steps below.

  1. To scale the object along the X, Y, or Z axis, hover your cursor over the appropriate axis marker. That marker will turn yellow.

  2. Click on the marker and hold down the left mouse button.

  3. With the marker selected and the left mouse button held down, move your cursor to scale the object.

  4. To finish scaling the object, release the left mouse button.

  5. To scale the object along multiple axes simultaneously, click and hold on one of the triangles located at the gizmo's root. You can then drag the object to your desired proportions.

You can also scale an object along all three axes at once. This will preserve the object's original aspect ratio/proportions, essentially allowing you to "embiggen" or "shrink" the object.

  1. Hold down the Shift key on your keyboard. A single highlighted box will appear at the root of the scaling gizmo.

  2. Click on the box and hold down the left mouse button. Continue to hold down the Shift key.

  3. Use your cursor to freely resize the object.

  4. To finish scaling the object, release both the left mouse button and the Shift key.

Editing the Transform component

In some situations, it may be more efficient to move, rotate, or scale an object by editing its Transform component. By manually editing the values stored in an object's Transform component, you can move an object five meters along the X axis and rotate the same object by a precise number of degrees, all with just a few clicks.

To identify the values stored in an object's Transform component, follow these steps.

  1. Locate the object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  2. You will see three properties (Local Position, Local Euler Angle, and Local Scale). Each property contains three fields corresponding to the object's X, Y, and Z axes.

Changing an object's position

To change the position of an object, enter the updated location values (along the X, Y, or Z axis, or any combination of these). Then click the Save button located in the bottom right corner of the Region Editor.

Changing an object's rotation

To change the rotation of an object, enter the updated rotation values (along the X, Y, or Z axis, or any combination of these). Then click the Save button located in the bottom right corner of the Region Editor.

Changing an object's scale

To change the scale of an object, enter the updated scale values (along the X, Y, or Z axis, or any combination of these). Then click the Save button located in the bottom right corner of the Region Editor.

Using node mode

Using grid mode

In grid mode, movement "snap points" are set one meter apart from each other. Rotation "snap points" are set at 15° intervals.

Local mode vs. global mode

In global mode, object manipulation is accomplished relative to the layout of the Region.

Both local and global mode have their uses. Combine global mode with grid mode to lay out a precise flower garden, or use local mode to randomly sprinkle rose petals along a pathway.

Center mode vs. mesh pivot mode

The difference between these two points can sometimes be subtle, but it's still a useful distinction to keep in mind. The pivot point is where your movement, rotation, and scaling gizmos will appear in the Region Editor, and rotating an object from its center pivot point may lead to different results than rotating that same object from its mesh pivot point.

Selecting default avatars

Breakroom's default avatars allow both new and seasoned users to pick a look and get right to work. Learn how to select and upload your personalized collection of default avatars.

Overview

Helping users select a starter avatar

Editing your default avatar collection

To select or change your default avatar collection, follow these steps.

  1. Click on the World Customization > Avatars tab.

  2. Use the Select Default Avatars drop-down menu to pick an avatar category.

  3. Scroll through the collection of avatar cards, and check the boxes to highlight the avatars you want to use.

  4. Click the Save Changes button.

Uploading custom default avatars

Creating a custom default avatar

At this point, it will be helpful to take a picture of your finished avatar using your computer's built-in screenshot functionality. We recommend that you save this as an 800x500 image (JPG or PNG), with a maximum file size of 5MB.

Uploading your custom default avatar to Dashboard

To upload your custom default avatar, follow these steps.

  1. Click on the World Customization > Avatars tab.

  2. Use the Select Default Avatars drop-down menu to select the Uploaded avatar category.

  3. Click the Upload Outfit button.

  4. The Custom Outfit IDs drop-down menu will appear. Use this menu to select the outfit ID of your custom avatar.

  5. Click the Browse link in the "Upload an image for the outfit ID" panel. This will launch a standard file import window on your computer. Select the saved image of your completed custom avatar, and then click the Open button.

  6. Click the Upload button.

Using the Region Editor

Breakroom lets you build your Metaverse, your way. Use the Region Editor to add and remove objects, edit Region sky presets, and undo your work so you can start all over again.

Overview

Opening the Region Editor


The Region Editor UI

The Objects window


The Objects window lists all of the virtual objects in your Region. These objects are sorted onto different floors, depending on who added them and when they were added.

The room floor (labeled "Floor_roomfloor" in the image above) contains any conference system components that you have permission to remove or edit, as well as any objects that you have manually placed in the Region.

Meanwhile, the Region floor (here labeled "Breakroom Gallery") contains the individual 3D assets used to build the Region template. The contents of this floor will vary.

Region floor objects were uploaded into Breakroom as a whole, as part of one cohesive Region. You may be able to toggle visibility on some of these objects, or edit their settings if the original Region uploader elected to make that possible. However, you may not be able to make changes to all of the Region floor components.

Objects window icons

In the Objects window, you'll notice that the room and Region floors have different icon sets associated with them. Here's a quick breakdown of what those icons mean.

Locating objects using the Objects window

You can use the Objects type drop-down menu located at the top of the Objects window to filter your objects list. You can also search for a specific object using the search field.

The Inspector window


The Inspector window is an advanced tool that generally tells you what components exist within or on a selected object. If the object is a seat, it will contain a Seat Position component. If the object is a solid wall, it will have a Collider component so that avatars can't pass through it. If the object contains a Lua script, it will have a Script Runtime component attached to it. These individual components can be examined, managed, and potentially modified via the Inspector window.

At the top of the window, you will notice an On/Off toggle labeled with the object's name, as well as an "Is Active" checkbox option. These controls are the same. If the toggle is on/box is checked, the object is active and will be rendered and scripted in your Region as normal. If the toggle is off/box is unchecked, the object (and all of its children) will not be rendered or scripted for users.

The Inventory window


The Inventory window lists all of the virtual objects you currently own. There are two ways to place an object in your Region while using the Region Editor.

  1. Left click on the item in your Inventory window, and then hover your cursor over the ground in your Region. You will see the item appear in real time. The item will follow your cursor, allowing you to position it. Click the left mouse button when you want to set the item down.

  2. Left click and hold on the item in your Inventory window, and drag it into the Region. Release the left mouse button, and your item will be placed in the indicated position.

You can switch between Icon view and List view in the Inventory window by clicking the pink View button (highlighted in the image above). You can also use the Search field to find any items you need.

The Advanced window

  • Change who owns the room floor

  • Change or reset Region materials *

  • Change or reset Region lighting *

  • Enable or disable Region options *

  • Reset the Region as a whole

Object positioning and editing tools

Deleting, duplicating, and deselecting objects

If you have no object selected, the buttons pictured above will not appear. Once you select an object, these buttons will give you the option to delete the object, duplicate it, or deselect all of your currently selected objects.

You can also delete a selected object by pressing the Delete key on your keyboard. You can duplicate a selected object by pressing Ctrl + D.

Function buttons

Finally, the Region Editor function buttons let you manage the windows described above and push your changes forward. From left to right, here's a brief overview of what each button does.

Users can join this group with no approval process. Users can also be added to the group .

Contacts listed in the Group Owner's and other approved users can join the group. Users can apply to join, and a Group Owner, Administrator, or Mod can the application. Users can also be added to the group .

Only approved users can join the group. Users can apply to join, and a Group Owner, Administrator, or Mod can the application. Users can also be added to the group .

While it's important to learn the basics of , the most powerful way to experience virtual space is undoubtedly your camera. In the Metaverse, the camera represents your visual perspective, and it can be detached from your avatar at will. Mastering the art of camera movement opens up a world of possibilities in terms of exploration, art appreciation, and .

Command
Result

Latch cam allows you to choose a specific object as your current focus point. You can then move the camera around it using the commands . To "latch" your camera onto an object, hold down the Alt key and click on the object with your right mouse button (RMB).

You can customize the way your camera behaves using the located in the Settings window.

Breakroom's , or user interface, consists of informational displays and tools that users need to participate in your World. and have the option to customize the basic UI components at any time through the Dashboard, including changing the UI scale and color palette.

Navigate to your .

Navigate to your .

Users can also adjust the UI scale to meet their specifications through the in-world .

Navigate to your .

To access Breakroom's audio and video troubleshooting tools, click the Device Options button in the . This will reveal a drop-down menu containing two buttons—Mic & Cam Test, and Change Devices.

Clicking the Mic & Cam Test button will open a dedicated AV testing panel. The test panel UI will vary depending on whether you are accessing Breakroom through the or .

UI component
Function
UI component
Function

Functionally, the web-based testing panel contains all of the same UI elements described .

If you're experiencing an issue related to voice chat or streaming media, please access the relevant AV testing panel as described . You can then do a basic troubleshooting rundown.

If everything looks good, but you're still having issues, please verify that Breakroom is set up to use your preferred equipment by .

To solve this problem, you will need to use earbuds or a headset. Plug a headset into your computer, and then .

Voice capabilities are currently restricted by login method. This means that if one user is logged in via the and another is logged in via , they will not be able to hear each other, even if they are standing in the same Region.

Clicking on the Change Devices button allows you to select which audio and video devices you want Breakroom to access. The UI you see will vary depending on whether you are using the or .

World Stream users can also access these audio settings by clicking the Settings button in the and then clicking the Audio tab on the left-hand side.

Only and can access the Dashboard. While World Owners can edit every feature described in this section, World Administrators have .

To see your Dashboard, log in to your Breakroom account by clicking the Log In button located in the top right corner of the .

Alternatively, you can log in via by following the steps outlined below.

Visit the login page.

Your usage and information about your

Your balance

Your basic

Your status

Links to your personal and your

The World Customization tab automatically expands into a number of subtabs. Here you can enter a name and description for your World, upload images, make changes to the and , and customize your and . The following mini-FAQ contains more information about the features available under each tab.

The Integration tab allows you to use to coordinate access to your virtual events. You can find more information and instructions in our .

The Media Library tab allows you to upload, view, and delete linked to your Breakroom account.

The Your Apps tab is where you can find download links for your custom Breakroom (and, for advanced users, the ).

The Analytics tab allows you to generate reports that offer insight into how your World is being accessed. You can find more information and instructions in our .

The Support Tickets tab allows you to submit and manage for assistance. Please note that while you can elect to mark your ticket as low, medium, high, or emergency priority, response times may vary. You can learn more by reviewing the .

The Knowledge Base tab contains quick links to relevant articles and documentation.

The Settings tab allows you to toggle your , including booting any users who may be currently logged in.

The Settings window contains advanced graphics, media, camera, and UI options that you can use to customize your personal Breakroom experience. Any changes you make through the Settings window will apply only to your personal or session.

The UI tab allows you to customize certain aspects of .

World Owners can make global changes to the default UI scale by visiting the World Customization tab on the .

The Audio tab allows you to independently control the volume of the different types of media that might play in-world. You can also use the Audio Test and Video Test buttons to conduct on your audio/visual equipment, and use the drop-down device selection menus to .

The settings available under this tab pertain to VR experiences in Breakroom. VR is only available on the Breakroom , and requires access to .

It is important to note that the camera settings listed under Profile Settings (from here referred to collectively as a camera profile) can be with a single click. Camera profiles can also be , exchanged with other users, and on demand.

You can find the saved Camera Settings Group object in your Inventory under Settings > Camera. You can save multiple camera profiles and share them with others using .

Please note that clicking this button will not change your .

Note: World Owners and World Administrators can that Analytics and Marketing data be collected from user logins. In such cases, end users will not be able to opt out of certain types of data collection via the Settings panel.

Just because you've chosen to open the Sine Wave Shop doors doesn't mean you need to relinquish control over what your users see and purchase. By customizing the Shop filters, you can limit your users to purchasing additional avatar components only from our pre-screened collections. and can change these filters at any time through the .

Navigate to your .

As noted in our section, Breakroom offers two types of currency for use in your World: Silver and Gold.

Navigate to your .

Breakroom's is a powerful tool that helps you bring your Metaverse visions alive. On this page, you'll learn how to move, rotate, resize, and position virtual objects in order to customize your Breakroom World.

Open the Region Editor by clicking the Edit Region button in the .

Click on the object you want to edit, or click on that item's name in the .

This will highlight the object on your screen. You can switch your selected object within the Region Editor at any time. For additional information, please review our and our .

To activate the movement gizmo while in the Region Editor, click the Move button located in the , or press the Alt + W keys on your keyboard.

You can move objects quickly and easily using the . This button will move any currently selected object to your camera's location. It's especially useful for .

To activate the rotation gizmo while in the Region Editor, click the Rotate button located in the , or press the Alt + E keys on your keyboard.

To activate the scaling gizmo while in the Region Editor, click the Scale button located in the , or press the Alt + R keys on your keyboard.

Open the Region Editor by clicking the Edit Region button in the .

Make sure the is open by clicking the Objects button located on the bottom right.

Expand the Transform component in the by clicking the > arrow located to the left.

This section is currently under construction. If you have any questions that aren't answered here, please contact our .

You can activate grid mode for every object in your Region by clicking the Grid Mode button in the , or by holding down the Ctrl key while actively manipulating an object. When you're in grid mode, you'll notice that object movement, rotation, and scaling will "snap" along an invisible grid instead of flowing smoothly. This is especially useful when moving items around a scene, allowing you to perform tasks like lining up chairs in neat rows with a minimum of effort.

In the , you can choose to orient your objects using either local mode or global mode. In local mode, objects will be moved, rotated, and scaled relative to their own axes.

In the , you can also toggle between two pivot points for your objects—center pivot and mesh pivot. All objects have a mesh pivot point, which is usually located at the object base (where an object might rest on the floor or on a table) or at a natural pivot point, such as the hinges of a door. Alternatively, an object's center point is normally located close to its center of mass, or the center of the bounding box that surrounds it.

Breakroom is a multi-person simulation that uses to represent where people are—and, perhaps more importantly, who they are. To streamline the onboarding process, Breakroom allows you to curate a set of default that users can wear while they familiarize themselves with the platform. and can make changes to the default avatar collection at any time through the .

Users can pick a starter avatar when they for an account on your Breakroom World. Once logged in, they can change their starter avatar at any time using the . Most starter avatars can also be customized using the .

Most low poly avatars have little to no advanced customization potential. They do not consist of different components that can be swapped in and out (outfit, hairstyle, etc.), but function as self-contained "costume" avatars. If you want to use low poly avatars for your event, you can to offer additional low poly avatar options for your users.

Navigate to your .

You can select up to twenty avatars from any combination of categories. Detailed category descriptions are .

If you prefer, you can offer your users a completely bespoke collection of default avatars. Users can access these avatars during sign-up or through the Start Here panel, as above.

Please note that only outfits that use your or content provided by Breakroom will appear in the Uploaded category. If you create an outfit featuring third-party creator content purchased in the , that outfit will be excluded from the list.

To begin, create a custom avatar using the . We will refer to this unique avatar configuration as an outfit. When you save your outfit, take note of the final number that is appended to the outfit name. This is your custom avatar's outfit ID.

Navigate to your .

The avatar can now be to your default avatar collection. The avatar image you uploaded will appear during new user registration and in the Start Here UI.

The Region Editor gives users with advanced or permissions the ability to edit existing Regions and any items that they contain. Plaster your exhibition hall with eye-catching posters, brand your vendor booths, or add appealing personal touches like potted plants and comfy sofas—with the Region Editor, almost anything is possible.

The videos, images, and tables below are designed to serve as a basic overview of the Region Editor. After you've grown comfortable accessing the Region Editor and utilizing the various tools it contains, you can expand your skillset by reviewing the additional pages in this section. There you'll learn more about , and explore some of the Region Editor's advanced settings, such as creating and .

You can open the Region Editor by clicking the Edit Region button in the .

Once the Region Editor is launched, you'll see that it replaces the normal on your screen. The tools in the Region Editor give you the ability to inspect and edit different parts of your Region. Let's take a look at each part of the Region Editor UI in greater detail.

All Breakroom contain a HIDDEN FLOOR as part of the Region floor. This floor contains the essential conference system components, and cannot be deleted or edited.

Room floor icon
Function
Region floor icon
Function

The Inspector window shows more specific information about the individual objects that make up your Region. You can open the Inspector window by clicking on an object while in the Region Editor, or by clicking on that object's name in the .

In the image above, a breakout room has been selected as the active object. You can see that the object is surrounded by a green collider box, and a is hovering inside. In the Inspector window, you can see that this object contains a number of components. Expanding a component reveals details about this particular breakout room, such as its location and scale.

All objects contain a which allows you to alter their rotation, position, and scale. This is useful to know, as it gives you a great amount of control over where objects appear in your Region.

The includes video players, web browsers, posters, and other media and branding assets to place wherever you like. You can also find unique items to dress up your Regions in the —such as stylish pieces of furniture, works of art, or quirky conversation starters.

Advanced settings can be accessed by clicking the Advanced button located in the . By editing these settings, you can:

Please see our page for more information.

Some Advanced window settings, including swappable materials, are only available on certain .

The buttons in this tray are designed to help you move and manipulate the virtual objects that make up your Region. From left to right, here's a brief overview of what each button does. You can find more comprehensive information about these tools on our dedicated .

Button
Function
Button
Function
Button
Function

Mouse scroll wheel

The camera will zoom in and out on the current focus point.

Hold down RMB (right mouse button) and move the mouse

The camera will orbit around the current focus point if you move the mouse from side to side. It will zoom in if you move the mouse forward and back.

Hold Ctrl + RMB and move the mouse

The camera will pan and tilt around the current focus point.

Hold Shift + Ctrl + RMB and move the mouse

The camera will pan side to side or up and down while maintaining the current focus point.

Esc key

The camera will return to its third-person starting point.

Component

End user impact if disabled

Chat button

Users will not be able to access text chat, and will be limited to using local voice chat to communicate with one another.

Hot Bar

Users will not be able to equip Inventory items for quick deployment.

People button

Users will not be able to open the People window, which allows them to locate other users and message them directly. They will also lose access to their Groups list.

Explore button

Users will not be able to open the Explore window, which allows them to

locate and teleport to Featured Regions.

Meetings button

Users will not be able to open the Meetings window, or see the posted event schedule.

Inventory button

Users will not be able to open the Inventory window, which allows them to access any in-world items they have collected or purchased.

Outfit button

Users will not be able to open the Outfit window, which means they will not be able to edit their avatars and may lose some clothing and avatar component customization options.

Shop button

Users will not be able to access the Sine Wave Shop.

Snapshot button

Users will not be able to open the Snapshot window in order to take pictures of their avatars or your virtual event.

Mini map

Users will not see the mini map in the upper right corner of their screens, and will lose access to additional functions such as bookmarks.

Quests

Users will not have access to the Quest window, where they can track their progress on any quests they've started.

Search

Users won't be able to search for Regions, users, groups, or Shop items.

Clock

Users will not see a clock displayed at the top of the screen.

Gold

Users will not see how much Gold they have or the button that allows them to purchase additional Gold currency. They will only see how much Silver currency they have.

Currency

Users will not see their current Gold or Silver currency holdings displayed at the top of the screen.

Email

Users will not be able to send Breakroom emails or read emails sent by other people.

Auction

Users will not be able to sell or purchase Shop items via auction.

Audio Test Feed drop-down menu

Allows you to select the audio input device (e.g. microphone) to be tested.

Audio Device check

Provides information on the selected audio input device.

Audio Networking check

Provides information on the audio network connection.

Audio Volume check

Provides information on audio volume.

Speaker drop-down menu

Allows you to select the audio output device (e.g. speaker or headset) to be tested.

"Click to test speaker" button

Plays a tone that allows you to test your speaker.

Next button

Launches the Video Test panel.

Skip All link

Closes the AV testing panel.

Video Test Feed drop-down menu

Allows you to select the video input device (e.g. camera) to be tested.

Live video feed

Allows you to visually confirm that your camera is working.

Video Device check

Provides information on the selected video input device.

Video Networking check

Provides information on the video network connection.

UI component

Function

Reset to Default button

Resets all volume and device settings to the default configuration.

Audio Test button

Launches the Audio Test panel.

Video Test button

Launches the Video Test panel.

Master Volume slider

Adjusts the overall volume of the Breakroom application.

Music Volume slider

Adjusts the volume of any music streamed on the Breakroom platform.

UI Volume slider

Adjusts the volume of the UI interactivity sounds.

SFX Volume slider

Adjusts the volume of any special effects sounds.

Voice Volume slider

Adjusts the voice streaming volume.

Mic Sensitivity slider

Adjusts your own microphone's sensitivity, impacting your voice volume.

Microphone Device menu

Allows you to select which microphone you want to use on Breakroom.

Playback Device menu

Allows you to select which speakers you want to use.

Webcam Device menu

Allows you to select which camera you want to use.

UI component

Function

Audio input source menu

Allows you to select which microphone you want to use on Breakroom.

Audio output source menu

Allows you to select which speakers you want to use.

Video input source menu

Allows you to select which camera you want to use.

Refresh button

Refreshes your media connection and pushes any changes forward.

Report button

Allows you to log a report indicating that you're having issues with media.

Setting

Function

Quick-adjust buttons

These buttons let you switch between a light graphics load (Fastest/Fast) and a heavier graphics load (Medium/Quality) with a single click.

Advanced Options

The sliders and check boxes located under Advanced Options allow you to make specific, granular changes to your graphics configuration.

Windowed Mode

On the desktop application, these buttons allow you to toggle Breakroom between full-screen and windowed mode.

Setting

Function

Interface size buttons

These buttons let you reduce or increase the size of the Breakroom UI elements that frame your screen.

"Enable Login to Preview" option

This option makes it possible to log in to the preview server.

"Show name tag of yourself" option

This option toggles the visibility of your own overhead name tag. (Please note that others will always be able to see your name tag.)

Setting

Function

"Click to walk" option

This option toggles the click to walk feature.

"Can click on self" option

This option controls whether you can click on your own avatar.

"Use Gamepad" option

This option enables or disables the use of a connected gamepad.

"Inverse Y Axis in Mouselook" option

This option allows you to inverses the Y axis while in mouselook.

"Lock Run State" option

This option locks your avatar into "always run" mode. This option will persist between login sessions and across Region teleports until you disable it. It can also be enabled by pressing Ctrl + R on your keyboard.

"Make Run Toggleable" option

This option allows you to toggle between normal movement and "always run" mode using your keyboard. "Always run" can be toggled by pressing the Shift key once.

"Make Crouch Toggleable" option

This option allows you to toggle between normal locomotion and persistent crouching by pressing the C key once. Your avatar will then crouch until you press the C key again.

Mouse Sensitivity

This slider adjusts the sensitivity (speed) of your mouse within the Breakroom viewer or screen.

Input Sensitivity

This slider adjusts the sensitivity (speed) of other input devices, such as gamepads or joysticks.

Movement Speed

This slider adjusts your avatar's default walk speed, so you can walk (and consequently run) slower or faster.

Turning Speed

This slider adjusts your avatar's default turning speed.

Setting

Function

Caching options

These controls can be used to clear your graphics cache and change the cache storage location on your device.

"Enable Browser Surfaces" option

This option lets you enable or disable all browser surfaces in-world. This includes the Breakroom web browser and Slido integration. Generally, we do not recommend turning this off.

"Enable Voice" option

This option enables or disables voice chat completely.

"Enable Highlight Effect" option

This option toggles the highlight "aura" that surrounds clickable objects and avatars when your mouse passes over them.

"Enable Camera Tooltips" option

This option enables or disables the camera tips that pop up when you pass your mouse over the settings toolbar.

"Prompt on Mouselook" option

This option enables or disables the prompt that appears when you use your mouse scroll wheel to transition into mouselook.

"Use TCP Connection" option

This option enables or disables the use of a TCP connection (as opposed to UDP). This may be a worthwhile option to pursue if you have an especially slow or troublesome connection.

"Enable Debug Mode" option

This option enables or disables Lua logging on Live servers. Useful for Lua programmers debugging their code. On Windows machines, the log is available at C:\Users<your windows username>\AppData\LocalLow\Sine Wave Entertainment Ltd\sinespace\Player.log.

Framerate

This drop-down menu lets you set a target framerate. If set to a chosen value, Breakroom will attempt to meet this framerate, but will not exceed it.

vSync

This drop-down menu can be used to enable or disable vSync. vSync helps your computer synchronize framerate with your monitor's refresh rate, so disabling this option may result in graphical "tearing." Generally, we do not recommend turning this off.

Max Loaded Avatars

This drop-down menu lets you specify the maximum number of avatars that will be rendered in-world. Setting this to a lower value can help if you are dealing with a slow connection or using a computer with lower-end graphics capability.

Filter

Category contents

Business Wear

Formal business attire and avatar components (e.g. hair, skins).

Semi Formal

Business casual attire and avatar components.

Fantasy

"Fantasy" attire and avatar components (e.g. wings, fangs).

Low Poly

Self-contained low poly avatars, with no separate attire or accessory options.

Eye

Toggling this icon changes the object's visibility without deleting it. If disabled, the object will not render (be visible to users), and any scripts it contains will not run.

Lock

Toggling this icon locks or unlocks an item. Locked items cannot be moved from their current position, and no further changes can be made to their components.

Trash

Clicking this icon deletes the item from the Region.

Eye

Toggling this icon changes the object's visibility without deleting it. If disabled, the object will not render (be visible to users), and any scripts it contains will not run.

Lock

Toggling this icon locks or unlocks an item. Locked items cannot be moved from their current position, and no further changes can be made to their components.

Reload

Clicking this icon reloads an item so that any changes will be pushed forward.

Move

Activates the movement gizmo, allowing you to move an object. (You can also toggle this by pressing the Alt + W keys on your keyboard.)

Rotate

Activates the rotate gizmo, allowing you to rotate an object. (You can also toggle this by pressing the Alt + E keys on your keyboard.)

Scale

Activates the scale gizmo, allowing you to resize an object. (You can also toggle this by pressing the Alt + R keys on your keyboard.)

Node Mode

If node mode is activated and "snap nodes" have been installed in both a Region and an object, then objects will naturally snap into place when you move them.

Grid Mode

With grid mode activated, you can orient objects on a local grid.

Move Object to Camera

Moves the currently selected object to your camera position.

Local Mode / Global Mode Toggle

With local mode activated, objects can be moved relative to their own position and rotation. With global mode activated, objects can be moved relative to the Region itself.

Center / Mesh Pivot Toggle

With center mode activated, gizmos will appear within the object's bounding box (or at their "center of mass"). With mesh pivot mode activated, gizmos will appear at the object's pivot point.

Undo

Undo your last action.

Redo

Redo your last undone action.

Avatar Move

If enabled, this feature locks your avatar into place while you edit the Region. Disabling it gives you the freedom to move your avatar around the Region as you edit.

Inventory

Calls up the Inventory window.

Advanced

Calls up the Advanced window.

Objects

Calls up the Objects window.

Terrain

Launches the Terrain editing window.

Sky

Launches the Sky editing window.

Floor menu

Allows you to select which floor items will be placed on. Set the drop-down menu to your desired floor, and any objects you set out will be "filed" under that floor in the Objects window.

Save

Saves your Region editing progress.

Close

Closes the Region Editor. You will be asked whether you want to save your changes.

Reset Zones

Resets all voice zones (and related navigation UIs) in order to push forward any changes made in the Region Editor.

Visibility

Toggles voice zone/object collider visibility. Useful for when you want to edit the objects inside a voice zone without running into camera issues.

manually
People list
approve or reject
manually
approve or reject
manually
avatar movement
Region customization
detailed above
Camera Controls
UI
World Owners
World Administrators
Dashboard
Dashboard
Settings panel
Dashboard
conference system controls
desktop viewer
World Stream
above
above
changing your device input and output settings
switch your audio output to the headset
desktop viewer
World Stream
Breakroom desktop viewer
World Stream
settings toolbar
World Owners
World Administrators
limited permissions
Breakroom homepage
Curator
Curator
seat
Daily Passes
World Credit
analytics
branding
World Stream URL
desktop applications
branding
Shop filters
UI
Regions
starter avatars
How can I change my World name and description?
How can I brand my apps and login screen?
How can I publish a custom Privacy Policy or EULA?
How can I turn GDPR/CCPA data compliance on or off?
How can I customize the user data I collect?
How can users grant or revoke consent for data collection?
How can I customize which parts of the UI my users see?
How can I filter the contents of the Sine Wave Shop for my users?
How can I change which in-world currencies my users see?
How can I change the default scale of the UI for every user on my World?
How can I create, edit, and delete Regions?
How can I enable a Region?
How can I feature a Region?
How can I select a Default Landing Region?
How can I create an Orientation Region?
How can I change which starter avatars my users see?
How can I change the UI color scheme?
How can I enable self-registration for my users?
How can I set up single sign-on (SSO)?
How can I purchase World Credits?
How can I set a World Credit monthly purchase cap for my team?
How can I find my World Credit transaction history?
How can I track World Stream usage?
How can I manually create user accounts?
How can I import user accounts in bulk?
How can I export user account data?
How can I purchase and manage Daily Passes?
How can I assign or revoke World-level user permissions?
How can users log in via World Stream?
What are the different World Stream server types?
How can I set caps on World Stream usage?
How can I pre-allocate a fleet of servers for my planned event?
Eventbrite
Opening the Doors section
How can students use the Breakroom for Training system?
How can Instructors log in and administer courses using the Breakroom for Training system?
How can I create a new course?
How can I activate, deactivate, or archive a course?
How can I add quizzes and waivers to my course?
How can I add the Breakroom for Training system to a Region?
image and video files
desktop applications
Breakroom SDK
Opening the Doors section
ticketed requests
Breakroom Terms of Service
GitBook
World availability
desktop viewer
World Stream
Breakroom's UI
Dashboard
real-time tests
switch between active devices
desktop application
advanced computer equipment
reset
saved
loaded
in-world email
global camera settings
mandate
World Owners
World Administrators
Dashboard
Dashboard
Getting Started
Dashboard
Region Editor
bottom toolbar
Objects window
introduction to using the Region Editor
Region Editor best practices
object editing tray
"Move Object to Camera" button
changing camera angles in voice zones
object editing tray
object editing tray
bottom toolbar
Objects window
Inspector window
Customer Success Team
object editing tray
object editing tray
object editing tray
avatars
starter avatars
World Owners
World Administrators
Dashboard
self-register
Start Here panel
Outfit window
filter the Shop contents
Dashboard
available
detailed
custom uploaded content
Shop
Outfit window
Dashboard
added
World-
Region-level
editing and moving objects
custom atmospheric and sky effects
swapping out materials
bottom toolbar
Breakroom UI
Region templates
Objects window
movement gizmo
Transform component
Breakroom Toolkit
Sine Wave Shop
function button tray
Advanced window
Breakroom Region templates
object editing page

Exploring the Breakroom Toolkit

Giving you the tools you need to succeed—that's the Breakroom way. Learn more about the items that make up the Breakroom Toolkit, including collaboration and navigation tools.

Overview

World Owners, World Administrators, and World Developers will automatically receive the contents of the Breakroom Toolkit delivered to their inventories. This toolkit consists of plug-and-play items designed to help you quickly add branding, media, and functional engagement to your Regions. You can place these items in your Regions using the Region Editor.

Toolkit contents

The Breakroom Toolkit contains the following items:

  • 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 for attendees and presenters

  • Voice zones

  • Breakroom LMS Core

In addition to the items listed above, the Breakroom Toolkit includes the following conference system components:

  • Breakroom Navigation UI

  • Breakroom Combined Media Core

  • Breakroom Gestures Standard

  • Breakroom Camera System

  • Breakroom Auditorium 90 and Auditorium 200

  • Breakroom Basic Emojis

  • Breakroom Start Here UI

These items are provided so that you can install the Breakroom conference system in a custom Region.

Item updates

World Owners, World Administrators, and World Developers will automatically receive new conference tools and interactive objects released by Breakroom. These objects will be delivered directly to each user's Inventory. Updates are also pushed forward automatically, even for items already set up in-world.

The Region Editor ADVANCED window

Up the "wow!" factor by customizing Region features using the Region Editor Advanced window. Learn how to swap materials, toggle additional template toys, play with lighting, and reset your changes.

Overview

Users with the appropriate World- or Region-level permissions can access advanced Region Editor functions by clicking the Advanced button located in the function tray. There you can control floor access, swap materials on some Region template surfaces, toggle optional Region template design features, or reset a Region back to its default configuration.

The Area tab

The Area tab allows you to change who owns the Region room floor. The room floor owner can move, delete, edit, and otherwise manage all items "filed" under that floor in the Objects window, even those set down by other people.

At this stage in Breakroom's development, this option has limited use. If you do want to change the room floor owner, follow these steps.

  1. Navigate to the Region that contains the room floor you want to reassign.

  2. Open the Region Editor by clicking the Edit Region button in the bottom toolbar.

  3. Open the Advanced window by clicking the Advanced button.

  4. Click on the Area tab.

  5. Locate the room floor, and click the Edit button.

  6. In the panel that appears, use the Owner drop-down menu to select one of your contacts as the new owner. If you want to revert ownership back to yourself, select "Region Owner" in the drop-down menu.

  7. Click the Save button.

The Materials tab

If a Region template includes material-enabled surfaces, you can change those materials at any time through the Materials tab. This is a quick, easy way to achieve fresh visual effects using existing Region templates.

Purchasing materials in the Shop

In order to swap out materials in a Region template, you will first need to purchase alternative material files. These are available through the Sine Wave Shop. To open the Shop and navigate directly to the materials category, follow these steps.

  1. Click on the Shop button located in the bottom toolbar.

  2. Click the Furniture tab located along the top of the Shop window.

  3. Click the Materials subcategory in the left-hand menu.

Once there, you can browse through the available files at your convenience. Please be advised that some materials come bundled in packs, while others are sold as single files. For help completing your purchase, please review our detailed Shop instructions.

Swapping materials on a Region surface

To illustrate the effects of a material swap and create a walkthrough tutorial, we will change the 90-seat auditorium stage surface in the Desert Island Region template. As you can see in the image above, the stage surface defaults to non-slip green flooring.

To access the material swap feature, follow the steps below.

  1. Navigate to the Region you want to edit.

  2. Open the Region Editor by clicking the Edit Region button in the bottom toolbar.

  3. Open the Advanced window by clicking the Advanced button.

  4. Click on the Materials tab.

  5. If there are any material-enabled surfaces in the Region, you will see them listed under this tab. To change a particular material, click the Swap Material button located to the right of the surface name.

  1. If you have materials in your Inventory, these will be displayed on the right side. Click on the material you want to use.

  2. Once you're satisfied with your changes, click the Save and Close buttons in the lower right corner of the Region Editor.

Here you can see that we have replaced the non-slip green floor with wooden decking material from the Wood Flooring Volume 1 materials pack by Trilo Byte Design. The effect is immediate, as the stage looks more organic and thus reflects the tropical environment.

The Lights tab

Like the Materials tab, the Lights tab allows you to make changes to real-time lighting fixtures. Currently, there are no Breakroom Region templates equipped with modifiable lighting.

The Options tab

Some Region templates come equipped with additional customization settings that can be toggled through the Options tab. This may include things like tree density, specific material effects, animated scenery, and more. To toggle any these settings, follow the steps below.

  1. Navigate to the Region you want to edit.

  2. Open the Region Editor by clicking the Edit Region button in the bottom toolbar.

  3. Open the Advanced window by clicking the Advanced button.

  4. Click on the Options tab.

  5. Locate the setting you want to toggle, and click the relevant Enable/Disable button.

  6. Once you're satisfied with your changes, click the Save and Close buttons in the lower right corner of the Region Editor.

The Reset Region tab

The Reset Region tab can be used to revert all or part of a Region back to default settings. Clicking any of these buttons can result in dramatic and wide-ranging effects, so it's important to understand how they work.

Reset Components button

Clicking the Reset Components button will reset every component attached to every object in the Region, restoring their default settings. This includes:

  • The Transform component, which affects object location and rotation

  • The RoomFurniture component, which can affect custom voice zones

  • The ScriptingData component, which can affect custom screen setups, etc.

Only click this button if you want to reset the components attached to every object without deleting those objects from your Region.

Reset Materials button

Clicking the Reset Materials button will restore the default materials on any material-enabled surfaces that you have edited.

Reset Region button

Clicking the Reset Region button will delete all custom changes that have been made to a Region. This includes deleting any virtual items that have been added to your Region. Please think carefully before you restore a Region to its default settings.

It bears repeating—please consider the consequences before you click any of the Reset Region buttons. Using these buttons can destroy any or all custom work you have done in a Region. Your deleted work will not be recoverable.

Breakroom Image Viewer

Brand your event with engaging signage and graphics—anywhere, anytime. Here you'll learn how to deploy and customize the Breakroom Image Viewer.

Overview

The Breakroom Image Viewer allows Object Owners and users with appropriate World- or Region-level permissions to upload static images—including company logos, informational signage, and event branding or advertising—and display them almost anywhere. Event coordinators can also create clickable images that will direct users to a webpage.

For help installing the Breakroom Video Player, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Setting up the Breakroom Image Viewer

The Breakroom Image Viewer control panel is only accessible to the Object Owner and users with appropriate World- or Region-level permissions. To access it, click on the Breakroom Image Viewer and then click the Open Admin button.

When users click on a web-enabled viewer, they will only see the Open URL button. Clicking this button will open the associated URL in an external browser tab.

Adding an image

To display an image using the Breakroom Image Viewer, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  3. Your selected image will display in the preview window. Make sure everything looks good, and then click the Save and Close button.

Adding a webpage URL

To link a webpage to your Breakroom Image Viewer, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

  3. Paste your URL into the Webpage URL field.

  4. Click the Save and Close button.

Now when users click on the Breakroom Image Viewer, they will see an Open URL button. Clicking this button will open the associated URL in an external browser tab.

Image viewer options

The Breakroom Image Viewer control panel also allows you to customize the way images are displayed.

To edit the image display options, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

  3. Click the ON or OFF button located next to each image display option.

  4. Click the Save and Close button.

Display setting
Function

Post FX

Pops Out

Editing the Breakroom Image Viewer collider zone

Several image viewer options are triggered when an avatar enters the Breakroom Image Viewer collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Image Viewer collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Image Viewer object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Image Viewer object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Tips for best performance

  • The Breakroom Image Viewer will automatically adjust its dimensions to match the aspect ratio of the image displayed on it. As a result, you may find that a finished image panel cuts through the floor of your Region, or is otherwise too large or small for its intended purpose. You can use the Region Editor to adjust the position, rotation, and scale of the image viewer as needed.

  • To resize an image viewer while maintaining the proper aspect ratio, hold down the Shift key while dragging the scaling gizmo. This will allow you to make the image viewer larger or smaller without distorting the image.

  • Images have a 5MB size limit. We recommend that image files used for signage or decorative purposes be no longer than 1024px along one side.

Breakroom Video Player

The perfect tool for sharing training videos, highlighting sponsors, or creating dynamic event backdrops. Read on for more information about setting up and using the Breakroom Video Player.

Overview

The Breakroom Video Player allows users to access live or pre-recorded video content on demand. Object Owners and users with appropriate World- or Region-level permissions can also configure playback options and add a splash screen that will be displayed when the video player is not in use.

For help installing the Breakroom Video Player, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Breakroom Video Player user controls

Users can control any Breakroom Video Player using the buttons located in the bottom control bar. Videos are displayed on a per-user basis, not streamed openly to the Region as a whole.

Control bar button
Function

Play

Plays the video for the user who clicks it.

Pause

Pauses the video for the user who clicks it.

Stop

Stops the video for the user who clicks it.

Zoom In / Zoom Out

Allows the user to focus on and away from the screen.

Settings

Only available to Object Owners and users with appropriate permissions.

Setting up the Breakroom Video Player

The Breakroom Video Player control panel is only accessible to the Object Owner and users with appropriate World- or Region-level permissions. To access it, click on the gear icon in the bottom control bar.

Adding a splash screen image

Splash screen image settings are the very first thing you'll see in the Breakroom Video Player control panel. You can either choose a splash image from your Media Library, or upload a new splash image from your computer.

To set a splash screen for your video player, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player control panel.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new splash image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  3. Your selected image will display in the preview window. When you're satisfied, click the Save and Close button.

Entering a video URL

To enter a video URL, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player control panel.

  3. Paste your video URL into the Video URL field.

  4. Click the Save and Close button.

Video playback options

The Breakroom Video Player control panel also allows you to customize the way videos are played. You can loop a video, mute a video until users interact with the player, and more.

To edit the video playback options, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player control panel.

  3. Click the ON or OFF button located next to each video playback option.

  4. Click the Save and Close button.

Video playback setting
Function

Auto Play

Loop Video

If set to ON, video will replay continuously.

Silent Mode

Post FX

Pops Out

Editing the Breakroom Video Player collider zone

Several advanced features and video playback options are triggered when an avatar enters the Breakroom Video Player collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Video Player collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Video Player object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Video Player object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Tips for best performance

  • Breakroom supports many common video formats, such as MP4, HLS, and YouTube videos.

  • Breakroom does not currently support videos hosted on Vimeo.

  • For best performance, we recommend hosting your video as an MP4 file on a cloud server (such as Amazon AWS).

If a YouTube video is DRM-controlled or monetized, you will not be able to stream it through the Breakroom Video Player. Please be aware that YouTube may automatically apply DRM restrictions to a video if it detects the presence of copyrighted materials (such as background music). If the video you want to use is DRM-controlled or monetized, you may still be able to play it using the Breakroom Web Browser. Please note that playing a video on the web browser object offers a different experience, and that Breakroom cannot track video analytics through the Web Browser object.

Editing terrain and sky

Breakroom lets you extend your editing reach to the stars. Learn how to use the Region Editor to control cloud formation, ambient lighting, and even the weather.

Overview

With Breakroom's Region Editor, you aren't limited to customizing physical spaces. The very elements are also yours to control, allowing you to create sunny, happy office parks or atmospheric nighttime events.

Editing the sky and atmosphere

To open the Sky editing window, follow these steps.

  1. Navigate to the Region that contains the object you want to edit.

  2. Open the Region Editor by clicking the Edit Region button in the bottom toolbar.

  3. Click the Sky button in the function tray.

As you can see in the image above, there are many different options to explore. The best way to get started is to play with the sliders and judge the virtual sky effects in real time. As far as control settings, there are a few key items to review.

Sky editing feature
Result

Master Control - Reset to Default button

Clicking this button will revert any custom changes you've made, and restore the Region's default sky settings.

Master Control - Override Sky Settings

In order to make changes to a Region's sky settings, this box must be checked. If you uncheck it and save your work, the Region's default sky settings will be restored.

Clock Settings - Use Fixed Time

If this box is checked, you can "freeze" your atmospheric settings at a certain time of day (e.g. sunset) using the slider. If this option remains unchecked, your Region will experience an animated day-to-night cycle.

Clock Settings - Synchronize to UTC

If this option is checked, your Region's day-to-night cycle follow the UTC time zone.

Weather Settings - Enable Random Weather

If this box is checked, random weather events will change the sky's color, haziness, and general presentation.

Editing terrain

This section is currently under construction. If you have any questions that aren't answered here, please contact our Customer Success Team.

Default avatar collections

Conservative, casual, or charming—Breakroom's default avatars make an excellent first impression. Choose a collection of starter avatars so your users can feel confident and stylish.

Overview

Breakroom's default avatars (sometimes referred to as starter avatars) are designed to be visually engaging and diverse. You can offer your users as few or as many default avatar options as you like from our themed collections, or even upload your own default avatars to meet the unique needs of your virtual world. World Owners and World Administrators can make changes to the default avatar collection at any time through the Dashboard.

Default

Breakroom's classic avatar collection. Attire, skins, hair, and accessories that are appropriate for a conservative work or university campus environment.

Business Casual

An expanded collection of diverse base avatars outfitted in business friendly fashions.

Lightweight

A cohort of fashionable avatars designed to play nice with lower-end rendering hardware.

Casual Outfits

Attire, skins, and hair that are appropriate for a casual festival, convention, or learning environment.

Low Poly

Fun, self-contained avatars that work well with lower-end devices. Low poly avatars also have the benefit of not being customizable, if you prefer to have total control over user avatar presentation.

Holiday Outfits

A cheerful selection of winter holiday-themed avatars. Perfect for use with the Breakroom Alpine Retreat and Breakroom Holiday Region templates!

Breakroom Web Browser

Foster engagement by giving users the ability to access web-based content without leaving the Metaverse. Here you'll learn how to set up and use the Breakroom Web Browser.

Overview

The Breakroom Web Browser allows users to access and interact with web-based content anywhere within your world. Object Owners and users with appropriate World- or Region-level permissions can also configure access options and add a splash screen that will be displayed when the web browser is not in use.

For help installing the Breakroom Video Player, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

The Breakroom Web Browser will not play MP4 or HLS videos. Please use the Breakroom Video Player to share media using these formats.

Breakroom Web Browser user controls

Users can control any Breakroom Web Browser using the buttons located in the bottom control bar. Webpages are displayed on a per-user basis, not streamed openly to the Region as a whole.

Control bar component
Function

Home

Takes the user back to the web browser's default URL.

Forward and back arrows

Allow users to navigate forward and backward within a website.

External open

Opens the default URL in the user's own web browser.

Zoom In / Zoom Out

Allows the user to zoom in on the panel and away again.

Settings

Only available to Object Owners and users with appropriate permissions.

Setting up the Breakroom Web Browser

The Breakroom Web Browser control panel is only accessible to the Object Owner and users with appropriate World- or Region-level permissions. To access it, click on the gear icon in the bottom control bar.

Adding a splash screen image

Splash screen image settings are the very first thing you'll see in the Breakroom Web Browser control panel. You can either choose a splash image from your Media Library, or upload a new splash image from your computer.

To set a splash screen for your web browser, follow these steps:

  1. Locate the Breakroom Web Browser object you want to edit.

  2. Click on the gear icon to open the Breakroom Web Browser control panel.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new splash image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  3. Your selected image will display in the preview window. Make sure everything looks good, and then click the Save and Close button.

Entering a webpage URL

To enter a webpage URL, follow these steps:

  1. Locate the Breakroom Web Browser object you want to edit.

  2. Click on the gear icon to open the Breakroom Web Browser control panel.

  3. Paste your URL into the Webpage URL field.

  4. Click the Save and Close button.

Web browser options

The Breakroom Web Browser control panel also allows you to customize the way users can interact with your content.

To edit the web browser options, follow these steps:

  1. Locate the Breakroom Web Browser object you want to edit.

  2. Click on the gear icon to open the Breakroom Web Browser control panel.

  3. Click the ON or OFF button located next to each web browser option.

  4. Click the Save and Close button.

Web browser option
Function

Allow forward/back

If set to ON, web navigation buttons will be displayed in the bottom control bar.

Allow external viewing

If set to ON, a button will appear in the bottom control bar allowing users to open the webpage in an external browser.

Post FX

Editing the Breakroom Web Browser collider zone

Several website display options are triggered when an avatar enters the Breakroom Web Browser collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Web Browser collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Web Browser object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Web Browser object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Breakroom Teleport Portal

Whether you want to highlight a must-see Region, limit the number of Regions users can visit, or make it easier for your virtual explorers to get around—the Breakroom Teleport Portal is a key tool.

Overview

The Breakroom Teleport Portal allows users to fast-travel between different Regions in your Breakroom World. You can use these portals to:

  • Call user attention to must-see Regions and activities

  • Present users with a limited number of Regions to visit (when you have otherwise disabled open exploration by removing access to the Explore window)

  • Make it easier for users to navigate multi-Region events

For help installing the Breakroom Teleport Portal, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Breakroom Teleport Portal user controls

Users can activate any Breakroom Teleport Portal by walking "into" it. When a portal is activated, a pop-up will appear containing a list of accessible Regions, complete with splash images and customized text.

Users can click on the labeled destination tiles to learn more about each Region. To travel to the Region currently highlighted in the main window, users can click the Teleport button.

To dismiss the Breakroom Teleport Portal pop-up, users can click the Cancel button or walk away from the portal.

Setting up the Breakroom Teleport Portal

The Breakroom Teleport Portal control panel is only accessible to the Object Owner and users with appropriate World- or Region-level permissions. To access it, click on the teleport portal object.

Users can access up to four different destinations through a single teleport portal. To add a new destination to a portal, follow these steps:

  1. Locate the Breakroom Teleport Portal object you want to edit, and click on it to launch the control panel.

  2. In the control panel, you'll see four Region destination tabs (labeled Region 1 through Region 4). Click on the Region tab you want to edit, if it is not already expanded.

  3. First, select a splash image for your destination.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new splash image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  4. Next, enter a description or call to action in the Region Description field. This description will be superimposed on your chosen splash image, so you may want to keep it on the shorter side.

  5. Enter a name for the Region in the Region Name field.

  6. To ensure users travel to the correct place, you will need to enter the Region ID for the destination. This can be found on your Breakroom Dashboard.

    1. On your Dashboard, navigate to the World Customization > Regions tab.

    2. Locate the Region you want to use. Click the Copy button located in the bottom left corner of the Region tile to copy the displayed Region ID.

    3. Paste the Region ID into the Region ID field in the Breakroom Teleport Portal control panel.

  1. Finally, toggle the Region Active button to On.

  2. Click the Save and Close button.

The Splash Image, Region Description, and Region Name fields are all optional. However, customizing these fields greatly increases the utility of the teleport portal and creates a better user experience.

You can toggle the Region Active button to Off to disable a teleport destination while retaining its data.

Editing the Breakroom Teleport Portal collider zone

The Breakroom Teleport Portal is activated when users enter its collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Teleport Portal collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Info Kiosk object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Teleport Portal object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Breakroom Info Kiosk

If you need dynamic text-based signage that your event team can edit on the fly, look no further. Read on for more information about setting up and using the Breakroom Info Kiosk.

Overview

The Breakroom Info Kiosk allows Object Owners and users with appropriate World- or Region-level permissions to set up text-based signage and edit it as needed from within the Breakroom platform. Unity rich text tags can be used to customize the text display, making it ideal for publishing dynamic information like event schedules and technical updates.

For help installing the Breakroom Info Kiosk, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Setting up the Breakroom Info Kiosk

The Breakroom Info Kiosk control panel is only accessible to the Object Owner and users with appropriate World- or Region-level permissions. To access it, click on the gear icon.

Kiosk access and display settings

Kiosk access and text display settings are the very first thing you'll see in the Breakroom Info Kiosk control panel. You can limit or permit Moderator access to the control panel, specify the kiosk's text size range, and more. These settings apply only to the individual kiosk.

To change the access and display settings, follow these steps:

  1. Locate the Breakroom Info Kiosk object you want to edit.

  2. Click on the gear icon to open the Breakroom Info Kiosk control panel.

  3. Click the ON or OFF button located next to each option.

  4. Click the Save and Close button.

Info kiosk setting
Function

Moderators Can Edit

Pops Out

Minimum Font Size

Sets the smallest possible font size for the text display.

Maximum Font Size

Sets the largest possible font size for the text display.

Entering text into the Breakroom Info Kiosk

The Breakroom Info Kiosk contains ten separate text boxes. You can enter text into one or all of these boxes. Depending on your chosen display settings, the text you enter will resize automatically.

To enter text into a Breakroom Info Kiosk, follow these steps:

  1. Locate the Breakroom Info Kiosk object you want to edit.

  2. Click on the gear icon to open the Breakroom Info Kiosk control panel.

  3. Type or paste your text into one or more of the text boxes.

  4. Click the Save and Close button.

Rich text support and style tips

  • If you enter a single space into any text box and save your work, that field will appear as an empty line on the Breakroom Info Kiosk. This can be useful if you want to create white space between two lines of text.

  • The following Unity rich text markup tags are supported, and you can use them to further customize your text.

    • The color tag accepts most color keywords, but can also be used with a hex color code.

    • The size tag will override any general min/max font settings made using the Breakroom Info Kiosk control panel. For more precise font size control, you may wish to set the minimum and maximum font size to the same value, and then use the size tag to edit your text as appropriate.

Tag
Description
Use

<b> </b>

Bold

<b>Example</b>

<i> </i>

Italic

<i>Example</i>

<size= > </size>

Changes text size

<size=40>Example</size>

<color= > </color>

Changes text color

<color=red>Example</color> <color=#d694c8>Example</color>

Editing the Breakroom Info Kiosk collider zone

Some options are triggered when an avatar enters the Breakroom Info Kiosk collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Info Kiosk collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Info Kiosk object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Info Kiosk object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Breakroom Web Collab

Connect on the web without disconnecting from the Metaverse. Learn how Breakroom Web Collab can help users access web-based productivity software from within the Breakroom platform.

Overview

Breakroom Web Collab is an optional addition to the conference system controls. With Breakroom Web Collab, users don't have to tab away from Breakroom to access web-based productivity software (such as Google Docs).

For help installing the Breakroom Web Collab object, please review our information on using the Region Editor.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

This object is invisible—you can place it anywhere. However, we encourage you to locate it at 0,0,0 in your Region by manually editing the Transform component.

Using Breakroom Web Collab

Breakroom Web Collab operates like a standard browser. The key difference is the two tabs:

  • Private: This tab is visible to the user alone. Any changes made to public documents hosted on third-party services will be visible to other participants, but non-public browsing and data entry will remain private.

  • Shared: This tab can only be controlled by a Moderator. Moderators can enter or navigate to any URL for shared viewing. However, scrolling and data entry are the responsibility of individual users; Moderators cannot force-navigate a page on behalf of all viewers.

Essentially, this system gives users the ability to log in to third-party productivity software from within the Breakroom platform, and gives Moderators the ability to point users toward a shared document for work or review.

Breakroom Web Collab can be accessed by clicking the Web Collab button in the conference controls.

Breakroom Games

Breakroom's easy-install gamification system brings the fun to you! Set up trivia nights, reward your most intrepid virtual explorers, and create magical moments of connection.

Overview

The Breakroom Games system allows you to fill your Regions with activities and minigames that your users can complete for points. The system includes several required and optional components, which can be combined in order to:

  • Encourage and reward exploration

  • Create obstacle courses and scavenger hunts

  • Host trivia competitions

  • Foster engagement with social media

Introduction to the Breakroom Games components

Before we walk through a sample Breakroom Games installation, it’s important to identify the individual system components and describe how they function. For your convenience, we've included video tutorials and text-based instructions for working with each system component.

Leaderboard

The Breakroom Games Leaderboard object displays the ten highest scores for a single game in the Region, as well as the individual viewer’s personal score. A single game can consist of one or more activity and minigame objects (for example, a Leaderboard may show scores for a single Trivia object, or it may show the combined scores for ten separate Clickable objects set up for a scavenger hunt).

Setting up the Leaderboard object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Leaderboard object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. In the Game field, enter the name of the game you want to track.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Each Breakroom Games Leaderboard object you set up will track points for a single game. It is important to emphasize that a single game can consist of one or more activity and minigame objects. You can set up multiple leaderboards within a Region, all tracking the same game (for ease of reference) or tracking different games.

For example, you may wish to set up a leaderboard to track a clickable scavenger hunt in one section of your Region, and a separate leaderboard to track trivia points in a pub on the other side of the Region. To differentiate these games, you might enter the name Scavenger Hunt into the game objects and leaderboards associated with the hunt, and the name Trivia into the game objects and leaderboards associated with the trivia.

Using the Leaderboard object

If you look at the Breakroom Games Leaderboard object, you will see the top ten scores for the game the leaderboard is set up to track, as well as your personal score in the top right corner.

Taskboard

The Breakroom Games Taskboard object shows all activity and minigame objects associated with a single game, sorted by name and category, and indicates whether the individual viewer has completed those activities. The Taskboard also contains administrative control buttons for resetting and reloading game and user data.

Setting up the Taskboard object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Taskboard object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. In the Game field, enter the name of the game you want to track.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

  6. Click the Reload Game button on the Breakroom Games Taskboard.

Each Breakroom Games Taskboard object you set up will track the activity and minigame objects associated with a single game. It is important to emphasize that a single game can consist of one or more activity and minigame objects. You can set up multiple taskboards within a region, all tracking the same game (for ease of reference) or tracking different games.

Using the Taskboard object

Most users only need to look at the Taskboard object in order to use it. When game tasks are completed, a green check mark will appear in the box associated with that task.

Rewards

Setting up a Rewards object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Reward object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game you want to track.

    2. In the Name field, enter the name of your reward activity (e.g. Reach 10 Points, Find 50 Keys).

    3. In the Points field, enter the number of points you would like to award users for completing the reward activity (optional).

    4. In the Points To Unlock field, enter the number of points users must accumulate to earn the reward.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using a Rewards object

Most users will interact with the Reward object in a passive manner. Once they have met the specified point threshold, they will earn the reward.

Findable

Breakroom Games Findable objects are generic, transparent objects that can be placed anywhere in a Region. Findables are triggered by avatar proximity, and can be used to create scavenger hunts or obstacle courses. You can highlight these objects with glowing particles for ease of discovery, or make them completely invisible.

Setting up a Findable object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Findable object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the findable activity.

    2. In the Name field, enter the name of the findable activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the findable activity (optional).

    4. Check the Secret option if you want to turn off the location particles and glow for the findable. This will render the findable completely invisible.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Customizing a Findable collider

Findables are triggered by avatar proximity. You can customize the proximity range of a Breakroom Games Findable object by changing the size and shape of its collider. To do so, follow these steps.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Findable object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click the > arrow located to the left of the object name to expand it.

  3. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Findables are a great way to set up an obstacle course for your users. Set out some pillars with Findable objects on top, and challenge your users to jump between them! Create rings in the sky with Findable objects inside, and see if your users can nail those sudden 90° turns while in flight! Also, did you know that the Points property associated with any activity or minigame object can be 0, as well as a negative number? That means you can set up a Findable object that "awards" negative points for an additional dose of drama!

Using a Findable object

To use a Findable object, all users need to do is move their avatar through its proximity collider. This can be done while walking, running, or flying.

Clickable

Breakroom Games Clickable objects are generic, transparent objects that can be placed over another object to turn it into a clickable activity. This functionality is ideal for creating scavenger hunts. You can highlight these objects with glowing particles for ease of discovery, or make them completely invisible.

Setting up a Clickable object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Clickable object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the clickable activity.

    2. In the Name field, enter the name of the clickable activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the clickable activity (optional).

    4. Check the Secret option if you want to turn off the location particles and glow for the clickable. This will render the clickable completely invisible.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using a Clickable object

To use a Clickable object, users just need to click on it.

Sittable

Breakroom Games Sittable objects are generic, transparent objects that turn the simple action of sitting down into a gamified activity. Both furniture and vehicle seats will work with sittables, allowing you to reward users for attending meetings or participating in fun rallies. You can highlight these objects with glowing particles for ease of discovery, or make them completely invisible.

Setting up a Sittable object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Sittable object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the sitting activity.

    2. In the Name field, enter the name of the sitting activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the sitting activity (optional).

    4. Check the Secret option if you want to turn off the location particles and glow for the sittable. This will render the sittable completely invisible.

    5. In the Seat field, enter the name of the seat(s) you would like users to sit on. (See below.)

    6. In the Time field, enter the amount of time users will need to sit in the seat to successfully complete the activity. (Note: Partial times are not recorded. Users must sit in the seat for the full duration in order to complete the activity.)

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

When setting up the Breakroom Games Sittable, you must specify which seats qualify for the activity. Because seats can be nested in Breakroom, you can either name a specific seat or refer to a broad grouping of seats.

Using a Sittable object

To use a Sittable object, users just need to sit on a qualifying seat for the specified time duration.

Photo Booth

Setting up a Photo Booth object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Photo Booth object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the photo booth activity.

    2. In the Name field, enter the name of the photo booth activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the photo booth activity (optional).

    4. Check the Secret option if you want to turn off the location particles and glow for the photo booth.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Customizing the Photo Booth object

By default, the Breakroom Photo Booth object includes two seats. This means that two users must sit on it and take a photo in order to complete the activity. You can make any photo booth a one-seater by following these steps.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Photo Booth object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click the > arrow located to the left of the object name to expand it.

  3. Locate the Person 1 and Person 2 seats. To disable one of these, click the eye icon located to the right of its name.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using a Photo Booth object

Tour Camera

Setting up the Breakroom Tour Cameras


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Tour Cameras object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the tour activity.

    2. In the Name field, enter the name of the tour activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the tour activity (optional).

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using the Breakroom Tour Cameras

Explorer

The Breakroom Games Explorer object is a generic activity that rewards players for walking, running, or flying a certain distance during the same login session in the same Region.

Setting up the Explorer object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Explorer object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the explorer activity.

    2. In the Name field, enter the name of the explorer activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the explorer activity (optional).

    4. In the Distance field, enter the number of meters you want users to cover during the explorer activity.

    5. Check the While Flying option if you want flight distance to count toward the explorer activity.

    6. Check the While Walking option if you want walking distance to count toward the explorer activity.

    7. Check the While Running option if you want running distance to count toward the explorer activity.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using the Explorer object

To complete an explorer task, users simply need to walk, run, or fly the distance indicated by the Explorer object settings. Please note that if a user logs out before earning a reward, their progress toward that reward will not be saved (i.e. if a user walks 50/100 meters and logs out, they will start at 0 meters when they log in again). Any large abrupt movement will be treated as a teleport and the meters for it will not be calculated.

Sightseeing

Setting up the Sightseeing object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Sightseeing object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the sightseeing activity.

    2. In the Name field, enter the name of the sightseeing activity (this will be listed on the game Taskboard).

    3. In the Points field, enter the number of points you would like to award users for completing the sightseeing activity (optional).

    4. In the Zone Name field, enter the zone name keyword you would like to count toward the sightseeing activity. (E.g. all zones that have Breakout in their name, all zones that have Pavilion in their name, etc. As long as the keyword appears somewhere in the zone name, the rest of the zone name doesn't matter.)

    5. In the Zone Count field, enter the number of zones you would like users to visit in order to complete the sightseeing activity.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using the Sightseeing object

To complete the sightseeing activity, users need to visit the correct number of zones that meet the keyword criteria.

Trivia

The Breakroom Games Trivia object is a trivia minigame where a Quizmaster initiates questions that can then be answered by anyone in the Region. Points are awarded based on question difficulty.

Setting up a Trivia object


  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Games Trivia object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Game field, enter the name of the game that includes the trivia minigame.

    2. In the Name field, enter the name of the trivia minigame (this will be listed on the game Taskboard).

    3. In the Easy Points field, enter the number of points you would like to award users for correctly answering an easy question (optional).

    4. In the Medium Points field, enter the number of points you would like to award users for correctly answering a medium question (optional).

    5. In the Hard Points field, enter the number of points you would like to award users for correctly answering a hard question (optional).

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Using a Trivia object

Quizmaster

  • The trivia question category

  • The question format

  • The question difficulty

  • How much time users have to answer the question

The Quizmaster can then click the GO! button to begin the trivia round. When the trivia game is over, clicking the Close Quizmaster button will dismiss the Quizmaster panel.

Trivia participants

Within the timeframe specified by the Quizmaster, all users are permitted to answer the active trivia question. Users must click on their preferred response, and will not have the ability to change their answer. All correct answers will be rewarded. This means that theoretically, a trivia game could end with everyone being a winner!

Sample Breakroom Games Region walkthrough

Now that we understand the different Breakroom Games system components and how they work together, let's take a look at some sample games set up in a Region.

When a user looks at the Leaderboard object, they will see the ten highest scores for the game. Their own score is displayed on the ribbon located in the top right-hand corner, even if their name doesn't appear in the top ten list.

All of the activity and minigame objects listed on the Taskboard object, as well as the associated Leaderboard object, have Upward Con specified as their object Game property. This game name is what ties the objects together, ensuring that they work as a unit.

It is important to note that some Breakroom Games objects allow you to enter an activity name as well as a game name. Here you can see that for the statue clickable, the Game property is set to Upward Con. However, the Name property is set to Find Our Logo Statue. This activity name appears on the Taskboard, so users can more easily understand the steps they need to take to complete an activity.

Notice that both trivia Reward objects have their Game property set to Trivia Night, and both have been set up to award points for reaching a certain point threshold. This, of course, is completely optional, and rewards may simply be standalone achievements.

Breakroom Start Here UI

Give your users a head start by installing one of Breakroom's instrumental onboarding tools. The Start Here panel allows users to select a starter avatar and access help with just a few clicks.

Overview

Deleting or deactivating the Start Here UI

When hosting events on Breakroom, there may be occasions where you don't want the Start Here UI to appear in a Region (for example, if you're hosting an event for seasoned Breakroom users who do not require access to default avatars). To delete the Start Here UI from a Region that currently contains it, or to temporarily disable the Start Here UI without deleting it, follow these steps.

    1. To delete the Start Here UI: To the right of the Breakroom Start Here UI, you'll see a trash can icon. Click this icon to delete the object from the Region.

    2. To temporarily disable the Start Here UI: To the right of the Breakroom Start Here UI, you'll see an eye icon. Click this icon to temporarily disable or "mute" the panel.

  1. Click the Save button in the bottom right corner to save your work. Click the Close button to exit the Region Editor.

Installing or reactivating the Start Here UI

To install the Breakroom Start Here UI in a region, or to reactivate it, follow the steps below.

  1. To install the UI panel:

    1. Open your Inventory by clicking on the Inventory button at the bottom of the screen.

  2. To reactivate a disabled UI panel: In the Objects window, expand the room floor. Locate the Breakroom Start Here UI object. Click the eye icon associated with the object.

  3. Click the Save button in the bottom right corner to save your work. Click the Close button to exit the Region Editor.

Once these steps are completed, the Breakroom Start Here UI will appear on your screen. The Avatar button will give users access to the default avatar collection you've chosen.

Breakroom Orientation Quest

Get your users up to speed fast with the Breakroom Orientation Quest. When added to a Region, new users can rock a crash course in Metaverse logistics and communication—all with a few clicks.

Overview

The Breakroom Orientation Quest offers a personalized, self-paced tutorial experience for users who need help getting around, changing their avatar, and activating their microphone. Located high in the sky, the Orientation Zone can serve as a relaxed, quiet place for new users to get away from the hubbub and get their virtual feet under them.

Using the Breakroom Orientation Quest

Orientation Regions

Add-on seats

Whether you're creating a custom voice zone or a special presenter lounge, Breakroom's add-on furniture objects combine function with flexibility.

Overview

Unless otherwise noted, chairs, couches, and other furniture items purchased from the Sine Wave Shop will not work with the Breakroom conference system, and will function as decorative seating only.

Add-on conference system seats

Breakroom Add-on Round Table

Key features: The Breakroom Add-on Round Table object includes 10 seats situated around a center conference table.

Breakroom Add-on Stools

Add-on presenter seats

Breakroom Add-on Presenters Standing

Breakroom Add-on Presenters Chairs

Key features: The Breakroom Add-on Presenters Chairs object features five presenter chairs.

Breakroom Add-on Presenters Sofas

Breakroom Tour Cameras

Breakroom's built-in tour camera system can help you boost visitor engagement and streamline the orientation process. Read on for information about designing custom tours of your Region.

Overview

The Breakroom Tour Camera system allows users with advanced permissions to implement customized visual tours of any Region. This powerful tool can be used to highlight networking areas, visually illustrate the steps necessary to complete a task, or generate excitement about the various activities available in a particular Region—the possibilities are endless.

Breakroom Tour Cameras user controls

Setting up the Breakroom Tour Cameras

To place a Breakroom Tour Cameras object in your Region, follow the quick-start steps below.

  1. Click the Inventory button in the bottom right toolbar.

  2. Search for the Breakroom Tour Cameras object in your Inventory, and drag the item into your Region.

  3. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Overview of the system components

The Breakroom Tour Cameras object contains several preconfigured cameras. You can use one or all of these cameras to create your custom Region tour—the choice is up to you.

You can locate the individual cameras by following the steps below.

  1. In the Objects window, search for the Breakroom Tour Cameras object. Click the > arrow located to the left of its name to expand it.

  2. Locate the Cameras object. Click the > arrow located to the left of its name to expand it.

Each camera type offers a unique approach to viewing your Region.

Activating and deactivating individual tour cameras

Each camera in the Breakroom Camera Tour object can be activated or deactivated as necessary. If a camera is active, then its "view" will be included in your custom tour. If a camera is deactivated, it will not be included in your custom tour.

To activate a camera, click the eye icon located to the right of its name in the Objects window. (When active, the eye icon will appear bright white.) To deactivate a camera, click the eye icon again (when deactivated, the camera's name and its icon set will appear grayed out).

Editing individual tour cameras

The Breakroom Tour Cameras can be edited in a variety of ways to achieve dramatic effects.

Positioning tour cameras

Here we see a close-up of the Pan Left Camera, with arrows indicating the direction the camera is facing and the path it will follow. The camera's track is highlighted in green.

Here we see the Zoom Out Camera, with icons indicating the camera focus point (the mountain) and the path and direction the camera will travel (down the highlighted green track, pulling away from its starting point).

Here we see the Orbit Camera, where the camera focus point (the mountain) will remain in the center. The camera will circle this focus point.

To edit the position of individual cameras in your Region, follow these steps.

  1. In the Objects window, search for the Breakroom Tour Cameras object. Click the > arrow located to the left of its name to expand it.

  2. Locate the Cameras object. Click the > arrow located to the left of its name to expand it.

  3. Click on the name of the individual tour camera you want to position in order to highlight it.

  4. Click the Save button to store your changes, and the Close button to exit the Region Editor.

You can test your chosen placement and effects by clicking the Take Tour button located in the Start Here panel.

Using the "Move Object to Camera" button to move tour cameras

For this portion of the tutorial, we will refer to the individual tour camera object that you want to move as the tour camera, and your own user camera as the working camera.

Each tour camera type will react differently to the position of your working camera.

To position a tour camera using the "Move Object to Camera" function, follow these steps.

  1. In the Objects window, search for the Breakroom Tour Cameras object. Click the > arrow located to the left of its name to expand it.

  2. Locate the Cameras object. Click the > arrow located to the left of its name to expand it.

  3. Locate the individual tour camera you want to edit, and click on its name in order to highlight it.

  4. Leaving the tour camera selected, move your working camera into position.

  5. Click the "Move Object to Camera" button. The tour camera will snap into place.

  6. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Customizing a tour camera focal point

Some individual Breakroom Tour Cameras offer the ability to position the camera focal point independent of the camera track. By changing the relation of the camera's focal point with its animated track, you can achieve unique customized effects.

To position a tour camera's focal point and track independently of one another, follow the steps below.

  1. In the Objects window, search for the Breakroom Tour Cameras object. Click the > arrow located to the left of its name to expand it.

  2. Locate the Cameras object. Click the > arrow located to the left of its name to expand it.

  3. Click on the individual tour camera you want to edit in order to highlight it.

  4. Click the > arrow located to the left of the individual tour camera to expand it. (Note: Not all Breakroom Tour Cameras include a modifiable focal point.)

  5. Click on the Focus or Track object to highlight it. A translation gizmo will superimpose over your chosen object.

  6. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Configuring the Breakroom Tour Cameras

In addition to editing their physical placement, there are a number of transition and speed options available within each tour camera object. By modifying these, you can add additional interest and drama to your custom Region tour.

To locate these options, follow the steps below.

  1. In the Objects window, search for the Breakroom Tour Cameras object. Click the > arrow located to the left of its name to expand it.

  2. Locate the Cameras object. Click the > arrow located to the left of its name to expand it.

  3. In the Inspector window, click the > arrow located to the left of the ScriptingData component.

All of the options under the ScriptingData component can be manually edited by keying words or values into their respective fields. Here's a quick reference chart to get you started.

Currently, Breakroom Tour Cameras support eight different transition types.

Once you're satisfied, click the Save button to store your changes and the Close button to exit the Region Editor.

Configuring intro and outro transitions and the Breakroom interface

  1. In the Inspector window, click the > arrow located to the left of the RoomFurniture component.

Here is a quickstart guide to the options contained under the RoomFurniture component.

Once you're satisfied, click the Save button to store your changes and the Close button to exit the Region Editor.

Breakroom Landmark

Need to direct users to a custom landing point in your Region, but don't need full voice zone functionality? Learn how to set up a Breakroom Landmark and get your users where they need to go.

Overview

Setting up a Breakroom Landmark

To place a Breakroom Landmark object in your Region, follow the quick-start steps below.

  1. Click the Inventory button in the bottom right toolbar.

  2. Search for the Breakroom Landmark object in your Inventory, and drag the item into your Region.

  1. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

    1. In the Landmark Name field, enter the name you would like to use for the landmark.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Accessing a Breakroom Landmark

The Areas of Interest panel

The Crowd Management panel

Multi-zone landmarks

By naming Breakroom Landmarks sequentially, you will create an additional place listing in the Crowd Management panel devoid of any identifying numeral and labeled multiple locations. This teleport target can be employed to send users to a random associated landmark.

In the example pictured above, you can see we've named three Breakroom Landmarks Picnic Meeting Point 1, Picnic Meeting Point 2, and Picnic Meeting Point 3. Notice how this has created an additional landmark named Picnic Meeting Point, which has no numeral and is labeled multiple locations.

This multi-zone landmark can be used to teleport a crowd of multiple users, with those users being distributed randomly between the three associated landmarks.

Advanced Breakroom Landmark options

When installing a Breakroom Landmark object, you can choose between default landing and clustered landing effects for users who teleport there. You can also randomize the direction your users will face upon arrival.

Default landing

The default landing pattern is automatically enabled upon installation. Under the default landing pattern, users will arrive at random points within the boundary designated by the Breakroom Landmark object.

To avoid a teleportation bottleneck, make your landing pad object as large as possible.

Clustered landing

By enabling the clustered landing option, you can arrange for users to arrive in groups within the zone designated by the Breakroom Landmark object. This can help foster an atmosphere of socialization and camaraderie.

To enable and manage clustered landing, follow the steps below.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Click the Objects button to launch the Objects window. Locate the Breakroom Landmark object you want to edit, and click the > icon to the left of the object name to expand it. Then click on the Landing component to highlight it.

  3. In the Inspector window that opens, click on the > icon to the left of both the Transform and ScriptingData components to expand them.

At this point, it is useful to explain what a few of these component properties do, as well as some of the math involved in creating clustered landing areas. The key properties to consider are:

  • Transform component > Local Scale. This property controls the size of the Landing component. In the example image above, you can see that the object is 6x1x12 meters, or 6x12 along the axes that "count."

  • ScriptingData component > Cluster Size. This property controls the size of the clustered landing areas within the Landing component.

  • ScriptingData component > Random Orientation. This property controls whether users will arrive in a group facing each other (i.e. oriented toward the center of the cluster), or facing in random directions.

The most important property to consider is the Cluster Size. This value must be entered as a number. If you enter the numeral N, we might summarize the instructions relayed to the system as "create as many clustered landing areas of NxN meters as will fit within the scale values of the landing pad object."

In the example image above, you can see that the Landing component is 6x12 meters in size. Under the ScriptingData component, you can see that the Cluster Size property has been set to 6. This will result in the creation of two 6x6 meter clustered landing areas within the boundary designated by the Breakroom Landmark.

With this explained, let's return to the instructions.

  1. Under the ScriptingData component, enable or customize the following properties:

    1. Random Orientation:

      1. If you want users to arrive in a cluster facing each other, enter no into the field.

      2. If you want users to arrive in a cluster facing in random directions, enter yes.

    2. Clustered Landing: Enter yes into the field.

    3. Cluster Size: Enter the size of your clustered landing points into the field (e.g. 3 to create 3x3 clustered landing points).

  2. Click the Reset Zones button to reset the conferencing system.

  3. When you are satisfied, click the Save button to store your changes.

Random Orientation

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects button to launch the Objects window. Locate the Breakroom Landmark object you want to edit, and click the > icon to the left of the object name to expand it. Then click on the Landing component to highlight it.

  4. In the Inspector window that opens, click on the > icon to the left of the ScriptingData component to expand it.

  5. In the Random Orientation field, enter yes.

  6. Click the Reset Zones button to reset the conferencing system.

  7. When you are satisfied, click the Save button to store your changes.

To return a Breakroom Landmark to standard orientation, repeat steps 1-4 above and enter no into the Random Orientation field. Click the Reset Zones button, followed by the Save button.

Breakroom Reactives

Add a touch of Metaverse magic to your event with whimsical, animated objects that react to avatar proximity. Read on for more information about setting up and using Breakroom Reactives.

Overview

Breakroom Reactives are objects with unique animated effects that are triggered by avatar proximity. When added to your Breakroom Regions, they can serve as points of interest and reinforce the user-avatar bond through moments of unexpected play.

Some Breakroom Reactives create effects that include strobing lights, bright flashing colors, and graphics distortions. These effects may be harmful for users with photosensitive epilepsy or other neurological conditions. We respectfully request that Breakroom designers consider their audience when using these objects.

Breakroom Reactive Blooming Garden

The Breakroom Reactive Blooming Garden will blossom to greet your users as they approach, producing tropical garden plots with functional seating. As users wander away, the gardens will draw back into the ground, waiting to be discovered by the next lucky explorer.

Blooming Garden options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Reactive Blooming Garden object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are two properties you can edit—Max Dist and Min Dist.

Max Dist

This number specifies the radius length of the interaction zone. Once users are N meters away, the Reactive Blooming Garden will begin to sprout out of the ground.

Min Dist

This number specifies the distance at which the Reactive Blooming Garden reaches its full size. Once users are within N meters from the center of the Blooming Garden object, it will stop growing. When users exit this N-meter "inner radius," the Blooming Garden will begin to shrink.

Breakroom Reactive Blooming Mushrooms

Breakroom Reactive Blooming Mushrooms will sprout as users approach, filling the air with sparkling spores and will o' the wisps. As users step away, the mushrooms will pop back into the ground.

Blooming Mushroom options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Reactive Blooming Mushroom object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are two properties you can edit—Max Dist and Min Dist.

Max Dist

This number specifies the radius length of the interaction zone. Once users are N meters away, the Reactive Blooming Mushrooms will begin to sprout out of the ground.

Min Dist

This number specifies the distance at which the Reactive Blooming Mushrooms reach full size. Once users are within N meters from the center of the Blooming Mushrooms object, it will stop growing. When users exit this N-meter "inner radius," the Blooming Mushrooms will begin to shrink.

Breakroom Reactive Glitches

Breakroom Reactive Glitches will warp metaversal reality as your avatars draw close to the pulsating "glitch ball," creating unique environmental effects.

The effects contained within the Breakroom Reactive Glitches object make use of strobing lights, bright flashing colors, and graphics distortions. These effects may be harmful for users with photosensitive epilepsy or other neurological conditions.

Reactive Glitches options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Reactive Glitches object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are several properties you can edit—Max Dist, Min Dist, Max Time, Min Time, and Cycles.

Max Dist

This number specifies the radius length of the interaction zone. Once users are N meters away from the Reactive Glitches ball, the glitch effects will be activated. Toward the outer point of this radius, glitch effects will appear more infrequently.

Min Dist

This number specifies the distance at which the glitches reach full effect. Users who stand within this inner radius of N meters from the center of the Reactive Glitches ball will see glitch effects far more frequently.

Max Time

This number specifies the time frequency, in seconds, of glitch effects within the outer bounds of the Max Dist interaction zone.

Min Time

This number specifies the time frequency, in seconds, of glitch effects within the Min Dist interaction zone.

Cycles

If enabled, all ten glitch effects will play in random order with no repeats. Once all ten effects have been played, they will be cycled again at random. If disabled, glitches will play at random, potentially with repeats.

Breakroom Reactive Particles (Tendrils)

Breakroom Reactive Tendrils are triggered by avatar proximity. Watch them dance, wriggle, and stretch toward your avatar as you move past, only to freeze in position when you go still.

Breakroom Reactive Tendrils are glowing objects that appear to move through virtual space. This effect may be harmful for users with photosensitive epilepsy or other neurological conditions.

Reactive Tendrils options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Proximity Particles (Tendrils) object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are several properties you can edit—Max Dist, Speed, Max Speed, and Die Off.

Max Dist

This number specifies the radius length of the interaction zone. Once users are N meters away from the Reactive Tendrils, they will appear and begin to respond to avatar movement.

Speed

This number specifies the lowest speed at which the tendrils will move.

Max Speed

This number specifies the fastest speed at which the tendrils will move.

Die Off

If enabled, tendrils will shrink and disappear when an avatar leaves the interaction zone. If disabled, tendrils will freeze in place until activated by an avatar's proximity.

Breakroom Reactive Particles (Rain)

Breakroom Reactive Rain is triggered by avatar proximity. Race through a squall of splashing raindrops that slow and stop in time with your avatar's movements.

Reactive Rain options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Proximity Particles (Rain) object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are several properties you can edit—Max Dist, Speed, Max Speed, and Die Off.

Max Dist

This number specifies the radius length of the interaction zone. Once users are N meters away from the Reactive Rain object, raindrops will appear and begin to respond to avatar movement.

Speed

This number specifies the lowest speed at which the raindrops will fall.

Max Speed

This number specifies the fastest speed at which the raindrops will fall.

Die Off

If enabled, raindrops will disappear when an avatar leaves the interaction zone. If disabled, raindrops will freeze in place until activated again.

Breakroom Reactive Welcome Drone

The Breakroom Reactive Welcome Drone greets Region visitors, offers a few quick orientation reminders, and then takes their photo to display on a welcome poster. Each user will see their own photo on the poster object, allowing you to offer a truly personalized experience. Users can click the Take Photo Again button on the poster to retake their picture at any time.

Welcome Drone options

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Welcome Drone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  3. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  4. Edit the properties to your specifications.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Under the RoomFurniture component, there are two properties you can edit—Freeze Player and Welcome Text.

Freeze Player

If enabled, this option will lock the player's avatar into position during the Welcome Drone's speech, preventing them from exiting the area until they've had their photo taken.

Welcome Text

One of these ten text boxes will be selected at random to caption the player's photo. Any text entered into the chosen field will be displayed along with the avatar's name (e.g. Looking good will display on the poster as Looking good Avatar Name!).

Changing the Drone voice

Additionally, you can choose between multiple voice options for the Welcome Drone. To do so, follow these steps.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Welcome Drone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.)

  3. Expand the Breakroom Welcome Drone object by clicking the > arrow located to the left of its name. Continue to expand from Target Follower > Follower > Voices.

  4. Locate the Voice object you want to edit (Drone, Male, or Female), and click on it to launch the Inspector window.

  5. In the Inspector window, toggle the Is Active option as needed.

  6. Click the Save button to store your changes, and the Close button to exit the Region Editor.

If more than one voice set is enabled, the Welcome Drone will use the last voice enabled in the list.

Breakroom Reactive Waypoint Blimp

The Breakroom Reactive Waypoint Blimp lets you take branding to a whole new level. Designed to circle overhead bearing your custom signage, users can individually interact with the blimp by summoning it for a low-fly pass.

The Breakroom Reactive Waypoint Blimp is visible to all users in the Region, though its location may vary. An individual low-fly pass request is only visible to the avatar who triggers it.

Waypoint Blimp options

The Breakroom Waypoint Blimp's flight path can be customized by adjusting the number and location of its built-in Waypoint Spheres. Steps to locate the Waypoint Spheres are provided below for easy reference.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Waypoint Blimp object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.)

  3. Expand the Breakroom Waypoint Blimp object by clicking the > arrow located to the left of its name. Continue to expand from Waypoint Group Interruptable > Waypoints.

  4. Locate the Waypoint Sphere object you want to edit.

    1. To toggle a Waypoint Sphere on or off, click the eye icon located to the right of its name in the Objects window.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Start and Interrupt points

In addition to customizing the Breakroom Waypoint Blimp's flight path, you can customize its Start Point and Interrupt Point (where the Blimp will divert for its low-fly pass). To do so, follow the steps outlined above, locating and acting on the following objects:

  • Breakroom Waypoint Blimp > Waypoint Group Interruptable > Start Point

  • Breakroom Waypoint Blimp > Waypoint Group Interruptable > Interrupt Waypoint

Branding the Waypoint Blimp

The Breakroom Waypoint Blimp's settings menu can be accessed by clicking the blimp itself, or by clicking the "Low Flying Aircraft" sign near the flight trigger point.

Clickable objects have a maximum interaction range. If clicking the blimp or the sign does nothing, try moving closer.

To change the image displayed on the side of the Breakroom Waypoint Blimp, follow these steps:

  1. Locate the Breakroom Waypoint Blimp object you want to edit.

  2. Click on the blimp or its associated sign to open the settings panel.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  3. The Blimp will only display a narrow slice of your chosen image. Use the Image Offset scroll bar to adjust which part of the image appears (0.50 will center the image vertically.)

  4. When you're satisfied with your changes, click the Save and Close button.

Breakroom Reactive Waypoint Whale

The Breakroom Reactive Waypoint Whale can be summoned by adventurous avatars who wander near its trigger point. After witnessing its dramatic emergence from a sky portal, avatars can then watch the whale take a tour of the Region.

The Breakroom Reactive Waypoint Whale is only visible to the avatar that triggers it.

Waypoint Whale options

The Breakroom Waypoint Whale's flight path can be customized by adjusting the number and location of its built-in Waypoint Spheres. Steps to locate the Waypoint Spheres are provided below for easy reference.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Waypoint Whale object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.)

  3. Expand the Breakroom Waypoint Whale object by clicking the > arrow located to the left of its name. Continue to expand from Waypoint Group Interruptable > Waypoints.

  4. Locate the Waypoint Sphere object you want to edit.

    1. To toggle a Waypoint Sphere on or off, click the eye icon located to the right of its name in the Objects window.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Start point

In addition to customizing the Breakroom Waypoint Whale's flight path, you can customize its Start Point (where the whale emerges from the sky portal). To do so, follow the steps outlined above, locating and acting on the following object:

  • Breakroom Waypoint Whale > Waypoint Group Interruptable > Start Point

During the initial cinematic, the Waypoint Whale will emerge from the Start Point portal and fly towards Waypoint Sphere 1. If Waypoint Sphere 1 is positioned above or across from the Start Point, the whale will fly horizontally through the clouds or fly upwards, compromising the intended effect. As a general rule, it's good practice to move the Start Point and Waypoint Sphere 1 together, or leave them in position and edit the other waypoints.

Breakroom Note Board

Brainstorming sessions, tutorials, icebreakers and more—the Breakroom Note Board allows you to literally throw your ideas at the wall. Learn how to set it up here.

Overview

Breakroom Note Board controls

Read mode

In read mode, each note features a title, text, and author name. There are also two buttons.

Edit: Clicking the Edit button allows you to make changes to the card, if you have permission to do so (or the card is set to be edited by the public).

Zoom In: Clicking the Zoom In button causes your camera to focus on the card. To look away again, click Zoom Out.

Write mode

In write mode, you can edit the note's contents or grant editing permissions to the public. Here's a brief overview of the relevant fields and options.

In your Inventory, you'll see the Breakroom Image Viewer represented by this icon:

If set to ON, will turn off various graphics settings within the image viewer that could distort the image or on-screen text.

If set to ON, video player screen will "pop out" to user screen when users enter the image viewer . The offset and scale of this pop-out screen can be customized by entering values into the associated fields.

In your Inventory, you'll see the Breakroom Video Player represented by this icon:

If set to ON, video will begin playing automatically when users enter the video player , and will stop when they exit the zone.

If set to ON, video will play with muted audio until a viewer clicks the .

If set to ON, will turn off various graphics settings within the video player that could distort the video or on-screen text.

If set to ON, video player screen will "pop out" to user screen when users enter the video player . The offset and scale of this pop-out screen can be customized by entering values into the associated fields.

In your Inventory, you'll see the Breakroom Web Browser represented by this icon:

If set to ON, will turn off various graphics settings within the web browser that could distort the screen.

In your Inventory, you'll see the Breakroom Info Kiosk represented by this icon:

In your Inventory, you'll see the Breakroom Info Kiosk represented by this icon:

If set to ON, will be able to access the control panel. This means that they can edit the kiosk settings, delete existing text, and enter new text.

If set to ON, the kiosk will "pop out" to the user's screen when users enter the info kiosk . The offset and scale of this pop-out can be customized by entering values into the associated fields.

In your Inventory, you'll see the Breakroom Info Kiosk represented by this icon:

In order for the Breakroom Games components to work, users with appropriate or permissions will need to place them in a Region and edit their components. The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

In your Inventory, you'll see the Breakroom Games Leaderboard represented by this icon:

After the Breakroom Games Leaderboard object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

In your Inventory, you'll see the Breakroom Games Taskboard represented by this icon:

After the Breakroom Games Taskboard object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

To build on the example given , after you set up two separate games in your region (named Trivia and Scavenger Hunt, respectively), you may want to add two different taskboards set to track the tasks associated with those games.

Users with appropriate or permissions can access additional administrative functions through the Taskboard object.

Button
Function

The Breakroom Games Reward object is a generic reward system that unlocks after a player reaches a certain point threshold. Currently the Reward object can only be used as a simple “completion” indicator, but in the future you will be able to reward your players with achievements and .

Like the and , each Reward object can be set up to track a single game. This means that only points earned on activities and minigames associated with that game will count toward the reward. Multiple Reward objects can be set up for the same game.

In your Inventory, you'll see the Breakroom Games Reward object represented by this icon:

After the Breakroom Games Reward object in your Region, you will need to edit its . The steps below are provided for easy reference.

As with all invisible system objects, we recommend editing the to place the Breakroom Games Reward object at 0,0,0. This keeps things tidy in your Region!

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

In your Inventory, you'll see the Breakroom Games Findable object represented by this icon:

After the Breakroom Games Findable object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

Click the Objects Button to launch the .

Click on the Findable Collider component to highlight it. the Findable Collider to meet your specifications.

Click the Reload Game button on the appropriate .

In your Inventory, you'll see the Breakroom Games Clickable object represented by this icon:

After the Breakroom Games Clickable object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

In your Inventory, you'll see the Breakroom Games Sittable object represented by this icon:

After the Breakroom Games Sittable object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

In the image above, a has been expanded in the Objects window to reveal its individual stools. If you enter the term Breakroom into the Sittable object's Name field, then users may sit on any stool in order to complete the activity. However, if you enter the term Breakroom Stool (11), then only that specific stool will qualify. If you have multiple copies of Breakroom Stool (11) in your Region, both seats will qualify.

Photo Booths can be set up so that one or two users are required to complete the activity. You can highlight these objects with glowing particles for ease of discovery, or make them completely invisible. Peppering your region with Photo Booths incentivizes use of Breakroom's , which also gives users the opportunity to share their virtual photos on social media.

In your Inventory, you'll see the Breakroom Photo Booth object represented by this icon:

After the Breakroom Photo Booth object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

To successfully complete a photo booth activity, one or two users must click on the seat icons and take a snapshot using Breakroom's .

can also be turned into an activity by entering any value into the object Game property. This encourages users to take your Region tour and learn more about your Breakroom World.

In your Inventory, you'll see the Breakroom Tour Cameras object represented by this icon:

Our documentation includes detailed information about installing and editing the . After setting up your tour, you will need to edit the camera's to make it work with the Breakroom Games system. The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

To complete the tour task, users will need to click the Take Tour button in the . Please note that activity requirements will not be met if users stop the tour prematurely.

In your Inventory, you'll see the Breakroom Games Explorer object represented by this icon:

After the Breakroom Games Explorer object in your Region, you will need to edit its . The steps below are provided for easy reference.

As with all invisible system objects, we recommend editing the to place the Breakroom Games Reward object at 0,0,0. This keeps things tidy in your Region!

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

The Breakroom Games Sightseeing object is a generic activity that allows players to be rewarded for visiting a certain number of unique or . This activity requires that the be set up in the same Region.

In your Inventory, you'll see the Breakroom Games Sightseeing object represented by this icon:

After the Breakroom Games Sightseeing object in your Region, you will need to edit its . The steps below are provided for easy reference.

As with all invisible system objects, we recommend editing the to place the Breakroom Games Reward object at 0,0,0. This keeps things tidy in your Region!

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

In your Inventory, you'll see the Breakroom Games Trivia object represented by this icon:

After the Breakroom Games Trivia object in your Region, you will need to edit its . The steps below are provided for easy reference.

Click the Objects Button to launch the .

Click the Reload Game button on the appropriate .

Any user with or higher (hereafter referred to as the Quizmaster) can click the Open Quizmaster button on the Breakroom Games Trivia object. Doing so opens a panel where the Quizmaster can select:

Here we see a and a set up to track the same game (Upward Con). This game consists of an obstacle course, a single-item scavenger hunt, a photo booth, exploration activities, and a bonus reward for reaching 10 points.

Meanwhile, we also have a trivia board set up in the same Region. Notice how the , as well as the Leaderboard and Taskboard objects, all have Trivia Night specified as their object Game property. This allows the objects to function together, and also sets this minigame apart as a separate game, with its own scoring and rewards system. Points earned in this trivia minigame will not appear on the Upward Con leaderboard, and vice versa.

On the Taskboard object, you can also see that we have set up two separate rewards just for the trivia game. This is accomplished by setting out multiple and editing their RoomFurniture component properties to meet your specifications.

To help keep things organized, it's important to remember that you can customize any object's Display Name in the . This can make it easier to locate objects in the Objects window. Here, for example, we can see that the two trivia rewards are named "Breakroom Games Reward Trivia" and "Breakroom Games Reward Trivia 2," respectively. The Leaderboard and Taskboard objects also have Trivia appended to their Display Names, making them easy to recognize.

The Breakroom Start Here UI (sometimes referred to as the Start Here panel) forms an integral part of the Breakroom , and comes pre-equipped in most Breakroom . Depending on the setup of your Region, visitors may be able to:

Select an avatar from your

Take an animated of the Region

Visit a

In your Inventory, you'll see the Breakroom Start Here UI object represented by this icon:

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

Open the by clicking the Edit Region button located in the . Then click the Objects button.

In the Objects window, expand the by clicking the > arrow located to the left of its name. Locate the Breakroom Start Here UI object. (Alternatively, you can search for "Start Here UI" in the search field.)

Open the by clicking the Edit Region button located in the .

Within your Inventory, locate the starter pack item called Breakroom Start Here UI. It's represented by this icon:

Click on the object icon. Then click on a location in your Region to place the Start Here UI down. (Note: This object is invisible—you can place it anywhere. However, we encourage you to locate it at 0,0,0 in your region by manually editing the .)

In your Inventory, you'll see the Breakroom Orientation Quest represented by this icon:

The Breakroom Orientation Quest is a single, self-contained object that can be installed in any Region. If you need help, please review our information on using the .

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

The Breakroom Orientation Quest is built using our Quest System. If you're interested in building your own custom quests, please see our .

This object is invisible—you can place it anywhere. However, we encourage you to locate it at 0,0,0 in your region by manually editing the .

When users enter a Region that contains the Breakroom Orientation Quest, they'll be welcomed with a pop-up reminding them how to . After reviewing this information, they can click the Close button to dismiss the pop-up, or click the Orientation Quest button to teleport to the Orientation Zone.

Completing the Orientation Quest is fairly straightforward—helpful robot guides will walk users through every step. Users will learn how to select a , how to through the Metaverse, how to use their to talk on voice chat, and how works. If at any time they wish to exit the quest, they can do so by clicking the Go Back button located in the top left corner of the screen.

By installing the Breakroom Orientation Quest in an official , you can make the quest mandatory for all new users. Users will arrive in your Orientation Region, and will not be allowed to exit the Region until they have completed the tutorial.

Breakroom's add-on seating sets consist of two major types: conference system seats and presenter seats. Conference system seats are designed to create or expand general seating capacity within and . Meanwhile, presenter seats are designed to host speakers in Presenter and Audience .

Details about each add-on seating object can be found below. Please note that these furniture items are built with crowds in mind. You can within each linked set if you don't need all of them.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

For more information about adding furniture items to or setting up , please see our .

Inventory icon:

Inventory icon:

Key features: The Breakroom Add-on Stools object features 14 seats in two rows. When users are seated, they will all face the same direction unless the seat orientation is changed using the .

For more information about adding furniture items to or setting up , please see our .

Inventory icon:

Key features: The Breakroom Add-on Presenters Standing object features nine standing presenter seats—five displayed automatically, and four hidden by default. This means that you can to add between one and nine presenter seats to a voice zone.

Inventory icon:

Inventory icon:

Key features: The Breakroom Add-on Presenters Sofas object features three sofas with three seated presenter seats each. You can to remove entire sofas or individual presenter seats from each sofa.

In your inventory, you will see the Breakroom Tour Camera system represented by this icon:

In order to set up the Breakroom Tour Cameras system, users with appropriate or permissions will need to place the object in a Region and edit its sub-objects and components. The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

Users can launch your custom Region tour at any time by clicking the Take Tour button in the . To exit the tour, they can press the Esc key.

If you do not have the Start Here panel installed in your Region, users will not have access to the Take Tour button. If you prefer, you can trigger your tour using a . Please note that Breakroom does not offer individualized Lua support.

Open the by clicking the Edit Region button located in the .

The primary Breakroom Tour Cameras object does not need to be located close to the areas you want to film. It can be located anywhere in your Region. For convenience and consistency, we encourage you to locate it at 0,0,0 in your Region by manually editing the .

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

Camera type
Behavior

While the Breakroom Tour Cameras object can be placed at in your Region, the individual tour cameras must be moved into position to capture the scenes you want to include in your tour. Many of the camera types include arrows and other markers designed to help with positioning.

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

Use the Region Editor's to place the tour camera where you want it. Alternatively, you can manually edit the tour camera's .

You can use the "Move Object to Camera" button located in the to snap a tour camera object to your current camera position (the that you control with your mouse and keyboard).

Tour camera type
"Move Object to Camera" behavior

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

Use the Region Editor's to place the Focus and/or Track where you want them. Alternatively, you can manually edit the component or use the detailed above.

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

Click on the individual tour camera you want to edit in order to highlight it. The will launch for that object.

ScriptingData camera option
Purpose or result
Transition
Effect

There are additional customization options available under the attached to the primary Breakroom Tour Cameras object. To locate these options, follow the steps below.

Open the by clicking the Edit Region button located in the .

Click the Objects Button to launch the .

In the Objects window, search for the Breakroom Tour Cameras object. Click on it in order to highlight it. The will launch for that object.

RoomFurniture component option
Purpose or effect

Every Breakroom includes a landing pad component that indicates where avatars will arrive when they to that location. The Breakroom Landmark object gives you the ability to set up a similar landing pad anywhere within a Region, independent of other voice zone functionality.

In your Inventory, you'll see the Breakroom Landmark represented by this icon:

In order to set up a Breakroom Landmark, users with appropriate or permissions will need to place the object in a Region and edit its sub-objects and components. The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

Open the by clicking the Edit Region button located in the .

The Breakroom Landmark object must be located at the place you want users to arrive. You can it using the Region Editor tools, or by manually editing the .

The size of the landing pad indicates the area into which your users will teleport. You can make the landing pad bigger or smaller by highlighting it in the Objects window and then changing the local scale values listed under its , or by using the in the Region Editor.

Once you've customized the Breakroom Landmark object position and size, you'll need to assign it a name. You can also assign it a specific color for use in the associated UI, and control whether it appears under the .

If you leave the Landmark Color field set to default, the teleport button associated with the landmark will follow the color "rules" set by the conference system or your . You can change this color by manually typing in any of the . You can also change the hex code associated with these keywords for even more options.

If you want the landmark to be visible under the , type the word yes into Landmark Visible field. If you want to remove it from the panel, set the field to no.

After you set up a Breakroom Landmark as described above, a teleport button will be added to the if it is available. Users can click these buttons at any time in order to travel to the specified point. You can to the Areas of Interest panel as a whole at any time.

You can also select the Breakroom Landmark as a teleport location under the on the . This gives the ability to teleport or more users directly to the landmark as needed.

ScriptingData component > Clustered Landing. This property controls whether clustered landing is enabled or disabled. If clustered landing is turned off, users will arrive in the landing style.

Make sure the Landing component is the size you need by changing the listed under its Transform component, or by using the in the Region Editor.

Whether you choose to implement or for your Breakroom Landmarks, you can randomize the direction that your users will face when they arrive. To do so, follow these steps.

In order for the Breakroom Reactives to work, users with appropriate or permissions will need to place them in a Region and edit their components. The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

Like many objects in Breakroom, the Reactive Blooming Garden can be to meet your needs. You could create a giant garden that appears out of nowhere, making your users feel like ants!

Several options for customizing the Breakroom Reactive Blooming Garden can be found under the object's . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Like many objects in Breakroom, the Reactive Blooming Mushrooms can be to meet your needs. You can set out tiny patches of mushrooms that erupt underfoot as users explore a path, or create a magical mushroom forest!

Like the Breakroom Reactive Blooming Garden, additional options for the Blooming Mushrooms object can be found under its . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Additional options for the Reactive Glitches object can be found under its . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Additional options for the Breakroom Reactive Tendrils object can be found under its . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Additional options for the Breakroom Reactive Rain object can be found under its . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Additional options for the Breakroom Welcome Drone object can be found under its . Steps to access the RoomFurniture component and edit its properties are provided below for easy reference.

Click the Objects Button to launch the .

Click the Objects Button to launch the .

Click the Objects Button to launch the .

To reposition a Waypoint Sphere, click on its name in the Objects window to highlight it. Using the or the , move the object to meet your specifications.

Click the Objects Button to launch the .

To reposition a Waypoint Sphere, click on its name in the Objects window to highlight it. Using the or the , move the object to meet your specifications.

Reusable notes or whiteboards are indispensable for brainstorming sessions, agile management, tutorials, games, and many other professional applications. Each Breakroom Note Board item functions as a reusable note that can be edited either by the public, or by users with appropriate or permissions.

In your Inventory, you'll see the Breakroom Note Board represented by this icon:

For help installing a Breakroom Note Board object, please review our information on using the .

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to prior to setting up this object.

Field or option
Function

Reset Myself

Resets your personal score for the game in question.

Reset Game

Resets any shared game data (e.g. the current trivia question).

Reload Game

Reloads the entire game and its components. Does not delete user data (e.g. points earned).

Orbit

Performs a close-end 360° orbit around a center focal point.

Wide Orbit

Performs a wider 360° orbit around a center focal point.

Zoom In

"Pushes in" along a fixed track.

Zoom Out

"Pulls out" along a fixed track.

Pan Right

Shifts from left to right along a fixed track.

Pan Left

Shifts from right to left along a fixed track.

Orbit/Wide Orbit Cameras

The camera focus will snap to the location of your working camera.

Zoom In Camera

The camera track's start point will snap to the location of your working camera.

Zoom Out Camera

The camera track's end point will snap to the location of your working camera.

Pan Right/Left Cameras

The camera track's center point will snap to the location of your working camera.

Speed

By default, each tour camera takes 5 seconds to move along its associated track. By editing the multiplier value in this field, you can change how fast that individual camera travels during your tour. (For example, entering a value of 0.5 would halve the default speed. The camera would then take 10 seconds to travel along its track.)

FOV (Field of View)

FOV refers to how much of the Region an individual tour camera can see, or how focused that camera is on a particular object or scene. The default value is 50. The lower the number, the more focused the camera will be. If you "pull out" the camera too much (beyond a field value of 70-75), you may see a fisheye distortion.

Caption

You can use this field to enter a caption for each individual camera view, which will then be displayed at the bottom of the screen. If this field is blank, no words will appear at the bottom of the screen.

Order

This option refers to the camera order in your final tour. The default value is 1, which means that all cameras have the same priority. Therefore, they will be played in the same order as they appear in the Objects window. You can manually order your chosen tour cameras by assigning them individual numbers, or you can create priority groups that will then play in the order in which they appear in the Objects window. (E.g. all priority 1s play first, then all priority 2s, etc.).

Transition

Here you can change how each tour camera transitions into the one that follows. Transition options are described in more detail below.

Loops (only on Orbit Cameras)

This value refers to the number of times the camera travels along its circular track, and defaults to 1. You can edit this value to make the camera complete multiple loops (ex: 3) or partial loops (ex: 0.5, which would be a 180° arc).

Fade White

A blended fade into the next scene through a white screen.

Fade Black

Same as above, but with a black screen.

Wipe White

A horizontal wipe into the next scene through a white screen.

Wipe Black

Same as above, but with a black screen.

Door White

A close shot into the middle, then opening up from the middle into the next scene, through a white background.

Door Black

Same as above, but with a black background.

Spin White

A spinning effect into the next scene through a white screen.

Spin Black

Same as above, but with a black screen.

Hide Interface

If checked, this option hides the Breakroom UI while the tour is playing.

Randomize Cameras

If checked, enabled cameras will play in random order for each tour.

Intro Transition

This field can be changed to any of the transition options described above.

Outro Transition

This field can be changed to any of the transition options described above.

Title

Allows you to enter a title for the card.

Description

Allows you to enter text that will be displayed on the card.

Font

Allows you to choose from a variety of fonts.

Text Color

Allows you to choose from a variety of text colors.

Public Editing

Checking this box will enable the card to be edited by anyone. If this box remains unchecked, only users with advanced permissions can edit the card.

Save

Saves your changes.

Cancel

Cancels your changes.

collider zone
collider zone
collider zone
Zoom In button
collider zone
collider zone
collider zone
Moderators
collider zone
World-
Region-level
installing
positioning
RoomFurniture component
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
positioning
RoomFurniture component
Objects window
above
World-
Region-level
Silver
Leaderboard
Taskboard objects
positioning
RoomFurniture component
Transform component
Objects window
Breakroom Games Taskboard object
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
Objects window
Edit
Breakroom Games Taskboard object
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
Breakroom Add-on Stools object
Snapshot feature
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
Objects window
Breakroom Games Taskboard object
Snapshot feature
Breakroom Tour Cameras
Breakroom Tour Cameras
RoomFurniture component
Objects window
Breakroom Games Taskboard object
Start Here UI
positioning
RoomFurniture component
Transform component
Objects window
Breakroom Games Taskboard object
breakout areas
voice zones
conference system
positioning
RoomFurniture component
Transform component
Objects window
Breakroom Games Taskboard object
positioning
RoomFurniture component
Objects window
Breakroom Games Taskboard object
Region Moderator permissions
Breakroom Games Leaderboard object
Breakroom Games Taskboard object
Breakroom Games Trivia object
Breakroom Games Reward objects
Inspector window
conference system
Region templates
default avatar collection
camera tour
custom triage zone
install these components manually
Region Editor
bottom toolbar
room floor
Region Editor
bottom toolbar
Transform component
Region Editor
install these components manually
Quest System documentation
Transform component
get around
starter avatar
move
microphones
spatial audio
Orientation Region
breakout areas
custom voice zones
voice zones
hide individual chairs
install these components manually
custom voice zones
presenter seats
Running Your Event section
Region Editor
custom voice zones
presenter seats
Running Your Event section
edit the object
edit the object
World-
Region-level
installing
positioning
RoomFurniture component
install these components manually
Start Here panel
Lua script
Region Editor
bottom toolbar
Transform component
Region Editor
bottom toolbar
Objects window
0,0,0
Region Editor
bottom toolbar
Objects window
object positioning tools
Transform values
object editing tray
live camera
Region Editor
bottom toolbar
Objects window
Region Editor
bottom toolbar
Objects window
object positioning tools
Transform values
"Move Object to Camera" feature
Region Editor
bottom toolbar
Objects window
Inspector window
RoomFurniture component
Region Editor
bottom toolbar
Objects window
Inspector window
voice zone
teleport
World-
Region-level
installing
positioning
RoomFurniture component
install these components manually
Region Editor
bottom toolbar
position
Transform component
Transform component
scale tool
Areas of Interest panel
UI customization choices
allowed color keywords
Areas of Interest panel
Areas of Interest panel
enable or disable access
Crowd Management panel
Moderator tools
Moderators
default/randomized
local scale values
scale tool
default landing
clustered landing
World-
Region-level
installing
positioning
RoomFurniture component
scaled up
RoomFurniture component
Objects window
scaled
RoomFurniture component
Objects window
RoomFurniture component
Objects window
RoomFurniture component
Objects window
RoomFurniture component
Objects window
RoomFurniture component
Objects window
Objects window
Objects window
Region Editor tools
Transform component
Objects window
Region Editor tools
Transform component
World-
Region-level
Region Editor
install these components manually

Conference rooms and booths

Foster deeper engagement and create networking opportunities with creative spaces. Learn more about installing and managing Breakroom's prefab breakout areas and event booths.

Overview

The Breakroom Toolkit includes several breakout area templates designed for instant deployment, including lounges, workshops, help desks, and exhibition stands. Each breakout space comes pre-equipped with Breakroom's conference tools, enabling media that can only be seen or heard by the users of that space.

For help installing breakout areas, please review our information on using the Region Editor. You can also find advanced tips for customizing breakout spaces in our Running Your Event section—learn how to change camera angles inside your booths, manage the Breakout Rooms navigation panel, and more.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Breakroom Showcase Booth

Breakroom Breakout Area A

Breakroom Breakout Area B

Breakroom Workshop

Breakroom Low Poly Office

Breakroom Helpdesk

The Helpdesk object's Zone Name will default to Entrance. This will automatically tie it into the General Navigation panel. By changing the Zone Name, you can create your own custom voice zone.

Breakroom Networking Area

The Networking object's Zone Name will default to Networking. This will automatically tie it into the General Navigation panel. By changing the Zone Name, you can create your own custom voice zone.

Breakroom Pod

Managing your Media Library

Breakroom's Media Library feature helps World Owners and World Administrators keep event images and videos organized. Learn how to upload, delete, and tag media elements straight from your browser.

Overview

As you build and refine your Breakroom event space, it's likely that you'll upload images and videos using various in-world tools. The Media Library tab on the Dashboard allows World Owners and World Administrators to view their media collections at a glance, upload media for in-world use, delete unneeded files, and tag files for improved organization.

The Media Library is account-bound, meaning that each user will be able to see and manage only media files that they have uploaded. Only World Owners and World Administrators can access the Dashboard. When planning your event, it may be wise to create a team continuity plan to ensure that important media files are uploaded on multiple accounts.

Uploading images and videos

Using the Media Library management tab, you can upload images and videos to Breakroom straight through the Dashboard. These media files will appear in your in-world Image Library, where they can then be deployed when setting up tools like the Breakroom Image Viewer and Breakroom Teleport Portals.

To upload an image or video file through the Dashboard, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Media Library tab, and then click the Upload Image/Video button.

  3. In the panel that appears, click the Select button. This will launch a standard file import window on your computer.

  4. Locate the file you want to use and click on it. Then click the Open button. Once your image or video has been uploaded, you will see it appear as a preview thumbnail.

  5. Add an image title, description, and tags if you like.

  6. Click the Confirm button to save your file.

Naming and tagging your files makes it easy to search for them using the search field located at the top of the tab. You can also use the media type drop-down menu to narrow your search by file type.

Managing images and videos

Viewing files

All of your uploaded image and video files appear as thumbnails under the Media Library tab. Clicking on a thumbnail will open the file detail window. There you can use the Zoom slider to zoom in and out, or move the image around the preview window by clicking and dragging your cursor.

Editing files

Clicking the Edit button in the file detail window will open the Edit Image/Video panel. Here you can edit the file type, title, description, and tags. You can also replace the file by clicking on the thumbnail. When you're satisfied with your changes, click the Confirm button.

Replacing a file with a new upload on the Media Library tab will not automatically replace the original image if it is displayed in-world. You will still need to manually delete or edit all in-world uses of the image.

Deleting files

To delete a file, first click on its thumbnail in the Media Library tab. You can then click the Delete link in the file detail panel.

Deleting a file from the Media Library tab will not erase that image from in-world displays. You will still need to manually delete or edit all in-world uses of the image.

Sharing files

You can share uploaded files with users outside the Breakroom platform by clicking the Copy URL button in the file detail panel.

Installing Breakroom for Training

With Breakroom for Training, you can gather real metrics about virtual education. Learn how to create courses complete with consent waivers, quizzes, and student- or instructor-led content modules.

Overview

The Breakroom for Training system is designed to support online learning through the streamlined management of educational content. World Owners and other stakeholders can create student- or instructor-led courses consisting of structured learning modules, waivers, and quizzes, and integrate these touchpoints into live online instruction.

This section will discuss the creation and management of Breakroom for Training courses on the backend. For more information about interacting with the Breakroom for Training system as a student or administering courses as an Instructor, please see our Getting Started section.

Only World Owners and World Administrators can access the Dashboard.

Installing the Breakroom LMS Core in a Region

In order for the Breakroom for Training system to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually before the LMS can be added.

In order to use the Breakroom for Training system, you'll need to install the Breakroom LMS Core object in one or more Regions. This object can be found in the Breakroom Toolkit.

You can find more information on using the Region Editor in our Creating Custom Experiences section. Quick-start steps are provided below for your convenience.

  1. Open the Region Editor by clicking the Edit Region button located in the bottom toolbar.

  2. Click the Inventory button in the bottom right toolbar.

  3. Search for the Breakroom LMS Core object in your Inventory, and drag the item into your Region.

  4. The Breakroom LMS Core object can be located anywhere in your Region. For convenience and consistency, we encourage you to locate it at 0,0,0 in your Region by manually editing the Transform component.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

Once the Breakroom LMS Core object is installed, any visitors to the Region will be able to interact with the system as either students or Instructors.

Breakroom Basic Emojis

Encourage audience participation with Breakroom's built-in emoji menu. Learn how to install or remove the Breakroom Basic Emojis item.

Overview

Clicking on the Emoji button reveals a menu of emojis designed to let users express their (naturally quite positive!) feelings about your event. These emojis will be displayed in a fun, brief animated burst above the avatar's head.

In order for this Toolkit object to work, you must have the Breakroom conference core components installed in the same Region. If you have uploaded a custom Region, you will need to install these components manually prior to setting up this object.

Deleting or deactivating the Emoji button

The Emoji button comes pre-installed in many Breakroom Region templates. To remove the Emoji button from a Region that currently contains it, or to temporarily disable the Emoji button without removing it, follow these steps.

  1. Open the Region Editor by clicking the Edit Region button located in the bottom toolbar. Then click the Objects button.

  2. In the Objects window, expand the room floor by clicking the > arrow located to the left of its name. Locate the Breakroom Basic Emojis object. (Alternatively, you can search for "Emoji" in the search field.)

    1. To delete the Emoji button: To the right of the Breakroom Basic Emojis object, you'll see a trash can icon. Click this icon to delete the object from the Region.

    2. To temporarily disable the Emoji button: To the right of the Breakroom Basic Emojis object, you'll see an eye icon. Click this icon to temporarily disable or "mute" the button.

  3. Click the Save button in the bottom right corner to save your work. Click the Close button to exit the Region Editor.

Installing or reactivating the Emoji button

To install the Emoji button in a Region, or to reactivate it, follow the steps below.

  1. Open the Region Editor by clicking the Edit Region button located in the bottom toolbar.

  2. To install the Emoji button:

    1. Open your Inventory by clicking on the Inventory button at the bottom of the screen.

    2. Click on the object icon. Then click on a location in your Region to place the Breakroom Basic Emojis object down. (Note: This object is invisible—you can place it anywhere. However, we encourage you to locate it at 0,0,0 in your region by manually editing the Transform component.)

  3. To reactivate a disabled Emoji button: In the Objects window, expand the room floor. Locate the Breakroom Basic Emojis object. Click the eye icon associated with the object.

  4. Click the Save button in the bottom right corner to save your work. Click the Close button to exit the Region Editor.

Waivers

Give students the information they need and record consent or encourage buy-in through the use of waivers. Learn how to create, edit, and archive waivers using the Breakroom for Training system.

Overview

Waivers allow instructors to present written information to students within the Breakroom platform, and gather student consent or feedback based on context. Waivers can be used for content disclosures, copyright information, touchpoints, etc.

Adding waivers

Only World Owners and World Administrators can access the Dashboard.

Breakroom for Training course content is created and managed through the Dashboard. To add a waiver to any of your existing courses, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you would like to edit.

  3. Click the Create button in the top right corner, and select Waiver from the drop-down menu.

  4. Enter a name and description for your waiver.

  5. If you like, you can change the waiver header by following these steps:

    1. Click the vertical ellipses icon in the upper right corner, and then click Upload Background Image.

    2. Click the Upload Image button to add an image to launch a standard file selection window on your computer. Select the image you want to use, and click Okay.

    3. Alternately, click the "Select from Our Course Image Templates" link to choose a basic color or generic image.

  6. Check the boxes beside the default Agree and Disagree reactions, or enter your own reaction text.

  7. When you are satisfied, click the Save button.

When waivers are first created, they are deactivated by default. To activate or deactivate a waiver, click the On / Off Toggle located in the top right corner of the waiver card.

Active waivers are live on your Breakroom World and can be accessed by students and Instructors. Deactivated waivers are inaccessible to students and Instructors, but World Owners and World Administrators can still edit their contents via the Dashboard.

Editing waivers

In the top right corner of each waiver card, you'll see a vertical ellipses icon. Clicking on this will open a menu containing waiver editing functions. Here's an overview of the associated UI.

Button or function
Purpose

On / Off toggle

Activates or deactivates the waiver.

View Waiver Content

Allows you to review the waiver and all response options.

Edit Waiver Content

Allows you to make changes to the waiver.

Duplicate

Creates a copy of the waiver in the same course.

Archive

Reviewing waiver responses

Student responses to waivers, including the response date and time, can be viewed following the steps below.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you want to review.

  3. Click the Agree/Decline button in the bottom right corner of the relevant waiver card.

  4. In the response window that appears, you can use the search field to locate a specific student, and filter all responses using the All Status drop-down menu.

Archiving waivers

Waivers can be archived, which deactivates them and prevents their contents from being edited. This preserves their contents for future use.

To archive a waiver, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you want to edit.

  3. Click the vertical ellipses icon in the relevant waiver card, and select Archive from the menu that appears.

To locate an archived waiver and make it accessible again, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you want to edit.

  3. Click the Filter button in the top right corner. In the menu that appears, check the Archived List option. This will reveal all of your archived materials.

  4. Locate the waiver you want to unarchive. You can use the search field to streamline this process. Click the vertical ellipses icon in the card, and select Unarchive in the menu that appears.

  5. To display all of your active and inactive course materials, click the Filter button again and check the box beside the Show All option.

When course materials are unarchived, they are deactivated. To activate a waiver, click the On / Off toggle in the upper right corner of the material card.

Creating and managing courses

Courses are the backbone of the Breakroom for Training LMS -- and once you've created them, you can edit and preserve their contents as needed. Learn how to create, edit, archive and retrieve courses.

Overview

In the Breakroom for Training system, courses contain all of the information required for administration of a single class or an entire academic or vocational course. Courses can consist of waivers, quizzes, and syllabuses, which may be administered individually or included as part of student- or Instructor-led content modules.

Once students interact with a particular course's content, student information and progress can be tracked and reviewed as needed. Courses can also be archived, which preserves their contents and prevents them from being edited.

Adding a new course


Only World Owners and World Administrators can access the Dashboard.

Breakroom for Training course content is created and managed through the Dashboard. To create a new course, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab.

  3. Click the Add Course button.

  4. In the Create New Course window that appears, enter a name and description for your course.

  5. If you like, you can click the Upload Image button to upload a course header from your own computer, or click the "Select from Our Course Image Templates" link to choose a basic color or generic course image.

  6. When you are satisfied, click the Create button.

Activating and deactivating courses

Once you add a course to Breakroom for Training, you will see that course appear as a card under the Learning Management tab. When courses are first created, they are inactive by default. To activate or deactivate a course, click the vertical ellipses icon in the upper right corner of the card, and then click the Activate/Deactivate Course button.

Activated courses are live on your Breakroom World and can be accessed by students and Instructors. Inactive courses are inaccessible to students and Instructors, but World Owners and World Administrators can still edit their contents via the Dashboard.

Editing course information

You can edit your course details at any time by clicking the vertical ellipses icon in the upper right corner of the course card on the Learning Management tab, and then clicking the Edit Course Info button.

Adding course notes

You can add notes to a course that will only be visible to those with Dashboard access. To do so, click the Notes button in the course card.

Archiving courses

Breakroom for Training courses can be archived, which deactivates them and prevents their contents from being edited. This preserves their contents for future use.

To archive a course, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab.

  3. Click the vertical ellipses icon in the course card, and select Archive in the menu that appears.

To locate an archived course and make it accessible again, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab.

  3. Click the Filter button in the top right corner. In the menu that appears, check the Archived List option. This will reveal all of your archived courses.

  4. Locate the course you want to unarchive. Click the vertical ellipses icon in the course card, then select Unarchive This Course in the menu that appears.

  5. To display all of your active and inactive courses, click the Filter button again and check the box beside the Show All option.

Quizzes

Breakroom for Training quizzes can consist of one or more questions of mixed type. Questions can be marked as mandatory or optional, and responses can be graded automatically or collected for manual grading, complete with reference answers.

Adding quizzes

Only World Owners and World Administrators can access the Dashboard.

Breakroom for Training course content is created and managed through the Dashboard. To add a quiz to any of your existing courses, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you would like to edit.

  3. Click the Create button in the top right corner, and select Quiz from the drop-down menu.

  4. Enter a name and description for your quiz.

  5. If you like, you can change the quiz header by following these steps:

    1. Click the vertical ellipses icon in the upper right corner, and then click Upload Background Image.

    2. Click the Upload Image button to add an image to launch a standard file selection window on your computer. Select the image you want to use, and click Okay.

    3. Alternately, click the "Select from Our Course Image Templates" link to choose a basic color or generic image.

  6. Add the number and type of questions you would like. Each question appears on its own card.

    1. You can add new questions by scrolling down and clicking the Plus button located in the lower right corner of the window.

    2. You can change the question type using the Question type drop-down menu located at the top of the question card.

  7. When you are satisfied with your changes, click the Save button.

When quizzes are first created, they are deactivated by default. To activate or deactivate a quiz, click the On / Off Toggle located in the top right corner of the quiz card.

Active quizzes are live on your Breakroom World and can be accessed by students and Instructors. Deactivated quizzes are inaccessible to students and Instructors, but World Owners and World Administrators can still edit their contents via the Dashboard.

You can add questions to a quiz during the initial creation process described above, or at any time by editing the quiz content.

Editing quizzes

In the top right corner of each quiz card, you'll see a vertical ellipses icon. Clicking on this will open a menu containing quiz editing functions. Here's an overview of the associated UI.

Button or function
Purpose

On / Off toggle

Activates or deactivates the quiz.

View Quiz Content

Allows you to view all questions on the quiz, along with correct answers and reference keys.

Edit Quiz Content

Allows you to make changes to the quiz, including deleting or adding questions.

Duplicate

Creates a copy of the quiz in the same course.

Archive

Quiz question types

The information provided below is intended to serve as a brief overview of the options available under each quiz question type. As with many things in Breakroom, the best way to master the task of course creation is to dive right in and play around.

Multiple choice questions

Multiple choice questions offer an impressive level of flexibility. You can specify multiple answers for users to check off, dictate that users must make a certain number of guesses, or even create single-answer questions by limiting the minimum and maximum choices required to 1.

Written response questions

Written response questions give users the opportunity to demonstrate deeper knowledge or to share personal insights. These questions must be graded manually, but a quiz point value and reference answer can be provided for graders. You can also specify a minimum and maximum number of characters allowed.

Match items questions

Match items questions can be made easier or more complex by the addition of minimum and maximum answer requirements.

Reference links and images

All question types can come bundled with website links and image files, providing students with helpful information as they take the quiz. Students can open links and view image files directly within the Breakroom platform.

To add a website link to a question, paste the link into the Insert Link field and click Insert. You can add multiple links. Make sure to click the Save button to save your changes.

To add a reference image, click the Upload File button. This will launch a standard file import window on your computer. Locate the image file you want to share and click on it, then click the Open button. You can attach multiple image files to a question.

Timed questions

You can place a time limit on any question by clicking the clock icon located at the top of the question card. Enter the time in hours and minutes, and then click outside of the time panel to set it. To remove time restrictions, click the clock icon and then click the Reset button.

Mandatory and optional questions

Any question can be made mandatory by clicking the Mark Mandatory toggle located in the bottom right corner of the question card. Questions are marked mandatory by default. Assigning quiz points to non-mandatory questions lets you build "extra credit" into quizzes, while ungraded written response questions provide students opportunities for reflection.

Removing questions

To remove a question from a quiz, click the Remove button located in the lower corner of the question card and then click the Save button.

Grading quizzes

To access a quiz and grade it, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you'll be grading.

  1. Click the Graded button in the bottom right corner of the relevant quiz card. Submitted but ungraded quizzes are identified by an active Grade button in the Grade column.

  2. Click the Grade button. This will open the submitted quiz.

  1. Of all the question types, only written responses must be graded manually. For the convenience of graders, these questions come with an assigned point value (visible in the upper right corner) and reference answers (located in the middle of the question card). Making use of these tools, you can enter points into the Grade Value field.

  2. If you like, you can manually adjust the Grade Value field for multiple choice and match items questions. You can also add written comments in the Comments field for any question. Students will not see these comments.

  3. When you are satisfied, click the Save button.

Reviewing quiz responses

Individual student quizzes can be accessed for review at any time by following these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you'll be grading.

  3. Click the Graded button in the bottom right corner of the relevant quiz card.

  4. Locate the quiz you want to review and click the View Answer button in the Action column.

Archiving quizzes

Quizzes can be archived, which deactivates them and prevents their contents from being edited. This preserves their contents for future use.

To archive a quiz, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you want to edit.

  3. Click the vertical ellipses icon in the relevant quiz card, and select Archive from the menu that appears.

To locate an archived quiz and make it accessible again, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Learning Management tab, then click on the course you want to edit.

  3. Click the Filter button in the top right corner. In the menu that appears, check the Archived List option. This will reveal all of your archived materials.

  4. Locate the quiz you want to unarchive. You can use the search field to streamline this process. Click the vertical ellipses icon in the card, and select Unarchive in the menu that appears.

  5. To display all of your active and inactive course materials, click the Filter button again and check the box beside the Show All option.

When course materials are unarchived, they are deactivated. To activate a quiz, click the On / Off toggle in the upper right corner of the material card.

Reviewing student information

Review student enrollment by course, verify that touchstones have been completed, and check quiz scores to ensure that students are on track for success.

Overview

Reviewing all participating students

Reviewing students for a single course

You can also access student lists on a by-course basis by following the steps below.

  1. Click on the Learning Management tab, then click on the course you want to review.

  2. Click the vertical ellipses in the top right corner of the main course card, and select Course Participants in the menu that appears.

Seats and concurrency

With Breakroom, it's easy to make room for everyone to join the conversation. Learn more about seats, user licenses, concurrency, and how to expand user capacity as needed.

Overview

Concurrency refers to the number of users who can log in simultaneously. Please note that your Breakroom account's concurrency cap may be different than your total seat count.

Daily Passes

Daily Passes are temporary seats that permit individual users to access your World for 24 hours, giving you the ability to scale your seat count to meet increased user demand. You can use Daily Passes to invite delegates to a conference, sell tickets to a professional or artistic event, or allow contractors to access your virtual workspace. The possibilities are endless.

Usage details

  • Once activated, a Daily Pass will lock to a single user account and will be deducted from your pool of available Daily Passes.

  • Daily Passes expire 24 hours after activation.

  • Unused Daily Passes will roll over month-to-month until your Breakroom subscription is cancelled or expires.

Purchasing Daily Passes

  1. Click on the Manage Users tab.

  2. Click on the Daily Pass button located in the bottom right corner. This will open the Add Daily Passes window.

  1. Move the slider to indicate the number of Daily Passes you need, or enter the number manually in the field located above the slider.

  2. Confirm your purchase by clicking the Add Daily Pass button.

Instructor orientation

As an Instructor

Logging in

Users who have access to Breakroom's moderator tools can become Instructors on the Breakroom for Training system. This list includes:

This section of the documentation refers to these individuals collectively as "Instructors." To enter Instructor mode, follow these steps.

  1. Navigate your avatar to the Region where you'll be instructing.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Instructor Mode button at the top of the moderator tools.

  4. When prompted to confirm your choice, click the Yes button.

To leave Instructor mode, repeat steps 1-4 above. You can also click the Leave Instructor Mode button on the top right of the Breakroom for Training widget.

Posting quizzes


When you're in Instructor mode, clicking the Course Information button in the Breakroom for Training widget will give you access to quizzes and waivers for each course.

To post a quiz for all users currently located in the Region, follow these steps.

  1. Click the Course information button on the top left of the Breakroom for Training widget.

  2. Click on the name of the course you're administering, and click the Quizzes tab.

  3. Locate the quiz you want to post, and click the associated Post button.

While the quiz is active, the text on the Post button will change to say End. When you're ready to end the quiz for all users, click the End button.

Reviewing quiz responses

Instructors can view anonymized quiz responses in real-time within the Breakroom platform. This is a powerful tool, as instructors can alter their content or instructional techniques based on student feedback.

To view quiz responses, follow these steps.

  1. Click the Course information button on the top left of the Breakroom for Training widget.

  2. Click on the name of the course you're administering, and click the Quizzes tab.

  3. Locate the quiz you want to review, and click View Responses.

If a quiz contains multiple questions, you can scroll through the question cards by clicking the forward and back arrows in the top right corner.

Grading quizzes

Posting and reviewing waivers


Just like quizzes, waivers are visible under the Course Information window when you're in Instructor mode. To post a waiver for students to review, follow these steps.

  1. Click the Course information button on the top left of the Breakroom for Training widget.

  2. Click on the name of the course you're administering, and click the Waivers tab.

  3. Locate the waiver you want to post, and click the associated Post button.

You can view anonymized response data at any time by clicking View Responses.

Creating and managing user accounts

The Metaverse couldn't exist without the creativity and talents of its users. Learn how to add users via CSV file upload or manual account creation, and watch your Breakroom World come to life.

Overview

There are a number of ways that you can invite users to join you in Breakroom. You can:

Importing and exporting user lists

Downloading a blank CSV file

You can download a fresh, unpopulated CSV file by clicking on the file link below.

You can also download an unpopulated CSV file directly from the Dashboard. Click on the Manage Users tab, and then click the Import Users button. The Import Users window will appear. Click on the link that says "Download CSV Model," and save the file to your computer.

Opening and editing a CSV file

You can open and edit CSV files using any commonly available spreadsheet software, such as Microsoft Excel or Google Sheets. When you open a blank Breakroom CSV file, you will see a series of fields where you can enter required or optional information.

Required information includes:

  • Email address: This should be an email address to which the user has full access, in case they need to change their password.

  • Password: This should be a complex, unique password of six or more characters.

Usernames can contain a maximum of 32 characters. Only alpha-numeric characters, spaces, underscores, periods, and dashes can be used. If you do not enter a custom username, one will be auto-generated from the user's display name.

Optional fields include:

  • Title: This is optional information that will also appear in the hover tag displayed above the user's avatar, as well as in their profile. For instance, you might use this field to identify a "Senior Delegate," or make it something fun like "Metaverse Wanderer."

  • Job Title: This refers to the user's actual job title. If you supply this information, it will be displayed in the user's hover tag and in their profile.

  • Company: The company the user works for. If you supply this information, it will also be displayed as described above.

Once you've entered the minimum required user data, you will need to save or export the document in CSV (.csv) format. You can change the document name if you like.

Uploading a CSV file

To upload a CSV file, navigate to the Manage Users tab of your Dashboard and click the Import Users button.

In the Import Users window that appears, click the "Upload file" field. This will launch a standard file import window on your computer. Locate the CSV file you want to upload, click on it, and then click the Open button.

If your CSV file contains any errors, the document will be rejected and those errors will be highlighted so you can make the necessary corrections. If no errors are detected, you will see the "CSV file verification succeeded" message displayed in the image above. Click the Import CSV button to continue.

Once you've successfully imported your users, you will see them listed under the Manage Users panel. You can click the pencil icon located next to a user's name to manually edit their information, or click the trash can icon to remove them from your user list altogether.

If you need to locate a particular user or set of users, you can also make use of the following functions:

  • The search field in the upper left corner allows you to search for a name, email address, or specific user ID.

  • The "Search by status" drop-down menu allows you to display only those users who have a particular status (e.g. active, pending, etc.).

  • The "Select user type" drop-down menu allows you to display only users of a certain type (e.g. World Administrators, World Developers, etc.).

Exporting existing users as a CSV file

To download a CSV file containing all of your current user information, click the Export Users button.

Adding individual users

Adding a user to your roster manually is as simple as filling out a text form. To begin, navigate to the Manage Users tab on your Dashboard and click the Add Users button.

If you want to add more than one user during a single session, click the plus icon in the bottom left corner to generate an additional set of user information fields. When you are finished keying in your user data, click the Add User button.

Assigning user types

Managing user status

In addition to a user type, each user is also assigned a status. You can use the "Search by status" drop-down menu to display only the users assigned that particular status, and to narrow down your search for a specific user.

The status types are:

By default, inactive users will not be displayed in your user list. To see your Inactive users, please use the "Search by status" drop-down menu to select the All or Inactive option.

Activating and deactivating users

To deactivate an individual user, click on the trash can icon located to the right of their name. The trash icon will then change to an undo icon. To reactivate the user, click the undo icon.

To deactivate or activate multiple users at once, check off each relevant name in your user list and then click the trash can icon or undo icon located in the top right above the user list.

If a user seems to disappear from your user list when you deactivate them, make sure that the "Search by status" drop-down menu is set to show All users or Inactive users. If it is set to any other option, you may not see your full user list.

Enabling self-registration

You can enable or disable self-registration from your Dashboard by following the steps below.

  1. Click on the World Customization > World Access tab.

  2. Click the Self Registration toggle to enable or disable self-registration.

Single sign-on

Learn how to enable SSO on Breakroom and customize your end-user login experience.

Overview

By enabling single sign-on (SSO) on Breakroom, you can provide your users with a secure and simplified login process. Integrating your current identity management system with Breakroom takes only a few minutes, but has the potential to save you a lot of hassle.

In order to enable SSO, you will need to contract for services with an Identity Provider (IdP). Some IdPs to consider include Okta and Microsoft Azure.

Enabling SSO

To enable SSO within Breakroom, you will need to copy the parameters Breakroom provides and enter them into your IdP's SAML Signing Certificate generator. Your IdP will then provide you with a SAML Signing Certificate, which will include a metadata file containing additional information. You will need to enter this information into the Breakroom Dashboard in order to complete setup.

You can enable SSO within Breakroom by following the steps below.

  1. Click on the World Customization > World Access tab.

  2. Click the SSO Login toggle to enable SSO.

  1. Once the SSO Login toggle is enabled, several additional sections will appear on your screen. Scroll down to the Identity Provider Setup panel.

  2. Here you will see two parameters provided in the form of links—the SSO URL and the SP Entity ID. You can click the copy icon located next to either of these parameters in order to copy it.

  3. Enter these parameters into the SAML Signing Certificate generator on your IdP's website. Once your IdP finishes creating your SAML Signing Certificate, they will provide you with a metadata file.

  1. Return to the Breakroom Dashboard and scroll to the Details Provided by your Identity Provider section. Enter the Entity ID, X.509 Certificate, and Sign-in URL parameters from the IdP metadata file into the relevant fields.

  2. Click the Save button.

Important notes

Disabling SSO

Customizing the Breakroom login screen

To customize the login panel, follow these steps.

  1. Click on the World Customization > World Access tab.

  2. First, choose which login methods will be available for your users.

    1. Enable or disable the standard login (Breakroom account email and password).

  3. If you have chosen to enable SSO, you can then customize the SSO login button appearance.

    1. In the Button Text field, enter the text you would like to appear on the button.

    2. If you want to upload a custom logo for the SSO login button, click the Browse link in the Button Image field. This will launch a standard file import window on your computer. Locate the image file you want to use, click on it, and then click the Open button.

    3. If you want to clear the current logo, click the Delete button.

  4. When you are satisfied with your changes, click the Save button.

Region-level user permissions

Learn how to assign advanced Region-level permissions to your teammates, and take full advantage of Breakroom's powerful Region editing and event management tools.

Overview

Region-level user types

In brief, the current Region-level user types are:

Assigning and revoking advanced Region-level permissions

To assign advanced Region-level permissions to individual users, follow the steps below.

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

  2. Click on the Members tab in the Region Information window.

  3. Click the Add Members button to open the "Add new members" dialog box. Locate the user you want to whitelist by using the search field, and then click the Add button beside their name.

  4. Once the user is added to the Region members list, check the box next to their name and then click on the Set Role drop-down menu. From this menu, select the permissions level you'd like to assign the user.

Removing Region members

To remove a user from the Region members list entirely, follow these steps.

  1. Click on the Members tab in the Region Information window, and use the search field to search for the user's name.

  2. Once you locate the user you want to remove, click the Edit button located to the right of their name. In the action menu that appears, click Delete.

Assigning Region control to a group

This means that only Group Administrators, Group Moderators, Group Developers, etc. will be able to exercise their powers over the Region as a whole. Additionally, only group members will be permitted to visit the Region. Any users in the Region member list will be ignored.

World Stream

World Stream makes Breakroom accessible to everyone, everywhere. Learn how everyone can meet in the Metaverse, even if they don't have a mind-blowing computer setup.

Overview

World Stream is an innovative cloud-based solution for enterprise and educational communities where members might not have access to advanced graphics processing hardware. World Stream renders your Breakroom World in a series of cloud servers, and then streams a dynamic, interactive live video of that World to each user's device.

This offers many benefits, including:

  1. Users don't need to download or install anything. No plugins, no standalone apps.

  2. Users don't need to have the latest and greatest computer hardware. As long as their device can run a supported browser and has access to the Internet, they're ready to stream.

Microsoft Edge usually comes bundled with Windows. In order to use World Stream, you must use the version of Edge which, like Google Chrome, is built on the Chromium engine. Prior to logging in to World Stream through Microsoft Edge, please make sure that Windows Update has been run recently and that you are using the most recent version of Edge.

Basic World Stream functionality

World Stream access is provided by AWS, which uses a variety of locations for delivery. Upon logging in, World Stream users will automatically be assigned to an available, low-latency AWS instance close to their physical location. In order for World Stream to be delivered, system administrators will need to whitelist the following domains:

*.breakroom.tech

*.amazonappstream.com

*.appstream2.eu-central-1.aws.amazon.com

*.appstream2.eu-west-1.aws.amazon.com

*.appstream2.eu-west-2.aws.amazon.com

*.appstream2.eu-east-1.aws.amazon.com

*.furioos.com

Additionally, please enable outbound UDP and TCP traffic on ports 443, 8433, and 53.

Users attempting to connect to Breakroom from behind an aggressive firewall may run into issues, as they will have limited access to the Internet. In these cases, a commercial TURN server may provide the necessary solution.

World Stream server types

World Credits

Partial hours and World Credit consumption

This means that users cannot consume partial hours while logged in to World Stream. For example, if a user logs in for 20 minutes, the cost of one hour of access (60 minutes) will be deducted from the World Credits available on the account.

Launching World Stream

World Stream can be accessed just like any other website. When you purchase a Breakroom subscription, you will be provided with a dedicated World Stream URL. You can copy this URL in order to share it with your users.

Several of the buttons in these headers can be used to launch World Stream or access the World Stream URL. Here's a brief overview of the UI.

Media access permissions

Logging in to World Stream

Switching World Stream user accounts

If you close World Stream and attempt to start it again a short time later, you may see an account confirmation dialog box appear during the login process. If you want to log in under the account you previously used, click Continue. If you want to log in with another user account, click Switch Account.

Important notes

Cross-platform voice capabilities

Users who log in via the same method can communicate freely. Therefore, we strongly suggest that you take this into consideration when planning your events, and require all guests to use either World Stream or the desktop app.

We apologize for the inconvenience, and hope to provide a solution soon.

Browser auto-play

World-level user permissions

By assigning special permissions to your team members, you can take collaboration and customization to a whole new level. Learn how to appoint Administrators, Moderators, and more.

Overview

World-level user types

Users with advanced World-level permissions have broad powers that apply to the entirety of your Breakroom World, but not necessarily powers that apply to individual Regions. Users with advanced World-level permissions generally have powers that allow them to manage your Breakroom account, oversee events, and upload new content.

In brief, the current World-level user types are:

In addition, World Owners can:

  • Modify or overwrite any content uploaded by other users.

World Administrators can perform many of the same tasks as World Owners, except they will not have access to billing information. They also cannot appoint additional World Administrators.

World Administrators can:

  • Modify or overwrite any content uploaded by other users.

World Moderators can:

World Developers can create and upload content to your World, as well as approve content uploaded by other users. They can also edit existing Regions using the in-world Region Editor.

World Developers can:

  • Modify or overwrite any content uploaded by other users.

World Guest accounts are created when:

Assigning and revoking advanced World-level permissions

You can assign advanced World-level permissions to individual users by following the steps below.

  1. Click on the Manage Users tab.

  2. Locate the name of the user whose permissions you want to edit. (Tip: You can use the search field to search by name or email address.) Click the pencil icon to the right of their name.

  3. In the Edit User window that appears, click on the permissions type you would like to assign.

  4. Click the Update button to save your changes.

Syllabuses

Creating a syllabus on Breakroom for Training allows your team to deliver standardized educational content and administer touchpoints, either on-demand or as part of a supported learning environment.

In the meantime, the following links may be of assistance.

For individual instructors:

For World Owners and World Administrators

Overview

Student-led vs. Instructor-led courses

A syllabus can be designated as student-led or Instructor-led. These can be considered synonymous with “single user” and “multi-user," as in:

  • A student-led syllabus is controlled by and only impacts the user running it.

Key features

The purpose of a syllabus is to create a structured, guided way for students to experience the course content, and offers the following key features:

  • Consistency: Regardless of who takes the course, or who teaches it, the content and lesson plan remain the same for each student.

  • Onboarding: Syllabuses simplify onboarding of new Instructors and students to the platform. An Instructor who is competent with the material being presented can quickly guide students through the course using the syllabus widget.

  • Completion: Tracking who has finished a syllabus to the end allows stakeholders to evaluate student progress and see whether they have completed the required materials.

  • Resiliency: Instructors have the ability to resume classes from any point if the material cannot be completed in a single session. Student-led courses automatically pick up where the student left off if they need to step away.

Building a syllabus

Dashboard interface tour

Adding a syllabus

  1. Click on the Learning Management tab, then click on the course you would like to edit.

  2. Click the Create button in the top right corner, and select Syllabus from the drop-down menu.

  3. Enter a name and description for your syllabus.

  1. Click the Syllabus Type toggle to indicate whether you would like the syllabus to be Instructor-led or student-led.

  2. If you like, you can change the syllabus header by following these steps:

    1. Click the vertical ellipses icon in the upper right corner, and then click Upload Background Image.

    2. Click the Upload Image button to add an image to launch a standard file selection window on your computer. Select the image you want to use, and click Okay.

    3. Alternately, click the "Select from Our Course Image Templates" link to choose a basic color or generic image.

  3. When you are satisfied with your changes, click the Next button.

Once your syllabus is created, you'll be directed to the Syllabus editing panel. Here you will see Steps on the left, and Actions and Annotations for each step on the right. We will review these features in more detail in the following sections.

Editing a syllabus

Steps and actions

When editing and executing a syllabus, everything revolves around steps. A syllabus contains one or more steps that must be completed to finish the syllabus. The current limit for this is 150 maximum steps.

Steps can also include annotations. Annotations consist of information that is displayed on-screen, and can be any combination of text, an image, and a link that opens in an external browser tab. There are separate annotations available for students and Instructors. Instructors can see student annotations if present, but students will never see Instructor annotations.

Action types

All actions execute on each step in the order they are arranged on the Dashboard. Annotations are displayed alongside the first action listed under any given step, and will not be dismissed until the next step is triggered.

Change Camera

Fields and options

  • Camera Perspective: Choose from Behind, Forward, Speaker, Screen, Audience, and Free Look

Custom Function

Fields and options

  • Channel: The channel parameter provided to Space.Shared.CallBroadcastFunction.

  • Command: The command parameter provided to Space.Shared.CalBroadcastFunction.

  • Parameters (Optional): Any extra info to pass to the Space.Share.CallBroadcastFunction call. This can be simple strings, or anything up to including encoded JSON information.

  • Along with the above information, the Lua script will receive a variety of metadata including:

    • Whether the syllabus is Instructor-led

    • The ID of the syllabus that called it

    • The ID of the course that called it

    • The current step number

    • A force parameter that translates to “override the ‘already done’ parameter”

    • An already done parameter which indicates if this step is being repeated (i.e., perhaps you don’t want to do a repeated step exactly the same as you did the first time)

    • Whether the current user is in control of the syllabus (i.e., the Instructor in an Instructor-led course, versus being a student)

Draw Attention

Fields and options

  • UI Element: Choose from Microphone, Webcam, Screenshare, Troubleshooting, Ask Question, Emojis, or Raise Hand

Participation Level

Fields and options

  • Permission:

    • Quiet: Enables Quiet Mode, disables Audience Mode

    • Voice Only: Disables Quiet Mode, disables Audience Mode

    • Full: Disables Quiet Mode, enables Audience Mode

Send Broadcast

Fields and options

  • Broadcast Message: Whatever you want the message to say.

Show Toast

Displays a temporary popup message on the screen that fades away after a few seconds.

Fields and options

  • Target Audience: Choose from User or Everyone. Everyone is only available in Instructor-led courses.

  • Toast Message: Whatever you want the message to say.

Start Quiz

Fields and options

  • Quiz Name: Select from active quizzes in the same course.

  • Question Selection: Select “All,” or alternatively, select one or more individual questions. Quizzes can be given in whole or in parts, with the expectation that the other quiz questions will be answered later in the syllabus.

Stop Quiz

Cancels a quiz. Any late joiners to the class will not be presented with the quiz. It is recommended that you stop quizzes past the point at which it makes sense to allow students to continue working on them.

Fields and options

  • Quiz Name: Select from active quizzes in the same course. Will do nothing if you didn't begin the quiz on a previous step.

Start Timer

Starts a countdown timer that will be visible on screen.

Fields and options

  • Target Audience: Choose from User or Everyone. Everyone is only available in Instructor-led courses.

  • Duration: How long the timer runs down, in hours and minutes.

  • Description: An indication of what the timer is counting down. Will be displayed as a tooltip when users hover their mouse over the timer.

Start Waiver

Fields and options

  • Waiver Name: Select from active waivers in the same course.

Take Tour

Fields and options

  • No parameters required.

  • Students can stop the tour at any time by pressing the Esc key on their keyboard.

Teleport

Fields and options

  • Target Audience: Choose from User or Everyone. Everyone is only available in Instructor-led courses.

  • Location: Choose from common locations such as the Auditorium, or from custom locations by picking Other. Other locations can be any valid Breakroom voice zone or teleport target. If the target shows up under the Crowd Manager in the Moderator controls, then it can also be a location here. This includes multi-zone landmarks that scatter the students among multiple locations if desired.

View Image

Fields and options

  • Image: Select or upload the image to display.

  • Display Location:

    • Screen: Displays in a separate 2D window on the user's screen as part of an LMS Media window that appears when needed.

Visit Website

Displays or opens a website URL in the specified location.

Fields and options

  • Website URL: The website you wish the students to read / view.

  • Display Location:

    • Screen: Displays in a separate 2D window on the user's screen as part of an LMS Media window that appears when needed.

    • External: Opens the website URL in an external browser tab.

Watch Video

Fields and options

  • Video: Select or upload a video. Should be in MP4 format for best results.

  • Display Location:

    • Screen: Displays in a separate 2D window on the user's screen as part of an LMS Media window that appears when needed.

Example syllabus walkthrough

The following tutorial offers step-by-step instructions for creating a syllabus and setting up related virtual objects in a Region. For this example...

Default number of chairs: 4 Default voice zone type: Meeting Inventory icon: Key features: This booth includes bookshelves, tables, and plenty of wall space to display promotional materials. A great choice for vendors and conference exhibitors, allowing them to generate excitement about their products and meet with potential clients.

Default number of chairs: 14 Default voice zone type: Meeting Inventory icon: Key features: Forward-facing stools allow users to focus on streaming video or presenter screens, making this an ideal breakout space for smaller presentations, group discussions, and material review. The media screen located at the front of the booth appears when webcam streaming or screen share is enabled, and disappears when not in use.

Default number of chairs: 10 Default voice zone type: Meeting Inventory icon: Key features: A central table facilitates friendly networking sessions or face-to-face power meetings, making this a great breakout space for collaborative work. The media screen located at the front of the booth appears when webcam streaming or screen share is enabled, and disappears when not in use.

Default number of chairs: 34 Default voice zone type: Meeting Inventory icon: Key features: Comfortable audience chairs face the media presentation area, while the two guest chairs located beneath it draw attention to presenters or delegates. Great for focused group workshops, facilitated group discussion, and speaker panels. The media screen located at the front of the booth appears when webcam streaming or screen share is enabled, and disappears when not in use.

Default number of chairs: 9 Default voice zone type: Meeting Inventory icon: Key features: An airy office space full of quirky details. The conference table plus overflow seating makes this a great breakout space for team meetings. The scalable media screen located on the wall appears when webcam streaming or screen share is enabled, and plenty of wall space makes this an ideal area for multi-user video conferencing.

Default number of chairs: 1 Default voice zone type: Presenter Inventory icon: Key features: A sleek and minimalist helpdesk, designed to complement a variety of venue aesthetics. Here staff can welcome and orient visitors through voice chat, text chat, and video.

Default number of chairs: 8 couch seats, 12 coffee table seats, and 12 high-top seats, for a total of 32 "chairs." Default voice zone type: Voice Inventory icon: Key features: A selection of eclectic, comfortable furniture arranged specifically for networking. Use the Region Editor to remove any seats and decorative items you don't need, or leave as-is.

Default number of chairs: 2 Default voice zone type: Meeting Inventory icon: Key features: Hop into this sleek pod for a side conversation, or use the built-in media tools to make a quick video pitch.

Within your inventory, locate the starter pack item called Breakroom Basic Emojis. It's represented by this icon:

the waiver without deleting it.

the quiz without deleting it.

Student participation in Breakroom for Learning can be tracked for the subscription or for each . In addition to viewing the names of all participating students, you can verify waiver answers, quiz grades, and course participation on a by-student basis.

Only and can access the Dashboard.

You can access a list of all students involved with your courses by navigating to the Dashboard > Learning Management tab and clicking the User List button. In the User List window that appears, you can search for students by name, see all courses students have taken, and review and responses.

Navigate to your .

Seats correspond to user licenses, and represent the number of active user accounts that your Breakroom World can accommodate. In addition to the persistent seats included with your Breakroom subscription, you can add temporary seats to your account through the use of .

Only and can access the Dashboard.

If you need additional persistent seats, please contact our .

Daily Passes are activated when your Breakroom account has no open and a logs in.

and can purchase Daily Passes at any time through the Dashboard by following these steps.

Navigate to your .

This section is currently under construction. We apologize for the inconvenience. Please reach out to our at any time if you require assistance.

The

Administrators, Moderators, and Developers

Owners, Administrators, and Moderators

Navigate your avatar to the Region where you'll be instructing, and .

Navigate your avatar to the Region where you'll be instructing, and .

Quizzes that require manual review (such as written response questions) can only be accessed and formally graded through the .

Navigate your avatar to the Region where you'll be instructing, and .

Create multiple user accounts simultaneously by

Create user accounts one at a time by manually

Allow users to the first time they visit your World

Enable your existing service

Finally, if you're hosting a free or for-cost ticketed event in Breakroom, you'll want to take advantage of to make logistics a snap.

Only and can access the Dashboard.

CSV files, or comma-separated values files, are spreadsheets containing relevant user account information. Uploading a populated CSV file will create an account for each user listed on the spreadsheet, complete with password. You can also include important institutional information about each user, which may be displayed in their or in-world hovertext (the identifying text that appears above each avatar's head).

Display Name: This is the name that serves to identify the user while they are in-world. It will appear in the identification tag that hovers over the user's avatar, as well as in the user's . Display names can be changed at any time by the World Owner or a World Administrator.

Username: This is a permanent username that serves to identify the account. It can also be used in place of the user's email address during the login process on the .

Type: This field should contain the user's type. (If you do not enter a value in this field, the user type will default to .)

The Add Users window will appear. To create a new user account, you will need to provide at least a Display Name, Username, email address, and password. You'll also need to choose a .

User types correspond to , and can be changed by clicking the pencil icon located to the right of a user's name and then selecting the type to be assigned. A detailed explanation of the different user types and for assigning or revoking World-level user permissions are also available.

Active: The user's account is active and accessible to the user. They can log in to your World. If you have assigned them advanced , they have access to the virtual tools they need (e.g. Curator).

Inactive: The user's account information is preserved, but they cannot currently log in to your World. See the section that follows for more information about .

Pending: The user's account is pending activation, and they have not yet logged in. This may be due to a lack of available .

Users can be deactivated individually or in bulk. When a user is deactivated, they will still appear under the Manage Users tab, with their user status changed to Inactive. They will no longer be able to log in, and will no longer take up one of your account's .

When you reactivate an inactive user account, the account will default to Pending status and Guest type. You will need to update their manually.

When self-registration is enabled, users who access your World through or a dedicated can sign up for their own account. Each user registration will take up one of your available , and users will be given the opportunity to pick a from your default avatar collection.

Navigate to your .

If self-registration is disabled, you will need to import or manually create user accounts using the steps outlined , or .

Only and can access the Dashboard.

Navigate to your .

Upon enabling SSO, user accounts are not automatically generated in Breakroom, and you will not see any users appear under the . Instead, Breakroom accounts will be generated as users log in. Each user account will occupy one of the available under your Breakroom account.

To disable SSO integration, follow steps 1-2 as and click the SSO Login toggle again.

The World Access tab features a login panel preview, so you can see how your changes will appear on the landing page and on the . You can also personalize your SSO button with a logo and custom text.

Navigate to your .

Enable or disable .

Enable or disable .

There are two categories of special user permissions that you can assign to teammates, event coordinators, or end users—, and Region-level permissions. It is important to note that these two categories are distinct, with their own separate spheres of influence and control. On this page, we will discuss Region-level user types.

Only and can access the Dashboard.

Users with advanced Region-level permissions have powers that apply to individual Regions within your World. These users can assist with setting up individual Regions and moderating events, but cannot access the in order to manage user accounts, approve content submitted to , or change your World-level settings unless you have also assigned them .

It may be helpful to think of advanced Region-level permissions as those you can assign and manage through the .

Region Owners have absolute control over the Region and its settings.

Region Owners can:

  • Access the Region .

  • Access the .

  • Access the and edit the Region settings.

  • Manage the and deal with .

  • Assign other users advanced .

Region Administrators can perform many of the same tasks as Region Owners. They cannot appoint additional Administrators.

Region Administrators can:

  • Access the Region .

  • Access the .

  • Access the and edit most Region settings.

  • Manage the and deal with .

  • Assign other users advanced below the Administrator level.

Region Moderators have access to the moderator controls and certain Region settings. They cannot appoint additional Moderators.

Moderators can:

  • Access the Region .

  • Access the and in order to deal with .

  • Assign other users advanced below the Moderator level.

Developers can:

Click the Region Information button located above the .

To revoke advanced Region-level permissions, repeat the steps above and select a new role (e.g. Member or Guest). You can learn more about in our .

Click the Region Information button located above the .

By enabling the , you can assign control over a Region to one or more . When a Region is set to "Groups Only," then the group member lists will override the Region's existing members list, including any Region members with advanced permissions.

To disable group control over the Region, a different Region access option. Doing so will restore access and advanced permissions to any users in the Region members list.

World Stream is currently supported on , , and . For the best possible experience, we recommend using Chrome. You can review detailed in our .

Only and can access the Dashboard.

You can learn more about AWS allowed domains by visiting .

If you encounter problems with WebRTC, you can perform a WebRTC test at .

Breakroom offers two types of server access—Ultra Servers and Lite Servers. Ultra Servers are recommended for cases, while Lite Servers are an economical choice for smaller events. Please see our information on and for more details.

When users log in through your dedicated Breakroom , there are no additional access fees above the cost of their . World Stream access, on the other hand, must be purchased on a per user/per time basis using a digital currency known as World Credits.

and can at any time. Unused World Credits never expire, even if your Breakroom subscription lapses.

Due to the way AWS structures its billing, World Stream usage is currently calculated in hourly increments (i.e., multiples of 60 minutes). This hourly calculation policy also extends to and .

When you log in to the Breakroom , you will see a permanent site header (in the example image above, this header is dark purple). You will also see a secondary tab header on each Dashboard tab you visit.

Header button
Function

When you click on a World Stream URL, your browser may request permission to use your microphone or camera. If a pop-up like this appears, click Allow or Okay. If you accidentally refuse permission or close the pop-up without making a choice, see our for assistance.

Once you've opened the World Stream URL in your web browser, you'll see an Account Login panel. Here you can either enter your credentials and click the Login button to connect to World Stream, or sign up for a new account if is enabled.

Once you've successfully logged in, that's it! Basic information about using Breakroom can be found in our .

Voice capabilities are currently restricted by login method. This means that if one user is logged in via and another user is logged in via a Breakroom , they will not be able to hear each other over voice chat, even if they are standing in the same Region.

Some browsers come equipped with "auto-play policies" that automatically block websites from playing audio and video until you interact with the content. In addition to to World Stream, you may also need to click on the page or otherwise interact with the streaming content in order to enable audio. You will need to repeat this action if you refresh the page.

There are two categories of user permissions that you can assign to teammates, event coordinators, or end users—World-level permissions, and . It is important to note that these two categories are distinct, with their own separate spheres of influence and control. On this page, we will discuss World-level user types.

Only and can access the Dashboard.

It may be helpful to think of advanced World-level permissions as those you can assign and manage through the .

World Owners are responsible for managing for their account, and can review their past invoices via the Dashboard.

Access the .

Purchase additional , , and .

Request for events.

Create and edit , , make use of World .

Edit all hosted on the World.

Access platform and make decisions about .

Access all .

Log in to their World while it is .

to Curator and approve their own content.

and content uploaded by other users.

Appoint World Administrators and change user types through the or .

Access the .

Purchase additional and .

Request for events.

Create and edit , , make use of World .

Edit all hosted on the World.

Access platform and make decisions about .

Access all .

Log in while the World is .

to Curator and approve their own content.

and content uploaded by other users.

Change sub-Admin user types through the .

World Moderators have universal access to the moderator controls, so they can moderate events held in any Region. They do not have access to the Dashboard, and they cannot administrate or edit any Regions unless they own that Region or have been given advanced .

Edit all hosted on the World.

Access all .

Log in while the World is .

Access in order to mute and block abusive users.

to Curator and approve their own content.

and content uploaded by other users.

List uploaded items for sale on the .

Access all .

Log in while the World is .

Access the .

After you have granted a user World Developer permissions, they will need to and accept the Terms and Conditions before they can access the .

World Members occupy a seat and don't have any special privileges. You may choose to assign World Members .

You create user accounts by , and do not specify another user type in the Type field.

While creating user accounts by uploading a CSV, you attempt to import more users than you have available . In this case, the extra user accounts will be created as Guests.

User accounts are automatically generated by , or any automated registration process you may choose to use.

When World Guest accounts log in for the first time, their account will be updated to Active. Member-type accounts and higher are always given login priority over Guest accounts.

Navigate to your .

To revoke advanced World-level permissions, repeat the steps above and select a new user type (e.g. Member). You can learn more about in our .

This section is currently under construction. We apologize for the inconvenience. Please reach out to our at any time if you need help.

Within the Breakroom for Training system, a syllabus is broadly considered to be an 'activity' like and . However, syllabuses can draw upon those other activities as part of a larger program of instruction, allowing stakeholders to create standardized, semi-automated content modules. These modules can include on-screen annotations and other messages, timers, camera effects, media cues, the execution of custom Lua scripts, and more.

An instructor-led syllabus is controlled by anyone logged in as an , while everyone else is a passive participant. Any actions executed by Instructor-led syllabus will impact all users in the Region.

Building a syllabus on the Breakroom for Training system is a multi-step process. In the following sections, we will begin by exploring the Dashboard interface and its related control panels, breaking down the creation of syllabus steps and actions in clear terms. We will then create a simple custom syllabus as a .

Only and can access the Dashboard.

Breakroom for Training course content is created and managed through the . To add a syllabus to any of your existing , follow these steps.

Navigate to your .

Similar to a or , creating a syllabus will add a syllabus card to the main course screen. In the top right corner of each syllabus card, you'll see a vertical ellipses icon. Clicking on this will open a menu containing editing functions. Here's an overview of the associated UI.

Button or function
Purpose

Each step also contains actions. A step will have at least one associated with it, but can have more actions if desired. The current limit is 10 actions per step. All actions execute on each step in the order they are arranged on the Dashboard.

The following actions are possible for any given step. Please note that some of these actions require advanced working knowledge of Breakroom customization, including .

If the user is seated in a Region that contains a , this action will automatically adjust their camera view as if they had pressed the corresponding button. Users can change it back at any time, as the camera is not locked to this view.

This action executes a custom in the Region. This requires that the course designer has placed their own Lua script in the Region with a registered Space.Shared function call that matches the supplied parameters. A Lua script in the Region can do anything the allows. Altering UIs, changing the environment and lighting, adding new objects, moving objects around, playing games, animating models or custom camera views, etc.

This action visually indicates a to call student attention to it. This can be useful for orientation periods at the beginning of a class, or to remind students during Q&A periods about the location of the and .

Changes the settings on the current occupied by the person controlling the syllabus. These zone settings are persistent, so they will remain in the last setting chosen until they are changed through the or a subsequent syllabus step.

Sends a through the standard messaging feature. The message will be sent as if originating from the primary controller of the syllabus (such as the Instructor).

Starts a . The quiz must be part of the same as the syllabus itself.

Starts a . The waiver must be part of the same as the syllabus itself.

If a exists in the Region, this action will trigger the tour as if the Take Tour button normally found on the has been clicked. This works even if the Start Here panel is not present in the Region.

Teleports users to a different location within the Region. This uses the built into the , and operates along the same principles.

Displays an uploaded image in a specified location. Images can be uploaded in advance through the on the Dashboard, or uploaded directly through this step.

Presentation: Displays the image on the in the voice zone. This is the same screen that displays webcams and screenshares. The image will appear as another window alongside these, as if someone were sharing it. The display may appear 2D or 3D depending on whether the user has clicked the on the .

Placed: Indicates that the image was placed in the scene through some other means, such as a .

Placed: Indicates that the website is visible on a already placed separately in the Region.

Plays an uploaded video in a specified location. Videos can be uploaded in advance through the on the Dashboard, or uploaded directly through this step.

Presentation: Displays the image on the in the voice zone. This is the same screen that displays webcams and screenshares. The image will appear as another window alongside these, as if someone were sharing it. The display may appear 2D or 3D depending on whether the user has clicked the on the .

Placed: Indicates that the image was placed in the scene through some other means, such as a .

This section is written for stakeholders with who are already familiar with customizing the Breakroom platform. If you need help accessing the , or editing the , please consult the linked documentation before proceeding.

Region Developers have access to the Region Editor, and can decorate and modify the Region to which they are assigned. They do not occupy a t, and cannot upload content to Curator.

Access the .

Region Members have no special privileges, but will be permitted to enter the Region should or access be enabled.

If an unassigned user enters your Region, they will appear in the member list as a Guest. Guests have no special privileges, and will not be permitted to enter the Region if access is .

Designating a user as a VIP gives them no special powers. Currently, this role is only useful for Lua script functionality and .

Add Credits

Allows you to purchase World Credits instantly from any page on the Dashboard.

Enter Your World

Opens your dedicated World Stream URL in a new tab.

Advanced

Allows World Owners, Administrators, and Developers to log in to Curator.

Power icon

Logs you out of the Dashboard.

Copy World URL

Copies your World Stream URL to your computer's clipboard.

Download App

Directs you to the Your Apps tab.

On / Off toggle

Activates or deactivates the syllabus.

View Syllabus Content

Allows you to view basic syllabus settings without changing them.

Edit Syllabus Content

Allows you to make changes to the syllabus, including adding or deleting steps and actions.

Edit Syllabus Basic Info

Allows you to edit basic syllabus information such as name, description, and type.

Duplicate

Creates a copy of the syllabus in the same course.

Archive

Archives the syllabus without deleting it.

Archives
Archives
account as a whole
individual course
World Owners
World Administrators
waiver
quiz
Dashboard
Daily Passes
World Owners
World Administrators
Customer Success Team
persistent seats
Guest
World Owners
World Administrators
Dashboard
support team
World Owner
World-level
Region-level
enter Instructor mode
enter Instructor mode
Dashboard
enter Instructor mode
uploading a CSV file
editing your user records
register their own account
single sign-on (SSO)
Eventbrite integration
World Owners
World Administrators
user profile
profile
desktop viewer
World-level permissions
Guest
user type
World-level user permissions
step-by-step instructions
World-level user permissions
activating and deactivating users
seats
seats
World-level user type
World Stream
desktop app
seats
starter avatar
Dashboard
above
enable SSO
World Owners
World Administrators
Dashboard
Manage Users tab
seats
detailed above
World Stream
desktop app
Dashboard
self-registration
SSO
World-level permissions
World Owners
World Administrators
Dashboard
Curator
advanced World-level permissions
Region Information window
moderator tools
Region Editor
Region Information window
Region member list
disruptive users
Region-level permissions
moderator tools
Region Editor
Region Information window
Region member list
disruptive users
Region-level permissions
moderator tools
Region member list
disruptive users
Region-level permissions
World Developer sea
Region Editor
Contact Only
Approved Only
controlled
presenter seats
mini map
managing Region members
Building New Worlds section
mini map
"Groups Only" Region access option
groups
choose
Chrome
Firefox
Microsoft Edge
technical specifications
Help section
World Owners
World Administrators
this page
https://test.webrtc.org/
high user concurrency
purchasing and managing World Credits
event pre-allocation
desktop app
seat
World Owners
World Administrators
purchase additional World Credits
pre-allocation campaigns
user session time limits
Dashboard
troubleshooting documentation
self-registration
Getting Started section
World Stream
desktop viewer
granting media permissions
Region-level permissions
World Owners
World Administrators
Dashboard
billing details
Dashboard
seats
Daily Passes
World Credits
pre-allocation
Regions
filter Shop contents
customization options
meetings
analytics
user privacy and data collection
moderator tools
offline
Upload content
Review
approve
Dashboard
CSV
Dashboard
Daily Passes
World Credits
pre-allocation
Regions
filter Shop contents
customization options
meetings
analytics
user privacy and data collection
moderator tools
offline
Upload content
Review
approve
Dashboard
Region-specific permissions
meetings
moderator tools
offline
Region settings
Upload content
Review
approve
Breakroom Shop
moderator tools
offline
Region Editor
log in to Curator
preview grid
advanced Region-level permissions
uploading a CSV
seats
Eventbrite
status
Dashboard
creating and managing user accounts
Opening the Doors section
support team
Instructor information
Installing Breakroom for Training
Creating and managing courses
waivers
quizzes
Instructor
tutorial example
World Owners
World Administrators
Dashboard
courses
Dashboard
waiver
quiz
action
custom scripting
camera system
Lua function
Breakroom SDK
UI button
Raise Hand
Question buttons
voice chat and audience participation
voice zone
Moderator tools crowd manager interface
broadcast message
Moderator tools
quiz
course
waiver
course
Breakroom Tour Camera
Start Here panel
Crowd Manager controls
Moderator tools
Media Library
main screen
Screen Appearance button
conference system controls
Breakroom Image Viewer item
Breakroom Web Browser item
Media Library
main screen
Screen Appearance button
conference system controls
Breakroom Video Player item
appropriate permissions
Region Editor,
moving objects
RoomFurniture component

Eventbrite integration

Breakroom makes it simple to sell or distribute tickets to your event through Eventbrite. Here's how to find the information you'll need to integrate your Breakroom and Eventbrite accounts.

Overview

By integrating your Breakroom account with Eventbrite, you can sell or distribute tickets to a virtual event and trust the backend logistics to us. Breakroom will automatically create a user account for anyone who purchases a ticket, using their ticket number as the password. If an account already exists under a user's email address, Breakroom will reactivate that account and reset the password to the ticketholder's current ticket number.

In order to integrate Breakroom and Eventbrite, you will need an active Eventbrite account. As a first step, log in to your Eventbrite account and create the event you plan to host in Breakroom. You can then follow the instructions outlined below to integrate your event with Breakroom's systems.

Getting your Eventbrite API key

Once you've created your event on Eventbrite, you'll need to locate the API key associated with that event and enter it into the Breakroom Dashboard. To get started, navigate to your Eventbrite account settings page.

On the left side of the account settings page, you'll see a drop-down menu called Developer Links. Expand it, and click on the tab that says API Keys. Then click on the button that says Create API Key.

Fill out the required information, and click the Create Key button.

Your API key should be generated automatically. Click the > arrow above the application name (in this case, Breakroom) to expand the key information menu. Highlight and copy the private token key.

From here, you will need to enter the private token key into the Breakroom Dashboard. Follow the instructions below to do so.

  1. Navigate to your Dashboard.

  2. Click on the Integration tab.

  3. Under the Select an integration to configure panel, click on the Eventbrite button.

  4. Paste your Eventbrite private token API key into the field.

  5. Click the Create payload URL button. Under the Payload URL panel, a special URL will be generated for you.

  6. Highlight and copy the payload URL.

  7. Return to the Eventbrite page to complete setup.

Setting up Webhook with payload URL

After you receive your payload URL, click on the Webhooks tab under Developer Links on your Eventbrite account settings page. Then click the button that says Add Webhook.

From here, you will need to enter the payload URL into Eventbrite. Follow the instructions below to do so.

  1. Paste the payload URL into the top field.

  2. Using the drop-down Event menu, select either a specific event or All Events, if you want to link more than one event to a single ticket purchase.

  3. Check the box beside order.placed.

  4. Click the button that says Add Webhook.

Once all of these steps are completed, you are ready to go.

Onboarding Eventbrite ticketholders

When users purchase a virtual event ticket through Eventbrite, they will not receive a confirmation email from Breakroom. Therefore, we strongly encourage event organizers to use their Eventbrite listing, email, or other relevant tools to provide ticketholders with the information they will need to log in.

Key points to communicate to ticketholders include:

  • Breakroom will automatically create a user account for anyone who purchases a virtual event ticket through Eventbrite. Their login will be the e-mail they provided to Eventbrite, and their password will be their ticket number.

  • If a Breakroom account already exists under a user's email address, Breakroom will reactivate that account and reset the password to the ticketholder's current ticket number.

  • Users will need to download the custom Breakroom desktop app or sign in through World Stream. Links to download the app or access your dedicated World Stream can be found on the Your Apps tab on the Dashboard.

World Stream keyboard shortcuts

Many actions in Breakroom are tied to easy keyboard shortcuts. Here's a cheat sheet for our World Stream service.

Overview

Since World Stream runs in your browser, keyboard shortcuts may differ compared to those used in the desktop Breakroom application. You can find specific keyboard shortcuts listed below.

Shortcuts

Windows Command

MacOS Command

Result

F1

F1

Calls up the help menu.

F12

F12

Calls up your own user profile.

Ctrl + Shift + F8

FN + Ctrl + Shift + F8

Ctrl + M

Ctrl + M

Toggles the Breakroom email window.

Ctrl + F

Ctrl + F

Toggles the People window.

Ctrl + E

Ctrl + E

Toggles the Explore window.

Ctrl + Q

Ctrl + Q

Toggles the Quest window.

Ctrl + I

Ctrl + I

Toggles the Inventory window.

Ctrl + O

Ctrl + O

Toggles the Outfit window.

Ctrl + S

Ctrl + S

Toggles the Shop.

Ctrl + H

Ctrl + H

Toggles the Rooms window.

Ctrl + `

Ctrl + `

Launches the Snapshot feature.

Ctrl + /

Ctrl + /

Calls up the Settings panel.

Ctrl + Shift + P

Ctrl + Shift + P

Calls up the bug report/feedback window.

World Stream viewer toolbars

Need to access stats for an online session, manage text input, or adjust your stream settings? Learn more about the World Stream toolbar.

Overview

World Stream features a specialized toolbar designed to help users address common streaming issues. This toolbar is located at the top of the browser window, and can be collapsed or expanded by hovering your cursor over it and clicking the arrow that appears.

On this page, we'll review the available functions and how to use them.

Copying and pasting

AWS runs Breakroom on a remote machine with its own clipboard, so copying and pasting text is a slightly more complex process. The World Stream toolbar gives you the ability to copy and paste text between the Breakroom stream and your own computer.

Copying text from World Stream

To copy text from a World Stream session to your local computer, follow these steps.

  1. Highlight the text you want to copy within your Breakroom World Stream Session, and press Ctrl + C on your keyboard.

  1. Click the Clipboard button in the World Stream toolbar. A pop-up window will appear containing your highlighted text.

  2. Highlight the text again, and press Ctrl + C a second time to copy the text to your local computer clipboard. You can then paste it wherever you like.

Pasting text into World Stream

To paste text into a Breakroom World Stream session, follow these steps.

  1. Highlight the text on your local computer and press Ctrl + C to copy it.

  2. Click the Clipboard button in the World Stream toolbar. A pop-up window will appear containing a text field. Press Ctrl + V to paste the text to the remote machine clipboard.

  3. Once the text is entered, you can press Ctrl + V to paste the text anywhere you like in-world, including in text chat fields.

Preferences

Clicking the Preferences button will reveal a panel containing several tabs. Many key stream settings are available here, including streaming mode and screen resolution, streaming metrics, and regional and keyboard settings.

General

As pictured above, the General settings panel allows you to customize:

  • Your streaming mode (responsiveness vs. image quality)

  • Your resolution

  • Your tab appearance

All of these settings will become active the moment you select them, and you can change your settings at any time.

Regional settings

Clicking on the Preferences > Regional settings tab allows you to customize your time zone and geographical location.

If you are using a Chinese, Japanese, or Korean keyboard, you can also specify your keyboard language in this panel. To do so, follow the steps below.

  1. Click the Preferences button, and then click the Regional settings tab.

  2. Using the Input method drop-down menu, select the keyboard language you would like to use.

  3. Click the Save button.

Performance

Clicking on the Preferences > Performance tab allows you to track streaming metrics in real time.

Function keys

Clicking the Fn Keys button in the World Stream toolbar will open a virtual on-screen keyboard that you can click with your mouse cursor or finger. This can assist with data entry or keyboard shortcuts.

Troubleshooting World Stream issues on Chrome

Encountering an issue with Breakroom's World Stream service? Learn how to troubleshoot common video and audio issues, as well as how to change the default device settings in Chrome.

Overview

In order to help troubleshoot audio and video connectivity issues, Breakroom provides users with a dedicated AV diagnostics panel. You can learn more about how to access this service on our general troubleshooting page, as well as how to change devices from within the World Stream platform itself.

However, some connectivity issues may require adjusting your browser settings. The instructions on this page are written specifically to assist users who may encounter issues while running World Stream on the Chrome browser.

Permission denied error / No device error

If you run a general AV troubleshooting test and the video or audio section reads "Permission Denied," and the video or audio device is listed as "No Device / Unauthorized," you may have accidentally blocked access to your camera and microphone, or your System Administrator may have blocked access within your browser.

To fix this problem, you may be able to manually grant permissions by following these steps.

  1. Click the vertical ellipses button in the upper right corner of your Chrome browser, and select Settings.

  2. Search for "site settings" using the search field, and click on the Site settings button.

  3. Click on the Breakroom.tech link to adjust settings for this site.

  4. In the Permissions panel that appears, use the drop-down menus to select "Allow" for the Camera and/or Microphone.

  5. Refresh your browser tab by pressing the F5 key or by clicking the browser refresh button.

If you are running Chrome on macOS, you may also need to grant media permissions on the OS level.

Unrecognized device errors

If you run a general AV troubleshooting test and the listed video or audio device is incorrect (meaning that the device selected is missing, or wrong), you may need to change the default devices that your browser is set up to recognize. This can be done from within the Breakroom platform, but you can also accomplish this through your browser.

To change the default devices in Chrome, follow these steps.

  1. Click the vertical ellipses button in the upper right corner of your Chrome browser, and select Settings.

  2. Search for "site settings" using the search field, and click on the Site settings button.

  3. Scroll down to the Permissions section. Click on either the Camera or Microphone settings, depending on what you would like to change.

  4. In the Permissions panel that appears, use the device selection drop-down menu located near the top to choose your preferred input device.

  5. After you've selected your new default devices, refresh the World Stream tab and your changes will take effect.

Important notes

Cross-platform voice capabilities

Voice capabilities are currently restricted by login method. This means that if one user is logged in via World Stream and another user is logged in via a Breakroom desktop viewer, they will not be able to hear each other over voice chat, even if they are standing in the same Region.

We apologize for the inconvenience, and hope to provide a solution soon.

Browser auto-play

Some browsers come equipped with "auto-play policies" that automatically block websites from playing audio and video until you interact with the content. In addition to granting media permissions to World Stream, you may also need to click on the page or otherwise interact with the streaming content in order to enable audio. You will need to repeat this action if you refresh the page.

Pre-allocation campaigns

If your World Stream event includes more than 50 people, you'll need to reserve virtual machines in advance. Learn more about pre-allocation campaigns, and how to submit your reservation.

Overview

Breakroom's World Stream service uses "virtual machines" to process and stream your content. The number of on-demand World Stream machines is limited to a maximum of 100 per World. This means that at any given time, you can host up to 100 concurrent World Stream users without any special accommodations.

For events where you anticipate hosting more than 100 concurrent World Stream users, you must request pre-allocation. This will reserve the number of virtual machines required for your special event, ensuring that everything goes off without a hitch.

Only World Owners and World Administrators can access the Dashboard.

Important notes

  • When pre-allocating virtual machines for your event, the baseline maximum of 100 users should not be taken into account while planning. Instead, please be careful to specify the exact number of users who will be attending your event. For example, if 101 people RSVP to your event, you would request pre-allocation for 101 users.

  • The maximum number of users World Stream can accommodate at this time is 1000. The system will not permit you to book an event for more than 1000 users.

  • Please note that each reservation must be made for a minimum of one hour.

  • When a live event consumes all pre-allocated World Credits due to longer than expected event duration or higher than expected user count, a notification will be sent to the World Owner and World Administrators. World Credits will then be automatically deducted from the account to cover login time, provided the Breakroom account has World Credits available.

  • Please keep in mind that World Stream use is calculated in 60-minute increments. If a user is logged in for 20 minutes, they will still consume one 60-minute block of World Stream time.

  • When making your reservation, please book for the maximum number of users for the longest duration required.

  • All reservations must be submitted a minimum of 48 hours prior to the event.

  • Please contact our Customer Success Team if you have any questions about requesting a reservation.

Pre-allocation campaigns require advance payment in the form of World Credits. The required amount of World Credits will be deducted from your account when you submit your pre-allocation campaign request. World Credits can be purchased during the pre-allocation process if needed.

Cancellation and refund policies

Whether a pre-allocation campaign can be cancelled or advance payment refunded depends on several factors, including when cancellation is requested and whether the submitted event has been approved by staff.

Time to event?
Event approved?
Can be cancelled?
Refund amount?

N/A

NO

YES

100%

>24 hours

YES

YES

80%

<24 hours*

YES

NO*

80%*

The automated pre-allocation system built into the Dashboard will not allow you to cancel less than 24 hours before your approved event start time. In these cases, we may be able to manually cancel your event. Please contact our Customer Success Team by submitting a support ticket through the Dashboard.

If we are unable to cancel your event prior to five minutes before start time, your advance payment will not be refundable. We apologize for the inconvenience.

Requesting pre-allocation

To submit a pre-allocation request, please follow the steps below.

  1. Navigate to your Dashboard.

  2. Click on the World Stream tab.

  3. Scroll down to the Pre-allocation panel and click the Book Pre-Allocation button. This will expand the panel.

  4. First, select your preferred World Stream server type by clicking the relevant Select button.

  5. Then, select either a One-time Reservation or a Recurring Reservation.

    1. For a one-time reservation, select your event date using the calendar.

    2. For a recurring reservation, select both your Start Date and End Date. Once you specify these dates, the weekday buttons will become active. Click on the days for which you are requesting pre-allocation. (E.g. Every Saturday over the specified time period.)

  6. After you have selected your event day(s), use the Start time and End time drop-down menus to specify the time duration for your event. (Note: Reservations must be a minimum of one hour in length.)

  7. Enter the number of users who will be attending your event in the Number of users field.

  8. Review the pricing breakdown. Remember: Pre-allocation campaigns require advance payment in the form of World Credits. The specified number of World Credits will be deducted from your balance after you confirm the booking.

  9. When you are satisfied with your choices, click the Request Pre-Allocation button.

After you submit your request, our Customer Success Team will review the details and get in touch to let you know whether your event has been approved or declined.

Purchasing and managing World Credits

Make sure everyone has access to your virtual space by managing your World Credits. Learn how to track minute usage, purchase additional World Credits, and limit user session time.

Overview

When users log in through your dedicated Breakroom desktop app, there are no additional access fees above the cost of their seat. World Stream access, on the other hand, must be purchased on a per user/per time basis using a digital currency known as World Credits.

World Owners and World Administrators can purchase, track, and manage World Credits using the Dashboard. Unused World Credits never expire, even if your Breakroom subscription lapses.

Only World Owners and World Administrators can access the Dashboard.

Purchasing World Credits

To purchase World Credits, follow these steps.

  1. Navigate to your Dashboard.

  2. Click the Add Credits button located in the site header.

  3. In the pop-up that appears, enter the number of World Credits you would like to purchase. Please note that World Credits must be purchased in increments of 1000 Credits.

  4. Click the Next button, and complete your payment information.

  5. When you are satisfied, click the Confirm button to finalize your purchase.

Tracking your World Credits

World Credit Balance widget

The World Credit Balance widget on the Dashboard landing page allows you to quickly check your World Credit balance and most recent account activity. If you need additional World Credits fast, the Add Credits link is also available.

World Credits tab

Alternatively, you can access a detailed breakdown of your World Credit purchases, refunds, and analytics by clicking the World Credits tab on your Dashboard.

In addition to information about your World Credit transactions, the World Credits tab contains a number of important tools. Here's a brief guide to key parts of the UI.

Button or link
Function

World Credit Balance panel

Displays your current World Credit balance, as well as your current-month purchases and expenditures.

Add Credits link / button

Allows you to purchase additional World Credits.

World Credit Analytics panel

Generates a quick World Credit purchase, expenditure, and availability breakdown based on your selected timeframe.

Transaction History panel

Provides a detailed, itemized list of your World Credit transactions and usage.

Transaction History search field

Allows you to search for a particular transaction.

Transaction History date pickers

Allows you to narrow the transaction history down to a specific date range.

Download CSV

Downloads a CSV file containing all transactions for the date period selected.

Generating World Credit transaction and usage reports

Transaction reports

You can download your World Credit transaction history at any time by following these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Credits tab.

  3. Scroll down to the Transaction History panel.

  4. Use the search field or the date pickers to filter the transactions list, if necessary.

  5. Click the Download CSV link located above the date pickers to download a spreadsheet containing your selected transaction data.

Usage reports

World Stream access and activity can also be tracked using the Transaction History panel on the World Credits tab.

  1. Navigate to your Dashboard.

  2. Click on the World Credits tab.

  3. Scroll down to the Transaction History panel.

  4. Enter the term "usage" into the search field, and press the Enter key on your keyboard. Usernames are identified in the Items column.

  5. Click the Download CSV link located above the date pickers to download a spreadsheet containing your selected transaction data.

If you're looking for more detailed information concerning user session times and Region access, we suggest generating an analytics report.

Managing World Credit usage

Partial hours and World Credit consumption

Due to the way AWS structures its billing, World Stream usage is currently calculated in hourly increments (i.e., multiples of 60 minutes). This hourly calculation policy also extends to pre-allocation campaigns and user session time limits.

This means that users cannot consume partial hours while logged in to World Stream. For example, if a user logs in for 20 minutes, the cost of one hour of access (60 minutes) will be deducted from the World Credits available on the account.

For this reason, Breakroom gives World Owners and World Administrators tools to limit World Stream user session times and World Credit consumption. World Owners can also place a cap on the number of World Credits that can be purchased each month by the administrative team.

Setting World Stream usage limits

To help you get the most out of your World Credits, there are three types of usage limits you can impose:

  1. Maximum session time per user, which sets a cap on how much time an individual user can spend in a single World Stream session.

  2. Monthly usage quota per user, which sets a cap on how much time an individual user can spend in World Stream per month.

  3. Monthly usage quota for World, which limits how many minutes all of your users can collectively spend in World Stream each month.

To enable any of these usage limits, follow the steps below.

  1. Navigate to your Dashboard.

  2. Click on the World Stream tab.

  3. Scroll down to the Manage World Stream Usage panel.

  4. Locate the usage cap you want to enable. Click the Edit button located to the right of the usage cap name.

  5. Enter your preferred number of minutes or click the Unlimited button.

  6. Click the Save button when you are finished.

Important notes about monthly usage quotas:

  • The Monthly usage quota per World cap does not discriminate between individual users. This means that a single user could potentially consume the entirety of your monthly usage quota.

  • The World Credit partial hours calculation policy also applies to monthly usage quotas. Users who log in for less than 60 minutes will still consume one 60-minute block of time from your monthly usage quota.

Choosing your World Stream server type

Another way that World Owners and World Administrators can manage costs is to select an appropriate World Stream server type. An updated list of server type features, prices, and regional availability can be found on the Dashboard, but in general, our Lite Servers offer acceptable performance for smaller events at a reduced cost.

To change your World Stream server type for all users, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Credits tab.

  3. Scroll to the Your World Stream server type panel.

  1. On the left side of the panel, you will see your current World Stream server type listed. To change it, click the "Change my World Stream server type" link located on the right side.

  2. A pop-up will appear. Click on the server type you prefer.

Setting World Credit purchase limits

To limit the amount of World Credits that can be purchased on your Breakroom account each month, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Credits tab.

  3. Scroll to the My Balance panel. You will see your current Monthly Purchase Limit listed there.

  4. To change the monthly limit, click the Pencil icon located to the right. A pop-up will appear. Enter the new purchase limit in the field, and click the Save button.

Desktop viewers

Breakroom's desktop application is a powerful tool for accessing your World. Use it for increased stability and performance while editing your Regions, or to conserve World Credits.

Overview

An important note concerning voice chat

Users who log in via the same method can communicate freely. Therefore, we strongly suggest that you take this into consideration when planning your events, and require all guests to use either World Stream or the desktop app.

We apologize for the inconvenience, and hope to provide a solution soon.

Downloading the application installers

After you finalize your subscription purchase, it will take 48 hours for Breakroom to generate app installers for your world. Once your installers are ready, they will be added to the Dashboard > Your Apps tab, where you can download one or both installers by clicking the Windows or macOS buttons. We also provide download links that you can distribute to your users.

Installing the desktop application

To install the desktop viewer, follow the steps below.

  1. Download the correct installer (Windows or macOS) for your computer.

  2. Locate the installer on your hard drive, and double-click on it.

  3. Follow the installer prompts.

Re-creating your installers

To update your desktop application installers, follow the steps below.

  1. Click on the Your Apps tab.

  2. Click the Re-create Installers button.

Troubleshooting World Stream issues on macOS

If you're running macOS, you may have to dig a little deeper to solve video and audio permissions issues. Learn more about granting and revoking media permissions for World Stream.

Overview

If you do not grant Breakroom permission to use the microphone and camera when initially asked, you will need to manually approve their usage by editing the Privacy & Security settings on macOS.

Allowing camera and microphone access

If you are running World Stream in Chrome on macOS, you will see four camera and microphone access dialog boxes appear the first time you log in. Two dialog boxes will ask you to confirm access for the Chrome browser, and two will ask you to confirm access for macOS.

To permit Breakroom to access your media devices, click the Allow button each time when prompted.

Correcting access errors

To grant Breakroom access to your microphone and camera on macOS, follow these steps.

  1. Click the System Settings icon in the Dock, or navigate to Apple menu > System Settings.

  2. Click on Privacy & Security, and then Camera and/or Microphone.

  3. You will see a list of installed applications. Toggle access on for Breakroom, Sinespace, or the custom name of the Breakroom World desktop app in question.

Revoking access

To revoke Breakroom's access to your camera and microphone on macOS, follow steps 1-3 above and toggle access off.

Sound input and output

MacOS gives you access to sound input and output volume controls. Making adjustments to your microphone and speaker volume can be very helpful when you run into audio issues in-world.

Input options

To locate the sound input options, follow these steps.

  1. Click the System Settings icon in the Dock, or navigate to Apple menu > System Settings.

  2. Click on Sound, and scroll down to the Output & Input section. Then click the Input tab.

The device identification window allows you to select your input device if you have multiple devices connected, or to identify your current device if you are uncertain which you may be using. The input volume slider allows you to control the volume of your input device. Lowering the volume on your microphone can assist with problems such as pitchiness or peaking, but may make it harder for others to hear you.

Output options

To locate the sound output options, follow these steps.

  1. Click the System Settings icon in the Dock, or navigate to Apple menu > System Settings.

  2. Click on Sound, and scroll down to the Output & Input section. Then click the Output tab.

The device identification window allows you to select your output device if you have multiple devices connected, or to identify your current device if you are uncertain which you may be using. The output volume control allows you to adjust your headphone volume independent of your speaker or master volume. You can also mute your headphones directly from this window.

Enables and drag mode when connected via AWS World Stream.

Breakroom provides desktop application installers for both Windows and macOS. When users log in through your dedicated Breakroom viewer, there are no additional access fees above the cost of their —which means that you won't need to dip into your pool of . However, users will need to install the Breakroom app on a computer equipped with that can effectively render 3D Worlds.

Voice capabilities are currently restricted by login method. This means that if one user is logged in via and another user is logged in via the desktop app, they will not be able to hear each other over voice chat, even if they are standing in the same Region.

You can find your custom application installers on the . Once you're logged in, click the Download App button in the tab header, or navigate to the Your Apps tab.

Breakroom's desktop viewer represents a major graphics and performance upgrade compared to . For best performance, you will need a PC or laptop that is capable of running 3D worlds. For maximum performance, we recommend using a machine with a dedicated graphics card. Please review our for more information.

If you decide to update any custom associated with your World, or if you your World as a whole, you will need to create and distribute fresh desktop app installers in order to push those changes to your users.

Navigate to your .

Please note that it may take Breakroom up to 48 hours to re-create your app installers. If you need your app installers sooner, please reach out to our .

Due to increased security restrictions on macOS, you will need to take extra steps to permit camera and microphone access when using World Stream. These permissions are necessary for the proper functioning of Breakroom's.

If you click the Don't Allow button for either camera or microphone access during initial setup and then want to correct this, you'll need toto access the device(s). You must then grant macOS the same permissions.

camera
object
seat
World Credits
hardware
World Stream
Dashboard
World Stream
system requirements
branding images
rename
Dashboard
Customer Success Team
conference system
grant Chrome permission

Understanding the conference system

Learn how Breakroom's conference system components work together—including voice zones, webcams, and more—and how you can customize them to suit your needs.

Overview

Breakroom's conference system is comprehensive, and consists of:

  • Voice chat

  • Webcam streaming

  • Screen sharing

  • Navigation tools

  • Moderation tools

  • Scheduling tools

  • Interactive emotes and gestures

  • A toolkit of media products

  • No-code gamification

In this section, we'll explore the conference system core in greater depth. You'll get to know the bones of the product, and learn more about how you can build Regions that truly serve your needs. Whether you want to add additional breakout areas to a Region, remove presenter seats from a stage, or integrate educational content into Breakroom, we'll walk you through every step.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

Analytics

Get key insights into how users are accessing your World, and pivot to meet their business and educational needs.

Overview

Breakroom provides basic analytics reports in the form of an auto-generated CSV file, which World Owners and World Administrators can download from the Dashboard or email to themselves.

Only World Owners and World Administrators can access the Dashboard.

Interpreting basic analytics report data

User visits are represented by rows, while key information is listed in each column.

Column
Contents

Grid

This number corresponds to the grid, or World, the user accessed.

UserID

The ID of the user who visited your World.

Username

The user's name.

Region

The Region ID the user visited.

RegionName

The name of the Region the user visited.

LoginTime

When the user logged in.

LogoutTime

When the user logged out.

SpendTime

How long the user spent in a particular Region.

LoginFrom

Session

The user's session ID.

Email

The email associated with the user's account.

Users may decline to share certain data by personalizing the Analytics and Marketing Preferences available under the Settings panel. If users decline to share their data, you may see this data (such as usernames, user IDs, and email addresses) replaced by asterisks in your analytics report.

Accessing basic analytics reports

To generate and download a basic analytics report, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the Analytics tab.

  3. Use the calendars to select a start date and an end date for your report.

  4. Click the Generate Analysis Report button.

  1. A pop-up will appear confirming that your report has been created. Click the Email Report button to send a copy of the report file to your email address. Click the Download Report button to immediately download the report file to your computer.

Privacy Policies, EULAs, and data collection

Consent is key. Learn how to use Breakroom's powerful tools to create custom EULAs, publicize your Privacy Policy, and comply with privacy and data retention legislation.

Overview

While few resources are more valuable, there are legal and ethical issues to consider when it comes to collecting and retaining user data. Breakroom offers a suite of tools designed to help World Owners and World Administrators implement their existing Data Collection Policies, as well as comply with legislation such as the General Data Protection Regulation (GDPR) and California Consumer Privacy Act (CCPA). Users can also customize their data profile within these specified parameters.

Only World Owners and World Administrators can access the Dashboard.

Adding a custom Privacy Policy

If you plan to collect and retain user analytics, a custom Privacy Policy is strongly encouraged. Users will be presented with your organization's Privacy Policy the first time they access Breakroom, and will be required to accept the terms before they can log in.

To add a custom Privacy Policy to your World, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab.

  3. Scroll to the World Privacy Notice panel, and paste your Privacy Policy text into the field.

  4. Toggle the World Privacy Notice on.

  5. When you are satisfied, click the Save Changes button.

To disable your custom Privacy Policy, follow steps 1-3 above and toggle the World Privacy Notice off.

Adding a custom EULA

If you are running an event that requires an additional End-User License Agreement (EULA), Breakroom makes it easy to seamlessly integrate review and acceptance of this document into the user login experience. Your EULA will appear after the Breakroom TOS, and users will need to accept both in order to access your World.

To add a custom EULA to your World, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab.

  3. Scroll to the Your World's EULA panel, and paste your EULA text into the field.

  4. Toggle the Your World's EULA on.

  5. When you are satisfied, click the Save Changes button.

To disable your custom EULA, follow steps 1-3 above and toggle the Your World's EULA off.

Managing end user data collection

World Owners and World Administrators can make the collection of user analytics, diagnostic data, and marketing data optional. By making the collection of such data optional, you give users the ability to opt in or opt out of data collection at any time.

In certain circumstances, you may have a legitimate interest in tracking platform usage. In these cases, you may elect to make data collection mandatory. Please be aware that you have full liability for any misuse of this functionality, and it is strongly recommended that you consult a legal or privacy professional prior to doing so.

For the proper functioning of the platform and security purposes, Breakroom must collect essential data. Essential data are generated primarily in response to actions performed by users, which amount to requests for services. This includes such actions as setting privacy preferences, logging in, and managing content.

Turning data collection on or off

To toggle data collection on or off as a whole, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab.

  3. Scroll to the Analytics User Consent Management panel.

  4. Choose either to Collect Data or Do Not Collect Data.

  5. When you are satisfied, click the Save Changes button.

Customizing the user consent pop-up

If you opt to turn on data collection, you can review the different types of data collected and make the collection of each type Optional or Mandatory using the In-World User Consent Popup panel. Any data collection type marked as Optional can be accepted or rejected by users at any time through the in-world Settings panel.

To customize your data collection policies and user consent pop-up, follow these steps.

  1. Navigate to your Dashboard.

  2. Click on the World Customization > Basic Information tab.

  3. Scroll to the In-World User Consent Popup panel.

  4. Review the different data types, and toggle each one to be Optional or Mandatory.

  5. Using the consent toggle in the upper right corner, confirm whether you want to display the consent pop-up to your end users.

  6. When you are satisfied, click the Save Changes button.

Toggling World availability

Need to restrict access to users with advanced permissions, or want to automatically throw open the doors on a particular date? Breakroom makes it easy to secure the borders of your virtual kingdom.

Overview

When your world status is set to Off, only World Owners, World Administrators, World Moderators, and World Developers will be able to log in. Members and Guests will no longer have access.

Taking your World offline

To take your World offline, follow these steps.

  1. Click on the Settings tab.

  2. Toggle the World switch to Off, and the Take World Offline window will open. In this window you can:

    1. Select a World Online date and time (required): This is the time that your Breakroom World will once again become accessible. This time will be displayed to users who try to log in while your World is offline.

    2. Enter a World Offline Notice (optional): In addition to your chosen go-live time, this notice will be displayed to users who try to access your World while it is offline.

    3. Enter a User Ejection Notice (optional): This notice will be displayed to online users before they are ejected from your World.

    4. Select any User Types to Be Ejected (optional): All online users of the selected types will be forcibly logged out once your World goes offline.

  3. Once you're satisfied, click the Take World Offline button. You will be asked to confirm your choice.

Bringing your World online

To bring your World back online before your specified go-live time, follow these steps.

  1. Click on the Settings tab.

  2. Toggle the World switch to On, and confirm your choice by clicking the Bring World Online button.

Voice chat and spatial audio

Empower your users to speak their minds. Read on for more information about Breakroom's spatial audio feature, as well as step-by-step instructions for disabling voice chat.

Overview

Disabling voice chat

There may be occasions where you want to disable voice chat on a Region-wide basis, or disable voice chat in an individual breakout area or voice zone.

Disabling voice chat for an entire Region

To disable voice chat entirely for a Region, follow these steps.

  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. Scroll down to the section titled VOIP. Check the box next to the "VOIP is disabled in this Region" option.

  5. Scroll down and click the Save button.

To restore voice chat to a muted Region, repeat the steps above and check the box next to the "VOIP is enabled for everyone by default" option.

Muting voice chat through the Region Information window will not remove the Microphone button from the conference system. However, the button will no longer work if clicked.

Disabling voice chat for a single voice zone

To disable all media sharing options in a voice zone (including voice chat, webcam, and screen sharing), follow the steps below.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, locate the Breakroom Breakout Area or Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  4. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  5. In the Zone Type field, enter the word "silent."

  6. Click the Reset Zones button to reset the conferencing system.

  7. Click the Save button to store your changes.

After you have closed the Region Editor, leave the voice zone and then return to it. You will see that most of the media buttons are gone, and that the Microphone button is grayed out to indicate that it is inaccessible.

Spatial audio

Voice zones, zone types, and conference permissions

Understanding the relationship between voice zones, zone types, and conference system permissions is critical for customizing your Breakroom workspace.

Overview

Collaboration is the soul of Breakroom—and that collaboration happens inside different types of voice zones. Voice zones are virtual objects that encompass the areas where audio and video sharing will take place. These objects are normally invisible to you and your users.

This page will serve as a brief introduction to the different voice zone types and how they can be used. It is strongly recommended that you read and understand this information prior to customizing your first Breakroom Region.

Voice zone types

Currently, Breakroom offers five different voice zone types.

Voice chat: Available to all users.

Voice chat, webcam and screen share: Available to all users. Everyone can chat and share media.

Voice chat: Available to all users.

Webcam and screen share: Disabled. No one can share media.

Voice chat, webcam and screen share: Disabled. No one can voice chat or share media.

Voice is the standard setting for the Global voice zone, which is an invisible voice zone that encompasses the whole of your Region. It may help to visualize this voice zone as the general environment of your Region, or as "anywhere another, specific voice zone is not." This topic will be explained in more detail below. Voice zones can also be nested within one another.

The media streaming system cannot accommodate more than 17 simultaneous webcam or screen share users at this time.

Voice zones in action

The image above is a flyover shot of the Breakroom Campus Large Region. You can see that it consists of several lobbies, meeting rooms, and an amphitheater, as well as trees and gardens. Everything you see here is contained inside the Global voice zone.

Here's a top-down view of the same Region. Each of the highlighted areas above is a separate voice zone. Depending on each zone's type, these spaces offer different communication options.

  • The circular amphitheater is a Presenter zone. Someone can give a video presentation here, and audience members will not be able to interrupt by sharing their own video streams. In order to present, users will have to sit on a presenter seat (normally located at the front of the auditorium). The audience can interact via voice chat to ask questions or participate in activities.

  • The red, yellow, blue, and green offices are Meeting zones. Everyone can share video and speak on voice chat, just as they might expect to do in a physical conference room.

  • Everywhere else falls within the Global voice zone, which is a Voice zone. This means that users can voice chat with one another as they move between the offices, but they cannot share their webcams or screens.

Only users with avatars currently located inside a particular voice zone can hear, share, and communicate with other users in that zone. This design makes it possible for different meetings or events to be held concurrently in the same Region without technical interference or audio competition. Likewise, when you are inside an isolated voice zone (such as an office), you will no longer hear voice chat taking place in the Global voice zone.

When you approach the edge of a voice zone, a transparent blue boundary indicator will appear. This serves as a reminder that you are about to enter or leave a voice zone, or that you need to enter a voice zone in order to speak with users located on the other side.

Conference permissions

Adding breakout areas

Breakroom's prefab breakout areas make event setup easy. Learn how to add extra breakout spaces to your Region, enable and manage key conference features, and customize the built-in cameras.

Overview

Locating the breakout area objects

Adding breakout areas using the Region Editor

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Reset Zones button to reset the conferencing system.

  4. When you are satisfied, click the Save button to store your changes. Click the Close button to exit the Region Editor.

Understanding breakout area Display Names

Editing breakout area details

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, locate the Breakroom Breakout Area object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  4. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

For the purposes of quick Region setup, this page will focus on the following properties:

  • Zone ID: The ID number of the audio zone associated with the breakout area

  • Zone Name: The name/room number associated with the audio zone

  • Zone Color: The color of the breakout area and its corresponding teleport button

There are certain situations where you may want to manually change the values in these property fields.

Zone ID

If two breakout areas or voice zones are assigned the same Zone ID, users in those areas will be considered to be within the same audio zone, even if they are separated by the entire length of a Region. Such a setup may result in cross-talk and general confusion.

If you encounter a situation like this and want to resolve it, or if you want to renumber your breakout areas and voice zones for more efficient Region management, you can do so by following these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Locate the Breakroom Breakout Area object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  4. Expand the RoomFurniture component in the Inspector window by clicking the > icon located to the left.

  5. Locate the Zone ID property. In the associated field, enter the ID number you wish to use for that breakout area.

  6. Click the Reset Zones button to reset the conference system.

  7. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Name

Each breakout area has a Zone Name in the format of "Breakout N," where N is a unique number. This name relays several important pieces of information to the Breakroom conference system. Most importantly, it indicates:

  • How many breakout areas there are, and which number identifies this particular breakout area

You can edit the Zone Name by following the steps below.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Locate the Breakroom Breakout Area object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  4. Expand the RoomFurniture component in the Inspector window by clicking the > icon located to the left.

  5. Locate the Zone Name property. In the associated field, enter a new name for the breakout area. This name must be input as "Breakout N," where N is the new number.

  6. Click the Reset Zones button to reset the conference system.

  7. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Color

If you want to change a breakout area's color, you can do so by following these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Locate the Breakroom Breakout Area object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  4. Expand the RoomFurniture component in the Inspector window by clicking the > icon located to the left.

  5. Locate the Zone Color property. In the associated field, enter any of the following colors:

    1. Blue

    2. Orange

    3. White

    4. Grey

    5. Magenta

    6. Teal

    7. Black

    8. Cyan

    9. Red

    10. Purple

    11. Pink

    12. Green

    13. Yellow

  6. Click the Reset Zones button to reset the conferencing system.

  7. Click the Save button to store your changes.

Editing breakout area cameras

The Behind Camera and Forward Camera are fixed relative to the user. However, the angle and location of the Speaker Camera, Screen Camera, or Audience Camera can be customized to support your individual needs.

If you want to change the angle of any of these cameras, you can do so by following the instructions below.

Note: In this section, we will refer to the built-in camera that you want to move as the static camera, and your own user camera as the working camera.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Locate the Breakroom Breakout Area object you want to edit in the Objects window. Click the > icon to the left of the object name to expand it.

  4. Locate the Breakroom Voice Zone object, and click the > icon to the left of the object name to expand it.

  5. Locate the Cameras object, and click the > icon to the left of the object name to expand it.

  6. Leaving the static camera object selected, move your working camera into position. This angle and position will replace the current angle of the selected static camera.

  1. Click the "Move Object to Camera" button located in the bottom toolbar. The static camera will snap into its new position.

  2. Click the Reset Zones button to reset the conference system, and click the Save button to store your changes.

  3. Click the Close button to exit the Region Editor. To make sure your UI is refreshed, exit the breakout area or voice zone. When you return to that zone, your new camera angle will now be accessible.

Creating custom voice zones

Adding custom voice zones to your Region is a useful way to control audio "traffic" and combat cross-talk while giving users the ability to make spontaneous connections.

Overview

Introduction to the voice zone objects

In the Region Editor, there are two specialized tools you'll use while editing voice zones. Clicking the Reset Zones button will refresh all of the voice zones within the Region, pushing forward any changes you've made. Clicking the Visibility button will toggle the transparent green boundary object highlighting on and off, which is useful when you need to maneuver your working camera inside a voice zone.

Voice zone shapes

Breakroom Voice Zone

Breakroom Voice Zone Round

Here we've set out the Breakroom Voice Zone Round object, which is shaped like a sphere. Again, the transparent green walls indicate its size and boundaries, and it contains additional components.

Voice zone components

In order to fully customize a Breakroom Voice Zone object, you will need to edit its individual components. After you have added a Breakroom Voice Zone object to your Region, follow the steps below to locate these components.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. In the Objects window, locate the Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for "voice zone" if you like.)

  3. Click the > icon located to the left of the object name to expand it. If necessary, you can expand some individual components by clicking the relevant > icons.

In the illustrated tutorial below, we will discuss how these components work together to create a cohesive voice zone and how you can edit them to achieve the level of function you desire. Before we leap into our tutorial example, however, let's start with a brief overview of each voice zone component.


  1. The screen: The screen component indicates where the video feed will appear when users opt to share their webcams or screens, as well as the size and location of the screen. Like the zone collider, the screen component can be edited independently of the other voice zone objects.

  1. The landing pad: This object indicates where avatars will "land" when they teleport directly into the voice zone. It can be edited independently of the other voice zone components, allowing you to place it wherever you like.

Voice zone furniture items

Setting up a voice zone

The following tutorial offers step-by-step instructions for setting up a custom voice zone in your Region. For this example, we will be using a Breakroom Voice Zone round object and a set of Breakroom Add-on Stools to create a networking area where users can "grab a cup of coffee" and chat.

Editing voice zone furniture items

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. We want our voice zone to contain seating, so as a first step we will set out a conference-ready furniture item and edit it. For this tutorial, we will use the Breakroom Add-on Stools object. To find it, use the search field at the top of the Inventory window to look for "stools."

Here we encounter our first challenge. There are too many stools in this seating arrangement, and every user who sits down will be facing the same direction. For our next step, we will remove all but six stools from the Breakroom Add-on Stools object, leaving three matched pairs.

  1. In the Objects window, click the > icon located beside the Breakroom Add-on Stools object to expand it.

  2. Click the > icon located beside the Seating Arrangements Stools object to expand it.

  3. Here you will find the individual stools that make up the linked stools object. To make a stool invisible, click the eye icon located to the right of its name. Click the Save button.

In the image above, you can see that we have reduced 14 stools to six. However, there's still a major issue.

All six stools are still facing the same way. We need to rotate three of the stools 180° so that two users sitting at the same table will face each other.

  1. Locate the first stool you want to edit under Breakroom Add-on Stools > Seating Arrangements Stools in the Objects window. Click on the stool name to launch the Inspector window for that object.

  2. In the Inspector window, locate the Transform component. Click the > icon located to the left to expand it.

  3. You will see three properties listed under the Transform component, each with three associated fields. Locate the Local Euler Angles property, and enter "180" into the Y-axis field.

  4. Repeat this set of tasks for every stool you want to "turn around." When you are done, click the Save button.

The stools now face each other, so let's place them into position and dress the scene a little.

  1. When you are done, click the Save button.

Success! We've created a lovely networking area overlooking the water. Now, let's make it a voice zone.

Editing voice zone objects

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. The Breakroom Voice Zone Round object will default to its standard size. In the example image above, you can see that there are several issues:

    1. The zone collider is too large.

    2. The screen is placed in an inconvenient location.

    3. The landing pad is right on top of the seating area.

  1. Next, we will reposition the landing pad. In the Objects window, click the > icon to the left of the Breakroom Voice Zone Round object name to expand it. Then click on the Landing component to highlight it.

  2. Using the Region Editor tools, move, rotate, and resize the landing pad to meet your specifications.

  1. Finally, we'll customize the size of the voice zone boundary object itself. In the Objects window, click the > arrow to the left of the Breakroom Voice Zone Round object name to expand it. Then click on the ZoneCollider component to highlight it.

  2. Using the Region Editor tools, move, rotate, and resize the zone collider to meet your specifications.

  3. Click the Reset Zones button to reset the conference system.

  4. When you are satisfied, click the Save button to store your changes.

Special instructions for screens

After resizing the voice zone collider, you may find that the default screen size is too large or small for your intended purpose. By editing the ScriptingData component attached to the screen object, you can customize how the screen appears.

To locate the ScriptingData component and edit it, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects button to launch the Objects window. Locate the Breakroom Voice Zone object, and click the > icon to the left of the object name to expand it. Then click on the Screen component to highlight it.

  4. In the Inspector window that opens, click on the > icon to the left of the ScriptingData component to expand it. You will see three properties, each with an associated field.

  5. If you want to change the aspect ratio of the screen, you can enter independent values into the Width and Height fields. For instance, you may wish to create a narrow, long screen to accommodate the webcams of several different speakers.

  6. If you want to change the size of the screen while preserving the current aspect ratio, you can enter a value in the Scale field, which is normally set at 1. Because this is a multiplier field, you can enter 0.5 to reduce the screen size by half, 2 to double the screen size, etc.

  7. Click the Reset Zones button to reset the conferencing system.

  8. When you are satisfied, click the Save button to store your changes.

For this tutorial, we entered a .75 value into the Scale field. This made the screen smaller overall, while preserving the default aspect ratio. Once we save our work and take a look at the voice zone, you can see that the screen appears at a much more manageable size.

Special instructions for cameras

Special instructions for landing pads

When installing a Breakroom Voice Zone object, you can choose between default landing and clustered landing effects for users who teleport straight into the voice zone. You can also randomize the direction your users will face upon arrival.

Default landing

The default landing pattern is automatically enabled upon voice zone installation. Under the default landing pattern, users will arrive at random points within the boundary designated by the landing pad object.

To avoid a teleportation bottleneck, make your landing pad object as large as possible.

Clustered landing

By enabling the clustered landing option, you can arrange for users to arrive in groups within the zone designated by the landing pad object. This can help foster an atmosphere of socialization and camaraderie.

To enable and manage clustered landing, follow the steps below.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects button to launch the Objects window. Locate the Breakroom Voice Zone object you want to edit, and click the > icon to the left of the object name to expand it. Then click on the Landing component to highlight it.

  4. In the Inspector window that opens, click on the > icon to the left of both the Transform and ScriptingData components to expand them.

At this point, it is useful to explain what a few of these component properties do, as well as some of the math involved in creating clustered landing areas. The key properties to consider are:

  • Transform component > Local Scale. This property controls the size of the landing pad object. In the example image above, you can see that the object is 6x1x12 meters, or 6x12 along the axes that "count."

  • ScriptingData component > Cluster Size. This property controls the size of the clustered landing areas within the landing pad object.

  • ScriptingData component > Random Orientation. This property controls whether users will arrive in a group facing each other (i.e. oriented toward the center of the cluster), or facing in random directions.

The most important property to consider is the Cluster Size. This value must be entered as a number. If you enter the numeral N, we might summarize the instructions relayed to the system as "create as many clustered landing areas of NxN meters as will fit within the scale values of the landing pad object."

In the example image above, you can see that the landing pad object is 6x12 meters in size. Under the ScriptingData component, you can see that the Cluster Size property has been set to 6. This will result in the creation of two 6x6 meter clustered landing areas within the boundary designated by the landing pad object.

With this explained, let's return to the instructions.

  1. Under the ScriptingData component, enable or customize the following properties:

    1. Random Orientation:

      1. If you want users to arrive in a cluster facing each other, enter no into the field.

      2. If you want users to arrive in a cluster facing in random directions, enter yes.

    2. Clustered Landing: Enter yes into the field.

    3. Cluster Size: Enter the size of your clustered landing points into the field (e.g. 3 to create 3x3 clustered landing points).

  2. Click the Reset Zones button to reset the conferencing system.

  3. When you are satisfied, click the Save button to store your changes.

Random Orientation

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects button to launch the Objects window. Locate the Breakroom Voice Zone object you want to edit, and click the > icon to the left of the object name to expand it. Then click on the Landing component to highlight it.

  4. In the Inspector window that opens, click on the > icon to the left of the ScriptingData component to expand it.

  5. In the Random Orientation field, enter yes.

  6. Click the Reset Zones button to reset the conferencing system.

  7. When you are satisfied, click the Save button to store your changes.

To return a landing pad to standard orientation, repeat steps 1-4 above and enter no into the Random Orientation field. Click the Reset Zones button, followed by the Save button.

Assigning a Zone ID

In order to identify your custom voice zone as a standalone media point, your custom voice zone needs a unique Zone ID. This number should be automatically assigned when you place the voice zone object down. To change a voice zone's Zone ID, follow these steps.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Voice Zone object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  3. Expand the RoomFurniture component in the Inspector window by clicking the > icon located to the left.

  4. Locate the Zone ID property. In the associated field, enter a new ID number for the voice zone.

  5. Click the Reset Zones button to reset the conferencing system.

  6. Click the Save button to store your changes.

Assigning a Zone Name

It is best practice to assign your custom voice zone a unique Zone Name. To do so, follow these steps.

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Voice Zone object you want to edit in the Objects window, and click on it. This will open the Inspector window for that object.

  3. Expand the RoomFurniture component in the Inspector window by clicking the > icon located to the left.

  4. Click the Reset Zones button to reset the conferencing system.

  5. Click the Save button to store your changes.

Adding voice zones to navigation tools

Zones already linked in the General Navigation or Breakout Rooms panel will be ignored by the Areas of Interest panel. This makes it a flexible solution for offering additional teleport options to your users.

Enabling auto-sit on teleport

If you set up your custom voice zone using furniture designed to work with the Breakroom conference system, you can enable the auto-sit feature. This means that when users teleport into the voice zone, they will be automatically seated in an available chair.

To enable the auto-sit feature, please follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Inspector window, click on the > icon to the left of the RoomFurniture component to expand it.

  4. You will see a single property titled Zone Name. In this field, enter the same exact Zone Name you used for the associated Breakroom Voice Zone object. (For example, if your voice zone is named "Coffee Bar," then the Zone Name for the stools should also be "Coffee Bar.")

  5. Click the Reset Zones button to reset the conferencing system.

  6. Click the Save button to store your changes.

The RoomFurniture component

The RoomFurniture component attached to the Breakroom Voice Zone objects contains several fields that can be manually edited. By doing so, you can:

  • Change the voice zone type

  • Disable or enable voice and text chat

  • Adjust the voice zone's spatial settings

  • Edit voice zone priority and "nest" voice zones

  • Enable or disable audience cameras, and more

Whether the user logged in from a or via .

Breakroom's World Status toggle allows you to restrict access to your World with the flip of a switch. When your World status is set to Off, only users with will be able to log in. You can also schedule a day and time when your world will automatically become accessible to a larger audience, and post a customized message to keep everyone in the loop.

Only and can access the Dashboard.

Navigate to your .

Once your World is offline, the Settings tab will change to display your chosen go-live time and offline message. You can change these at any time by clicking the relevant Edit links. A link is also provided so that you can change your World's to a temporary placeholder, as this can assist with messaging.

Navigate to your .

is a key conference system function—but at Breakroom, we empower you to build your World, your way. On this page we'll review instructions for disabling voice chat when needed, as well as discuss the spatial audio feature and how it works.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

Click the Objects Button to launch the .

If you prefer, you can turn voice chat off while leaving other media sharing options available by editing the located under the . However, if you have nested voice zones, users may still be able to hear and participate in voice chat from surrounding voice zones (including the Global voice zone).

have spatial audio set up by default. This means that a crowded virtual event will sound much like a similar event in "real life"—you'll be able to easily hear the people standing right next to you, while you may not be able to hear someone standing on the other side of the room. In a virtual world like Breakroom, this can initially confuse some users.

If you're having trouble hearing someone in voice chat even though you can see their avatar, make sure that you're both standing in the same . (If someone is standing in an auditorium voice zone, for example, and someone else is standing just outside of it, they will not be able to hear each other.) If you're both in the same voice zone, try moving closer together.

If you're still having trouble using voice chat, please consult our . If you want to edit the spatial distance for a specific breakout area or voice zone object, or turn off spatial audio altogether, please consult our documentation.

Each behaves differently, giving you the ability to structure online work, conferences, and presentations in a number of ways. By adding , creating , and editing the attached to Breakout Area and Voice Zone objects, you can streamline communication and remove potential pain points.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

Webcam and screen share: Restricted to only those users in the designated . Moderators can choose to permissions for the audience if they wish.

Voice chat, webcam and screen share: Restricted to only those users in the designated . Moderators can choose to permissions for the audience if they wish.

Voice zone type information is stored in the , under the voice zone object's .

To visually illustrate how multiple voice zones could be set up in a Region, let's take a closer look at one of the Breakroom .

Among the voice zone types, Presenter and Audience zones are unique, as both make use of special presenter seats. By positioning their avatars in these seats, presenters can gain access to voice chat and media sharing functions within a particular voice zone, even if these functions are otherwise restricted. Users with access to the can also grant access to voice chat or media sharing functions as needed.

For help , as well as detailed information on using the moderator tools to , please see our .

Breakroom's prefab come with voice zones and conference tools pre-installed. Each breakout area object you install in your Region will automatically receive its own custom , , and a unique that will be added to the . These options can all be changed to suit the needs of your event.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

After using the to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

A selection of prefab breakout rooms, booths, offices, and workshops can be found in the . Detailed descriptions of each breakout area object are also .

You can add any of the to your Region using the . The quick-start instructions below are provided for your convenience.

Click the Inventory Button to launch your .

Locate the Breakroom Breakout Area object you want to use. Add it to your Region using your .

The breakout area will automatically receive its own Zone ID, Zone Color, and a unique Zone Name. If you want to edit any of these properties, please refer to the that follows.

Using the Region Editor tools, the breakout area to meet your specifications.

If you add multiple copies of any object to your Region, you will notice that every copy is identified by the same name in the . The same is true of breakout area and voice zone objects. However, to facilitate Region setup and management, these objects will acquire two additional information tags after installation:

: This number will be displayed using [brackets]

: This information will be displayed in (parenthesis)

These information tags can help you identify your breakout areas and resolve .

Breakout areas are designed to automatically set themselves up. However, you may run into situations where you need to change some breakout area details. To do this, you will need to locate and edit the object's .

Click the Objects Button to launch the .

The RoomFurniture component properties are covered in more detail in our . There you can learn how to enable or disable chat in voice zones, adjust the screen aspect ratio and size, change a breakout area's zone type, and other advanced tricks.

Make sure theis open by clicking the Objects button located on the bottom right.

If you need additional help resolving duplicate zone errors in your Region, please visit our dedicated .

That the breakout area should be included in the

There may come times when you need to edit the teleport button lineup—for instance, if the first breakout area you set down (which automatically became "Breakout 1" and was assigned to the "1" button) has been moved to a far-off area, and you'd rather make it "Breakout 5." Alternatively, you may wish to create a and add it to the Breakout Rooms panel.

Make sure theis open by clicking the Objects button located on the bottom right.

When you add a new prefab breakout area to your Region, it will automatically assign itself a unique Zone Color. This color will be applied to the actual breakout area object, and will also be used as the teleport button background color in the .

Make sure the is open by clicking the Objects button located on the bottom right.

If you want to change the hexadecimal code associated with any of these color keywords, you can find instructions by reviewing our .

All of Breakroom's voice zones, including those built into the prefab breakout areas, come equipped with cameras. These cameras integrate with the conference system , allowing users to switch between a variety of camera angles while seated.

In the image above, you can see the location of these cameras highlighted in the . There are three cameras, each represented by a 3D camera icon bounded by a translucent box. The box color corresponds to the camera type, and these colors are consistent between all voice zones and breakout areas.

Box Color
Camera Name
Camera Focus

Make sure the is open by clicking the Objects button located on the bottom right.

Click on the static camera you want to move (either the Screen Camera, Audience Camera, or Speaker Camera). This static camera will be highlighted on your screen, and the will center on it.

give users the ability to connect through voice chat, webcam streaming, and screen sharing. Breakroom allows you to nest voice zones within one another, opening up a world of Region design possibilities. Through the use of customized voice zones, you can create a virtual space full of offices, cozy coffee corners, and bustling auditoriums—all in the same Region, with no audio cross-chatter or audio interference.

Elsewhere, we covered how you can included in the . In this section, we'll explore how you can set up custom voice zones.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

After using the to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

Voice zones take the form of boundary objects that encompass the virtual areas where audio and video sharing will take place. These boundary objects are normally invisible to you and your users. There are different , each designed to offer a unique media experience.

When you launch the in an area that contains breakout areas or other voice zones, you'll see these boundary objects highlighted in transparent green, as in the image above.

In addition to the prefab breakout areas included in the , you will receive two customizable voice zones with no additional building or seat components attached to them. These items are called Breakroom Voice Zone and Breakroom Voice Zone Round. You can find them in the Furniture > Collaboration section of your .

Here in the , you can see that we've set out a copy of the Breakroom Voice Zone object. This voice zone is shaped like a cube, and the transparent green walls indicate its size and boundaries. It contains other components, such as a screen, cameras, and a landing pad.

Click the Objects Button to launch the .

The ZoneCollider component: The zone collider represents the size and boundaries of the voice zone itself. Its can be edited independently of the other components that make up the voice zone object.

The cameras: Colored boxes indicate the default locations for the screen, audience, and speaker cameras. This information is critical for the correct functioning of the conference system , and the of each camera can be customized.

In order to take full advantage of the tools built into Breakroom's conference system, you will need to use furniture items that are designed to work with voice zones. There are several sets of included in the Breakroom Toolkit.

Voice zones do not need to contain seating or other furniture in order to function, and if you do not include seating in a custom voice zone, users will still be able to voice chat, turn on their webcams, and share their screens. However, seats let users access additional tools like and .

This section is written for administrative clients who are already familiar with customizing the Breakroom platform. If you need help accessing the , or editing the , please consult the linked documentation before proceeding.

Click the Inventory Button to launch your .

When you locate the Breakroom Add-on Stools object, set it down in your Region using your . Click the Save button.

For the sake of convenience, we will move all six stools as a whole. Click on the Breakroom Add-on Stools object in the Objects window, and then use the and to position it in your Region.

Our networking area needs some tables and accessories. Click the Inventory button to open your Inventory window. When you find an item you like, feel free to add it to your scene. Use the movement, rotation and to edit each item as you see fit. (Remember: You can use the to purchase additional furniture and decor items.)

In order to accommodate users at different points in their Breakroom tech journey, we will begin this part of the tutorial fresh. If you are interested in learning more about conference-ready voice zone furniture items, please review the . If you need a refresher on the different voice zone object components, you can find that information at the of this page.

Click the Inventory Button to launch your .

Locate the Breakroom Voice Zone object you want to use. (For this tutorial, we are using the Breakroom Voice Zone Round object.) Add it to your Region using your .

To begin tackling these issues, select the top-level Breakroom Voice Zone Round object in the Objects window. Then, using the Region Editor tools, and the entire voice zone until the screen component appears where you want it to be. By moving the entire voice zone as a linked set, you will preserve the existing camera angles.

The size of the landing pad indicates the area into which your users will teleport. You can make the landing pad bigger or smaller by highlighting it in the Objects window and then changing the local scale values listed under its , or by using the in the Region Editor.

If you create a custom voice zone that contains designed to work with Breakroom's , you may find that you want to change the camera focus points. (For example, if you move the screen out of range of the Screen Camera.) You can edit the voice zone cameras by using the "Move Object to Camera" button in the Region Editor. Detailed instructions are in our .

ScriptingData component > Clustered Landing. This property controls whether clustered landing is enabled or disabled. If clustered landing is turned off, users will arrive in the /randomized landing style.

Make sure the landing pad object is the size you need by changing the listed under its Transform component, or by using the in the Region Editor.

Whether you choose to implement or for your teleport points, you can randomize the direction that your users will face when they arrive. To do so, follow these steps.

Make sure the is open by clicking the Objects button located on the bottom right.

If you need help resolving duplicate zone errors, please visit our dedicated .

Make sure the is open by clicking the Objects button located on the bottom right.

Locate the Zone Name property. In the associated field, enter a new name for the voice zone. (Tip: If you want to add the voice zone to the , you can input the name as "Breakout N," where N is a unique number.)

If you need help resolving duplicate zone errors, please visit our dedicated .

When you add a custom voice zone to your Region, you may see it appear in the Areas of Interest panel. This panel is visible on the right side of the screen when activated, and can be set up to offer direct teleport links to any voice zone that has the "Zone Visible" option enabled in its .

You can within the Areas of Interest panel. If you disable all of your custom voice zones from appearing within the Areas of Interest panel, the panel will not be displayed on your screen. You can also add a custom voice zone to the .

Click the Objects button to launch the . Locate the furniture item you want to edit. Click on the object name to launch the Inspector window.

These are advanced settings that Region designers can use to create wholly customized points of interactivity. Please see our for more information.

Orange

Audience

The audience as a whole.

Blue

Screen

The presentation screen.

Green

Speaker

The presenting speaker's avatar.

desktop viewer
World Stream
advanced permissions
World Owners
World Administrators
Dashboard
login screen
Dashboard
Voice chat
installing
positioning
RoomFurniture component
Objects window
Zone Voice property
RoomFurniture component
Global voice zones
voice zone
troubleshooting tips
RoomFurniture component
voice zone type
breakout areas
custom voice zones
RoomFurniture component
installing
positioning
RoomFurniture component
presenter seats
enable media sharing
presenter seats
enable media sharing
Zone Type property
RoomFurniture component
Region templates
Breakroom moderator tools
setting up or customizing Presenter and Audience zones
control audience access to media sharing functions
Running Your Event section
breakout areas
Zone ID
Zone Color
Zone Name
Breakout Rooms panel
installing
positioning
RoomFurniture component
Region Editor
Breakroom Toolkit
available
breakout area objects
Region Editor
Inventory window
preferred method
section
position
Objects window
Zone ID
Zone Name
duplicate zone errors
RoomFurniture component
Objects window
RoomFurniture component documentation
Objects window
troubleshooting page
Breakout Rooms panel
custom voice zone
Objects window
Breakout Rooms panel
Objects window
RoomFurniture component documentation
gesture and camera controls
Region Editor
Objects window
movement gizmo
Voice zones
set up the prefab breakout areas
Breakroom Toolkit
installing
positioning
RoomFurniture component
Region Editor
types of voice zones
Region Editor
Breakroom Toolkit
Inventory
Region Editor
Objects window
size, location, and rotation
gesture and camera controls
location
conference-ready furniture
gestures
camera options
Region Editor,
moving objects
RoomFurniture component
Inventory window
preferred method
movement
rotation tools
scaling tools
Sine Wave Shop
preceding section
start
Inventory window
preferred method
move
rotate
Transform component
scale tool
furniture items
conference system cameras
available
Running Your Event section
default
local scale values
scale tool
default landing
clustered landing
Objects window
troubleshooting page
Objects window
Breakout Rooms panel
troubleshooting page
RoomFurniture component
enable, disable, or rename individual links
Breakout Rooms panel
Objects window
RoomFurniture component documentation

Broadcast messages

The Broadcast Message panel allows you to send text announcements, assist users individually through direct messages, and solicit user feedback.

Overview

The Broadcast messages button (highlighted above) gives Moderators the ability to send text messages to all users currently gathered within a Region, or to individual users. Moderators can flag their messages for reply, allowing users to respond with a minimum of effort. Moderators can also create countdown timers to assist with event management.

After accessing the moderator tools, click the Broadcast messages button in the panel that appears on the right-hand side. This will open the Broadcast Message panel. A quick rundown of the UI will be helpful before we delve into the various messaging options.

Button or UI component

Function

Set Timer toggle

Allows you to activate or deactivate the countdown timer displayed on users' screens.

Timer field

Allows you to enter the countdown timer start value (in hours and minutes).

Select recipient menu

Allows you to select a message recipient (i.e., Everyone or a specific user).

Optional templates menu

Allows you to select a pre-defined message template.

Message field

Allows you to compose your own message.

Message type menu

Allows you to choose whether users can respond to your message, and how they can respond.

Send button

Sends the current message.

Send and Close button

Sends the current message and closes the Broadcast Message panel.

Close button

Closes the Broadcast Message panel.

Message types

Region broadcasts

Region broadcasts are useful when it comes to managing event logistics. You can use them to keep everyone in your Region on task, announce schedule changes, or provide event transition cues.

Here's an example of a message intended for everyone within the Region. Notice how the options are set up:

  • The Select recipient drop-down menu is set to Everyone, so everyone in the Region will see the announcement

  • The Message type drop-down menu is set to Message, so the announcement will be displayed with no expectation of a reply

Here's how the example message might appear to users located within the Region:

To send a Region broadcast message like the one above, follow these steps:

  1. Navigate your avatar to the Region where you want to communicate with your users.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Broadcast messages button.

  4. In the Broadcast Message panel that appears, use the Select recipient drop-down menu to select Everyone.

  5. Enter the message you want to send, or select a template using the Optional templates drop-down menu.

  6. Set the Message type drop-down menu to Message.

  7. Click the Send or Send and Close button.

Direct messages

You can also send direct messages to individual users located in a region. To do so, follow these steps.

  1. Navigate your avatar to the Region where you want to communicate with your users.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Broadcast messages button.

  4. In the Broadcast Message panel that appears, use the Select recipient drop-down menu to select your intended recipient. You can use the search field to search for a specific name.

  5. Enter the message you want to send, or select a template using the Optional templates drop-down menu.

  6. Set the Message type drop-down menu to Message.

  7. Click the Send or Send and Close button.

Yes-or-no messages

In certain cases, you may want to gather feedback from users in the form of a yes-or-no response. You can broadcast an open question to everyone gathered within your Region, or limit your question to a particular user.

Here's an example of how you might approach a specific user. Notice that:

  • The Select recipient menu is set to a specific user

  • The Message type menu is set to Yes or No Response

Here's how the example message might appear to the intended user:

You can see that in addition to being able to close the message, the user can answer Yes or No by clicking the relevant buttons.

In our hypothetical example, the user has responded by answering that yes, she can hear other attendees speaking. Above is the return message a Moderator might receive. From here, the Moderator can reply again through the message pop-up by clicking the Reply button. Alternatively, the Moderator may close the message by clicking the Close button, and approach the user directly through text or voice chat.

To send a yes-or-no message, follow these steps:

  1. Navigate your avatar to the Region where you want to communicate with your users.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Broadcast messages button.

  4. In the Broadcast Message panel that appears, enter the following information:

    1. Use the Select recipient drop-down menu to select Everyone or your intended recipient. You can use the search field to search for a specific name.

    2. Enter the message you want to send, or select a template using the Optional templates drop-down menu.

    3. Set the Message type drop-down menu to Yes or No Response.

  5. Click the Send or Send and Close button.

Input messages

Input messages allow Moderators to solicit detailed responses and feedback from users. These messages can be broadcast to an entire Region, or targeted at a single person.

In the example image above, the Moderator is sending a message to everyone. Notice that:

  • The Select recipient menu is set to Everyone

  • The Message type drop-down menu is set to Input Response

Here's how the example message might appear to users located within the Region:

You can see that a user has received this message and has entered her thoughts in the response field. She can now click Send to reply to the Moderator, or dismiss the announcement pop-up by clicking Close.

Here's an example of how the user's response may appear to a Moderator. The Moderator can now respond to the user by clicking Reply, or Close the conversation.

To send an input message, follow these steps:

  1. Navigate your avatar to the Region where you want to communicate with your users.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Broadcast messages button.

  4. In the Broadcast Message panel that appears, enter the following information:

    1. Use the Select recipient drop-down menu to select Everyone or your intended recipient. You can use the search field to search for a specific name.

    2. Enter the message you want to send, or select a template using the Optional templates drop-down menu.

    3. Set the Message type drop-down menu to Input Response.

  5. Click the Send or Send and Close button.

Countdown timers

You can also use the Broadcast Message panel to create countdown timers that will appear on users' screens. Timers can be added to any message type, and users can see one individual timer and one global timer.

In the example image above, the Moderator is sending a message to everyone. Notice that:

  • The Set Timer toggle is switched On

  • A number value has been entered into the minutes field

Here's an example of how timers may appear to an individual user. This user has received one private timer ("Timer") and one global timer ("Event Timer"). By attaching private timers to direct messages, you can issue individual cues to help speakers and educators transition between events.

To attach a timer to any type of broadcast message, follow these steps:

  1. Navigate your avatar to the Region where you want to communicate with your users.

  2. Click the Moderator tools/Key button located on the right side of the screen.

  3. Click the Broadcast messages button.

  4. In the Broadcast Message panel that appears, switch the Set Timer toggle to On. Enter the timer length in hours and minutes.

  5. Complete your message as normal.

  6. Click the Send or Send and Close button.

When you issue a new event or private timer, it will override any previous timers.

Moderator tools

You work hard behind the scenes to make each and every event a success. Let Breakroom help with our collection of moderator tools. Communicate with users, share streaming media, and more.

Overview

Breakroom's moderator tools offer event coordinators a virtual leg-up when it comes to attendee support and logistics. By accessing a single menu, you can message users as a whole or individually, teleport users to different locations within a Region, and field questions from audience members. You can also stream music and video to create a unique multimedia experience.

Accessing the moderator controls

Moderator tool permissions

Key event coordinators and stakeholders will have access to the moderator tools by default. This list includes:

  • The World Owner

  • World-level Administrators, Moderators, and Developers

  • Region-level Owners, Administrators, and Moderators

This section of the documentation refers to these individuals collectively as "Moderators."

Launching the moderator tools

To launch the moderator tools, click the Moderator tools/Key button located on the right side of the screen. To further expand the moderator tools menu, click the Maximize button located at the bottom.

Here's a brief overview of the moderator tools UI, with links to relevant information.

Button
Purpose

Close button

Closes the menu.

Allows Moderators to act as an Instructor on the Breakroom for Training system.

Allows Moderators to send messages to one or more attendees in the Region.

Raised hands button

Allows Moderators to control signage and videos for presentations.

Support requests button

Allows Moderators to address submitted support requests. (Note: This feature is currently unavailable.)

Allows Moderators to reveal UI elements that are hidden from most users.

Allows Moderators to post a participation system URL for use in the Region, such as Slido.

Allows Moderators to switch the Region audio stream.

Minimize button

Minimizes the expanded menu.

We'll explore the moderator tools in more detail in the sections that follow.

The Moderator tools/Key button is normally visible only to the user types listed above. However, other users may see this button if you have enabled a password on the moderator tools to make them more broadly accessible. If you would like to enable a password as part of your event security or logistics plan, please contact our Customer Success Team for more information.

Designating triage zones

You care about your visitors—and so do we. Learn how you can designate any voice zone a "triage zone," where you can offer users passive or active technical assistance.

Overview

Breakroom offers World Owners and their users a variety of support resources, including:

  • Built-in device and networking testing

  • Device, World Stream and network troubleshooting guides

  • New user guides

However, for large events you may want to designate a triage zone where attendees can access immediate technical assistance. By specifying a triage zone in the Start Here UI, you will add a button that attendees can click to teleport directly to your support area. Moderators can also send attendees to the triage area using the teleportation options built into the moderator tools.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

After using the Region Editor to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

Assistance options

It is important to note that triage zones are quick-teleport destinations available through the Start Here UI. They have no special functionality. Instead, you will need to make key decisions about the way you use your triage area based on the needs of your audience.

If you have a large team, you may want to train several "triage leaders" who will actively staff the triage zone for the duration of your event. Triage leaders could be trained to:

  • Identify struggling users and reach out to them using the moderator tools

  • Use the moderator tools to move users to the triage zone

  • Communicate with users via text and voice chat

  • Troubleshoot any issues that are preventing users from participating in the event

If you have a small team, you may opt to offer passive assistance with or without a limited triage leader presence. This might look like:

  • Graphic guides posted on Breakroom Image Viewers, with or without built-in links

  • Tutorial or troubleshooting videos accessible through Breakroom Video Players, with or without built-in links

  • Interactive website assistance offered through Breakroom Web Browsers

Designating your triage zone

After setting up a breakout area or custom voice zone, you can specify it as a triage zone by following the steps below.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects Button to launch the Objects window.

  4. In the Objects window, locate the Start Here UI object. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  5. In the Inspector window, locate the RoomFurniture component (highlighted above). Expand it by clicking the > arrow.

  6. Locate the Triage Zone field. Into this field, enter the name of the zone you want to designate as the triage zone. (In the example above, we have named a custom voice zone Triage Zone, as highlighted in the Objects window.)

  7. Click the Save button to store your changes. Click the Reset Zones button to reset the conferencing system.

  8. Click the Close button to exit the Region Editor. Leave the Region and return to activate the Get Help button in the Start Here UI.

Setting up Presenter and Audience zones

Breakroom's Presenter and Audience zone types both make use of special presenter seats. Learn how to customize the number of presenter seats available and restrict their use to official delegates.

Overview

Breakroom allows you to customize your Regions with a variety of voice zone types, each with its own set of rules governing what kinds of media can be shared and by whom. Among these, Presenter and Audience zone types are unique, as both make use of special presenter seats.

By positioning their avatars in these seats, presenters can gain access to voice chat and media sharing functions within a particular voice zone, even if these functions are otherwise restricted. Users with access to the Breakroom moderator tools (hereafter referred to collectively as Moderators) can also grant access to voice chat or media sharing functions as needed.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

After using the Region Editor to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

Using Presenter and Audience zones

Presenter seats are represented by the usual blue seat tag. Depending on which Region template or breakout area is being utilized, you may see these tags arranged on a stage, set in front of a main screen, or otherwise located in the logical spot for a presenter to occupy.

To take up a presenter spot, simply click on a blue presenter seat tag. This will position your avatar and give you access to voice chat and media streaming options. To leave the presenter seat, click the Stand Up button at the bottom of the screen.

Presenter and Audience zone functionality

Presenter and Audience voice zones are similar, in that both restrict media access to certain users. For reference, here is a comparison of the default settings for Presenter and Audience zones.

Zone type
Voice chat
Media share (webcam, etc.)

Presenter

All users

Presenters only

Audience

Presenters only

Presenters only

In the following sections, we will explain how presenters can access the media sharing functions they need, and how Moderators can enable or disable media streaming. Instructions are also provided so that World Owners and other users with access to the Region Editor can customize the number of available presenter seats in a given voice zone, or place limitations on who can use those presenter seats.

Setting up Presenter and Audience zones

You can customize Presenter and Audience zones by adding or removing presenter seats. You can also set limitations on who can use those seats. The following tutorials offer step-by-step instructions for specific use cases, but the same general principles can be used to create many different presenter configurations.

Adding presenter seats

For our first tutorial example, we'll add some additional presenter seats to a Breakroom Helpdesk. We will assume that the Breakroom Helpdesk object is already installed in a Region, along with its single presenter seat.

The Breakroom Toolkit includes a variety of presenter seat objects that you can add to any Presenter or Audience zone. Our goal is to place one additional standing presenter seat on either side of the desk to accommodate event staff.

To get started, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Inventory Button to launch the Inventory window.

  4. Locate the Breakroom Addon Presenters object. This object consists of nine standing presenter seats. To find it, use the search field at the top of the Inventory window to look for "presenters."

  5. When you find the Breakroom Addon Presenters object, set it down in your Region using your preferred method. Click the Save button.

Here we encounter our first challenge. There are too many standing presenter seats for our purposes. For our next step, we will make all but two seats invisible.

  1. In the Objects window, click the > arrow located beside the Breakroom Addon Presenters object to expand it.

  2. Click the > arrow located beside the Presenter Sits object to expand it.

  3. Here you will find the nine individual seats that make up the linked presenter seats object. To make a seat invisible, click the eye icon located to the right of its name. Repeat this step for every seat you want to make invisible. Click the Save button.

Now we need to move the seat tags into position by placing one on either side of the desk.

  1. Locate the first seat you want to edit under Breakroom Addon Presenters > Presenter Sits in the Objects window. Click on the seat name to highlight that individual seat.

  2. Use the movement and rotation tools to position the seat tag in your Region. You can also key position values into the tag's Transform component.

  3. Once you have the first seat tag in position, repeat this process for the remaining seat. Click the Save button.

Finally, we need to connect the new presenter seats to the Breakroom Helpdesk voice zone.

  1. Click the Objects button to launch the Objects window. Locate the Breakroom Addon Presenters object. Click on the object name to launch the Inspector window.

  2. In the Inspector window, click on the > arrow to the left of the RoomFurniture component to expand it.

  3. You will see a property titled Zone Name. In this field, enter the Zone Name you want to attach the presenter seats to. (For example, my Helpdesk voice zone is named "Entrance," so I would type in "Entrance.")

  4. Click the Reset Zones button to reset the conference system.

  5. Click the Save button to store your changes, and the Close button to exit the Region Editor.

You can add as many presenter seats as you like to a voice zone. However, it is important to note that Breakroom's media streaming system cannot accommodate more than 17 simultaneous webcam or screen share users.

Removing presenter seats

To remove presenter seats from a voice zone (for example, if you want two presenter spots instead of nine), you would follow the same instructions included in the example tutorial above.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, click the > arrow located beside the Breakroom Addon Presenters object to expand it.

  4. Click the > arrow located beside the Presenter Sits object to expand it.

  5. Here you will find the individual seats that make up the linked presenter seats object. To make a seat invisible, click the eye icon located to the right of its name. Repeat this step for every seat you want to make invisible.

  6. Click the Reset Zones button to reset the conference system.

  7. Click the Save button to store your changes, and the Close button to exit the Region Editor.

The Presenter and Audience zones seats that come preconfigured in Breakroom's Region templates cannot be edited, as they are uploaded with the Region as a whole. We apologize for the inconvenience.

Restricting presenter seat access

It is possible to prevent unauthorized users from jumping on empty presenter seats by restricting access to VIPs or staff members only. To get started, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, click the > arrow located beside the Breakroom Addon Presenters object to expand it.

  4. Click the > arrow located beside the Presenter Sits object to expand it.

  5. Here you will find the individual seats that make up the linked presenter seats object. To edit a seat, click on it in the Objects window. Doing so will launch the Inspector window for that seat.

  6. In the Inspector window, locate the ScriptingData component. Click the > arrow on the left to expand it.

  7. Here you will see three properties and their associated fields. We are concerned only with the VIP and Staff fields. The Reserved field should not be edited.

    1. VIP field: To restrict presenter seat access to Region VIPs and above, as well as world-level Administrators and above, type yes into this field.

    2. Staff field: To restrict presenter seat access to Region Moderators and above, as well as world-level Administrators and above, type yes into this field.

  8. Repeat these steps for every seat you want to restrict. When you are satisfied, click the Reset Zones button to reset the conference system.

  9. Click the Save button to store your changes, and the Close button to exit the Region Editor.

The Presenter and Audience zones seats that come preconfigured in Breakroom's Region templates cannot be edited, as they are uploaded with the Region as a whole. We apologize for the inconvenience.

Controlling audience voice chat and media access

Using the Crowd management panel, Moderators can permit or restrict access to voice chat, webcam streaming, and screen sharing in Presenter and Audience zones.

To locate this panel, click the Moderator controls/Key button located on the right side of the screen, and then the Crowd management button. In order to moderate Presenter and Audience zones, you will use the buttons under the Zone Settings section.

In detail, the available zone settings are:

  • Quiet Mode: When turned on, Quiet Mode will mute every user who is not currently seated on a presenter seat.

  • Audience Mode: When turned on, Audience Mode grants users access to all enabled communication options in that voice zone (e.g., voice chat, webcam, and screen share). Audience Mode overrides Quiet Mode, if Quiet Mode is also turned on.

  • Admin Mode: When turned on, Admin Mode permits Moderators to access all enabled communication options in that voice zone (e.g., voice chat, webcam, and screen share). Admin Mode overrides Quiet Mode.

To customize a voice zone's communication settings, follow the steps below.

  1. Navigate your avatar to the appropriate Region.

  2. Position your avatar inside the voice zone that you want to customize.

  3. Click the Moderator tools/Key button located on the right side of the screen.

  4. Click the Crowd management button. In the Crowd Management panel that appears, locate the Zone Settings section.

  5. Click the relevant buttons to customize the voice zone.

    1. If a button says Quiet/Audience/Admin is On, then that communication setting is currently enabled. Click the button again to disable it.

    2. If the button says Quiet/Audience/Admin is Off, then that communication setting is currently disabled. Click the button again to enable it.

  6. Repeat this process for every voice zone you want to customize.

The most common change Moderators will make is to toggle Quiet Mode on or off in Presenter zones. This will enable the audience to use voice chat—for example, during a Q&A session.

Troubleshooting duplicate zone errors

While setting up your breakout areas and voice zones, you may encounter duplicate zone errors in the Region Editor. Here you'll learn what these errors mean and how to fix them.

Overview

The prefab breakout areas and voice zone objects included with your Breakroom subscription are designed to set themselves up automatically. When added to a Region, each object should assign itself a unique Zone ID and Zone Name. However, occasionally you may run into situations where two or more voice zones are assigned the same information.

In these situations, the Region Editor will display a warning panel in the lower middle portion of the screen. Depending on the type of information that has been duplicated, you may see a Duplicate Zone ID warning, a Duplicate Zone Name warning, or both.

Clicking on either warning will trigger beacons designed to help you locate the conflicting voice zones. You can then make any necessary changes.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

After using the Region Editor to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

Fixing duplicate Zone IDs

If the Region Editor displays a Duplicate Zone ID warning, it means that two or more breakout areas or voice zones are assigned the same Zone ID. You can learn more about Zone IDs in our RoomFurniture component documentation, but the key things to remember are:

  • A Zone ID identifies the breakout area or voice zone as a self-contained media point.

  • If two voice zones are assigned the same Zone ID, then users located in those two zones can hear one another over voice chat, see each other over webcam, etc., even if the voice zones are located a good distance from each other. This may result in cross-chatter and confusion.

To change a breakout area or voice zone's Zone ID, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects Button to launch the Objects window.

  4. In the Objects window, locate the Breakroom Breakout Area or Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  5. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  6. In the Zone ID field, enter the ID number you want to use.

  7. Click the Reset Zones button to reset the conferencing system.

  8. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Remember: Clicking on the Duplicate Zone ID warning will trigger highlight beacons over both duplicate zones.

Fixing duplicate Zone Names

If the Region Editor displays a Duplicate Zone Name warning, it means that two or more breakout areas or voice zones are assigned the same Zone Name. Zone Names mainly serve to identify or label destinations that will appear in the Breakout Rooms panel and the Areas of Interest panel.

To change a breakout area or voice zone's Zone Name, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. Click the Objects Button to launch the Objects window.

  4. In the Objects window, locate the Breakroom Breakout Area or Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  5. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

  6. In the Zone name field, enter the name you want to use.

  7. Click the Reset Zones button to reset the conferencing system.

  8. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Remember: Clicking on the Duplicate Zone Name warning will trigger highlight beacons over both duplicate zones.

The RoomFurniture component

The RoomFurniture component is an integral part of Breakroom's prefab Breakout Area and Voice Zone objects. Learn how to create custom audio effects, change the default cameras, and more.

Overview

When it comes to editing and customizing prefab breakout areas and voice zones, the RoomFurniture component is of key importance. In the sections that follow, we'll explore the various object factors that the RoomFurniture component controls.

Accessing the RoomFurniture component

After you add a Breakroom Breakout Area or Breakroom Voice Zone object to your Region, follow the steps below to locate the RoomFurniture component and view its properties.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, locate the Breakroom Breakout Area or Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Click on the object name to launch the Inspector window.

  4. In the Inspector window, locate the RoomFurniture component. Expand this component by clicking the > arrow located to the left of its name.

In the sections that follow, we'll explain the functions each property controls and discuss ways to customize your Breakroom Region setup.

Zone ID

When you add a new Breakroom Breakout Area or Breakroom Voice Zone object to your Region, it will be automatically assigned a unique Zone ID. This number identifies the zone as a self-contained media point.

To change the Zone ID:

  1. In the Zone ID field, enter the ID number you want to use.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Grouping certain types of Zone IDs together can help with project organization. For example, important zones such as a help desk and an auditorium could be identified as Zones 1 and 2 respectively, while breakout rooms could be identified from Zone 10 upwards.

❗ IMPORTANT NOTE ABOUT ZONE IDS ❗

If two breakout areas or voice zones are assigned the same Zone ID, users in those areas will be considered to be within the same voice zone, even if they are separated by the entire length of a Region. This may be just the trick you need to create points of interest and interaction for your users— or it could result in cross-chatter and confusion.

Zone Name

You can rename a breakout area or voice zone at any time. Uses for this may include:

  • Fixing issues caused by redundant prefab breakout area names, or manually reordering breakout areas

To change the Zone Name:

  1. In the Zone Name field, enter the name you want to use.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes.

Zone Type

  • Presenter: Presenter zones restrict the use of screen and webcam sharing to only users in a designated presenter seat. Voice chat is available to everyone.

  • Audience: Audience zones go a step further than Presenter zones, restricting voice chat and media sharing to only users in a designated presenter seat.

  • Meeting: In Meeting zones, voice chat and media sharing are enabled for all users.

  • Silent: In Silent zones, voice chat and media sharing are disabled for all users.

You can change a breakout area or voice zone's Zone Type at any time by following these steps.

  1. In the Zone Type field, enter the type (presenter, audience, meeting, voice, silent) you want to use.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes.

Zone Voice

The Zone Voice property controls whether voice chat is enabled in a particular breakout area or voice zone.

To enable or disable voice chat:

  1. In the Zone Voice field, enter the word yes or no.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

However, this property is useful in certain cases. For example, you may want to create a custom voice zone where users can share their screens while they participate in Global chat.

Zone Spatial

By entering 0 in the Zone Spatial field, you can turn off spatial audio entirely. This means that everyone in the voice zone will be heard at the same volume, with no spatial audio effect.

If you enter a 1 or above in the Zone Spatial field, you will enable spatial audio. The number represents the number of meters surrounding each avatar wherein their voice feed can be heard by others. 1 equals one meter, 5 equals five meters, etc.

To edit the Zone Spatial property:

  1. In the Zone Spatial field, enter either a 0 or the number of meters you prefer.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Chat

The Zone Chat property controls whether a dedicated, zone-specific text channel is available to users.

To enable or disable text chat:

  1. In the Zone Chat field, enter the word yes or no.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Auto Configure

This field is for internal Breakroom use. You will not need to manually edit it.

Zone Priority

The Zone Priority property can be used to create "nested" voice zones, or voice zones located inside other voice zones. In the image above you will see multiple voice zones, some of which are overlapping:

  • The cozy chat area (highlighted), located in its own cube-shaped voice zone

  • The concourse end (center), located in a spherical voice zone

  • The auditorium (back), with its own associated voice zone

  • The Global voice zone (not highlighted), which covers the entirety of the Region

Let us consider the voice zones represented by the cube and the sphere, specifically. By setting the large spherical voice zone as Priority 2 and the cube as Priority 3, we can specify that users seated within the cozy chat area should only participate in audio or video chat with each other, even though their avatars are technically also located inside the sphere... which is located inside the Global voice zone.

Creating nested voice zones may appear to be a simple matter stacking voice zones on top of one another. However, doing so may not achieve the effect you want—what matters is the Zone Priority number each voice zone has been assigned. The Global voice zone is always Priority 1; the higher the number, the higher the zone priority.

To edit an area's Zone Priority:

  1. In the Zone Priority field, enter the priority number you want to assign to the voice zone.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Color

To change the Zone Color:

  1. In the Zone Color field, enter one of the following color keywords:

    1. Blue

    2. Orange

    3. White

    4. Grey

    5. Magenta

    6. Teal

    7. Black

    8. Cyan

    9. Red

    10. Purple

    11. Pink

    12. Green

    13. Yellow

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes.

Changing the Zone Color presets

If you like, you can change the hexadecimal presets for each of the color keywords listed above. To do so, follow these steps.

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

  2. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  3. In the Objects window, locate the Breakroom Breakout Area or Breakroom Voice Zone object you want to edit. (Tip: You can use the search field at the top of the window to search for a specific object.) Expand that object by clicking the > arrow located to the left of the object name.

  4. Locate the Colors component and click on it. This will launch the Inspector window.

  1. In the Inspector window, expand the ScriptingData component by clicking the > arrow next to its name.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Color keywords can only be edited on a per-object basis. They cannot be changed on a global basis.

Zone Camera Default

By editing the Zone Camera Default property, you can change which camera angle users see when they first sit down in a breakout area or voice zone. Camera options include:

  • Behind

  • Forward

  • Speaker

  • Screen

  • Audience

  • Free

To change the default camera:

  1. In the Zone Camera Default field, enter the name of the camera you would like to use (behind, forward, speaker, screen, audience, or free).

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Camera List

  • Behind

  • Forward

  • Speaker

  • Screen

  • Audience

  • Free

By default, the Zone Camera List is blank, indicating that users have access to all of the cameras listed above. If you enter one or more specific camera names, users will be restricted to only those choices.

To edit the Zone Camera List:

  1. In the Zone Camera List field, enter the camera names you want to make available, separated by commas. For example:

  1. Click the Reset Zones button to reset the conferencing system.

  2. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Zone Visible

To add or remove a breakout area or custom voice zone from Region navigation tools:

  1. In the Zone Visible field, enter the word yes or no.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Screen options (Width, Height, Scale)

The Width, Height, and Scale properties can be used to change the aspect ratio or size of the screen used to display user-driven media inside a breakout area or voice zone. By manually editing the Width and Height fields, you can create custom aspect ratios.

As a brief overview, to edit a voice zone screen's aspect ratio or size:

  1. In the Width, Height, or Scale fields, enter the value(s) you prefer.

  2. Click the Reset Zones button to reset the conferencing system.

  3. Click the Save button to store your changes. Click the Close button to exit the Region Editor.

Customizing the conference system components

Within the Metaverse, you can shape virtual reality to meet your actual needs. Whether you want to add plug-and-play breakout areas or create custom functionality, learn more about your options here.

Overview

When you're building your Breakroom World, you can customize it as little or as much as you like. Plug-and-play breakout areas allow you to deploy conference Regions with just a few clicks, while our custom voice zones allow you to shape the aural landscape to control media sharing and audience interaction.

Important links in this section

Allows Moderators to teleport one or more users around the Region, and to control access to .

Allows Moderators to review audience questions through the conference system.

Allows Moderators to identify users who have their .

When you select a prefab or object in Breakroom's , you'll see a number of components listed in the Inspector window for that object.

These components contain properties that can be edited to customize various object factors and behaviors. For example, the Transform component contains information about a virtual object's position and size. You can these properties manually by entering new values into the fields.

The instructions provided in this section presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

After using the to add or edit a voice zone, always remember to click the Reset Zones button to reset the conferencing system. If this doesn't seem to push your changes forward, try saving your work, leaving the Region, and entering it again.

Click the Objects Button to launch the .

Follow the to access the RoomFurniture component.

If you are experiencing issues with voice zones, always check your Zone IDs. If you do have duplicate Zone IDs within a Region, the warning pictured above will appear in the Region Editor. Please see our page on for more information.

When you add a new Breakroom Breakout Area or Breakroom Voice Zone object to your Region, it is automatically assigned a Zone Name. In the case of prefab , this name will take the form of "Breakout N," where N is a unique number. This naming convention ensures that the breakout area is added to the . In the case of , the zone name will default to "Workshop."

Designating a custom voice zone as a breakout area by changing its name to "Breakout N" (where N is a unique number). This will add it to the and the

Linking a breakout area or custom voice zone to the or when in a bespoke Region

Follow the to access the RoomFurniture component.

As explained in our documentation concerning , there are five types of voice zones available for use in Breakroom. To review, these are:

Voice: Within Voice zones, only will work.

Follow the to access the RoomFurniture component.

Follow the to access the RoomFurniture component.

Disabling the Zone Voice property may not disable voice chat entirely. For instance, a user standing in a breakout area with Zone Voice deactivated will still be able to hear and participate in chat from the surrounding voice zone (e.g. the ), as nested voice zones can impact one another.

The Zone Spatial property controls the that users will experience when standing in a breakout area or voice zone. When spatial audio is enabled, voice zones behave much like you would expect in the "real world"—other avatars (or people) standing nearby will be easy to hear, while avatars standing at a distance may be more difficult to hear, if you can hear them at all.

Follow the to access the RoomFurniture component.

Follow the to access the RoomFurniture component.

Turning Zone Chat off will not disable text chat as a whole for end users. It will simply remove the option of having a dedicated text chat within the specified voice zone. If you want to disable text chat across the whole of your Breakroom World by , please see our .

Follow the to access the RoomFurniture component.

When you add a new Breakroom Breakout Area to your Region, it will automatically assign itself a unique Zone Color. This color will be applied to the actual breakout space, and will also be used as the teleport button background color in the .

Follow the to access the RoomFurniture component.

Click the Objects Button to launch the .

Enter the you would like to assign to each keyword.

Follow the to access the RoomFurniture component.

By editing the Zone Camera List, you can change which camera angles users will be able to access through the . Camera options include:

Follow the to access the RoomFurniture component.

The Zone Visible property controls whether a breakout area or custom voice zone appears in any navigation tools. This includes the and the .

Follow the to access the RoomFurniture component.

You can also edit the final display size of the screen overall by changing the number in the Scale field. The value in this field is a multiplier with a default of 1, so you might enter .5 to create a screen half the size, or 2 to create a screen double the size. Our walkthrough contains an illustrated example of how you might edit this field.

Follow the to access the RoomFurniture component.

Behind,Speaker
Breakroom Training Instructor Mode button
Broadcast messages button
Crowd management button
voice chat
Audience questions button
submitted
hands raised
Presentation controls button
Hidden UI button
Participation button
Audio stream button
breakout area
voice zone
Region Editor
edit
installing
positioning
RoomFurniture component
Region Editor
Objects window
steps above
troubleshooting duplicate zone errors
breakout areas
Breakout Rooms panel
custom voice zones
Breakout Rooms panel
moderator tools
General Navigation panel
Areas of Interest panel
installing the conference system
steps above
voice zones and conference permissions
voice chat
steps above
steps above
Global voice zone
spatial audio effect
steps above
steps above
customizing the UI
Creating Custom Experiences section
steps above
Breakout Rooms panel
steps above
Objects window
hexadecimal color codes
steps above
gesture and camera panel
steps above
Breakout Rooms panel
Areas of Interest panel
steps above
custom voice zone
steps above
Adding breakout areas
Creating custom voice zones
Setting up Presenter and Audience zones
107B
Breakroom CSV 2024.csv
A screenshot of the starter avatar selection screen during sign-up. On the right is a tile menu consisting of pictures of different avatars, while on the left is a detailed view of a single avatar.
Pictured: Choosing a starter avatar from the menu during sign-up.
Pictured: The Start Here panel and the starter avatar menu.
A screenshot of six diverse avatars standing in a row, all dressed in business wear.
Breakroom's avatar customization system offers endless possibilities for self-expression.
Groups of avatars converse in a futuristic, open-plan convention center. In the foreground, a convention attendee seeks advice from a staffer who is seated behind a desk.
Virtual conferences create development and networking opportunities for individuals who may not be able to attend in-person events.
A group of teenage avatars is gathered in a dimly lit museum room, where several artifacts from world religions are displayed. They are listening to a young male teacher speak, and a few teenagers have their hands raised.
Museum exhibits are only a click away when you use Breakroom to deliver interactive educational content.
A female avatar in a pink dress stands facing the camera in a futuristic conference center. On the screen around her are the various toolbars that make up the Breakroom UI.
An example of the UI in action. You can press the F9 key or Alt + U (⌘ + U) to toggle the UI on and off.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation.
Pictured: The bottom toolbar.
A closeup of the top toolbar of the Breakroom UI. This toolbar includes in-world currency information, a search bar, and various notification icons along with access to in-world email.
Pictured: The top toolbar.
A closeup of the mini map in the Breakroom UI. In addition to a map of the region, the mini map includes buttons that provide region information, bookmark capabilities, and access to quest information.
Pictured: The mini map.
A closeup of the settings toolbar of the Breakroom UI. The settings toolbar contains buttons that allow access to viewer and audio settings, in-world help documentation, and audio streams.
Pictured: The settings toolbar.
A closeup of the Shop window. Under the Gesture tab, a number of different dance gestures are listed, including ballet, break dancing, and disco.
Pictured: The Sine Wave Shop, and an example of the contents you may find listed under the Gestures tab.
A closeup of the Inventory window, where several gestures are visible under the Gestures category. This includes dances, hugs, and high-fives.
Pictured: An example of how the Inventory window may appear. The Gestures category is expanded to reveal two sub-categories.
A closeup of the Hot Bar, which has been filled with various dance gestures.
Pictured: The Hot Bar populated by several different gestures.
A screenshot of a female avatar with auburn hair dancing. An arrow at the bottom highlights the position of the "Stop Gesture" button.
Highlighted: The location of the Stop Gesture button.
A screenshot of two female avatars standing on a lawn. An action menu has been opened by clicking the avatar in the back, and a highlight draws attention to the "Play Gesture" action.
Highlighted: The Play Gesture action.
A screenshot of two female avatars standing in a sculpture garden. One of the avatars has started an open gesture, and glowing blue rings highlight the "gesture zone" around her.
Pictured: An open gesture invitation, with a visible "gesture zone."
A closeup of the Breakroom Shop currency display. Here you can quickly review your Gold and Silver currency holdings.
Pictured: An example of the Sine Wave Shop currency display.
A closeup of the Breakroom UI bottom toolbar. The Shop button is highlighted on the right-hand side.
Highlighted: The location of the Shop button.
A screenshot of the Breakroom Shop, with the category tabs along the top highlighted. The Clothes category is currently open, and the window contains tiles corresponding to various items of clothing for sale, including suit jackets, shoes, and t-shirts.
Highlighted: The Sine Wave Shop category tabs.
A closeup of the Clothes subcategory menu. Clicking on any of these subcategories will narrow down your search -- for instance, you can browse through full outfits, tops, bottoms, etc.
Pictured: The Clothes subcategory menu.
A closeup of the Breakroom Shop search field as seen in the Clothes category. In addition to entering terms into the search field, you can click "Male Only," "Both," or "Female Only" to specify what type of clothing you are looking for.
Pictured: The Sine Wave Shop search field.
A closeup of a shirt listing in the Breakroom Shop. The model has close-cropped ginger hair, and they are wearing a blue short-sleeved Oxford shirt. This shirt can be purchased with either Gold or Silver currency.
Pictured: A clothing item in the Sine Wave Shop.
A closeup of the Breakroom Shop clothing preview window. Here a female avatar with auburn hair is trying on the blue, short-sleeved Oxford shirt. She is also wearing a navy blue wrap skirt. There are buttons allowing you to purchase the shirt with Gold, with Silver, or to add it to your cart.
Pictured: A female avatar trying on a new shirt.
A closeup of the Breakroom Shop preview window camera controls. The buttons along the top allow you to zoom in on your avatar's feet, body, and head. The magnifying glass buttons allow you to zoom in or out, while the arrows allow you to adjust your camera position. The UI for this panel is described below.
Pictured: The preview window camera controls.
A closeup of the Breakroom Shop cart. It is populated by a single item, a red sheath dress. Toggles at the top allow you to select whether you want to pay for the item using Gold or Silver, while buttons on the bottom allow you to clear the cart, check out, or continue shopping.
Pictured: The Sine Wave Shop checkout screen.
A closeup of a bundled item and its associated action menu. The buttons, from top to bottom, are labeled "Use," "Rate," "Delete," and "Cancel."
Highlighted: The location of the Use button.
A screenshot of two windows displayed next to each other. On the left is the Inventory window, where a single bundle icon is visible. On the right is the Bundle Detail window corresponding to this bundle. The bundle contents are listed in the window, while buttons at the bottom allow you to "Get" the bundle contents, or "Cancel" the bundle opening.
Highlighted: The location of the Get button.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The Outfit button is highlighted in orange.
Highlighted: The location of the Outfit button.
A screenshot of the Outfit window. The right side of the screen contains menus for applying face and body presets, while the left side contains a preview window. In the preview window, a gray-haired female avatar wearing a sleeveless top and pencil skirt is shown.
Pictured: The main Outfit window UI.
A closeup of the Outfit window camera controls, which include directional and zoom buttons. The UI for this panel is described below.
Pictured: The camera tools.
A closeup of the Create New Outfit button.
Pictured: The Create New Outfit button.
A closeup of the Outfit window tabs, which consist of four tabs arranged vertically between the two halves of the Outfit window. The first one at the top, the Appearance tab, is highlighted.
Highlighted: The location of the Appearance tab.
A closeup of the Body and Face presets available under the Appearance tab.
Pictured: Body and face presets available under the Appearance tab.
The Outfit window, with the Appearance tab open on the right side. The location of the Details tabs is highlighted. In the preview window, a female avatar with gray hair is shown from the waist up.
Highlighted: The Appearance tab, with the location of the Details tabs highlighted.
A closeup of the Head tab, showing several slider controls.
Pictured: The Head tab, with several facial feature control panels expanded.
A closeup of the Randomize slider.
Pictured: The Randomize slider.
A closeup of the Skins tab, showing several female skins that can be applied to an avatar.
Pictured: The Skins tab.
A closeup of the Skin Bumpiness slider.
Pictured: The Skin Bumpiness slider.
A screenshot of the Skin Shade interface. This consists of a color palette as well as Hue, Saturation, and Brightness sliders.
Pictured: The Skin Shade settings.
A closeup of the Outfit window tabs, which consist of four tabs arranged vertically between the two halves of the Outfit window. The second one from the top, the Wardrobe tab, is highlighted.
Highlighted: The location of the Wardrobe tab.
A screenshot of the Wardrobe tab, listing a variety of avatar accessory categories. These include Bottoms, Tops, Outfits, Skins, and more.
Pictured: The Wardrobe tab categories.
A closeup of a single avatar component -- a pair of round, black plastic glasses. In the lower right corner, a pencil icon is visible.
Pictured: An avatar item in the Wardrobe tab. Note the pencil icon in the lower right corner.
An example of the customization options available for a single avatar item, in this case a pair of black plastic glasses. Using these options, the glasses can be repositioned, resized, rotated, and their materials edited.
Pictured: An example of the customization options available for a particular avatar component.
A closeup of the Wearing tab > Bodies category, featuring a face morph and several pairs of shoes.
Pictured: An example of a third-party morph, alongside other avatar components.
A closeup of the Outfit window tabs, which consist of four tabs arranged vertically between the two halves of the Outfit window. The third one from the top, the Wearing tab, is highlighted.
Highlighted: The location of the Wearing tab.
A closeup of the Wearing tab, showing fingernail polish and shoes as worn by an avatar. These items can be removed from the avatar by clicking the associated Remove button. The shoes can be edited, and so a material slider is visible.
Pictured: The Wearing tab. Note the Remove buttons and the edit sliders.
A closeup of the Outfit window tabs, which consist of four tabs arranged vertically between the two halves of the Outfit window. The one on the bottom, the Outfit List tab, is highlighted.
Highlighted: The location of the Outfit List tab.
A closeup of the Outfit list, in this case populated by more than a dozen saved outfits. Each tile features a male or female-styled head, depending on the base gender of the avatar. In addition to the outfit name, there is also an ID number for each outfit.
Pictured: The Outfit List tab populated with saved outfits.
A closeup of the top toolbar. The envelope icon on the far right has a pink "alert" tag attached to it, indicating that there is one unread message.
Pictured: The top toolbar. The envelope icon has changed to alert the user to an unread message.
A closeup of the Mail window, with a single unread email. The sender and first line of this email are displayed in the Email preview area.
Pictured: The Mail window with an unread message.
A closeup of the email composition window. A user is responding to an email in the field.
Pictured: The in-world email composition window.
A closeup of the conference system controls, which consists of the General Navigation panel, the communication panel, and the Breakout Rooms teleport panel.
Pictured: The conference system controls, located at the top of the screen.
A closeup of the conference system communication panel. Large buttons from left to right are labeled Microphone, Video, Screenshare, Device Options, and See in World. Small buttons from left to right are Raise Hand, Emoji, Web Collab, and Question. The UI for this panel is described below.
Pictured: The conference system communication panel.
A closeup of the Microphone button.
Pictured: The Microphone Off / On button.
A closeup of the Settings toolbar, with the Microphone button highlighted in orange.
Highlighted: The Microphone button in the Settings toolbar.
A closeup of the Video button.
Pictured: The Video Off / On button.
A closeup of the Screenshare button.
Pictured: The Screenshare Off / On button.
Pictured: The Screenshare control panel.
A closeup of the "See in World," or Screen Appearance button.
Pictured: The Screen Appearance button.
A screenshot showing how a user has changed Screen Appearance to "See on Screen" mode, and so the screen being shared is visible in the center of their viewer.
Highlighted: The active "See on Screen" option, as well as the full screen toggle.
A screenshot of a female avatar seated in a futuristic meeting room. She has clicked the Raise Hand button, and her own hand is raised. An orange hand icon floats above her head.
Highlighted: The location of the Raise Hand button.
A screenshot of two female avatars seated in a futuristic meeting room. The auburn-haired avatar on the left has clicked the Emoji button, and animated thumbs-up emojis are floating above her head.
Highlighted: The location of the Emoji button and menu.
A screenshot of a female avatar seated in a chair. The location of the Question button is highlighted. The user has clicked this button, and has written a question about continuous improvement into the question field.
Highlighted: The location of the Question button.
A screenshot of a gray-haired female avatar looking up the stadium seating in an empty auditorium. Blue circle and arrow tags hover over the available seats.
Pictured: A virtual auditorium. Note the blue tags hovering over the available seats.
A screenshot of a gray-haired female avatar seated in one of the red auditorium seats. To the left are two panels labeled Gestures and Camera View. These contain options for emoting and adjusting the camera while seated.
Pictured: An avatar seated in an audience seat. Note the Gestures and Camera View panels on the left side of the screen.
A screenshot of a gray-haired female avatar standing outside a breakout area located in a sculpture garden. A transparent blue voice zone boundary indicator stands in front of her. To her left is an event sign advertising Upward Con.
Pictured: An avatar on the threshold of a breakout area. Note the voice zone boundary indicator.
A closeup of the General Navigation panel. The UI for this panel is described below.
Pictured: The General Navigation panel.
A closeup of the Breakout Rooms panel. The UI for this panel is described below.
Pictured: The Breakout Rooms panel.
A closeup of the Areas of Interest panel.
Pictured: The Areas of Interest panel.
Highlighted: The location of the Breakroom for Training widget.
Pictured: A closeup of the Breakroom for Training widget.
Pictured: The Reference buttons.
Pictured: An example multiple choice question.
Pictured: The submission confirmation screen.
Pictured: An example Breakroom for Training waiver.
The login screen of the Breakroom desktop application. Highlighted: The Language drop-down menu.
Pictured: Breakroom's display language can be changed by accessing the Language drop-down menu prior to login.
A closeup of the mini map, with an orange arrow pointing to the Bookmark button.
Highlighted: The location of the Bookmark button.
A closeup of a user Inventory opened to the Bookmarks category. The action menu for a bookmark has been opened, and a blue arrow points to the Teleport button.
Highlighted: Several bookmarks and the location of the Teleport button.
A closeup of the General Navigation panel. The UI for this panel is described below.
Pictured: The General Navigation panel.
A closeup of the Breakout Rooms panel.
Pictured: The Breakout Rooms panel.
A closeup of the Areas of Interest panel.
Pictured: The Areas of Interest panel.
A closeup of the mini map.
Pictured: The mini map.
A closeup of the top toolbar search field, with a single result returned for a Region search.
Pictured: The search field.
A closeup of a Breakroom Teleport Portal set up in the Delphi Region.
Pictured: A Breakroom Teleport Portal.
A closeup of the Explore window, with twelve different Region listing cards.
Pictured: The Explore window.
A closeup of a user Inventory opened to the Bookmarks category. The action menu for a bookmark has been opened, and a blue arrow points to the Teleport button.
Highlighted: Several bookmarks and the location of the Teleport button.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The Meetings button is highlighted in orange.
Highlighted: The location of the Meetings button.
A closeup of the Meetings window, with three events published for review. The UI for this window is described below.
Pictured: An example of how the Meetings window may appear.
A closeup of a meeting listing. Under a photo of the Region where the event will be held, details about the meeting are noted.
Pictured: An example of how a single event listing may appear.
A closeup of the Meeting creation window. Instructions for creating and listing a meeting are detailed below.
Pictured: The Meeting creation window.
A closeup of the Invite Attendees window. Instructions for using this window are detailed below.
Pictured: The Invite Attendees window.
A closeup of the mini map, with an orange arrow pointing to the Bookmark button.
Highlighted: The location of the Bookmark button.
A closeup of the Meeting creation window. Here a user has entered several event details, including selecting a direct bookmark.
Pictured: The Meeting creation window.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The Explore button is highlighted in orange.
Highlighted: The location of the Explore button.
A closeup of the Explore window, with twelve different Region listing cards. The UI for this window is described below.
Pictured: The Explore window.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The Profile icon is highlighted in orange, and an orange arrow is pointing to it.
Highlighted: The location of the Profile icon.
A closeup of an example user profile. The first page is the Detail tab, where a photo of the user's avatar is displayed above their professional information.
Pictured: The Detail tab of a user's profile, as viewed by that user.
A closeup of another user's profile, where the focus is on the action buttons displayed in the header. These buttons were described in the preceding section.
Pictured: The main page of a user profile, as viewed by another user.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The Snapshot button is highlighted in orange.
Highlighted: The location of the Snapshot button.
A screenshot of the Snapshot tools superimposed on an image of a gray-haired female avatar wearing a formal gown in a snowy Region.
Pictured: An example of the Breakroom UI with the Snapshot feature enabled. Please note that any visible UI elements will not be present in your final shot.
A closeup of the Snapshot tabs located along the top of the Snapshot toolbar. These features are detailed below.
Pictured: The Snapshot tabs.
A closeup of the save options located at the bottom of the Snapshot toolbar. These options are described in more detail below.
Pictured: The options located at the bottom of the Snapshot toolbar.
A snapshot of a gray-haired female avatar in a sparkly blue ballgown, posed dramatically for the camera. The final save menu is visible in the upper right-hand corner.
Pictured: A snapshot and the final save menu.
Another photo of the gray-haired female avatar, this time displayed with social media sharing options beneath.
Pictured: The Snapshot social media sharing options.
A closeup of a user profile's Photo tab, with twelve different snapshots on display.
Pictured: An example of a user profile photo library.
A closeup of the People window, where nine contacts are listed for a particular user. The last contact name has been clicked, revealing an action menu.
Pictured: The combined People and Groups window.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The People button is highlighted in orange.
Highlighted: The location of the People button.
A screenshot of two female avatars standing in front of a modern sculpture. The avatar on the right has been clicked, revealing an action menu. The Add/Delete Contact action is highlighted.
Highlighted: The Add/Delete Contact action in the avatar action menu.
A closeup of the People window action menu, listing various commands. The UI for this menu is described below.
Pictured: The People window action menu.
A closeup of the Groups window, with two groups listed.
Pictured: The combined People and Groups window.
A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The People button is highlighted in orange.
Highlighted: The location of the People button.
A screenshot of a user's group list and a Group Information window displayed side-by-side.
Pictured: A user's group list and an example Group Information window.
A closeup of the top toolbar search field, with two results returned for a group search.
Pictured: A group search with two results returned.
A closeup of the Groups dialog box, with details entered for the creation of a new group.
Pictured: The Groups dialog box.
A closeup of the Members tab. A user has applied to join, and an orange arrow points to the Edit button action menu, where that application can be approved or rejected.
Pictured: An example of an Approved Only group with a pending applicant.
A closeup of the Members tab. The "Add new members" dialog box is superimposed on top, and the Group Owner has searched for a specific user, returning one result.
Pictured: The "Add new members" dialog box.
A closeup of the Members tab, with the Set Role drop-down menu expanded.
Pictured: An example of the Group Information window Members tab.
A closeup of the Members tab. The Status icons and Edit button action menu are highlighted in orange.
Highlighted: The location of the Status icons and the Edit button action menu.
A closeup of the mini map. An orange arrow points to the location of the Region Information button.
Highlighted: The location of the Region Information button.
A screenshot of the Region Information window. This window lists information about the Region, its Administrators, and its current permissions.
Pictured: An example Region Information window.
A closeup of the Permissions panel in the Region Information window. In addition to listing the Region's current permissions, an Edit button is located in the top right corner.
Pictured: The Permissions panel of the Region Information window. Note the Edit button.
A screenshot of the Region settings tab available to Region Owners and Region Administrators. Options listed in this window are described below.
Pictured: An example of the Region settings available to Region Owners and Region Administrators.
A screenshot of the Region Information window alongside the audio stream selection menu. Multiple audio streams are listed.
Pictured: The Region Information window audio stream selection menu.
A closeup of the Region Access panel in the Region Information window. Four types of Region access are listed here, and are described in great detail below.
Pictured: The Region Access panel of the Region Information window.
A screenshot of the Region Information window > Members tab, with six members listed.
Pictured: The Region Information window > Members tab.
A screenshot of the Region Information window > Groups tab, with four groups listed.
Pictured: The Region Information window > Groups tab.
A screenshot of the Region Information window > Members tab, with the location of the Status icons and the Edit button action menu highlighted.
Highlighted: The location of the Status icons and the Edit button action menu.
Pictured: A custom login screen for an event in Breakroom.
Pictured: The Dashboard > World Customization > Basic Information tab, "Branding" panel.
Pictured: Several application icons in the Windows taskbar.
Pictured: The desktop app installation dialog box.
A screenshot of the Breakroom Town Square Region, featuring a blocky cityscape, a western town, and a Japanese temple in the distance. King Kong sits atop one of the skyscrapers, keeping watch over his domain.
A screenshot of the Breakroom Conferece Region, which is a long white open-air conference hall with slatted roof pieces for visual interest. Several brightly colored breakout areas are already installed.
A screenshot of the Breakroom Boardroom Region, which consists of a large room with organic walls and tall windows overlooking a Japanese temple. A long conference table sits in the middle of the room.
A screenshot of the Breakroom Campus Region, which is a low-poly open-air environment with four office areas connected by walkways. Multicolored trees give the surroundings texture.
A screenshot of the Breakroom Campus Large Region, which is a low-poly open-air environment with eight office areas connected by walkways. A modern trellis gazebo offers an additional seating area.
A screenshot of the Breakroom Neon Club Region, taken from behind the main bar and overlooking the dance floor. The furniture is very modern, and pink and purple neon lights add visual interest to the walls.
A screenshot of the Breakroom City Townhall Region, a low-poly city with a central columned amphitheater full of desks.
A screenshot of the Breakroom Canvas Region, which consists of a flat, circular oval stage surrounded by a low-poly forest. Tiered seating is set up on half of the stage, leaving the rest open for builds and demo objects.
A screenshot of the Breakroom Desert Island Region, consisting of areas of green grass sprouting up from an otherwise sandy landscape. Beach activities, such as a DJ station and volleyball nets, are set up around the edges of the island.
A screenshot of the Breakroom Gallery Region, which consists of an organic white office space filled with sculptures and areas of blank signage. A welcome desk and a conference table are set up.
A screenshot of the Breakroom Zone 54B Region, which features a sci-fi industrial landscape under hazy red skies. Catwalks and lighted pathways connect the various areas, while in the distance the engines of a downed spaceship jut out of the earth.
A screenshot of the Breakroom Alpine Retreat Region, which consists of a large building and associated outdoor gathering spots situated in a pine forest. Bonfires, drink stations, and other festivities light up the night.
A screenshot of the Breakroom Holiday Region, which is the Alpine Region all dressed up! Christmas trees and garlands festoon the open areas and walkways, while Santa's sleigh flies through the air overhead.
A screenshot of the Breakroom Delphi Region, which consists of a series of ruins and outbuildings spread over the Greek countryside. The light tan stone contrasts against the lush green surroundings.
A screenshot of the Breakroom Cabin Region, which consists of a warm cabin interior filled with long, communal working tables. A large fireplace and traditional artwork make the place seem homey and inviting.
A screenshot of the Breakroom Azalea Garden Region, which consists of a number of unique buildings and art installations set in a picturesque countryside. The colorful, oversized art pops against the green grass and blue sky.
A screenshot of the Breakroom Executive Boardroom Region, which consists of a polished conference table and furniture arranged on a lush brown marble floor.
A screenshot of the Breakroom Ballroom Region, which consists of luxurious white dining tables set up in front of a convenient stage.
A screenshot of the Breakroom Campfire Talks Region, a vast, almost Nordic region bounded by snowy mountains and framed by deep blue waters.
A screenshot of the Breakroom Starbase Region, which harkens back to the optimistic future depicted by old sci-fi shows. A tall aquarium fills the center space, while glass-walled staircases lead to additional meeting rooms.
A screenshot of the Breakroom Pixel Pines Region, where the candy-colored carnival games of your youth live on! A Ferris wheel takes center stage, while wide sandy avenues lead to additional rides and games.
A screenshot of the Breakroom Show Region, which consists of a news-style studio with anchor and podcaster desks surrounded by cheerful red stadium seating.
A screenshot of the Breakroom Large Stage Region, where crowds of avatars are seated around a glowing central stage with attendant screens.
A Breakroom Delphi Region card. An orange house icon in the topmost left corner indicates that this is a Default Landing Region.
Pictured: A Region card on the Dashboard. The house icon shows that this is a Default Landing Region.
A Breakroom Azalea Garden Region card. An orange signpost icon in the topmost left corner indicates that this is an Orientation Region.
Pictured: A Region card on the Dashboard. The signpost icon shows that this is an Orientation Region.
A screenshot of World Customization > Regions tab on Dashboard, featuring six Region cards.
Pictured: The Dashboard > World Customization > Regions tab.
A screenshot of the Creation Region panel. Instructions for using this panel are described below.
Pictured: The Create Region panel.
A screenshot of a Desert Island region card, with the location of the Edit Region action highlighted.
Highlighted: The Edit Region button.
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.
Pictured: A brand new Region. Note how it is not enabled, featured, or set as a Default Landing Region.
A screenshot of an example Region List window, with six Region cards and their associated buttons displayed.
Pictured: An example of how the Region List window may appear.
A closeup of the Explore window, with twelve different Region listing cards.
Pictured: The Explore window.
A Breakroom Delphi Region card. An orange star icon in the topmost left corner indicates that this is a Featured Region.
Pictured: A Region card on the Dashboard. The star icon shows that this is a Featured Region.
Pictured: The Dashboard > World Customization > Features tab.
Pictured: The Dashboard > World Customization > Features tab, "Default Scale" panel.
Pictured: The Dashboard > World Customization > Color Theme tab.
Pictured: An example of the same UI in the same Region, but with different UI color schemes.
A closeup of the Microphone and Device Options buttons located at the top of the screen. The Device Options button has been clicked, revealing two additional buttons - Mic  & Cam Test and Change Devices.
Pictured: The AV troubleshooting tools available under Device Options.
A closeup of the Audio Test panel. The UI for this panel is described below.
Pictured: The desktop viewer Audio Test panel.
A closeup of the Video Test panel. The UI for this panel is described below.
Pictured: The desktop viewer Video Test panel.
A closeup of the World Stream AV test panel. This website combines the options of the previous two panels.
Pictured: The desktop viewer AV test panel.
A closeup of the Audio settings tab under the Settings window. The UI for this window is described below.
Pictured: The Breakroom Audio Settings window.
A closeup of the World Stream Device Management panel. The UI for this panel is described below.
Pictured: The World Stream Device Management panel.
A screenshot of a user's Curator page. The Grids tab is live, listing one active World.
Pictured: The Curator World (Grids) management page.
A screenshot of the main Dashboard landing page.
Pictured: The Dashboard tab.
A screenshot of the Dashboard World Customization tab.
Pictured: The World Customization > Basic Information tab.
A screenshot of the Dashboard World Credits tab.
Pictured: The World Credits tab.
A screenshot of the Dashboard Manage Users tab.
Pictured: The Manage Users tab.
A screenshot of the Dashboard World Stream tab.
Pictured: The World Stream tab.
A screenshot of the Dashboard Integration tab.
Pictured: The Integration tab.
Pictured: The Learning Management tab.
Pictured: The Media Library tab.
A screenshot of the Dashboard Billing tab.
Pictured: The Billing tab.
A screenshot of the Dashboard Your Apps tab.
Pictured: The Your Apps tab.
A screenshot of the Dashboard Analytics tab.
Pictured: The Analytics tab.
A screenshot of the Dashboard Support Tickets tab.
Pictured: The Support Tickets tab.
A screenshot of the Dashboard Activity Log tab.
Pictured: The Activity Log tab.
Pictured: The Settings tab.
The bottom right corner toolbar, which contains five buttons. The Settings button is highlighted on the far left.
Highlighted: The location of the Settings button.
A closeup of the Settings button in the upper right corner of the Breakroom login screen.
Pictured: The Settings button on the login screen.
The Settings window Graphics tab, which contains various options to improve graphics performance. The UI for this tab is described below.
The Settings window UI tab, which contains various options to change the UI display. Five large pink buttons along the top control the scale of the UI, with 80% at the far left and 190% at the far right. The UI for this tab is described below.
The Settings window Controls tab, which contains various options to change input devices and device sensitivity. The UI for this tab is described below.
The Settings window Audio tab, which contains options to independently control the volume of different audio types and change input and output devices. The UI for this tab is described below.
The Settings window Miscellaneous tab, which contains various options related to graphics caching and viewer display. The UI for this tab is described below.
The Settings window Camera Controls tab, which contains camera behavior options that can be customized.
A screenshot of a user Inventory, with a Camera Settings Group object highlighted.
Pictured: Camera Settings Group objects, located in the Inventory window.
A screenshot of a user Inventory, with a Camera Settings Group object menu highlighted.
Pictured: Camera Settings Group objects located in the Inventory window, and the location of the Use button.
The Settings window Analytics and Marketing Preferences tab, which contains options for changing privacy and marketing preferences.
Pictured: The Dashboard > World Customization > Features tab, "Filter your Shop" panel.
Pictured: The Dashboard > World Customization > Features tab, "Currencies" panel.
Pictured: The Region Editor window, with a Breakroom Web Browser object selected. Its Inspector window is shown on the left.
Pictured: An example Inspector window.
Pictured: In local mode, the movement gizmo aligns with the width, length, and height of the object.
Pictured: In global mode, the movement gizmo aligns with the cardinal directions of the region itself.
Pictured: The Dashboard > World Customization > Avatars tab.
Highlighted: The location of the outfit name and outfit ID.
Pictured: The Dashboard > World Customization > Avatars tab, with custom avatar upload options enabled.
Highlighted: The location of the Edit Region button.
Pictured: The Region Editor UI, which consists of multiple windows and panels.
Pictured: The Objects window.
Pictured: The Objects window with the Objects type drop-down menu expanded.
Pictured: The Inspector window displayed next to a selected object.
Pictured: The Inventory window, with the location of the View button highlighted.
Highlighted: The location of the Advanced button.
Highlighted: The location of the Advanced button in the Region Editor function tray.
Pictured: The Area tab in the Region Editor Advanced window.
Pictured: The Materials tab in the Region Editor Advanced window.
Pictured: The Shop window, filtered to display the Furniture > Materials category.
Pictured: The standard 90-seat auditorium installed in the Breakroom Desert Island Region template.
Pictured: The Region Editor > Advanced window > Materials tab. This Region has one swappable material point.
Pictured: The same 90-seat auditorium, now with a wooden floor.
Pictured: The Options tab in the Region Editor Advanced window.
Pictured: The Reset Region tab in the Region Editor Advanced window.
Highlighted: The Breakroom Image Viewer access buttons.
Pictured: The Breakroom Image Viewer settings.
Pictured: The Webpage URL option in the Breakroom Image Viewer control panel.
Pictured: Settings available in the Breakroom Image Viewer control panel.
Pictured: The Region Editor, with a Breakroom Image Viewer object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Image Viewer object.
Pictured: The Breakroom Video Player control bar.
Highlighted: The location of the Breakroom Video Player gear icon.
Pictured: The Breakroom Video Player settings.
Pictured: The video URL and video settings in the Breakroom Video Player control panel.
Pictured: The Region Editor, with a Breakroom Video Player object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Video Player object.
Picured: A Breakroom Video Player set up in the Desert Island region template.
A few slider tweaks allow you to turn this...
...into this.
Pictured: The Sky editing windows.
Pictured: The Breakroom Web Browser user control bar.
Highlighted: The location of the Breakroom Web Browser gear icon.
Pictured: The Breakroom Web Browser settings.
Pictured: The webpage URL and web browser options in the Breakroom Web Browser control panel.
Pictured: The Region Editor, with a Breakroom Video Player object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Video Player object. This information also applies to Breakroom Web Browsers.
Pictured: The Breakroom Teleport Portal end user controls.
Pictured: The Breakroom Teleport Portal control panel.
Pictured: A Region tile on the Breakroom Dashboard, with the Region ID displayed.
Pictured: The Region Editor, with a Breakroom Teleport Portal object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Teleport Portal object.
Highlighted: The location of the Breakroom Info Kiosk gear icon.
Pictured: The Breakroom Info Kiosk control panel.
Pictured: The Breakroom Info Kiosk control panel contains ten separate text boxes.
Pictured: The Region Editor, with a Breakroom Info Kiosk object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Info Kiosk object.
Highlighted: The location of the Web Collab button.
Pictured: The Breakroom Web Collab tabs.
Pictured: The Inspector window for the Breakroom Games Leaderboard object.
Pictured: The Inspector window for the Breakroom Games Taskboard object.
Pictured: The Inspector window for the Breakroom Games Reward object.
Pictured: A Breakroom Games Findable object nestled in a group of bushes.
Pictured: The Inspector window for the Breakroom Games Findable object.
Pictured: A Findable object viewed through the Region Editor. Notice that the object is expanded in the Objects window and that the Findable Collider is highlighted in green.
Pictured: A Breakroom Games Clickable object superimposed on a statue.
Pictured: The Inspector window for the Breakroom Games Clickable object.
A Breakroom Games Sittable object placed on a table.
Pictured: The Inspector window for the Breakroom Games Sittable object.
Pictured: The Objects window, with a Breakroom Addon Stools set expanded and highlighted.
Pictured: The Inspector window for the Breakroom Games Photo Booth object.
Pictured: A Breakroom Photo Booth object expanded in the Object window.
Pictured: The Breakroom Tour Cameras object set up within a Region.
Pictured: The Inspector window for the Breakroom Tour Cameras object.
Pictured: The Inspector window for the Breakroom Games Explorer object.
Pictured: The Inspector window for the Breakroom Games Sightseeing object.
Pictured: The Inspector window for the Breakroom Games Trivia object.
Pictured: The Region Editor, with the location of the Start Here UI highlighted in the Objects window.
Pictured: The Orientation Quest pop-up.
Pictured: The Start Here panel.
Pictured: The Region Editor, with a Breakroom Tour Cameras object highlighted.
Pictured: The Breakroom Tour Cameras > Cameras object expanded.
Pictured: Three Zoom In cameras, two of which are active.
Pictured: An individual Pan Left Camera object being positioned within a Region.
Pictured: An individual Pan Left camera.
Pictured: An individual Zoom Out camera.
Pictured: An individual Orbit Camera.
Highlighted: The location of the "Move Object to Camera" button.
Pictured: The Region Editor, with a Zoom In Camera highlighted in the Objects window. The focal point has been isolated and manually shifted to the right of the camera track.
Pictured: An example of the ScriptingData component attached to an Orbit Camera.
Pictured: The Breakroom Tour Cameras object highlighted in the Objects Window. The RoomFurniture component has been expanded.
Pictured: The Region Editor, with a Breakroom Landmark object highlighted.
Pictured: The Breakroom Landmark Inspector window, with the RoomFurniture component expanded.
Pictured: The Areas of Interest panel.
Highlighted: Multi-zone landmarks in the Crowd Management panel.
Highlighted: The location of the Landing object in the Objects window, as well as the relevant landing pad components in the Inspector window.
Pictured: The Reactive Blooming Garden Inspector window.
Pictured: The Reactive Blooming Mushrooms Inspector window.
Pictured: The Breakroom Reactive Glitches Inspector window.
Pictured: The Breakroom Reactive Tendrils Inspector window.
Pictured: The Breakroom Reactive Rain Inspector window.
Pictured: The Breakroom Welcome Drone Inspector window.
Pictured: The Breakroom Welcome Drone > Target Follower > Follower > Voices folder expanded.
Pictured: The Breakroom Waypoint Blimp's flight path is determined by the number and location of its Waypoint Spheres. These transparent objects are located in the sky, so you may have to tilt your camera upward or pan back to work with them.
Pictured: The Low Flying Aircraft sign.
Pictured: The Breakroom Waypoint Blimp settings menu.
Pictured: The Breakroom Waypoint Whale's flight path is determined by the number and location of its Waypoint Spheres. These transparent objects are located in the sky, so you may have to tilt your camera upward or pan back to work with them.
Pictured: A Breakroom Note Board in read mode.
Pictured: A Breakroom Note Board in write mode.
Pictured: The Dashboard > Media Library tab.
Pictured: The Upload Image/Video panel.
Pictured: Media Library file details.
Pictured: The Region Editor, with the Breakroom LMS Core object highlighted in the Objects window.
Pictured: The Dashboard > Learning Management > Course > Add New Waiver window. Note the Upload Background Image button in the upper right corner.
Highlighted: The location of the waiver editing functions.
Pictured: An example waiver response window.
Pictured: The Dashboard > Learning Management > Create New Course window.
Pictured: A course card. Note the "Inactive" tag in the top right corner.
Highlighted: The location of the Edit Course Info button.
Highlighted: The location of the Notes and Add Quiz buttons.
Highlighted: The location of the Filter button and Archived List checkbox.
Pictured: The Dashboard > Learning Management > Course > Add New Quiz window.
Highlighted: The location of the quiz editing functions.
Pictured: An example of a multiple choice question.
Pictured: An example of a written response question.
Pictured: An example of a match items question.
Pictured: The Insert Link and Attach Files options for a Breakroom for Training question.
Pictured: A question with a two-minute time limit.
Pictured: The Mark Mandatory toggle.
Pictured: The Remove button.
Highlighted: The quiz administration buttons.
Highlighted: The Grade column. Buttons that say "Grade" indicate quizzes awaiting review.
Pictured: An example quiz being graded. Note the point value in the top right corner and the expanded reference answer.
Highlighted: The location of the User List button.
Highlighted: The location of the View Student List button.
Highlighted: The location of the Daily Pass button.
Pictured: The Add Daily Passes window.
Highlighted: The location of the Instructor Mode button.
Highlighted: The location of the Leave Instructor Mode button.
Highlighted: The location of the Course Info button.
A multiple choice question response graph.
A listing of written responses.
A matched pair response matrix, with correct and incorrect answers highlighted.
Pictured: The Waiver tab.
Highlighted: The location of the "Download CSV Model" link.
Pictured: A blank Breakroom CSV file open in Microsoft Excel.
Pictured: Using Google Sheets to export (download) an example file in CSV format.
Highlighted: The location of the Import Users button.
Highlighted: The location of the "Upload file" field.
Pictured: The CSV file verification message.
Pictured: The Manage Users panel.
Highlighted: The location of the Export Users button.
Highlighted: The location of the Add Users button.
Pictured: The Add Users window.
Highlighted: The "Search by status" drop-down menu and the user status column.
Pictured: The Manage Users tab on Dashboard, with the user management tools highlighted.
Pictured: A deactivated member listing. Notice how the trash can icon has been changed to an "undo" icon.
Pictured: The undo icon and the trash can icon.
Pictured: The "Search by status" drop-down menu, showing the different filtering options.
Highlighted: The location of the Self Registration toggle.
Highlighted: The Dashboard > World Customization > World Access tab, and the location of the SSO Login toggle.
Pictured: The SSO Settings > Identity Provider Setup panel.
Pictured: The IdP panel.
Pictured: Here the SSO buton has been customized, and the self registration and standard login features have been disabled. The end result is visible in the Login Screen Preview panel.
Pictured: The Region Information window > Members tab.
Highlighted: The Breakroom access buttons in the site and secondary tab headers.
Pictured: The user type selection menu, accessible through Dashboard > Manage Users > Edit user.
Pictured: The Dashboard > Manage Users tab.
Highlighted: The location of the Syllabus button.
Highlighted: The Syllabus Type toggle.
Pictured: The Syllabus editing panel.
Highlighted: The location of the syllabus editing functions.
Pictured: The Action drop-down menu.
Pictured: An example event listing in Eventbrite.
Highlighted: The location of the Account settings page on Eventbrite.
Highlighted: The API Keys tab, as well as the location of the "Create API Key" button.
Pictured: The Eventbrite API key request page.
Pictured: An example of how your API key may appear once generated, with the private token key highlighted.
Pictured: The Dashboard > Integration tab.
Pictured: The Webhooks tab on Eventbrite, with the Add Webhook button highlighted.
Pictured: The Eventbrite "Add Webhook" page.
Highlighted: The location of the World Stream toolbar.
Pictured: An example of text highlighted within a Breakroom World Stream session.
Highlighted: The location of the Clipboard button.
Highlighted: The location of the Preferences button.
Pictured: The World Stream Preferences > Regional settings tab.
Pictured: The World Stream Preferences > Performance tab.
Pictured: A completely non-functioning system, as seen in a general AV troubleshooting test.
Pictured: The Chrome settings > Privacy and security tab, with the location of the Camera and Microphone permissions for breakroom.tech highlighted.
Pictured: The Chrome settings > Privacy and security > Site settings tab, with the location of the Camera and Microphone permissions highlighted.
Pictured: The Pre-allocation request panel.
Pictured: The Add Credits panel.
Pictured: An example of how the World Credits tab may appear.
Pictured: An example combined World Credit transaction history and usage report.
Pictured: The Manage World Stream Usage panel.
Highlighted: The "Change my World Stream server type" link.
Highlighted: The Monthly Purchase Limit section of the World Credits tab.
Highlighted: The location of the Download App button.
Pictured: The Dashboard > Your Apps tab.
Pictured: An example macOS permission pop-up.
Pictured: The Privacy & Security > Microphone settings in macOS.
Pictured: The Sound > Input settings in macOS.
Pictured: The Sound > Output settings in macOS.
Pictured: An example of a basic analytics report.
Pictured: The Dashboard > Analytics tab.
Pictured: An example Privacy Policy.
Pictured: An example EULA.
Pictured: The World Customization > Basic Information > Data collection panel.
Pictured: An example of the Take World Offline window.
Pictured: Example settings for an offline World.
Pictured: VOIP options available through the Region Information window.
Pictured: The RoomFurniture component for a Breakroom Voice Zone object, with the Zone Type property highlighted.
Pictured: An example of a voice zone boundary indicator. This user will need to move inside the boundary indicator if she wants to be heard by others in the breakout room.
Pictured: A voice zone set up around an info desk, currently visible through the Region Editor (the green cube).
Pictured: An example of a voice zone boundary indicator. This user will need to move inside the boundary indicator if she wants to be heard by others in the breakout room.
Pictured: A breakout area being added to a Region.
Pictured: The Objects and Inspector windows. Notice how the highlighted Breakroom Breakout Area A object is tagged with both its Zone ID and Zone Name.
Pictured: The RoomFurniture component, expanded to display all 15 fields.
Pictured: An example Breakout Rooms panel.
Pictured: An avatar seated in an audience seat. Note the Gestures and Camera View panels on the left side of the screen.
Highlighted: The static audience camera selected in Region Editor. Notice how the Workshop object has been expanded in the Objects window.
Highlighted: The location of the Move Object to Camera button.
Pictured: A Breakroom Conference Region viewed in the Region Editor. Notice how transparent green boundary objects surround the three breakout areas in back.
Highlighted: The Breakroom Voice Zone objects in a user's Inventory.
Pictured: The zone collider highlighted in the Objects window. Notice how the movement gizmo is centered within the boundary object.
Pictured: The screen component highlighted within the Objects window.
Pictured: The landing pad highlighted within the Objects window.
Pictured: All cameras highlighted within the Objects window. Notice how you can expand the Cameras object to select individual cameras.
Pictured: The future site of much coffee and networking.
Pictured: The Breakroom Add-on Stools object, as viewed through the Region Editor.
Pictured: An individual stool object and its Inspector window.
Highlighted: The set of six visible stools.
Pictured: A Breakroom Voice Zone Round object in the Region Editor.
Pictured: The voice zone, rotated so that the screen component is in a more convenient location.
Highlighted: The landing component.
Pictured: The zone collider resized to create a smaller, more contained space for voice chatting.
Pictured: The screen highlighted in the Objects window, and its associated ScriptingData component expanded in the Inspector window.
Highlighted: The voice zone cameras, as well as the conference system camera panel.
Highlighted: The location of the landing pad object in the Objects window, as well as the relevant landing pad components in the Inspector window.
Pictured: The Areas of Interest panel.
Highlighted: The location of the Broadcast messages button.
Pictured: An example Region broadcast message.
Pictured: An example direct broadcast message.
Pictured: An example direct yes-or-no broadcast message.
Pictured: An example input response message.
Pictured: An example broadcast message with an associated timer.
Highlighted: The expanded moderator tools, with an arrow pointing to the Maximize button.
Pictured: The fully expanded moderator tools.
Pictured: The Start Here UI.
Pictured: Here a keynote speaker is standing in one of the presenter seats in a Presenter zone, and is able to share her screen.
Pictured: An example of how a Presenter or Audience zone might appear, with five presenter seats set up on a stage.
Pictured: An example of the default Breakroom Helpdesk setup.
Pictured: The Breakroom Addon Presenters object added to a Region, with its contents expanded in the Objects window.
Pictured: Nine standing presenter seat tags reduced to two.
Pictured: An individual presenter seat being isolated and edited in the Region Editor.
Pictured: The Crowd management panel.
Pictured: An example Duplicate Zone Name warning, with beacons turned on.
Pictured: An example Inspector window, with three components listed for the selected object.
Pictured: The RoomFurniture component, expanded to display all 15 fields.
PIctured: An example of two nested voice zones in the Region Editor, with the smaller one highlighted.
Highlighted: The location of the Colors component.