Skip to content

* config.yml

Yitong "Frank" Wu edited this page Nov 9, 2017 · 6 revisions

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.

language-file-name: 'lang.yml'

The language file that LockettePro will read from.

enable-quick-protect: <true/false/sneak>

This will change quick protect settings. A quick protect action is whenever a user right click a lockable block with a sign in his hand. Set to true to enable quick protect (while sneak + place sign will not protect the chest), set to sneak requires players to sneak in order to quick protect, set to false to disable.

block-interfere-placement: <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.

block-item-transfer-in: <true/false>
block-item-transfer-out: <true/false>

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

block-hopper-minecart: <true/false/remove>

This controls what happen when someone try to steal from a chest using a hopper minecart. Set to true will block item transferring, set to false will disable the protection, set to remove will remove the hopper minecart.

cache-time-seconds: <integer>

Experimental feature. This feature will cache a block's lock state while dealing with hopper item transfers (manually interfere with the lock will reset the cache). It will dramatically increase your server's performance only if you have a lot of active hoppers. Recommended interval is 5~10 (unit is seconds).

disable-explosion-protection: <true/false> 

If true, this will disable explosion protection from TNT. Useful in factions raiding?

private-signs:
- '[Private]'
- '[private]'
additional-signs:
- '[More Users]'
- '[more users]'

Those controls what sign format will become a lock sign or additional user sign. The first one in the list will become the default string that would be used in quick protect.

everyone-signs:
- '[Everyone]'
- '[everyone]'

Controls what sign line could grant all user permission to use the block. REMOVE THIS WHOLE ENTRY IF YOU WANT TO DISABLE THIS FEATURE.

timer-signs:
- '[Timer:@]'
- '[timer:@]'

If a door has a line stated above, where @ is an integer, the door will close automatically after @ seconds. REMOVE THIS WHOLE ENTRY IF YOU WANT TO DISABLE THIS FEATURE.

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

Controls which blocks are lockable. You should use internal block name or legacy block id.

protection-exempt:
- explosion
- growth
- piston
- redstone
- villager
- enderman

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 are available exempts.