How It Works
Just how does this all work, anyway?
How Dungeons Work
A dungeon is a Minecraft world with its own set of configurable rules and automated events and objectives, which Mythic Dungeons builds a private copy of whenever players start it.
Instanced Worlds
When players enter a dungeon, Mythic Dungeons builds them a private instance and sends them to it. This means every party has their own private version of the dungeon (we call these "instances"). When all the players have left the dungeon, that instance will be cleaned up and deleted.
How the instance is built depends on the dungeon type and on whether one-world dungeons are enabled:
- Classic and continuous dungeons get a fresh copy of the whole dungeon world.
- Procedural dungeons copy nothing. Their world is generated from the dungeon's rooms every time.
- With one-world dungeons enabled, the dungeon's selected regions are pasted into a shared world instead, and the instance is the area they occupy.
Automation
Dungeons can be automated using what we call Dungeon Elements, which include many customizable functions, triggers, and conditions, making for an objective system that is entirely in you the admin's hands.
Learn more about creating a dungeon and working with elements here!
The Dungeon Queue
Mythic Dungeons can be configured to have a limited number of instances running at a time. This is useful when you're concerned about overloading your server. config.yml has a global option for this (General.MaxInstances, 10 by default), limiting the total number of instances, while every dungeon's config has an option of the same name for limiting how many instances of itself can be running at once (5 in the default dungeon config, 0 means unlimited).
Both counts include more than just parties that are playing: an open /md edit session and an idle preloaded continuous instance each take up a slot too.
But what if all the instances are taken up and someone wants to start a dungeon? That's where the dungeon queue comes in.
If a player or party attempts to play a dungeon while all the instances are full, they'll be put in a queue that waits for a spot to become available. As soon as there's a free instance, the party will be informed with a title and a message. A countdown will then appear, giving them time to ready-up. When all party members are ready, the players will be sent into the dungeon. This same "ready-up" prompt appears when attempting to enter a dungeon with a party, regardless of the queue.
The queue only advances when an instance has been fully cleaned up, not the moment the last player walks out, so there is a short delay between an instance emptying and the next party being called.
The queue and the ready check are controlled by these config.yml options, each of which a dungeon can override for itself in its own config:
| Option | Default | What it does |
|---|---|---|
General.LeaderOnlyQueue |
true |
Only the party leader may start a dungeon for the party. |
General.ReadyCheckOnCommand |
true |
Run the ready check when the play command is used with no queue involved. |
General.ReadyCheckInQueue |
true |
Run the ready check after waiting in the queue. |
General.ReadyCheckTime |
45 |
Seconds the ready check waits for everyone. |
General.StartWithoutUnreadyPlayers |
false |
Send the ready players in anyway when the timer expires. |
General.ReadyCheckRequireLeader |
true |
The party leader must be ready when starting without everyone. |
How Parties Work
A party is a group of players that can enter a dungeon together. Mythic Dungeons comes with a default party system, and can hand the job over to another party plugin instead. All parties have a leader who is able to start the dungeon once all the players in the party are ready.
Which system is used is set with General.PartyPlugin in config.yml:
| Value | Party system |
|---|---|
Default or DungeonParties |
The party system built into Mythic Dungeons. This is the default. |
Heroes |
Heroes |
Parties |
Parties |
MythicRPG |
MythicRPG |
paf |
PartyAndFriendsGUI |
Any other value is treated as the name of an installed plugin. If no plugin by that name is found, party support is disabled and an error is logged at startup.
The built-in party system also includes a private party chat, but it is turned off by default. Set General.PartyChat: true in config.yml to enable it.
Party Recruitment
(GIF SHOWING THE RECRUITMENT PROCESS?)
Mythic Dungeons provides a party recruitment system for players making open-invite parties. By using the /recruit command, the player will be walked through a recruitment creation process, with the option of requiring a password. Once they've finished creating their recruitment listing, everyone on the server will receive a clickable message inviting them to join.
All recruitment listings have the following info:
- Label - The title of the recruitment listing.
- Description - Information about what the recruitment is for, such as what dungeon or what kind of player the party is looking for.
- Party Size - How many players are needed in the party.
- Password - OPTIONAL The password required to join the party.