Dungeon Stages and Main Settings

---

Before we begin setting up the dungeon and its parts, let's first understand how the dungeon generation process works.

Dungeons are created through a series of different stages. These stages handle the different processes that the dungeon has to pass in order to spawn and run correctly.

Stage Settings

The different stages of dungeon generation are as follows:

graph LR;
    id1(FREEZE)-->id2(CHECK)-->id3(PREPARE)-->id4(CLOSED);
    id4(CLOSED)-->id5(WAITING_PLAYERS)-->id6(OPENING);
    id6(OPENING)-->id7(OPENED)-->id8(DELETING)-->id1(FREEZE);
    id1(FREEZE)-->id9(CANCELLED);
    id2(CHECK)-->id9(CANCELLED);
    id3(PREPARE)-->id9(CANCELLED);
    id4(CLOSED)-->id9(CANCELLED);
    id5(WAITING_PLAYERS)-->id9(CANCELLED);
    id6(OPENING)-->id9(CANCELLED);
    id7(OPENED)-->id9(CANCELLED);
    id8(DELETING)-->id9(CANCELLED);
    id9(CANCELLED)-->id1(FREEZE);

Loading

STAGE	DESCRIPTION
FREEZE	All active dungeons are queued up and waiting their turn.
CHECK	All active modules like location generation, announcements, chests, commands, schematics, holograms, spawn points, and mobs are verified.
PREPARE	The dungeon is being created in the world.
CLOSED	The dungeon has spawned but is not open yet.
WAITING_PLAYERS	Players can enter the dungeon area and explore.
OPENING	The dungeon opens and the chests fill with rewards, mobs appear, and holograms are set up.
OPENED	The dungeon is fully open and mobs/effects are activated.
DELETING	All active modules are cleaned up; the dungeon closes and gets deleted.
CANCELLED	This stage occurs if something goes wrong.

You can view these different stages by clicking on the Stage Settings icon in the dungeon settings menu.

You can set timers to each of these stages but we'll get to part that later on.

Main Settings

The next thing you need to know is the main settings for the dungeon. These settings control how your dungeon works.

It will allow you to:

• Enable or disable the dungeon instance you created
  
• Use a click timer for the dungeon chests
  
• Allow players into the dungeon area when it's close
  
• Specify the number of online players needed to activate the dungeon
  
• Choose which mobs spawn in the dungeon
  

Enabled Dungeon

When you create a new instance of a dungeon, this setting is enabled by default.
Clicking the icon toggles between Yes and No. You can leave this as is but I highly recommend
setting this to "No" if you are creating a dungeon for the first time.
Setting this option to "No" will stop the dungeon from generating in the world.

Click Timer

When the dungeon spawns, the dungeon chest goes through five stages: waiting, cooldown,
closed, opened, and deleted. If you set the chest opening type to Click and activate this
option, clicking on the dungeon chest during the waiting stage will start the timer for the
closed stage right away. By default, this setting is set to "No".

Player Roaming (Let players when close)

When the dungeon is in the closed stage, this setting will allow players to roam inside the dungeon
area. By default this is set to "Yes".

Warning

When this is set to "No", players will be pushed back 3 blocks away from the dungeon.

Minimal Online

This setting decides if the dungeon spawns based on how many players are online. When you make
a new dungeon instance, it's set to 0 by default. You will want to change this to 1 to stop the
dungeon from spawning when the server is online with no players.

Dungeon Mobs

This setting will set which mob spawns in the dungeon. To make them spawn in the dungeon, you will need to
set them up in the Mob Editor first. After setting them up, go back this setting and enter the mob ID and
then specify the mob count to spawn. For this tutorial, we'll use "Zombie" as the mob ID and use 5
for the mob count (e.g., "Zombie 5"). This means that the dungeon will spawn 5 Zombies when it opens.

Note

If you haven't set up the mobs in the Mob Editor yet, you can leave this setting as is by clicking on [Exit Edit Mode] to return to the settings menu.