[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


    HoodedxSaints likes this.
  3. Offline


    Okay, I've tried using it on a dispenser, but it's saying "Lockette: No unclaimed container nearby to make Private!" Working fine on chests and furnaces. My furnace is one block above the level I'm placing the sign and has blocks around it on all sides, but the front side. Also naming a chest [Everyone] doesn't appear to work for me either.

    Also maybe this could work on craftbenches if you're feeling selfish? :)
    And I agree with the doors one.
  4. Offline


    Do you mean your dispenser is one block above? You can put a temporary block down in front so the sign is on the same level. Dispensers can fire through signs fine, so no worries about blocking the hole. Oh, the sign can't be diagonal from the dispenser too, it has to be on a side of it, maybe that is the issue?

    For [Everyone] to work, it should be on the 3rd or 4th line, so you have on the sign:
    <Your name entered automatically>

    More details about your setup would help, if the above doesn't work. What version of craftbukkit? Dispensers work fine for me in all tests, under version 323~ :3

    Craft benches don't have a static inventory, and are easy to make, so probably no point? Hehe~
    And a vote for doors noted~
    HoodedxSaints likes this.
  5. Offline


    Well here's the dispenser:


    And as for community chests I tried entering





    but still only I can access it.

    I just installed craftbukkit today from the wiki page, so it should be the latest release. Hmm...
  6. Offline


    Ok, yes, you need to put the sign right on the dispenser. To do this put a block infront and below the dispenser, and put the sign on that block. The sign will fix itself over the hole but won't block it. (You can also put the sign on the side or rear of the dispenser. It needs to touch it.)


    Second, I see the problem, [Everyone] with a capital E, I didn't make it case insensitive there, I'll fix in next update. Which will only take a minute.

    Edit: Done
    HoodedxSaints likes this.
  7. Offline


    Regardless the ability to have an amount of limited protected chests I will still be using this plugin. Forget about vaults I love the way this plugin functions :D
  8. Offline


    1) Needs permissions support, this way mod/admin can have override to check peeps shit
    2) Needs a fast way of doing this, group support would be ideal. we have 180 people on our server
  9. Offline


    I agree for #1 feature but I don't care for groups since my server everyone is the same :p
    --- merged: Feb 16, 2011 11:49 AM ---
    Just tested it and seams the issue that we had is gone away :) Good job!
  10. Offline


    This a great, easy plugin for chest protection.
  11. Offline


    i put plugin into plugin folder as anothers, but not work, i try make sign but he dont merge with chest. i wright [private] on 1 line.
    plugin have properties file?
  12. Offline


  13. Offline


    I hope not though I did request to the author if they have time if they could do this:

    To many Icon related plugins and more messy code. I love to see more light weight products for the bigger servers :)

    I really love Acru mod and hope someday he considers a stab at making a shop one.
  14. Offline


    What permissions plugin are you using for admins/mods/usergroups? I'm not sure which ones are popular.
    --- merged: Feb 16, 2011 9:03 PM ---
    Thanks for the positive feedback. :3
    --- merged: Feb 16, 2011 9:11 PM ---
    First check that it says 'Lockette version x.x is enabled!' in the console when you start the server. If not, make sure 'Lockette.jar' is in the plugins folder and not a subfolder.

    If Lockette is enabled properly, make sure the signs you place are directly adjasent to the container to be protected. That is, the sign should be directly beside the container to the north, south, east, or west. (Not above or below.)

    If this doesn't help, I'll need more information. This plugin currently has no properties file.
    --- merged: Feb 16, 2011 9:18 PM ---
    I don't see why it wouldn't work to protect your chest, but still allow shopping, though you'll have to check compatibility yourself for now. As time goes on I'll have a chance to try different configurations on my private server, but there are too many other plugins out there to do it all myself. :3
  15. Offline


    We have this installed in the Plugins directory
    and can not get it to work,

    here is the server log section

    SEVERE: SIGN_CHANGE (Is it up to date?)
    java.lang.NoSuchFieldError: SIGN_CHANGE

    any insite on this would be great...

    our server should be the latest as we downloaded it from bukkit...

    any other information i can provide just let me know..
  16. Offline


    It sounds as if you are running an older version of bukkit, prior to the support of SIGN_CHANGE event.
    It looks like the bamboo site for bukkit is down today as well, so I can't check what is current.

    Incidentally, I still need to update the namespace for my plugin, as they are blocking *.bukkit
    --- merged: Feb 16, 2011 11:22 PM ---
    Ok, I've updated the plugin once more, just to be ready for the namespace block, and http://bamboo.lukegb.com/ is up again.

    It looks like the 330-332 builds failed, and the artifact for 333 is currently unreachable, so guess we will have to wait for them to sort things out further...

    Edit: As of this moment, build 328 is here and it worked fine, however:
  17. Offline


    I am also getting the
    SEVERE: SIGN_CHANGE (Is it up to date?)
    java.lang.NoSuchFieldError: SIGN_CHANGE

    error. Please update us as soon as it works :D Thanks for the great plugin!
  18. Offline


    Do you know what build of craftbukkit you are using?
    Try using the console command /version, though it doesn't give a build number it might help identify.
    Also, at what point was the error generated? When you started the server, when you clicked done on the sign? Etc.
    What other plugins are you using?

    The more info I have, the easier it will be to track down the cause of the error.
    --- merged: Feb 17, 2011 4:16 AM ---

    I tried Lockette 1.1.2 with the supported Craftbukkit versions 323, 325, 326, 327, 328, 334, and 335, but was unable to generate the error.
    With Craftbukkit 311-318, you should be getting a different error.
    With Craftbukkit older than 310, this error might be thrown, but hard to check so many versions.
    (SIGN_CHANGE didn't exist as a field prior to build 311, but you need build 323 or greater for full protection.)

    Like I said though, try the /version console command, it will help identify the exact build, and provide as much additional info as possible.
  19. Offline


    I get this error when i start up the server

    Edit: wow someone already had the problem just moments ago before i could even post LOL

    Edit2: /version doesn't do anything unfortunately
  20. Offline


    Oh good, someone online with the problem! What does it say at the start of the log?
    The bit that says like 'This server is running Craftbukkit version"... and has a long string after, what's the string?
  21. Offline


    [INFO] This server is running Craftbukkit version git-Bukkit-0.0.0-393-gbba70c8-b304 (MC: 1.2_01)
    i got same error as him
    --- merged: Feb 17, 2011 4:47 AM ---
    also error msg is when starting server!
  22. Offline


    You are using build [304]~ (the b304 at the end)
    The number in brackets at the end of a plugin's subject is the required build version. For Lockette, this is [323].
    Please update your craftbukkit jar file. :3

    The current version at the time of this post is [335], and can be found here:

    Though some have reported crashes with it, you may want to use [325] for now:

    Hope this helps!
    (Also @Wardogz @KenRhee @thelukestir see the above~)
  23. Offline


    did 304 have the new sign hook? Think you need to update.
  24. Offline


    Alright I got the sign to work on the dispenser following your instructions, but adding [Everyone] to a sign still isn't working for me.
  25. Offline


    You sir are smarter then us, I thank you :D
    --- merged: Feb 17, 2011 4:56 AM ---
    also, Very nice plugin thanks for making it :D
  26. Offline


    I'm glad I helped with the first bit anyway~!
    Now for the second bit, I'm not sure what else to say?

    [Private] on the first line, [Everyone] on the third line.
    Including the square brackets on both.
    Capitalization shouldn't matter if you have the latest version of Lockette. (1.1.2)

    Could there be another plugin (like LWC) keeping [Everyone] from working?

    --- merged: Feb 17, 2011 5:03 AM ---
    You are welcome~ :3
  27. Offline


    Works perfect! Great mod thanks :3
  28. Offline


    Ah good, another problem sorted~ XD
  29. Offline


    Alright I forgot to restart the server once I updated the plugin. Duh.
    Anyways just a personal opinion, it would make more sense if you just put [Everyone] on the first line. Because saying private on it and having a users name can confuse people. Thanks for help though!
  30. Offline


    I see your point, but the chest is still privately owned, even if everyone can look inside.

    You can always hide the sign inside the wall, like I do with mine. :3
  31. Offline


    Most people who are using permissions use permission 2.0 http://forums.bukkit.org/threads/admn-info-permissions-v2-0-revolutionizing-the-group-system.1403/ just make a permission set for the ability to view any chest no matter the protect so bypassprotect or something like that. This way admins can ensure people are not doing some naughty things!! Also, the ability for group names using permissions would be epic! This way we dont have to put 5000 usernames on the chest but just a groupname.

Share This Page