Config.md

@@ -5,61 +5,81 @@ Mythic Dungeons comes with a default config that includes lots of comments to ex
 General:
   # What plugin to use for the party system. Defaults to DungeonParties, which is provided by Mythic Dungeons.
   PartyPlugin: Default
+
   # Enable or disable the built-in party-chat system
   PartyChat: false
+
   # The max number of instances that can be run on this server.
   MaxInstances: 10
+
   # The interval between autosaves of the dungeon while in edit mode in seconds. 0 disables autosave. (NOT RECOMMENDED)
   AutoSaveInterval: 300
+
   # What the function builder item's material is. Must be a valid Spigot material.
   # Useful if you have another plugin that also uses FEATHER for a tool, like goPaint
   FunctionBuilderItem: FEATHER
+
   # Whether the `/md stuck` command kills the player.
   StuckKillsPlayer: false
+
+  # ------------------------------------------------------------
+  # Queue & Ready-Check
+  # All settings below can be overridden per-dungeon (v2.0.1+) by
+  # adding the same key at the top of that dungeon's config.yml.
+  # ------------------------------------------------------------
+
   # Whether only the party leader is allowed to start a dungeon for the party.
-  # (v2.0.1+) Can be overridden per-dungeon by setting `LeaderOnlyQueue` at the top level of that dungeon's config.yml.
   LeaderOnlyQueue: true
+
   # Whether to require all party members confirm they're ready before entering a dungeon after the play command is run.
   # Note: This check is used if there is no queue to get into the dungeon.
-  # (v2.0.1+) Per-dungeon override available via the same key in the dungeon's config.yml.
   ReadyCheckOnCommand: true
+
   # Whether to require all party members confirm they're ready before entering a dungeon after waiting in the queue.
-  # (v2.0.1+) Per-dungeon override available via the same key in the dungeon's config.yml.
   ReadyCheckInQueue: true
+
   # How long in seconds the ready check (from when a dungeon becomes available) will wait for all players to be ready.
-  # (v2.0.1+) Per-dungeon override available via the same key in the dungeon's config.yml.
   ReadyCheckTime: 45
+
   # Whether to send all ready players into the dungeon when the above timer expires.
-  # (v2.0.1+) Per-dungeon override available via the same key in the dungeon's config.yml.
   StartWithoutUnreadyPlayers: false
+
   # Whether to require the party leader to be ready when starting without all players.
-  # (v2.0.1+) Per-dungeon override available via the same key in the dungeon's config.yml.
   ReadyCheckRequireLeader: true
+
+  # ------------------------------------------------------------
+
   PartyFinder:
     # Whether to automatically broadcast party recruitments regularly.
     AutoBroadcast: true
     # How many minutes there should be between each broadcast of a recruitment listing.
     ListingBroadcastPeriod: 5
+
   # What Multiverse-Inventories group to use for all dungeons.
   MultiverseGroup: default
+
 # Settings related to procedural (room-based) dungeon generation.
 Generator:
   # How long the generator will spend trying to create a valid dungeon layout in seconds. If you have particularly complex dungeons, consider increasing this.
   # NOTE: This is handled async and will NOT lock up your server! Yay! This is useful if you have very large dungeons or rooms with lots of restrictive rules.
   Timeout: 5
+
 # These config options have potential to cause unforeseen issues and strangeness.
 Experimental:
   # Whether entities standing on moving blocks will move with the block.
   # WARNING :: Upwards movement will not work unless `allow-flight` in server.properties is set to TRUE! Use at your own risk!
   # WARNING 2 :: Jumping from a moving block DOES NOT WORK due to ping latency! We are investigating if this can be fixed but it seems unlikely due to vanilla limitations.
   MovingBlocksMoveEntities: false
+
   # Whether to keep all dungeons in a master world to avoid constantly loading and unloading worlds. SIGNIFICANTLY reduces risks of memory leaks.
   # WARNING :: This does NOT load all dungeons into your existing survival worlds!! It creates a SEPARATE world that will host all the dungeons!
   # See the "One-World Dungeons" wiki page for the full explainer.
   OneWorldDungeons: false
+
 Spectator:
   # Whether to use the legacy spectator system, modern one requires packetevents.
   UseLegacy: true
+
   Hotbar:
     Teleport:
       Material: COMPASS
@@ -79,6 +99,7 @@ Spectator:
       Name: '<red>Leave Dungeon</red>'
       Lore:
         - '<gray>Click to leave the dungeon.</gray>'
+
   GUI:
     Teleport:
       Title: '<gray>Teleport to Player</gray>'
@@ -101,4 +122,4 @@ Spectator:
             Slot: 11
             Lore:
                 - '<gray>Cycle fly speed, right click to increase, left click to reset</gray>'
-```
+```
\ No newline at end of file