[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


    Hy! I have a question, pls help me. Im using Permissions 2.7.2 and lockette v1.3..7. Im also using Factions, and we have a guild. We have a guild, and the guild has a big castle, with a garden. So i want to restrict the players who dont memberse of the guild, and how can i create a new group like [private] or [everyone] to make a list about the members, and just they can enter through the door. im know, its very hard to understand, my english is ... so if you can help me, i thank.
  3. Offline


    Make a permissions set with "GuildName" and move those users into it. I think that's the only workaround. Then you can use [GuildName] in the lock. Like I have Admins, Mods, VIP, Users, Guests. If I put [Users], only they can get in. :)
  4. Offline


    That one is not a broadcast, it is just a normal message. Perhaps the red color is misleading? :3

    Interesting thought, though I don't know how useful~
    At sunrise the doors would open, letting in burning zombies and skeletons. XD
  5. Offline


    Okey, but can you tell me where have i to put the player names? what lines? pls help me :D
  6. Offline


    Ever since last night the doors on my house are playing up, when you open it, it opens but like 3 seconds after the top half retracts and vice verca. I have no clue how to fix this? Could someone help. There was a protect sign on the doors and it worked fine until this happened. I have tried re-protecting and replacing the doors. The auto door close setting is on 2
    Screenie: [​IMG]
  7. Offline


    Love this plugin. I've got a suggestion with regards to usability though. When some users see [Private] and a name they're afraid of using a chest even though the next line is [Everyone]. While I can understand why, I would've loved it if the only line on the chest-sign would've been [Everyone] (or [Public]) etc - just to make it really obvious that the contents of the chest are indeed meant for ... everyone.
  8. Offline


    How do you turn off the snoop message? :(
  9. Offline


    When I change the config, this mod stops working! Please help!
  10. Offline


    Lockkete will work for a few hours then stop letting some people claim containers or doors by saying "no container nearby to claim message and then [?]. I'm using CB build 740 lockette version 1.3.7, permissions version 2.7.2 with the appropriate permissions of - 'lockette.create.*' - 'lockette.user.create.*'
    All of this, I have read back many pages with no luck. Also no server message of error or any at all relating to lockette or I would report that. Uhm, any other info you need ask.
  11. Offline


    Can you PM me your Permission config in [ Code ] tags?
  12. Offline


    I'm not having any problems with wooden doors/WG protection, but I have a feature request. Add something [deliveries]? where people will be able to put things in chests, but will not be able to take them out (right click with the item? or maybe simply throw it on top of the chest?).
  13. Offline


    This is weird. i download the plugin, drop it in the Plugins Folder, and run the server, but it does not work. is there a config file somewhere? i cannot find it. :p
  14. Offline


    In the Lockette folder that gets generated?..

    Edit: Actually; I think there IS a Lockette folder in the .zip.
  15. Offline


    Im here to thank you Acru. This is a incrdible plugin, I have NEVER seen it fail. Its great, simple, and really easy.
    Those kind of plugins u dont even notice that are there. Alway easy to update, it never breaks, it never fails :3
  16. Offline


    i dont see what you are talking about. when i run the CraftBukkit RUN.Bat (with Lockette.zip in the plugins folder) it does not generate a folder for Lockette like the other plugins do.
  17. Offline


    If you downloaded the zip and it contains lockette.jar then extract the jar, if it does not contain a lockette.jar then rename it to lockette.jar and install that as it's some weird browser bug (I think someone blamed IE) that renames the file
  18. Offline


    could you add a few more blocks like the locker plugin has

    e.g. ironblock, diamondblock, glowstone, TORCHES, pumpkins, MINECART TRACKS, POWERED MINECART TRACKS :D

    If you can add any of those that would be awesome :D
  19. Offline


    I have Lockette installed to my server. But when I get into the server it doesn't work. HELP ME?!?!?!
  20. Offline


    Hey, I really love your plugin, I have never had a chest locking plugin that was so easy to use! Sadly, sometimes signs turn from [Private] to [?] without any reason. One of my member got stuff stolen from because his chest sign changed to [?] and everyone was able to accsess the chest. I did look in the logs but found no error related to Lockette :/ I'm running craftbukkit 740.
  21. Offline


    You have to unzip the .zip file (extract it). There's your issue.
  22. Offline


    This is a nice plugin, thanks for it.

    Is there any way that you could make it so that [Everyone] chests JUST say "Everyone" on the front? Its a bit confusing how it says [Private] username [Everyone].
  23. Hi Acru, I have discovered a bug with your lockette plugin today of which id like you to know about.

    We have been using your plugin for some time now and would like to thank you for keeping our stuff safe :)

    However, today i discovered this....(bug maybe?)

    I enabled the admin snoop option in config.yml and everythign works correctly until an OP/Admin tries to break the containers (after the snoop option is turned off again) it says that the admin is no owner and will not allow it to be broken. I can assure you that permissions are set correctly and that the options are also correct.

    To overcome this issue.... I have had to install a sign editing plugin and use command /set sign 1 openme (example) of which will remove the [Private] Line or i can also do this by editing the username on 2nd line.

    Is this a normal thing? if so, is it possible to add a feature to your next update which will optionally allow ANY admin or op to break and destroy the containers.?

    Looking forward to your resoponse.

  24. Offline


    Edited config to turn snoop on
    /lockette reload
    Snooped container A owned by another player
    Edited config to turn snoop off

    /lockette reload
    Broke the lock on container A

    As you can see, I enabled snoop, used it, turned if off and broke a chest lock as you tried to do
    Can you do the following
    • Check your log for an error stack and post it in code tags if there is one
    • Give more exact steps on how you caused the bug as your method likely differs from mine
    • Attempt my method and see if the bug reoccurs
  25. sure,
    I dont have any error logs for this as none are generated.

    To replicate my issues... (I am OP/Admin with full set of permissions)

    1. Get a normal, NON OP/ADMIN player with standard build right to Create a chest
    2. Make them lock the chest.
    3. then enable admin snoop and admin bypass (after chest was placed and locked)
    4. /lockette reload - or server restart
    5. Try and destroy chest as OP/Admin not working - only allow snooping into the chest via right click.

    As i mentioned previously, only a sign editing plugin will enable any OP on our server to override this.

    If you would like, id be more than happy to issue a youtube video fo the issue if that helps.
    or please join our server
    mc.ukwarfare.co.uk - please provde a response to this post if you wish to join so i can add nessesary permissions.

    I have recently removed lockette completly, and reinstalled the plugin but to no avail the bug still stands.

  26. Offline


    I've repeated your steps and I am still capable of breaking the lock, I'd like to connect and try it on your end
    ...that reminds me, Lockette version (I'm assuming 1.3.7 since you reinstalled) and bukkit build, I am running on build 733 as I've seen multiple bugs show up for my other plugins on 740
  27. yeah sure, ill be on the server at 6pm GMT

    im using 760 bukkit build as it has miltiple plugin fixes.
  28. Offline



    For container locks, could you add the option of making a sign with [Protected] so that people can see what's inside but can't successfully take anything from it? Sometimes players want to keep stuff safe but still want others to see what they have.

    I don't know a lot about plugin making, but maybe you could save the contents of the container and the player's inventory upon opening, then load both back when it's closed so that nothing changes? I would love if this worked. :)
  29. Offline


    Been to dunems server and so far as we can tell it's either a conflict between Essentials Protect and Lockette or 760 and Lockette don't play nice
    I'm going with Essentials conflict as it was picking up on the Lockette signs under it's own protection
  30. Thanks to maxis010 coming on our server to help me out.

    I have fixed the issue! It was a confliction with the plugin "OpenINV"

    I simply removed it a checked again, and have no problems destroying any chest protection. I re enabled it afterwards and I dont have anymore issues. I cant explain why openinv would protect anythin tho?
  31. Offline


    Everything was going fine until... Lockette stopped working. The plugin was working and all but yesterday it just suddenly stopped:


    When you place a chest it still shows the message to place a sign headed "[Private]" but when you actually do it it still does not work. I tried reloading it, deleting and re-downloading it but it doesn't work.

Share This Page