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
    • 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
  • Importing and exporting user lists
  • Downloading a blank CSV file
  • Opening and editing a CSV file
  • Uploading a CSV file
  • Exporting existing users as a CSV file
  • Adding individual users
  • Assigning user types
  • Managing user status
  • Activating and deactivating users
  • Enabling self-registration
Export as PDF
  1. OPENING THE DOORS

Creating and managing user accounts

The Metaverse couldn't exist without the creativity and talents of its users. Learn how to add users via CSV file upload or manual account creation, and watch your Breakroom World come to life.

PreviousSeats and concurrencyNextWorld-level user permissions

Last updated 11 months ago

Overview

There are a number of ways that you can invite users to join you in Breakroom. You can:

Importing and exporting user lists

Downloading a blank CSV file

You can download a fresh, unpopulated CSV file by clicking on the file link below.

You can also download an unpopulated CSV file directly from the Dashboard. Click on the Manage Users tab, and then click the Import Users button. The Import Users window will appear. Click on the link that says "Download CSV Model," and save the file to your computer.

Opening and editing a CSV file

You can open and edit CSV files using any commonly available spreadsheet software, such as Microsoft Excel or Google Sheets. When you open a blank Breakroom CSV file, you will see a series of fields where you can enter required or optional information.

Required information includes:

  • Email address: This should be an email address to which the user has full access, in case they need to change their password.

  • Password: This should be a complex, unique password of six or more characters.

Usernames can contain a maximum of 32 characters. Only alpha-numeric characters, spaces, underscores, periods, and dashes can be used. If you do not enter a custom username, one will be auto-generated from the user's display name.

Optional fields include:

  • Title: This is optional information that will also appear in the hover tag displayed above the user's avatar, as well as in their profile. For instance, you might use this field to identify a "Senior Delegate," or make it something fun like "Metaverse Wanderer."

  • Job Title: This refers to the user's actual job title. If you supply this information, it will be displayed in the user's hover tag and in their profile.

  • Company: The company the user works for. If you supply this information, it will also be displayed as described above.

Once you've entered the minimum required user data, you will need to save or export the document in CSV (.csv) format. You can change the document name if you like.

Uploading a CSV file

To upload a CSV file, navigate to the Manage Users tab of your Dashboard and click the Import Users button.

In the Import Users window that appears, click the "Upload file" field. This will launch a standard file import window on your computer. Locate the CSV file you want to upload, click on it, and then click the Open button.

If your CSV file contains any errors, the document will be rejected and those errors will be highlighted so you can make the necessary corrections. If no errors are detected, you will see the "CSV file verification succeeded" message displayed in the image above. Click the Import CSV button to continue.

Once you've successfully imported your users, you will see them listed under the Manage Users panel. You can click the pencil icon located next to a user's name to manually edit their information, or click the trash can icon to remove them from your user list altogether.

If you need to locate a particular user or set of users, you can also make use of the following functions:

  • The search field in the upper left corner allows you to search for a name, email address, or specific user ID.

  • The "Search by status" drop-down menu allows you to display only those users who have a particular status (e.g. active, pending, etc.).

  • The "Select user type" drop-down menu allows you to display only users of a certain type (e.g. World Administrators, World Developers, etc.).

Exporting existing users as a CSV file

To download a CSV file containing all of your current user information, click the Export Users button.

Adding individual users

Adding a user to your roster manually is as simple as filling out a text form. To begin, navigate to the Manage Users tab on your Dashboard and click the Add Users button.

If you want to add more than one user during a single session, click the plus icon in the bottom left corner to generate an additional set of user information fields. When you are finished keying in your user data, click the Add User button.

Assigning user types

Managing user status

In addition to a user type, each user is also assigned a status. You can use the "Search by status" drop-down menu to display only the users assigned that particular status, and to narrow down your search for a specific user.

The status types are:

By default, inactive users will not be displayed in your user list. To see your Inactive users, please use the "Search by status" drop-down menu to select the All or Inactive option.

Activating and deactivating users

To deactivate an individual user, click on the trash can icon located to the right of their name. The trash icon will then change to an undo icon. To reactivate the user, click the undo icon.

To deactivate or activate multiple users at once, check off each relevant name in your user list and then click the trash can icon or undo icon located in the top right above the user list.

If a user seems to disappear from your user list when you deactivate them, make sure that the "Search by status" drop-down menu is set to show All users or Inactive users. If it is set to any other option, you may not see your full user list.

Enabling self-registration

You can enable or disable self-registration from your Dashboard by following the steps below.

  1. Click on the World Customization > World Access tab.

  2. Click the Self Registration toggle to enable or disable self-registration.

Create multiple user accounts simultaneously by

Create user accounts one at a time by manually

Allow users to the first time they visit your World

Enable your existing service

Finally, if you're hosting a free or for-cost ticketed event in Breakroom, you'll want to take advantage of to make logistics a snap.

Only and can access the Dashboard.

CSV files, or comma-separated values files, are spreadsheets containing relevant user account information. Uploading a populated CSV file will create an account for each user listed on the spreadsheet, complete with password. You can also include important institutional information about each user, which may be displayed in their or in-world hovertext (the identifying text that appears above each avatar's head).

Display Name: This is the name that serves to identify the user while they are in-world. It will appear in the identification tag that hovers over the user's avatar, as well as in the user's . Display names can be changed at any time by the World Owner or a World Administrator.

Username: This is a permanent username that serves to identify the account. It can also be used in place of the user's email address during the login process on the .

Type: This field should contain the user's type. (If you do not enter a value in this field, the user type will default to .)

The Add Users window will appear. To create a new user account, you will need to provide at least a Display Name, Username, email address, and password. You'll also need to choose a .

User types correspond to , and can be changed by clicking the pencil icon located to the right of a user's name and then selecting the type to be assigned. A detailed explanation of the different user types and for assigning or revoking World-level user permissions are also available.

Active: The user's account is active and accessible to the user. They can log in to your World. If you have assigned them advanced , they have access to the virtual tools they need (e.g. Curator).

Inactive: The user's account information is preserved, but they cannot currently log in to your World. See the section that follows for more information about .

Pending: The user's account is pending activation, and they have not yet logged in. This may be due to a lack of available .

Users can be deactivated individually or in bulk. When a user is deactivated, they will still appear under the Manage Users tab, with their user status changed to Inactive. They will no longer be able to log in, and will no longer take up one of your account's .

When you reactivate an inactive user account, the account will default to Pending status and Guest type. You will need to update their manually.

When self-registration is enabled, users who access your World through or a dedicated can sign up for their own account. Each user registration will take up one of your available , and users will be given the opportunity to pick a from your default avatar collection.

Navigate to your .

If self-registration is disabled, you will need to import or manually create user accounts using the steps outlined , or .

single sign-on (SSO)
Eventbrite integration
user profile
profile
desktop viewer
user type
World-level user permissions
seats
seats
World-level user type
World Stream
desktop app
seats
starter avatar
Dashboard
uploading a CSV file
editing your user records
register their own account
activating and deactivating users
enable SSO
above
World-level permissions
World-level user permissions
World Owners
World Administrators
Guest
step-by-step instructions
107B
Breakroom CSV 2024.csv
Highlighted: The location of the "Download CSV Model" link.
Pictured: A blank Breakroom CSV file open in Microsoft Excel.
Pictured: Using Google Sheets to export (download) an example file in CSV format.
Highlighted: The location of the Import Users button.
Highlighted: The location of the "Upload file" field.
Pictured: The CSV file verification message.
Pictured: The Manage Users panel.
Highlighted: The location of the Export Users button.
Highlighted: The location of the Add Users button.
Pictured: The Add Users window.
Highlighted: The "Search by status" drop-down menu and the user status column.
Pictured: The Manage Users tab on Dashboard, with the user management tools highlighted.
Pictured: A deactivated member listing. Notice how the trash can icon has been changed to an "undo" icon.
Pictured: The undo icon and the trash can icon.
Pictured: The "Search by status" drop-down menu, showing the different filtering options.
Highlighted: The location of the Self Registration toggle.