> ## 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

> Allow server boosters to create, customize, color, icon, share, and manage custom boost roles.

# Booster Role System

<Badge variant="elite">Tier 1: Elite</Badge>

> Reward your server boosters with custom, self-managed roles featuring hex color codes, custom icons, friend-sharing perks, word filters, and booster announcement channels.

***

## Command Overview

| Command      | Aliases | Syntax                                | Description                                  | Permissions            |
| :----------- | :------ | :------------------------------------ | :------------------------------------------- | :--------------------- |
| `.boostrole` | `br`    | `.boostrole <subcommand> [arguments]` | Complete management suite for booster roles. | Boosters / ManageGuild |

***

## Booster Role Setup (Admin Commands)

Configure base permissions, position anchoring, share limits, word filters, and announcement messages for your server.

| Subcommand    | Syntax                                        | Description                                                            | Example                                          |
| :------------ | :-------------------------------------------- | :--------------------------------------------------------------------- | :----------------------------------------------- |
| `baserole`    | `.boostrole baserole <@role\|roleid>`         | Sets base role anchor for permission inheritance and role placement    | `.boostrole baserole @BoosterAnchor`             |
| `sharelimit`  | `.boostrole sharelimit <number>`              | Sets maximum number of friends a booster can share their role with     | `.boostrole sharelimit 5`                        |
| `filter`      | `.boostrole filter <type> <word>`             | Block specific words from booster role names (`add`, `remove`, `list`) | `.boostrole filter add badword`                  |
| `setchannel`  | `.boostrole setchannel <#channel\|channelId>` | Sets the channel for booster role creation messages                    | `.boostrole setchannel #booster-lounge`          |
| `message`     | `.boostrole message <content>`                | Sets custom message sent when a booster creates their role             | `.boostrole message Thanks for boosting {user}!` |
| `testmessage` | `.boostrole testmessage`                      | Sends a test preview of the booster announcement message               | `.boostrole testmessage`                         |
| `display`     | `.boostrole display <enable\|disable>`        | Configures how booster roles are displayed in server member lists      | `.boostrole display enable`                      |
| `config`      | `.boostrole config`                           | Displays full server booster role configuration                        | `.boostrole config`                              |
| `list`        | `.boostrole list`                             | Lists all active booster roles created in the server                   | `.boostrole list`                                |

***

## Booster Self-Management Commands

Server boosters can customize their personal roles using the following subcommands:

| Subcommand | Syntax                                                 | Description                                              | Example                                   |
| :--------- | :----------------------------------------------------- | :------------------------------------------------------- | :---------------------------------------- |
| `create`   | `.boostrole create <#color1> [#color2] [emoji] <name>` | Creates your personal boost role                         | `.boostrole create #ff0000 #0000ff ⭐ VIP` |
| `rename`   | `.boostrole rename <newName>`                          | Renames your boost role                                  | `.boostrole rename Super Booster`         |
| `color`    | `.boostrole color <#color>`                            | Updates the color of your boost role                     | `.boostrole color #FF5733`                |
| `icon`     | `.boostrole icon <emoji>`                              | Sets a custom role icon                                  | `.boostrole icon 👑`                      |
| `share`    | `.boostrole share <@user\|userId>`                     | Shares your boost role with a friend                     | `.boostrole share @Friend`                |
| `unshare`  | `.boostrole unshare <@user\|userId>`                   | Removes your shared boost role from a friend             | `.boostrole unshare @Friend`              |
| `on`       | `.boostrole on`                                        | Enables/equips your boost role                           | `.boostrole on`                           |
| `off`      | `.boostrole off`                                       | Temporarily unequips your boost role without deleting it | `.boostrole off`                          |
| `remove`   | `.boostrole remove`                                    | Permanently deletes your boost role                      | `.boostrole remove`                       |

***

## Step-by-Step Examples

<Tabs>
  <Tab title="Creating a Role">
    ```bash theme={null} theme={null}
    .boostrole create #FF0055 ⭐ Diamond Booster
    ```
  </Tab>

  <Tab title="Sharing with Friends">
    ```bash theme={null} theme={null}
    .boostrole share @BestFriend
    .boostrole unshare @BestFriend
    ```
  </Tab>

  <Tab title="Customizing">
    ```bash theme={null} theme={null}
    .boostrole rename Elite Member
    .boostrole color #7289DA
    .boostrole icon 🚀
    ```
  </Tab>

  <Tab title="Server Configuration">
    ```bash theme={null} theme={null}
    .boostrole baserole @ServerBooster
    .boostrole sharelimit 3
    .boostrole setchannel #booster-chat
    .boostrole config
    ```
  </Tab>
</Tabs>