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

# Variable Dictionary

> Dynamic variables allow @curse to personalize every interaction by pulling real-time data from your server. These variables are accessible throughout @curse and can be used in any command context that supports a message or embed code parameter, such as welcome, leave, and goodbye.

<Tip>
  Don't forget to check out the official documentation for **@curse** embeds and dynamic messaging @ [https://docs.cursebot.site/resources/scripting](https://docs.cursebot.site/resources/scripting)
</Tip>

## 1. Core Variable Categories

<Tabs>
  <Tab title="Guild">
    | **Variable**                   | Output                                               |
    | :----------------------------- | :--------------------------------------------------- |
    | `guild`                        | The name of the server.                              |
    | `guild.name`                   | The name of the server.                              |
    | `guild.id`                     | The unique 18-digit Discord ID of the server.        |
    | `guild.owner_id`               | The unique 18-digit Discord ID of the server owner.  |
    | `guild.icon`                   | The direct URL to the server's icon image.           |
    | `guild.banner`                 | The direct URL to the server's banner image.         |
    | `guild.splash`                 | The direct URL to the server's invite splash image.  |
    | `guild.created_at`             | The date the server was created.                     |
    | `unix(guild.created_at)`       | The Unix timestamp of the server creation date.      |
    | `guild.count`                  | The total number of members in the server.           |
    | `guild.member_count`           | The total number of members in the server.           |
    | `guild.boost_count`            | The total number of boosts the server has.           |
    | `guild.boost_tier`             | The current boost tier level of the server.          |
    | `guild.emoji_count`            | The total number of emojis in the server.            |
    | `guild.role_count`             | The total number of roles in the server.             |
    | `guild.channel_count`          | The total number of channels in the server.          |
    | `guild.text_channel_count`     | The total number of text channels in the server.     |
    | `guild.voice_channel_count`    | The total number of voice channels in the server.    |
    | `guild.category_channel_count` | The total number of category channels in the server. |
    | `guild.features`               | A list of the server's enabled features.             |
  </Tab>

  <Tab title="User">
    | Variable                     | Output                                                                |
    | :--------------------------- | :-------------------------------------------------------------------- |
    | `user`                       | The user's full Discord tag.                                          |
    | `user.id`                    | The unique 18-digit Discord ID of the user.                           |
    | `user.mention`               | Tags the user with a clickable mention.                               |
    | `user.name`                  | The username of the user.                                             |
    | `user.tag`                   | The discriminator of the user.                                        |
    | `user.avatar`                | The direct URL to the user's current profile picture.                 |
    | `user.bot`                   | Whether the user account is a bot (true or false).                    |
    | `user.created_at`            | The date the user's Discord account was created.                      |
    | `unix(user.created_at)`      | The Unix timestamp of the account creation date.                      |
    | `user.display_avatar`        | The direct URL to the user's display avatar.                          |
    | `user.joined_at`             | The date the user joined the server.                                  |
    | `unix(user.joined_at)`       | The Unix timestamp of the server join date.                           |
    | `user.join_position`         | The numerical join position of the user in the server.                |
    | `suffix(user.join_position)` | The join position formatted with an ordinal suffix (1st, 2nd, etc.).  |
    | `user.highest_role`          | The highest role assigned to the user.                                |
    | `user.role_list`             | A comma-separated list of the user's roles.                           |
    | `user.role_count`            | The total number of roles assigned to the user (excluding @everyone). |
    | `user.boost`                 | Whether the user is currently boosting the server (true or false).    |
    | `user.boost_since`           | The date the user started boosting the server.                        |
    | `unix(user.boost_since)`     | The Unix timestamp of the boost start date.                           |
    | `user.color`                 | The user's display hex color based on their highest role.             |
    | `user.nickname`              | The user's nickname in the server.                                    |
    | `user.display_name`          | The display name of the user.                                         |
  </Tab>

  <Tab title="Channel">
    | **Variable**      | Output                                         |
    | :---------------- | :--------------------------------------------- |
    | `channel`         | The name of the channel.                       |
    | `channel.name`    | The name of the channel.                       |
    | `channel.id`      | The unique 18-digit Discord ID of the channel. |
    | `channel.mention` | Tags the channel with a clickable mention.     |
    | `channel.topic`   | The topic set for the channel.                 |
  </Tab>

  <Tab title="Moderator">
    | **Variable**                           | Output                                                                  |
    | :------------------------------------- | :---------------------------------------------------------------------- |
    | `moderator.mention` / `mod.mention`    | Tags the moderator with a clickable mention.                            |
    | `moderator.name` / `mod.name`          | The username of the moderator.                                          |
    | `moderator.display_name`               | The display name of the moderator.                                      |
    | `moderator.nick`                       | The moderator's nickname in the server.                                 |
    | `moderator.tag`                        | The moderator's full Discord tag.                                       |
    | `moderator.discriminator`              | The discriminator of the moderator.                                     |
    | `moderator.id`                         | The unique 18-digit Discord ID of the moderator.                        |
    | `moderator.avatar`                     | The direct URL to the moderator's current profile picture.              |
    | `moderator.display_avatar`             | The direct URL to the moderator's display avatar.                       |
    | `moderator.color` / `moderator.colour` | The moderator's display hex color based on their highest role.          |
    | `moderator.top_role`                   | The name of the moderator's highest role.                               |
    | `moderator.joined_at`                  | The date the moderator joined the server.                               |
    | `moderator.joined_at_timestamp`        | The formatted timestamp of the server join date.                        |
    | `moderator.created_at`                 | The date the moderator's Discord account was created.                   |
    | `moderator.created_at_timestamp`       | The formatted timestamp of the account creation date.                   |
    | `moderator.boost`                      | Whether the moderator is currently boosting the server (true or false). |
    | `moderator.boost_since`                | The date the moderator started boosting the server.                     |
    | `moderator.bot`                        | Whether the moderator account is a bot (true or false).                 |
    | `reason`                               | The reason provided for the moderation action.                          |
    | `duration`                             | The duration of the moderation action.                                  |
  </Tab>

  <Tab title="Victim">
    | **Variable**                     | Output                                                               |
    | :------------------------------- | :------------------------------------------------------------------- |
    | `victim.mention`                 | Tags the victim with a clickable mention.                            |
    | `victim.name`                    | The username of the victim.                                          |
    | `victim.display_name`            | The display name of the victim.                                      |
    | `victim.nick`                    | The victim's nickname in the server.                                 |
    | `victim.tag`                     | The victim's full Discord tag.                                       |
    | `victim.discriminator`           | The discriminator of the victim.                                     |
    | `victim.id`                      | The unique 18-digit Discord ID of the victim.                        |
    | `victim.avatar`                  | The direct URL to the victim's current profile picture.              |
    | `victim.display_avatar`          | The direct URL to the victim's display avatar.                       |
    | `victim.color` / `victim.colour` | The victim's display hex color based on their highest role.          |
    | `victim.top_role`                | The name of the victim's highest role.                               |
    | `victim.joined_at`               | The date the victim joined the server.                               |
    | `victim.joined_at_timestamp`     | The formatted timestamp of the server join date.                     |
    | `victim.created_at`              | The date the victim's Discord account was created.                   |
    | `victim.created_at_timestamp`    | The formatted timestamp of the account creation date.                |
    | `victim.boost`                   | Whether the victim is currently boosting the server (true or false). |
    | `victim.bot`                     | Whether the victim account is a bot (true or false).                 |
  </Tab>

  <Tab title="Level">
    | **Variable**     | Output                           |
    | :--------------- | :------------------------------- |
    | `level.new_rank` | The user's new level rank.       |
    | `level.user_xp`  | The total XP amount of the user. |
  </Tab>

  <Tab title="Last.fm">
    | **Variable**           | Output                                         |
    | :--------------------- | :--------------------------------------------- |
    | `user.name`            | The Last.fm username.                          |
    | `user.avatar`          | The direct URL to the Last.fm profile picture. |
    | `user.plays`           | The total number of scrobbles.                 |
    | `user.url`             | The direct URL to the Last.fm profile.         |
    | `author`               | The Discord author object.                     |
    | `author.name`          | The username of the Discord author.            |
    | `author.nickname`      | The nickname of the Discord author.            |
    | `author.discriminator` | The discriminator of the Discord author.       |
    | `album.name`           | The name of the album.                         |
    | `lower(album.name)`    | The album name converted to lowercase.         |
    | `album.url`            | The direct URL to the album page.              |
    | `album.cover`          | The direct URL to the album cover image.       |
    | `track.name`           | The name of the track.                         |
    | `lower(track.name)`    | The track name converted to lowercase.         |
    | `track.url`            | The direct URL to the track page.              |
    | `track.spotify_url`    | The direct URL to the track on Spotify.        |
    | `track.plays`          | The total number of plays for the track.       |
    | `artist.name`          | The name of the artist.                        |
    | `lower(artist.name)`   | The artist name converted to lowercase.        |
    | `artist.plays`         | The total number of plays for the artist.      |
    | `artist.url`           | The direct URL to the artist page.             |
    | `artist.image`         | The direct URL to the artist image.            |
  </Tab>
</Tabs>

## 2. Frequently Asked Questions

### 2. 1. Where can I use these variables?

You can use these in any command that has a `message` or `embed code` parameter. This includes automated posts, custom responses, and greeting messages.

### 2. 2. What happens if I use a variable incorrectly?

If a variable is misspelled (e.g., `{uesr}`), **@curse** will treat it as plain text and won't replace it with dynamic data. Always double-check your spelling against this guide!
