> For the complete documentation index, see [llms.txt](https://eproject.gitbook.io/eshulkerbox/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eproject.gitbook.io/eshulkerbox/general/configuration.md).

# Configuration

## Deafult config.yaml

```yaml
#
#   ███████╗███████╗██╗  ██╗██╗   ██╗██╗     ██╗  ██╗███████╗██████╗ ██████╗  ██████╗ ██╗  ██╗
#   ██╔════╝██╔════╝██║  ██║██║   ██║██║     ██║ ██╔╝██╔════╝██╔══██╗██╔══██╗██╔═══██╗╚██╗██╔╝
#   █████╗  ███████╗███████║██║   ██║██║     █████╔╝ █████╗  ██████╔╝██████╔╝██║   ██║ ╚███╔╝
#   ██╔══╝  ╚════██║██╔══██║██║   ██║██║     ██╔═██╗ ██╔══╝  ██╔══██╗██╔══██╗██║   ██║ ██╔██╗
#   ███████╗███████║██║  ██║╚██████╔╝███████╗██║  ██╗███████╗██║  ██║██████╔╝╚██████╔╝██╔╝ ██╗
#   ╚══════╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝
#
# "ANSI Shadow" from http://patorjk.com/software/taag/
# Version:    ${version}
# Build time: ${timestamp}
# Wiki: https://eproject.gitbook.io/eshulkerbox/
# --
# General configuration
# --
# After change, reload needed! [/eshulkerbox reload]
# Websites:
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html

# Will the plugin be enabled? After change, restart needed!
enabled: true

# If set to true, the plugin will send message everytime the plugin is not updated
check-for-updates: true

# Will the plugin support custom ShulkerBoxes?
# You are able to create your own custom ShulkerBoxes that can support CustomModelData and much more!
# More info: https://eproject.gitbook.io/eshulkerbox/custom-shulkerboxes
allow-custom-shulker-boxes: true

# Default cooldown of each ShulkerBox (in miliseconds) -> 1s = 1000ms
default-cooldown: 1000

# Default sound that will play when the player opens a ShulkerBox
# If you want to disable the sound, set it to "NONE"
# Default: BLOCK_SHULKER_BOX_OPEN
default-open-sound: "BLOCK_SHULKER_BOX_OPEN"

# Default sound that will play when the player closes a ShulkerBox
# If you want to disable the sound, set it to "NONE"
# Default: BLOCK_SHULKER_BOX_CLOSE
default-close-sound: "BLOCK_SHULKER_BOX_CLOSE"

# Pitch of the sound when opening a shulker box
# Default: 1.0
default-open-pitch: 1.0

# Pitch of the sound when closing a shulker box
# Default: 1.0
default-close-pitch: 1.0

# Volume of the sound when opening a shulker box
# Default: 1.0
default-open-volume: 1.0

# Volume of the sound when closing a shulker box
# Default: 1.0
default-close-volume: 1.0

# If set to true, all shulker boxes can be opened by right clicking them
# If set to false, only custom shulker boxes with the option "openable-by-interact" can be opened by right clicking them
# Default: true
all-boxes-are-openable-by-interact: true

# Openable enderchest
# Default: false
openable-enderchest-by-interact: false

# shift + right click to invite players to open your shulker box
# If set to true, you can send invite friends to open shulker box
# Default: true
invite-friend-to-open-shulker: true

# Disable the plugin for specific worlds
# If you want to disable the plugin for a specific world, add the world name to the list
disabled-worlds:
  - "spawn1"
  - "spawn2"
```

## Default messages.yaml

```keepalived
#e
#   ███████╗███████╗██╗  ██╗██╗   ██╗██╗     ██╗  ██╗███████╗██████╗ ██████╗  ██████╗ ██╗  ██╗
#   ██╔════╝██╔════╝██║  ██║██║   ██║██║     ██║ ██╔╝██╔════╝██╔══██╗██╔══██╗██╔═══██╗╚██╗██╔╝
#   █████╗  ███████╗███████║██║   ██║██║     █████╔╝ █████╗  ██████╔╝██████╔╝██║   ██║ ╚███╔╝
#   ██╔══╝  ╚════██║██╔══██║██║   ██║██║     ██╔═██╗ ██╔══╝  ██╔══██╗██╔══██╗██║   ██║ ██╔██╗
#   ███████╗███████║██║  ██║╚██████╔╝███████╗██║  ██╗███████╗██║  ██║██████╔╝╚██████╔╝██╔╝ ██╗
#   ╚══════╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝
#
# "ANSI Shadow" from http://patorjk.com/software/taag/
# --
# General messages
# You can use %prefix% to replace it for the currently prefix in config.yaml
# If you want to, you can use RGB colors (Gradients, Solid) -> more on our wiki
# Our systems supports PAPI
# --

prefix: "&8[&b&lShulkerBox&8] &7"

help-command:
  - "&8&m-------------------&8[&b&lShulkerBox&8]&8&m-------------------"
  - "&8» &b/shulkerbox help&8» &7Shows this help page"
  - "&8» &b/shulkerbox reload [type] &8» &7Reloads the plugin"
  - "&8» &b/shulkerbox give <type> [player] &8» &7Gives a shulker box to a player"
  - "&8» &b/shulkerbox list &8» &7Shows all shulker box types"
  - "&8» &b/shulkerbox info <type> &8» &7Shows info about a shulker box type"
  - "&8&m------------------------------------------------------"


invalid-command: "%prefix% &cInvalid command! Type /shulkerbox help for help!"

no-permission: "%prefix% &cYou don't have permission to do that!"

no-player: "%prefix% &cYou can't do that from console!"

plugin-reloading: "%prefix% &7Reloading plugin..."

# Custom Placeholders for this message:
# %time% - Reload time in milliseconds
plugin-reloaded: "%prefix% &7Plugin reloaded in %time%!"

# Custom Placeholders for this message:
# %new_version% - New version of the plugin
# %current_version% - Current version of the plugin
update-available: "%prefix% &7There is an %new_version% update available!"
```