Installing the conferencing package furniture item

When you upload a custom region to Breakroom, you will need to install the conferencing system to achieve full functionality. Learn how to set up voice zones, teleport menus, and more.

Overview

In this walkthrough, we will take a completely blank region and set up the Breakroom conference system from scratch, with all the tools necessary to run an event. By following the steps below, you can install the conference system in any custom region that you have uploaded.

A completely blank conference region, with no Breakroom systems currently installed.

Extracting the conference furniture bundle

If you have a Developer seat in Breakroom, you will have received the Breakroom Conference Bundle. This item contains all the tools required to set up a fully featured conference system in your region.

You can locate this package in the Inventory, under the Furniture heading.

The location of the Inventory button, and an example of an open inventory window.

To open the Breakroom Conference Bundle, click on it in your inventory. A menu will appear. Click the Use button to extract the bundle contents.

The location of the "Use" button.

After the bundle has finished extracting, you will see a number of new items appear in your inventory. These are the different conference system elements, and you will use them to install the conference system in your region.

Icons depicting Breakroom components from both the Starter Pack and Conference Pack.

The items included in the Breakroom Starter Pack are covered here. The items included in the Conference Bundle will be discussed in more detail below.

The core conference system

The core conference system contains four key components:

Breakroom combined media core

The combined media core icon.

The Breakroom combined media core is the backbone of the entire conferencing system, and is a required for the conferencing system to function. It contains Breakroom's primary tools, such as voice chat, webcam and screen sharing capabilities, and the stage manager system.

Breakroom camera system

The camera system icon.

The Breakroom camera system controls all of the camera operations in the conference system. For example, when sitting on a seat guests will see a camera menu that allows them to select a different camera view.

Breakroom gesture system/gestures standard

The gesture system icon.

The Breakroom gesture system controls all the gesture actions within the conference system. For example, when sitting in a seat guests will see a gesture menu offering them access to different emotes and animations.

Breakroom navigation UI

The navigation UI icon.

The Breakroom navigation system controls the navigation and teleport menus in Breakroom. Guests will be able to travel to different locations in your region by clicking different quick link buttons.

Breakroom auditorium

The auditorium icon.

Finally, the standard 90-seat auditorium that features in several of Breakroom's default region templates is included for your use. This component is optional.

Installing the core components

The Room Editor in an empty region, with the Inventory and Objects windows open.

To install the core components in an empty region, follow the steps below. For more information about using the Room Editor or editing objects via the Room Editor, please consult the linked documentation.

  1. Click on the Edit Room button at the bottom of the screen.

  2. Click on the Inventory button located on the bottom right to open the Inventory window.

  3. For each of the following components, drag them from the Inventory window to the floor near your avatar. This will install them in the region.

    1. Breakroom Combined Media Core.

    2. Breakroom Gestures Standard.

    3. Breakroom Camera System.

    4. Breakroom Navigation UI.

The four key components of the conferencing system, highlighted in an example inventory.

The positioning of these components is not important. However, to keep things tidy, it is best practice to position them at 0/0/0. To reposition an object, follow these steps.

  1. While still in the Room Editor, click the Objects button located on the bottom right.

  2. Click the > arrow on the Room Floor heading to expand it.

  3. Click on one of the four core components under the Room Floor heading (for example, the Breakroom Combined Media Core). This will launch the Inspector window for that object.

  4. In the Inspector window, click the > arrow next to Transform component to expand it.

  5. Locate the Local Position component. Set each field to the numeral 0, for a combined position of 0/0/0.

  6. Repeat these steps for each of the components.

  7. When complete, hit the Save button to store your changes.

The Objects and Inspector windows, with the Local Position component highlighted.

After you are done installing and editing the core components, click the Save button, followed by the Close button. You will notice that the main control panel, navigation panels, and stage manager panels are now available at the top and side of your screen. This completes the basic setup of the main conference components. You can now edit and configure those components to meet your needs.

Setting up the default auditorium

We have simplified the setup of some common areas. This includes a 90-seat auditorium with built-in camera and screen positions, as well as its own presenter voice zone. You can install this in your region by following these steps.

  1. Click on the Edit Room button at the bottom of the screen.

  2. Click on the Inventory button located on the bottom right to open the Inventory window.

  3. Drag the Breakroom Auditorium 90 object to the floor near your avatar. This will install it in the region.

  4. Click the Save button.

The "Breakroom Auditorium 90" object placed in a region, as viewed through Room Editor.

We can now use the movement and rotation tools in the Room Editor to position our auditorium as necessary. When positioning is complete, click Save to store your changes.

The default auditorium component, successfully positioned within the auditorium area.

Editing the presenter seats

The 90-seat auditorium is configured to work "out of the box," with the conference system's voice, webcam and screen sharing, and navigation functions built in. After positioning the entire auditorium object, the only thing you'll need to do is edit the presenter seats to meet your needs. In a presenter zone, only the individuals who sit on the presenter seats will be able to share their webcam or screens.

The Breakroom Combined Media Core, highlighted in the Objects window.

To edit the presenter seats, follow the steps below.

  1. While still in the Room Editor, click the Objects button located on the bottom right.

  2. Click the > arrow on the Room Floor heading to expand it.

  3. Locate the Breakroom Combined Media Core object. Click the > arrow next to it to expand it.

  4. Locate the Breakroom Media Sharing Combined object. Click the > arrow again to expand it.

  5. Locate the Presenters object and click on it. This will launch the Inspector window.

  6. Selecting this object will also isolate and highlight it within the region.

The location of the Presenters object, highlighted in the Objects window.

You can now move the presenter seats to your desired location by hand-keying values into the Transform component (as detailed above), or by using the Room Editor positioning tools. When you're happy with your changes, make sure to click the Save button.

The Presenter seats, highlighted in the Room Editor.

Presenter seat hints

Testing position with a live avatar

If you sit on one of the presenter seat tags while the Room Editor is closed, then open the Room Editor while remaining seated, your avatar will travel with the presenter seat tags when you position them. This is a useful quality check to ensure that your avatar is facing the right way and isn't sinking into the floor.

An avatar "seated" on a presenter seat while in Room Editor. Note the translation gizmo.

Disabling unneeded seats

The conference system comes with 5 presenter seats as standard. You can disable any seats you don't need by following these instructions.

The Presenters object, highlighted and expanded in the Objects window.
  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located on the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the Breakroom Combined Media Core object. Click the > arrow next to it to expand it.

  5. Locate the Breakroom Media Sharing Combined object. Click the > arrow again to expand it.

  6. Locate the Presenters object. Click the > arrow again to expand it.

  7. Click the eye icon located to the right of any presenter seat you do not wish to appear in-world. In the example image above, seats two through five have been disabled, leaving one presenter seat.

  8. Click the Save button to store your changes.

Presenter seats can only be located in one area per voice zone at the present time (i.e. one group of seats per region).

Setting up breakout rooms and voice zones

Breakroom's prefab breakout rooms and booths, like the 90-seat auditorium discussed above, come pre-equipped with seats, gestures, voice zones, and teleport UI functionality. These convenient virtual areas are designed to set themselves up; all you need to do is add them to your region using the Room Editor. You can learn more about installing and customizing prefab breakout areas by consulting this page.

Custom voice zones are blank voice zones that can be placed wherever you like in your region. They can contain any items or regional features you choose, and can even be nested. You can edit the RoomFurniture component so they appear in the breakout room teleport menu, or you can direct the general navigation menu to teleport users to a custom voice zone by following the instructions below.

A round and square voice zone, being edited in the Room Editor.

Customizing the general navigation menu

The general navigation menu gives your guests the ability to teleport to different areas within your region with the click of a button. If seats are available within that area, teleporting will also automatically assign users a seat.

The buttons names, from left to right, are:

Button

Default target location

Audience

Teleports your avatar to the auditorium.

Information

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

Removing buttons from the menu

You can remove one or more buttons from the general navigation menu by following these steps.

The Objects window, visible within Room Editor, with the general navigation buttons highlighted.
  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located on the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the Breakroom Navigation UI object. Click the > arrow next to it to expand it.

  5. Locate the Crowd Manager Navigation UI object. Click the > arrow again to expand it.

  6. Locate the Canvas object. Click the > arrow again to expand it.

  7. Locate the General Navigation object. Click the > arrow again to expand it.

  8. Click the eye icon located to the right of any button you do not wish to appear in the menu.

  9. Click the Save button to store your changes.

  10. Click the Reset Zones button to reset the conference system.

Changing the landing zones

The landing zones that these buttons point to can be changed, either by repositioning the link objects within Room Editor or by editing a voice zone's RoomFurniture component. Simply follow the steps below for the method that you prefer.

The Objects window, visible within Room Editor, with the landmarks location highlighted.
  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located on the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the Breakroom Combined Media Core object. Click the > arrow next to it to expand it.

  5. Locate the Crowd Manager Core object. Click the > arrow again to expand it.

  6. Locate the Landmarks object. Click the > arrow again to expand it.

  7. Click on the name of the landmark you would like to move (e.g. "Entrance").

  8. Physically position the landmark object within the region using the Room Editor tools, or by entering the appropriate values in the Transform component in that object's Inspector window, as detailed above.

  9. Click the Save button to store your changes.

  10. Click the Reset Zones button to reset the conference system.

The invisible Entrance landmark object being moved. Note the translation gizmos.

Editing the RoomFurniture component

The Objects and Inspector window in Room Editor, with a custom voice zone selected.

Using this method, you can point any general navigation button to a custom voice zone or a prefab breakout area of your choice. Just follow these steps.

  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located on the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the voice zone or prefab breakout area you want to edit, and click on it. The Inspector window will launch.

  5. In the Inspector window, click on the > arrow next to the RoomFurniture component to expand it.

  6. Locate the Zone Name field. Type in the name of the general navigation button you would like to point to the voice zone (e.g. Auditorium, Entrance, Networking, or Floor).

  7. Click the Save button to store your changes.

  8. Click the Reset Zones button to reset the conference system.

If a voice zone or breakout area has been given a custom Zone Name, this will override the general navigation link objects described above. There is no need to disable them. However, if you would like to use the link object system again, you will need to rename any voice zones or breakout areas using the Auditorium, Entrance, Networking, or Floor names.

Advanced navigation system configuration

Breakroom's navigation system is made up of three separate components.

  • The general navigation menu, located in the top left corner of the screen, is attached to several landmark objects built into the conference system. By editing the position of these landmark objects (or assigning their names to separate objects), your guests can teleport to those locations using the available buttons. This editing process is described above.

  • The breakout room teleport menu is located in the top right corner, and will display a teleport button for any voice zone that includes the prefix "Breakout" in its Zone Name field -- for example, Breakout 1, Breakout 2, etc. Prefab breakout areas will automatically add themselves to the navigation bar when you place them in your region, but you can also add areas to the navigation bar manually by editing the breakout area or voice zone's Zone Name. You can find instructions for doing so here and more technical details here.

In addition to the general navigation and the breakout room teleport menus, Breakroom's navigation system contains a third component: the areas of interest navigation menu.

An example of the areas of interest navigation menu, located next to the stage manager controls.

This menu is disabled by default, and is located on the right side of the screen when activated. The areas of interest navigation menu can contain teleport links to any voice zone that has the Zone Visible option enabled in the RoomFurniture component. Zones already linked in the general navigation menu or breakout room teleport menu will be ignored by the areas of interest menu. This makes it a flexible solution for offering additional teleport options to your users.

When speaking about these three navigation menus in aggregate, two new options emerge for advanced region configuration:

  • Removing menus from the region entirely.

  • Activating and customizing the areas of interest navigation menu.

Removing menus from a region

The Objects and Inspector windows in Room Editor, with the Breakroom Navigation UI object selected.

To enable or disable the three individual menus that make up Breakroom's navigation system, follow these steps.

  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located at the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the Breakroom Navigation UI object and click on it. The Inspector window will launch.

  5. In the Inspector window, click on the > arrow next to the RoomFurniture component to expand it.

  6. You will see three fields listed under the RoomFurniture component:

    1. Navigation Breakouts: This refers to the breakout room teleport menu.

    2. Navigation General: This refers to the general navigation menu.

    3. Navigation Others: This refers to the areas of interest navigation menu.

  7. If you want a menu to appear in your region, type "yes" into the corresponding field. If you want to remove a particular menu from your region, type "no" into the field.

  8. Click the Save button to store your changes.

  9. Click the Reset Zones button to reset the conference system.

The areas of interest navigation menu

The Objects and Inspector window in Room Editor, with a voice zone object selected.

If you choose to make the areas of interest navigation menu visible to your users, you can follow the instructions below to populate it with clickable teleport links.

  1. Click on the Edit Room button at the bottom of the screen.

  2. Click the Objects button located at the bottom right.

  3. Click the > arrow on the Room Floor heading to expand it.

  4. Locate the breakout area or voice zone object you want to include under areas of interest, and click on it. The Inspector window will launch.

  5. In the Inspector window, click on the > arrow next to the RoomFurniture component to expand it.

  6. There are two key fields listed under the RoomFurniture component that you will need to edit:

    1. Zone Name: This is the name of your area, and the name that will appear in the corresponding teleport button in the areas of interest navigation menu.

    2. Zone Visible: This field governs whether the zone is added to the areas of interest navigation menu. Type "true" into the field if you want the zone to be added to the menu. Type "false" into the field if you want to remove the voice zone from the menu.

  7. Click the Save button to store your changes.

  8. Click the Reset Zones button to reset the conference system.