Create PlaceholderAPI authored by MarcatoSound's avatar MarcatoSound
Placeholder API Compatibility
========
Mythic Dungeons now comes with _limited_ PlaceholderAPI support. So far, a collection of valid placeholders have been implemented. **Support for placeholders in various dungeon functions is not yet implemented and will come at a later date.**
Instance Placeholders
----------------
These placeholders can be used when a player is in an instance.
### Dungeon Info Placeholders
- `%md_dungeon_name`
The name of the dungeon the player is currently in.
- `%md_dungeon_display_name`
The formal, presentable display name of the dungeon the player is currently in.
### Instance Info Placeholders
- `%md_dungeon_id%`
The instance ID of the dungeon. This is the dungeon name plus a number.
- `%md_dungeon_players`
The number of players in the dungeon instance, including dead players.
- `%md_dungeon_players_living`
The number of _living_ players in the dungeon instance.
- `%md_dungeon_lives_left`
The number of lives the player has left.
Dungeon-Specific Placeholders
----------------
These placeholders can be used by specifying a dungeon name. (Replace [dungeon] with the name of the dungeon.)
- `%md_dungeon_[dungeon]_lives`
How many lives players will start with in this dungeon.
- `%md_dungeon_[dungeon]_min_players`
The minimum number of players needed in a party to enter this dungeon.
- `%md_dungeon_[dungeon]_max_players`
The maximum number of players allowed in a party for this dungeon.
- `%md_dungeon_[dungeon]_unlock_time`
How long until the player can access this dungeon again.
Party Placeholders
----------------
These placeholders can be used when a player is in a party.
- `%md_party_leader`
The name of the current party's leader.
- `%md_party_size`
The number of players in the current party.
Recruitment Placeholders
----------------
These placeholders can be used by specifying a recruiting player's name. (Replace [player] with the name of the player.)
- `%md_recruitment_[player]_host`
The name of the player hosting this recruitment. Which... you should already have if you've gotten this far. But it's there.
- `%md_recruitment_[player]_label`
The label of this player's recruitment listing.
- `%md_recruitment_[player]_description`
The description of this player's recruitment listing.
- `%md_recruitment_[player]_total_players`
How many players this recruitment listing needs in total.
- `%md_recruitment_[player]_players_present`
How many players this recruitment listing already has.
- `%md_recruitment_[player]_players_needed`
How many players this recruitment listing still needs. (Basically, the amount of spots still available in the party.)
- `%md_recruitment_[player]_needs_password`
"Yes" or "No" depending on if this listing requires a password to join.
\ No newline at end of file