Skip to content

Placeholders

Ali Arslan edited this page Apr 11, 2026 · 1 revision

Placeholders

Placeholders are variables replaced with live values in messages, command responses, embeds, and nicknames. This page lists every placeholder supported across the plugin.


Server Placeholders

Available in: custom commands, server stats, chat bridge, join/leave logs, presence messages.

Placeholder Description Example
%server_name% Server name from config Survival
%online_players% Number of players currently online 42
%max_players% Server player slot limit 100
%server_tps% 1-minute average TPS 19.98
%server_mspt% Milliseconds per tick 2.4
%server_uptime% Time since server started 3h 12m
%server_ram_used% JVM heap memory in use (MB) 2048
%server_ram_max% JVM max heap memory (MB) 8192
%server_version% Paper/Spigot version string Paper 1.21.4

Player Placeholders

Available in: custom commands, rank sync post-link commands, boost reward commands, level reward commands, punishment sync, audit logs.

Placeholder Description Notes
%player_name% Minecraft username Always available when player is known
%player_uuid% Minecraft UUID (dashed) Always available when player is known
%player_level% XP level Player must be online
%player_health% Current health points Player must be online
%player_food_level% Current hunger Player must be online
%player_exp% Experience points Player must be online
%player_world% Current world name Player must be online
%player_x% X coordinate Player must be online
%player_y% Y coordinate Player must be online
%player_z% Z coordinate Player must be online
%player_ip% Connecting IP address Available in 2FA embeds
%player_location% GeoIP country/city Requires GeoIP enabled

Discord Placeholders

Available in: custom commands, audit logs, join/leave logs, presence messages.

Placeholder Description
%discord_id% Discord user snowflake ID
%discord_name% Discord display name
%discord_tag% Full Discord tag (username#discriminator)
%total_boosts% Number of active server boosts
%linked_accounts% Total number of linked accounts in the database
%member_count% Total Discord server member count
%channel_name% Name of the Discord channel (chat bridge)

Nickname Format Placeholders

Available specifically in rank-sync.ymlnickname.format.

Placeholder Description Example
%player_name% Minecraft username Steve
%discord_name% Discord display name steve
%server_name% Server name from config Survival
%primary_rank% Highest-priority LuckPerms group admin
%all_ranks% All groups joined by comma admin, vip

Economy Placeholders (Vault)

Available in: custom commands. Requires Vault and an economy plugin (e.g., EssentialsX, CMI).

Placeholder Description Example
%vault_eco_balance% Raw balance number 15000
%vault_eco_balance_formatted% Formatted balance string $15,000.00

Event-Specific Placeholders

Boost Reward Commands

Placeholder Description
%player_name% Claiming player's Minecraft name
%player_uuid% Claiming player's UUID
%discord_id% Linked Discord user ID
%discord_name% Linked Discord username
%server_name% Server where claim was made

Level Reward Commands

Placeholder Description
%player_name% Minecraft username
%player_uuid% Minecraft UUID
%discord_id% Discord user ID
%level% Level being claimed
%server_name% Server name

Punishment Sync Reasons

Placeholder Description
%reason% Punishment reason
%player_name% Punished player's Minecraft name
%discord_name% Punished user's Discord name
%duration% Punishment duration
%moderator% Who issued the punishment

Join/Leave Log Messages

Placeholder Description
%player_name% Minecraft username
%player_uuid% Minecraft UUID
%discord_name% Discord username
%discord_id% Discord user ID
%server_name% Server name
%online_players% Player count after the event
%member_count% Discord member count after the event

2FA Embed

Placeholder Description
%player_name% Minecraft username
%player_uuid% Minecraft UUID
%player_ip% Connecting IP address
%player_location% Country/city from GeoIP
%server_name% Server name
%timestamp% Event date and time

PlaceholderAPI Integration

If PlaceholderAPI is installed, the plugin also passes supported fields through PAPI. This means any PAPI-compatible placeholder (%essentials_vanished%, %luckperms_prefix%, etc.) can be used inside custom command response templates.

response:
  type: text
  content: "Your prefix is: %luckperms_prefix%"

PlaceholderAPI is an optional soft dependency. The plugin works without it, but third-party PAPI placeholders are unavailable.

Clone this wiki locally