Skip to main content

Placeholders

PlaceholderAPI allows for other plugins to display data provided by Hungergames. With its current implementation, you can use placeholders to show per-player statistics as well as global game statistics inside scoreboards, chat formats, holograms, and other supported plugins. You can also use it in place of signs for displaying info about arenas.

Enabling placeholders

To enable the use of placeholders, simply download PlaceholderAPI, place it in your plugins directory. After you restart the server, HungerGames will automatically detect the presence of the plugin.

warning

To enable placeholders, you must first set up a database connection in settings.yml. The database acts as persistent storage for player data which serves PlaceholderAPI information to display.

Main Identifier

The PlaceholderAPI identifier for this plugin is hungergames. This means that all placeholders for this plugin must start with hungergames_, and the wiki will assume this prefix is added when retrieving.

Individual Player Placeholders

If you'd like to view statistics about a specific player, you can use individual placeholders. This returns the same results as players running /hg stats.

PlaceholderDescriptionExample Output
uuidUUID of player6b05687f-3c9e-356f-b709-c63a9b0c71d7
usernameUsername of PlayerCantankerousAlly
deathsNumber of deaths during games5
killsNumber of kills during games12
kill_assistsNumber of assists (damaged player but not killed) during games7
solo_games_startedNumber of solo games started using the /hg start command3
solo_games_playedNumber of solo games played10
solo_games_wonNumber of solo games won2
team_games_startedNumber of team games started using the /hg start command4
team_games_playedNumber of team games played8
team_games_wonNumber of team games won1
chest_openedNumber of chests opened during games45
supply_drops_openedNumber of deaths during games6
environment_deathsNumber of deaths during games to environmental reasons (fall_damage, drowning etc.)2
border_deathsNumber of deaths during games to world border damage0
player_deathsNumber of deaths during games to other players9
arrows_shotNumber of arrows shot during games30
arrows_landedNumber of arrows hitting players during games18
fireworks_shotNumber of fireworks shot during games8
fireworks_landedNumber of fireworks hitting players directly during games3
attacks_blockedNumber of attacks blocked using a sheild durin games5
potions_usedNumber of potions used during games3
food_consumedNumber of food items (including liquids excluding potions) consumed during games20
totems_poppedNumber of Totem of Undyings used during games1
damage_dealtAmount of damage dealt to living entities (players and mobs) during games178.5
projectile_damage_dealtAmount of projectile damage dealt to living entities (players and mobs) during games64.0
damage_takenAmount of damage taken during games142.33
projectile_damage_takenAmount of projectile damage taken during games55.0
health_regeneratedAmount of health regenerated during games72.5
solo_percentileAverage player placement percentile during solo games75.4
team_percentileAverage player placement percentile during solo games62.1
last_loginDate of last login2026-01-03
last_logoutDate of last logout2026-01-03
seconds_playedNumber of seconds spent alive during games5187
seconds_played_monthNumber of seconds spent alive during games this month732

Note: Floating point numbers are rounded to 2 decimal points

Global Player Placeholders

Global placeholders use the same keys as individual ones, but uses more parameters for the position and type of data. It follows the following command

leaderboard_top_<rank>_<stat>_<name|value>

  • Replace <rank> with the position on the leaderboard to display, for example leaderboard_top_**1**_<stat>_<name|value>
  • Replace <stat> with the stat to display, for example leaderboard_top_<rank>_**kills**_<name|value>
  • Replace <name|value> with either name or value depending on whether you want to display the stat or player with said stat, for example leaderboard_top_<rank>_<stat>_**name**

Slot Placeholders

If you'd like to use custom signs in your plugins, you can use these to display information about arenas.

PlaceholderDescriptionExample Output
slot_<slot_name>_worldName of arena related to slotSeacliff
slot_<slot_name>_progressWhether the game is in progress or waitingIn Progress
slot_<slot_name>_playersNumbers of players alive or spawnpoints occupied13 Alive
  • Replace <slot_name> with the name of the slot, for example slot_seacliff_progress