[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


    ive tried to use your addon for a while now it always works perfect at first but then people start getting [?] when trying to lock things randomly...
  3. Offline


    With no database, my plugin uses a block-step technique to trace between the private sign and what it is protecting.
    Super fast with the sign attached directly to a chest.
    Expanding the area would take up exponentially more cpu power, though.

    That doesn't sound good, what CB build? What other plugins? It is giving the 'no container found' error?
  4. Offline



    Good work with the [Timer:x] function, turned out well, I have just discovered one bug however, if you place a sign while the doors are open, it creates an opposite effect with an "auto open" function going on.

    That said, I also wanted to let you know, it seems to not be picking me up as the claimer, if I place a sign with header "[Private]" it gets claimed by what appears to be an empty variable, saying things like alpha_x888 has problem a container owned by ! etc

    Just thought I should let you know x]
  5. Offline


    That is because Lockette can't tell which state the doors are in so it assumes when you place the sign the doors are closed
  6. Offline


    hey Arcu hope u found the answer to my problem[bookshelf] <--- maby it will help you lol
  7. Offline


    I have moderators with the correct permissions in permissions config but for some reason they cant create signs? They can open their own doors/chests but they cant put their own signs up, it says they dont have the correct permission.
  8. Offline

    William Hall

    when i type [Private] it just says [?]
    and says permission to lock container denied
  9. Offline


    So do I need to download this mod again for it to be compatible with 733?
  10. Offline


    That is not a bug, that is a feature! But as there is no easy way for the plugin to know which door state is what might be called 'closed', it assumes the initial state is the state it should reset to, after the timer expires.

    This is being caused by a change in MinecartManiaAdminControls 1.1.0.
    I'm still considering if I should put out a workaround patch, or wait for the MM update to fix.

    Edit: It seems 1.1.1 of it is out, so you should update. :3

    I did not get enough information from you to help. Note that CB builds 685-703 have an issue that would cause a [?]. Try updating to build 733 first.

    Are you using version 1.3.6? Did you remember to put the .* after create?

    Version 1.3.4 used lockette.create.all, but 1.3.5+ added lockette.user.create.*, with sub-nodes for doors, chests, etc.

    After checking the above, you can post your permissions config, perhaps.

    Either give yourself permission in your permissions/groupmanager plugin, or disable use of permissions in the Lockette/config.yml file. Also check you are using 1.3.6 and not 1.3.5

    Only if you have an old version. :3

    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 had an old version. Thanks :)
  12. Offline


    Mkay, np. :3
  13. Offline


    i know you have worked to get lockette working with at least part of minecart mania, but is there anychance you could get it to work with mm's sign and chest commands? i would really like to have automated farming on our server, but rely on lockette for chest/door protection. right now mm causes lockette to not stick signs to chests.
  14. Offline


    I've never used the sign and chest commands part. What is the nature of the issue exactly, so I can set up a test?
  15. Offline


    Well it is 733 and no more [?] but still no help with the no near lockette maby u cud write me a install guid u know
    1.first put the lockette jar in plugins folder.........
    u know something like that and i will see what i did not do and fix that just an idea
  16. Offline


    Any way to add support for signs sat one block under chests? That's how we set Minecart Mania's automations up, to keep it clean, and it would be handy being able to hide our chest locks as well. Hell, even an option to make the sign invisible, perhaps?
  17. Offline

    sexy vampire

    locket only looks on the sides of chests doors can be one space above.
    mine cart mania looks in all directions even on angels but tricky to get them to work that way
  18. Offline


    How to deal with inactive player?

    Is it possible to desactive the protection on a sign if a player is inactive (more of X days of inactivity)

    Im starting to get issue with all protected signs lefts by players who wont come back.
    Big thanks for your plugin :)
  19. Offline


    I'm not sure I take your meaning.
    I'm sorry if english is not your native language, but you need to speak clearer~

    Invisible signs are not possible. Other plugins just pretend by moving the sign's contents into a database.

    As for below, well, it might be possible similar to how doors are done, but it would be a bunch more work for little functionality gain. Of course, you can always put the chest up against a wall, and put the sign in the wall.

    Frankly, I am happy with the plugin as it stands now, and I don't intend to add new features for a bit.
    I'll just take care of incompatibilities, and any bugs that turn up in future builds, so I can spend time on other things. :3

    As there is no database for tracking protected containers, it is something admins with the lockette.admin.break permission will have to take care of.

    Some servers don't give guest users the lockette.user.create.* permission, so only regulars can make protected chests.
    This might relieve most of the issue, aside from cleaning up the ones that already exist?
  20. Offline


    Just stopped by, not to give an error report, but to say everything works very well. Thank you for this plugin; we use it extensively.
  21. Offline


  22. Offline


  23. Offline


    I'd use this plugin if you could set a limit to how many protected chests a player can have.
  24. Offline


    my bad ok i will try now: Can you make instructions on how to install this plugin,like 1.put the jar file in plugins folder
    hope you understood me this time i really need this plugin
  25. Offline


    All you do is place it in the plugins folder, run your server, stop the server, go look in the Lockette folder and edit the options and re-run the server. Bazam; it works.
  26. Offline


    Is there any way to disable lockette's "right click to trigger edit mode" feature, as one of my players asked me?

    We have a system in place that allows players to edit signs by right-clicking an existing sign with another sign, and it seems to cause issues with lockette signs already in place on chests and the like.
  27. Offline


    How I can disable admin-snoop message broadcasting?
  28. Offline


    In the config file in the Lockette folder.

    Confirmed: this version of Lockette works on 740 with no issues. Title fix?

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

    cole robinson

    when i login it says bad login every time
  30. Offline


    Nothing to do with lockette, everything to do with the Minecraft Client.
  31. Offline


    not sure if this is to do with your plugin or worldguard plugin but i have a lockette double doors that is marked for everyone (i just wanted the the auto open and close feature on it) and the building it is attached to in a region protect are so that no one can grief it how ever not everyone is allowed to go into that building (prevented via worldguard) when a non allowed person clicks the door the one opens for a split second and closes (cause of world guard entity interaction protection) but this still causes the other door to open and stay like that. then you click the either door and the open one closes and the closed one opens and then revert back to open and closed due to lockette autoclose.
    to fix this issue i am required to destroy the lockette sign close the offending door and relockette the door.

Share This Page