Variables
Variables allow you to easily add information about the voter, bot, server and more into your custom vote embeds
Variable Formatting
Variables require lowercase letters and must be surrounded with {}
.
Incorrect Variable Formatting
Correct Variable Formatting
TagScript V1
TagScript V1 is now deprecated and will not work inside of Vote Messages anymore. If you notice tags not getting replaced, make sure to check its a TagScript V2 variable
Text Variables
The following variables are supported in all embed fields except image & field name & values. Please see below for a list of supported variables for images
Name | Description | Bots | Servers |
---|---|---|---|
tag | Voters username & tag | ||
id | Voters user ID | ||
mention | Mentions the voter | ||
total_votes | Voters total votes for the bot/server | ||
monthly_votes | Voters votes for the bot/server this month | ||
platform | Platform the bot/server was voted on | ||
link | Link to vote for the bot/servre | ||
date | Current date | ||
role | Role given to voters | ||
duration | Duration vote role is kept for | ||
guild_name | Name of the voted or current server | ||
guild_id | ID of the voted or current server | ||
bot_name | Name of the voted bot | ||
bot_mention | Mentions the voted bot |
Image Variable List
The following variables are only supported for the author, footer & main image fields of the vote embed
Name | Description | Bots | Servers |
---|---|---|---|
user_avtar | Voters icon | ||
app_icon | Icon of the voted bot/server |
TagScript V2
TagScript V2 is our current system for variables & dynamic content in messages. TagScript V1 only supported text variables and a few image variables, with inconsistent naming and formats. TagScript V2 fixes those issues
All V2 tags has a Top Level Tag, followed by a period (.
) and then a property. This makes it much easier to see what a tag is for and gives access to many more tags
In addition to those improvements, TagScript V2 adds more types of tag: Colour, Link & Date tags. Some can be used with the existing setup commands & embed customisation in Discord, and some, such as link tags, will only be useful when customising the extra fields available in the Dashboard
Top Level Tags
Some Top Level Tags have replaced values, usually mentions, if no additional property is specified
Tag | Description | Value |
---|---|---|
| Contains information about the user who voted |
|
| Contains information about the guild the tracker is setup in | |
| Contains information about the bot that was voted for |
|
| Contains information about the platform that the vote was on | |
| Contains information about the rewards given | |
| Contains information about the rewards given by Miki, if setup |
If a server was voted for, then any app
tags will be replaced with nothing, or may not the replaced at all. The guild
tag will always be replaced with the data of the server the vote message is to be sent in, even if the target was a bot
voter
Properties
voter
PropertiesTag | Description | Valid For |
---|---|---|
| ID of the voter | Text |
| Username of the voter | Text |
| Voter's global display name, falls back to | Text |
| Voter's nickname, or | Text |
| Voter's total votes | Text |
| Date voter's account was created on | TextDate |
| Date the voter joined the server | TextDate |
| Voter's avatar | ImageLink |
| Voter's banner | ImageLink |
| Voter's profile accent colour. Will fallback to default embed if not set | Colour |
| Voter's profile banner colour. Will fallback to default embed if not set | Colour |
guild
Properties
guild
PropertiesTag | Description | Valid For |
---|---|---|
| ID of the server | Text |
| Name of the server | Text |
| Date server was created | TextDate |
| Server icon | ImageLink |
| Server banner | ImageLink |
app
Properties
app
PropertiesTag | Description | Valid For |
---|---|---|
| ID of the voted bot | Text |
| Name of the voted bot | Text |
| Date the voted bot was made | TextDate |
| Date the voted bot joined the server | TextDate |
| Avatar of the voted bot | ImageLink |
platform
Properties
platform
PropertiesTag | Description | Valid For |
---|---|---|
| Name of the platform voted on | Text |
| Relative time until the user can vote (e.g. in 6 hours) | Text |
| Time when the user is next able to vote | TextDate |
| Link to the platform | TextLink |
| Link to the bot/servers page on the platform | TextLink |
| Link to vote on the platform | TextLink |
| Platform's icon/logo | ImageLink |
rewards
Properties
rewards
PropertiesTag | Description | Valid For |
---|---|---|
| Mention the primary reward role | Text |
| ID of the primary reward role | Text |
| Duration primary reward role is kept for | Text |
miki
Properties
miki
PropertiesTag | Description | Valid For |
---|---|---|
| Bucket that given EXP is in | Text |
| Amount of EXP given to voter | Text |
| If the user has levelled up | Text |
Additional Tags
These tags have no Top Levels Tags and are used as just {tag}
Tag | Description | Valid For |
---|---|---|
| Current date | TextDate |
| Voter's votes in the monthly bucket. | Text |
Last updated