[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


    Does this work with permissionsbukkit?
  3. I think I have found a bug with the Plugin "Cenotaph"
    (It places a sign in the top of the Chest)
    With Diamond Tools everybody on my Server can destroy the signs
    Bukkit Build #1000

    I hope for an fix, Thank you!
    (Sorry for bad english...)
    greez h2o
  4. Offline


    Is there away to make it where OP's can't bypass the Private items? I'm hosting my server and I'm tired of my friends bypassing it. But I don't want to deop them
    Is there away I can change the settings to do so?
  5. Offline


    Heyia, any chance of in-bukkit permissions support for groups/etc?

    Also, I've noticed with auto close doors on, sometimes doors bug out and think that the open state is closed, so they default to open after 30 seconds ago... I've only encountered it with double doors, but it could also happen with single doors. Let me know if you need any additional information.

    I've placed the Lockette sign with the doors closed as per the first post.
  6. Offline


    Can we get

    1. Snoop receive: permission node ?
    2. Multiple Groups to show msgs too in the config: I tried "groupa,groupb" did not work.
  7. Offline


    Can you add in the config so we can disable chest protection/locking?
  8. Offline


    Create groupc, add everyone from groupa and groupb to groupc, set groupc as the target
  9. Offline


    You mean a fake group in permissions that everyone is apart of no thanks.
  10. This also works with CB #1000, title should be updated :p
  11. Offline


    I would really love to have this feature!
  12. Offline

    James Lawrence

    The new server I started, new box, new files.

    When I place double iron doors they won't place shut... one door is always places open so I can't use the plugin on iron doors. If I use a switch to close the 1 door, place the sign, remove the switch, it opens that one door then the doors alternate open/close close/open never close/close or open/open

    it's really annoying. I know it's not the plugin doing it, I've removed ALL plugins so even just running the basic server without the plugins it still places them this way.

    I'm not posting to say the plugin doesn't work, I'm posting to ask if anyone else has the problem and knows a way around it so I CAN use this plugin... get it?

    RB#1000 no plugins or only Lockette
  13. Offline


    If you want multiple groups to be the target then you have to add everyone from those groups in to another group and set that as the target, there is no other way at this time
  14. Offline


    A couple of bugs:
    -ANY block with a sign placed on it cannot be destroyed.
    -When writing on signs, the first few characters typed will be erased and you must start over.

    Anyone else getting these?
  15. Offline


    I'll just leave this here
    - <3 nala
    18:11:56 [SEVERE] Could not pass event PLAYER_INTERACT to Lockette
            at org.bukkit.craftbukkit.block.CraftSign.getLine(CraftSign.java:24)
            at org.yi.acru.bukkit.Lockette.Lockette.findBlockOwner(Lockette.java:915
            at org.yi.acru.bukkit.Lockette.Lockette.findBlockOwner(Lockette.java:874
            at org.yi.acru.bukkit.Lockette.Lockette.findBlockOwner(Lockette.java:756
            at org.yi.acru.bukkit.Lockette.LocketteBlockListener.rightclickDoor(Lock
            at org.yi.acru.bukkit.Lockette.LockettePlayerListener.onPlayerInteract(L
            at org.bukkit.plugin.java.JavaPluginLoader$10.execute(JavaPluginLoader.j
            at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.jav
            at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.j
            at org.bukkit.craftbukkit.event.CraftEventFactory.callPlayerInteractEven
            at net.minecraft.server.ItemInWorldManager.interact(ItemInWorldManager.j
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:553)
            at net.minecraft.server.Packet15Place.a(SourceFile:57)
            at net.minecraft.server.NetworkManager.b(NetworkManager.java:226)
            at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:85)
            at net.minecraft.server.NetworkListenThread.a(SourceFile:105)
            at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:451)
            at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:361)
            at net.minecraft.server.ThreadServerApplication.run(SourceFile:422)
  16. Offline


    That was why I requested the feature many plugins can check via ininheritance or at least offer usage like "'Player1,Player2'" thanks for taking the time to respond but for now I will just leave it as the one group, Tho I possibly merge our Vice admin's to a subgroup of Mods hmm that could work, tho I thought that would count as a part of a ininheritance chain.
  17. Offline


    I am getting a lot of reports that the signs get cleared out. Anyone else seen / have this issue?
  18. Offline



    Check out codename_B's bShot, a patch-plugin for the sign/chest bug. Lockette was included in his tests and he has no sign or chest-wiping.
    Digi likes this.
  19. Offline


    OK, you seem to be miss understanding me if you are considering merging for this
    Permissions 3 supports MULTIPLE groups per user
    So I can be part of SuperAdmin and Lockette groups at the same time
    SuperAdmin for permissions, Lockette for the casts
  20. Offline


    hmmm I never tried that and I don't know how well that will go down when trying to link this to Mybb
  21. Offline


    :confused: Any ETA on next update to support hatches and other features/bugfixes? Been awhile since this plugin has been updated and I don't really want to move to LWC just yet, but will if I have to.
  22. When i or other users try to lock a chest, we all get the error "permisson to lock container denied"
    But im Admin and have a possible permissons, how is this possible?
  23. Offline


    Dude how do i delete the messages that pop out when i snooped, or a broke something. I tried deleting the text from the strings file, but i just put it back.
  24. Offline


    Hiya James. My users noticed this bug on my server too, running 39 plugins under RB#1000.
    I found a way around it. I placed a redstone torch behind the rightmost door to prop it open, then
    put the lockette sign down in front of it. When i took away the torch, the doors stayed together (as Lockette overrides redstone/switches). Hopefully this will work for you.

    I have a rather more annoying bug I wish to report: I can no longer seem to place Lockette signs ABOVE or BELOW doors, only ON (in front of) them. Everytime I try to pplace one above (or below), i get (?) and "Conflict with Existing Lockette" (despite the absence of same). Annoying, but I can work around it. Existing doors still work.
    [It is likely this is caused by another plugin, maybe Cenotaph or ChestShop? I will investigate...]

    On another note, using Perms3.15b I observed that Group Permissions on a sign (eg. [Explorer1]) are inherited, meaning that (in the example) all groups that inherit from Explorer1 can also pass. This is a VERY handy feature I am exploiting on my new server world Tartarus {Explorers (no build) vs Engineers (no money)}.

    And on a final note; THANKS ACRU for (all the hard work and) an amazingly useful plugin! I hope you manage to add hatches, but even without, the value of Lockette on my server(s) is inestimable! :D
  25. Offline


    is there a way i can limit how many doors 1 person protects?
  26. Seems Lockette doesnt work anymore on my server people cant go in their own chests...
  27. Offline


    My favourite plugin. It's awesome :))
  28. Offline


    This is my problem. I can bypass doors but I cant get in anyones chest and im OP. Do you know what wrong?
  29. Offline


    Anyone here planning on taking over the Lockette project in the near future? It looks like our friend has left us for good :(
  30. I want to make it so when Admin snoops into a chest or opens a door, it would not broadcast the "(Admin) ibab has snooped into a chest owned by a palyer!"

    Heres my config.
    enable-messages-help: true
    broadcast-snoop-target: '[Everyone]'
    broadcast-reload-target: '[Operators]'
    broadcast-break-target: '[Everyone]'
    enable-messages-error: true
    enable-messages-user: false
    enable-messages-owner: false
    enable-messages-admin: false
    enable-protection-doors: true
    default-door-timer: 0
    explosion-protection-all: false
    enable-permissions: true
    allow-admin-bypass: true
    allow-admin-snoop: true
    I tried turning all of those enable-messages-user, owner, admin and etc to false, then used the /lockette reload, but it sitll gives those messages. How can I get rid of them?

Share This Page