Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
MythicDungeons MythicDungeons
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 86
    • Issues 86
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Operations
    • Operations
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • MythicCraft
  • MythicDungeonsMythicDungeons
  • Wiki
  • PlaceholderAPI

Last edited by MarcatoSound Feb 24, 2024
Page history

PlaceholderAPI

Placeholder API Compatibility

Mythic Dungeons now comes with limited PlaceholderAPI support. So far, a collection of valid placeholders have been implemented, and placeholders will be parsed in message and title functions.

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.

  • %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.)

  • %md_dungeon_time_elapsed% How many hours, minutes and seconds have passed since the dungeon started.

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%
    When the player can access this dungeon again as a formatted date.

  • %md_dungeon_[dungeon]_unlock_time_seconds%
    How long until the player can access this dungeon again in seconds.

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.

  • %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.

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.

Clone repository

NOTE: Items marked with * are incomplete or unwritten.

General Info
  • Changelogs
  • Free vs Premium
  • Commands and Permissions
  • Plugin Config
  • How it all Works
Guides
  • Getting Started
  • Your First Dungeon
  • Importing from DXL
Dungeon Elements
  • Dungeon Config
  • Dungeon Types
  • Functions
  • Triggers
  • Conditions
Generated Dungeons [2.0+]
  • Procedural Dungeons Overview
  • Dungeon Rooms
  • Default generation.yml
  • Generator Tips & Tricks
  • Troubleshooting
Compatibility
  • Mythic Mobs
  • Placeholder API
  • BetonQuest
Developer Documentation
  • Avoiding Memory Leaks
  • Introduction to API
  • Getting Started with Elements
  • GUI Menus
  • *Custom Functions
  • *Custom Triggers
  • *Custom Conditions
  • Adding Party Support
    [Coming Soon!]
  • *Custom Dungeon Types
  • *Custom Procedural Layouts