[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. HAH! Can't believe it actually happened...got a member who's name is too long for the sign...anyway to circumvent this? ^^;
  3. Offline


    Which version of Bukkit are you using?

    I'm getting issues on my own plugin, as well as seeing some issues posted to Leaky, that makes me suspect that the Bukkit event system sometimes fails to propagate events through event handlers. That causes/would cause all sorts of glitchy behavior if so.

    (And would also be completely un-fixable by plugin authors)

    I'm not sure whether this is visible in all Bukkit versions since the event system change or only the 1.2.3 betas.
  4. Offline


    Newest Development Build
  5. Offline


    can u make it so that zombies on hard mods cant break in if it is locked
  6. How do i lock a door for a specific group in bpermissions ?
    btw i love your plugin and your so awesome for making it, be sure to keep up the good work :)
  7. Offline


    This is a great plugin, but it would be even better if i can open someone's chest without breaking the sign without permissions (ofc i'm an op)
  8. Offline


    You'd have to disable permissions in the config for that though. It's easier to just give your OPs the permission node. :)
  9. Offline


    is there a way to make a player only to open it and not to make one?
  10. Offline

    Codex Arcanum

    Can anyone clarify what the mcMMO support does?
  11. Offline


    Thank you for all your hard work and the updates!

    bug - Lockette+Towny - [Everyone] on door - before this would only work for town members - now "Everyone" in the world can open it.

    suggestion - enable-protection-FURNACE: false - I dont want people able to protect furnaces.

    suggestion - Why does lockette show admins snooping in a chest? I would much rather see when a player trys to snoop in a chest as I see no reason any admin would want to know when they are looking in a chest.
  12. Offline


    Haven't seen this anywhere in here yet, but could you add protection to levers and buttons?
  13. Acru
    The quickprotect seems to be able to protect already LWC protected chests even if protected by another user. Can a check be performed before?
  14. Offline


    Mishrathium have you tried not granting the lockette.create.furnace node?

    Sorken why use both LWC and Lockette? Most admins choose one or the other.
  15. Greylocke

    To give my users choice and freedom in using the protection system they feel is right for them. Also, most have played on some server before and are used to one or the other.
  16. Offline


    I am an idiot. You must ENABLE the "enable-permissions: false" in the lockette config to remove things... doh
  17. Offline


    so i cant figure this out im new to this but w/e so every time i put private and a name nothing happens anybpdy can walk in do i need the permissions because that's what confusing me i haven't put any in yet but the question is are they required?
  18. Offline


    I would like to see [$<amount] implemented on signs. It would be great for adventure maps and alike for dungeons ands things :) I want to charge players to enter an end portal room. Would be great :D
  19. Offline


    OllieGlover since Lockette doesn't tie into an economy system, you might want to check out Turnstile for that.

    sticky55 Lockette will work without permissions, but its functionality will be severely limited. From the OP, above:
  20. Offline


    still it doesn't work with any permissions not sure why nothing works even if the sign says [Private] anybody can just walk in.
  21. Offline


    sticky55 do you know for sure that it is actually loading? Check your server log for errors. Try the /lockette command to see what happens, and may try just slapping a sign on a chest. If Lockette is running, then it should automatically put [Private] and your name on the chest.
  22. Offline


    judging from it it doesn't even seem like its trying to boot? server.png
  23. Offline


    sticky55 there should be a server.log file in the same directory as your craftbukkit.jar file. Near the end of that file will be a record of the last time you started your server. Look for any Lockette information. If you see it mentioned in the log, paste the first few lines of the messages into a code window here, or a pastebin link.

    If you don't see Lockette mentioned in your server log, then Lockette.jar is not in the /plugins folder.
    Acru likes this.
  24. Offline


    Does this work for metal doors? Also more information on what craftbukkit version you are using would be helpful.

    I need someone that knows Spanish well.

    I somehow ended up with two Spanish translations, and I need a third party who can point out the better one.

    Just put the number of characters that will fit on the sign, and it will work. No room for color codes though.

    Support for zombie breaking prevention won't come until there is a more stable build or RB for 1.2.3, (with the needed events.)

    A fix for bPermissions groups is done, expect to see 1.5.1 release shortly.

    This means you can use the name on an mcMMO group on a Lockette sign, for accessing a chest or door.

    bug: This probably relates to a setting in Towny, not in Lockette.
    suggestion: There is a specific permission for protecting furnaces, you can deny it to everyone.
    suggestion: This is an effort to prevent admin abuse of the snooping feature. The message can be disabled if you fully trust your admins, though.

    My standard suggestion is to put the levers in a room behind a locked door, as anyone can activate redstone circuits by placing a redstone torch in the right position.

    I'll have to look into this and see what I can do.

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


    just my opinion... I like the concept of zombies being able to bust down a locked door. I know this gives an opportunity for 'zombie griefing' but on my server, I'd prefer allow the zombies to bust the door down!

    so Acru if you put in the anti-zombie-busting (AZB) feature, could you make it optional?
  26. Offline


    This feature is planned, but not ready yet.


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


    It depends on what country they are from since there are so many dialects of Spanish.

    I can take a look if you'd like, I will do my best to pick the one that is the closest to basic Spanish.
  28. Offline


    Send a PM, im from Argentina, it's my native language!
  29. Offline


    Okay, started a convo with both ya~

    [Preview of next version, with brewing stands and custom protected (single) blocks.]

    It all seems to work, and I'll be posting soon. The sign could be better placed for brewing stands, though I'll leave that for a future update.

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


    maybe make the signs work under the stand, like with a door?

    .. and is that a diamond block you locked? Is that a joke? :confused:
  31. Offline


    Doing it that way would require more time to do right, and can be supported in a later version. For now I just wanted to get it in there and stop putting it off for a 'nicer method'.

    Yes that is a diamond block, and no it isn't a joke, but it is only supported if you have the ID 57 included in the custom-lockable-block-list, in the config.yml

    But for some reason org.bukkit.configuration.file.FileConfiguration.set() is refusing to write a List<Integer> for me right now, and the update is delayed do to it.

Share This Page