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

# Vanity Roles

> Automatically assign roles to members who add your server's vanity URL to their status.

# Vanity Roles

> Automatically assign roles to members who add your server's vanity URL to their status.

## Overview

Vanity roles automatically assign a role to any member who includes your server's vanity URL in their Discord custom status. When they remove it, the role is revoked.

<Info>
  Requires the server to have a vanity URL (Discord Level 3 boost).
</Info>

## Enable & Disable

```bash theme={null} theme={null}
;vanity enable
;vanity disable
```

## Reward Roles

Roles assigned when a member adds the vanity to their status.

<Accordion title="Reward roles">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity reward add (@role)
        ;vanity reward remove (@role)
        ;vanity reward view
        ;vanity reward clear
    ```

    ```bash Example theme={null} theme={null}
    ;vanity reward add @vanity
        ;vanity reward remove @vanity
    ```
  </CodeGroup>
</Accordion>

## Award Message

Send a message when a member adds the vanity to their status.

<Accordion title="Award message">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity message (text)
        ;vanity message channel (#channel)
        ;vanity message enable
        ;vanity message disable
        ;vanity message view
        ;vanity message clear
    ```

    ```bash Example theme={null} theme={null}
    ;vanity message {user.mention} thanks for repping {guild.name}!
        ;vanity message channel #vanity-log
    ```
  </CodeGroup>
</Accordion>

## Revoke Message

Send a message when a member removes the vanity from their status.

<Accordion title="Revoke message">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity revoke (text)
        ;vanity revoke channel (#channel)
        ;vanity revoke enable
        ;vanity revoke disable
        ;vanity revoke view
        ;vanity revoke clear
    ```

    ```bash Example theme={null} theme={null}
    ;vanity revoke {user.mention} removed the vanity from their status.
        ;vanity revoke channel #vanity-log
    ```
  </CodeGroup>
</Accordion>

## Channel

Set a fallback channel used when no dedicated message or revoke channel is configured.

<Accordion title="Set channel">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity channel (#channel)
    ```

    ```bash Example theme={null} theme={null}
    ;vanity channel #vanity-log
    ```
  </CodeGroup>
</Accordion>

## Target

Configure a specific URL or phrase that must be present in a user's status to receive the vanity rewards.

<Accordion title="Set target">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity target (url/phrase)
    ```

    ```bash Example theme={null} theme={null}
    ;vanity target discord.gg/raze
    ```
  </CodeGroup>
</Accordion>

## Strict Mode

Toggle whether the vanity must be the member's entire status or just appear somewhere in it.

```bash theme={null} theme={null}
;vanity strict
```

| Mode          | Behavior                                      |
| ------------- | --------------------------------------------- |
| Off (default) | Status must exactly match the vanity code     |
| On            | Vanity code can appear anywhere in the status |

## Ignore List

Prevent specific members or roles from receiving vanity rewards.

<Accordion title="Ignore a user">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity ignore user (@member)
        ;vanity ignore user remove (@member)
        ;vanity ignore user view
        ;vanity ignore user clear
    ```

    ```bash Example theme={null} theme={null}
    ;vanity ignore user @someone
        ;vanity ignore user remove @someone
    ```
  </CodeGroup>
</Accordion>

<Accordion title="Ignore a role">
  <CodeGroup>
    ```bash Syntax theme={null} theme={null}
    ;vanity ignore role (@role)
        ;vanity ignore role remove (@role)
        ;vanity ignore role view
        ;vanity ignore role clear
    ```

    ```bash Example theme={null} theme={null}
    ;vanity ignore role @staff
        ;vanity ignore role remove @staff
    ```
  </CodeGroup>
</Accordion>

## Settings & Reset

```bash theme={null} theme={null}
;vanity settings
;vanity reset
```

## Variables

Messages support the full TagScript variable set. See the [Variables](/resources/variables) page for all available placeholders.
