> ## Documentation Index
> Fetch the complete documentation index at: https://docs.razebot.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Booster Roles

> Let server boosters create and customise their own personal role.

# Booster Roles

> Let server boosters create and customise their own personal role.

## How it works

Boosters (or staff-allowed users) can create a personal role with a custom name, color, and icon. When they stop boosting, their role is automatically removed. Staff control the position, per-server limits, and a word/user blacklist.

## Setup

Enable the booster role system for your server.

```bash theme={null} theme={null}
;boosterrole setup
```

Disable the system.

```bash theme={null} theme={null}
;boosterrole reset
```

<Tabs>
  <Tab title="Base role">
    Booster roles are placed directly below this role in the role list.

    ```bash theme={null} theme={null}
    ;boosterrole base (@role)
    ```

    ```bash theme={null} theme={null}
    ;boosterrole base @Mods
    ```
  </Tab>

  <Tab title="Role limit">
    Cap how many booster roles can exist at once. Use `0` to remove the limit.

    ```bash theme={null} theme={null}
    ;boosterrole limit (number)
    ```

    ```bash theme={null} theme={null}
    ;boosterrole limit 50
    ```
  </Tab>
</Tabs>

## Booster commands

Available to **server boosters** and any users added via `allow`.

<Tabs>
  <Tab title="Create">
    Optionally pass up to 3 colors (hex or name, comma-separated) before the name to create a gradient.

    ```bash theme={null} theme={null}
    ;br create (colors) (name)
    ```

    ```bash theme={null} theme={null}
    ;br create Wanderer
    ```

    ```bash theme={null} theme={null}
    ;br create ff6b6b,black My Role
    ```
  </Tab>

  <Tab title="Color">
    Update your role's color. Pass up to 3 colors for a gradient.

    ```bash theme={null} theme={null}
    ;br color (colors)
    ```

    ```bash theme={null} theme={null}
    ;br color ff0000,blue,black
    ```
  </Tab>

  <Tab title="Name">
    ```bash theme={null} theme={null}
    ;br name (new name)
    ```

    ```bash theme={null} theme={null}
    ;br name wanderer
    ```
  </Tab>

  <Tab title="Icon">
    Provide a URL or attach an image directly to the command message.

    ```bash theme={null} theme={null}
    ;br icon (url)
    ```

    ```bash theme={null} theme={null}
    ;br icon https://example.com/icon.png
    ```
  </Tab>

  <Tab title="Delete">
    ```bash theme={null} theme={null}
    ;br delete
    ```
  </Tab>
</Tabs>

## Staff commands

<Tabs>
  <Tab title="Wipe">
    Force-delete a specific member's booster role.

    ```bash theme={null} theme={null}
    ;br wipe (@member)
    ```

    ```bash theme={null} theme={null}
    ;br wipe @wanderer
    ```
  </Tab>

  <Tab title="List">
    View all active booster roles in the server.

    ```bash theme={null} theme={null}
    ;br list
    ```
  </Tab>
</Tabs>

## Allow

Let specific users create a booster role without actually boosting.

<Tabs>
  <Tab title="Add">
    ```bash theme={null} theme={null}
    ;br allow add (@member)
    ```

    ```bash theme={null} theme={null}
    ;br allow add @wanderer
    ```
  </Tab>

  <Tab title="Remove">
    ```bash theme={null} theme={null}
    ;br allow remove (@member)
    ```

    ```bash theme={null} theme={null}
    ;br allow remove @wanderer
    ```
  </Tab>

  <Tab title="List">
    ```bash theme={null} theme={null}
    ;br allow list
    ```
  </Tab>
</Tabs>

## Award roles

Automatically give members an additional role when they boost, separate from their personal booster role.

<Tabs>
  <Tab title="Add">
    ```bash theme={null} theme={null}
    ;br award add (@role)
    ```

    ```bash theme={null} theme={null}
    ;br award add @Supporter
    ```
  </Tab>

  <Tab title="Remove">
    ```bash theme={null} theme={null}
    ;br award remove (@role)
    ```

    ```bash theme={null} theme={null}
    ;br award remove @Supporter
    ```
  </Tab>

  <Tab title="List">
    ```bash theme={null} theme={null}
    ;br award list
    ```
  </Tab>
</Tabs>

## Blacklist

Block specific users or words from being used in booster role names.

<Tabs>
  <Tab title="Blacklist user">
    ```bash theme={null} theme={null}
    ;br blacklist user (@member) [reason]
    ```

    ```bash theme={null} theme={null}
    ;br blacklist user @wanderer abusing the system
    ```
  </Tab>

  <Tab title="Blacklist word">
    ```bash theme={null} theme={null}
    ;br blacklist word (word) [word...]
    ```

    ```bash theme={null} theme={null}
    ;br blacklist word slur badword
    ```
  </Tab>

  <Tab title="Unblacklist user">
    ```bash theme={null} theme={null}
    ;br unblacklist user (@member)
    ```

    ```bash theme={null} theme={null}
    ;br unblacklist user @wanderer
    ```
  </Tab>

  <Tab title="Unblacklist word">
    ```bash theme={null} theme={null}
    ;br unblacklist word (word) [word...]
    ```

    ```bash theme={null} theme={null}
    ;br unblacklist word badword
    ```
  </Tab>

  <Tab title="View users">
    ```bash theme={null} theme={null}
    ;br blacklisted user
    ```
  </Tab>

  <Tab title="View words">
    ```bash theme={null} theme={null}
    ;br blacklisted word
    ```
  </Tab>
</Tabs>

## Sharing

Let boosters share their role color with other members.

Enable or disable sharing server-wide:

```bash theme={null} theme={null}
;br share enable
;br share disable
```

<Tabs>
  <Tab title="Share limit">
    Cap how many members one booster can share with.

    ```bash theme={null} theme={null}
    ;br share limit (number)
    ```

    ```bash theme={null} theme={null}
    ;br share limit 3
    ```
  </Tab>

  <Tab title="Share with a member">
    ```bash theme={null} theme={null}
    ;br share add (@member)
    ```

    ```bash theme={null} theme={null}
    ;br share add @friend
    ```
  </Tab>

  <Tab title="Stop sharing">
    ```bash theme={null} theme={null}
    ;br share remove (@member)
    ```

    ```bash theme={null} theme={null}
    ;br share remove @friend
    ```
  </Tab>

  <Tab title="View shared members">
    ```bash theme={null} theme={null}
    ;br share list
    ```
  </Tab>
</Tabs>