[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


    I hope soon ;/ All plugins from my server work except lockette :( And we really love it !
  3. Offline


    By a chance, do you have a GitHub? If so, is the source for Lockette available on said GitHub? I'd love to be able to see the code, and maybe even fork it! :3
  4. Offline


    I am sure a lot of ppl would be willing to help you keep this plugin up to date if you make it open on github.... including myself.....
  5. Offline


    I need this plugin lol my server is down without it...

    ill give you [cake] for an update!!!
  6. Offline


    You're not alone in needing it, but everybody posting telling him how much they need it and to get it done now, doesn't help get it done quicker. He'll get it done when he can. :p
    whebzy likes this.
  7. Offline


    Update please for 1.2.2
  8. Offline


    I know but im not slowing him down lol Just board and figured id let him know how much him and his plugin means to us all,
    PS. have a [diamond]
  9. Offline


    If this plugin doesn't update - My server.... Well lets look on the bright side.
  10. Offline


    Note that Deadbolt is totally compatible with Lockette, and does work with 1.2 - http://www.curse.com/server-mods/minecraft/deadbolt - of course, the downside is that it's a curse link, and is insanely painful to actually navigate through. Once you manage to get the Jar file, it works flawlessly.
  11. Offline


    xrobau md_5 does some pretty good work. Not sure why he thought he needed to reverse engineer Lockette...maybe because Acru keeps a pretty low profile. But Deadbolt still has some maturing to do. Lockette works... it just needs to be updated. :)
  12. Offline


    LOOK! You guys, don't give up. Sometimes you have to wait a bit, or read a few of the posts by the author. Acru is probably about to explode with the amount of people saying to update to 1.2.3! Be patient! Be thankful that bukkit came out with a recommended build that didn't take a week to be released!
  13. Offline


    There's an RB? R6 is for MC 1.1. There is no 1.2.3 RB. -- But that's beside the real point, which is a good one.
  14. Offline


    I get an error loading Lockette 1.4.9 on 1.1-r6 RB, which happens to be the same error as trying on 1.2.x
    I didn't see anyone else say this, so I just wanted to let you know.
  15. Offline


    My entire server is converted and ready to go on all main plugins.. except this one :(
    *paces floor lots* can you at least get chest and doors working.. if you are trying to add lockette support for all the other good stuff... can you do that later :/ i know zombies probably break the doors anyway.. and you are trying to figure something out, but its chests mainly ppl need the locks for :/
    *paces some more*
  16. Offline


    Same here!
  17. Offline


    Note, I posted a link to Deadbolt, which does EXACTLY THE SAME THING as Lockette, and it works NOW.

    Here is a direct link to the Jar - http://dev.bukkit.org/media/files/577/666/Deadbolt.jar - this works WITH YOUR EXISTING SIGNS. Just install that. It'll all work. When Acru finishes updating Lockette you can move back if you want. But this works NOW.
  18. Offline


    Only two problems there - firstly it appears to have different permissions - and when I made my post he didn't have a working R6.. although there appears to be a test build up now. Plus most people use lockette as it is the original, and integrates with a few other plugins, while deadbolt wont without some lockette bridging hacks. Most of us probably just spent the last 3 days testing and retesting and updating and reconfiguring numerous plugins they are familiar with, then retesting with various combinations of dev builts till they all played nice together- having to wack on another plugin, and a hack, then reconfigure all the integrated plugins that use the hack, then retest all the plugins, then restest everything and cross fingers just to move back to Lockette afterwards isn't really going to appeal to them.
  19. Offline


    r6 didn't give any 1.2 errors...
    then there is the stable too
  20. Offline


    Are you going to update this to R6 or 1.2?
  21. Offline


    I check this thread more than dl.bukkit.org
  22. Offline


    not compatible with 1.1-R6 :/
  23. Offline


    Please update this plugin !!
  24. Offline


    Haha I do too. :p
    Ok good at least I"m not the only one.

    And btw I can't update to deadbolt also because of permissions...
  25. Offline


    Doesnt work for bukkit 1988 build. Update I love this plug-in. :D
  26. Offline


    pls update this to MC V1.2.3

    pls update to build 2032 pls

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  27. Offline


    please update this !!!!!!!!!!!!!!!!!! i love this plugin!!!!!!
  28. Offline


    Heh, a lot of please update posts today and its not even noon here yet. Working on it.

    The update will cover the changes in the API that were introduced with R5.

    Incidentally, know where I can find a MC client 1.1? I don't appear to have a backup.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  29. Offline


    Just get Deadbolt for now, its the same thing. But just doesn't work for groups on signs.
  30. Offline


    Waiting your plugins ...........
    No your plugins i can't open server =[
  31. Offline


    Enough with mentioning Deadbolt here, please, I'm still generally annoyed that they reverse compiled Lockette to build a clone.

Share This Page