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

Breakroom's UI, or user interface, consists of informational displays and tools that users need to participate in your World. World Owners and World Administrators have the option to customize the basic UI components at any time through the Dashboard, including changing the UI scale and color palette.

Enabling or disabling UI functions

Pictured: The Dashboard > World Customization > Features tab.

To enable or disable UI features, follow these steps.

1. Navigate to your Dashboard.

2. Click on the World Customization > Features tab.

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

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

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

Changing the default UI scale

Pictured: The Dashboard > World Customization > Features tab, "Default Scale" panel.

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

2. Click on the World Customization > Features tab.

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

4. Click the Save Changes button.

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

Pictured: The Dashboard > World Customization > Color Theme tab.

To customize the UI colors, follow these steps.

1. Navigate to your Dashboard.

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

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

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

Pictured: An example of the same UI in the same Region, but with different UI color schemes.