### MythicDungeons BossBar Line Parameters and Example

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/staged-dungeon/displays/boss-bar.md

Details the available parameters that can be used within the `Lines` configuration for a BossBar display, allowing for dynamic content and styling. Includes an example of a structured line.

```APIDOC
BossBar Line Parameters:
  Parameter:
    progress:
      Type: Number (0.0 to 1.0) or Placeholder
      Description: Progress of the boss bar.
      Examples: "1.0", "%BlockBreak_3_progress%"
    color:
      Type: String (Spigot BarColor)
      Description: Color of the boss bar, follows Spigot API rules.
      Example: "PURPLE"
    style:
      Type: String (Spigot BarStyle)
      Description: Style of the boss bar, follows Spigot API rules.
      Example: "SEGMENTED_20"
    message:
      Type: String
      Description: Message of the boss bar.
  Example Structured Line:
    {progress=1.0;color=PURPLE;style=SEGMENTED_20;message='&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'}
```

--------------------------------

### Example Display Format for Declared Objectives in YAML

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/staged-dungeon/displays/README.md

Demonstrates how the previously declared objectives are formatted for display to players. This example uses specific placeholders like '%MythicMob_1_mobamtkilled%' and '%Checkpoint_2_cpreached%' to dynamically show progress and status within the display text.

```yaml
- '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
- '&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'
```

--------------------------------

### Mythic Dungeons Main Menu Item Configurations

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/configuration/guis.md

Defines the properties for individual interactive items and small confirmation menus displayed within the main Mythic Dungeons user interface. This includes navigation buttons ('Next', 'Leave'), information displays ('Info'), invitation options ('Invite'), settings access ('Settings'), dungeon start ('Start'), and various confirmation prompts for actions like leaving, promoting, or removing players.

```YAML
Next:
  Slot: 37
  Material: ARROW
  Name: "&fNext page"
  Lores:
    - "&7%current%/%max%"
Leave:
  Slot: 46
  Material: IRON_DOOR
  Name: "&cLeave"
  Lores: [ ]
Info:
  Slot: 49
  Material: BOOK
  Name: "&aRoom information"
  Lores:
    # Info for privacy PUBLIC or PRIVATE
    Default:
      - "&7ID: %id%"
      - "&7Owner: %owner%"
      - "&7Dungeon: %dungeon%"
      - "&7Created: %created% ago"
      - "&7Privacy: %privacy%"
      - "&7Note: %note%"
    # Info for privacy PASSWORD
    Password:
      - "&7ID: %id%"
      - "&7Owner: %owner%"
      - "&7Dungeon: %dungeon%"
      - "&7Created: %created% ago"
      - "&7Privacy: %privacy%"
      - "&7Password: %password%"
      - "&7Note: %note%"
Invite:
  Slot: 48
  Material: PLAYER_HEAD
  Name: "&aInvitation to players"
  Lores:
    # If all invite is on
    AllInvite_On:
      - "&7Invite your friends to the room"
      - "&7and challenge the dungeon with them!"
    # If all invite is off
    AllInvite_Off:
      - "&7Check the pending invitations"
      - "&7tell your friends to accept invitations!"
Settings:
  Slot: 50
  Material: COMPARATOR
  Name: "&aSettings"
  Lores:
    - "&7Change min, max players"
    - "&7and privacy settings here."
Start:
  Slot: 52
  Material: DIAMOND_SWORD
  Name: "&aStart"
  Enchants:
    - DAMAGE_ALL 1
  ItemFlags:
    - HIDE_ATTRIBUTES
  Lores:
    - "&7Challenge dungeon %dungeon% &r&7!"
Leaving:
  Title: "Confirm leaving?"
  Name: "&e%owner%'s %dungeon% &r&eroom"
  Lores:
    - "&7ID: %id%"
    - "&7Owner: %owner%"
    - "&7Dungeon: %dungeon%"
Promotion:
  Title: "Confirm promotion?"
  Name: "&ePromote %name% to owner"
  Lores:
    - "&7ID: %id%"
    - "&7Owner: %owner%"
    - "&7Dungeon: %dungeon%"
Removal:
  Title: "Confirm removal?"
  Name: "&eRemove %name% from the room"
  Lores:
    - "&7ID: %id%"
    - "&7Owner: %owner%"
    - "&7Dungeon: %dungeon%"
```

--------------------------------

### MythicDungeons Dungeon Readiness Countdown Screen Configuration

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/configuration/guis.md

This YAML snippet defines the user interface for the pre-dungeon readiness screen. It includes the screen size and name, decorative panes, a visual countdown (Three, Two, One), and interactive buttons to cancel or start the dungeon, along with item flags.

```YAML
  Ready:
    Size: 27
    Name: "Get ready for %dungeon%&r!"
    Pane:
      Slot: [ 1, 2, 3, 4, 5, 6, 7, 19, 20, 21, 22, 23, 24, 25 ]
      Material: BLACK_STAINED_GLASS_PANE
      Name: " "
      Lores: [ ]
    Pane2:
      Slot: [ 0, 8, 9, 17, 18, 26 ]
      Material: WHITE_STAINED_GLASS_PANE
      Name: " "
      Lores: [ ]
    Three:
      Slot: [ 10, 16 ]
      Material: YELLOW_STAINED_GLASS_PANE
      Name: " "
      Lores: [ ]
    Two:
      Slot: [ 11, 15 ]
      Material: ORANGE_STAINED_GLASS_PANE
      Name: " "
      Lores: [ ]
    One:
      Slot: [ 12, 14 ]
      Material: RED_STAINED_GLASS_PANE
      Name: " "
      Lores: [ ]
    Cancel:
      Slot: [ 4, 22 ]
      Material: REDSTONE_BLOCK
      Name: "&cCancel"
      Lores: [ ]
    Start:
      Slot: 13
      Material: DIAMOND_SWORD
      Name: "&ePrepare for %dungeon%&r&e!"
      ItemFlags:
        - HIDE_ATTRIBUTES
      Lores: [ ]
```

--------------------------------

### Configure Dungeon Entry Requirements

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/general.yml.md

Defines the prerequisites for starting a dungeon, including permission checks, monetary costs (configurable per player or leader only), required items (with support for various custom item plugins and loot tables), and conditional expressions based on player attributes like level or experience.

```YAML
# The cost of starting the dungeon
Requirements:
  Permission: true
  # Money to pay to start the dungeon
  Money:
    # Deduct per player, if you have 3 players, all of them pay 30000.0
    # Otherwise, only the leader will be charged
    PerPlayer: true
    # Amount to charge
    Amount: 30000.0
  # Items to pay to start the dungeon
  Items:
    # Deduct per player, the items in the list will be removed from all players
    # Otherwise, only the leader will be charged
    PerPlayer: true
    # Items to pay
    # Some custom item plugins are supported, DO NOT add extra spaces or quotations
    # Only Loot Tables declared in "loottables" folder are supported
    # Use "/mg check" with the items on your hand to retrieve the string
    Items:
      - "{\"v\":3578,\"type\":\"DIAMOND_BLOCK\"}"
      - "{\"v\":3578,\"type\":\"REDSTONE_BLOCK\"}"
      - "{\"v\":3578,\"type\":\"EMERALD_BLOCK\"}"
      # - 'MMOItems{type=FOOD;id=ICE_CREAM;amount=64}'
      # - 'MythicMobs{id="SkeletonKingSword";amount=2}'
      # - 'ItemsAdder{id=iron_search;amount=2}'
      # - 'EcoItems{id=armor_core;amount=1}'
      # - 'EcoArmor{id=default;amount=1;type=crystal}'
      # - 'EcoArmor{id=reaper;amount=1;type=set;slot=boots}'
      # - 'EcoArmor{id=reaper;amount=1;type=shard}'
      # - 'Talismans{id=boss_1;amount=1}'
      # - 'LootTable{id=Stage1Table}'
  Conditions:
    Required:
      - '%changeoutput_>=_input:{player_level}_matcher:5_ifmatch:true_else:false% true'
    Optional:
      - '%changeoutput_ignorecase_input:{player_allow_flight}_matcher:yes_ifmatch:true_else:false% true'
      - '%changeoutput_>=_input:{player_exp}_matcher:1_ifmatch:true_else:false% true'
```

--------------------------------

### General Parameters API Reference

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/staged-dungeon/actions-completions-and-fail-actions/general-parameters.md

Details common parameters like 'delay' that can be applied to various actions and completions within the system, including their purpose, examples, and requirements.

```APIDOC
General Parameters:
  delay:
    Explanation: Delay in ticks before the action is done. Delays are applied to all actions respectively so please accumulate the delay if the actions are done one by one.
    Required: No
    Example: Message{delay=20;type=ACTION_BAR;text='&d&lIMPRESSIVE, you have completed the challenge, you may now leave.'}
```

--------------------------------

### Configure UI Icons (Detailed Style)

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/general.yml.md

Detailed example of defining UI icons, allowing specification of slot, material, custom name, lore, and amount. Placeholders can be used within the name and lore fields to display dynamic information.

```YAML
Icon:
  Items:
    '0':
      Slot: 3
      Material: REDSTONE_BLOCK
      Name: "Whatever you want, but only placeholders existed in the item below can be used"
      Lores: "Whatever you want, but only placeholders existed in the item below can be used"
      Amount: 64
    '1':
      Slot: 4
      Material: REDSTONE_BLOCK
      Name: "Whatever you want, but only placeholders existed in the item below can be used"
      Lores: "Whatever you want, but only placeholders existed in the item below can be used"
      Amount: 64
    '2':
      Slot: 5
      Material: REDSTONE_BLOCK
      Name: "Whatever you want, but only placeholders existed in the item below can be used"
      Lores: "Whatever you want, but only placeholders existed in the item below can be used"
      Amount: 64
```

--------------------------------

### Configure In-Game Scoreboards with scoreboard.yml

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/configuration/scoreboards.md

This YAML configuration defines the structure and content of in-game scoreboards for different states: `InRoom` (when a player is in a room), `Starting` (when the owner starts a dungeon), and `Ending` (when a dungeon ends). It includes placeholders for dynamic information like room ID, dungeon name, owner, player counts, and status, allowing for customizable display intervals, titles, and scores.

```YAML
InRoom:
  # Scoreboard display when player is in a room
  # %id%: Room's id
  # %dungeon%: Room's dungeon group
  # %owner%: Room's owner
  # %current%: Room's member count
  # %min%: Room's min member
  # %max%: Room's max member
  # %note%: Room's note
  # %privacy%: Room's privacy
  # %password%: Room's password
  # %created%: Room's creation time
  # %visible%: Room's visibility in menu
  # %status%: Room's status
  Owner:
    Interval: 10
    Title:
      - "&6&lMythicDungeons"
      - "&eMythicDungeons"
    Scores:
      - "&e&m--------===========--------"
      - "&eDungeon&7: &f%dungeon%"
      - "&1"
      - "&eStatus: &f%status%"
      - "&2"
      - "&ePlayers: &f%current%/%max%"
      - "&3"
      - "&eId: &f%id%"
      - "&4"
      - "&ewww.Example.com"
  Member:
    Interval: 10
    Title:
      - "&6&lMythicDungeons"
      - "&eMythicDungeons"
    Scores:
      - "&e&m--------===========--------"
      - "&eDungeon&7: &f%dungeon%"
      - "&1"
      - "&eStatus: &f%status%"
      - "&2"
      - "&ePlayers: &f%current%/%max%"
      - "&3"
      - "&eOwner: &f%owner%"
      - "&4"
      - "&ewww.Example.com"
  NoOwner:
    Interval: 10
    Title:
      - "&6&lMythicDungeons"
      - "&eMythicDungeons"
    Scores:
      - "&e&m--------===========--------"
      - "&eDungeon&7: &f%dungeon%"
      - "&1"
      - "&eStatus: &f%status%"
      - "&2"
      - "&ePlayers: &f%current%/%max%"
      - "&3"
      - "&ewww.Example.com"
Starting:
  # Scoreboard display when owner starts the dungeon
  # %id%: Room's id
  # %dungeon%: Room's dungeon group
  # %owner%: Room's owner
  # %current%: Room's member count
  # %min%: Room's min member
  # %max%: Room's max member
  # %note%: Room's note
  # %privacy%: Room's privacy
  # %password%: Room's password
  # %creation%: Room's creation time
  # %visible%: Room's visibility in menu
  # %status%: Room's status
  Owner:
    Interval: 10
    Title:
      - "&6&lMythicDungeons"
      - "&eMythicDungeons"
    Scores:
      - "&e&m--------===========--------"
      - "&eDungeon&7: &f%dungeon%"
      - "&1"
      - "&eStatus: &f%status%"
      - "&cClick "Cancel" to cancel"
      - "&2"
      - "&ePlayers: &f%current%/%max%"
      - "&3"
      - "&eId: &f%id%"
      - "&4"
      - "&ewww.Example.com"
  Member:
    Interval: 10
    Title:
      - "&6&lMythicDungeons"
      - "&eMythicDungeons"
    Scores:
      - "&e&m--------===========--------"
      - "&eDungeon&7: &f%dungeon%"
      - "&1"
      - "&eStatus: &f%status%"
      - "&2"
      - "&ePlayers: &f%current%/%max%"
      - "&3"
      - "&eOwner: &f%owner%"
      - "&4"
      - "&ewww.Example.com"
Ending:
  # %dungeon%: Dungeon's name
  # %teleport%: Time before dungeon ends and teleport all challengers to lobby
  Interval: 10
  Title:
    - "&6&lMythicDungeons"
    - "&eMythicDungeons"
  Scores:
    - "&e&m--------===========--------"
    - "&eDungeon&7: &f%dungeon%"
    - "&eTeleport in &f%teleport%"
    - "&1"
    - "&2"
    - "&3"
    - "&4"
    - "&5"
    - "&6"
    - "&7"
    - "&8"
    - "&9"
    - "&0"
    - "&a"
    - "&ewww.Example.com"
```

--------------------------------

### Configure Stage Options Parameters

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/staged-dungeon/stages.md

This section details the available parameters for configuring options within a dungeon stage, specifically under `Stages.<ID>.Options`. These parameters control the stage's behavior, such as its starting conditions, delays, and termination.

```APIDOC
Stages.<ID>.Options:
  Initial:
    type: boolean
    description: Define the first stage of the dungeon. Only 1 stage can be defined as initial.
    example: "true" (if this is the first stage of the dungeon, otherwise, it can be omitted)
  Delay:
    type: integer (ticks)
    description: How long in ticks will the stage wait before starting. Actions will not be done, and objectives will not be shown on the scoreboard or checked during the delay.
    example: (e.g., 20 for 1 second)
  End:
    type: boolean
    description: Define the last stage of the dungeon. Once this stage is completed, the dungeon ends. More than 1 stage can be defined as a last stage.
    example: "true"
```

--------------------------------

### Define Simplified Dungeon Stage Configuration

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/stages.yml.md

This YAML snippet illustrates a simplified configuration for a single dungeon stage. It covers defining the stage's initial and end properties, actions to perform when the stage starts (e.g., spawning a MythicMob), objectives required for completion (e.g., killing a specific mob), and detailed scoreboard display settings including titles, lines, and objective progress tracking.

```yaml
# Main flow of the dungeon
Stages:
  # ID of the stage, must be unique
  '0':
    Options:
      # True if this is the first stage of the dungeon, only 1 can exist
      Initial: true
      # True if this is the last stage of the dungeon, more than 1 can exist
      End: true
    # A list of actions will do when this stage starts
    Actions:
      - MythicMob{type=SkeletalKnight;at=LOCATION;world=dungeon;x=120.5;y=6.0;z=259.5;yaw=0.0;pitch=0.0}
    # A list of objectives needs to be fulfilled to complete this stage
    Objectives:
      - MythicMob{type=SkeletalKnight;amount=1}
    # Objective display of the stage
    Displays:
      # Scoreboard display of the stage
      Scoreboard:
        # Interval of the title changes
        Interval: 10
        # Title of the scoreboard display
        # If no title lines are specified, the next stage with objective lines specified
        # will inherit previous active titles
        Titles:
          - "&6&lMythicDungeons"
          - "&eMythicDungeons"
        # Interval of the objective line scrolls if objective lines
        # does not fit pre-defined spaces
        ScrollInterval: 20
        # Lines of the scoreboard display, use %objectives% to show objective lines
        # If no lines are specified, the next stage with objective lines specified
        # will inherit previous active lines
        Lines:
          - "&e&m--------===========--------"
          - "&eDungeon&7: &f%dungeon%"
          - "&eTime left&7: &f%expire%"
          - "&1"
          - "&2%objective%"
          - "&3%objective%"
          - "&4%objective%"
          - "&5%objective%"
          - "&6%objective%"
          - "&7%objective%"
          - "&8%objective%"
          - "&9%objective%"
          - "&0%objective%"
          - "&a"
          - "&ewww.Example.com"
        # Objective lines of the stage, follows the order where Objectives are defined
        Objectives:
          - '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
    # A list of actions will do when this stage is completed
    Completions: [ ]
    # A list of actions will do when the dungeon fails during this stage
    FailActions: [ ]
    # A list of stages that will start when this stage is completed
    Branches: [ ]
```

--------------------------------

### MythicDungeons Initial Stage (Stage 0) Configuration

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/stages.yml.md

This YAML snippet defines the initial stage ('0') of a dungeon. It specifies that this is the starting point ('Initial: true'), lists actions such as spawning specific MythicMobs at designated locations, and sets objectives like defeating a certain number of mobs or reaching a checkpoint. It also configures various in-game displays including a Scoreboard with dynamic lines, a BossBar showing progress, and an ActionBar for transient messages.

```YAML
'0':
  Options:
    Initial: true
  Actions:
    - MythicSpawner{type=rat1;world=dungeon;x=116.0;y=5.0;z=255.0;yaw=0.0;pitch=0.0;settings=rat1.yml}
    - MythicSpawner{type=rat1;world=dungeon;x=116.0;y=5.0;z=252.0;yaw=0.0;pitch=0.0;settings=rat1.yml}
    - MythicSpawner{type=rat2;world=dungeon;x=124.0;y=5.0;z=252.0;yaw=0.0;pitch=0.0;settings=rat2.yml}
  Objectives:
    - MythicMob{type=rat1;amount=3}
    - Checkpoint{id=1}
  Displays:
    Scoreboard:
      Interval: 10
      Titles:
        - "&6&lMythicDungeons"
        - "&eMythicDungeons"
      ScrollInterval: 20
      Lines:
        - "&e&m--------===========--------"
        - "&eDungeon&7: &f%dungeon%"
        - "&eTime left&7: &f%expire%"
        - "&1"
        - "&2%objective%"
        - "&3%objective%"
        - "&4%objective%"
        - "&2"
        - "&ewww.Example.com"
      Objectives:
        - '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
        - ''
        - '&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'
        - ''
        - '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
        - ''
        - '&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'
        - ''
    BossBar:
      Interval: 20
      Lines:
        - '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
        - ''
        - "{progress=1.0;color=PURPLE;style=SEGMENTED_20;message='&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'}"
        - "{progress=%BlockBreak_3_progress%;message='&fBreak %BlockBreak_3_broke%/%BlockBreak_3_amount% %BlockBreak_3_block%'}"
    ActionBar:
      Interval: 20
      Lines:
        - '&fSlain %MythicMob_1_mobamtkilled%/%MythicMob_1_mobamtmax%x %MythicMob_1_mobamtkill%'
        - ''
        - '&fDiscover the secret of %Checkpoint_2_cp%: %Checkpoint_2_cpreached%'
  Completions: [ ]
  FailActions: [ ]
  Branches:
    - Branch{id=1}
```

--------------------------------

### MythicDungeons PlaceholderAPI: Dungeon Instance Variables

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/miscellaneous/placeholders.md

These placeholders provide details about an active MythicDungeons instance, including its unique ID, origin world coordinates, current player count, player and team death counts, the timestamp when the dungeon started, and its current operational state.

```APIDOC
MythicDungeons Dungeon Placeholders:
  %mythicdungeons_dungeon_id%: Dungeon's ID
  %mythicdungeons_dungeon_origin_world%: Dungeon's Origin world
  %mythicdungeons_dungeon_origin_x%: Dungeon's Origin x-axis
  %mythicdungeons_dungeon_origin_y%: Dungeon's Origin y-axis
  %mythicdungeons_dungeon_origin_z%: Dungeon's Origin z-axis
  %mythicdungeons_dungeon_current%: Dungeon's current players amount
  %mythicdungeons_dungeon_playerdeath%: Dungeon's player death count
  %mythicdungeons_dungeon_teamdeath%: Dungeon's team death count
  %mythicdungeons_dungeon_startedat%: Timestamp of the dungeon started
  %mythicdungeons_dungeon_state%: Dungeon's state (NOT_STARTED, PRE_STARTING, STARTED, ENDING, ENDED)
```

--------------------------------

### Configure UI Icons (List Style)

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/general.yml.md

Example of defining UI icons using a simple list format, where each item specifies a version and material type. This configuration will override any existing buttons, placing new icons in the next available slot if not explicitly specified.

```YAML
# All existing buttons will be overridden
# If the slot is not specified, it will be placed in the next available slot
Icon:
  Items:
    - '{"v":2865,"type":"REDSTONE_BLOCK"} 0'
    - '{"v":2865,"type":"REDSTONE_BLOCK"} 1'
    - '{"v":2865,"type":"REDSTONE_BLOCK"} 2'
```

--------------------------------

### npcs.yml Example Configuration

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/configuration/npcs.md

This YAML configuration file demonstrates how Citizens NPC data is structured for MythicDungeons. It includes metadata, name, UUID, various traits (like skin, type, and owner), and navigation settings. The location coordinates are dynamically set using PlaceholderAPI placeholders, allowing the NPC to spawn at the dungeon's origin.

```yaml
# Citizens NPC Storage

last-created-npc-id: 1
npc:
  '1':
    metadata:
      cached-skin-uuid: 991d961c-b6b4-4d49-88e6-01788cf445dc
      cached-skin-uuid-name: i9_14900k
    name: i9_14900K
    uuid: ebda02e9-48eb-4f6e-82d7-2de8fd5a8f95
    traits:
      type: PLAYER
      owner:
        uuid: 991d961c-b6b4-4d49-88e6-01788cf445dc
      skintrait:
        fetchDefaultSkin: true
        signature: Ejyo9ry8TIXAuj0QCS920+xOXlWpvbF1vJ9SLvPJYYmvGr5/MUamKe2NsXMxdELCty+TvhQfucO9BmIbTCCOmmIjrhgK1UpIsryVxpYI4LsTI8IZN7UZ8cYYFPM3wcK58NBz5SRM7l04+B3cVLiJA2jzYjQEyWb/NF+D8dV9W7GiG0upuTyx6s5jW7+o0Z5ortegDPE+howhFlbQyj6YPzWZp/2rAJNc+2zS8G4j5HIc5p4nHNwxUAjWLJYzFlM0Elg9Tii7JHTSw7eIi/DzpsMVeOxjQTZ88UPnlp6dNm5fRm8InnK9Vdb/0QKQiBdiIU5gVP52FoRSk7A8oY70ZHKbBIVaplk9yG/+ccbEyO29DhVZdstA5vxZMJ7xhmMsqMByQsur5p4/Yx9swhixv44yWK0c491uIZ2dSMjEjfsIoqYUs4L/HLIoWW3fCk/DKFBU6slbsCBBYcmCSxZVk+Rut42pOUozp1Ns/AMXHauBlPCb57uoVlUqj1r2QC3WZpq2Sp1wQ36njPchHyJEryfiQyrBfXkFJCj+w6JXMQb+8Sk0+u+9zrcNjTj3QyPpIwUhI633S2pbrMqd0TVXbVR/MiHblKDq4qKDiA7k3MPiMoaeLpNZ4krxKenkitjI5AOrdbZMh9zoYEtcgCDvXtR+pDkjk0Z2iBCXOpyhT/o=
        textureRaw: ewogICJ0aW1lc3RhbXAiIDogMTcwNjYxNTYxNTU5MywKICAicHJvZmlsZUlkIiA6ICI5OTFkOTYxY2I2YjQ0ZDQ5ODhlNjAxNzg4Y2Y0NDVkYyIsCiAgInByb2ZpbGVOYW1lIiA6ICJpOV8xNDkwMEsiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMTA4M2Q4MjM2NWQ1MTEyM2EyNjMyNzcxM2M2ZjllNmU1ZTZjMWU0ZGJkYmIwMzg0OWYxZjZlOWNlYWFiZTEwYSIKICAgIH0sCiAgICAiQ0FQRSIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjM0MGMwZTAzZGQyNGExMWIxNWE4YjMzYzJhN2U5ZTMyYWJiMjA1MWIyNDgxZDBiYTdkZWZkNjM1Y2E3YTkzMyIKICAgIH0KICB9Cn0=
        updateSkins: false
      location:
        bodyYaw: -0.52426267
        world: '%mythicdungeons_dungeon_origin_world%'
        x: '%mythicdungeons_dungeon_origin_x%'
        y: '%mythicdungeons_dungeon_origin_y%'
        z: '%mythicdungeons_dungeon_origin_z%'
        yaw: '-0.5243'
        pitch: '-5.7066'
    traitnames: inventory,scoreboardtrait,type,spawned,owner,mounttrait,skintrait,location
    navigator:
      speedmodifier: '1.0'
      avoidwater: false
      usedefaultstuckaction: false

```

--------------------------------

### MythicDungeons Dungeon Room Commands Reference

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/commands-and-permissions/dungeon-room.md

This section provides a comprehensive reference for all MythicDungeons in-game commands related to Dungeon Rooms. Commands typically start with `/MythicRooms` (or aliases like `/mythicrooms`, `/mrm`, `/room`, `/mr`) and are followed by specific actions and parameters. Each entry details the command syntax, its required permission node, and a description of its functionality, including parameter types and whether they are optional or required.

```APIDOC
Command: /MythicRooms
  Permission: MythicDungeons.Commands.Rooms
  Description: Show the help page
```

```APIDOC
Command: /MythicRooms Accept <Player>
  Permission: MythicDungeons.Commands.Rooms.Invite.Accept
  Parameters:
    Player: string - The player to accept the invitation from (required)
  Description: Accept specified player's invitation
```

```APIDOC
Command: /MythicRooms AllInvite
  Permission: MythicDungeons.Commands.Rooms.AllInvite
  Description: Give/revoke permission that all members can invite other players
```

```APIDOC
Command: /MythicRooms Chat <Message>
  Aliases: /roomchat, /rmchat, /rc
  Permission: MythicDungeons.Commands.Rooms.Chat
  Parameters:
    Message: string - The message to send to room members (required)
  Description: Chat with the members
```

```APIDOC
Permission: MythicDungeons.Commands.Rooms.Chat.ColorCode.[0-9,a-f,k,l,m,n,o,r]
  Description: Allows use of specific color codes in Room Chat.
```

```APIDOC
Command: /MythicRooms Create <Type>
  Permission: MythicDungeons.Commands.Rooms.Create
  Parameters:
    Type: string - The type of dungeon for the room (required)
  Description: Create a room with a specified dungeon type
```

```APIDOC
Command: /MythicRooms Deny <Player>
  Permission: MythicDungeons.Commands.Rooms.Invite.Deny
  Parameters:
    Player: string - The player whose invitation to decline (required)
  Description: Decline specified player's invitation
```

```APIDOC
Command: /MythicRooms Disband
  Permission: MythicDungeons.Commands.Rooms.Disband
  Description: Disband the room. All members will be removed
```

```APIDOC
Command: /MythicRooms Info
  Permission: MythicDungeons.Commands.Rooms.Info
  Description: Shows the room info.
```

```APIDOC
Command: /MythicRooms Invite <Player>
  Permission: MythicDungeons.Commands.Rooms.Invite
  Parameters:
    Player: string - The player to invite to the room (required)
  Description: Invite a specified player to the room
```

```APIDOC
Command: /MythicRooms Join <Id / Player>
  Permission: MythicDungeons.Commands.Rooms.Join
  Parameters:
    Id / Player: string - The ID of the room or the owner's name (required)
  Description: Join the room with specified id/owner
```

```APIDOC
Command: /MythicRooms Leave
  Permission: MythicDungeons.Commands.Rooms.Leave
  Description: Leave the room
```

```APIDOC
Command: /MythicRooms MaxPlayer <Amount>
  Permission: MythicDungeons.Commands.Rooms.MaxPlayer
  Parameters:
    Amount: integer - The maximum number of players the room accepts (required)
  Description: Change how many players the room accepts
```

```APIDOC
Command: /MythicRooms Menu
  Permission: MythicDungeons.Commands.Rooms.Menu
  Description: Open room menu
```

```APIDOC
Command: /MythicRooms Note [Note]
  Permission: MythicDungeons.Commands.Rooms.Note
  Parameters:
    Note: string - The new note for the room (optional). Leave blank to clear.
  Description: Change room's note. Leave it blank to clear
```

```APIDOC
Command: /MythicRooms MinPlayer <Amount>
  Permission: MythicDungeons.Commands.Rooms.MinPlayer
  Parameters:
    Amount: integer - The minimum number of players the room requires (required)
  Description: Change how many players the room requires
```

```APIDOC
Command: /MythicRooms Privacy <PUBLIC / PRIVATE / PASSWORD> [Password]
  Permission: MythicDungeons.Commands.Rooms.Privacy
  Parameters:
    PrivacyType: string - The privacy setting (PUBLIC, PRIVATE, or PASSWORD) (required)
    Password: string - The password for PASSWORD privacy (optional)
  Description: Change room's privacy settings. Please enter the password if privacy has been set to PASSWORD
```

```APIDOC
Command: /MythicRooms Promote <Player>
  Permission: MythicDungeons.Commands.Rooms.Promote
  Parameters:
    Player: string - The player to promote (required)
  Description: Promote specified players. You will lose all permission after promoting others
```

--------------------------------

### Example YAML Declaration of Stage Objectives

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/staged-dungeon/displays/README.md

Illustrates how stage objectives are declared in YAML, showing a 'MythicMob' objective to kill specific mobs and a 'Checkpoint' objective for reaching a location. These declarations define the tasks players need to complete.

```yaml
- MythicMob{type=rat1;amount=3}
- Checkpoint{id=1}
```

--------------------------------

### MythicDungeons Dungeon Group CLI Commands and Permissions

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/commands-and-permissions/dungeon-group.md

Lists all available commands for managing Dungeon Groups in MythicDungeons, along with their corresponding permissions and usage examples. The primary command can be invoked using aliases like /mythicgroups, /mgroups, /mgroup, or /mg. Arguments enclosed in angle brackets (`<>`) are required, while those in square brackets (`[]`) are optional.

```APIDOC
Command Aliases: /mythicgroups, /mgroups, /mgroup, /mg

Commands:
  /MythicGroups
    Permissions: MythicDungeons.Commands.Groups
    Usage: Show the help page

  /MythicGroups Check
    Permissions: MythicDungeons.Commands.Groups.Check
    Usage: Get the item on hand in MythicDungeons formatted string

  /MythicGroups Delete <Group>
    Permissions: MythicDungeons.Commands.Groups.Delete
    Usage: Delete specified dungeon group
    Parameters:
      <Group>: Required, name of the dungeon group

  ~~/MythicGroups Editor~~
    Permissions: ~~MythicDungeons.Commands.Groups.Editor~~
    Usage: ~~Open up Editor GUI~~
    Note: This command appears to be deprecated or removed.

  /MythicGroups Info <Group> <Page>
    Permissions: MythicDungeons.Commands.Groups.Info
    Usage: Show specified dungeon group’s info
    Parameters:
      <Group>: Required, name of the dungeon group
      [Page]: Optional, page number for info

  /MythicGroups Load
    Permissions: MythicDungeons.Commands.Groups.Load
    Usage: Load dungeon group data

  /MythicGroups Migrate
    Permissions: MythicDungeons.Commands.Groups.Migrate
    Usage: Migrate old dungeon group configurations to the new version

  /MythicGroups Save
    Permissions: MythicDungeons.Commands.Groups.Save
    Usage: Save dungeon group data

  /MythicGroups Toggle
    Permissions: MythicDungeons.Commands.Groups.Toggle
    Usage: Toggle dungeon state until next restarts
```

--------------------------------

### Example Configuration for a MythicDungeons Loot Chest

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/get-started/dungeon-group-config/lootchests.yml.md

This YAML snippet defines a single loot chest with ID '1', specifying its name, world location, particle effects for different states (idle, opened, renew), hologram configurations, potion effects, inventory type, per-player setting, renewal time, title, size, and item contents. It demonstrates how to configure a detailed in-game loot chest, including how to reference items and loot tables.

```yaml
# Loot chests that players can get items from it
LootChests:
  # ID of the loot chest, must be unique
  '1':
    Name: "&eTreasure Chest"
    # Location of the loot chest
    Location:
      world: dungeon
      x: 125.0
      y: 5.0
      z: 260.0
    # Particle effects of the loot chest, only effects declared in "effects.yml" can be used
    Effects:
      # Appear when the loot chest is not opened
      Idle:
        - vortex 3.0
      # Appear when the loot chest is opened and not renewable
      Opened:
        - vortex 3.0
      # Appear when the loot chest is opened and waiting for renewal
      Renew:
        - vortex 3.0
    Hologram:
      Idle:
        # Vertical offset of the hologram based on the original location
        Offset: 4.0
        Lines:
          - '{material=PLAYER_HEAD;glow=true;damage=0;skullowner=991d961c-b6b4-4d49-88e6-01788cf445dc}'
          - '&fOPEN ME!'
      Opened:
        Offset: 6.0
        Lines:
          - '{material=PLAYER_HEAD;glow=true;damage=0;skullowner=3fb398fb-f50a-42de-998d-692c35048e86}'
          - '&7CLAIMED'
      Renew:
        Offset: 2.0
        Lines:
          - '{material=PLAYER_HEAD;glow=true;damage=0;skullowner=34a35801-3895-4aae-a7e5-fbb52e575e3d}'
          - '&7RENEW IN %time%'
    Potions:
      - SPEED 10 2 true true true
      - JUMP 10 2 true true true
    # Type of the loot chest, check here for available inventory type
    # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/InventoryType.html
    Type: CHEST
    # Whether every player in the dungeon has their loot chest inventory, or they share the same one
    PerPlayer: true
    # How long(in ticks) will the loot chest renews
    Renew: 60
    # Title of the loot chest, empty if default title should be used
    Title: ''
    # Size of the loot chest when "Type" is "CHEST"
    Size: 54
    # Contents of the loot chest
    # Use "/mg check" with the items on your hand to retrieve the string
    # Followed by which slot to put
    # Loot Table can also be used by LootTable{id=Stage1Table} 1 2 3
    # where Stage1Table is the name of the Loot Table and 1 2 3 is the slot applying the Loot Table
    # If the items drawn do not fit in the slots, then the rear slots will not be filled
    # or the items in the rear of the list will not be fitted in
    Items:
      - '{"v":2865,"type":"REDSTONE_BLOCK"} 8'
      - '{"v":2865,"type":"DIAMOND_BLOCK"} 16'
      - '{"v":2865,"type":"EMERALD_BLOCK"} 24'
```

--------------------------------

### Dungeon Join and Start Status Messages

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/configuration/locale.md

Messages informing players about the availability, start status, and join outcomes of dungeons. This includes notifications for successful joins, dungeon starts, cancellations, and reasons why a dungeon cannot be created or joined. Messages use Minecraft color codes and placeholders for dungeon names, IDs, or player names.

```Minecraft Message Format
MESSAGE_DUNGEON_NO_AVAILABLE: "&cThere is no dungeon {0}&c available at the moment. Please create a new one or try again later."
MESSAGE_DUNGEON_ALREADY_STARTED: "&cDungeon {0}&c with ID {1} has already started."
MESSAGE_DUNGEON_NOT_RUNNING: "&cDungeon {0}&c with ID {1} is not running."
MESSAGE_DUNGEON_ALREADY_STOPPED: "&cDungeon {0}&c with ID {1} has already stopped."
MESSAGE_DUNGEON_ALREADY_JOINED: "&eYou have already joined the dungeon {0}&e with ID {1}."
MESSAGE_DUNGEON_JOINED: "&eYou have joined the dungeon {0}&e with ID {1}."
MESSAGE_DUNGEON_STARTED_OWNER: "&eYou have started the dungeon {0}&e with ID {1}."
MESSAGE_DUNGEON_STARTED_MEMBER: "&e{0}&e has started the dungeon {1}&e with ID {2}."
MESSAGE_DUNGEON_START_CANCELLED_OWNER: "&cYou have cancelled the start of the dungeon."
MESSAGE_DUNGEON_START_CANCELLED_MEMBER: "&cRoom owner cancelled the start of the dungeon."
MESSAGE_DUNGEON_CANNOT_CREATE: "&cDungeon {0} &ccannot be created."
MESSAGE_DUNGEON_CANNOT_CREATE_DISABLED: "&cDungeon {0} &ccannot be created because it is disabled."
MESSAGE_DUNGEON_NOT_FULFILL_REQUIREMENT: "&cOne/some member(s) does not fulfill the requirements."
```

--------------------------------

### MythicDungeons Command Line Interface Reference

Source: https://github.com/i998979/mythicdungeons-wiki/blob/main/commands-and-permissions/dungeon.md

Detailed documentation for MythicDungeons commands, including their syntax, required permissions, and usage descriptions. Arguments enclosed in `<>` are required, while `[]` denote optional arguments.

```APIDOC
Command: /MythicDungeons
  Description: Show the help page
  Permissions: MythicDungeons.Commands.Dungeons
```

```APIDOC
Command: /MythicDungeons Chat <Message> (or /dungeonchat /dchat /dc)
  Description: Chat with the dungeon members
  Permissions: MythicDungeons.Commands.Dungeons.Chat
```

```APIDOC
Permission: MythicDungeons.Commands.Dungeons.Chat.ColorCode.[0-9,a-f,k,l,m,n,o,r]
  Description: Use specific kind of color code in Dungeon Chat
```

```APIDOC
Command: /MythicDungeons Create <Type>
  Description: Create a new dungeon with specified dungeon group
  Permissions: MythicDungeons.Commands.Dungeons.Create
```

```APIDOC
Command: /MythicDungeons Info <Type> [Id]
  Description: Show specified dungeon's info. Enter id for more information
  Permissions: MythicDungeons.Commands.Dungeons.Info
```

```APIDOC
Command: /MythicDungeons Join <Type> [Id]
  Description: Join first available dungeon if id not specified. Otherwise, join specified one
  Permissions: MythicDungeons.Commands.Dungeons.Join
```

```APIDOC
Command: /MythicDungeons Leave
  Description: Leave the dungeon currently at
  Permissions: MythicDungeons.Commands.Dungeons.Leave
```

```APIDOC
Command: /MythicDungeons Reload [Group | Player | LootTable | Scoreboard | Effect | Locale | Config | Menu]
  Description: Reload specified dungeon configurations, leave it blank to reload all
  Permissions: MythicDungeons.Commands.Dungeons.Reload
```

```APIDOC
Command: /MythicDungeons Remove <Type> <Id> <Player>
  Description: Remove specified player from specified dungeon
  Permissions: MythicDungeons.Commands.Dungeons.Remove
```

```APIDOC
Command: /MythicDungeons Start <Type> <Id>
  Description: Start specified dungeon
  Permissions: MythicDungeons.Commands.Dungeons.Start
```

```APIDOC
Command: /MythicDungeons Stop <Type> <Id>
  Description: Stop specified dungeon
  Permissions: MythicDungeons.Commands.Dungeons.Stop
```