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

# Vanity

> ## Documentation Index
>
> Fetch the complete documentation index at: [https://docs.bleh.bot/llms.txt](https://docs.bleh.bot/llms.txt)
> Use this file to discover all available pages before exploring further.

# Vanity Roles

> Reward your members for advertising your server in their status.

## Getting started

This feature uses a dedicated bot due to some limitations with the main bleh bot. You can invite the dedicated bot by clicking [here](https://discord.com/oauth2/authorize?client_id=996638412675227668\&permissions=8\&scope=bot%20applications.commands).

<Warning>
  Your server must be **Level 3** with at least **14 boosts** prior to inviting
  the dedicated bot.
</Warning>

<Info>
  All commands are **slash commands** and can be accessed by typing `/vanity` in
  a text channel.
</Info>

## Setting the vanity to be monitored

You'll need to set what vanity you want to monitor. You can do this by using the `/vanity set` command.

<Tip>It's recommended to prefix the substring with a `/` (e.g. `/bleh`).</Tip>

<CodeGroup>
  ```javascript Syntax theme={null} theme={null}
  /vanity set (substring)
  ```

  ```javascript Example theme={null} theme={null}
  /vanity set /bleh
  ```
</CodeGroup>

<br />

<Frame />

## Setting up roles to reward

You can use the `/vanity role add` command to add a vanity reward.

<Info>
  If you no longer want to reward a role for a vanity, you can use the `/vanity
          role remove` command.
</Info>

<CodeGroup>
  ```javascript Syntax theme={null} theme={null}
  /vanity role add (role)
  /vanity role remove (role)
  ```

  ```javascript Example theme={null} theme={null}
  /vanity role add @Vanity
  /vanity role remove @Vanity
  ```
</CodeGroup>

<br />

<Frame />

### Viewing all roles being rewarded

You can use the `/vanity role list` command to view all roles being rewarded.

<Frame />

## Setting up the award message

You can set a thank you message for when a user advertises your server in their status.

<Info>
  The `message` parameter can be raw text or an [embed](/resources/scripting)
  with dynamic [variables](/resources/scripting/variables).
</Info>

<CodeGroup>
  ```javascript Syntax theme={null} theme={null}
  /vanity message (message)
  ```

  ```javascript Example theme={null} theme={null}
  /vanity message thank you {user.mention}
  /vanity message {embed}$v{message: {user.mention}}$v{description: thank you for advertising our server!}
  ```
</CodeGroup>

### Setting where the message is sent

You can use the `/vanity award channel` command to set where the message is sent.

<CodeGroup>
  ```javascript Syntax theme={null} theme={null}
  /vanity award channel (channel)
  ```

  ```javascript Example theme={null} theme={null}
  /vanity award channel #general
  ```
</CodeGroup>