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

# Booster Roles

> A custom colored role for server boosters.

## Overview

Boosters can create a custom colored role for themselves, and share it with a limited number of other members. Everything in this section requires the member to actually be boosting the server.

## Creating and styling your role

<CodeGroup>
  ```javascript Syntax theme={null}
  !boosterrole color <hex> [hex2]
  !boosterrole rename <name>
  !boosterrole icon <input>
  !boosterrole random
  !boosterrole remove
  ```

  ```javascript Example theme={null}
  !boosterrole color #ff91c2
  !boosterrole color #ff91c2 #8399ff
  !boosterrole icon 🎀
  ```
</CodeGroup>

`hex2` creates a gradient role. `icon` accepts an image URL, a custom emoji, or a sticker ID.

## Sharing

<CodeGroup>
  ```javascript Syntax theme={null}
  !boosterrole share <user>
  !boosterrole unshare <user>
  !boosterrole shared
  ```

  ```javascript Example theme={null}
  !boosterrole share @Friend
  ```
</CodeGroup>

## Staff administration

Directly manage any member's booster role, bypassing their own cooldowns and limits.

<CodeGroup>
  ```javascript Syntax theme={null}
  !boosterrole admin set <user> [hex] [hex2] [name]
  !boosterrole admin rename <user> <name>
  !boosterrole admin icon <user> <input>
  !boosterrole admin remove <user>
  !boosterrole admin list
  !boosterrole admin link <user> <role>
  !boosterrole admin cleanup
  ```

  ```javascript Example theme={null}
  !boosterrole admin set @Someone #ff91c2 --name "Someone's Role"
  !boosterrole admin link @Someone @ExistingRole
  ```
</CodeGroup>

`link` associates an already-existing role with a member as their booster role, useful if one was created manually. `cleanup` deletes booster roles belonging to members who are no longer boosting.

## Server-wide settings

<CodeGroup>
  ```javascript Syntax theme={null}
  !boosterrole admin base <role>
  !boosterrole admin limit <count>
  !boosterrole admin share-limit <count>
  !boosterrole admin cooldown <type> <duration>
  ```

  ```javascript Example theme={null}
  !boosterrole admin base @Booster
  !boosterrole admin limit 1
  !boosterrole admin cooldown color 24h
  ```
</CodeGroup>

| Setting       | Description                                                                                                     |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| `base`        | New booster roles are placed just above this role.                                                              |
| `limit`       | Max booster roles per member (0 = unlimited).                                                                   |
| `share-limit` | Max members one booster role can be shared with (0 = unlimited).                                                |
| `cooldown`    | How often `color`, `icon`, or `rename` can each be used, `type` picks which one. Use `0` to disable a cooldown. |

## Filtered words

Block specific words from booster role names.

<CodeGroup>
  ```javascript Syntax theme={null}
  !boosterrole admin filter add <word>
  !boosterrole admin filter remove <word>
  !boosterrole admin filter list
  ```

  ```javascript Example theme={null}
  !boosterrole admin filter add slur
  ```
</CodeGroup>