[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


  3. Offline


    protecting the breaking of signs???????
  4. Offline


    No, anyone can break the signs there by making the whole basis of this plugin completely worthless
    Of course is protects itself
  5. Offline


    Will you add the locking of signs?
  6. Offline


    I think s/he meant can you protect regular signs.
  7. Offline


    Erm. Wrong plugin for that...
  8. Offline


    I have updated my server to bukkit version 860 and it still doesn't work.
  9. Offline


    In your OP you say that Lockette is incompatible with OpenINV but I am using Lockette and OpenINV together perfectly!
  10. Offline


    It's not saying they are completely against one another, its where there was a conflict between OpenINV and Lockette that was reported once and as such is an "Unconfirmed" conflict, if it works for you then it works for you
  11. Offline


    aaahhh ok now I understand!
  12. Offline


    Don't know if this is a know bug or not getting quite tired of reading because so many things are broken atm, notch sure is an idiot :(


    I use permission 3.1.5b and have the '*' myself

    Now if i want to destroy a sign of someone else, i get the message i am not the owner of that sign. I am even in the ops file :(

    enable-messages-help: true
    broadcast-snoop-target: '[Everyone]'
    broadcast-reload-target: '[Operators]'
    broadcast-break-target: '[Everyone]'
    enable-messages-error: true
    enable-messages-user: true
    enable-messages-owner: false
    enable-messages-admin: true
    enable-protection-doors: true
    default-door-timer: 0
    explosion-protection-all: false
    enable-permissions: true
    allow-admin-bypass: true
    allow-admin-snoop: true
    Please help, this plugin is to awesome :D
  13. Offline


    I cant seem to set the owner of a container as a group from the permissions plugin. It reads the group name as a player name instead. I have permissions plugin enabled but it still doesn' work for some reason.
  14. Offline


    It will only read it as a player on creation, after that it will read it as a group

    Not sure if this helps the MM/Lockette conflict fix but it only happens to doors and only if you don't manually specify the 2nd line

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


    Oh ok thanks.
  16. Offline


    This work for 860?
  17. Yes it works with 860.

    I have a problem that I just discovered, I'm also using "Cabinet" plugin to stack chests but if one of those chests is locked by someone, it says that I don't have access to it but it still opens the inventory GUI :/
    Can you overwrite Cabinet's ability to open chests locked by your plugin ?
    Or you could edit that one, I was unable to edit it since there are stuff missing or are too old methods for me to understand, I just started learning :))
  18. Offline


    This issue still persists (in 818). It seems that when someone goes through the nether that lockette breaks. Door signs do not work and it seems like only some chests still work. A non-OP could access some locked chests but not others. Very odd. I will report back with more findings. This might be fixed in 840, however, but we haven't upgraded yet.

    As I noted in my previous post (the one I quoted) it seems to fix itself. I'm not sure why yet, though.
  19. Offline


    My admin's are not OPS but I want to give them permission to bypass and snoop, how do I do this?
  20. If you use "Permissions" plugin you're able to give any specific thing to any specific player or group.
  21. Offline


    i like this plugin better than others because it requires zero setup on my part. i just told my users how to activate it in a tutorial show at the pavilion we built. and then they locked their chests and the stupid petty theft accusations were gone.
  22. Offline


    Today I found out one of my player's lockette signs weren't working. They were on doors, furnaces and chests and looked proper. (They had worked when they were first created.) The problem was exclusive to one chunk and no others (so far that I've found.) I was able to open all of his chests/furnaces and when either of us tried to protect a chest within the chunk it would give the 'No nearby container detected' message.

    Basically something happened to the chunk, no errors appear in the log. Anyone else experience this or know of a fix. I'm thinking of just nuking the chunk in MCEdit.
  23. Offline


    I just fixed it with groupmanager... i was being stupid again :p
  24. Offline


    Stopping and starting the server may have fixed this. Still kind of scary.
  25. Offline


    Add to trapdoors plzz :D
  26. Offline


    I second this, and here is an idea (or several) on where to place the sign
    Below the door is obviously not an option as we need ladders, so how about on the block that holds the trap door (above perhaps?)
  27. Offline


    Anybody know Solutions to get Lockette working together with Residence / iConomy?
  28. Offline


    There still is no way to prevent non-ops to create their own chest, even with the permissions, is there?

    Im new to plugins and never used permissions before.
  29. Offline


    Use permissions and don't give them the lockette.create.* permissions (so do nothing really)
  30. Offline


    Cant protect doors on 860 anymore, worked fine last night with 860, now all i get is the conflicting with already protected door message... any solutions?
  31. Offline


    Chances are you installed MinecartManiaCore, this is a known conflict and the solution is to enter your name on the 2nd line (don't let Lockette handle the naming)

Share This Page