[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 am also getting the same error.. Im using permissionsbukkit though. Please help. Plugin is completely useless until fixed as no player can use it.
  3. Offline


    This is not correct. My servers are running both Lockette v1.4.4 and Spout v1.0.6.403.

    I do know that there was an incompatibility introduced in recent dev builds of craftbukkit that breaks Spout. Maybe you're bumping into that?
  4. Offline


    Same issue here, "permission to lock containers denied", Lockette unable to link to Permissions plugin version 3.1.6! Seems to be related to Spout, if I disable Spout-plugin there is no error from Lockette... Will test more.
  5. Offline


    Could you tell me how to set up my permissions so that while my users could set a [PRIVATE] sign on a door, they can't do it on chests/furnaces etc?

    Thanks, Com
  6. Offline


    Well I'm not using Lockette.
    I said it because in those logs, the errors mentioned spout several times, and whenever I see that in my log it always comes from a plugin that is known to be incompatible with spout

    I was wondering if it's possible to have the signs hidden..
    I need to lock doors so only players in certain groups can open them for questing reasons, but I do not want visible signs that can, in any kind of way, ruin the roleplay immersion
    I read somewhere that the sign can be placed on the block beneath the door, if that's true then this is gonna be installed today
  7. Offline


    I understand the author fixed the issue in more recent versions, but I haven't tested personally.

    Don't forget to give the permission lockette.towny.wilds, for permission to lock in wilds.
    The next version has a separate error message for that.

    I'm sorry, but I cannot understand what you are saying here.
    Perhaps you need the permission lockette.towny.wilds too?

    In any case, I don't know why @LlmDl liked that post, heh.

    This is an error within Bukkit, apparently, I reported it here some time ago, though no response;

    I also put in a workaround that will be in Lockette 1.5, sorry it is taking time to get released. :3

    This is already in Lockette as of 1.4.1.

    I'm not sure if this is true, but if so it is Sprout that needs to be fixed!
    The error is a piston event passing a non-piston.

    If you have Towny installed and are building in the wilds, you need the permission lockette.towny.wilds
    Unfortunately, I gave it the same error message in 1.4.4 as a permission error, so hard to tell when it is happening.
    This will be fixed.

    You can place the sign there, and hide it within the wall, yes.
    Unfortunately since the chest block was shrunk, you can't hide the sign on the backside of a chest anymore.

    Looking good, though I'm sad you don't show the quick-protect method in the video~ (Aka, right click a chest with a sign.)

    I need a new tutorial video that shows it. Though I want to have something similar for doors too first. :3

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


    Yes, I just had time to install and test it before heading off to work. This is perfect :)
    Now I just need to see when I get home, if I can get some of my staff to help me test it. (gotta demote them for it though.. Gotta test how it works for players ;))
  9. Offline


    Actually it was because the plugin does not work with superperms.. Please add support for that. I had to go in and add in each individual node and it worked then..
  10. Offline


    Sorry, I intended to reply earlier but haven't had the time to test it thoroughly. Either your statement is incorrect or I'm not understanding it properly.

    I can lock a door and put [groupname] on the sign, and only those in that permissions group can open the door. For a player in any other group, the door immediately closes. I'm using PermissionsBukkit and SuperPermsBridge.
  11. Offline


    Yes, it would appear this does indeed have native support for permissionsbukkit :)
    As I already mentioned, I didn't have this at the time.. I installed it yesterday
    So my statement is indeed incorrect

    And for once, I am very happy to be wrong! As I can now have the quest system I need, with buildings containing high-end quests closed off for new players
  12. Offline


    cant get it to work with the new PEX version -.-
  13. Offline


    hi there,

    This may have been asked a lot but is that possible to made Lockette work for trapdoor? Sometime that could be interresting to private a trapdoor or use the "Timer" to close it after a specific time.

    Anyway thx for the great job :)
  14. Define not working. Seems to be working fine for me with PEX 1.15

    I don't know about the timer bit, but it already does work with trap doors.

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


    Using the PEX dev build (because Towny requires that) also Towny dev build and CB #1321
    If set Lockette to enable-permissions=false it tells players they don't have permission to lock chests. Before it worked with the same config. Then I tried enable-permission=true , added all permission nodes, also tried the sub nodes but that didn't change anything either. Players don't have Permission. It's not like the plugin isn't working, no errors but it seems like the permissions are screwed.
  16. Offline


    Did you add the permission for lockette.towny.wilds? Though I may have overlooked towny.wilds effecting when permissions are disabled, I'll look into that too.
  17. Offline


    Yes that one was added. I also tried it without Towny and its the same issue.
    Thanks for your quick reply.
  18. Offline


    Getting really close on the permissions system rewrite, hopefully I'll have covered all the issues, and everything will magically work...
    But with superperms a new feature, there may be new issues~
    maniacmusic likes this.
  19. Offline


    When do you expect it to be ready?
  20. Offline


    My to do list is still a bit lengthy, but I may cut it short so I can get a release sooner. The permissions rewrite is basically done though, I'm just poking some permissions into plugin.yml before testing.

    By the way, were you using PEX 1.15, or the dev version specifically?
    The dev link is broken and I can't get it, just now.

    I had some good feedback on a beta build, so I'm leaking it here, until I get the full release done:

    Just in case it takes longer than planned.

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


    Before I forget, I wanted to say that it is on my list.

    However, it may not make it into the next version as I'm trying to set a cutoff point for Lockette 1.5.
  22. Offline


    Hm true i need it for my bak sytem people want to use it please try do in next few days I love this plugins and my sever does to :D my idea is a good one write command and hit door and sign actaches to it :) plz do ASAP cuz my server is open :)
  23. Offline


    all of a sudden when people put a sign above a door they get a ? even with using [private]
  24. Offline


    Did you make any permissions changes recently? Maybe an accidental one? If things were working but now they're not... you gotta ask, "what changed?"
  25. Offline


    Would you perhaps make a ticket for it?
    I would like to start using the ticket system :3

    Made beta build 1.4.7 available.

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


    What exactly is the conflict with OpenInv?
  27. Offline


    Those specific versions, it was bypassing the protection of lockette/lwc
  28. Offline


    One problem.
    People can make their way round the protection by breaking the sign. It comes back but with no text on it, thus they ca open the chest/door...
    Anyway or a plugin that stop this from being exploited?
  29. Offline


    Can you isolate which plugin that you are using is causing this?
  30. Offline


    Well I dont have any protection plugins, that may be the problem, but i really doubt any of the plugins i have conflict.

    I think it was one of my Admins, since he said he was doing some 'routine checks' and obviously wasnt very clevrer and broke the protection instead...
  31. Offline


    Well, you never can tell, and there is one known issue with Bukkit's MC 1.8 + MinecartMania + Lockette. You could try the Lockette 1.4.8 beta just to be sure. (Root cause is a bug in bukkit added in 1.8, which the beta now works around.)

Share This Page