# Groups

{% embed url="<https://youtu.be/vckdoReN9-o?feature=shared&t=8>" %}

## Overview

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2Fv9WbWI3JYE65J4o0qVhn%2FGroups_001.jpg?alt=media&#x26;token=05f5a9b9-f652-434d-a52d-1818f08bd326" alt="A closeup of the Groups window, with two groups listed." width="275"><figcaption><p>Pictured: The combined People and Groups window.</p></figcaption></figure></div>

Groups serve several functions in Breakroom, including:

* Casual and professional networking
* Streamlining the invitation process for [private meetings](https://docs.breakroom.tech/using-the-meetings-window#scheduling-meetings)
* Region [access control](https://docs.breakroom.tech/building-new-worlds/region-settings#controlling-region-access)

The Groups window lists all of your current groups. You can search for a particular group using the **search field** located at the top of the window.

{% hint style="info" %}
World Owners and World Administrators can [enable and disable parts of the UI](https://docs.breakroom.tech/creating-custom-experiences/ui-customization-options) via the [Dashboard](https://docs.breakroom.tech/building-new-worlds/breakroom-dashboard-tour). You may not have access to every function described in this section.
{% endhint %}

## Opening the Groups window

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2F5kRf3q45P4w5wrE2gMe9%2FPeople_002.jpg?alt=media&#x26;token=8de53dd2-435c-4631-b3cc-6194492b239c" alt="A closeup of the bottom toolbar of the Breakroom UI. This toolbar includes buttons for in-world text chat and navigation. The People button is highlighted in orange."><figcaption><p>Highlighted: The location of the People button.</p></figcaption></figure></div>

You can open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.

### Accessing group information

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FprMdUnyDKsOmmsLtDJ8u%2FGroups_002.jpg?alt=media&#x26;token=101d0f28-bcd6-48d6-899f-586acc828d5b" alt="A screenshot of a user&#x27;s group list and a Group Information window displayed side-by-side." width="563"><figcaption><p>Pictured: A user's group list and an example Group Information window.</p></figcaption></figure></div>

If you belong to a group, clicking on its **name** will open the Group Information window. In addition to reviewing details about the group under the Info tab, you can click the **"Chat in the group" button** to begin a global [text chat](https://docs.breakroom.tech/getting-started/communicating-with-other-users#text-chat) with all online members.

If you have the appropriate [permissions](#assigning-group-roles), you may also see an **Edit button** in the Info tab > Permissions section. Clicking this button will allow you to make changes to the group's name, description, and [group access type](#group-access-types).

## Finding and joining existing groups

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FkjmhbIpY94ibaeYByol2%2FGroups_003.jpg?alt=media&#x26;token=9f77f2c5-d9d1-4cca-98ea-0386183cb2a8" alt="A closeup of the top toolbar search field, with two results returned for a group search." width="226"><figcaption><p>Pictured: A group search with two results returned.</p></figcaption></figure></div>

If you know the name of a group you want to join, you can search for it using the **search field** in the [top toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-top-toolbar). If you like, you can filter the search results by checking the **Refine Search > Group option.**

Once you've found the right group, click the **Detail button** to open the Group Information window. Then click the **"Apply to join" button**. If the group is set to Public access, then congrats—you're officially a member! If the group is set to Contact Only or Approved Only access, your application will be submitted for [review](#approving-group-applicants).

## Creating a group

If you want to create a new group, [open the Groups window](#opening-the-groups-window) and click the **Create New Group button.** This will open the Groups dialog box.

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FX2Kjg1RNdGZYPkojPbEH%2FGroups_004.jpg?alt=media&#x26;token=1ac71781-49f6-4864-8311-e99f722576c9" alt="A closeup of the Groups dialog box, with details entered for the creation of a new group." width="560"><figcaption><p>Pictured: The Groups dialog box.</p></figcaption></figure></div>

Here you can enter a **name** and **description** for your group. You can also change your **group access type** to Public, Contact Only, or Approved Only. When you're done, click the **Save button**.

### Group access types

<table data-header-hidden><thead><tr><th width="182.6363525390625"></th><th></th></tr></thead><tbody><tr><td>Group access type</td><td>Description</td></tr><tr><td>Public</td><td>Users can join this group with no approval process. Users can also be added to the group <a href="#adding-and-removing-group-members">manually</a>.</td></tr><tr><td>Contact Only</td><td>Contacts listed in the Group Owner's <a href="people">People list</a> <em>and</em> other approved users can join the group. Users can apply to join, and a Group Owner, Administrator, or Mod can <a href="#approving-group-applicants">approve or reject</a> the application. Users can also be added to the group <a href="#adding-and-removing-group-members">manually</a>.</td></tr><tr><td>Approved Only</td><td><em>Only</em> approved users can join the group. Users can apply to join, and a Group Owner, Administrator, or Mod can <a href="#approving-group-applicants">approve or reject</a> the application. Users can also be added to the group <a href="#adding-and-removing-group-members">manually</a>.</td></tr></tbody></table>

### Deleting a group

To delete a group, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Locate the group you want to delete and click on its **name** to launch the **Group Information window**. Then click on the **Members tab.**
3. Scroll to the bottom of the page and click the **"Delete this group" button**. Follow the prompts to confirm deletion.

## Managing group members

### Approving group applicants

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2F41Spuntx8vI6LeWZxJjD%2FGroups_005.jpg?alt=media&#x26;token=eccc0363-873f-4019-a196-e750787ab1ad" alt="A closeup of the Members tab. A user has applied to join, and an orange arrow points to the Edit button action menu, where that application can be approved or rejected." width="563"><figcaption><p>Pictured: An example of an Approved Only group with a pending applicant.</p></figcaption></figure></div>

If you are the Owner, Administrator, or Moderator of a group that requires member approval, you will see membership requests appear in the Group Information window under the **Members tab > Requests category**. Here you can click the **Edit button** located to the far right of the individual's name in order to approve, [block](#banning-users), or delete the user request.

To approve multiple users at once, check the boxes located to the left of their names and then use the **Set Role drop-down menu** to assign them all the same [role](#assigning-group-roles). (For instance, you could select five users and approve them all at once by assigning them "Member" status.)

### Adding and removing group members

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FfEnFKSn7qsOkwdXx0IeL%2FGroups_006.jpg?alt=media&#x26;token=b38c5b09-d8fd-451c-b8b1-19a87e25c0ed" alt="A closeup of the Members tab. The &#x22;Add new members&#x22; dialog box is superimposed on top, and the Group Owner has searched for a specific user, returning one result." width="456"><figcaption><p>Pictured: The "Add new members" dialog box.</p></figcaption></figure></div>

To add a user to your group manually, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Click on the **name** of the group you want to edit. This will open the **Group Information window**.
3. In the Group Information window, click on the **Members tab**, and then click the **Add Members button**. This will open the **"Add new members" dialog box**.
4. Use the **search field** to search for the user's name. Once you find it, click the **Add button**.

To remove a user from the group entirely, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Click on the **name** of the group you want to edit. This will open the **Group Information window**.
3. In the Group Information window, click on the **Members tab**, and use the **search field** to search for the user's name.
4. Once you locate the user you want to remove, click the **Edit button** located to the right of their name. In the action menu that appears, click **Delete**.

You can remove multiple group members simultaneously by checking the boxes located to the left of their names, clicking the **Set Status drop-down menu,** and selecting **Delete**.

{% hint style="danger" %}
Deleted members can reapply for membership to the group. To [ban](#banning-users) a user from reapplying, select **Block** instead of Delete.
{% endhint %}

### Assigning group roles

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FtJA2Q39wFh7YwB52sw06%2FGroups_007.jpg?alt=media&#x26;token=48624546-dbdd-4ead-8ada-c263cab50ad1" alt="A closeup of the Members tab, with the Set Role drop-down menu expanded." width="563"><figcaption><p>Pictured: An example of the Group Information window Members tab.</p></figcaption></figure></div>

Within groups, there are several roles that members can be assigned. Some roles confer special powers and privileges, both within the group and when Regions are assigned to a particular group using the ["Groups Only" Region access](https://docs.breakroom.tech/building-new-worlds/region-settings) option.

In brief, these roles are:

{% tabs %}
{% tab title="Owner" %}
Group Owners have absolute control over the group and its settings. If a group is set to [Contact Only](#group-access-types) permissions, then any contacts on the Group Owner's [People list](https://docs.breakroom.tech/exploring-breakroom/networking-with-other-users/people) will automatically be granted access to the group.

Owners can:

* [Manage](#creating-a-group) and [delete](#deleting-a-group) the group
* [Manage the group member list](#managing-group-members) and deal with [disruptive group members](#muting-and-banning-group-members)
* Assign group members [advanced permissions](#assigning-group-roles)

When a Region is set to the ["Groups Only" region access option](https://docs.breakroom.tech/building-new-worlds/region-settings), Group Owners have all the rights and permissions of a [Region Owner](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions).
{% endtab %}

{% tab title="Administrator" %}
Group Administrators can perform many of the same tasks as Group Owners. Administrators can invite users to [Contact Only and Approved Only groups](#group-access-types), and [approve](#approving-group-applicants) membership requests. They cannot appoint additional Administrators.

Administrators can:

* [Manage the group member list](#managing-group-members) and deal with [disruptive group members](#muting-and-banning-group-members)
* Assign and manage [advanced group permissions](#assigning-group-roles) below the Administrator level

When a Region is set to the ["Groups Only" Region access option](https://docs.breakroom.tech/building-new-worlds/region-settings), Group Admins have all the rights and permissions of a [Region Admin](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions).
{% endtab %}

{% tab title="Moderator" %}
Group Moderators can [approve](#approving-group-applicants) membership requests. They can mute, block, and reinstate members. They cannot appoint additional Moderators.

Moderators can:

* [Manage the group member list](#managing-group-members) and deal with [disruptive group members](#muting-and-banning-group-members)
* Assign and manage [advanced group permissions](#assigning-group-roles) below the Moderator level

When a Region is set to the ["Groups Only" Region access option](https://docs.breakroom.tech/building-new-worlds/region-settings), Group Moderators have all the rights and permissions of a [Region Moderator](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions).
{% endtab %}

{% tab title="Developer" %}
When a Region is set to the ["Groups Only" Region access option](https://docs.breakroom.tech/building-new-worlds/region-settings), Group Developers have all the rights and permissions of a [Region Developer](https://docs.breakroom.tech/opening-the-doors/creating-and-managing-user-accounts/region-level-user-permissions). Otherwise, they have no special powers.
{% endtab %}

{% tab title="Member" %}
Group Members have no special privileges, but they will be permitted to enter any Region that has been set to ["Groups Only" Region access](https://docs.breakroom.tech/building-new-worlds/region-settings) for that group.
{% endtab %}

{% tab title="Guest" %}
Coming soon.
{% endtab %}

{% tab title="VIP" %}
Designating a user as a VIP gives them no special powers. Currently, this role is only useful for Lua script functionality and [presenter seats](https://docs.breakroom.tech/getting-started/using-the-conference-system#presenter-seats) in Regions set to ["Groups Only" Region access](https://docs.breakroom.tech/building-new-worlds/region-settings).
{% endtab %}
{% endtabs %}

To assign a group member a different role, check the box located next to the member's name in the **Members tab**. Then use the **Set Role drop-down menu** to select the new role. You can assign users the *Member* role to revoke advanced permissions at any time.

You can assign multiple users the same role simultaneously by checking the boxes located to the left of their names and then using the **Set Role drop-down menu** to [assign them all the same role](https://docs.breakroom.tech/getting-started/networking/groups#assigning-group-roles).

## Muting and banning group members

In order to mute or ban/block a user, that user must be a current member of your group.

### Muting users

<div data-with-frame="true"><figure><img src="https://1679086873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5gOE0ivmDtuXfHroTVSx%2Fuploads%2FpDE06bDyrWloiMvRvKke%2FGroups_008.jpg?alt=media&#x26;token=4a00c0ff-6d11-4e29-9bd3-c5c5104f1a84" alt="A closeup of the Members tab. The Status icons and Edit button action menu are highlighted in orange." width="563"><figcaption><p>Highlighted: The location of the Status icons and the Edit button action menu. </p></figcaption></figure></div>

To mute a single user on group text chat, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Click on the **name** of the group you want to edit. This will open the **Group Information window**.
3. In the Group Information window, click on the **Members tab**, and use the **search field** to search for the user's name.
4. Once you locate the user you want to mute, you can either:
   1. Click the **Edit button** located to the far right of the user's name. In the action menu that appears, select **Mute Chat.**
   2. Toggle the **Speech bubble icon** located to the right of the user's name. When the blue check mark disappears, the user is muted.

To restore communication to a previously muted user, repeat steps 1-4 above, and either:

1. Click the **Edit button** located to the right of the user's name. In the action menu that appears, select **Unmute Chat.**
2. Toggle the **Speech bubble icon** located to the right of the user's name. When a blue check mark appears, the user can communicate over text chat.

To mute multiple users at once, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Click on the **name** of the group you want to edit. This will open the **Group Information window**.
3. In the Group Information window, click on the **Members tab**, and locate the users you want to mute. Check the box located to the left of each user's name.
4. Click the **Set Status drop-down menu,** and select **Mute Chat.**

To restore communication to multiple users, repeat steps 1-3 above. Then, click the **Set Status drop-down menu**, and select **Unmute Chat.**

### Banning users

To block a user from participating in your group or reapplying for membership, follow these steps.

1. Open the Groups window by clicking the **People button** in the [bottom toolbar](https://docs.breakroom.tech/getting-started/ui-tour#the-bottom-toolbar), or by pressing **Ctrl + F** on your keyboard. Then click the **Groups tab**.
2. Click on the **name** of the group you want to edit. This will open the **Group Information window**.
3. In the Group Information window, click on the **Members tab**, and use the **search field** to search for the user's name.
4. Once you locate the user you want to ban, click the **Edit button** located to the far right of the user's name. In the action menu that appears, select **Block**.

To undo a ban, repeat steps 1-3 above. Locate the user under the **Ban List**, and then click the **Edit button** located to the far right of their name. In the action menu that appears, select **Unblock.**

To ban multiple users at once, follow these steps.

1. Repeat steps 1-2 above.
2. In the Group Information window, click on the **Members tab**, and locate the users you want to ban. Check the box located to the left of each user's name.
3. Click the **Set Status drop-down menu,** and then click **Block.**

To undo a ban for multiple users, repeat steps 1-2 above. Then click the **Set Status drop-down menu**, and select **Unblock.**

{% hint style="warning" %}
Banning a member with Administrator, Moderator, Developer, or VIP permissions will revoke this special role. If you choose to unban such a user and reinstate them in the members list, please take a moment to ensure that they have been [assigned](#assigning-group-roles) the proper role.
{% endhint %}
