PlaceholderAPI Integration
ArenaPvP provides a built-in PlaceholderAPI expansion that exposes 40+ placeholders. These can be used by any plugin that supports PlaceholderAPI — scoreboards, tab lists, holograms, chat formats, etc.
Setup
- Install PlaceholderAPI on your Hytale server.
- Start the server — ArenaPvP registers its expansion automatically.
- No manual download or
/papi ecloudneeded — it's bundled inside the plugin.
Verify the expansion is loaded:
/papi list
You should see arenapvp in the list.
Placeholder Format
All placeholders use the format:
%arenapvp_<key>%
Player State
Require a player context. Return true or false.
| Placeholder | Description |
|---|---|
%arenapvp_in_arena% | Player is inside an active arena match |
%arenapvp_in_queue% | Player is waiting in a matchmaking queue |
%arenapvp_in_pending% | Player has a match found, waiting for arena instance |
%arenapvp_is_spectator% | Player is spectating a match |
%arenapvp_is_busy% | Player is busy (in arena, queue, pending match, or transfer) |
%arenapvp_in_group% | Player belongs to a group |
%arenapvp_is_leader% | Player is the leader of their group |
%arenapvp_queue_category% | Category code the player is queued for (empty if not in queue) |
Arena Info
Info about the arena the player is currently in. Returns empty string if not in arena.
| Placeholder | Description |
|---|---|
%arenapvp_arena_name% | Arena template name |
%arenapvp_arena_category% | Category code (e.g. 2-FFA) |
%arenapvp_arena_type% | Arena type (e.g. FFA, TDM, TCTO) |
Global Stats
Aggregated across all categories. Require player context.
| Placeholder | Description |
|---|---|
%arenapvp_kills% | Total kills |
%arenapvp_deaths% | Total deaths |
%arenapvp_wins% | Total wins |
%arenapvp_losses% | Total losses |
%arenapvp_kdr% | Kill/death ratio (2 decimals) |
%arenapvp_wlr% | Win/loss ratio (2 decimals) |
Per-Category Stats
Replace {cat} with the category code (e.g. 2-FFA, 4-TDM). Default rating is 1000.
| Placeholder | Description |
|---|---|
%arenapvp_rating_{cat}% | Rating in the category |
%arenapvp_kills_{cat}% | Kills in the category |
%arenapvp_deaths_{cat}% | Deaths in the category |
%arenapvp_wins_{cat}% | Wins in the category |
%arenapvp_losses_{cat}% | Losses in the category |
%arenapvp_kdr_{cat}% | K/D ratio (2 decimals) |
%arenapvp_wlr_{cat}% | W/L ratio (2 decimals) |
%arenapvp_tier_{cat}% | Rating tier name (e.g. "Gold I") — requires RatingTiersEnabled |
Examples:
%arenapvp_rating_2-FFA% → 1250
%arenapvp_kills_4-TDM% → 87
%arenapvp_kdr_2-FFA% → 2.35
Top Leaderboard
Replace {cat} with category code and {pos} with the 1-based rank (1–100).
| Placeholder | Description |
|---|---|
%arenapvp_top_name_{cat}_{pos}% | Player name at that rank |
%arenapvp_top_rating_{cat}_{pos}% | Rating at that rank |
%arenapvp_top_kills_{cat}_{pos}% | Kills at that rank |
%arenapvp_top_wins_{cat}_{pos}% | Wins at that rank |
%arenapvp_top_tier_{cat}_{pos}% | Tier name at that rank — requires RatingTiersEnabled |
Returns "" (name) or "0" (numbers) if the position doesn't exist.
Examples:
%arenapvp_top_name_2-FFA_1% → "f0xx"
%arenapvp_top_rating_2-FFA_1% → 1580
%arenapvp_top_kills_2-FFA_3% → 204
%arenapvp_top_wins_4-TDM_10% → 15
Group Info
Require player context. Return 0 or empty string if not in a group.
| Placeholder | Description |
|---|---|
%arenapvp_group_size% | Number of members |
%arenapvp_group_leader% | Leader display name |
%arenapvp_group_type% | PERMANENT or TEMPORARY |
%arenapvp_group_online% | Online member count |
Server-Wide
These do not require a player context.
| Placeholder | Description |
|---|---|
%arenapvp_active_arenas% | Total active arena instances |
%arenapvp_players_in_arenas% | Total players in arenas |
%arenapvp_queue_size% | Total groups in all queues |
%arenapvp_pending_matches% | Matches awaiting instance creation |
%arenapvp_queue_size_{cat}% | Groups in queue for a specific category |
%arenapvp_active_arenas_{cat}% | Active instances for a specific category |
Category Codes
| Code | Description |
|---|---|
2-FFA | 2-player Free For All |
3-FFA | 3-player Free For All |
4-TDM | 4-player Team Deathmatch |
2-T | 2-player Team |
6-FFADM | 6-player FFA Deathmatch |
4-TCTO | 4-player Team Capture the Orb |
Available categories depend on the arena templates configured on your server.
Testing Placeholders
Parse any placeholder in-game:
/papi parse me %arenapvp_kills%
/papi parse me %arenapvp_rating_2-FFA%
/papi parse me %arenapvp_top_name_2-FFA_1%
/papi parse me %arenapvp_active_arenas%
/papi parse me %arenapvp_is_busy%
Use Cases
Scoreboard
Show player stats on a scoreboard:
Rank: %arenapvp_tier_2-FFA%
Rating: %arenapvp_rating_2-FFA%
K/D: %arenapvp_kdr_2-FFA%
Wins: %arenapvp_wins%
Tab List
Show player state in tab:
%arenapvp_is_busy% → Display "[In Arena]" or "[In Queue]"
Top Player Display
Create a leaderboard hologram:
#1 %arenapvp_top_name_2-FFA_1% - %arenapvp_top_rating_2-FFA_1%
#2 %arenapvp_top_name_2-FFA_2% - %arenapvp_top_rating_2-FFA_2%
#3 %arenapvp_top_name_2-FFA_3% - %arenapvp_top_rating_2-FFA_3%