Docs
Placeholders
PulsePrison supports two placeholder systems:
| System | Format | Requirement |
|---|---|---|
| Native PulsePrison | %%pulseprison_...%% | None (works on its own) |
| PlaceholderAPI | %pulseprison_...% | PlaceholderAPI installed |
Every numeric placeholder accepts the
_compact(1.5M) and_commas(1,500,000) suffixes, for example%pulseprison_tokens_compact%.
Currency placeholders
| Placeholder | Returns |
|---|---|
%pulseprison_currency_<id>% | Compact balance of any currency in currencies.yml |
%pulseprison_currency_<id>_formatted% | With the currency format |
%pulseprison_currency_<id>_full% | With thousands separators |
%pulseprison_currency_<id>_raw% | Unformatted number |
%pulseprison_currency_<id>_name% | Name with color |
Level placeholders
| Placeholder | Returns |
|---|---|
%pulseprison_level_<track>% | Track level |
%pulseprison_level_<track>_exp% · _required% | Current and required experience |
%pulseprison_level_<track>_progress% · _bar% | Percentage and bar |
%pulseprison_level_<track>_max% · _name% | Max level and name |
Rank and prestige placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_rank% | Current rank | C |
%pulseprison_next_rank% | Next rank (or "MAX") | D |
%pulseprison_prestige% | Prestige level | 3 |
%pulseprison_rankup_progress% | Rankup progress | 65.3% |
%pulseprison_rankup_progress_bar% | ASCII progress bar | [████░░░░░░] |
Rebirth and multiplier placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_rebirth% | Rebirth level | 2 |
%pulseprison_rebirth_bonus% | Permanent sell bonus | 20% |
%pulseprison_multiplier_total% | Total multiplier | x2.5 |
%pulseprison_multiplier_global% | Active global multiplier | x2.0 |
%pulseprison_multiplier_personal% | Active personal multiplier | x1.5 |
Economy placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_balance% | Money balance | 15000.00 |
%pulseprison_money% | Balance (alias) | 15000.00 |
%pulseprison_balance_formatted% | Formatted balance | $15.0K |
%pulseprison_tokens% | Tokens | 5000 |
%pulseprison_gems% | Gems | 120 |
Clan placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_clan_name% | Clan name | Dragons |
%pulseprison_clan_tag% | Clan tag | [DRG] |
%pulseprison_clan_level% | Clan level | 3 |
%pulseprison_clan_members% | Member count | 8 |
%pulseprison_clan_balance% | Clan bank | 50000.00 |
%pulseprison_clan_value% | Value mined by the clan (/clan top leaderboard) | 1.2M |
Pickaxe placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_pickaxe_level% | Pickaxe level | 45 |
%pulseprison_pickaxe_exp% | Current EXP | 3200 |
%pulseprison_pickaxe_exp_needed% | EXP for the next level | 4500 |
%pulseprison_pickaxe_progress% | Progress in % | 71.1 |
%pulseprison_pickaxe_blocks_mined% | Blocks mined (formatted) | 1.5M |
%pulseprison_pickaxe_enchant_<id>% | Level of a specific enchant | 3 |
Skill tree placeholders
| Placeholder | Description |
|---|---|
%pulseprison_skill_points% | Unspent points |
%pulseprison_skill_points_spent% | Invested points |
%pulseprison_skill_bonus_<effect>% | Bonus of sell_bonus, token_bonus, gem_bonus, exp_bonus or enchant_power |
Market placeholders
| Placeholder | Description |
|---|---|
%pulseprison_market_price_<block>% | Current block price |
%pulseprison_market_trend_<block>% | Block trend |
Pet placeholders
| Placeholder | Description |
|---|---|
%pulseprison_pet_name% | Active pet, or None |
%pulseprison_pet_display% | Active pet with rarity color |
%pulseprison_pet_level% | Active pet level |
%pulseprison_pet_rarity% | Active pet rarity |
%pulseprison_pet_count% | Unlocked pets |
%pulseprison_pet_total% | Existing pets |
%pulseprison_pet_bonus_<effect>% | Current bonus of an effect |
Robot placeholders
| Placeholder | Description |
|---|---|
%pulseprison_robots_count% | Player's robots |
%pulseprison_robots_limit% | Robot limit |
%pulseprison_robots_stored% | Blocks waiting in their robots |
Season placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_season_name% | Season name | Season 1 |
%pulseprison_season_number% | Season number | 1 |
%pulseprison_season_status% | Status | ACTIVE |
%pulseprison_season_start% | Start date | Jan 01, 2026 |
%pulseprison_season_end% | End date | Jan 31, 2026 |
%pulseprison_season_time_left% | Time left (long) | 5d 3h 22m |
%pulseprison_season_time_left_short% | Time left (short) | 5d |
%pulseprison_season_players% | Unique players | 150 |
%pulseprison_season_total_points% | Total points | 1500000 |
%pulseprison_season_my_points% | Your points | 5430 |
%pulseprison_season_my_position% | Your position | #12 |
%pulseprison_season_my_blocks% | Your blocks this season | 1500 |
%pulseprison_season_my_money% | Your money this season | 50000.00 |
%pulseprison_season_my_rankups% | Your rankups this season | 3 |
%pulseprison_season_top{N}_name% | Top N name | PlayerX |
%pulseprison_season_top{N}_points% | Top N points | 50000 |
Server placeholders
| Placeholder | Description | Example |
|---|---|---|
%pulseprison_server_players% | Online players | 42 |
%pulseprison_server_max_players% | Max players | 100 |
%pulseprison_server_tps% | Server TPS | 19.98 |
Private mine placeholders
With the private-mines module enabled. They are evaluated for the player with %pulseprison_pmine_<key>%; the %pulseprison_pmine_here_<key>% prefix uses the mine the player stands in. Blocks and percentages only count the current mineable zone.
| Key | Description |
|---|---|
has, owner, id, type, stage, stage_number, stages | Whether they own a mine, owner, type id and name, stage |
expansions, max_expansions, size | Expansion and virtual size |
tax, open, members, visitors | Access and visitors |
blocks_mined, blocks_remaining, blocks_total | Zone status |
percent_mined, percent_remaining, reset_percent, reset_cooldown | Percentages and reset |
Internal placeholders (for plugin configs)
Used with double percent %%...%% in internal configuration files:
| Placeholder | Description |
|---|---|
%%player_name%% | Player name |
%%player_ping%% | Ping in ms |
%%player_level%% | Minecraft XP level |
%%pulseprison_rank%% | Current rank |
%%pulseprison_next_rank%% | Next rank |
%%pulseprison_prestige%% | Prestige |
%%pulseprison_rankup_progress%% | Progress % |
%%pulseprison_rankup_progress_bar%% | Visual bar |
%%pulseprison_balance%% | Balance |
%%pulseprison_clan_tag%% | Clan tag |
%%pulseprison_blocks_mined%% | Blocks mined |
%%pulseprison_server_tps%% | TPS |
%%pulseprison_server_players%% | Online players |
%%pulseprison_server_max_players%% | Max players |
%%pulseprison_playtime_minutes%% | Playtime (minutes) |
%%pulseprison_playtime_hours%% | Playtime (hours) |
Usage in other plugins
yaml
# In a TAB plugin (requires PlaceholderAPI):
header: "&b⛏ PULSEPRISON ⛏"
footer: "&7Players: &f%pulseprison_server_players%&7/&f%pulseprison_server_max_players% | %pulseprison_server_tps% TPS"
# In a hologram plugin:
lines:
- "&6Top Season Player"
- "&f%pulseprison_season_top1_name%"
- "&ePoints: %pulseprison_season_top1_points%"
# In DeluxeChat or similar:
format: "%pulseprison_clan_tag% [%pulseprison_rank%] {player}: {message}"