[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


    My server is really a small one and if i just switch protection the people there will get robbed and griefed like mad.
    (I dont understand why but people like to grief small servers... ALOT)
    I cant go around and replacing each sign for them because every one builds so far away from each other and most even hide there houses. Also, I have iconomy chest shop and the protection on those chest and signs wouldnt work any more so that would make that plugin useless also.
  3. Offline


    Well give your users the ability to place Lockette signs
    last I checked there was no conflict between them so install Lockette, and have your users create protection signs for their stuff, give it about a week, after that if they get robbed for not shifting their protection that is their fault
    Meanwhile experiment with an empty shop, see if Lockette protection works for that plugin
    If it doesn't then that is down to you to handle
  4. Offline


    OH crud.. the reason im switching is because lwc causes my member's clients to crash.
  5. Offline


    Does this expect utf-8 files and fails if they aren't?
    My server provider only allows to edit the files with a website, so I can't create UTF-8 files.
    After I updated to 803 and Lockette 1.3.8, Lockette stopped working.
    No exception in the console - it was enabled just fine.
    /lockette did nothing.
    Placing signs did nothing - I just had a normal [private] sign without functionality.
    After I removed all characters over ascii 127 - e.g. Privé => Prive etc, and a /reload, lockette worked again.
    Don't catch Exceptions and ignore them if they prevent Lockette from working. At least do a System.out.println.
  6. Offline


    OK, I don't know how the LWC db is structured but you should be able to retrieve the location and names for all of the chests
    Search for an SQLite database reader and open the db file or connect to your MySQL server and find the table you need
    Get a teleport plugin that can handle coords (Tele++), lock down your server (Enable whitelist with only your name) and Lockette each chest for each user

    I can't check right now but I'm sure Lockette had ASCII 127+ charecters in the default config and it loaded just fine for me
    If I'm wrong then just ignore me but if I'm right then look for your problem elsewhere

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


    You may be right, as I didn't bother to test it once it worked, but I had multiple reloads and restarts and it didn't help, but it worked once I removed this characters.
    Also I know from another plugin, that my Windows test server behaves differently than the hosted mc server on a config file that's not UTF-8 - i.e. the windows server worked, but the hosted linux server didn't.
  8. Offline


    I'm new to servers and modding alike so please excuse my little knowledge on the subject. I downloaded this mod this morning, all works well apart from the fact that all ops can break the signs? Is this intended or am I missing something?
  9. Offline


    Yes, it's supposed to work like that. Ops are considered trusted. How else would you allow ops to handle problems, like someone stealing from someone else and placing it in his chest etc.?
    You can specify with permission who is allowed to snoop in chests or use protected doors, however, they can always break the sign. but you can have messages broadcasted to all if they break, use doors or snoops in chests.
    Also note that any plugin directly manipulating blocks, like WorldEdit, can break signs without a message.
  10. Offline


  11. Offline


    It is hard to deal with plugin conflicts with so many plugins and versions out there, along with many builds of bukkit. The best I can do is try to deal with cases as they arise.

    Do you mean you are having trouble with the 2.7.4? As that one seems to be working for me with Lockette 1.3.8 and bukkit 803. Perhaps there is another factor involved. Is your java runtime up to date? Does the problem occur with the default permissions config?

    I think he meant some sort of inter-plugin connection, but in theory the other plugin could un-cancel the the interaction event at the highest priority, with no changes needed to Lockette.

    Ahwell. If it works, it works. :3

    In theory, if the permission plugin you are using supports having users in multiple groups, you could setup a specific group for the alerts. But in any case, do you have a specific reason for needing?

    As Maxis said, your best bet is to use both, or bite the bullet and reprotect everything. There is no way to do move from one to the other automatically. I can't really help you with a crashing LWC db though, heh.

    Lockette uses UTF-8 because Bukkit and the built in snakeyaml library uses UTF-8, a different format might cause an exception within bukkit. A utf-8 text file with no special characters is just ascii though.

    Are you using a McMyAdmin hosting service? I know that one tends to eat console messages.

    See ToastedJelly's post above. But yea, regular users shouldn't be op'd, and if you need more control you should use a permissions plugin.

    That plugin seems to be inactive, though?
  12. Offline


    it is?
  13. Offline


    Don't forget to edit the quote for what you are replying to. See what you did above? lol

    Incidentally, I ran though the basic series of tests with bukkit build 818, and I am satisfied enough that everything is still working okay, for once~

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


    Any chance of this plugin working for hatches / trapdoors ?
  15. Offline


    There is a chance.

    I did some testing with, and it seems that a hatch is attached to the side of a block similar to how a regular door is placed atop a block. If that block is removed, the door/hatch is too. Unfortunately, it is a new type of case that would need to be dealt with, and also I'm not sure if bukkit has full event support for them yet.

    Probably it can wait a bit anyway.
  16. Offline


    Well I have an Owner group and an Admin group and I just wanted it so that both could see the messages. I'm considering getting Permissions 3.0 which has multigroup support but apparently some plugins aren't compatible with it yet.
  17. Offline


    Thanks. Hatches are a dream in my castle, only they let people into private areas!
  18. Offline


    If you go to the last post of Factions there is a new version linked, the original author is gone, someone new picked it up
  19. Offline


  20. Offline


    Heyia, I'm running Lockette 1.3.8 on CB818 and whenever I try to create a protected door I receive the following:

    Lockette: Conflict with an existing protected door.

    Even if the door in question is nowhere near another door or chest. Any ideas?
  21. Offline


    Very happy to wait ... but would love to see this in a future version.
  22. Offline


    Hi, this is my first post on this forum, I've been running a server for a week now. I was wondering if it was possible to restrict the use of this method of protection to certain permission groups or OP only?
  23. Offline


    Does this still happen after restarting the server?

    Only people with the lockette.user.create.* permission can create locked chests for themselves. Ops can create chests for others with the lockette.admin.create.* permission.
  24. Offline


    how can we remove explosion protection for all containers, even private ones?
  25. Offline


    Yes it does.
  26. Offline


    You can't, exp protection on protected containers stops people breaking in by blowing the sign off or the chest open
  27. Offline



    I like the way the double doors work in your plugin, would it be possible for you to make another plugin that has that feature only? I like using double doors in all my builds but I hate having to lay down the extra redstone and inverters to get the doors to open at the same time. I'd like to be able to just put in the doors, throw down some pressure plates or switches and have both doors open with activated.

    Just a thought.......

  28. Offline


    How do we turn off exp protection completely?
    explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    On= All containers, Off= Only private ones. What I want is None= No explosion protection whatsoever.

    Because in my server there are cities, and people have their own stuff, but when the city gets attacked, the attackers must be able to open the chests up somehow.
  29. Offline


    I have already said to you IT CAN NOT BE DONE AT THIS TIME
    Your only option without the plugin being modified is to have someone with the break permission open the chests or have all the chests assigned the [Everyone] tag or whatever group name your attacker fall under if they are a specialist group
    That or assign mods to break the chests on call
  30. Offline


    Ok, thank you very much.
  31. Offline


    Love it! Seems to work great on CB 819

    I would suggest one thing..

    Allow signs to be set one/two blocks below the chests and doors. Like redstone or minecartmania signs.

    I'd like to be able to hide them. Players on my server don't like using the door locking because of how they look. If we could put them in hidden places, it would get a whole lot more use.

Share This Page