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

# Variable

> Atom provides variables for customizable outputs. Each variable is wrapped in curly brackets.

<Accordion title="Level Up Message">
  | Variable                | Description                     |
  | ----------------------- | ------------------------------- |
  | `{dot}`                 | Inserts a dot (`.`).            |
  | `{new_line}`            | Inserts a line break.           |
  | `{user_mention}`        | Mentions the user.              |
  | `{user_username}`       | The user's username.            |
  | `{user_displayName}`    | The user's display name.        |
  | `{user_nickname}`       | The user's server nickname.     |
  | `{previous_level}`      | The previous level.             |
  | `{new_level}`           | The new level.                  |
  | `{previous_experience}` | The XP before leveling up.      |
  | `{new_experience}`      | The XP after leveling up.       |
  | `{experience_needed}`   | XP needed for the next level.   |
  | `{level_gained}`        | Levels gained from leveling up. |
  | `{experience_gained}`   | XP gained from leveling up.     |
</Accordion>

<Accordion title="Level Up Embed">
  | Variable                | Description                                            |
  | ----------------------- | ------------------------------------------------------ |
  | `{dot}`                 | Inserts a dot (`.`).                                   |
  | `{new_line}`            | Inserts a line break.                                  |
  | `{user_mention}`        | Mentions the user.                                     |
  | `{user_username}`       | The user's username.                                   |
  | `{user_displayName}`    | The user's display name.                               |
  | `{user_nickname}`       | The user's server nickname.                            |
  | `{user_avatar}`         | The user's avatar.                                     |
  | `{server_name}`         | The server's name.                                     |
  | `{server_avatar}`       | The server's avatar.                                   |
  | `{reward_role_mention}` | Mentions the reward role obtained from leveling up.    |
  | `{reward_role_name}`    | The name of the reward role obtained from leveling up. |
  | `{previous_level}`      | The previous level.                                    |
  | `{new_level}`           | The new level.                                         |
  | `{previous_experience}` | The XP before leveling up.                             |
  | `{new_experience}`      | The XP after leveling up.                              |
  | `{experience_needed}`   | XP needed for the next level.                          |
  | `{level_gained}`        | Levels gained from leveling up.                        |
  | `{experience_gained}`   | XP gained from leveling up.                            |
</Accordion>

<Accordion title="Level Up Nickname">
  <Tip>When using `{user_nickname}`, enclose any decorative characters with `*/` at the start and `/*` at the end for cleaner formatting.</Tip>

  | Variable                | Description                   |
  | ----------------------- | ----------------------------- |
  | `{server_name}`         | The server's name.            |
  | `{user_username}`       | The member's username.        |
  | `{user_displayName}`    | The member's display name.    |
  | `{user_nickname}`       | The user's nickname.          |
  | `{previous_level}`      | The previous level.           |
  | `{new_level}`           | The new level.                |
  | `{previous_experience}` | The XP before leveling up.    |
  | `{new_experience}`      | The XP after leveling up.     |
  | `{experience_needed}`   | XP needed for the next level. |
</Accordion>

<Accordion title="Live Periodic Leaderboard Message">
  | Variable             | Description                             |
  | -------------------- | --------------------------------------- |
  | `{dot}`              | Inserts a dot (`.`).                    |
  | `{new_line}`         | Inserts a line break.                   |
  | `{user_mention}`     | Mentions the user.                      |
  | `{user_username}`    | The user's username.                    |
  | `{user_displayName}` | The user's display name.                |
  | `{user_nickname}`    | The user's nickname.                    |
  | `{rank}`             | The user's rank for the current period. |
  | `{messages}`         | Messages sent by the user this period.  |
  | `{reward}`           | Reward obtained for the period.         |
</Accordion>

<Accordion title="Live Periodic Leaderboard Embed">
  | Variable              | Description                                     |
  | --------------------- | ----------------------------------------------- |
  | `{dot}`               | Inserts a dot (`.`).                            |
  | `{new_line}`          | Inserts a line break.                           |
  | `{period}`            | Leaderboard period (Daily, Weekly, Monthly).    |
  | `{refreshes_in}`      | Time until the leaderboard refreshes.           |
  | `{ends_in}`           | Time until the current leaderboard period ends. |
  | `{placement_command}` | Command mention to check a user's placement.    |
</Accordion>