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

# Setting the Vanity Award Message

> This guide will show you how to set the message that is sent once a user adds the vanity sub-string to their status.

<Tip>
  Variables are accepted, the list of accepted variables can be found below.
</Tip>

<AccordionGroup>
  <Accordion title="Setup Guide with Regular Text">
    To set a regular award message is simple and can be done following the example below.

    <Info>
      To add new lines, use \n

      Example:

      ```
      hi \nnew line!
      ```
    </Info>

    <CodeGroup>
      ```javascript Usage
      /vanity msg (message)
      ```

      ```javascript Example
      /vanity msg Thank you {user.mention} for adding {guild.vanity} to your status!
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Setup Guide with Embeds">
    To create an embed, go to [https://doll.hamptonn.dev/embeds](https://doll.hamptonn.dev/embeds)

    Then go back to Discord, and paste it into `/vanity msg` Here's an example below.

    ```javascript
    /vanity msg 
    {
      "content": "{user.mention}",
      "embeds": [
      {
        "description": "<:e_crown:1344462958239027301> thank you for **repping** /dolls",
        "color": 16769009,
        "footer": {
          "text": "use /disableping to disable pings"
        }
      }
    ],
    "components": []
    }
    ```

    Now you're done! You can view this message by using `/vanity view msg:True`
    If you need any help, feel free to message me on Discord.
  </Accordion>
</AccordionGroup>

| Variables        | What each variable does                   |
| ---------------- | ----------------------------------------- |
| user.mention     | mentions the user                         |
| user.name        | the username of the user                  |
| user.displayname | the user's display name                   |
| user.avatar      | the avatar or server-set avatar of a user |
| guild.name       | the server's name                         |
| guild.vanity     | the vanity substring (if set)             |
| guild.icon       | the guild's icon (if set)                 |
