[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


    The range is ok, since you have the last compatible listed ;)
  3. Offline


    I tried that and my Groups.yml looks NOTHING like anything on that thread.
  4. Offline


    I know that GroupManager also supports Permissions style configurations, if you're using that form. Best to learn how to use GroupManager in any case, if you are going to have it installed. (The other option being disabling that plugin.)
  5. Offline


    I'm sorry if someone has pointed this out and I didn't see it >.<

    Theres a way to get past doors :(
    If you "break" the door, it'll come back of course but in the open position.
    Other than that. I love lockette <3
  6. Offline


    This was broken by CB build 561 (wooden doors only) and was fixed in Lockette version 1.3.4, so you ought to update. :3
  7. Offline


    Lockette doesnt work for me! i use craftbukkit[670] and it doesnt work! D:
    i place sign saying


    And it doesnt apply to the chest, i've tried with doors, furnaces and dispenser too, it simply doesnt work.
    Is there something i do wrong?
    it worked at version [617] but then i updated.
    Does anyone else have this problem?
  8. Offline


    You only need to type [private] on the first line, if you are an Admin and you type something on the 2nd line it overrides the default which is your name, you use that to claim chests for other people
  9. Offline


    is there a way i can use it where admins CANT bypass door locks? if not could you do something like, add something in the next updates config file, something like. Admin_Bypass_Door: True/False? im horrible with permissions...
  10. Offline


    PM me with a list of groups you want, how you want your users divided in those groups and the plugins you have, I'll go through them, pick out the permission nodes then send you a set of yes/no questions for each group
    You answer those questions and I'll build a permissions file for you with comments to help you learn more about permissions

    I know it seems like a lot of work for both of us but in the long run it's better for you as you can get some understanding of permissions by looking at that file and then you can modify it as you install more plugins that use permissions
  11. Offline


    No, it still doesnt work... there is something wrong D:
  12. Offline


    There should be a message when you place a sign, either about permission or about container not found. (Assuming error messages are enabled in the config.) If it is permission, then you are using either Permissions or GroupManager plugins, and you need to give yourself the lockette.create.* permission.
  13. Offline


    Ok, so I put the lockette thing and still can't.
    Did I add it in right?

    default: true
    - essentials.help
    - essentials.helpop
    - essentials.list
    - essentials.motd
    - essentials.rules
    - essentials.spawn
    - lockette.create
    inheritance: []
    prefix: '&e'
    build: false
    suffix: ''
    default: false
    - -groupmanager.mantogglesave
    - essentials
    - essentials.clearinventory
    - essentials.cooldown.bypass
    - essentials.deljail
    - essentials.give
    - essentials.god
    - essentials.heal
    - essentials.heal.others
    - essentials.invsee
    - essentials.item
    - essentials.jails
    - essentials.kickall
    - essentials.kit.*
    - essentials.mute
    - essentials.sell
    - essentials.setjail
    - essentials.signs.protection.override
    - essentials.spawmob
    - essentials.teleport.cooldown.bypass
    - essentials.teleport.timer.bypass
    - essentials.togglejail
    - groupmanager.*
    - essentials.burn
    - moderator
    prefix: '&c'
    build: true
    suffix: ''
    default: false
    - essentials.afk
    - essentials.back.ondeath
    - essentials.balance
    - essentials.chat.shout
    - essentials.compass
    - essentials.home
    - essentials.kit
    - essentials.kit.tools
    - essentials.mail
    - essentials.mail.send
    - essentials.me
    - essentials.msg
    - essentials.nick
    - essentials.pay
    - essentials.portal
    - essentials.protect
    - essentials.sethome
    - essentials.signs.buy.use
    - essentials.signs.disposal.create
    - essentials.signs.disposal.use
    - essentials.signs.free.use
    - essentials.signs.heal.use
    - essentials.signs.mail.create
    - essentials.signs.mail.use
    - essentials.signs.protection.create
    - essentials.signs.protection.use
    - essentials.signs.sell.use
    - essentials.signs.trade.create
    - essentials.signs.trade.use
    - essentials.suicide
    - essentials.tpa
    - essentials.tpaccept
    - essentials.tpahere
    - essentials.tpdeny
    - essentials.warp
    - essentials.warp.list
    - essentials.worth
    - default
    prefix: '&2'
    build: true
    suffix: ''
    default: false
    - essentials.back
    - essentials.ban
    - essentials.banip
    - essentials.broadcast
    - essentials.delwarp
    - essentials.depth
    - essentials.eco
    - essentials.getpos
    - essentials.jump
    - essentials.kick
    - essentials.kill
    - essentials.setwarp
    - essentials.time
    - essentials.togglejail
    - essentials.top
    - essentials.tp
    - essentials.tphere
    - essentials.tpo
    - essentials.tpohere
    - essentials.tppos
    - essentials.tptoggle
    - essentials.unban
    - essentials.unbanip
    - essentials.whois
    - essentials.world
    - groupmanager.listgroups
    - groupmanager.mandemote
    - groupmanager.manload
    - groupmanager.manpromote
    - groupmanager.mansave
    - groupmanager.manselect
    - groupmanager.manuadd
    - groupmanager.manudel
    - essentials.ext
    - builder
    prefix: '&5'
    build: true
    suffix: ''
    default: false
    - '*'
    - semiadmin
    prefix: '&4'
    build: true
    suffix: ''
  14. Offline


    First, when adding logs/configs, you should use the Code button in the editor, so it can be read easier. :3

    Looking at it though, you missed out the ".*", the line should read "- lockette.create.*", and it should work once you change to that.
  15. Offline


    How do I do the code button and I added what you told me still permission's denined...
    Do you have TeamViewer?
  16. Offline


    It is the second last button, on the line starting with the bold button, in the message editor.
    And you added it without the quotes I hope? :3
    I'm not sure what else to tell you, if you still can't figure it out.
    *looks up team viewer*
    No, I don't have that.
  17. Offline


    I'd like to make a special 'group' sign with no owner listed. Of course this would only be modified by an admin. But right now, for any doors or chests that are special "VIP" only, it currently says [Private] [Greylocke] [VIP]. I don't want my name all over town on doors and chests, and it is confusing to players because it looks like the doors are all mine.

    I'd prefer that the signs look something like [VIP] or [Group] [] [VIP] or even [Private] [Group] [VIP].

    Is there some way to get my name off the signs? Or could you add the ability to make a special no-owner "group" sign?
  18. Offline


    Technically, with the lockette.admin.create.* permission, you can currently put in whatever you like on line 2 when you place the sign, as long as it is not blank.
  19. Offline


    Thanks for your help Acru! :D

    This caused a few hours of grief for me, ended up having to create a new group with permissions, and restructure the inheritance in the new base group. :D
  20. Offline


    I wonder to myself if there is a possible way to link this with towny and only allow residents to access a chest kinda like a community tools chest or something. Seems possible but maybe not worth your time, love the plugin none the less!
  21. Offline


    It still doesnt work, im the servers owner and i have made a group with the lockette.create.* that everyone is in, and it has intherance to everything :(
  22. Offline


    Brilliant! I knew there had to be a way!

    Now my signs say [Private] entry for [VIP] only! :D
  23. Offline


    Yes I did can you please download Team Viewer and check it out for me?
  24. Offline


    Glad I could help~

    That really depends on if Towny has hooks other plugins can use. :3

    Edit: I looked a little at the thread and the code on github, and though I didn't see anything apparently intended to be publicly available, there are a lot of public functions. This was probably not intentional though~ :3

    I'll need more info than 'it doesn't work', if you want me to be able to help you~ What does it say in the log on server start up? What message if any is sent when you place a sign, and do you get a [?] tag on the error? Which permissions/groups plugins do you have installed, more than one? Stuff like that.

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

    Mark PROT

  26. Offline


    Okay, I still don't understand what you are saying in it, but I'll update the link. :3
    As a Canadian, I learned some french in grade school, but I've forgotten nearly all of it~

    Pamplemousse o3o
  27. Offline


    Is there anyway to get rid of the message that pops up saying "This person snooped around in a container owned by other person" ?

    Or atleast so this message doesn't pop up when mods or admins snoop?

    Its really quite annoying everyone knowing that I'm checking up on their chests.
  28. Offline


  29. Offline


    If the above hurts your head like it does mine. :D One of the work arounds that we have come up with is to use group manager and use a sub-group, so it's hidden, but the permissions are available.

    It's basic & generic, but the group setup can also be used for other things as well. Used in conjunction with CommandSigns, the town members can add themselves to the sub-group, so admins are not required. The sign would need to be well hidden so as griefers don't sign themselves up to a town to steal the chests.
  30. Offline


    Well what it did was that the sign didnt attach to the chest, and it did give me a message saying "Place a sign beside or infront of a chest to lock it" it has some incompatbility with EssentialsGroupManager i think. at once i deleted it then it worked again...
  31. OOOOOOOHHHHHHH! Thanks! I had EssentialsGroupManager installed. After deleting it was fixed :)

Share This Page