DungeonRooms

DungeonRooms

Guided dungeon runs powered by WorldGuard & MythicMobs

Overview

DungeonRooms lets server owners build guided dungeon runs where players unlock each room by defeating the required MythicMobs. Create dungeon areas with WorldGuard, set a safe spawn point, choose how many mobs each room requires, and let the plugin handle room locks, progress tracking, dungeon death returns, admin bypasses, and optional particle borders.

Compatibility

Features

• Dungeon boundaries — Register a full dungeon WorldGuard region with /dr create.
• Spawn regions — Register a spawn region per dungeon before rooms can be added.
• Dungeon death override — Fatal dungeon damage is intercepted and the player is returned to the dungeon spawn.
• Per-dungeon progression — Room sequence is scoped to each dungeon.
• MythicMobs kill tracking — Only MythicMobs kills count toward room completion.
• JSON player data — Player kills and room unlocks stored in a flat Gson JSON file.
• Lightweight storage — Gson is provided by Paper. No database library is bundled.
• Atomic async saves — Writes use temp files before replacing JSON data. Safe on crash.
• Reset toggles — Death, dungeon exit, world change, and teleport resets can be toggled independently.
• Teleport pass-through protection — Ender pearls, chorus fruit, and other teleports cannot bypass locked rooms.
• Border visualization — Show current room, spawn region, or all dungeon/room borders privately via particles.
• Admin bypass — Bypass all rooms or specific dungeon rooms with permissions.

Installation

1. Download DungeonRooms-2.0.3.jar.
2. Place it in your server's plugins/ folder.
3. Install required dependencies:
   • WorldGuard
   • WorldEdit
   • MythicMobs
4. Start or restart the server.
5. Edit plugins/DungeonRooms/config.yml if needed.
6. Run /dr reload after configuration changes.

Commands

Permissions

Scoped bypass example:

dungeonrooms.bypass.sample.room_2

Setup Guide

1. Create a WorldGuard region for the whole dungeon boundary.
2. Register it: /dr create <world> <region> <dungeonName>
3. Create a WorldGuard region for the dungeon spawn area.
4. Register the spawn region: /dr add spawn <world> <region> <dungeonName>
5. Stand inside the spawn region and run: /dr setspawn <dungeonName>
6. Create WorldGuard regions for each room.
7. Add rooms in progression order: /dr add room <dungeonName> <region> <kills>
8. Spawn MythicMobs inside rooms.
9. Use /dr status to verify kill progress and unlocks.

Example:

/dr create dungeon_world sample_boundary sample /dr add spawn dungeon_world sample_spawn sample /dr setspawn sample /dr add room sample room1 10 /dr add room sample room2 15 /dr add room sample boss_room 1

Region Layout

+--------------------------------------------------+ | WorldGuard region: sample_boundary | | Dungeon name: sample | | | | +--------------+ | | | sample_spawn | <- /dr add spawn ... | | | spawn point | <- /dr setspawn sample | | +--------------+ | | | | | v | | +--------------+ +--------------+ | | | room1 | -> | room2 | | | | 10 kills | | 15 kills | | | +--------------+ +--------------+ | | | | | v | | +--------------+ | | | boss_room | | | | 1 kill | | | +--------------+ | +--------------------------------------------------+

Progression Logic

Example flow:

Spawn → Room 1 → Room 2 → Boss Room

Reset Triggers

Border Visualizer

• /dr showborder — Renders the current room border only.
• /dr showborder spawn — Renders the spawn region border for the current dungeon.
• /dr showborder all — Renders all registered dungeon boundaries and room borders simultaneously.

Only the toggling player sees particles. DungeonRooms uses player.spawnParticle().

Storage

plugins/DungeonRooms/ config.yml dungeons.json playerdata.json

No external database. Gson comes from Paper — DungeonRooms does not shade any storage library. All data loads synchronously on startup. Runtime writes are async and atomic using temp file replacement.