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

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

On this page
  • Overview
  • Enabling or disabling UI functions
  • End user impact
  • Changing the default UI scale
  • Customizing the UI colors
Export as PDF
  1. CREATING CUSTOM EXPERIENCES

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.

PreviousBranding toolsNextFiltering the Sine Wave Shop

Last updated 2 months ago

Overview

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.

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.

Component

End user impact if disabled

Chat button

Hot Bar

People button

Explore button

Meetings button

Inventory button

Outfit button

Shop button

Snapshot button

Mini map

Quests

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

Currency

Email

Auction

Users will not be able to sell or purchase Shop items via auction.

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.

Navigate to your .

Users will not be able to access , and will be limited to using local to communicate with one another.

Users will not be able to Inventory items for quick deployment.

Users will not be able to open the , which allows them to locate other users and message them directly. They will also lose access to their .

Users will not be able to open the , which allows them to

locate and teleport to .

Users will not be able to open the , or see the posted event schedule.

Users will not be able to open the , which allows them to access any in-world items they have collected or purchased.

Users will not be able to open the , which means they will not be able to edit their avatars and may lose some clothing and avatar component customization options.

Users will not be able to access the .

Users will not be able to open the in order to take pictures of their avatars or your virtual event.

Users will not see the in the upper right corner of their screens, and will lose access to additional functions such as .

Users will not have access to the , where they can track their progress on any quests they've started.

Users will not see how much Gold they have or the button that allows them to purchase additional Gold . They will only see how much Silver currency they have.

Users will not see their current Gold or Silver holdings displayed at the top of the screen.

Users will not be able to send or read emails sent by other people.

Navigate to your .

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

Navigate to your .

Dashboard
Dashboard
Dashboard
People window
Groups list
Explore window
Meetings window
Outfit window
Sine Wave Shop
Snapshot window
Quest window
UI
World Owners
World Administrators
Settings panel
equip
text chat
voice chat
Breakroom emails
Inventory window
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.
bookmarks
Featured Regions
mini map
currency
currency