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

# Booster Roles

> One personal role per booster, with colour, icon and sharing.

Boosters can create and customise a single role each · name, colour and icon · and share it with
somebody else. Nothing is pre-created: run the setup command once and `/boosterrole create` handles
the rest.

## Setup

```text theme={null}
/boosterrole setup
```

That checks the server can support booster roles and stores what the module needs. After that, every
booster creates their own:

```text theme={null}
/boosterrole create
```

## Commands

| Command | What it does |
| - | - |
| `/boosterrole create` | Create your role if you're boosting |
| `/boosterrole rename <name>` | Rename it |
| `/boosterrole color <#hex>` | Change its colour |
| `/boosterrole icon <emoji>` | Set an emoji as its icon |
| `/boosterrole share <member>` | Invite someone to use the role |
| `/boosterrole unshare <member>` | Take the share back |
| `/boosterrole leave` | Leave a role that was shared with you |
| `/boosterrole delete` | Delete your role |

The prefix alias is `,br`, so `,br setup` and `,br rename New Name` work too.

## Rules

| Rule | Behaviour |
| - | - |
| Sharing | Only the owner can share; the recipient accepts by DM within **five minutes** |
| Leaving | A shared member can `leave`; the owner can `unshare` them |
| Deletion | Admins can run `,br delete @owner` to remove somebody else's role |
| Boosting ends | The role is deleted when its owner stops boosting |
| Icons | A Unicode emoji, or a custom emoji from another server |
| Colour | Any hex value, independent of the server palette |

## Requirements

* **Manage Roles**, and Criminal's role must sit **above** the booster roles it creates.
* The member must actually be boosting · without an active boost there's no role to make.
* Renames and colours apply immediately; there's no re-create step.

**Boosters keep their own identity**

A shared role still belongs to the booster who created it · the person it's shared with can use it,
but can't rename it or pass it on.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.