> ## Documentation Index
> Fetch the complete documentation index at: https://hotpotato.arrowtan.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Placeholders

> PlaceholderAPI placeholders for scoreboards and other plugins.

When [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is installed, HotPotato exposes `%hotpotato_*%` placeholders. Use them on scoreboards, in chat formats, or anywhere PlaceholderAPI is read.

<Note>
  These need PlaceholderAPI installed. Without it, the placeholders are not registered.
</Note>

<Tabs>
  <Tab title="Game state" icon="gamepad">
    | Placeholder             | Returns                                                   |
    | ----------------------- | --------------------------------------------------------- |
    | `%hotpotato_arena%`     | The arena the player is in, or empty.                     |
    | `%hotpotato_state%`     | `none`, `lobby`, `countdown`, `playing`, or `spectating`. |
    | `%hotpotato_is_potato%` | `true` or `false` while in a game, otherwise empty.       |
  </Tab>

  <Tab title="Player stats" icon="chart-simple">
    | Placeholder                   | Returns                                |
    | ----------------------------- | -------------------------------------- |
    | `%hotpotato_wins%`            | Total wins.                            |
    | `%hotpotato_losses%`          | Total losses.                          |
    | `%hotpotato_games_played%`    | Total games played.                    |
    | `%hotpotato_transfers%`       | Times the player passed the potato.    |
    | `%hotpotato_times_potato%`    | Times the player was made the potato.  |
    | `%hotpotato_rounds_survived%` | Total rounds survived.                 |
    | `%hotpotato_kdr%`             | Win to loss ratio, two decimals.       |
    | `%hotpotato_win_rate%`        | Win rate as a percentage, one decimal. |
  </Tab>

  <Tab title="Leaderboard" icon="ranking-star">
    Replace `<rank>` with a position, starting at `1`.

    | Placeholder                   | Returns                             |
    | ----------------------------- | ----------------------------------- |
    | `%hotpotato_top_<rank>_name%` | The name at that rank, or `N/A`.    |
    | `%hotpotato_top_<rank>_wins%` | The win count at that rank, or `0`. |

    For example, `%hotpotato_top_1_name%` is the player with the most wins. The number of ranks kept is set by `stats.leaderboard-size` on the [storage](/configuration/storage) page.
  </Tab>
</Tabs>