[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 see.

    Admins (ops or people with '*' permissions) can already do this by default.
    I plan to add a permission to limit who can place the signs too, though this isn't in yet.
  3. Offline


    Just today I realized that Lockette wasn't working with my multiple worlds. It always said [?] on the sign and in the chat said "There is no unclaimed container nearby!" when I had the sign literally right in front of the chest. I tried from all angles but it never found the chest. craftbukkit 556
  4. Offline


    This was reported once before by @Shaun Bennett, but I was unable to reproduce. (Multiple worlds always worked for me.)

    If you could give me more details on your setup, maybe I could track down the problem. What multiple world plugin are you using and what version? What method do you use to change worlds? Does it work again when you return to the primary world? If not, does it work again when you restart the server?

    It is also possible another mod was interfering as well. What other plugins w/ versions are you using? Could you perhaps disable all plugins except the multi-world one and Lockette, to see if it works? And if so add a few plugins at a time until it doesn't, to narrow it down?
  5. Offline


    Do like this:
    You got a chest against the wall, and you place the sign on the wall but on the left side to the chest, it appears to be on the wall but when you finished editing it will stick to the chest.
  6. Offline


    I know how lockette works, really, it works just fine on the normal world. It just doesn't go on this other world I have.
  7. Offline


    Just wanted to say thank you for the awesome plugin Acru, could not live without it. That being said, will you be around if 1.4 breaks it? :p

    Seriously though one of the best plugins on the site.
    Nuk3d likes this.
  8. Offline


    Future Possibilities:

    There are a number of things that have been suggested, but aside what has already been implemented, the following may or may not appear in future versions:

    • A permission node for being able to make locked containers or doors.
    If you want any of the above features sooner than never, let me know!

    I am curious if the above is something you'd still be willing to code into this plugin. If you are willing and able to do this my server would definitely use it!
  9. Offline


    I just want to let you know, I love this. I am new to running a server/bukkit and there has been slight stealing issues. This is fantastic for that problem.
  10. Offline


    Does this work with GroupManager?

    Sorry didnt see that. Disregard. Thanks

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  11. Offline


    I agree! So easy to use! No databases! It even does Windows ... oops, got carried away. :p

    Seriously, great job, Acru! :D
  12. Offline


    See my reply too, if you missed it!~

    Lol, thank you~

    I'm still around in case something breaks or an issue comes up in the thread, replying to bunches at a time, though I'm not actively working on the plugin at the moment. (I work on this plugin maybe a few days out of every couple weeks, more or less.)

    Expect this one included in the next minor update! :3

    I'll probably put some time into it this weekend, along with checking compatibility with the new recommended build 600.


    Thanks too~ :3

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: May 8, 2016
  13. Offline


    Does protecting doors work if I set the sign 2 blocks below it, and work for the 2 doors connected.?.​
  14. Offline



    Hello, Just to let you know recommended is now 602 of this post :)


    I wanted to add your plugin is great the new door feature is amazing and I really think you have done a great job so far with this plugin. Keep up the good job and damn you for derailing the shop mod <3
  15. Offline


    No, and yes for the second bit.

    Yea, I get an alert every time they put out a new RB, maybe because I have a developer tag or maybe everyone gets. :3

    And sorry, but between rl and improvements to Lockette (and SpaceChem) I haven't had time to fork out to a new plugin... and it seems like the release forums are already saturated with shop plugins (of varying quality), while the only competition for container security is LWC. :3
  16. Offline


    @Acru Well you do have the best locking system that is for sure :) Looking forward for the 602+ update :)
  17. Offline


    Can we please get this updated to build 602? Thanks
  18. Offline


    would love an update!
  19. Offline


    Need update for 602 ;D
  20. Offline


    I realise how many server this plugin is core on, but no need for the threadspam, guys. One post mentioning 602 is enough to alert the wah to our burning need to keep our containers away from wandering hands!
    Scyfi likes this.
  21. Offline


    I didn't realize they slipped a little something extra into 602 to break something I hadn't already accounted for. I'm tracking this down now for a quick fix.

    Edit: Lovely, they changed some event names between 599 and 600 is all..
    SirMustachio likes this.
  22. Offline


    Thanks so much! Without Lockette and WorldGaurd, my MineCraft life ends.
  23. Offline


    I bet it was @Grum ... He does this for fun to mess with us all hes like a epic troll! lol
  24. Offline


    Heh, yes, blame goes to @Grum for making the depreciated functions final. I had to fork off a copy of my player listener, one for pre-600 and one for post-600, to stop Bukkit from complaining.

    Fix'd in 1.3.3.

    At least it makes it easy to notify the the most interested people about the update, as above. :3
    SirMustachio likes this.
  25. Offline


    Yeah, certainly a plus point!

    Thanks a lot for the quick update, fluffy one!
    SirMustachio likes this.
  26. Offline


    Np, it was a simple fix as I had already done the needed changes for the 560-561 transition.

    By the way, 1.3.3 doesn't have this yet. I put it off for sooner 600-602 build support.
  27. Not sure if this bug has been reported, but private doors can be circumvented with use of placing a button next to a door.
  28. Offline


    This can only be done in a CB build earlier than 537, note that I recommend 552 or greater~
    You are using an old build, yes?
  29. Offline


    Alright, would this mean that you wouldn't be releasing this until a new recommended build is released? Sorry if that is a dumb question. I am still new to Bukkit plugins and noticed a few developers only release updates upon a new recommended build being released. If that is not the case here then would it still be likely that you would be able and willing to code that in this weekend and upload a small Lockette update? :3
  30. Offline


    Yes, I'll have time to add a couple things this weekend.
  31. Offline


    Thank you!

Share This Page