DungeonForge Wiki - The Ultimate Dungeon Creation System

🏰 DungeonForge Documentation

Welcome to the official documentation for DungeonForge - The Ultimate Dungeon Creation System for Minecraft servers.

📋 Requirements

Server: Paper/Spigot 1.16+ | Java: 16+ | Dependencies: None required (all optional)

📦 Installation

Server Requirements

Server Software: Paper (recommended), Spigot, or CraftBukkit
Minecraft Version: 1.16 or higher
Java Version: Java 16 or higher

⚠️ Important

Vanilla Minecraft servers cannot load plugins. You need Paper or Spigot!

Installation Steps

Stop your server
Download DungeonForge-1.0.0.jar
Place the JAR file in your plugins/ folder
Start the server to generate config files
(Recommended) Restart after making config changes

Generated Files

plugins/DungeonForge/
├── config.yml          # Main configuration
├── loot_tables.yml     # Loot table definitions
├── dungeons/           # Your dungeon saves
│   └── *.yml
└── templates/          # Room templates (NBT)
    └── <dungeonId>/
        └── *.nbt

Optional Integrations

Plugin	Purpose
Vault	Economy rewards on dungeon completion
PlaceholderAPI	Stats and leaderboard placeholders
MythicMobs	Custom mob spawning
MMOItems	Custom items in loot tables
Citizens	NPC support for quests/merchants
ModelEngine	Custom mob models

⚡ Quick Start (5 Minutes)

🎯 Goal

Create your first playable dungeon in under 5 minutes!

Step-by-Step Guide

Create a dungeon:
```
/df create MyFirstDungeon
```
Start editing:
```
/df edit MyFirstDungeon
```
Your hotbar now has quick-access builder items!
Open Builder Hub:
```
/df build
```
Or use the Compass in your hotbar
Follow the guided steps:
- Create Room (select corners first)
- Place Start Marker
- Place End Marker
- Unlock Free Build tools!
Publish your dungeon:
```
/df publish MyFirstDungeon
```
Test it!
```
/dfjoin MyFirstDungeon
```
Set lobby return point:
```
/df setspawnoflobby
```

🎮 Your First Dungeon Tutorial

Understanding the Builder Flow

DungeonForge uses a guided builder system that walks you through creating a dungeon step by step.

📍 Step 1: Create Your Room

▼

Get your wand: /df wand
Switch to SELECT mode (Shift + Drop)
Left-click one corner of your room
Right-click the opposite corner
Open Builder Hub and click "Create Room"

🟢 Step 2: Place Start Marker

▼

Switch wand to MARKER mode
Right-click where players should spawn
Select "START" from the marker picker

🔴 Step 3: Place End Marker

▼

Right-click where the dungeon should end
Select "END" from the marker picker
You now have Free Build access!

⚔️ Step 4: Add Combat & Loot

▼

MOB_SPAWN: Add enemy spawners
BOSS_SPAWN: Add a boss fight
LOOT_CHEST: Add treasure chests
TRAP: Add hazards

Use INFO mode to configure each marker!

👤 Player Commands

Main command aliases: /dungeonforge, /df, /dungeon, /dungeons

Command	Description
`/df help`	Show help menu
`/df howto`	Step-by-step quick guide
`/df tutorial`	Cinematic setup guide
`/df menu`	Open main menu GUI
`/dfjoin <dungeon>`	Join a dungeon
`/dfleave`	Leave current dungeon
`/df preview <dungeon>`	Preview a dungeon in 3D
`/df preview rooms`	Show room list in preview
`/df preview leave`	Exit preview mode
`/df queue <dungeon>`	Join matchmaking queue
`/df queue leave`	Leave queue

🔨 Builder Commands

Command	Description
`/df create <name>`	Create a new dungeon
`/dfcreate <name>`	Alias for create
`/df edit <name>`	Enter edit mode
`/df save`	Save and exit edit mode
`/df build`	Open Builder Hub GUI
`/df wand`	Get builder wand
`/df wand guide`	Get simple guided wand
`/df wand builder`	Get full builder wand
`/df prefabs`	Open prefab library
`/df room create <name>`	Create a room from selection
`/df room list`	List all rooms
`/df room delete <room>`	Delete a room
`/df publish <name>`	Toggle publish status
`/df validate <name>`	Validate dungeon setup
`/df tp <dungeon> [room]`	Teleport to dungeon/room

Prefab Commands

Command	Description
`/df prefab help`	Show prefab help
`/df prefab north\|south\|east\|west <n>`	Move preview
`/df prefab up\|down <n>`	Move preview vertically
`/df prefab rotl\|rotr`	Rotate preview
`/df prefab confirm`	Place the prefab
`/df prefab cancel`	Cancel placement

👥 Party Commands

Command	Description
`/dfparty create`	Create a new party
`/dfparty invite <player>`	Invite a player
`/dfparty accept`	Accept party invite
`/dfparty deny`	Deny party invite
`/dfparty leave`	Leave current party
`/dfparty kick <player>`	Kick a party member
`/dfparty disband`	Disband the party
`/dfparty list`	List party members
`/dfparty promote <player>`	Promote to party leader

⚙️ Admin Commands

Command	Description
`/df config`	Open server settings GUI
`/df reload`	Reload configuration
`/df setspawnoflobby`	Set lobby return point
`/df pack list`	List dungeon packs
`/df pack export <dungeon>`	Export dungeon pack
`/df pack import <file>`	Import dungeon pack

🪄 Wand System

The wand is your primary building tool. Get one with /df wand or /dfwand.

Wand Types

Command	Type	Description
`/df wand`	Default	Standard builder wand
`/df wand guide`	Guided	Simple wand for beginners
`/df wand builder`	Full	All features unlocked

Wand Modes

Cycle modes with Shift + Drop (Q)

📐 SELECT Mode

▼

Left-click: Set position 1
Right-click: Set position 2

Used for selecting room boundaries and regions.

📍 MARKER Mode

▼

Right-click: Open marker picker GUI
Sneak + Right-click: Quick-place selected marker type

Used for placing markers like spawners, chests, and objectives.

🔗 CONNECT Mode

▼

Right-click: Link two connector markers

Used for procedural generation - connects rooms together.

ℹ️ INFO Mode

▼

Right-click: Open marker configuration GUI

Used for configuring marker settings like mob types, loot tiers, etc.

🗑️ DELETE Mode

▼

Right-click: Remove marker at location

Used for removing placed markers.

🎒 Builder Hotbar

When you enter edit mode (/df edit <name>), your hotbar is populated with quick-access items:

Slot	Item	Action
1	🪄 Wand	Selection & marker placement
2	🧭 Compass	Opens Builder Hub (`/df build`)
3	📚 Bookshelf	Opens Prefab Library (`/df prefabs`)
4	⚙️ Comparator	Opens Server Config (`/df config`) - Admin only
5	⭐ Nether Star	Opens Main Menu (`/df menu`)
6	📖 Writable Book	Save and exit (`/df save`)
7	💎 Emerald	Toggle publish status
8	🚫 Barrier	Exit edit mode

💡 Tip

Right-click any hotbar item to use it. These items cannot be dropped or moved.

🏠 Room Creation

Rooms are the building blocks of dungeons. Each room contains markers and can be used as a prefab template.

Creating a Room

Enter edit mode: /df edit <dungeon>
Get your wand: /df wand
Switch to SELECT mode (Shift + Q)
Left-click first corner of your room
Right-click opposite corner
Run: /df room create <roomName>

Room Management

Command	Description
`/df room list`	List all rooms in current dungeon
`/df room delete <room>`	Delete a room
`/df tp <dungeon> <room>`	Teleport to a specific room

💡 Templates

Rooms are saved as NBT templates in plugins/DungeonForge/templates/<dungeonId>/

🧱 Prefab System

Prefabs are pre-built room templates you can place instantly. Perfect for quickly building dungeons!

Using Prefabs

Open the prefab library: /df prefabs
Click a prefab to select it
A preview will appear at your location
Use commands to position and rotate
Confirm placement: /df prefab confirm

Prefab Controls

Command	Action
`/df prefab north <n>`	Move preview north by n blocks
`/df prefab south <n>`	Move preview south by n blocks
`/df prefab east <n>`	Move preview east by n blocks
`/df prefab west <n>`	Move preview west by n blocks
`/df prefab up <n>`	Move preview up by n blocks
`/df prefab down <n>`	Move preview down by n blocks
`/df prefab rotl`	Rotate 90° counter-clockwise
`/df prefab rotr`	Rotate 90° clockwise
`/df prefab confirm`	Place the prefab
`/df prefab cancel`	Cancel placement

🎯 Pro Tip

Create your own prefabs by saving rooms! They'll appear in the prefab library for reuse.

📍 Core Markers

Core markers define the basic structure of your dungeon.

🟢 START Marker

▼

Required: Yes (one per dungeon)

Defines where players spawn when entering the dungeon.

Players teleport here on dungeon start
Also used as respawn point if no checkpoint reached

🔴 END Marker

▼

Required: Yes (one per dungeon)

Defines the dungeon completion point.

Players touching this complete the dungeon
Triggers rewards and teleport back to lobby

🔵 CHECKPOINT Marker

▼

Required: No (optional)

Save points within the dungeon.

Players respawn here on death
Multiple checkpoints can be placed
Players activate by walking through

⚔️ Combat Markers

Combat markers spawn enemies and create challenging encounters.

👹 MOB_SPAWN Marker

▼

Spawns mobs when players enter the area.

Configuration Options:

Option	Default	Description
mob-type	ZOMBIE	Entity type or MythicMobs ID (`mm:MobName`)
count	3	Number of mobs to spawn
activation-radius	8	Trigger distance (blocks)

# Example MythicMobs usage:
mob-type: mm:SkeletonWarrior
count: 5

💀 BOSS_SPAWN Marker

▼

Spawns a boss with health bar and phases.

Configuration Options:

Option	Default	Description
boss-type	WITHER_SKELETON	Entity type or MythicMobs ID
boss-name	Dungeon Boss	Display name above health bar
phase-count	3	Number of phases
phase-health-percentage	33	Health % per phase transition

🌊 WAVE_SPAWNER Marker

▼

Spawns multiple waves of mobs in sequence.

Configuration Options:

Option	Default	Description
wave-count	3	Number of waves
mobs-per-wave	5	Mobs in each wave
time-between-waves	10	Seconds between waves

⚠️ TRAP Marker

▼

Creates environmental hazards.

Configuration Options:

Option	Default	Description
trap-type	ARROW	Type of trap (ARROW, FIRE, POISON, etc.)
damage	4	Damage dealt
cooldown	3	Seconds between activations

🎁 Loot Markers

📦 LOOT_CHEST Marker

▼

Places a loot chest that generates items based on tier.

Configuration Options:

Option	Default	Description
tier	1	Loot tier (1-5, higher = better)
chest-type	CHEST	Block type (CHEST, TRAPPED_CHEST, BARREL)
item-count	5	Number of items to generate

Loot Tiers:

Tier 1: Common - Basic materials, food
Tier 2: Uncommon - Iron gear, potions
Tier 3: Rare - Diamond gear, enchantments
Tier 4: Epic - Enchanted diamond, rare items
Tier 5: Legendary - Best loot, custom items

# MMOItems loot example:
items:
  - "mi:SWORD:FLAME_BLADE"
  - "mi:ARMOR:DRAGON_HELM"

🔐 Puzzle Markers

Puzzle markers create interactive elements like doors and keys.

🚪 DOOR Marker

▼

Creates a locked door that requires a key to open.

Configuration Options:

Option	Default	Description
key-id	default	ID that matches with KEY_LOCATION
door-material	IRON_DOOR	Block type for the door

Doors block passage until the matching key is collected.

🔑 KEY_LOCATION Marker

▼

Places a collectible key that unlocks matching doors.

Configuration Options:

Option	Default	Description
key-id	default	ID that matches with DOOR marker
key-item	TRIPWIRE_HOOK	Item that represents the key

💡 Tip

Match key-id between DOOR and KEY_LOCATION to create lock/key pairs!

🔗 CONNECTOR Marker

▼

Defines connection points for procedural generation.

Configuration Options:

Option	Default	Description
direction	NORTH	Which way this connector faces
size	3x3	Size of the connection opening

Used in CONNECT wand mode to link rooms together for procedural layouts.

👥 Party System

Team up with friends to tackle dungeons together!

Creating & Managing Parties

Create a party: /dfparty create
Invite friends: /dfparty invite <player>
Friend accepts: /dfparty accept
Join dungeon together: /dfjoin <dungeon>

Party Features

Shared Instance: All party members join the same dungeon instance
Party Chat: Private communication channel
Shared Progress: Checkpoints and objectives sync across party
Loot Distribution: Configurable loot sharing modes

Matchmaking

Solo players can use the matchmaking queue to find parties:

/df queue <dungeon>   # Join the queue
/df queue leave        # Leave the queue

⚙️ Configuration

Party size limits and settings are in config.yml under the party: section.

💎 Loot System

DungeonForge features a 5-tier loot system with customizable loot tables.

Loot Tiers

Tier	Name	Typical Contents
1	Common	Basic materials, food, arrows
2	Uncommon	Iron gear, basic potions
3	Rare	Diamond gear, better enchants
4	Epic	Enchanted diamonds, rare drops
5	Legendary	Best items, custom gear

Loot Table Configuration

Edit plugins/DungeonForge/loot_tables.yml to customize loot:

tier_1:
  items:
    - material: IRON_SWORD
      chance: 0.3
      enchantments:
        SHARPNESS: 1
    - material: GOLDEN_APPLE
      amount: 1-3
      chance: 0.5

MMOItems Integration

Add custom MMOItems to loot tables:

tier_5:
  items:
    - mmoitem: "SWORD:LEGENDARY_BLADE"
      chance: 0.1
    - mmoitem: "ARMOR:DRAGON_PLATE"
      chance: 0.05

💀 Boss Fights

Create epic boss encounters with phases, abilities, and health bars!

Boss Features

Boss Bar: Displays health at top of screen
Multiple Phases: Boss changes behavior as health drops
Custom Abilities: Special attacks per phase
Loot Drops: Guaranteed rewards on defeat

Phase System

Bosses transition through phases based on health percentage:

Phase 1: 100% - 67% health
Phase 2: 66% - 34% health  (abilities unlock)
Phase 3: 33% - 0% health   (enraged mode)

Configuration

boss:
  health-multiplier: 10.0
  damage-multiplier: 2.0
  phases:
    enabled: true
    count: 3
  abilities:
    enabled: true

🎯 MythicMobs

For advanced boss mechanics, use MythicMobs: boss-type: mm:MyCustomBoss

🌍 Instancing

Each party gets their own isolated copy of the dungeon!

Instance Types

Type	Description
Isolated Worlds	Each run creates a separate world (recommended)
Slot-Based	Pre-generated slots in one world

How Instancing Works

Player/party runs /dfjoin <dungeon>
DungeonForge creates/assigns an instance
Dungeon is copied to the instance
Players are teleported in
On completion/leave, instance is cleaned up

Instance Protection

Players cannot break dungeon blocks
Mob spawning is controlled by markers
Inventory optionally saved/restored
Death handling is customizable

Configuration

instances:
  isolated-worlds:
    enabled: true
    world-prefix: "df_instance_"
    delete-on-complete: true
  slot-based:
    enabled: false
    slots-per-dungeon: 5

🎲 Procedural Generation

Generate unique dungeon layouts each run using room templates and connectors!

How It Works

Create multiple room templates (prefabs)
Add CONNECTOR markers to each room
Link connectors with compatible rooms
DungeonForge randomly assembles rooms each run

Connector Setup

Switch wand to MARKER mode
Place CONNECTOR markers at doorways
Switch to CONNECT mode
Right-click two connectors to link them

Configuration

procedural:
  enabled: true
  min-rooms: 5
  max-rooms: 12
  branch-chance: 0.3
  corridor:
    enabled: true
    min-length: 3
    max-length: 8

⚠️ Important

Procedural dungeons need at least 3 room templates with matching connectors to work well.

📋 General Configuration

Main settings in plugins/DungeonForge/config.yml

general:
  language: en_US
  debug: false

builder:
  default-wand-mode: SELECT
  particles-enabled: true
  selection-particle: FLAME

preview:
  enabled: true
  duration-seconds: 60
  particle-density: 1.0

🌐 Instance Configuration

instances:
  isolated-worlds:
    enabled: true
    world-prefix: "df_instance_"
    delete-on-complete: true
    ground-level-placement:
      enabled: true
      target-y: 64

  slot-based:
    enabled: false
    slots-per-dungeon: 5
    slot-spacing: 1000

  protection:
    prevent-block-break: true
    prevent-block-place: true
    prevent-mob-spawning: true

  player:
    save-inventory: true
    restore-on-leave: true
    teleport-on-death: CHECKPOINT

📍 Marker Default Configuration

markers:
  defaults:
    mob_spawn:
      mob-type: ZOMBIE
      count: 3
      activation-radius: 8

    boss_spawn:
      boss-type: WITHER_SKELETON
      boss-name: "Dungeon Boss"
      phase-count: 3

    wave_spawner:
      wave-count: 3
      mobs-per-wave: 5
      time-between-waves: 10

    loot_chest:
      tier: 1
      chest-type: CHEST
      item-count: 5

    door:
      key-id: "default"
      door-material: IRON_DOOR

    key_location:
      key-id: "default"
      key-item: TRIPWIRE_HOOK

🎁 Loot Configuration

loot:
  enabled: true

rewards:
  economy:
    enabled: true
    base-amount: 100
    per-tier-bonus: 50
  experience:
    enabled: true
    base-xp: 50

drops:
  mobs:
    enabled: true
    drop-chance: 0.3
  bosses:
    guaranteed-drops: true
    drop-count: 3

👹 MythicMobs Integration

Spawn custom MythicMobs creatures in your dungeons!

Usage

Prefix mob names with mm: in any spawner marker:

# MOB_SPAWN marker
mob-type: mm:SkeletonWarrior

# BOSS_SPAWN marker
boss-type: mm:DragonLord

# WAVE_SPAWNER marker
mob-types:
  - mm:Zombie
  - mm:SkeletonArcher
  - mm:DarkMage

Requirements

MythicMobs 5.x installed and configured
Mob must be defined in MythicMobs config

💡 Tip

DungeonForge will fallback to vanilla mobs if MythicMobs isn't installed or the mob isn't found.

🗡️ MMOItems Integration

Add custom MMOItems to loot chests and drop tables!

Usage

Prefix items with mi:TYPE:ID in loot tables:

tier_5:
  items:
    - mmoitem: "SWORD:FLAME_BLADE"
      chance: 0.1
    - mmoitem: "ARMOR:DRAGON_HELM"
      chance: 0.05
    - mmoitem: "CONSUMABLE:HEALTH_POTION"
      chance: 0.3

Marker Configuration

In LOOT_CHEST marker config:

items:
  - "mi:SWORD:LEGENDARY_BLADE"
  - "mi:ARMOR:DRAGON_PLATE"
  - "mi:GEM:FIRE_RUBY"

Requirements

MMOItems installed and configured
Items must exist in MMOItems database

🔌 Other Plugin Integrations

Vault (Economy)

Reward players with money on dungeon completion:

rewards:
  economy:
    enabled: true
    base-amount: 100
    per-tier-bonus: 50

PlaceholderAPI

Available placeholders for scoreboards and chat:

Placeholder	Description
`%dungeonforge_runs%`	Total dungeons completed
`%dungeonforge_kills%`	Total mobs killed
`%dungeonforge_deaths%`	Total deaths in dungeons
`%dungeonforge_current%`	Current dungeon name
`%dungeonforge_party_size%`	Current party size

Citizens (NPCs)

Place Citizens NPCs in dungeons for quests or merchants. NPCs persist in templates and are cloned to instances.

ModelEngine

Apply custom models to mobs spawned by MythicMobs integration. Models display correctly in dungeon instances.

🔑 Permissions

Permission	Default	Description
`dungeonforge.admin`	op	Full admin access (config, reload, etc.)
`dungeonforge.build`	op	Create and edit dungeons
`dungeonforge.play`	true	Join and play dungeons
`dungeonforge.party`	true	Use party commands

Permission Hierarchy

dungeonforge.admin
  └── dungeonforge.build
        └── dungeonforge.play
              └── dungeonforge.party

💡 Tip

Use a permissions plugin like LuckPerms to manage player access.

🔧 Troubleshooting

❌ Plugin won't load

▼

Check you're running Paper/Spigot 1.16+
Verify Java 16 or higher is installed: java -version
Check console for error messages
Ensure the JAR isn't corrupted (re-download)

❌ Dungeons won't load/save

▼

Check file permissions on plugin folder
Ensure disk isn't full
Run /df validate <dungeon>
Check console for specific errors

❌ MythicMobs/MMOItems not working

▼

Verify the plugin is installed and enabled
Check mob/item names are correct (case-sensitive)
Use /mm mobs to list available MythicMobs
Use /mi list to list available MMOItems

❌ Players can't join dungeons

▼

Check dungeon is published: /df publish <name>
Verify player has dungeonforge.play permission
Run /df validate <name> to check setup
Ensure START and END markers exist

❓ Frequently Asked Questions

How many dungeons can I create?

▼

Unlimited! There's no hard limit on dungeons. Performance depends on your server resources.

Can multiple parties run the same dungeon simultaneously?

▼

Yes! That's what instancing is for. Each party gets their own isolated copy. You can have unlimited concurrent runs.

Do I need MythicMobs or MMOItems?

▼

No! All integrations are optional. DungeonForge works fully standalone with vanilla Minecraft mobs and items.

Can I share dungeons with other servers?

▼

Yes! Use the pack system:

Export: /df pack export <dungeon>
Import: /df pack import <file>

What happens if a player disconnects mid-dungeon?

▼

Their inventory is restored (if configured), and they're teleported to the lobby on reconnect. The instance continues if other party members are present.

How do I reset a dungeon instance?

▼

Instances automatically reset when all players leave. For the source dungeon, re-enter edit mode and make changes.

🏰 DungeonForge

The Ultimate Dungeon Creation System

Made with ❤️ for Minecraft

Back to Top