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

# Vanity Roles

> Reward users for supporting your server with a custom URL.

Encourage users to add your server's custom vanity URL to their status by rewarding them with a special role.

## How it Works

1. A user adds your vanity URL (e.g., `/.gg/myserver`) to their Discord status.
2. Flamey detects this change.
3. Flamey automatically assigns the configured **Vanity Role**.
4. If they remove the URL from their status, the role is removed.

<Warning>
  This feature requires your server to have a **Vanity URL**, which usually requires **Level 3 Boosts**.
</Warning>

## Setup Guide

<Steps>
  <Step title="Check Requirements">
    Ensure your server has a custom vanity URL set in Server Settings.
  </Step>

  <Step title="Create Role">
    Create the role you want to give (e.g., "Supporter"). Make sure the bot's role is **higher** than this role.
  </Step>

  <Step title="Configure Dashboard">
    Go to **Dashboard > Configuration > Roles**.
  </Step>

  <Step title="Enable & Select">
    Enable **Vanity Roles** and select the role you created from step 2.
  </Step>

  <Step title="Save">
    Click **Save Changes**.
  </Step>
</Steps>
