Skip to content

Dungeon Config

dungeons/dungeon-config.yml is current persisted dungeon template file. AramDungeons loads this single template, edits it in place, and validates it before runs.

Top-Level Fields

FieldMeaning
idDungeon id used by /ad join <id> and admin commands.
display-nameHuman-facing name shown in menus.
icon-materialMenu icon material for admin/player interfaces.
descriptionMenu lore text.
enabledMust be true before normal joins succeed.
anchor-locationAbsolute template anchor for dungeon-level relative positions.
lobby-locationRelative location where players can be sent for lobby flow.
spectator-locationRelative spectator location used by template setup.
exit-locationRelative exit location after leaving flow.
stagesPer-stage setup entries.
rewardsFinal win gold, EXP, and boss drop rolls.

Stage Fields

Each stage stores:

  • stage-number
  • schematic-file
  • anchor-location
  • combat-teleport-location
  • supply-teleport-location
  • checkpoint-location
  • combat-region
  • supply-region
  • mob-round-spawns
  • boss-spawns
  • supply-npc-locations

What Each Saved Point Means

SettingOperator meaning
anchor-locationExact source/build anchor for stage schematic. Save this before any relative stage point.
combat-teleport-locationWhere players land for combat rounds in this stage.
supply-teleport-locationWhere players land during supply round. Must stay inside supply region.
checkpoint-locationWhere dead players respawn during this stage.
combat-regionFAWE-copied bounds used to validate regular/boss spawns.
supply-regionFAWE-copied bounds used to validate supply teleports and supply NPC positions.

Relative Location Idea

Dungeon-level and stage-level anchors are absolute positions in source world. Most other positions are saved as offsets from those anchors. When plugin pastes schematic into instance world, those offsets are applied to pasted copy so teleports, NPCs, and spawns line up with pasted build.

In practice:

  1. Stand at source anchor and save it.
  2. Move to gameplay point inside source schematic.
  3. Save that point.
  4. Plugin remembers offset, not only raw world coordinates.

Spawns and NPCs

mob-round-spawns is keyed by round number. Default combat rounds are 1, 2, 3, 4, and 6. Each spawn entry stores group label, relative location, amount, and MythicMob id. Validation checks each combat spawn stays inside combat region.

Reward Rules

rewards controls end-of-run win payout:

  • win-gold
  • win-exp
  • boss-drop-rolls

These values are applied when final boss is cleared.