Skip to content

Placeholders

Jump to bottom
Paul McSweeney edited this page Sep 2, 2021 · 11 revisions

The following placeholders are supported by Boost for use with PlaceholderAPI.

Holograms

You can use these PAPI-supported placeholders on holograms. You will need a hologram plugin and a plugin to allow that hologram plugin to use placeholders through PlaceholderAPI and ProtocolLib

Example command when using: Holographic Displays, AND Holographic Extension or Holographic Placeholders, AND ProtocolLib

/hd create topMontly First: {slow}%boost_top_monthly_first_player% - {slow}%boost_top_monthly_first_wins% wins

That will create a hologram called topMonthly with one line showing the top player and their win count over the last month, e.g. "First: pmme - 99 wins". You would then use "/hd addline topMonthly ..." to add extra lines for the second player, third and so on. Specifying {slow} update speed means it will update every 5 seconds, which should be fast enough for general use.

Example command when using: Holograms, AND Holograms-Placeholders, AND ProtocolLib

/holograms create arena1weekly 1st %boost_top_weekly_first_player_Arena3% - %boost_top_weekly_first_wins_Arena3%

That will create a hologram called arena1weekly with one line showing the top player and their win count in a game named Arena3 over the last week, e.g. "1st pmme - 43". You would then use "/holograms addline arena1weekly ..." to add extra lines for the second player, third and so on.

Leader board placeholders

General placeholder pattern

The leader board placeholders follow a pattern: %boost_top_<period>_<position>_<stat>% or %boost_top_<period>_<position>_<stat>_<game>% where the values in < > are each one of the following:

  • <period> is one of total, monthly, weekly or daily.
  • <position> is one of first, second, third, fourth, fifth, sixth, seventh, eighth, ninth or tenth.
  • <stat> is one of player, wins, losses, games, besttime, lasttime, avgtime or rank.
  • <game> is one of your game nodes under games: in config.yml.

Example leader board placeholders across all game arenas played are as follows:

Placeholders for stats across all game arenas can fetch only the wins, losses, games or rank stats. These placeholders do not include time stats on parkour arenas, which are time-based.

Overall leader board

Placeholder Retrieved value
%boost_top_total_first_player% Name of the player at the top of the leader board.
%boost_top_total_first_wins% Number of games won by the player at the top of the leader board.
%boost_top_total_first_losses% Number of games lost by the player at the top of the leader board.
%boost_top_total_first_games% Number of games played by the player at the top of the leader board.
%boost_top_total_first_rank% Rank number of the player at the top of the leader board.
%boost_top_total_second_player% Name of the player coming second on the leader board.
%boost_top_total_second_wins% Number of games won by the player coming second on the leader board.
... ...
%boost_top_total_tenth_player% Name of the player coming tenth on the leader board.
%boost_top_total_tenth_wins% Number of games won by the player coming tenth on the leader board.
%boost_top_total_tenth_losses% Number of games lost by the player coming tenth on the leader board.
%boost_top_total_tenth_games% Number of games played by the player coming tenth on the leader board.
%boost_top_total_tenth_rank% Rank number of the player coming tenth on the leader board.

Monthly leader board

Placeholder Retrieved value
%boost_top_monthly_first_player% Name of the player at the top of this month's leader board.
%boost_top_monthly_first_wins% Number of games won by the player at the top of this month's leader board.
%boost_top_monthly_first_losses% Number of games lost by the player at the top of this month's leader board.
%boost_top_monthly_first_games% Number of games played by the player at the top of this month's leader board.
%boost_top_monthly_first_rank% Rank number of the player at the top of this month's leader board.
%boost_top_monthly_second_player% Name of the player coming second on this month's leader board.
%boost_top_monthly_second_wins% Number of games won by the player coming second on this month's leader board.
... ...
%boost_top_monthly_tenth_player% Name of the player coming tenth on this month's leader board.
%boost_top_monthly_tenth_wins% Number of games won by the player coming tenth on this month's leader board.
%boost_top_monthly_tenth_losses% Number of games lost by the player coming tenth on this month's leader board.
%boost_top_monthly_tenth_games% Number of games played by the player coming tenth on this month's leader board.
%boost_top_monthly_tenth_rank% Rank number of the player coming tenth on this month's leader board.

Weekly leader board

Placeholder Retrieved value
%boost_top_weekly_first_player% Name of the player at the top of this week's leader board.
%boost_top_weekly_first_wins% Number of games won by the player at the top of this week's leader board.
%boost_top_weekly_first_losses% Number of games lost by the player at the top of this week's leader board.
... ...
%boost_top_weekly_tenth_losses% Number of games lost by the player coming tenth on this week's leader board.
%boost_top_weekly_tenth_games% Number of games played by the player coming tenth on this week's leader board.
%boost_top_weekly_tenth_rank% Rank number of the player coming tenth on this week's leader board.

Daily leader board

Placeholder Retrieved value
%boost_top_daily_first_player% Name of the player at the top of today's leader board.
%boost_top_daily_first_wins% Number of games won by the player at the top of today's leader board.
%boost_top_daily_first_losses% Number of games lost by the player at the top of today's leader board.
... ...
%boost_top_daily_tenth_losses% Number of games lost by the player coming tenth on today's leader board.
%boost_top_daily_tenth_games% Number of games played by the player coming tenth on today's leader board.
%boost_top_daily_tenth_rank% Rank number of the player coming tenth on today's leader board.

Example leader board placeholders for a specific game arena are as follows:

Placeholders for stats on a specific game arena can fetch wins, losses, games, besttime, lasttime, avgtime or rank.
For a PvP or race arena, use placeholders wins, losses, games, or rank.
For a parkour arena, use the time-based stats placeholders besttime, lasttime, avgtime or rank.

For the following examples assume that you have a game node Arena1: under games: in config.yml.

games:
  Arena1:   <- This value must be used in the placeholder.
    name: '&6Arena1'
    ...

Overall leader board for Arena1

Placeholder Retrieved value
%boost_top_total_first_player_arena1% Name of the player at the top of the leader board.
%boost_top_total_first_wins_arena1% Number of games won by the player at the top of the leader board.
%boost_top_total_first_losses_arena1% Number of games lost by the player at the top of the leader board.
... ...
%boost_top_total_tenth_losses_arena1% Number of games lost by the player coming tenth on the leader board.
%boost_top_total_tenth_games_arena1% Number of games played by the player coming tenth on the leader board.
%boost_top_total_tenth_rank_arena1% Rank number of the player coming tenth on the leader board.

Monthly leader board for Arena1

Placeholder Retrieved value
%boost_top_monthly_first_player_arena1% Name of the player at the top of this month's leader board.
%boost_top_monthly_first_wins_arena1% Number of games won by the player at the top of this month's leader board.
... ...
%boost_top_monthly_tenth_rank_arena1% Rank number of the player coming tenth on this month's leader board.

Weekly leader board for Arena1

Placeholder Retrieved value
%boost_top_weekly_first_player_arena1% Name of the player at the top of this week's leader board.
%boost_top_weekly_first_wins_arena1% Number of games won by the player at the top of this week's leader board.
... ...
%boost_top_weekly_tenth_rank_arena1% Rank number of the player coming tenth on this week's leader board.

Daily leader board for Arena1

Placeholder Retrieved value
%boost_top_daily_first_player_arena1% Name of the player at the top of today's leader board.
%boost_top_daily_first_wins_arena1% Number of games won by the player at the top of today's leader board.
... ...
%boost_top_daily_tenth_rank_arena1% Rank number of the player coming tenth on today's leader board.

Player statistics placeholders

General placeholder pattern

The player statistics placeholders follow a pattern: %boost_player_<period>_<stat>% or %boost_player_<period>_<stat>_<game>% where the values in < > are each one of the following:

  • <period> is one of total, monthly, weekly or daily.
  • <stat> is one of player, wins, losses, games or rank.
  • <game> is one of your game nodes under games: in config.yml.

Some combinations will retrieve the same value (e.g. all that fetch the player's name). The full expanded list of player statistics placeholders are as follows:

For the following examples assume that you have a game node Arena1: under games: in config.yml.

games:
  Arena1:   <- This value must be used in the placeholder.
    name: '&6Arena1'
    ...

Overall player statistics

Placeholder Retrieved value
%boost_player_total_player% Name of the player.
%boost_player_total_wins% Total number of games won by the player.
%boost_player_total_losses% Total number of games lost by the player.
%boost_player_total_games% Total number of games played by the player.
%boost_player_total_rank% Overall rank of the player.

Overall player statistics for Arena1

Placeholder Retrieved value
%boost_player_total_player_arena1% Name of the player.
%boost_player_total_wins_arena1% Total number of games won by the player.
%boost_player_total_losses_arena1% Total number of games lost by the player.
%boost_player_total_games_arena1% Total number of games played by the player.
%boost_player_total_rank_arena1% Overall rank of the player.

Monthly player statistics

Placeholder Retrieved value
%boost_player_monthly_player% Name of the player.
%boost_player_monthly_wins% Number of games won by the player this month.
%boost_player_monthly_losses% Number of games lost by the player this month.
%boost_player_monthly_games% Number of games played by the player this month.
%boost_player_monthly_rank% Overall rank of the player this month.

Monthly player statistics for Arena1

Placeholder Retrieved value
%boost_player_monthly_player_arena1% Name of the player.
%boost_player_monthly_wins_arena1% Number of games won by the player this month.
%boost_player_monthly_losses_arena1% Number of games lost by the player this month.
%boost_player_monthly_games_arena1% Number of games played by the player this month.
%boost_player_monthly_rank_arena1% Overall rank of the player this month.

Weekly player statistics

Placeholder Retrieved value
%boost_player_weekly_player% Name of the player.
%boost_player_weekly_wins% Number of games won by the player this week.
%boost_player_weekly_losses% Number of games lost by the player this week.
%boost_player_weekly_games% Number of games played by the player this week.
%boost_player_weekly_rank% Overall rank of the player this week.

Weekly player statistics for Arena1

Placeholder Retrieved value
%boost_player_weekly_player_arena1% Name of the player.
%boost_player_weekly_wins_arena1% Number of games won by the player this week.
%boost_player_weekly_losses_arena1% Number of games lost by the player this week.
%boost_player_weekly_games_arena1% Number of games played by the player this week.
%boost_player_weekly_rank_arena1% Overall rank of the player this week.

Daily player statistics

Placeholder Retrieved value
%boost_player_daily_player% Name of the player.
%boost_player_daily_wins% Number of games won by the player today.
%boost_player_daily_losses% Number of games lost by the player today.
%boost_player_daily_games% Number of games played by the player today.
%boost_player_daily_rank% Overall rank of the player today.

Daily player statistics for Arena1

Placeholder Retrieved value
%boost_player_daily_player_arena1% Name of the player.
%boost_player_daily_wins_arena1% Number of games won by the player today.
%boost_player_daily_losses_arena1% Number of games lost by the player today.
%boost_player_daily_games_arena1% Number of games played by the player today.
%boost_player_daily_rank_arena1% Overall rank of the player today.

Game placeholders

General placeholder pattern

The game placeholders follow a pattern: %boost_game_<game>_<parameter>% where the values in < > are each one of the following:

  • <game> is one of your game nodes under games: in config.yml.
  • <parameter> is one of players, playing, min, max, time or status.

For the following examples assume that you have a game node Arena1: under games: in config.yml.

games:
  Arena1:   <- This value must be used in the placeholder.
    name: '&6Arena1'
    ...
Placeholder Retrieved value
%boost_game_arena1_players% Total players in the game (queuing, playing, spectating).
%boost_game_arena1_playing% Active players in the game (i.e. playing but have not lost).
%boost_game_arena1_min% Minimum number of players required for the game to start.
%boost_game_arena1_max% Maximum number of players allowed in the game.
%boost_game_arena1_time% Remaining queuing time before the game starts.
Returns an empty string if the game is not counting down to start.
%boost_game_arena1_status% Current status of the game. Returns one of the following values:
QUEUING, RUNNING or STOPPED.

Contents:

Clone this wiki locally