⚙️Main configuration

Correctly configures the plugin's main configuration file.

Explanations of the different settings are generally well explained. However, for a more in-depth explanation, or even examples, this page will be helpful.

---

############################################################
# +------------------------------------------------------+ #
# |                      Information                     | #
# +------------------------------------------------------+ #
############################################################

# This is the configuration file for EssentialsX-GUI.

# If you need help with the configuration of the plugin,
# you can join our discord server at: https://discord.gg/fSzK79TAYf

# For more information about how to configure EssentialsX-GUI,
# check our Wiki at: https://sniper-tvmc.gitbook.io/essentialsx-gui/configuration/main-configuration

############################################################
# +------------------------------------------------------+ #
# |                        General                       | #
# +------------------------------------------------------+ #
############################################################

general:

  # Please do not change this value as it may cause the file to be reset.
  # Default: "1.0"
  configVersion: "1.0"

  # If you want to see a detailed loading message when the plugin is loading, set this to true. (Also works for unloading)
  # Default: true
  detailedLoading: true

  # Do you want to check for updates of the plugin?
  # Default: true
  checkForUpdates: true


  modules:

    # Set this to true if you want to use the homes features.
    # This will allow players to access the homes GUI.
    # Default: true
    homes: true

    # Set this to true if you want to use the kits features.
    # This will allow players to access the kits GUI.
    # Default: true
    kits: true

############################################################
# +------------------------------------------------------+ #
# |                        Sounds                        | #
# +------------------------------------------------------+ #
############################################################

sounds:

  # Set this to true if you want to enable sounds in the plugin.
  # Default: true
  enabled: true


  # Warning: This section should follow values listed on this website:
  # - https://helpch.at/docs/1.21.5/org/bukkit/Sound.html
  # Change '1.21.5' with your current Minecraft version.


  # The sound played when a player opens a GUI.
  # Default: "BLOCK_CHEST_OPEN"
  guiOpen: "BLOCK_CHEST_OPEN"

  # The sound played when a player clicks on a close item.
  # Default: "BLOCK_CHEST_CLOSE"
  guiClose: "BLOCK_CHEST_CLOSE"

  # The sound played when a player clicks on a back item.
  # Default: "ENTITY_EXPERIENCE_BOTTLE_THROW"
  guiBack: "ENTITY_EXPERIENCE_BOTTLE_THROW"

  # The sound played when a player clicks on an interactive item in the GUI.
  # Default: "ENTITY_CHICKEN_EGG"
  guiClick: "ENTITY_CHICKEN_EGG"


  # The sound played when a player completes an action.
  # Default: "ENTITY_PLAYER_LEVELUP"
  actionSuccess: "ENTITY_PLAYER_LEVELUP"

  # The sound played when a player cancels an action.
  # Default: "ENTITY_ITEM_BREAK"
  actionCanceled: "ENTITY_ITEM_BREAK"

  # The sound played when a player fails an action.
  # Default: "ENTITY_VILLAGER_NO"
  actionFailure: "ENTITY_VILLAGER_NO"

############################################################
# +------------------------------------------------------+ #
# |                      Permissions                     | #
# +------------------------------------------------------+ #
############################################################

permissions:

  commands:

    # Change the permission needed to access to the EssentialsX-GUI command.
    # Default: "essentialsxgui.command.essentialsxgui"
    essentialsxgui: "essentialsxgui.command.essentialsxgui"

    # Change the permission needed to access to the EssentialsX-GUI debug command.
    # Default: "essentialsxgui.command.essentialsxgui.debug"
    debugArgument: "essentialsxgui.command.essentialsxgui.debug"


  guis:

    # Change the permission needed to access to the Kits GUI in admin mode.
    # Default: "essentialsx.gui.kits.admin"
    kitsAdminAccess: "essentialsxgui.kits.admin"