Customizing the UI

Control the information and tools available to your users by building a custom Breakroom UI. We'll show you how to toggle the UI options, and explain the impact your end users may experience.

Overview

As noted on our UI orientation page, Breakroom's UI, or user interface, contains the tools your users need to navigate and participate in your world. World Owners have the option to enable or disable the basic UI components at any time through the Dashboard.

In the following sections, we will discuss how removing certain UI components may impact the virtual world experience for your end users. You will also learn how to customize the Breakroom UI settings.

End user impact

The following UI components can be toggled on or off via the Dashboard. The location of each UI component is documented on our UI orientation page.

Here's how removing each UI component may affect your users.

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 zones 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 browse through your world's regions and teleport directly to them.
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 manage and use the 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 Breakroom 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.
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.

Enabling or disabling UI functions

To enable or disable UI features, follow these steps.

1. Navigate to your Dashboard.

2. Click on the World Customization tab.

3. Click on the Features tab.

4. Uncheck the boxes on any UI features that you wish to remove from the viewer.

5. Click the Save Changes button.

Changing the default UI scale

The Default Scale customization panel.

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

To change the default UI scale, please follow the steps below.

1. Navigate to your Dashboard.

2. Click on the World Customization tab.

3. Click on the Features tab.

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

5. Click the Save Changes button.

An example of the same UI in the same region, with scale set to 100% and 130% respectively.

Users can also adjust the UI scale to meet their specifications through the in-world Settings panel.

Customizing the UI colors

The UI Color Setting customization panel. Note the active color picker under the Text Color 2 field.

Breakroom's UI Color Setting panel allows you to customize the UI color scheme at any time. 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 world.

To change the UI colors, please follow the steps below.

1. Navigate to your Dashboard.

2. Click on the World Customization tab.

3. Click on the Color Theme tab.

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

5. Once you are satisfied with your changes, click the Save Changes button.

An example of the same UI in the same region, with different UI color schemes.