[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


    Boxes don't lock and neither do doors
  3. Offline


    Error Stack from the Logs, Lockette Messages, Permissions
  4. Offline


    I suppose that depends on time and inclination, I'm on a break from minecraftings this weekend though~

    Is it physically open, such that you can pass through it, or just visually open? I'll have to check on this later...

    Thanks :3

    I know groupmanager does this automatically, membership in a group means membership in inherited groups. I'm not sure how permissions implemented, as it is more recent. As to the latter, it may be another plugin that only does stuff with wooden doors? Hard to say, let me know if you get more info.

    By details, Maxis ment craftbukkit version, plugin version, other plugins used, console logs. That sort of info.
    "It doesn't work" just means "I can't help you." :3

    Probably the first thing is to check for any [WARNING] or [SEVERE] messages in the console log~
  5. Offline


    Ooh, update for 714!
    This is the most important plugin on my server!
  6. Offline


    Is there an issue with 714?
  7. Offline


    It's not working for me atleast.

    I put a sign above a door, [Private], nothing happens. Just says [Private]. No confirmation message in the chat, as it usually shows.
  8. Offline

    Ethan Thomas

    Can you update it to make sure players with the create.lockette permission is enabled in their group. It seems to not be working for me. Thanks.
  9. Offline


    Say again? The permission is lockette.user.create.* in version 1.3.5+ of lockette, or you can disable the use of permissions in the config file. (lockette.create.* is still supported too.)
  10. Offline


    Ok so this plugin works perfectly----if your an admin. I dont use Permission, but GroupManager, when ever i type in [Private] on a chest, it generates my name, but im an admin. When normal players try to type [Private] it converts to [?], and i have to put the sign on the chest for them. I would apppreaciate if you could tell me how to fix that, many thanks
  11. Offline


    What is wrong it just says no unclaimed container nearby to make private and it does with all things chests furnace
    Then when i log off my server and log back in it shows [?] And my name below it
    What do i have to do????HELP
  12. Offline


    You either need to give them the permission to create private chests in groupmanager, or else turn off the option to use permissions in lockette's config.

    You are probably using a bad craftbukkit build, do you see the warning message in the console log?
  13. Offline


    No it says: [INFO] Lockett: Ready to protect your containers.
    It does not show me any warnings
  14. Offline


    I am very interested in this plugin. However I do need a specific request.
    Only allowing Lockette within a specified worldguard region. LWC does this but I like how elegant Lockette is and would prefer to use it.

    Let me know what you think/if it's possible.
  15. Offline


    Confirmed working well on my CB716 server.

    Is it possible to create "inheritable" group permissions on the signs? Ie. if I put [Default] as a protected group can we allow all groups above that (eg. Admin) to automatically have permission? I know I can add another sign next to it but this can get messy.
  16. Offline


    This has been suggested but not implemented, best wait for a reply from Acru on if it is possible and if it will happen as it's not in the to do list
  17. Offline

    sexy vampire

    i found a lil bug well kinda locketted door stop pets like tamed wolfs form entering home i just had to remove the lockette form the door so my dog can enter my home maby this can be fixed since i know notch some whut updated the wolf ai to make then enter building through doors. ty

    ps i loev this pluggin i find it easery then lwc :)
  18. Offline


    Worldguard? If LWC does it there is probably an interface. I'd have to look into it.

    This is something that GroupManager does automatically. I understand that Permissions added some sort of inheritance too, but it may not work in terms of the inGroup() function provided for other plugins.

    Edit: Permissions does have the function inSingleGroup() so inGroup() should include inheritance...? Have you tried to use inheritance with Permissions and Lockette? It ought to work already, I think.

    You could add a doggie door? A 1x1 passage/tunnel just for Wolves.
    Also you could set the door timer longer, if you are not using a redstone method to open.
  19. Offline


    @Acru , when i make [Private] or [PRIVATE] i can open by clickin but it wont write my name on the sign. I keep the second line blank but it wont and whe i destroy it says andre destroyed a container owned by . No name. Craftbukkit build 714 but it doesnt work since 684.
  20. Offline

    sexy vampire

    no even if the door is left open with a privet on it wolfs cant enter home when tamed enless i punch a wild one
  21. Offline


    Are you putting a sign on the lower half of the door? (Though this shouldn't effect, I'm not certain for Wolves.)

    Perhaps you are just having trouble with wolves getting stuck on the doorjam, which is a minecraft problem.

    Lockette works with MC 1.5 in builds 704+, and I just tested 714 and 720 specifically, and they work for me too.

    It sounds like another plugin may be interfering though. Please list your plugins?
    Also you can disable a few at a time until you find the culprit, and let me know which one it is?

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


    Commandsigns maybe?
  23. Offline


    Does Lockette work okay when you disable commandsigns?
    If so, what version of commandsigns are you using?
    If not, try disabling other plugins.
  24. Offline


    I am GMT +1 so i will try tomorrow.
  25. Offline

    sexy vampire

    lol your right sory no bug :D
  26. Offline


    Nevermind, working now. I don't know how tho.
    Also, me and the players on my server got some stuff we wanted to let you know of:

    Make the doors/chest(I don't know about the doors, but according to my players, chests are unbreakable, but I'm an admin so I can't confirm), doors and chests shouldn't be able to destroy.

  27. Offline


    Acru, Afforess added support for Lockette locked chests in Minecart Mania 1.1.0 (if that's what Minecart Mania Chest Control being listed as a conflicting plugin is about):
  28. Offline


    All private items are unbreakable, unless you have the lockette.admin.break permission.

    Ah, news to me~
    Hadn't heard back from him personally yet.
    Good news. :3

    Also whoever it was who posted and then deleted their post;
    I tracked the problem down as far as MinecartManiaAdminControls 1.1.0, so I'll have to talk to @Afforess about it.
    I'm just trying to trace the problem in more detail first.

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



    Not to be a pest... I'd love to see with the door protect the ability to protect X blocks from the doors from "breakin"
    (at least 2 high to match the doors)

    The sign config:
    [private 10]

    ====> 10 blocks on both sides (20 in total) is protected from breakage.
    People can add as many or as little (o) as they want
    BUT the sign has the block # hidden on viewing (That way random griefers can't see how many blocks you've chosen to protect.)

    The sign viewed

    Is any of this possible?

  30. Offline


    I'm afraid this is not possible without an expensive search.
    What you want is more in the realm of a cuboid-type plugin.
  31. Offline


    We have worldguard & bigbrother, I was looking for something a little less intensive, and for small areas :)

    Q: Expensive Search, sorry, as in, a search for code?



Share This Page