Bug reports:..............................https://github.com/rutgerkok/BlockLocker/issues or use the discussion thread
- Native Minecraft Version:
- Tested Minecraft Versions:
- Source Code:
- happyvalley-lmx, ibmibmibm, james090500, jensvh, Jo0001, Ghost-chu, Kervinou, Nestu14, stan60250, TheBusyBiscuit, TheCiROMG, WMGameLive, 2125368097
- Languages Supported:
- Chinese (traditional and simplified), Dutch, French, German, Spanish
This plugin allows you to protect chests, doors, furnaces, dispensers, droppers, hoppers and many other blocks simply using signs. Once a sign is attached, only people listed on the sign can access the container. It uses no databases, all information is stored on sign attached to the protected block. So if you use WorldEdit to move a chest, the chest will still be protected.
The plugin can be used as a replacement for LockettePro. Existing protections will look a bit funny at first (the UUID on the sign is not hidden, as BlockLocker does not include a protocol hack), but once you interact with the protection it will be updated to look normal again. This is because BlockLocker stores the UUID on a "hover text", which is hidden automatically by the Minecraft client.
Video created by ServerMiner
Another video, by TheCiROMG, in Spanish:
- Protect chest, doors, etc. simply by attaching a sign.
- Doesn't need a database, the plugin just looks for attached signs.
- Allow other players to access your protection.
- Allow groups to access your protection.
- Groups are defined using permission nodes, scoreboard teams, or using supported plugins like Factions and Towny.
- UUID support
- Players can change their names without losing access to their protected blocks.
- Stores UUIDs on signs in a hidden text component, so UUIDs are saved between server restarts.
- Supports double doors and double chests (double trapped chests too): you only need one sign to protect both blocks.
- Shows a message to players placing a chest, so that they know chests can be protected.
- Automatically closes doors when a [Timer:X] tag is added, or when a default door close time has been specified in the config file.
- Automatically let protections expire if the owner hasn't logged in for X numbers of days. (Disabled by default.)
- Redstone support
- Redstone contraptions cannot open protected doors, unless a [Redstone] tag is added.
- Hoppers (minecart hoppers too!) cannot take or put items, unless a [Redstone] tag is added.
- Update notifications
- Server owners get notified when there is a BlockLocker update available.
- The update checker works asynchronously, it will never block the server.
- The update checker can of course be toggled off.
- Add extra blocks, for example TNT, levers or note blocks.
- You can set that "attachable" blocks like levers can be protected by attaching a sign on the block the lever is attached on (no need to put signs on the lever itself!)
- All messages can be translated.
- Reload config files while the server is running using /blocklocker reload
For containers (chests, furnaces, dispensers, etc.) it's easy: just place a sign against the block. BlockLocker will automatically add [Private] to the first line and your name to the second.
You can also place a sign while sneaking, this allows you to add some text to the third and fourth lines. You then need to write[Private] yourself on the first line. You can leave the second line empty, your name will automatically be placed here.
For doors, place a sign with [Private] on the first line against the block above the door. Placing a sign on the block below the door or even on the door itself works too, but looks less nice.
Trapdoors can be protected by placing a sign with [Private] on the first line against the block the trapdoor is attached to.
Right-click the sign and type /blocklocker <line number> <text> to replace the text on the given line. You can shorten this to /bl <line number> <text>.
Adding people to the sign
On the third and fourth row of the sign with [Private] you can add the names of up to two friends who may also access the chest. Want to add more people? Place a second sign against the chest. BlockLocker will add [More Users] to the first line and [Everyone] to the second line. If you want to change this, right-click the sign to edit it.
If the name of the person you're adding doesn't fit on the sign, just type as many characters as possible. If the person you're adding is currently online, BlockLocker will be able to complete the name.
If no Minecraft account exists with the name, a ~ is added before the name. However, the ~ is not added for things that don't look like an username, so --text-- won't be changed to ~--text--. This should still give you plenty of options to decorate the sign, while it will still be obvious when name is not a valid Minecraft name.
The tag [Everyone] grants everyone access to the protection. The tag [Redstone] grants hoppers access to the container, and allows redstone signal to open doors.
There's also a [Timer:X] tag, where X is a number from 0 to 9. Doors (trapdoors too) will close automatically after the specified amount of seconds. Use 0 to never close the door automatically. The timer tag overrides the default close timer setting the config.yml.
You can also add [MyGroup], which will grant all members of the group MyGroup access to the chest. See "Group support" below for what groups are supported.
Finally, you can also add +MyGroup+, which allows only the group leaders to access the sign. See again "Group support" below for more information.
There's a very simple permission structure:
- blocklocker.protect - create new protections
- blocklocker.bypass - bypass all protections, edit all protections
- blocklocker.reload - use /bl reload to reload the configuration files
- blocklocker.group.groupName - adds you to the group with the name groupName, so that you have access to protections with a [groupName] tag on it.
- blocklocker.wilderness - place chests outside Towny towns. Granted by default, so use your permissions plugin to negate this permissions if you don't want people to place chests in the wilderness. Has no effect if Towny is not installed.
- /blocklocker <line number> <text> - places the specified text on the last sign you selected (right-clicked). You can only select signs on your own protections, unless you have the permission node blocklocker.bypass.
- /blocklocker reload - reloads configuration files. Requires the permission node blocklocker.reload
You can change what block types can be protected, you can set a default close timer for doors and you can set whether one sign protects a whole row of containers, or only the current container.
The file plugins/BlockLocker/config.yml contains explanations of all settings, I won't repeat them here. Just open the file!
When you have made a change, run the command /bl reload for your settings to take effect. You can of course also restart the server.
By default, the plugin displays all messages in English. To change them to another language, open the plugins/BlockLocker/config.yml file and change the setting languageFile to one of the following:
In the same folder as the configuration file, you can find the translation file. You can edit this file to customize the translations. You can even edit the tags like [Private], [More Users], etc. Multiple values are allowed, here for example
- Any other language, but you'll have to translate everything yourself from English. It would be appreciated if you share those translations with me, so that I can include them in the plugin.
private: ['[Private]', '[Privé]'] makes both [Private] and [Privé] work for protecting signs.
When placing [MyGroup] on a sign, every member of MyGroup will have access to the protection. The plugin considers the following persons to be a member of the group MyGroup:
- People with the permission node blocklocker.group.mygroup. The permission node is always blocklocker.group. with the lowercase group name appended to it.
- People in the scoreboard team MyGroup (case insensitive). You can modify scoreboard teams using the (vanilla) command /scoreboard.
- When MassiveCraft Factions is installed: people in the faction called MyGroup (case insensitive).
- When Towny is installed: people in a town or nation called MyGroup (case insensitive).
- When mcMMO is installed: people in a party called MyGroup (case insensitive)
- When Guilds is installed: people in a guild called MyGroup.
- When SimpleClans is installed: people in a clan called MyGroup.
When placing +MyGroup+ on the sign, only the leaders of MyGroup will have access. Those are:
- When Towny is installed: mayors and assitants of Towny towns and nations called MyGroup will have access.
- When mcMMO is installed: the party leader.
- When Guilds is installed: the guild master.
- When SimpleClans is installed: the clan leader.
Other group systems are currently not supported. If you want support for another plugin, just ask me.
As this is an anti-stealing plugin, bugs can have a large impact on the economy of your server. For that reason, the plugin notifies you of any updates. As of version 1.7, the plugin will not download any files anymore, making the AUTO_INSTALL setting equal to JUST_NOTIFY. The updater works asynchronously: it will never pause your server while it's checking for something.
If you want to disable the updater you must edit the plugins/BlockLocker/config.yml file. Set the updater setting in the file to DISABLED or JUST_NOTIFY. If you don't see the update setting in the file it is because you have a pre-1.0 config file. Simply add updater: DISABLED or updater: JUST_NOTIFY to a new line and you'll be fine.
BlockLocker has been built with UUID support in mind. If you put a name on a sign, then the plugin will automatically look up the UUID of the player, and store that on the sign in a way that's invisible for players. For the technical people: it uses Bukkit's PersistentDataHolder API.
When your server is running in offline mode and not behind a BungeeCord proxy, the plugin won't use UUIDs and will simply only use names.
When UUIDs are used, the plugin accesses api.mojang.com every now and then to look up UUIDs of offline players added to a sign.
If you have found a bug, please report it! You can report it here in in the forum thread, or on Github. Please provide instructions for me how I can reproduce the bug. Please do not file bug reports in the review tab, as (a) bug reports aren't reviews and (b) the review section doesn't allow any interaction: you cannot reply there to any questions that I ask, so tracking down a bug is impossible.
Frequently asked questions (FAQ)
Can you add this feature?
I'm still maintaining this plugin, but I've decided to no longer add features myself that I'm not personally interested in. If you would like a new feature, code it yourself! (Or ask someone else to code it for you.) Once you're done, a pull request on Github would be very much appreciated!
Some features that would be nice:
Some features that wouldn't work:
- A permission node to allow people to view chests, but not to modify the contents of the chest.
- Some way to let players add items to a certain chest, but not remove them.
How do I change the color scheme of messages, [Private] and [More Users]?
- A shop function to buy items from chests. This will quickly grow out of hand. It's better to code this as a separate plugin. For example, ChestShop (as of version 3.12) integrates with BlockLocker so that you can buy and sell items from your protected chests. This integration is possible because BlockLocker offers a simple API for other plugin authors to check if a chest is protected.
- A command that shows all your protected chests. This would require keeping a database of all chests. Right now, all information is stored on the signs. Using a database would mean that copying chests to/from schematic files and moving them around with WorldEdit would no longer work correctly.
- Limiting the number of chests of a player. This would also require keeping a database of all chests.
Open plugins/BlockLocker/translations-en.yml (if you're using another language, open up that file instead) and add/remove color codes. For example private: "&9[Private]" results in a blue [Private] tag. You can make it as advanced as you like, see for example this website that generates color gradients.
Hoppers cannot put items into/take items from protected chests. How can I fix this?
Add a line with the text [Redstone] or [Everyone] to the sign.
Hoppers can put items into/take items from protected chests. How can I fix this?
This isn't caused by BlockLocker, but it's caused by setting hopper.disable-move-event to true in your paper.yml file. If this is set to true, then plugins cannot react to item movement in hoppers anymore. So you need to set this to true, there is no other workaround.
How can I disable the message that tells players how they can protect a chest?
Open the plugins/BlockLocker/translation-en.yml file (if you're using another language, open up that file instead) and set the protection.chest_hint setting to two quotes: "". The configuration file uses the YAML format, and those two quotes mean that the message is empty.
Are old Minecraft versions supported?
Nope. For older Minecraft versions, please download an older release of BlockLocker.
Minecraft 1.14.4 to 1.17: use latest version
Minecraft 1.14.0 to 1.14.3: use BlockLocker 1.6
Minecraft 1.13: use BlockLocker 1.5
Minecraft 1.12: use BlockLocker 1.3.4
Minecraft 1.9 to 1.11: use BlockLocker 1.3.3
Minecraft 1.8: use BlockLocker 126.96.36.199
Even older: BlockLocker didn't exist yet
I removed all doors/containers/attachables and ended up with an empty list. However, this doens't seem to have any effect. What can I do?
YAML (the configuration file format used by most Spigot plugins) only accepts empty lists if you use a special format with a [ and a ]. Like this:
What are the differences between this plugin and LockettePro?
This plugin uses no code from LockettePro. It was written from scratch. I have listed the major differences here, but there are many more smaller differences.
Both LockettePro and BlockLocker store the UUID of players on the sign, which is a good thing: the UUID data cannot get lost, even when you are using WorldEdit to move a sign. LockettePro stores UUIDs of players in the sign text as Name#UUID, so for example Notch#069a79f4-44e9-4726-a5be-fca90e38aaf5. It uses a protocol hack to hide the UUID. For this, the plugin requires ProtocolLib. BlockLocker stores the UUID in a hover text on the sign. Unlike for chat messages, signs never display their hover text, even if your mouse cursor is on the sign. Therefore, no protocol hack was needed to hide the UUID of players: Minecraft already hides this text.
LockettePro currently supports Vault groups, which BlockLocker doesn't. Instead, BlockLocker supports groups based on permission nodes: if you for example grant someone the permission node blocklocker.group.myexample, then that player will belong to the group MyExample (case insensitive). Note that groups from Towny, SimpleClans and MassiveCraft Factions are supported in both plugins.
LockettePro has only rudimentary redstone support. You have to add [Everyone] to your door for redstone to work. In BlockLocker [Everyone] still works, but you can also add a [Redstone] tag instead.
Hoppers are not well supported in LockettePro: either they never take items from protected containers, or always, depending on a configuration setting. BlockLocker allows you to add a [Redstone] tag to allow hoppers. When no [Redstone] (or [Everyone]) tag is added, hoppers won't be able to place or take items from the container.
What are the differences between this plugin and the classic Lockette?
This plugin uses no code from Lockette. It was written from scratch. I have listed the major differences here, but there are many more smaller differences.
Lockette has no real UUID support: it just looks up your old names. (UUIDs are cached as Bukkit metadata, but not saved, so they are lost when the server restarts.) BlockLocker uses Bukkit PersitentDataHolder, which means that the data is stored safely inside the chunk and that editors like WorldEdit won't delete the UUID data.
Lockette has only rudimentary redstone support. You have to add [Everyone] to your door for redstone to work. In BlockLocker [Everyone] still works, but you can also add a [Redstone] tag instead.
Hoppers are not well supported in Lockette: either they never take items from protected containers, or always, depending on a configuration setting. BlockLocker allows you to add a [Redstone] tag to allow hoppers. When no [Redstone] (or [Everyone]) tag is added, hoppers won't be able to place or take items from the container.
Placing signs works a little different. In both plugins you can attach a sign to a container simply by right-clicking the container with a sign in your hand. The sign will be filled with [Private] on the first line and your name on the second line. In Lockette you can also place a sign next to a container. You have to manually type [Private] on the first line. Lockette will then move the sign so that it is attached to the chest. I find this behaviour not very useful, so it is not included in BlockLocker. For those cases where you want to add something to the third or fourth line of the sign, you can either edit the sign after placing it, or you can place the sign while sneaking, allowing you manually edit the sign.
I have another question.
Please ask! The best place is here in the discussion thread. You can also send me a PM, but keep in mind that others won't be able to benefit from any solution you found.
Protect chests, doors, etc. using signs. UUID compatible.