# Dungeon Settings

There are a lot of options available in a dungeon's config.yml configuration file.

# Global

General dungeon settings located at the top of the config.

Replaces default plugin's prefix for all messages sent inside a dungeon. You can use internal Dungeon placeholders.

Prefix: '<gray>[<white>%dungeon_name%</white>]</gray> '

Sets dungeon display name. This name is returned by the %dungeon_name% internal placeholder.

Name: 'Volter''s Mansion'

Sets dungeon description. This text is returned by the %dungeon_description% internal placeholder.

Description:
- 'Example of dungeon description.'
- 'Another line example.'

Sets dungeon icon to display in GUIs. Click Here to browse available options.

Icon:
  Material: player_head
  SkinURL: '80af5f572f1e5425bef927528076f7b0b755fd2bf5297acdce57a65bdb88b9c8'
  Hide_Components: true

Sets initial level for a dungeon.

StartLevel: default

Sets initial stage for a dungeon.

StartStage: default

# Game Settings

Gameplay dungeon settings located under the Game section.

# General

General gameplay settings. Located under the Game -> General section.

Sets the amount of time (in minutes) players have to complete a dungeon before it automatically fails. Set -1 to disable.

Timeleft: 30

Sets the amount of time (in seconds) players have to prepare for a dungeon raid in lobby.

Lobby_Prepare_Time: 60

Controls whether player automatically leaves a dungeon on death if no lives left. Otherwise becomes an spectator.

Leave_On_Death: true

Controls whether players gets their game mode set as Adventure inside a dungeon.

Adventure_Mode: true

Sets min. amount of players requried for a dungeon raid to start, and max. allowed amount of players for a dungeon. Set MaxPlayers to -1 to disable players limit.

MinPlayers: 1
MaxPlayers: 10

Sets amount of player lives in a dungeon. If player died having 2 or more lives, they can be revived with the revive_players Script Action.

PlayerLives: 1

Controls whether players keep their inventory on death.

Keep_Inventory: true

Sets a list of commands allowed to use inside a dungeon.

AllowedCommands:
- balance
- msg
- reply

Do not add a / before command names. Aliases for each command are auto-detected and included.

List of forbidden items inside a dungeon. Click Here for a list of item names.

Banned_Items:
- ender_pearl
- chorus_fruit

Forbidden items will be removed from player's inventory and restored on dungeon leave.

Broadcasts a message for all online players when a dungeon raid is about to start or ended.

Announcements:
  OnStart: true
  OnEnd: true

# Vanilla Features

Settings controlled vanilla mechanics inside a dungeon. Located under the Game -> VanillaFeatures section.

Controls whether exhaust is enabled in a dungeon.

Exhaust:
  Enabled: true

Controls health regeneration.

HealthRegain:
  Enabled: true # Enables health regeneration as a whole.
  DisabledFrom:
    Food: false # Disables health regeneration from eating consumables.
    Saturation: false # Disables health regeneration due to player's hunger being satisfied
    Potions: false # Disables health regeneration from all potions.
    Other: false # Disables health regeneration from all other sources.

Controls whether items can be damaged.

Item_Durability:
  Enabled: true

# Player Actions

Settings controlled player actions inside a dungeon. Located under the Game -> PlayerActions section.

Controls whether players can drop/pickup items in a dungeon.

Allow_Item_Drop: true
Allow_Item_Pickup: true

# Mobs

Mobs related settings. Located under the Game -> Mobs section.

Controls whether mobs can drop XP/loot in a dungeon.

DropXP: true
DropLoot: true

Controls whether external mob spawns are allowed. Click Here for a list of available spawn reasons.

AllowedExternalSpawns:
- custom
- spawner

# Kits

Kits related settings. Located under the Game -> Kits section.

Controls whether dungeon uses premade kits instead of player's own inventory.

Enabled: true

Sets max. possible amount of players with certain kit(s) in a dungeon.

Limits:
  warrior: 3
  tank: 0

To completely disable a kit for a dungeon, set its limit to 0.

# Integrations

Settings related to integrations with other plugins. Located under the Game -> Integrations section.

Controls whether players can use pets inside a dungeon.

Pets_Enabled: true

Controls whether mcMMO abilities are available inside a dungeon.

Mcmmo_Enabled: true