---

📚 Documentation and Support

• Documentation: InstancedDungeons Documentation
• Discord: Join the support server

Please check validation output and the documentation before reporting a setup problem. If something is genuinely broken, include the plugin version, Paper version, Java version, and the relevant console error.

---

✨ Main Features

🏰 Isolated World Instances

• Use an existing world as a reusable dungeon template.
• Give every party its own temporary copy.
• Run multiple groups through the same dungeon at the same time.
• Clean up completed, failed, abandoned, and orphaned instances.
• Remove matching temporary WorldGuard world data during cleanup.
• Keep players who are not part of the run out of active instances.

👥 Parties and Spectators

• Party creation with short join codes.
• Configurable minimum and maximum party sizes.
• Party-leader controls for starting a run.
• Support for leaving, reconnecting, tower transitions, and cleanup.
• External spectators can follow an active party and leave safely.
• Eliminated players can spectate the rest of the run or return to the exit.

🎯 Boss and Trigger Dungeons

Choose how each dungeon is completed:

• BOSS — defeat the configured boss.
• TRIGGER — activate one configured button or pressure plate.

Boss and trigger rewards support independent drop chances, amount ranges, vanilla items, ItemsAdder, Oraxen, Nexo, and MythicMobs items.

Reward delivery is configurable per objective:

• send rewards directly to inventories or drop them at the objective;
• reward the leader, killer, trigger activator, every alive player, or create one shared party drop;
• safely drop inventory overflow at the recipient's location;
• reject invalid delivery and recipient combinations before the dungeon starts.

🚪 Stages, Gates, and Missions

• Add progression stages inside a dungeon.
• Select existing gate blocks without breaking or replacing them.
• Use sneak-click to edit connected blocks of the same material.
• Import the current WorldEdit selection with //set while editing a gate.
• Give stages explicit IDs and order numbers.
• Run multiple stages in parallel by assigning the same order.
• Add multiple holograms with live mission progress.

Supported stage missions:

• mob kills;
• levers;
• synchronized buttons and pressure plates;
• required keys;
• timers;
• sacrifice decisions;
• Vault payments;
• item payments.

The Free edition supports up to two stages per dungeon and two missions per stage.

⚔️ Mob Spawners

• Vanilla mobs and MythicMobs.
• Mixed vanilla/MythicMobs pools.
• Weighted entries and individual spawn chances.
• Boss spawners for boss-objective dungeons.
• Start, proximity, delay, and proximity-with-delay trigger modes.

📦 Loot Chests

• Place configured loot chests in the template world.
• Random chances and min/max amounts per entry.
• Vanilla and supported custom items.
• Potion, tipped-arrow, and enchanted-book IDs.
• Add the item in your hand with /dungeon lootchest loot <id> add.
• Guaranteed mission-key supply for required-key stages.
• Editor particles make configured locations easy to find.

🗼 Tower Dungeons

Chain dungeon templates together into a longer run. The Free edition supports:

FIRST -> LAST

The party, lives, spectators, and progression are carried across the transition. Entry costs belong to the first dungeon, while the last dungeon completes the tower.

💰 Costs, Lives, and Timers

• Money and item entry costs.
• Vault economy support.
• Leader-only or whole-party payment.
• Player-scoped or shared team lives.
• Unlimited lives with 0.
• Configurable elimination behavior.
• Per-dungeon countdown and bossbar.
• Configurable timer alerts and automatic failure at zero.

🛡️ Dungeon Rules and Item Restrictions

• Control block breaking, block placement, fluids, interactions, and TNT.
• Keep mission blocks, gates, objectives, and loot chests protected even when normal building is enabled.
• Decide whether existing player flight is allowed; Creative and Spectator flight remain available.
• Optionally block elytra, ender pearls, chorus fruit, enchanted golden apples, wind charges, firework rockets, maces, and tridents.

Item restrictions are configured per dungeon in config.yml.

⚙️ Event Commands

Each dungeon can run commands for player and party events. Commands may run as the console or as a player and can react to party creation, joins, starts, deaths, mob and boss kills, stages, gates, completion, failure, tower transitions, and more.

Event commands are disabled by default and support context placeholders for players, parties, dungeons, stages, mobs, bosses, worlds, and coordinates.

🔧 Validation and Diagnostics

• /dungeon validate <id> checks one dungeon.
• /dungeon validate all checks every dungeon.
• Reload validation covers objectives, towers, spawners, loot, costs, stages, and commands.
• Invalid setups are blocked before they can create a broken run.
• Optional lightweight RAM analysis can be toggled with /dungeon ram analysis.
• RAM analysis is disabled by default and does not scan the heap or force garbage collection.

---

📋 Compatibility

InstancedDungeons currently has separate downloads for the two supported server lines. Choose the JAR that matches your server.

Plugin	Server	Java	Multiverse-Core
2.0.+	Paper 26.1.x / 26.2.x	25+	5.6.0+
2.0.+	Paper 1.21.x	21+	5.5.2+
1.0.8 and older	Paper 1.21.x	21+	5.5.2+

Optional Integrations

• MythicMobs 5.0+ — custom mobs, bosses, and items.
• ItemsAdder 3.0+ — custom items.
• Oraxen — custom items.
• Nexo — custom items.
• Vault plus an economy plugin — money costs and money missions.

---

Free and Pro

The Free edition is a complete, playable dungeon system with limits intended for smaller and medium-sized setups.

Area	Free	Pro
Active instances	Up to 16 globally	♾️ Unlimited
Tower layout	FIRST -> LAST	FIRST -> MIDDLE -> ... -> LAST
Stages	Up to 2 per dungeon	♾️ Unlimited
Missions	Up to 2 per stage	♾️ Unlimited
Mission blocks	Up to 3 levers, 3 buttons, and 2 pressure plates per stage	♾️ Unlimited
Required-key mission	Up to 1 per dungeon	♾️ Unlimited
Sacrifice, money, and item-payment missions	Up to 1 of each per dungeon	♾️ Unlimited
Item types in an item-payment mission	Up to 3	♾️ Unlimited
Checkpoints and closing gate actions	❌	✅
Per-dungeon sounds.yml	❌	✅
Admin GUI	❌	✅

InstancedDungeons Pro: View the official BuiltByBit page

Use code 436583-UPGRADE for 15% off.

---

🚀 Quick Start

1. Install

1. Download the correct InstancedDungeons JAR for your Paper version.
2. Place it in the server's plugins folder.
3. Install the matching Multiverse-Core version.
4. Start the server.

2. Create a Template and Dungeon

/mv create dragon_template normal
/dungeon create dragon_lair dragon_template boss
/dungeon edit dragon_lair
/dungeon setspawn
/dungeon setexit
/dungeon setboss
/dungeon save
/dungeon reload

For a trigger dungeon:

/dungeon create puzzle_room puzzle_template trigger
/dungeon edit puzzle_room
/dungeon setspawn
/dungeon setexit
/dungeon settrigger STONE_BUTTON
/dungeon save
/dungeon reload

3. Add Loot and a Stage

/dungeon edit dragon_lair
/dungeon addlootchest treasure_1
/dungeon lootchest give treasure_1
/dungeon stage create entrance
/dungeon stage entrance gate create
/dungeon gate save
/dungeon stage entrance gate hologram create

4. Start a Run

/dungeon open dragon_lair
/dungeon join <code>
/dungeon start

---

🎮 Commands

Player Commands

Command	Description
/dungeon help	Show the command list
/dungeon list	List available dungeons
/dungeon open <id>	Create a party for a dungeon
/dungeon join <code>	Join a party
/dungeon leave	Leave an open party
/dungeon start	Start the run as party leader
/dungeon exit	Leave an active dungeon
/dungeon spectate <leader>	Spectate an active party
/dungeon spectator exit	Leave spectator mode

Common Admin Commands

Command	Description
`/dungeon create <id> <world> <boss	trigger>`
/dungeon edit <id>	Enter editor mode
/dungeon setspawn	Set the dungeon spawn
/dungeon setexit	Set the exit
/dungeon setboss	Set the boss location
/dungeon settrigger <material>	Set the trigger objective
/dungeon boss reward edit	Edit boss rewards
/dungeon trigger reward edit	Edit trigger rewards
/dungeon addspawner <id>	Add a mob spawner
/dungeon addlootchest <id>	Add a loot chest definition
/dungeon lootchest give <id>	Get its placement chest
/dungeon addcost	Edit entry costs
/dungeon stage create <id>	Create a stage
/dungeon stage list	List stage IDs and order
/dungeon stage <id> order <number>	Change stage order
`/dungeon stage <id> gate create	edit
/dungeon stage <id> gate stick	Get the gate editing stick
`/dungeon stage <id> gate hologram create	delete`
/dungeon gate save	Save the current gate selection
`/dungeon validate <id	all>`
/dungeon instances	Show active parties and instances
/dungeon reload	Reload plugin and dungeon files
/dungeon delete <id>	Delete a dungeon after confirmation

The complete command reference, including mission and custom-item commands, is available in the documentation.

---

🔑 Permissions

Permission	Default	Description
instanceddungeons.admin	OP	Administrative and editor commands
instanceddungeons.open	true	Open dungeon parties
instanceddungeons.join	true	Join dungeon parties
instanceddungeons.open.<dungeon_id>	true	Open a specific dungeon
instanceddungeons.join.<dungeon_id>	true	Join a specific dungeon
instanceddungeons.spectate	true	Spectate active dungeons
instanceddungeons.bypass.cost	OP	Bypass entry costs
instanceddungeons.bypass.limit	OP	Bypass normal start limits

---

⚠️ Updating

• Configurations from 1.x are not compatible and should be recreated.
• Missing 2.1.0 settings are appended without replacing existing values.
• The plugin does not create automatic backups. Stop the server and back up the dungeons folder, config.yml, and messages.yml before updating.

---