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

# Booster Roles

> Allow members that boost your server to create custom roles

## What is Booster?

<p>
  Booster allows your **members** to create and customize their own role when they boost your server!
</p>

## Configuring Booster for the server

<p>
  Start by using the `booster enable` command.
  This will make it so boosters in the server can create their **custom roles**!
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster enable
  ```

  ```javascript Example theme={null}
  ;booster enable
  ```
</CodeGroup>

### Setting the Base Role

<p>
  Start by using the `booster base` command.
  This will make it so any custom role created will go **under** that **base role**
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster base (role)
  ```

  ```javascript Example theme={null}
  ;booster base @under
  ```
</CodeGroup>

### Setting the max shared roles

<p>
  Using the `booster share max` comamnd sets the amount of roles that a user can share.
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster share max (number)
  ```

  ```javascript Example theme={null}
  ;booster share max 6
  ```
</CodeGroup>

## Creating your Custom Role

<p>
  Start by creating your role with the `booster create` command.<br />
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster create (name) [color] [color 2]
  ```

  ```javascript Example theme={null}
  ;booster create haunt rocks black white
  ```
</CodeGroup>

<Frame>
  <img src="https://mintcdn.com/haunt-74016d1b/WkiBHwfWsxNaHW28/images/miscellaneous/booster/create.png?fit=max&auto=format&n=WkiBHwfWsxNaHW28&q=85&s=40c04befe66e5daa08026206b9715a88" width="505" height="188" data-path="images/miscellaneous/booster/create.png" />
</Frame>

## Configuring your Custom Role

<p>
  There are 7 subcommands you can use to configre your **custom role**.<br />
</p>

<AccordionGroup>
  <Accordion title="Deleting your Custom Role">
    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster delete
      ```

      ```javascript Example theme={null}
      ;booster delete
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Renaming your Custom Role">
    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster name (name)
      ```

      ```javascript Example theme={null}
      ;booster name zay's role
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Recoloring your Custom Role">
    <Info>The **second color** is optional for **gradient roles**.</Info>

    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster color (color 1) [color 2]
      ```

      ```javascript Example theme={null}
      ;booster color blue purple
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Making your Custom Role Mentionable">
    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster mention (choice)
      ```

      ```javascript Example theme={null}
      ;booster mention yes
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Setting an Icon to your Custom Role">
    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster icon (attachment)
      ```

      ```javascript Example theme={null}
      ;booster icon haunt.jpeg
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Removing your Custom Role Icon">
    <CodeGroup>
      ```javascript Syntax theme={null}
      ;booster icon remove
      ```

      ```javascript Example theme={null}
      ;booster icon remove
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>

## Sharing your Custom Role

<p>
  You can share your **custom role** with other **members**!<br />
  Start with the `booster share` command.
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster share (member)
  ```

  ```javascript Example theme={null}
  ;booster share @isa
  ```
</CodeGroup>

<Frame>
  <img src="https://mintcdn.com/haunt-74016d1b/WkiBHwfWsxNaHW28/images/miscellaneous/booster/share.png?fit=max&auto=format&n=WkiBHwfWsxNaHW28&q=85&s=565d3c523a2b9079edd703fe9a75c951" width="558" height="224" data-path="images/miscellaneous/booster/share.png" />
</Frame>

### Leaving a Shared Custom Role

<p>
  Start by using the `booster share leave` command.
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster share leave (member)
  ```

  ```javascript Example theme={null}
  ;booster share leave @isa
  ```
</CodeGroup>

### View who you're sharing your Custom Role with

<p>
  Start by using the `booster share view` command.
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster share view
  ```

  ```javascript Example theme={null}
  ;booster share view
  ```
</CodeGroup>

### Clear who you're sharing your Custom role with

<p>
  Start by using the `booster share clear` command.
</p>

<CodeGroup>
  ```javascript Syntax theme={null}
  ;booster share clear
  ```

  ```javascript Example theme={null}
  ;booster share clear
  ```
</CodeGroup>