Placeholders¶
zFrostBoats works with PlaceholderAPI. That lets you show a player's stats and live match info on scoreboards, in chat, in tab, in holograms, and anywhere else that supports placeholders.
You need PlaceholderAPI installed
These only work if the PlaceholderAPI plugin is on your server. zFrostBoats finds it automatically on startup and turns the placeholders on. Nothing to set up on our side.
No PlaceholderAPI? The plugin still runs fine. You just will not have these tags.
Every placeholder starts with %zfrostboats_. For example, a player's wins is %zfrostboats_wins%.
Player stats¶
These show the player's saved, all-time numbers. They work for any player, even offline ones (in tools that look up offline players).
| Placeholder | Shows |
|---|---|
%zfrostboats_wins% |
Matches won |
%zfrostboats_kills% |
Players shattered |
%zfrostboats_deaths% |
Times shattered |
%zfrostboats_kd% |
Kill/death ratio (for example 1.75) |
%zfrostboats_games_played% |
Matches played |
%zfrostboats_win_rate% |
Win percentage (for example 42.5) |
%zfrostboats_territory_claimed% |
Total ice claimed across all matches |
%zfrostboats_avg_territory% |
Average ice claimed per match |
%zfrostboats_longest_streak% |
Best win streak |
%zfrostboats_time_played% |
Time spent in matches (for example 3h 12m) |
A loading dot
The very first time a stat is asked for, you may see ... for a second while it loads from storage. It fills in right after. This keeps the server smooth and never freezes it to read the database.
Live match¶
These show what is happening in the player's current match. If the player is not in a match, you get a sensible default (no, -, or 0).
| Placeholder | Shows |
|---|---|
%zfrostboats_in_game% |
yes or no |
%zfrostboats_state% |
Match state: WAITING, COUNTDOWN, IN_GAME, ENDING, RESETTING |
%zfrostboats_slot% |
The match's slot number |
%zfrostboats_color% |
The player's colored name word (for example a red Red) |
%zfrostboats_color_name% |
The player's color as plain text (for example Red) |
%zfrostboats_territory% |
The player's ice share this match, as a percent (for example 12.4) |
%zfrostboats_alive% |
yes if still in, no if shattered |
%zfrostboats_match_kills% |
Players this player has shattered this match |
%zfrostboats_match_players% |
How many players are in the match |
%zfrostboats_match_alive% |
How many players are still alive |
%zfrostboats_place% |
Finish place once out or won (also %zfrostboats_rank%) |
Server wide¶
These are about the whole server, not one player.
| Placeholder | Shows |
|---|---|
%zfrostboats_active_matches% |
Number of matches running right now |
%zfrostboats_players_in_games% |
Total players across all matches |
Leaderboard¶
Show the top players in any category, by rank. Swap in the category and the rank number.
The pattern is:
%zfrostboats_top_<category>_<rank>_name% -> the player's name
%zfrostboats_top_<category>_<rank>_value% -> their number
<category> |
Ranks by |
|---|---|
wins |
Matches won |
kills |
Players shattered |
territory |
Total ice claimed |
win_rate |
Win percentage |
<rank> is a number from 1 to 10.
1 is the best player in that category.
| Placeholder | Shows |
|---|---|
%zfrostboats_top_wins_1_name% |
Name of the #1 player by wins |
%zfrostboats_top_wins_1_value% |
That player's win count |
%zfrostboats_top_kills_3_name% |
Name of the #3 player by kills |
%zfrostboats_top_territory_5_value% |
#5 player's total ice claimed |
%zfrostboats_top_win_rate_1_name% |
Name of the player with the best win rate |
Leaderboards refresh on their own
The top lists update every 30 seconds in the background, so they stay current without slowing the server. If a rank has no player yet, the name shows - and the value shows 0.
A quick example¶
A simple scoreboard line built from placeholders might look like this:
&fWins: &e%zfrostboats_wins% &fK/D: &e%zfrostboats_kd%
&fTop player: &e%zfrostboats_top_wins_1_name%
A placeholder shows nothing or stays as text?
- Make sure PlaceholderAPI is installed and the server has been restarted.
- Check the spelling. Every tag starts with
%zfrostboats_and ends with%. - For leaderboard tags, check the category and rank are valid (rank
1to10).
Still stuck? See Support and tell us the exact placeholder you used and what you saw.