name: LockX
version: ${project.version}
main: nl.tabuu.lockx.LockX
description: ${project.description}
author: Tabuu
authors: [Tabuu]
website: https://www.tabuu.nl
depend: [TabuuCore]
api-version: 1.13

commands:
  lockx:
    usage: /<command>
    description: Opens the lock menu.
    permission: lockx.lock.menu.open
    aliases: [lockette, lock]

  lockx help:
    usage: /<command> help
    description: Help command.
    permission: lockx.command.help

  lockx give:
    usage: /<command> give <player> [amount]
    description: Gives a player a lock.
    permission: lockx.lock.give

permissions:
  lockx.lock.menu.open:
    description: Allows users to open a lock menu.
    default: true

  lockx.command.help:
    description: Allows users to execute the LockX help command.
    default: true

  lockx.lock.give:
    description: Allows users to give lock items.
    default: op

# DESCRIPTION:  Settings regarding the lock item.
LockItem:
  # DESCRIPTION:  Material type of the item.
  # FORMAT:       TabuuCore XMaterial (http://f.tabuu.nl/spigot/tabuucore/javadoc/nl/tabuu/tabuucore/material/XMaterial.html).
  Material: 'TRIPWIRE_HOOK'

  # DESCRIPTION:  Display name of the lock item.
  # FORMAT:       String.
  DisplayName: '&e&lLock'

  # DESCRIPTION:  Lore of the lock item.
  # FORMAT:       String
  # NOTE:         Add a return by adding '\n' to the string.
  Lore: '&7Use shift + right click on a valid block to lock it.'

  # DESCRIPTION:  Whether the lock item should drop on lock destroy.
  # FORMAT:       Boolean.
  Drop: true

  # DESCRIPTION:  Settings regarding lock crafting.
  Crafting:
    # DESCRIPTION:  Whether the lock item should be craftable.
    # FORMAT:       Boolean.
    Craftable: true

    # DESCRIPTION:  Lock item recipe
    Recipe:
      # DESCRIPTION:  Whether or not the recipe is shaped, if set to false it is shapeless.
      # FORMAT:       Boolean.
      Shaped: true

      # DESCRIPTION:  The items used and their symbols.
      #               XMaterial (http://f.tabuu.nl/spigot/tabuucore/javadoc/nl/tabuu/tabuucore/material/XMaterial.html).
      # FORMAT:       Map.
      Ingredients:
        A: 'LEVER'
        B: 'IRON_INGOT'
        C: 'REDSTONE'
        D: 'AIR'

      # DESCRIPTION:  Shape of the recipe (if shaped), using the ingredients map.
      # FORMAT:       String list.
      Shape:
        - "DAD"
        - "DBD"
        - "DCD"

# DESCRIPTION:  Settings regarding the protection of a lock.
LockProtection:
  # DESCRIPTION:  Whether or not a lock should be protected from explosions.
  # FORMAT:       Boolean.
  Explosion: true

  # DESCRIPTION:  Whether or not a locked block ignore being powered by redstone.
  # FORMAT:       Boolean.
  Redstone: true

  # DESCRIPTION:  Whether or not a locked block should be protected from piston movement.
  # FORMAT:       Boolean.
  Piston: true

  # DESCRIPTION:  Whether or not a locked block should be protected from entities.
  # FORMAT:       Boolean.
  Entity: true

  # DESCRIPTION:  Whether or not items can transfer OUT of a protected block by for example a hopper.
  # FORMAT:       Boolean.
  ItemTransfer: true

# DESCRIPTION:  Settings regarding sound.
SoundSettings:
  # DESCRIPTION:  Sound a player hears when an action has been successful.
  # FORMAT:       Sound (https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html).
  Sound_CONFIRMED: 'BLOCK_NOTE_BLOCK_PLING'

  # DESCRIPTION:  Sound a player hears when an action has been unsuccessful.
  # FORMAT:       Sound (https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html).
  Sound_DENIED: 'ENTITY_VILLAGER_NO'


# DESCRIPTION:  All block types a lock can be applied on.
# FORMAT:       TabuuCore XMaterial (http://f.tabuu.nl/spigot/tabuucore/javadoc/nl/tabuu/tabuucore/material/XMaterial.html).
LockableBlockTypes:
  # Containers
  - 'CHEST'
  - 'FURNACE'
  - 'HOPPER'
  - 'DROPPER'
  - 'DISPENSER'
  - 'ANVIL'

  # Doors
  - 'IRON_DOOR'
  - 'ACACIA_DOOR'
  - 'OAK_DOOR'
  - 'SPRUCE_DOOR'
  - 'BIRCH_DOOR'
  - 'JUNGLE_DOOR'
  - 'ACACIA_DOOR'
  - 'DARK_OAK_DOOR'

  # Trapdoors
  - 'IRON_TRAPDOOR'
  - 'OAK_TRAPDOOR'
  - 'SPRUCE_TRAPDOOR'
  - 'BIRCH_TRAPDOOR'
  - 'JUNGLE_TRAPDOOR'
  - 'ACACIA_TRAPDOOR'
  - 'DARK_OAK_TRAPDOOR'

# DESCRIPTION:  All entity types a lock can be applied on.
# FORMAT:       Bukkit EntityType (https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html)
# NOTE:         Variable note
LockableEntityTypes:
  - 'HORSE'

LOCKETTE_COMMAND_NO_LOCK_FOUND: "&c&lYou must look at a lock to perform this command."

# DESCRIPTION:  Lock item related text.
LOCK_ITEM_USE_SUCCESS: "&2&lSuccessfully applied lock!"
LOCK_ITEM_USE_FAIL: "&c&lFailed to apply lock!"


# DESCRIPTION:  Lock interaction related text.
LOCK_INTERACTION_DENIED: "&c&lYou cannot open this lock!"
LOCK_REMOVED: "&e&lYou removed a lock!"


# DESCRIPTION:  Main UI related text.
LOCK_UI_TITLE: "&3&l{OWNER_NAME}'s lock"

LOCK_UI_DEFAULT_SETTINGS_BUTTON: "&a&lChange default access settings."
LOCK_UI_DEFAULT_SETTINGS_BUTTON_LORE: "&7Click here to change the default access settings.\n
\n
&7&lCurrent settings:\n
&7Can open: {CAN_OPEN}\n
&7Can edit: {CAN_EDIT}"

LOCK_UI_REMOVE_BUTTON: "&c&lRemove lock."
LOCK_UI_REMOVE_BUTTON_LORE: "&7Click here to remove lock."

LOCK_UI_ACCESS_BUTTON: "&a&lChange individual access settings."
LOCK_UI_ACCESS_BUTTON_LORE: "&7Click here to change the access of individual players.\n
&7You can also set the group here."

LOCK_UI_PASSWORD_CHANGE_BUTTON: "&a&lChange password."
LOCK_UI_PASSWORD_CHANGE_BUTTON_LORE: "&7Click here to change the password."

LOCK_UI_PASSWORD_TOGGLE_BUTTON: "&a&lEnable/disable password"
LOCK_UI_PASSWORD_TOGGLE_BUTTON_LORE: "&7Click here to toggle the password.\n
\n
&7Password enabled: {PASSWORD_ENABLED}"

LOCK_UI_EXIT_BUTTON: "&c&lExit"
LOCK_UI_EXIT_BUTTON_LORE: "&7Click here to exit the UI."


# DESCRIPTION: Player lock setting selector UI related text.
LOCK_SETTING_SELECTOR_UI_TITLE: "&3&lAccess editor"

LOCK_SETTING_SELECTOR_UI_ITEM: "&b{PLAYER_NAME}"
LOCK_SETTING_SELECTOR_UI_ITEM_LORE: "&7Left-click here to edit this players settings.\n
&7Right-click here to remove this player.\n
\n
&7&lCurrent settings:\n
&7Can open: {CAN_OPEN}\n
&7Can edit: {CAN_EDIT}"

LOCK_SETTING_SELECTOR_UI_ADD_BUTTON: "&a&lAdd player"
LOCK_SETTING_SELECTOR_UI_ADD_BUTTON_LORE: "&7Click here to add a player."

LOCK_SETTING_SELECTOR_UI_EXIT_BUTTON: "&c&lExit"
LOCK_SETTING_SELECTOR_UI_EXIT_BUTTON_LORE: "&7Click here to exit the UI."

LOCK_SETTING_SELECTOR_UI_NEXT_BUTTON: "&9&lNext"
LOCK_SETTING_SELECTOR_UI_NEXT_BUTTON_LORE: "&7{CURRENT_PAGE}/{PAGE_COUNT}"

LOCK_SETTING_SELECTOR_UI_PREVIOUS_BUTTON: "&9&lPrevious"
LOCK_SETTING_SELECTOR_UI_PREVIOUS_BUTTON_LORE: "&7{CURRENT_PAGE}/{PAGE_COUNT}"

LOCK_SETTING_SELECTOR_UI_SAVE_BUTTON: "&9&lSave group"
LOCK_SETTING_SELECTOR_UI_SAVE_BUTTON_LORE: "&7Click here to save this access list as a group."

LOCK_SETTING_SELECTOR_UI_LOAD_BUTTON: "&9&lLoad group"
LOCK_SETTING_SELECTOR_UI_LOAD_BUTTON_LORE: "&7Click here to load a saved access group."


# DESCRIPTION: Lock setting editor UI related text.
LOCK_SETTING_EDITOR_UI_TITLE: "&3&lSettings editor"

LOCK_SETTING_EDITOR_UI_EXIT_BUTTON: "&c&lSave & exit"
LOCK_SETTING_EDITOR_UI_EXIT_BUTTON_LORE: "&7Save settings and exit UI."

LOCK_SETTING_EDITOR_UI_CAN_OPEN_CHECKBOX: "&b&lToggle can open"
LOCK_SETTING_EDITOR_UI_CAN_OPEN_CHECKBOX_LORE: "&7Click here to toggle the 'can open' setting."

LOCK_SETTING_EDITOR_UI_CAN_EDIT_CHECKBOX: "&b&lToggle can edit"
LOCK_SETTING_EDITOR_UI_CAN_EDIT_CHECKBOX_LORE: "&7Click here to toggle the 'can edit' setting."


# DESCRIPTION: Lock group setting selector UI related text.
LOCK_GROUP_SETTING_SELECTOR_UI_TITLE: "&3&lGroup setting selector"

LOCK_GROUP_SETTING_SELECTOR_UI_ADD_BUTTON: "&a&lAdd new group"
LOCK_GROUP_SETTING_SELECTOR_UI_ADD_BUTTON_LORE: "&7Click here to add a new group."

LOCK_GROUP_SETTING_SELECTOR_UI_REMOVE_BUTTON: "&c&lRemove group"
LOCK_GROUP_SETTING_SELECTOR_UI_REMOVE_BUTTON_LORE: "&7Set group of lock to default group."

LOCK_GROUP_SETTING_SELECTOR_UI_NEXT_BUTTON: "&9&lNext"
LOCK_GROUP_SETTING_SELECTOR_UI_NEXT_BUTTON_LORE: "&7{CURRENT_PAGE}/{PAGE_COUNT}"

LOCK_GROUP_SETTING_SELECTOR_UI_PREVIOUS_BUTTON: "&9&lPrevious"
LOCK_GROUP_SETTING_SELECTOR_UI_PREVIOUS_BUTTON_LORE: "&7{CURRENT_PAGE}/{PAGE_COUNT}"

LOCK_GROUP_SETTING_SELECTOR_UI_EXIT_BUTTON: "&c&lExit"
LOCK_GROUP_SETTING_SELECTOR_UI_EXIT_BUTTON_LORE: "&7Click here to exit the UI."

LOCK_GROUP_SETTING_SELECTOR_UI_ITEM: "&b{GROUP_NAME}"
LOCK_GROUP_SETTING_SELECTOR_UI_ITEM_LORE: "&7Left-click here to select this players settings.\n
&7Right-click here to remove this group."