Placeholders
Athena registers a PlaceholderAPI expansion with identifier athena.
Use placeholders as:
%athena_<placeholder>%
Player Placeholders
These placeholders require a player context unless noted otherwise.
| Placeholder | Output |
|---|---|
%athena_combat_timer_active% |
true or false depending on whether the combat timer is active. |
%athena_combat_timer_remaining% |
Remaining combat timer duration, or empty/null if unavailable. |
%athena_spawn_timer_active% |
true or false depending on whether the spawn timer is active. |
%athena_spawn_timer_remaining% |
Remaining spawn timer duration, or empty/null if unavailable. |
%athena_guild% |
Player clan/guild display name with color, or None. |
%athena_full_hearts% |
Whole health value out of 20. |
%athena_legacy_hearts% |
Whole heart value out of 10. |
%athena_decimal_hearts% |
Decimal health value out of 20. |
%athena_legacy_decimal_hearts% |
Decimal heart value out of 10. |
%athena_total_kills% |
Total kills. |
%athena_total_deaths% |
Total deaths. |
%athena_total_kdr% |
Kill/death ratio. |
%athena_current_kill_streak% |
Current killstreak. |
%athena_highest_kill_streak% |
Highest killstreak. |
%athena_total_credits% |
Current credit balance. |
%athena_events_won% |
Total hosted events won. |
%athena_experience% |
Tier experience. |
%athena_tier_level% |
Current tier numeric level. |
%athena_tier_display% |
Current tier display text. |
%athena_clan_tag% |
Formatted clan tag, or empty if no clan/tag exists. |
%athena_chat_channel% |
Guild when clan chat is enabled, otherwise Global. |
%athena_bounty% |
Formatted bounty value, or empty if the player has no bounty. |
Leaderboard Placeholders
Leaderboard placeholders use this pattern:
%athena_top_<leaderboard>_<rank>%
%athena_top_<leaderboard>_<rank>_<field>%
Supported leaderboard names:
| Name | Meaning |
|---|---|
kills |
Top total kills. |
deaths |
Top total deaths. |
highest_kill_streak |
Top highest killstreak. |
highest_kill_streaks |
Alias for highest killstreak. |
highest_killstreak |
Alias for highest killstreak. |
highest_killstreaks |
Alias for highest killstreak. |
guild_kills |
Top clan/guild kills. |
clan_kills |
Alias for clan/guild kills. |
Supported fields:
| Field | Output |
|---|---|
| omitted | Formatted leaderboard entry from leaderboards.yml. |
entry |
Formatted leaderboard entry. |
display |
Formatted leaderboard entry. |
name |
Player or clan display name. |
player |
Alias for name. |
value |
Score value. |
amount |
Alias for value. |
score |
Alias for value. |
uuid |
Entry UUID/id when available. |
id |
Alias for uuid. |
rank |
Requested rank position. |
position |
Alias for rank. |
If a leaderboard entry does not exist, Athena returns Nobody for the name, 0 for the value, and an empty id.
Examples:
%athena_top_kills_1_name%
%athena_top_kills_1_value%
%athena_top_deaths_3_display%
%athena_top_guild_kills_1%
%athena_top_highest_kill_streak_5_score%