Skip to content

🧩 Placeholders

Mirage provides a set of placeholders that can be used with PlaceholderAPI to display player balances, statistics, and leaderboard data across your server.

These placeholders are commonly used in: - Scoreboards - Chat formats - GUIs - Holograms - Tab lists

💰 Player Currency Balances

These placeholders display a player’s current balance for each Mirage currency.

Placeholder Description
%mirage_shard_balance% Displays the player’s Shard balance
%mirage_crystal_balance% Displays the player’s Crystal balance
%mirage_essence_balance% Displays the player’s Essence balance
%mirage_credit_balance% Displays the player’s Credit balance
%mirage_gem_balance% Displays the player’s Gem balance

🏆 Currency Leaderboards

These placeholders display the player name at a specific position on each currency leaderboard.

Replace x with a number between 1 and 10.

Placeholder Description
%mirage_credit_top.x% Player at position x on the Credit leaderboard
%mirage_crystal_top.x% Player at position x on the Crystal leaderboard
%mirage_essence_top.x% Player at position x on the Essence leaderboard
%mirage_gem_top.x% Player at position x on the Gem leaderboard
%mirage_shard_top.x% Player at position x on the Shard leaderboard

📊 Statistic Leaderboards

These placeholders display the top players for tracked Mirage statistics.

Replace x with a number between 1 and 10.

Placeholder Description
%mirage_crops_broken_top.x% Player at position x for crops broken
%mirage_mob_top.x% Player at position x for mobs killed
%mirage_fish_top.x% Player at position x for fish caught
%mirage_cane_top.x% Player at position x for sugarcane harvested
%mirage_blocks_broken_top.x% Player at position x for blocks broken

⚙ Requirements

  • PlaceholderAPI must be installed
  • Mirage must be loaded and enabled
  • Leaderboards must have at least one recorded entry to display data

📝 Notes

  • Leaderboard placeholders return player names, not values
  • If a leaderboard position is empty, the placeholder may return an empty value
  • Placeholder updates depend on your PlaceholderAPI refresh settings

🎯 Common Use Cases

  • Scoreboard displays
  • Top-10 holograms
  • Chat rank formatting
  • GUI balance displays
  • Event and competition tracking