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

# Booster Roles

> Give your boosters the ability to create and manage their own personalized roles.

## Getting Started

Personalized booster roles allow your server's boosters to create a custom role with their own name, color, and icon. This feature is a great way to reward your most loyal community members.

### Requirements

* **Boost Tier 2**: Your server must be at least Boost Tier 2 for this feature to be available.
* **Boosting**: The user must be actively boosting the server (or be the server owner).

<Steps>
  <Step title="Enable the system">
    Run the `boosterrole setup` command to enable the system in your server.

    ```javascript theme={null}
    ,boosterrole setup
    ```
  </Step>

  <Step title="Set a base role (Optional)">
    Use the `boosterrole base` command to set a role that booster roles will be positioned under. This ensures boosters don't accidentally get permissions higher than intended.

    ```javascript theme={null}
    ,boosterrole base @Member
    ```
  </Step>
</Steps>

## Managing your role

Once enabled, boosters can use the following commands to manage their custom role.

### Creating a role

Create your personalized role with a name and optional hex colors. greed supports up to 3 colors for gradient roles on servers with enhanced color support.

<CodeGroup>
  ```javascript Syntax theme={null}
  ,boosterrole create (name) [color1] [color2] [color3]
  ```

  ```javascript Example theme={null}
  ,boosterrole create greed-fan #BCBCE3
  ,boosterrole create "Super Booster" #ff0000 #00ff00 #0000ff
  ```
</CodeGroup>

## Management Commands

### Role Customization

Once your role is created, you can fine-tune it with these commands:

<AccordionGroup>
  <Accordion title="Color & Gradients">
    Change your role's color. Support for single hex codes or dual-color gradients.

    ```javascript theme={null}
    ,br color #ff0000
    ,br color #ff0000 #0000ff
    ```
  </Accordion>

  <Accordion title="Renaming">
    Update your role's name at any time.

    ```javascript theme={null}
    ,br rename new name
    ```
  </Accordion>

  <Accordion title="Custom Icons">
    Set a custom emoji or image as your role icon.

    ```javascript theme={null}
    ,br icon :emoji:
    ```

    <Tip>Run without an argument to reset the icon.</Tip>
  </Accordion>

  <Accordion title="Hoisting">
    Choose whether your role is displayed separately from other members in the sidebar.

    ```javascript theme={null}
    ,br hoist on/off
    ```
  </Accordion>
</AccordionGroup>

### Social Features

<Accordion title="Sharing your role">
  You can grant your personalized booster role to friends!

  ```javascript theme={null}
  ,br share @user
  ```

  <Info>By default, users can share their role with up to 5 people.</Info>
</Accordion>

***

## Administrative Commands

Commands for server staff to manage the booster role system globally.

### System Management

<AccordionGroup>
  <Accordion title="Base Role & Syncing">
    Set a "base" role that all booster roles will be positioned below in the hierarchy.

    * Set base: `,br base @Role`
    * Sync positions: `,br sync` (Ensures all booster roles are correctly ordered below the base)
  </Accordion>

  <Accordion title="Filtering & Names">
    Prevent users from using specific words in their role names.

    ```javascript theme={null}
    ,br filter add (word)
    ```
  </Accordion>

  <Accordion title="Global Status">
    * `,br list`: Check how many booster roles exist and who owns them.
  </Accordion>
</AccordionGroup>

### Advanced Settings

Fine-tune the system behavior with these administrative subcommands.

<AccordionGroup>
  <Accordion title="Hierarchy Anchor">
    Set a "base" role that all booster roles will be positioned below in the hierarchy.

    * `,settings baserole @Role`
  </Accordion>

  <Accordion title="Booster Awards">
    Automatically grant specific roles to users when they start boosting and remove them when they stop.

    * Add award: `,settings award add @Role`
    * View awards: `,settings award list`
    * Remove award: `,settings award remove @Role`
  </Accordion>
</AccordionGroup>

<Info>
  Use `,br setup` for the initial configuration. Remember that greed requires **Manage Roles** permissions to manage booster roles.
</Info>

* `,boosterrole delete [user]`: Delete your own booster role or a specific user's booster role.
* `,boosterrole disable`: Turn off the booster role system entirely.

<Tip>
  Use `,boosterrole filter` to manage a list of prohibited words for booster role names.
</Tip>