[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


    Hum, yeah, I've just been busy with other things, I had a friend watching the thread for breakages needing my attention though...

    He just informed me of this. o3o

    I just want to make it clear that if Lockette were to actually break, I'd definitely fix myself. It just had gotten to a stable point and didn't need any real extra bells and whistles. Except hatches, which turned out to be a more complex issue than I thought...

    Though I'm a bit out of touch in where permissions have gotten to in the last while.

    PluginCore is the common code between Lockette and my other plugin. At this point I am looking into the new permissions systems myself, so It looks like Lockette will be revived. (Inactive doesn't mean broken btw, it just means I haven't updated in a while~)

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

    Nathan C

  4. Offline


    Mind you, you coulda tried starting a convo anyway, I would have gotten an e-mail~ o3o

    Yeah, I put Lockette aside, but I haven't forgotten it either~

    The recent activity has made me pick up the project again, though, heh.

    I would have to warn you that daemitus's version is not based on the 1.3.8 source, but rather is a rehash and I cannot personally speak for its reliability. :3

    Perhaps there is nothing wrong with it, and it might be better in some ways, but I just don't know. XD

    On a related note, it is September again, and I hereby promise an update for Lockette to version 1.4 in the next week.

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


    No offense but I like the new one better...
    The code has been reworked and is a lot cleaner, not to mention a couple bugfixes in the process.
    Then again you havn't been around so you could've done the same and maybe better :p
    Either way, my vote is to keep both (maybe change the name of the new one) and let people decide.
  6. Offline


    W00T! Nice to see you on the forums again, Acru. [I donated a month or so back, a financial poke :)]
    For the record, I can't find any more bugs in daemitus' build of Lockette (1.1).
    Your Lockette version (1.38) seems to be weak to redstone activation in RB1060 (in my experience).
    Rewrite it at your leisure, but please consider the groundwork that has been laid already.
    No need to re-invent the wheel again, I would hope. {daemitus' Lockette logo on BukkitDev is pretty good too}
    But a new Acru Lockette build would save Acrobot and SouthPaw from having to rewrite part of their plugins (ChestShop and Cenotaph, respectively) to accomodate the newer build(s).
    Anyway, Welcome Back! (to the Funny Farm)
  7. Offline


    Doesnt seem to work with PEX (permissions EX plugin), it defaults to only OP's being able to open chests with it, but somehow people can still open locked doors?, any insight into why that is?, running CB 1060. and lockette 1.3.8
  8. Offline


    1.3.8 has no support for super perms. Best guess, you need to use PEX and whatever options it has for the old permissions 3.x or whichever.
  9. Offline


    I second that, daemitus' code is much cleaner, with more features, less bugs and probably more efficient.

    @daemitus, if you are to change the name, my suggestion is LockSigns :)
  10. Offline


    I love both versions.

    But id say just rename you version daemitus its always nice to have a choice of systems to use incase the plugin developer decides to up and leave for months at a time.

    @Acru, Love the work and all, but would a quick post a few weeks ago kill you? Or even a post from your friend.

    Theres no reason to login after a few months getting all but hurt about someone stepping up to help the community.

    To everyone else who stepped forward to support the community nice work.
  11. He really isn't butthurt. Learn to read.

    Secondly, for those who keep saying the code is "cleaner", decompiling does not produce the original code, it produces COMPATIBLE code, and that's all it does. I do not doubt daemitus has done a great job optimising methods and improving compatibility.

    There are licensing issues involved here too, but Acru doesn't appear to be too bothered. I'm pretty sure the two will work together so there's no duplication of effort.
    Southpaw018 likes this.
  12. Offline


    [EDIT] Hopefully a fork can be avoided

    By the way im a minor contributor to the project, Daemitus is the author.

    Keep reporting bugs, I will also try to read this thread more often. One or two feature requests would be nice for the new version, but please dont make the same request 100 times. At the moment and probably for ever PermissionsBukkit and the op list are the only systems availible, but the op list may be expanded to a more complete internal permissions file.

    Again thanks for all the support.

  13. Offline


    Theres a fully fleshed out super perm list, which permissionsbukkit, pex, bperms, etc all hook into. Not using that, the permissions in plugin.yml all have op or everyone defaults as necessary. Since super perms are the 'wave of the future' however, and even ninjiko is dropping perms3, dont expect it. atleast not from me.
  14. Offline


    I did but i didnt mean in the sence i think you are looking at it i ment upset (Butt Hurt - To become offended or upset)

    Anyhow lets hope both partys find a way to resolve so everyone is happy.

    How about Locket, LocketteXL, VampedLocket
  15. Offline


    This is my config file, i didn't change anything around.
    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: false
    allow-admin-bypass: true
    allow-admin-snoop: false

    The sign was above a iron door, and i placed [Private] so i only have access to that door and then all the other people in the server could open the door. I also tried placing the sign below the door and people could still open it. Maybe some plugins are conflicting with your plugin idk? Please reply

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


    I third that. Or you could probably work on the project together. It's up to you.
    Actually, have you added in the famous 'secret door' thingy that lockette has?
    Blocks are in front of a door; right-click it; the blocks dissappear and the door opens.
  17. Offline


    Don't know if you noticed, but I suggested LockSigns. I love when the title says it all ;)
  18. Offline


    I would prefer that a fork be avoided, if at all possible. I see that @daemitus has on the BukkitDev page that he and @Acru are hashing things out. I'll wait for their official announcement here on how Lockette is proceeding.
  19. Offline


    Permissions don't seem to be working correctly with this, I have all the perms written down, been a problem for a while with me. I did check use Permissions to true, yet none of my members can use it only admins.
  20. Offline


    Hmm skycar like daemitus im also not quite sure of this. It looks like you were using this when it was still slightly less stable. 1st of all I would suggest deleting your Lockette/ folder and trying again, as your config file seemed out of date /incomplete.
    Also are you using superperms or the op list because your permissions might be set up wrong or all your users are ops (very bad idea)

    If none of these work maybe P.M Daemitus or I the server i.p so we can see for ourselves.

    Unfortunately I could not recraete any of these. Please update and delete your current config to get the latest options.

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


    If youre coming to this thread with issues, because of the confusion that having 2 plugins in the same thread, you need to specify exactly what jar youre running.

    We already fixed that. It was the sign cast issue.

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


    Yeah that was my fix :)

    And error :(
  23. Offline


    Personally, I'm glad @Acru came back, I understand people wanting to elaborate and make this plugin better to "revive it" but in all honesty no one else has come close to making a chest locking plugin with no databases, none. This is the main selling point to this whole plugin, the simple elegant solution to chest locking using very little to no resources.
    The only plugin similar to this is WorldGuard, it has a chest locking feature like this, but it fails hard and was never truly "implemented properly". Again, I reiterate, I'm glad Acru came back, he was initiative enough to make something so unique and resource saving.
  24. Offline


    Hi, I can't wait for this stuff to get sorted out.

    BTW I just found this competitor which looks like Lockette + Wordguard combined. I have no idea how good it is though. http://dev.bukkit.org/server-mods/alerter/
    One idea from it: coloured writing on signs and lever/switch protection :)
  25. Offline



    Get enough of your Terraria addiction? haha
    (Seen you post on Terrarias forums)
  26. Offline


    Please bring any issues regarding my work to the above locations.
  27. Offline


    nvm i fixed i just had to change something in the config file :D
  28. Offline


    Thats all good. Just a reminder as above, the new lockette is now Deadbolt so post issues there.
  29. Offline


    Not necessarily the 'new' lockette. Acru is still going to update. Just something different.
  30. Offline


    Well, as I haven't been playing minecraft any for the last while, (blame Terraria for part of that, hee), I just haven't given it much thought~

    In any case, I want to ensure that the project can be continued without me, but I want to add a couple things of my own first. :3
  31. Offline


    so its inactive? oh come on honestly this is my favorite plugin really really helpful

Share This Page