> For the complete documentation index, see [llms.txt](https://docs.mipcraft.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mipcraft.eu/hide-and-seek/placeholderapi.md).

# PlaceholderAPI

Hide and Seek includes comprehensive PlaceholderAPI integration for scoreboards, TAB lists, holograms, and hub leaderboards.

## 👤 Individual Player Statistics

Retrieve statistics for the targeted player:

| Placeholder                         | Description                     | Example Output           |
| ----------------------------------- | ------------------------------- | ------------------------ |
| `%hideandseek_player_name%`         | Player's display name           | `Player123`              |
| `%hideandseek_player_uuid%`         | Player's UUID                   | `8667c4b0-13a8-4228-...` |
| `%hideandseek_player_wins%`         | Total games won                 | `42`                     |
| `%hideandseek_player_score%`        | Cumulative total score points   | `1250`                   |
| `%hideandseek_player_best-score%`   | Highest single-game score       | `350`                    |
| `%hideandseek_player_win-streak%`   | Current consecutive win streak  | `5`                      |
| `%hideandseek_player_games-played%` | Total games played              | `68`                     |
| `%hideandseek_player_placement%`    | Player's overall rank placement | `#3`                     |

## 🎮 Game & Arena Stats

| Placeholder                            | Description                                                                    | Example Output |
| -------------------------------------- | ------------------------------------------------------------------------------ | -------------- |
| `%hideandseek_game-count_<game_name>%` | Current player count in `<game_name>`                                          | `12`           |
| `%hideandseek_game-state_<game_name>%` | Current state of `<game_name>` (`WAITING`, `STARTING`, `INGAME`, `RESTARTING`) | `INGAME`       |

## 🏆 Top 10 Leaderboard Placeholders

Display Top 10 leaderboards for scoreboards, holograms, or TAB menus!

### Placeholder Naming Structure

```
%hideandseek_top_<CATEGORY>_<RANK>_<FIELD>%
```

* **`hideandseek_top_`**: Constant prefix.
* **`<CATEGORY>`**: The leaderboard metric. Options:
  * `games-played`
  * `win-streak`
  * `wins`
  * `kills`
  * `points`
  * `score`
  * `best-score`
* **`<RANK>`**: Placement rank from `1` to `10`.
* **`<FIELD>`**: The data attribute to return. Options:
  * `name` - Player's username
  * `uuid` - Player's UUID
  * `wins` - Win count
  * `win-streak` - Current win streak
  * `games-played` - Total games played
  * `kills` - Total kills
  * `points` / `score` - Score points
  * `placement` - Placement rank number

## 💡 Leaderboard Examples

Here are common real-world examples:

* `%hideandseek_top_wins_1_name%` → Name of the **#1 Top Wins** player.
* `%hideandseek_top_wins_1_wins%` → Win count of the **#1 Top Wins** player.
* `%hideandseek_top_score_3_name%` → Name of the **#3 Top Score** player.
* `%hideandseek_top_score_3_score%` → Score of the **#3 Top Score** player.
* `%hideandseek_top_win-streak_5_name%` → Name of the **#5 Highest Win-Streak** player.
* `%hideandseek_top_win-streak_5_win-streak%` → Win streak count of the **#5** player.