[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

Discussion in 'Inactive/Unsupported Plugins' started by Acru, Feb 14, 2011.

  1. Offline


    Lockette - The sign-based container and door lock for Bukkit! - by Acru Jovian

    ElgarL has been assigned as the current maintainer of this project, please forward any important issues to him as well. This post is abandoned, but proceed to BukkitDev for updates.

    Download it at BukkitDev! (Alternate) (JAR) (Source), also view the Change Log on BukkitDev.

    Supported external plugins:
    • Permissions - Permissions/Groups
    • GroupManager - Permissions/Groups
    • PermissionsBukkit - SuperPerms/Groups
    • PermissionsEx - SuperPerms/Groups
    • bPermissions- SuperPerms/Groups
    • Towny - Groups/Zones
    • SimpleClans - Groups
    • mcMMO - Groups (Disabled by default now, due to issues.)
    • Factions - Groups
    • LWC - Zones
    • Register - Economy
    Alternate languages included:
    Confirmed compatible plugins: ColorSign, SpeedSign.
    Conflicting plugins: ChestShop, Most sign editors!

    The active Lockette information page will commute to BukkitDev soon, but the forum thread is still the best place for discussion.


    The purpose of this plugin is to restrict access to the contents of chests, dispensers, furnaces, and doors without the use of a database to track containers.

    To use, simply place a signpost on the floor directly beside a chest or other container to be locked. Enter [Private] as the first line. Your own name will automatically be entered on line 2 as the chest owner. Optionally type in the full names of two other users allowed to access the chest's inventory on lines 3 and 4.

    When done correctly, the sign will automatically fix itself to the side the target chest, protecting it from unauthorized access! Only the chest's owner can then break the sign or chest. (Warning: Anyone with permission to use WorldEdit commands or similar can circumvent the protection by removing the sign.)


    Additionally, you can enter [Everyone] on lines 3 or 4 instead of a user name to allow everyone access to the contents of a private container, or [Operators] to allow ops access. If a Permissions plugin is available, you can use groups like [Moderator] or [Admins] or others as defined in the Permissions settings files.

    The owner of a container can add more users by placing additional signs beside the container with the heading [More Users], where lines 2-4 specify the names of the additional users. You can edit the users on previously placed signs by right clicking the sign, and using the command '/lockette <line number> <text>' to change it.

    Working with Doors:

    To protect a door, you can use the same method as protecting a container, the sign will attach to the door automatically. In addition, you can attach a [Private] wall sign to any side of the blocks just above or just below a door. For double doors only one side needs a sign. Door support is enabled by default in the config file.

    Once a door is protected it will only open for someone listed as a user, and will not respond to redstone power or switches unless [Everyone] is listed as a user. Iron doors which usually won't open from clicking will work just as wooden doors. In addition, double doors will open together automatically!

    You can also use [More Users] signs as with containers, with the caveat that the sign cannot be placed on the block above the door if the [Private] sign is not above the door as well! (This is done to prevent a security uncertainty issue.)

    Protected doors will be closed automatically if a timer is set. A timer can be set globally with a configuration option, or individually for each door by using the tag [Timer: #] on line 3 or 4 of the [Private] sign, where # is the number of seconds that the door should remain open. If the timer is set to 0, this means the door will never automatically close. If no timer is specified, protected doors will use a global timer set in the configuration file. If the server is shut down cleanly any open doors will be closed, but in the event of a server crash while a door is open, it may remain so. Note that the initial state of a door is assumed to be closed.

    Care must me taken to place protected doors on a stable block. Building a door on sand, gravel, leaves, TNT and et cetera are allowed by the plugin, but cannot be secured fully. :3 Additionally, it should be noted that most status messages still refer to locked blocks as containers, so for the purpose of simplicity, doors should be considered as a type of container.

    • No passwords or databases needed!
    • Permission checks run in constant time, no matter how many protected containers.
      • One owner and up to 11 additional users supported. (17 for double chests!)
      • Allows access to [Everyone] while still protecting the container from vandalism.
      • Allows group names in conjunction with many other plugins.
    • Special powers for ops or admins, configurable with permissions.
      • Reports when an admin does something naughty.
    • Protects single and double chests, dispensers, and furnaces.
      • Explosion and block-break protection for the protected container and sign.
        • Option to protect all containers from explosions.
    • Full support for doors, both wooden and iron!
      • Double doors are handled automatically, with no redstone.
      • Doors can be set to close automatically, via a timer setting.
      • Redstone hacking is disabled for protected doors.
    • Prevents creation of chests larger than 2 blocks.
    • Informative or helpful messages when interacting with containers.
      • The first time a chest is placed, a help message will be shown.
      • Types of messages shown are configurable in settings.
      • Additional language support.

    Advanced Setup (Permissions) (open)

    Advanced Setup:
    There are a few things you can now customize in the configuration files for the plugin, found in the plugins/Lockette folder. After running the plugin for the first time, two files will be created, config.yml and strings.yml. The first holds the following settings:
    • enable-permissions - Allows the use of permission nodes to specify who can do what. If this is disabled, groups will still be used but admin status is taken from the ops file. Defaults to false.
    • enable-messages-* - Enables or disables groups of messages listed in the strings.yml file. Not counting the broadcast ones.
    • broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.
    • explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    • allow-admin-bypass - Allows admins to go though any protected door. Default is true.
    • allow-admin-snoop - Allows admins to peek into chests owned by other people. Default is false, and this setting is recommended! A broadcast message will be sent each time an admin snoops in a protected container where the admin doesn't have permission to. The message will be sent to a player or group as specified in another option. Admins can still break protection on chests if this is disabled, however.
    • enable-protection-doors - Enables support for private doors, defaults to true.
    • default-door-timer - Sets the door closing timer for all protected doors on the server, unless overridden by a specific sign. Defaults to 0, which disables the door closing timer.
    In the strings.yml file, you can set alternate language tags for [Private] and such, in ANSI format. If you need characters not in ANSI then you might try UTF-8 format, though it seems bugged tight now. The default alternate tags are in French, but server ops are free to translate the whole file into the language of their choice. If you do this, please share it back to me~ :3 If you want to disable only a specific message, you can set it to "", the empty string. Admins can use the command '/lockette reload' after editing the configuration files, to reload them.

    If a Permissions plugin is not available or the enable-permissions option is set to false, Lockette will use the ops file to determine who are admins. Admins can break the protection on any chest, and look inside protected chests (only if the related option is set), as well as reload the plugins configuration files. All non-ops will be able to create protected containers for themselves.

    If a Permissions plugin is available and the enable-permissions option is set to true, the following nodes will be used instead of the ops file and are included by default in the '*' node:
    • lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door. (The permission lockette.create.all is still supported, but obsolete.)
    • lockette.admin.create.* - Allows admins to create containers and doors for other users. Possible sub-nodes include chest, dispenser, furnace, and door. Leave line 2 blank for the default behavior or enter the name of your choice. Capitalization matters.
    • lockette.admin.break - Allows breaking protection on containers.
    • lockette.admin.bypass - Allows opening of any locked door.
    • lockette.admin.snoop - Allows peeking in protected containers. (The setting allow-admin-snoop must be true.)
    • lockette.admin.reload - Allows use of the reload command.

    Technical Information (open)

    Technical Information:

    This plugin has been tested and shown to be working for many builds of CraftBucket though a number of the more recent builds had a serious issue, so I'm suggesting a minimum build of 561 now. If you update past what is listed in the post's title and the plugin seems to break, it is probably not my fault. Post a note anyway and I'll see about fixing. I'll try and keep up with the new recommended build system, but for latest builds that break things, you should expect some time to pass before I take care of the issue, as this plugin is now mature. :3

    If there are multiple containers by the placed sign, the plugin will use the NESW rule to choose the first container that is not yet private. To elaborate, the plugin will check to the north of the sign first, and if no container or door is available to the north, it will continue checking clockwise around the sign.

    Due to the current implementation of the explosion event, this plugin will cancel all explosions that would damage the container or sign, rather than just remove the container and sign from the blocks to be damaged. Canceled explosions still knock signs off the walls. Canceled explosions leave signs looking blank, but this is just a graphic glitch, reconnect to fix.

    Bonus: This plugin will prevent chests bigger than 2 blocks from being created via glitches. (Again, this could be circumvented using WorldEdit commands, so take care who has access to such a plugin.)

    This plugin was inspired by the old hmod plugins Lock by Roman "kingseta" Pramberger and ChestCapsule by Fernando "Fergo".

    Hooking into Lockette (open)

    Hooking into Lockette:

    If you are a plugin author and want to connect to Lockette, you can use a public static function to get information about the protected status of a block.

    More info later, perhaps, but if you need the details now then go poke through the source~

    Future Possibilities:

    There are a number of things that have been suggested, and they tend to be added to the list below if I think they might be a good idea. However, some sort of locked container limit is requested often but this is not possible without a database to track the number of locked containers someone has. All things considered, this will not be supported. On the up side, without a database you can have literally millions of locked containers without any sort of lag, and there are permissions to restrict who can create locked chests. Perhaps only allow Moderators to create locked chests for other users, if you don't want to allow infinite locked chests.

    Aside what has already been implemented, the following may or may not appear in future versions:
    • Furnace/dispenser clusters, protected by a single sign.
    • [Log] sign to list recent users of a container or door.
    • iConomy fee for protecting containers/doors.
    • Worldguard connection.
    • [Protected] tag for viewing only.
    • Specific time range that doors can be opened.
    • DataLog plugin support.
    • More types of protected blocks, such as brewing stands.
    If you want any of the above features sooner than never, let me know! However, I currently see Lockette as functionally complete, for the most part, in that it already has all the functionality it needs. Future updates will mostly be to account for changes in Minecraft and Bukkit.

    Final Note:

    Please leave a reply if there are any bugs or suggestions, and if you like this plugin you can click the like button at the bottom of this post~ Thanks to those few that have donated! [​IMG]
  2. Offline


    Eloston I'm not seeing any issues with timed doors, single or double, default timer or manually-set timer. Lockette v1.6, CB2127
    nunber1_Master if you are experiencing issues with timers, please post information so that the problem can be reproduced.

    I have noticed an issue with double doors that can happen after importing the door with WorldEdit or MCEdit. But reapplying the sign fixes the problem.
  3. Offline


    I updated my server today, and al the double doors were messed up :s
    Some of them were pointed at the same direction so they were like 2single doors next to each other and some just moved half block back. So i started to delete them and replace them. for my own doors it works but whenever i want to delete someone elses door it says that i can't break a container from that person :(
    i didn't enabled the permissions and i'm OP so why can't i break it? also when i enable the perms and give myself evere lockette node it doesn't work. :(

    help would be appriecated very much.
    hope you understand my sort of english talking :p
  4. Offline


    arnii5 break the sign protecting the door first (make sure to notice the names on the sign!). Then you can fix the misplaced door and re-protect it.
  5. Offline


    I'm not having issue, theres just an interact error. It doesn't affect me :)
  6. Offline


    I'm having issues locking a quadruple fence gate setup, with 2 on top of each other and next to each other. It seems that the 1 sign does in fact recognize all 4 doors, however if the top left door is opened, the 2 on the right side also open, but the bottom left does not. If top right is opened, 2 bottom doors open and the top left does not. It seems to go in a clockwise motion, however stops after just the first 3 doors. I could just use regular doors I guess, but at least heres something to think about :) Server is 1.2.4, whether or not the admin has updated to latest version of your plugin I have no idea, if it's something you have fixed ignore me :p
  7. Offline


    thanks, i'll try it now! I'm sure it will work ;)
    you are really fast to support your plugin users! :D
    keep up the good work ;)
  8. Hello, I uploaded to youtube a video tutorial helpful for Spanish users. This way you canprevent people do absurd questions.

    Take a look, tell me if you like and if so you can put in bukkit dev

  9. Offline


    The door problem doesn't happen right away. At the beginning, it will be fine. But after a couple hours or so, the door timers will fail to work.
  10. Offline


    I have a request to make!

    Adding [InOnly] instead of [Private] OR any line under the [Private] tag will allow people to open it but it will show as empty. When they put something inside it will automatically be added to the chest and dissapear for the user, giving the message that [item] was successfully placed in the chest. If the chest is full it pops the item back into the inventory with a Chest Full message. It can only be retrieved by any name on the container. I wanna use it for mailboxes.
  11. Offline


    Roadcrosser of course it is up to Acru to decide where he wants to take Lockette, but I can tell you not to get your hopes up. The modifications your request would require are far outside of the current scope of this plugin, which currently does not interact with player or container inventories at all. Your best bet would be to strike up a conversation with a dev that works with "shop" chests.
  12. Offline


    If this isn't already feasible, can you make it so that lockette allows plugins like hawkeye or logblock to log the placing of signs on chests?
  13. Offline


    teaearlgraycold LogBlock does. Just look for signs where the the first line is "[Private]"
  14. Offline


    Is the plugin compatible with Minecraft 1.2.5?
  15. Offline


    c0de_junkie likes this.
  16. Offline


    Latest CB 1.2.5R1 Latest lockette 1.6
    2012-04-05 01:24:28 [SEVERE] Could not pass event PlayerInteractEvent to Lockette
    at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:303)
    at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:62)
    at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:459)
    at org.bukkit.craftbukkit.event.CraftEventFactory.callPlayerInteractEvent(CraftEventFactory.java:176)
    at net.minecraft.server.ItemInWorldManager.interact(ItemInWorldManager.java:287)
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:636)
    at lishid.orebfuscator.hook.NetServerHandlerProxy.a(NetServerHandlerProxy.java:96)
    at net.minecraft.server.Packet15Place.handle(SourceFile:39)
    at net.minecraft.server.NetworkManager.b(NetworkManager.java:229)
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:113)
    at lishid.orebfuscator.hook.NetServerHandlerProxy.a(NetServerHandlerProxy.java:60)
    at net.minecraft.server.NetworkListenThread.a(NetworkListenThread.java:78)
    at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:551)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:449)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:492)
    Caused by: java.lang.IncompatibleClassChangeError: Expected static method com.gmail.nossr50.mcMMO.getPlayerProfile(Lorg/bukkit/entity/Player;)Lcom/gmail/nossr50/datatypes/PlayerProfile;
    at org.yi.acru.bukkit.PluginCore.inGroup(PluginCore.java:548)
    at org.yi.acru.bukkit.PluginCore.inGroup(PluginCore.java:454)
    at org.yi.acru.bukkit.Lockette.LockettePlayerListener.canInteract(LockettePlayerListener.java:495)
    at org.yi.acru.bukkit.Lockette.LockettePlayerListener.interactDoor(LockettePlayerListener.java:328)
    at org.yi.acru.bukkit.Lockette.LockettePlayerListener.onPlayerInteract(LockettePlayerListener.java:199)
    at sun.reflect.GeneratedMethodAccessor89.invoke(Unknown Source)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
    at java.lang.reflect.Method.invoke(Unknown Source)
    at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:301)
    ... 14 more
  17. Offline


    Well I'm actually using hawkeye right now. Is this something I should ask the developer of Hawkeye about? I doubt he/she would add this, though, because of the development of Guardian right now.
  18. Offline


    teaearlgraycold he already records sign places and breaks. He just needs to record sign text, too. Doesn't hurt to ask.
  19. Offline



    I have installed this plugin, and as a Owner with all permissions i thought that i could open all chests but i could not do that. So my question is, what can i do so i can open all chests?


    Sorry for my bad english.
  20. Offline


    XCroft it sounds like you need to set allow-admin-snoop in your configuration. Check the original post's Advanced Setup(permissions) for more settings and information.
  21. Offline


    It works now thx! :)
  22. ChestShop works with this.
    I just checked.
    So yeah.
  23. Offline


    You should add a "group-privacy" like
    So only admins can use the container :) great plugin btw, love it!
  24. Offline


    Raggarcowboy just put [Admin] on the third line like this:

    Then only you and other admins can open the container or door. Take a look at the 4th paragraph in the Overview in the original post, above.
  25. Offline


    Running CraftBukkit 1.2.5 R1 and NukerNL's Lockette 1.6
    This spits out when I right-click on a door/container. This does not happen on my own doors. My doors function correctly, but the ones that aren't mine don't work. Iron doors won't open, and gate timers don't work.
    16:57:59 [SEVERE] Could not pass event PlayerInteractEvent to Lockette
            at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.ja
            at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.jav
            at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.j
            at org.bukkit.craftbukkit.event.CraftEventFactory.callPlayerInteractEven
            at net.minecraft.server.ItemInWorldManager.interact(ItemInWorldManager.j
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:636)
            at net.minecraft.server.Packet15Place.handle(SourceFile:39)
            at net.minecraft.server.NetworkManager.b(NetworkManager.java:229)
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:113)
            at net.minecraft.server.NetworkListenThread.a(NetworkListenThread.java:7
            at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:551)
            at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:449)
            at net.minecraft.server.ThreadServerApplication.run(SourceFile:492)
    Caused by: java.lang.IncompatibleClassChangeError: Expected static method com.gm
            at org.yi.acru.bukkit.PluginCore.inGroup(PluginCore.java:548)
            at org.yi.acru.bukkit.PluginCore.inGroup(PluginCore.java:454)
            at org.yi.acru.bukkit.Lockette.LockettePlayerListener.canInteract(Locket
            at org.yi.acru.bukkit.Lockette.LockettePlayerListener.interactDoor(Locke
            at org.yi.acru.bukkit.Lockette.LockettePlayerListener.onPlayerInteract(L
            at sun.reflect.GeneratedMethodAccessor17.invoke(Unknown Source)
            at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
            at java.lang.reflect.Method.invoke(Unknown Source)
            at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.ja
  26. Offline


    Eloston I setup double iron doors with two names (other players) and a timer. Both doors opened normally and then shut according to the timer. No errors.

    CB 2148, Lockette 1.6, mcMMO not installed. I'm pretty sure I've seen some other mcMMO users having issues. Have you posted anything with the mcMMO people to see if it is on their end? Or maybe they could start a convo with Acru and get to the cause of the matter.
  27. Offline


    Indeed, there was a fix mentioned in this post.
  28. Offline


    khamseen_air As I have stated in my previous post, I am already using that fix.
    There could be a possibility the fix no longer applies in the newer versions of mcMMO.
    I'll try to contact the mcMMO people and see what they can do. Otherwise I'll ask Acru if he can fix it.
    Edit: Strangely, all wooden doors work. Only iron and fence gates seem to be broken.
  29. Offline


    Hey . I think This Plugin is Awesome ! Using it on my own server .
    i want to suggest something ,
    Try to put Private on brewing stand !
    That will be great !
  30. Offline


  31. Offline


    Yeah, I was more meaning that since there was a fix related to mcMMO before, chances are it's something they need to fix, not Acru. So it's best to tell them. :)

Share This Page