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
  • Opening the Settings window
  • Graphics settings
  • UI settings
  • Controls settings
  • Audio settings
  • Miscellaneous settings
  • VR settings
  • Camera Controls settings
  • Profile settings vs. global settings
  • Saving camera profiles
  • Loading camera profiles
  • Resetting the camera profile to default
  • Analytics and Marketing Preferences settings
Export as PDF
  1. GETTING STARTED

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.

PreviousUsing Breakroom for TrainingNextLanguage and accessibility

Last updated 10 months ago

Overview

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.

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:

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.

UI settings

Setting

Function

Interface size buttons

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

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.

Setting

Function

"Click to walk" option

"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

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

Audio settings

Miscellaneous settings

The Misc tab allows you to enable or disable additional functions within Breakroom.

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

"Enable Voice" option

"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

"Prompt on Mouselook" option

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

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.

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.

The UI tab allows you to customize certain aspects of .

These buttons let you reduce or increase the size of the elements that frame your screen.

World Owners can make global changes to the default UI scale by visiting the World Customization tab on the .

This option toggles the feature.

This option allows you to inverses the Y axis while in .

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 .

This option lets you enable or disable all browser surfaces in-world. This includes the and . Generally, we do not recommend turning this off.

This option enables or disables completely.

This option enables or disables the camera tips that pop up when you pass your mouse over the .

This option enables or disables the prompt that appears when you use your mouse scroll wheel to transition into .

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.

Breakroom's UI
Dashboard
desktop application
advanced computer equipment
mandate
reset
saved
loaded
global camera settings
Breakroom UI
Breakroom web browser
Slido integration
desktop viewer
World Stream
real-time tests
click to walk
in-world email
voice chat
settings toolbar
switch between active devices
Highlighted: The location of the Settings button.
Pictured: The Settings button on the login screen.
Pictured: Camera Settings Group objects, located in the Inventory window.
Pictured: Camera Settings Group objects located in the Inventory window, and the location of the Use button.
The bottom right corner toolbar, which contains five buttons. The Settings button is highlighted on the far left.
A closeup of the Settings button in the upper right corner of the Breakroom 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.
A screenshot of a user Inventory, with a Camera Settings Group object menu highlighted.
The Settings window Analytics and Marketing Preferences tab, which contains options for changing privacy and marketing preferences.
mouselook
mouselook