[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 dont know how to can you please just try to add the feature asap man U'll be the best :)
  3. Offline


    If i am an admin on a server and we use this plugin, can i get access to peoples private chests if they dont add us on their sign? We only want to for security reasons.
  4. Offline


    Enable the snoop configuration option and give the lockette.admin.snoop permission.
    (If you aren't using permissions, you have to be op instead, for the latter.)

    PermissionsEx 1.15.1 (dev build) is bugged, just fyi, to anyone who reads this.

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


    PLease man try add that feature :D
  6. Offline


    Just what I need! Is there a way to make it so only ops can lock stuff?or is it just anybody?

    Eeehhh could you make this work for build #1337? Or does it? I can't test it right now, I'm on my android.

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


    2011-10-23 10:58:56 [INFO] Lockette: Detected craftbukkit build [1337] ok.
    works for me. ;)
  9. Offline


    Is it out for 1.8.1 yet?
  10. Offline


    Yes, it works for RB#1337. I use it.
  11. Offline


    how can i make it public i downloaded it but only op's can use it and im one my friends cant use it it says permission to lock chest denied
  12. Offline


    I have a suggestion that I would love be implemented. Would you be able to design a donation chest so to speak
    And the donation chest works so that I (owner privated to the chest) can take items, put items in ect. And anyone else can only put items inside the chest, and not remove them. That would be really neat and useful for donation chests, mailboxes, community chests ect.
  13. Offline


    Okay, So I'm using Lockette 1.4.4 and PEX 1.5 (NOT 1.5.1) is the problem also in 1.5, or am I just being stupid? Also, is that a problem with Lockette or PEX?

    Sorry, forgot to say anythgin about the problem.
    When my players try to lock a chest it says they are denied locking the chest. they DO have the permissions node, as i have check many time, for spelling errors and stuff, but now i'm just assuming this is the same problem with 1.5.1 PEX
  14. It's working fine for me with PEX 1.15 (latest version) and lockette 1.4.4, so I would have to guess that it's possibly your setup somewhere that is off.
  15. Offline


    Im getting the same problems, only OPs(/op name) can use lockette regardless of permissions.
    Pex 1.15 (stable)
    All other permissions for all the other plugins work fine.
    1.4.8(beta) seems to be working
  16. Offline


    I can't edit lines on lockette signs that already have text in them. So if I want to change/remove a user, I need to break the sign completely and re-do it. No error messages given.
  17. Offline


    Can you add support for fencegates?
  18. Offline



    I was wondering if you could add Auto-Protection to signs. Meaning when you place a sign anywhere it auto-protects itself like in LWC, cause i left LWC for lockette, but i really liked that Auto-Sign protect feature.

  19. Offline


    @Acru we talked about custom doors and etc before. My question is if I have a blast door that acts and does pretty much exactly what a iron door does could it not be as simple as having a special config to add special items? Maybe over doing it sorry hehe. We really went full out Industrial Server :p
  20. Offline


    Ive been asking for agers can you please add it as an optin people can do a command right click the door and it places a sign on it? Plz.
  21. Offline


    Im getting alot of these errors
    its not affecting plugin, but kinda annyoing
    can u help me?

    //NVM it was problem with mod, mucck fixed this ;z
  22. Offline


    If a Towny town runs out of funds and the town is disbanded, will the chests in the town be unlocked too?

    If not, I'd like to request the option. :) This would keep admins from having to manually prune chests every time a region is disbanded.
  23. Offline


    Towny does handle this. 2 ways:

    1. Deleting IDs on unclaim
    On a per-world basis you can have a list of IDs removed from townblocks when they are unclaimed (mayor command or upkeep). Signs are automatically in this list.

    2. Mayor's /plot clear command
    Also on a per-world basis, mayors have access to the /plot clear command. This command can only be used on an town-owned (no personally-owned by a resident) townblock. Typing '/plot clear' will erase the listed IDs, useful for when a player leaves town/is kicked from town and their lockette chests are on the property still.
  24. Offline


    Maybe an idea for future updates, a way to lock switches or buttons.
  25. Offline


    Hey, great that you added my translation!
    Only one small remark; my name is at the Polish translations, while kamild's is at the Dutch; this should be reversed :)

    Thank you!
  26. Offline


    A person on my server just said a pretty good and neat idea but I have no idea if this could be doable.

    Netherportal locks, making it impossible to mainly enter and preferably also exit through a portal if it has got a lock.
  27. Offline


    Can we get a change log on the beta builds?
  28. Offline


    Very nice work Acru! I use LWC on my server, but I can see how this will appeal to a lot of people who can't/don't want to use a database or need to use minimum resources. Awesome job!
  29. Offline


    you can already, you jsut place a sign infront of it, it auto-completes everything...
  30. Offline


    I am having 2 issues currently.
    1) None of my users can us lockette at all. I am using PEX and gave users lockette.user.create.*.
    2) also (only me when not OP) cannot even access a chest with/without lockette on it. error is "You are not allowed to use chests or dispensers"

    Any help would greatly be appreciated!
  31. Offline


    @Acru I am looking for a way to make a chest view-only and I see that you've got the [Protected] tag on your ToDo list. I have no idea what it would take to add this functionality, but it would be VERY useful in starter towns, adventure maps, instances, and many other places where you just want a player to see what is in the chest, but not be able to take it. I think there are many people that would really appreciate this feature.

    I would imagine that the [Protected] tag replaces [Private], and then the user could add names of players (or groups) that could have full access to the chest...

    Any chance of moving this from ToDo to Done soon? :D

    PS: How about an [Infinite] tag? :cool: It would maintain the current inventory of the chest by automatically replacing whatever was taken out of it.

Share This Page