config.yml

This page describes config.yml in a very detailed way. If your config.yml is missing entries, you may add them manually. For quick configuration, please refer to page Quick Start.

import-fromLockettePro: false

Imports config settings from LockettePro. Will turn itself off after imported the old config once. Will not import language files. Does not affect importing Lockette(Pro) lock signs. Is deprecated and will get removed in future Versions.

language-file-name: 'en'

The language file that Padlock will read from.

dependency.worldguard.enabled: <true/false>

If set to true and worldguard is installed, this will check if the player is allowed to build when quick protecting / breaking locks.

dependency.worldguard.overwrite: <true/false>

If set to true and worldguard is enabled, this will give the player access to locked blocks even if they don't have access to the region else wise. Note: This does NOT allow the player to break locks, even if they are owner of it, when they don't have block break access on the region! Note: We have to check every block at least twice to make this happen. If you experience lag, I would recommend to turn caching on.

lock.quick-protect: <NOT_SNEAKING_REQUIRED, SNEAK_NONRELEVANT, SNEAK_REQUIRED, NO_QUICKLOCK>

This will change quick protect settings. A quick protect action is whenever a user right-clicks a lockable block with a sign in his hand.

Option	Description
NOT_SNEAKING_REQUIRED	Quick protect if the player is not sneaking
SNEAK_NONRELEVANT	Quick protect if the player, whenever or not they are sneaking or not (this makes it hard to place signs on protected blocks!)
SNEAK_REQUIRED	Quick protect if the player is sneaking
NO_QUICKLOCK	Players can't quick protect and always have to manual lock

lock.blocked.interfere: <true/false>

This will block players from placing blocks that may potentially interfere with a locked block. For instance, it will block other players from placing hoppers next to a locked chest.

lock.blocked.item-transfer.in: <true/false>
lock.blocked.item-transfer.out: <true/false>

This will block items from transferring in/out a locked container.

lock.blocked.item-transfer.cooldown-ticks: <positiv integer including 0>

To prevent lag, hopper can set to a cooldown after they unsuccessfully accessed a locked container. While this cooldown is activ it will no longer try to transfer items in/out of the containter. Setting this to 0 will disable the cooldown. Note: this cooldown will stay even if the lock was removed from the container!

lock.blocked.hopper-minecart: <BLOCKED/ALLOWED/REMOVE>

This controls what happen when someone try to steal from a chest using a hopper minecart. Set to BLOCKED will block item transferring, set to ALLOWED will disable the protection, set to REMOVE will remove the hopper minecart. Note: hopper minecarts don't have cooldowns, so if you experience lag you should turn the remove option on

lock.exemptions:
- EXPLOSION
- GROWTH
- PISTON
- REDSTONE
- VILLAGER
- ENDERMAN
- ENDER_DRAGON
- WITHER
- ZOMBIE
- SILVERFISH

Listed events will not trigger a lock protection. For instance, if you put explosion into the list, the plugin will no longer protect locked blocks against explosion. Similar goes to growth (tree growth), piston (piston pushing/retracting), redstone (open door via redstone). The list above contains all available exempts.

lock.expire.days: <integer>

If non of the owners of the sign was online for the configured amount of days the lock will expire and get invalidated. Setting this to 0 will disable die expiration feature.

cache.seconds: <integer>

Experimental feature. This feature will cache a block's lock state. It can dramatically increase your server's performance. Recommended interval is 5~10 (unit is seconds).

bedrock-prefix: "."

If you have some kind of Waterfall enabled and allow bedrock players to join, this should match with the configurated prefix there.

lockables:
- CHEST
- TRAPPED_CHEST
- FURNACE
- ...

Controls which blocks are lockable. You should use internal Material name or Tag key. Allows for * for adding all blocks. Allows for prepending any Material / Tag with a minus (-) for removing it from the List of protected blocks.

    lockables:
    - *
    - -CHEST

Will lock anything but chests.