Variables - mira

A variable is {object.property}. When the script runs, it’s swapped for the real value.

{description: {user.mention} joined — that's {guild.members} members now.}

Which variables exist depends on where the script runs. A welcome message knows about the member who joined; a ticket message knows about the ticket. The common ones below are available almost everywhere.

If a variable doesn’t exist in the current context, it’s left in the output as literal text. Seeing {user.rank} in your message means that variable isn’t available there — not that it’s spelled wrong.

Member

{user} on its own renders as a mention.

Variable	Result
`{user}` / `{user.mention}`	`@someone`
`{user.name}`	`someone`
`{user.display_name}`	Their nickname, or username if unset
`{user.global_name}`	Their display name
`{user.id}`	`1234567890`
`{user.avatar}`	URL to their avatar
`{user.created_at}`	Account creation, as a Discord timestamp
`{user.joined_at}`	When they joined this server
`{user.join_position}`	`47` — the Nth member to join
`{user.top_role}`	Their highest role
`{user.roles}`	Comma-separated role names
`{user.role_ids}`	Comma-separated role IDs
`{user.color}`	Their role colour
`{user.bot}`	`True` / `False`

user, member, author, u and m are interchangeable. {member.name} and {u.name} are the same as {user.name} — use whichever reads better to you.

Server

Variable	Result
`{guild.name}`	Your server’s name
`{guild.id}`	Its ID
`{guild.icon}`	URL to the icon
`{guild.members}`	Total member count
`{guild.humans}`	Non-bot members
`{guild.bots}`	Bot members
`{guild.boosters}`	Number of boosters
`{guild.boosts}`	Boost count
`{guild.boost_tier}`	`0`–`3`
`{guild.vanity}`	Vanity code, e.g. `mira`
`{guild.vanity_url}`	The full `discord.gg/...` link
`{guild.created_at}`	When the server was made
`{guild.owner}`	The owner

Aliases: guild, server, sv, g, s. {server.name} works.

Channel

Variable	Result
`{channel}` / `{channel.mention}`	`#general`
`{channel.name}`	`general`
`{channel.id}`	Its ID
`{channel.topic}`	The channel topic

Aliases: channel, ch, c.

Context-specific variables

Invites — welcome, goodbye and rejoin

Available in welcome, goodbye and rejoin messages: who invited the member, and through which invite.

Variable	From a member’s invite	From the vanity URL, or unknown
`{inviter}` / `{inviter.name}`	Their username	`discord.gg/yourvanity` (or `Vanity URL`)
`{inviter.display_name}`	Their display name	Same as above
`{inviter.mention}`	`@inviter` — pings them	Same as above, as plain text — no ping
`{inviter.id}`	Their ID	Empty
`{inviter.avatar}`	Their avatar	The server’s icon
`{inviter.invites}`	Their invite total (bonus included)	`0`
`{inviter.invites_today}` · `_weekly` · `_monthly`	Invites in that window	`0`
`{inviter.invites_regular}`	Invites still in the server	`0`
`{inviter.invites_left}`	Invited members who left	`0`
`{inviter.invites_fake}`	Invites flagged as fake	`0`
`{inviter.invites_bonus}`	Bonus invites added by staff	`0`
`{inviter.is_vanity}`	`false`	`true`
`{invites}`	Same as `{inviter.invites}`	`0`
`{invite}` / `{invite.url}`	`discord.gg/code`	The vanity link
`{invite.code}`	The invite code	The vanity code
`{invite.uses}`	How often that invite’s been used	`0`
`{invite.is_vanity}`	`false`	`true`

When the join wasn’t from a person’s invite — someone came in through your vanity URL, or mira couldn’t tell which invite was used — there’s no inviter to describe, so the inviter variables fall back to the server: the name and mention read as your vanity link, the avatar is the server icon, and every count is 0. Nothing is left as a raw {inviter.mention}, so a template never breaks; use {inviter.is_vanity} to word it differently:

{content: welcome {user.mention}!}
{description: {if: {inviter.is_vanity} && you found us through **{invite.url}** && invited by {inviter.mention} — their {inviter.invites|ordinal} invite}}
{thumbnail: {inviter.avatar}}

{inv.*} and {invited_by.*} work as aliases for {inviter.*}, and {invite_url} for {invite}.

Invite tracking needs mira to be able to see invites (Manage Server). Without it, every join counts as unknown and gets the server fallback above.

Levels

Available in !level message:

Variable	Result
`{user.level}`	The level just reached
`{user.next_level}`	The one after it
`{user.xp}`	XP toward the current level
`{user.total_xp}`	Lifetime XP
`{user.required_xp}`	XP needed for the next level

!level message {content: gg {user.mention}} {description: level **{user.level}** — {user.required_xp} xp to {user.next_level}} {color: dominant}

Moderation

Available in !invoke responses, which override what moderation commands reply with:

Variable	Result
`{user}`	The member being punished
`{moderator}`	Who ran the command
`{reason}`	The reason given
`{case}`	The case number
`{duration}`	For temp punishments

!invoke ban {content: {user.name} got hit — case #{case}} {description: {reason}}

!invoke variables lists them in Discord.

Tickets

Available in ticket option messages:{case}, {panel}, {option}, {creator}, {claimer}, {reason}, plus {user} for whoever triggered the action.

!tickets option message Support billing greeting {title: Ticket #{case}} {description: hey {creator.mention} — someone will be with you shortly.}

Vanity and tag roles

In !vanity message and !tag message, {user} is the member who was awarded a role and {role} is the role they got.

Counter channels

Counter channel names use a different, flatter variable set — no user. or guild. prefix. {members}, {boosters}, {online}, {messages_today}, {voice_week} and so on. See Counters for the full list, or run !counter variables.

Last.fm

Available in !lastfm mode and !lastfm reskin username. Four objects, each rendering as its name on its own:

Object	Notable properties
`{track}`	`name` `url` `image` `plays` `duration` `spotify_url` `nowplaying` `timestamp` `crown` `whoknows_position`
`{artist}`	`name` `url` `image` `plays` `spotify_url` `crown` `whoknows_position`
`{album}`	`name` `url` `cover` `crown` `whoknows_position`
`{lastfm}`	`name` `url` `avatar` `scrobbles` `artists` `albums` `tracks`

{old_track}, {old_artist} and {old_album} hold whatever played before the current track.

!lastfm mode {title: {track.name}} {description: by **{artist.hyperlink}** on *{album.name}*} {thumbnail: {track.image}} {footer: {track.plays} plays && {lastfm.avatar}}

See Now playing for every property, the crown and whoknows aliases, and the .lower / .upper / .hyperlink suffixes.

VoiceMaster

!voicemaster default name accepts {user.name}, and defaults to something like {user.name}'s channel.

Timestamps and durations

Any date variable renders as a raw Unix timestamp, which you can drop straight into Discord’s timestamp markdown:

{description: account made <t:{user.created_at}:R>}

Renders as account made 3 years ago. Every date also takes a named suffix — {user.created_at.relative} does the same thing without the markup — and every duration takes .short, .seconds, .hours and friends. See timestamps & durations for the full set, which works identically on every date and duration in the bot.

Finding what’s available

Most modules have a variables subcommand that lists exactly what that context supports:

!welcome variables
!goodbye variables
!boost variables
!rejoin variables
!pingonjoin variables
!invoke variables
!counter variables
!autothread variables

Variables compose with operators. {guild.members|comma} gives 1,247, {user.name|upper} shouts, and {if: {user.bot}==True && beep boop && welcome} branches on a value.

​Member

​Server

​Channel

​Context-specific variables

​Timestamps and durations

​Finding what’s available

Member

Server

Channel

Context-specific variables

Timestamps and durations

Finding what’s available