[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 was wondering if you tried creating this with 1000's of chests and checking how long it took to use a chest. The reason I ask is I have 100's of users and they would fill the chests really fast.

    But I think this mod is way nicer then having a normal chat command lock system since now you can see who exactly owns it and such I assume?
  3. Offline


    As this plugin doesn't use a database, the time to use a chest is the same no matter how many millions of locked chests exist. The plugin simply checks the attached sign, if any, to see who can access it.
  4. Offline


    wow this is pretty nice then. I will have to use it for sure. This would really beat every chest protect out there. I assume if the name is to long it will use part names?
  5. Offline


    Good question! Currently no, but I've never met anyone who has a name longer than can fit on one line of a sign, which is 15 characters. Does anyone know what the longest allowed username is? If its longer than 15, I'll have to account for it in the next version.
    SentryTheDefiant likes this.
  6. Offline


    We can only add 2 "friends"?
  7. Offline


    @Acru I checked a few names on my server..

    TehHardcoreRaver 16 chars :(

    Also ever consider adding, door protection for fun to prevent people entering peoples houses and maybe vaults and such.

    Heck with your skills id like to see a chest trader shop. There is a couple but they never work well or use chests and signs right.

    Id love to someday see a really good trade sign/chest trade system that worked flawless and know things like the chests full and such.
    jerky404 likes this.
  8. Offline


    For version 1.0, yes.

    I was considering the possibility of allowing user groups in the last two lines, but it occurs to me as well that one could add a second sign for more space, at the expense of simplicity.

    Okay, thanks. It perhaps might be best to always use full names, and those with names longer than 15 chars would have their name wrap onto the third line? Eg, if someone were to make an account 'TehHardcoreRaven', etc.

    I can see how doors might work, along the same principle, but without additional protection someone could just tunnel through the walls. :3

    As for inventory things, I think part of the problem might be bukkit still being in development, and inventory events are still being sorted out. Its only as of craftbukkit 323 that I could prevent chests from being smashed open, for this plugin.
  9. Offline


    @Acru, Very true but we have every block logged when it comes to that and I mean door is simple too but some people just like a private door to start with and just gives more privacy I think. Maybe also it work with some protection systems well that would say not let you break blocks but let certian people use a door eww not a bad idea there maybe.

    I personally since it use no resources allow it since it be just fun to make more private houses and such.

    Now about the names I find that bukkit offers a nice system for /ban batm and it finish the batman part. Now why not do the 15 characters of the name and leave it at that? I doubt if ever anyone would ever have a name exactly 15 characters unless they know each other to start with.

    Anyways I just like the ideas of you making a few plugins because I consider the ideas of using signs truly lightweight and that is what large servers need.
    --- merged: Feb 14, 2011 11:41 AM ---
    EDIT: Just tested this mod and it works flawless.
  10. Offline


    This mod is great!

    May I suggest adding signs onto the chest for adding more users?
    Could provide us with at least 9 more name slots.
  11. Offline


    Yeah, limit 3 players per chest isn't going to work. Also: What would happen if a chest is protected with LWC and Lockette? Would it still work? ALSO! Elaborate on your little "NESW" rule. I've heard of a south/west rule, but only briefly. Post a video of this rule taking effect.
  12. Offline


    And you run your own server?
  13. Offline


    Agreed. I made all names match to the first 15 characters. There will be no problems migrating from 1.0 to 1.0.1, as the names on the signs will be truncated to 15 characters when you reload the server.

    (It seems that you can put any number of characters on a sign, leading to text hovering midair, but only 15 characters will be saved and reloaded with the chunk.)

    Thanks! I wanted to update to 1.0.1 first, with some minor changes, but I'll look into this later tonight.

    This plugin is more geared towards personal chests, so user count will always be limited. I'm not sure how LWC and Lockette would interact, not having tested them together, but it is my guess is that you'd need to have permission via both plugins. Anyone willing to check on this for me?

    For the NESW rule, it just means it will check to the north, then clockwise (east then south then west) when looking for a chest to claim. If it can't find a chest, an error message will be generated. I don't have any experience making videos, though. I hope the updated description explains?
  14. Offline


    I... DO. Hence the banner. And domain name for it.
  15. Offline


    @cjbh1996 I don't think a home hosted server counts :p I think he was just more surprised that you didn't understand one of the basic minecraft plugin standards of NESW checking.

    @Acru thanks for quick reply and updates! a paypal donation link wouldn't go amiss :D
  16. Offline


    As this is my first plugin, I'm keeping a close eye on replies, yea, hee.
    And I had snuck one in at the bottom~ Too subtle? :3
  17. Offline


    I hate you @Acru :p I sent you a small tiny donation then I looked at your @email. I live in Ontario and before Rogers an Shaw worked out a monopolizing deal of the country we use to have Shaw. It seams in the end anyone who has shaw now wins in every way.

    Rogers might be 10 fold bigger but they are all the worst scammers now :(

    Also you guys have this trial going around 1gig internet or something LOL like wth!
  18. Offline


    Ah, that sucks, I don't suppose you have the option of Telus over there, or is it Bell? D:
    Someone showed me this recently, makes me wonder where things are going: http://stopthemeter.ca/

    On the up side, getting close to having version 1.1 of the plugin ready. It adds dispensers/furnaces and more users on additional signs~ They are functional, but I just gotta make it so only the owner can add and remove user signs.

    Anyway, thanks much for the donation~ :3
  19. Offline


    Very nice Acru and yes I know about the site I been spreading the love of it haha. We have bell and such but I don't like them and there just as bad here haha.

    I just want to add that I put a plugin request it might not be something you ever want to do but I posted anyways: http://forums.bukkit.org/threads/trade-sign-chest-plugin.4458/

    I really hope whoever does it will do it your style with signs and such and not by database.
  20. Offline


    uhm.. Maybe a function that reserves the possibility to add a sign but anyone able to open it.. good for example community chests which is used by a large amount of users?

    Just that none can just flop up a sign and they own the box.
  21. Offline


    I really do like this method of chest protection. I have one suggestion. Add a feature to configure how many chests a group can have protected.
  22. Offline


    I could check for a special user name [Everyone], on line 3/4? :3

    As this plugin doesn't use a database, this is impossible. No chest knows of any of the others.

    On the plus side, there isn't any lag issue in having millions of locked chests, opening a chest always takes a constant time.

    I'll have a think about this later, once I've got outstanding issues taken care of in Lockette. :3
  23. Offline


    Well my issue wasn't with a million chests. My server is the expensive type that relies on donations and as a perk of donating you get a vault of chests made with bedrock so you can have more chests than normally allowed. Being able to have unlimited protected chests defeats the purpose.

    Perhaps I could eliminate that as a donator perk and let people have as many chests as they want. Dont know, hard decision.
  24. Offline


    I'm not sure I understand~ How are you controlling the number of chests a person can place, on your server? With a separate plugin?
  25. Offline


    I'm controlling the number of protected chests a user can place. If you were to make 7 chests on my server LWC would only allow you to protect 5 of them. The other 2 would be vulnerable to theft because you would not be able to protect them. If there was no limit on protection then there would be no need to have a private vault that only you can access.
  26. Offline


    Done and done!

    I see... I'm afraid I can't help you there with this plugin, not having any per-user tracking in it. Its up to you if you want to use it anyways. :3 Though it occurs to me that one could cap the number of place-able chests allowed per user as well, with a plugin that does have a user database.
  27. Offline


    I'm sorry this is such a dumb question. I finally decided to install bukkit today, and I got that up and running. I'm just not sure how to use this with it. I installed the craftbukkit. Could you please tell me how to add this or link me to a post? Thanks and sorry for the trouble.
  28. Offline


    If you put Lockette.jar into the 'plugins' folder, it will be loaded automatically. The plugins folder should be in the same folder as your craftbukkit.jar file. :3
  29. Offline


    Thanks for 1.1 I can't wait to try ;) Will see how things go I can't wait to see what other things you could add and expand to this wonderful plugin system.
  30. Offline


    Ok thanks for dealing with my ignorance, and great plugin! Much appreciated!

Share This Page