[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'm a server owner and I've found a problem possibly due to the 1.3 update.
    I am using towny 0.81 (newest version) and Lockette 1.7.4 but I'm having some strange confliction.

    Lockette works fine in claimed towns, but in the wilderness (unclaimed) my players are getting this error on the signs they place on chests: [lockett]this zone is protected by towny.wilds.
    I am an admin and can use the lockette plugin in the wilderness but normal players can't....
    I've checked permissions and players have the: - lockette.user.create.* permission so shouldn't be a permissions problem.
    Any ideas what the problem is and any fixes?
  3. Offline


    Give them lockette.towny.wilds in their perm nodes, I wonder if this one is still missing from the main post?
  4. Offline


    When you have a private sign on a dispenser, you can't dispense lava.
  5. Offline


    Acru how do you make a faction lock? I can't figure it out.
  6. Offline

    Parker Mckinley

    Im using 1.3.1R1, and ok i'll try that.
  7. Offline


    Im currently using essentials vanish but il give it a try, thanks.
  8. Offline


    Does this work on a Hamachi server.. If so.. how do I set it up because nothing is working right for me.
  9. Offline


    maybe its that but im on mac wat do i do everything like plugins i download it doesnt work and yes i have a bukkit server wat do i do[creeper]
  10. Offline


  11. Italian Language doesn't work :p
    Needs to be fixed!

    Edit: Manually fixed, now works :p
  12. Offline


    can you please add support for minecart, chest in minecart, and furnace in minecart

    is anyone good at modding because i would like a server plugin with workbench in minecart

    and 9 chain block with 1 iron ingot to connect minecarts

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  13. BUG!!!! When I place a sign on a diamond block, it automatically turns into a lockette sign.
  14. Offline


    marksc That is a configurable feature.

    You'll need to set the "custom-lockable-block-list:" portion of your Lockette config file. Diamond blocks are ID# 57, so if you don't want Lockette to be able to lock diamond blocks then remove that entry.
  15. /th
    Thanks a lot, really helped out!!! Have some diamonds :): [diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond][diamond]
  16. Offline


    Hey, i'm working on getting a server going, and I got this mod based on the feedback. However, I am having issues with the doors. the first time I tried it, it seemed to have worked. However, I had to take the first sign down to put up another with the other OP's names on it and now it will not work. Any clue why?

    I figured it out. I still had pressure plates down. It was an iron door. If anyone else has this problem, just take the pressure plates off and click on the door as if it was a wooden door.
  17. Offline


    My co-owner and I were looking into making a post office type area on our building. This gave us a interesting idea. I think an interesting and useful feature to add to lockette would be a depositing system. Idk how it would be done, maybe by adding a "[deposit]" onto the sign. Something like this would allow for people to insert things into a deposit chest not owned by them, but not allow them to remove items. Maybe by left clicking on the sign or the chest with the item in hand. Then, that item stack would be insterted into the chest if there is room. It could also inform people if the chest is full and no longer can accept items with a message. This would allow for donation chests, something like what me and my co-owner were pondering, maybe a newbie help chest, or simply allowing your friends to help you mine or gather stuff without giving them access to all your items.
  18. Offline


    great plugin! yay! and acru... luv ur pic... so awsome... pawsome...
  19. Offline


    I used deadbolt for some time, not that it is dead, I will migrate to lockette.

    My question is: Does lockette offers the funcionality to protect all atached chests/furnaces with only one sign, as deadbolt did? For example, on deadbolt, if a player had a wall of furnaces, he would place the sign on only one, and all the wall would be protected.

    If lockette does not have this feature, could I request that?
  20. Offline


    I hope someone can help. I'm having issues with Lockette not actually locking people out. Here's my permissions file. It's a bit messy as I haven't removed permissions for plugins I removed/added recently as well as probably unnecessary permissions for certain users. http://pastie.org/private/za4xbrmr3wlgqxbldkuva I've removed the users from the pastie.

    As for my plugin list:
    Dynmap - Essentials
    My Worlds
    Cluster(minebook plugin)
  21. Offline


    Any way of a chest bypass permission?
  22. Offline


    like for admin/ops? Check the Advanced setup/Permissions section at the top of the page.
  23. Offline


    Thank you mate!
  24. Offline


    Ok so im not allowed to use .* permissions with spout so i put:

    - lockette.user.create.chest
    - lockette.user.create.dispenser
    - lockette.user.create.furnace
    - lockette.user.create.door

    I am using essentials group manager, craftbukkit 1.3.1
    i also have lwc if thats an issue
    but every time i place a sign above a door (both wooden and iron)
    it says "No unclaimed containers nearby" I put it right above the door
    and i even tried to put it infront of the door same thing
    i am owner of server but i want my mods to be able to use the signs
    on there stuff to protect it. Please Help. Thanks
    and happy to share anything else that might be helpful
  25. Offline


    hey as a owner of typicalcraft i am wondering, is there anyway for me to still be able to write on signs, instead of always making them all private signs?
  26. Offline


    If you r-click a chest with a sign in your hand, it'll automatically place a Lockette sign on the chest, and [Private] will be the first line. But if you just place the sign in front of the chest, you will have the full Minecraft sign-editing features.

    Does that answer your question?
  27. Offline


    I have a suggestion wich would be to make another user group like:

    I would like to have the group:

    currently if you use [everyone] anybody can use your door even on your faction land when they are not a member of your faction
    lockette is great for using automated closing doors however you cannot use them on your faction buildings
  28. Offline


    no i have door protection turned on and when i place a sign on the wall it things there is a door!
  29. Offline


    I've never heard of that problem, and I cannot reproduce it. Is there something different about the blocks in your world? Have you added your wall blocks to the list of "lockable" blocks?
  30. Offline


    how can i disable /lockette <line number> <text>? whats the permission for it?
  31. Offline


    Is this worked with 1.3.2-R0.1?

Share This Page