Dungeon Category
Category that groups multiple dungeon instances for display in a global menu. Each instance has independent unlock criteria and locked/unlocked visuals.
Placeholders
| Placeholder | Description |
|---|---|
{dungeon_name} | Name of the dungeon instance |
{players} | Current player count in lobby |
{max} | Maximum party size |
Configuration
dungeon_category — Map
Configuration for the dungeon category.
Properties
instances
"> List of dungeon instances in this category with their visual configs.
DungeonCategorySlot
dungeonInstance
"> Reference to the dungeon instance. criteria
">
Criteria to check if the player has unlocked this instance.
unlockedItem — Item
Item shown when unlocked. unlockedName
">
Name when unlocked. Supports {dungeon_name}, {players}, {max}.
unlockedLore
"> Lore when unlocked. Supports
{dungeon_name},{players},{max}. lockedItem —Item
Item shown when locked. lockedName
"> Name when locked. lockedLore
"> Lore when locked.
Example
dungeon_category:
id: "main_dungeons"
name: "Main Dungeons"
instances:
- dungeonInstance: "dungeon_forest"
unlockedItem: OAK_LOG
unlockedName: "<green>Ancient Forest</green>"
unlockedLore:
- "<gray>Players: {players}/{max}"
lockedItem: BARRIER
lockedName: "<red>🔒 Locked</red>"
lockedLore:
- "<gray>Complete the tutorial to unlock"
- dungeonInstance: "dungeon_desert"
criteria:
- type: permission
permission: "dungeon.desert"
unlockedItem: SANDSTONE
unlockedName: "<gold>Desert Pyramid</gold>"
unlockedLore:
- "<gray>Players: {players}/{max}"
lockedItem: BARRIER
lockedName: "<red>🔒 Locked</red>"
lockedLore:
- "<gray>Requires permission: dungeon.desert"