Dungeon-Config.md

@@ -13,91 +13,123 @@ Here is current default config provided by the plugin for your reference. _This
 General:
   # Do not change! Used to track the config version when major updates happen.
   Version: 1
+
   DungeonType: CLASSIC
+
   # The generator to use for chunks in this dungeon. These can also be provided by other plugins.
   # natural = Default superflat.
   # mythicdungeons:void = Classic void generator, provided by Mythic Dungeons.
   # mythicdungeons:block.[BLOCKTYPE] = Generates entire chunks of a specific block. (For example, mythicdungeons:block.STONE would generate chunks at full height of all stone.)
   ChunkGenerator: natural
+
   # The pretty name of this dungeon that'll appear when it's finished and started.
   DisplayName: "&bA Dungeon"
+
   # Whether to show the display name above in a title message to the players when the dungeon begins.
   ShowTitleOnStart: false
+
   Lobby:
     Enabled: false
+
   # Where the player appears after leaving the dungeon via the "Finish Dungeon" function. (Use the /md setexit <dungeon> command.)
   ExitLocation: null
+
   # Whether to use the exit location for any time the player leaves instead of just when they finish the dungeon.
   AlwaysUseExit: false
+
   # What game mode the players will be in while in the dungeon.
   Gamemode: SURVIVAL
+
   # How many times the player can die before being unable to respawn. 0 will give the player infinite lives.
   PlayerLives: 0
+
   # Should players be shown minecraft's death screen when they die?
   InstantRespawnPlayers: false
+
   # Whether players who lose all their lives get put into spectator. If this is set to false, the player will instead be kicked from the dungeon.
   # NOTE: Spectators cannot use the spectator menu to exit the dungeon.
   DeadPlayersSpectate: true
+
   # Whether to close the dungeon when all players are spectating. If this is set to false, the dungeon will remain open until all players have left.
   # If set to false, players must use /md leave to exit the dungeon.
   # NOTE: This option only works if DeadPlayersSpectate is set to true.
   CloseDungeonWhenAllSpectating: true
+
   # Whether players keep their inventory upon entering the dungeon.
   KeepInventoryOnEnter: true
+
   # Whether players keep their current health upon entering the dungeon.
   # (Otherwise,they will be restored to full health upon entry, and set back to their previous health upon exit.)
   KeepHealthOnEnter: false
+
   # Whether players keep their current food level upon entering the dungeon.
   # (Otherwise, they will be restored to full food upon entry, and set back to their previous food level upon exit.)
   KeepFoodOnEnter: false
+
   # Whether players keep their current potion effects upon entering the dungeon.
   # (Otherwise, they will have all potion effects cleared upon entry.)
   KeepPotionEffectsOnEnter: false
+
   # Whether players keep their current EXP and level upon entering the dungeon.
   KeepExpOnEnter: true
+
   # Whether to kick players who disconnect during the dungeon.
   KickOfflinePlayers: true
+
   # How long to wait in seconds after a disconnect before kicking the player from the dungeon.
   KickOfflinePlayersDelay: 300
+
   # The maximum number of backups the plugin will save before deleting old backups.
   MaxBackups: 7
+
   # The maximum number of instances there can be of this dungeon at a time.
   MaxInstances: 5
+
   # How long in minutes until the dungeon is automatically ended and the players are kicked out. 0 will disable the time limit.
   TimeLimit: 0
+
   # How long in ticks to wait before cleaning up a dungeon when all players have left it. 0 will clean up the dungeon instantly.
   CleanupDelay: 0
+
   # The maximum number of players that can be in this dungeon. Used by the CONTINUOUS dungeon type.
   MaxPlayers: 0
 
-  # Per-dungeon overrides for the global queue/ready-check toggles in config.yml. (v2.0.1+)
-  # Uncomment any key at the top level (outside the General: section) to override the global
-  # value for this dungeon only. Omit a key to inherit the global. See "Config.md" for what
-  # each toggle does.
+  # ------------------------------------------------------------
+  # Per-dungeon overrides for global queue/ready-check toggles (v2.0.1+)
+  # Uncomment any key to override the matching value in config.yml
+  # for this dungeon only. Omit a key to inherit the global.
+  # See "Config.md" for what each toggle does.
+  # ------------------------------------------------------------
   #LeaderOnlyQueue: true
   #ReadyCheckOnCommand: true
   #ReadyCheckInQueue: true
   #ReadyCheckTime: 45
   #StartWithoutUnreadyPlayers: false
   #ReadyCheckRequireLeader: true
+  # ------------------------------------------------------------
 
   # When set to 'true', when players take items from reward functions, they'll be put in a rewards list.
   # Upon finishing the dungeon, the players will be given the rewards.
   GiveLootAfterCompletion: false
+
   # Loot Cooldown makes it so that players can't loot chests they've already looted recently.
   # Reward functions can be configured individually, or use the default values provided in this section.
   LootCooldown:
     Enabled: false
+
     # When true, each reward function tracks its own cooldown (per-chest).
     # When false, looting any reward starts a single dungeon-wide cooldown that blocks
     # all reward functions in this dungeon until it resets.
     PerReward: true
+
     # Setting this to TIMER will make it so the player can't get loot again until their cooldown is up.
     # Options like HOURLY, DAILY, WEEKLY, and MONTHLY will let you configure a set time for loot to be reset.
     CooldownType: DAILY
+
     # If type is set to TIMER, this is how many minutes until the player can acquire loot again.
     # Otherwise, this is the time of day when the reset occurs in hours.
     CooldownTime: 0
+
     # If type is set to WEEKLY, ResetDay determines what numbered day of the week the reset occurs.
     # "Sunday" would be 1, "Monday" is 2, "Tuesday" is 3, etc.
     # If type is set to MONTHLY, ResetDay determines what day of the month the reset occurs.
@@ -109,20 +141,27 @@ General:
   #    The "LootCooldown" section should be used instead to avoid this.
   AccessCooldown:
     Enabled: false
+
     # Whether to apply the cooldown when the player finishes the dungeon (via a "Finish Dungeon" function.)
     CooldownOnFinish: true
+
     # Whether to apply the cooldown when the player leaves the dungeon by any means.
     CooldownOnLeave: false
+
     # Whether to apply the cooldown when the player loses all their lives.
     CooldownOnLoseLives: false
+
     # Whether to apply the cooldown when the player starts the dungeon. If you have a lobby enabled, it won't apply the cooldown until a Start Dungeon function is activated.
     CooldownOnStart: false
+
     # Setting this to TIMER will make it so the player can't get run this dungeon again until their cooldown is up.
     # Options like HOURLY, DAILY, WEEKLY, and MONTHLY will let you configure a set time for access to be reset.
     CooldownType: DAILY
+
     # If type is set to TIMER, this is how many minutes until the player can player the dungeon again.
     # Otherwise, this is the time of day when the reset occurs in hours.
     CooldownTime: 0
+
     # If type is set to WEEKLY, ResetDay determines what numbered day of the week the reset occurs.
     # "Sunday" would be 1, "Monday" is 2, "Tuesday" is 3, etc.
     # If type is set to MONTHLY, ResetDay determines what day of the month the reset occurs.
@@ -131,19 +170,26 @@ General:
 Requirements:
   # A list of permissions the player must have.
   Permissions: []
+
   MinPartySize: 1
   MaxPartySize: 4
+
   # A list of dungeons the player must have completed. Note: "Finished" means the "Finish Dungeon" function was used in the required dungeon.
   DungeonsComplete: []
+
   # If a Vault-based economy is installed, it costs this much to play the dungeon.
   Cost: 0
+
   # Set to "true" if you only want to consume the above cost from the party leader.
   LeaderOnlyCost: false
+
 AccessKeys:
   # Whether to consume keys when players enter the dungeon using the key.
   Consume: true
+
   # Set to "true" if you only want to consume the key from the party leader.
   LeaderOnly: false
+
   # A list of itemstacks that are valid key items. NOTE: It is not recommended adding keys from here. Use the `/md addkey <dungeon>` command instead.
   # Mythic items are supported and will default to the latest version of the Mythic item (based on its namespace).
   KeyItems: []
@@ -151,8 +197,10 @@ AccessKeys:
 Difficulty:
   # Whether or not to enable difficulty levels for dungeons.
   EnableDifficultyLevels: false
+
   # Whether or not to show a difficulty selection menu to the player when playing. Requires the above to ALSO be true.
   EnableDifficultyMenu: false
+
   # A list of difficulty options and how they affect the dungeon. You can name them whatever you want and have as many as you like!
   # Useful in combination with the "Dungeon Difficulty" condition.
   Levels:
@@ -164,18 +212,24 @@ Difficulty:
         Display: "&cHard"
         Lore:
           - "&cOnly for the truest gamers."
+
       # How much to increase the mobs health by (1.2 would be +20%)
       MobHealth: 1.5
+
       # How much to increase the amount of mobs coming from spawner functions (1.2 would be +20%)
       MobAmounts: 1.5
+
       # How much to increase the amount of damage mobs do by (1.2 would be +20%)
       MobDamage: 1.25
+
       # How much to increase all Mythic Mobs' levels by
       BonusMythicLevels: 1
+
       # A range of how much bonus loot to add to loot table and random rewards functions.
       # WARNING: Only works on Mythic Dungeons loot tables and 'random rewards' functions!
       # Mythic Mobs drop tables do not get bonus drops. Instead, use the `dungeondifficulty` mythic condition in your mythic drop table!
       BonusLoot: 1-3
+
       # Optional per-difficulty overrides for selected General settings. Any key omitted falls
       # back to the dungeon's base value above. Supported keys:
       #   TimeLimit, PlayerLives, MaxPlayers, KeepInventoryOnEnter, InstantRespawnPlayers
@@ -183,6 +237,7 @@ Difficulty:
       #  TimeLimit: 15
       #  PlayerLives: 1
       #  KeepInventoryOnEnter: false
+
       # Optional per-mob overrides. Keys match the spawner's Mob field (MythicMob ID or
       # vanilla EntityType name). Any sub-key omitted falls back to the difficulty defaults
       # above (MobAmounts / MobHealth / MobDamage / BonusMythicLevels). Mobs not listed here
@@ -208,12 +263,16 @@ Difficulty:
 Map:
   # Gives the players the map when they join. Effectively enables use of the map.
   GiveOnJoin: false
+
   # How fast the blocks on the map should fade out as the player rises higher.
   MaxRenderDepth: 10
+
   # Displays a floor label in the corner of the map based on the Y value the player is at. Useful for procedural dungeons.
   DisplayFloors: false
+
   # How many blocks along the Y axis the player must travel before we consider the player to be on a different floor.
   FloorDepth: 3
+
   # Whether to show icons for other players on the map instead of just the player holding the map.
   ShowAllPlayers: true
 
@@ -227,18 +286,24 @@ Rules:
   AllowEnderpearl: false
   AllowChorusFruit: false
   AllowBucket: false
+
   # Limits placing things that don't count as blocks like boats.
   AllowPlaceEntities: false
+
   # Effectively sets RandomTickSpeed to 0 inside the dungeon, preventing blocks from spreading, plants from growing, ice from melting, etc.
   DisableRandomTick: true
+
   PreventPlantGrowth: true
   PreventExplosionBlockDamage: false
   PvP: false
   HideDeathMessages: false
+
   # Prevents players outside the dungeon from teleporting in. Admins can bypass with the `dungeons.bypassjoin` permission. (Or `dungeons.bypassjoin.[dungeon_name]`)
   PreventTeleportIn: false
+
   # Whether to allow all commands in the dungeon.
   AllowCommands: false
+
   # A list of commands that can still be used, even when "AllowCommands" is set to false.
   AllowedCommands:
     - party
@@ -247,39 +312,53 @@ Rules:
     - dungeon leave
     - md leave
     - leave
+
   # A list of commands that CAN'T be used, even when "AllowCommands" is set to true.
   DisallowedCommands: []
+
   # Vanilla Minecraft item materials to ban. (Must be a valid Spigot material.)
   BannedItems: []
+
   # A list of more detailed items to ban from the dungeon. (Recommended to use the /md banitem command instead of modifying this directly.)
   CustomBannedItems: []
+
   # Toggles whether banned items can be picked up if they are on the ground in the dungeon.
   AllowPickupBannedItems: false
+
   # Toggles whether banned items can be crafted while inside the dungeon.
   AllowCraftBannedItems: false
+
   # Toggles whether banned items can be placed in or removed from storage in the dungeon.
   AllowStorageBannedItems: false
+
   # A list of blocks that are allowed to be PLACED in this dungeon, regardless of the "AllowPlaceBlocks" rule.
   # Remove the [] and add the blocks like a list as show in the comments.
   BlockPlaceWhitelist: []
   # - DIAMOND_ORE
   # - GOLD_ORE
+
   # A list of blocks that are allowed to be BROKEN in this dungeon, regardless of the "AllowBreakBlocks" rule.
   BlockBreakWhitelist: []
+
   # A list of blocks that are NOT allowed to be PLACED in this dungeon, regardless of the "AllowPlaceBlocks" rule.
   BlockPlaceBlacklist: []
+
   # A list of blocks that are NOT allowed to be BROKEN in this dungeon, regardless of the "AllowBreakBlocks" rule.
   BlockBreakBlacklist: []
+
   # Whether to let players break any blocks they've placed in this dungeon. Useful when "AllowPlaceBlocks" is true, but "AllowBreakBlocks" is false.
   # OVERRIDES THE ABOVE RULES!!
   AllowBreakPlacedBlocks: false
+
   # A list of Spigot entities that cannot be damaged.
   DamageProtectedEntities: []
+
   # A list of Spigot entities that cannot be interacted with. Useful for protecting Item Frames and Armor Stands.
   InteractProtectedEntities: []
+
   # When set to true, prevents armor, weapons and/or tools from losing durability while in the dungeon
   PreventDurabilityLoss:
     Armor: false
     Weapons: false
     Tools: false
-```
\ No newline at end of file
+```