Placeholder API Compatibility

Mythic Dungeons ships a PlaceholderAPI expansion. It registers itself automatically on startup when the PlaceholderAPI plugin is installed, so there is nothing to download from the eCloud.

• Identifier: md (every placeholder starts with %md_)
• Author: MarcatoSound
• Version: the Mythic Dungeons version, with any build suffix stripped

Placeholders are also resolved inside the Message, Title, Command, and Boss Bar functions, in spectator teleport menu button names, and on both sides of a Placeholder Check condition.

For placeholders usable inside Mythic Mobs configs instead, see Mythic Mobs placeholders.

When a placeholder can't resolve

• An identifier the expansion doesn't know returns nothing, so PlaceholderAPI leaves the raw %md_...% text visible. A visible placeholder almost always means a typo.
• Most %md_dungeon_...% placeholders return a single space when the player is not currently inside a dungeon.
• Placeholders that read live instance state only work inside a play instance. Inside an edit session they return nothing.

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. This is the dungeon's folder name.

• %md_dungeon_display_name%
  The formal, presentable display name of the dungeon the player is currently in. (The General.DisplayName config value, colour codes already applied.)

• %md_dungeon_unlock_time%
  When the player can access the dungeon they are currently in again, as a formatted date. Shows "Unlocked" when there is no cooldown.

Instance Info Placeholders

• %md_dungeon_id%
  The instance ID of the dungeon. With the standard one-world-per-instance system this is the dungeon name plus a number (for example mydungeon_0). With the same-world dungeon system, every instance shares one world, so this returns that shared world's name (for example dungeons_normal_0) and is not unique per instance.

• %md_dungeon_players%
  The number of players in the dungeon instance, including dead players.

The rest of this section needs a running dungeon. Inside an edit session they all return nothing.

• %md_dungeon_players_living%
  The number of living players in the dungeon instance.

• %md_dungeon_dead%
  The number of players in the instance who are no longer alive.

• %md_dungeon_spectators%
  How many of the players who started the dungeon are no longer counted as active players.

• %md_dungeon_max_players%
  The maximum party size configured for the dungeon this instance belongs to.

• %md_dungeon_environment%
  The dungeon's dimension: NORMAL, NETHER, or THE_END.

• %md_dungeon_lives_left%
  The number of lives the player has left. Shows "Infinite" when the dungeon has lives disabled.

Timer Placeholders

• %md_dungeon_time_left%
  How many hours, minutes and seconds there are left until the dungeon ends automatically. (For example, 01:35:15 for 1 hour, 35 minutes, and 15 seconds remaining.) The hour part rolls over at 24.

• %md_dungeon_time_left_seconds%
  The same value as a plain number of seconds.

• %md_dungeon_time_elapsed%
  How many hours, minutes and seconds have passed since the dungeon started. The hour part rolls over at 24.

• %md_dungeon_time_elapsed_seconds%
  The same value as a plain number of seconds.

• %md_dungeon_time_limit%
  The dungeon's time limit in minutes, including any per-difficulty override. 0 means no time limit.

• %md_dungeon_time_limit_formatted%
  The same time limit as an hours:minutes:seconds string. Note that it currently formats the limit as if it were seconds, so a 30 minute limit reads 00:00:30 instead of 00:30:00.

• %md_dungeon_progress%
  How far through the time limit the run is, as a whole number from 0 to 100. Only meaningful when the dungeon has a time limit: with TimeLimit: 0 this reads 100 from the first second onward.

• %md_dungeon_progress_fraction%
  The same value as a decimal from 0.00 to 1.00. This is the value to feed a Boss Bar progress source. As with %md_dungeon_progress%, it only means anything when the dungeon has a time limit.

Procedural Dungeon Placeholders

These only return a value inside a procedural (generated) dungeon. Everywhere else they are empty, or 0 for the room counts.

• %md_dungeon_room_name%
  The template name of the room the player is standing in.

• %md_dungeon_room_depth%
  How many rooms away from the start room the player's current room is. The start room is 1.

• %md_dungeon_room_rotation%
  The rotation of the player's current room in degrees: 0, 90, 180, or 270.

• %md_dungeon_rooms_total%
  How many rooms the generated dungeon has.

• %md_dungeon_rooms_cleared%
  How many of those rooms currently contain no MythicMobs.

• %md_dungeon_rooms_remaining%
  How many rooms still contain at least one MythicMob.

Mob Placeholders

• %md_dungeon_mobs%
  How many MythicMobs are currently alive in the instance.

• %md_dungeon_mobs_[mob]%
  How many MythicMobs of one specific type are alive in the instance. Replace [mob] with the mob's internal name, for example %md_dungeon_mobs_SkeletalKnight%. The name is matched ignoring case, and unlike the [dungeon] and [player] slots below, it may contain underscores.

The mob placeholders, along with %md_dungeon_rooms_cleared% and %md_dungeon_rooms_remaining%, ask Mythic Mobs for the answer, so they error out on a server that does not have Mythic Mobs installed.

Living Player Placeholders

• %md_alive_member_[##]%
  The name of the player corresponding with the provided number, counting only the players still alive in the instance. For example, %md_alive_member_1% shows the name of the first living player. Use this one with care: it currently errors instead of returning a value whenever the player reading it is not inside a dungeon, whenever the number is not a whole number, and whenever the number is 0 or higher than the number of living players.

Dungeon-Specific Placeholders

These placeholders can be used by specifying a dungeon name. (Replace [dungeon] with the name of the dungeon.) The name is the dungeon's folder name and it is case sensitive. Dungeon names containing an underscore cannot be used here.

• %md_dungeon_[dungeon]_lives%
  How many lives players will start with in this dungeon. Shows "Infinite" when lives are disabled. This reads the dungeon's base General.PlayerLives value only: per-difficulty overrides are ignored, and a value written as a placeholder or math expression also reads as "Infinite".

• %md_dungeon_[dungeon]_min_players%
  The minimum number of players needed in a party to enter this dungeon. Defaults to 1 when not configured. May be a placeholder or math expression, resolved when the placeholder is requested.

• %md_dungeon_[dungeon]_max_players%
  The maximum number of players allowed in a party for this dungeon. Defaults to 4 when not configured. May be a placeholder or math expression.

• %md_dungeon_[dungeon]_min_class_level%
  Reads a Requirements.ClassLevel config value. No dungeon config has that value and nothing else in the plugin writes it, so this always shows 1. The requirement that is actually enforced is Requirements.PlayerLevel.

• %md_dungeon_[dungeon]_max_instances%
  How many instances of this dungeon may exist at once.

• %md_dungeon_[dungeon]_busy_instances%
  How many instances of this dungeon exist right now. This counts every allocated instance, including an open edit session and any empty preloaded instances.

• %md_dungeon_[dungeon]_unlock_time%
  When the player can access this dungeon again as a formatted date. Shows "Unlocked" when there is no cooldown.

• %md_dungeon_[dungeon]_unlock_time_seconds%
  How long until the player can access this dungeon again in seconds. Shows 0 when the dungeon is already unlocked.

• %md_dungeon_[dungeon]_finished%
  Meant to show whether the player has completed this dungeon. It reads a completion list that nothing in the plugin writes to, so it currently always shows "false", even right after a player finishes the dungeon.

Party Placeholders

These placeholders can be used when a player is in a party. When the player has no party, the name placeholders show a blank space, %md_party_size% shows 0, and the true/false ones show false. If you use a third-party party plugin, a player with no one else in their party counts as having no party.

• %md_party_leader%
  The name of the current party's leader.

• %md_party_size%
  The number of players in the current party.

• %md_party_in_dungeon%
  "true" if any member of the party is currently inside a dungeon, otherwise "false".

• %md_party_queued%
  "true" if any member of the party is currently queued for a dungeon, otherwise "false".

• %md_party_member_[##]%
  The name of the player in the party corresponding with the provided number. (##) For example, %md_party_member_1% would show the name of the first player in the party. Shows a blank space if the party has fewer members than that.

• %md_party_member_[##]_health%
  That same player's current health, to one decimal place. A player at full vanilla health shows 20.0. For example, %md_party_member_2_health%.

Recruitment Placeholders

These placeholders can be used by specifying a recruiting player's name. (Replace [player] with the name of the player.) The player must be online and must currently have a listing. Player names containing an underscore cannot be used here.

• %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%
  Meant to show "Yes" or "No" depending on if this listing requires a password to join. It currently always shows "Yes", including for listings that do not need a password.