# Vanity Roles

## Getting started

{% hint style="warning" %}
Your server must be **Level 3** with at least **14 boosts** prior to user vanity roles.
{% endhint %}

## 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.

{% hint style="info" %}
It’s recommended to prefix the substring with a `/` (e.g. `/evelina`).
{% endhint %}

```
Syntax: ;vanity set [vanity]
Example: ;vanity set /evelina
```

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20090552.png" alt=""><figcaption></figcaption></figure>

## Setting up roles to reward <a href="#setting-up-roles-to-reward" id="setting-up-roles-to-reward"></a>

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

```
// Set Vanity Role
Syntax: /vanity role add [role]
Example: /vanity role add represent

// Remove Vanity Role
Syntax: /vanity role remove 
Example: /vanity role remove
```

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20090715.png" alt=""><figcaption></figcaption></figure>

### Viewing all roles being rewarded

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

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20090823.png" alt=""><figcaption></figcaption></figure>

## Setting up the award message

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

{% hint style="info" %}
The `message` parameter can be raw text or an [embed](https://github.com/EvelinaServices/docs/blob/main/server/roles/broken-reference/README.md) with dynamic [variables](https://docs.evelina.bot/resources/scripting/variables).
{% endhint %}

```
// Set Vanity Message
Syntax: /vanity message [code]
Example: /vanity message {user.mention}, thanks for represent us
```

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20090923.png" alt=""><figcaption></figcaption></figure>

### Setting where the message is sent

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

```
// Set Vanity Channel
Syntax: ;vanity channel set [channel]
Example: ;vanity channel set #support
```

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20091050.png" alt=""><figcaption></figcaption></figure>

```
// Remove Vanity Channel
Syntax: ;vanity channel remove
Example: ;vanity channel remove
```

<figure><img src="https://github.com/EvelinaServices/docs/blob/main/.gitbook/assets/Screenshot%202025-03-16%20091301.png" alt=""><figcaption></figcaption></figure>
