[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


    Personally I use Towny, I don't let towny protect the chests, that is up to the player to do. Use Towny/WG/PS and dont protect chests with it.

    You understand what I was saying about all the cart/hopper/chest machines breaking server-wide if we implemented your idea right?
  3. Offline


    I totally understand your problem but why can't you add this as an optional feature so that every server owner can decide on his own if he want to protected locked chests from hopper minecarts or not?
  4. Offline


    I don't think he's a Lockette dev.
  5. Offline


    Not a dev, but part of the team.

    I'm just passing on what Elgarl and I decided was the best course of action. Monitoring every locked chest for hopperpull events would probably get pretty resource heavy. If its such a problem then you might want to just remove hoppers and hoppercarts from your server.
  6. Offline


    Yes it's true monitoring every hopperpull event is very resource have but my solution isn't resource heavy.
  7. [BUG]
    I would like to report a bug that breaks the function lockette.
    If you put a minecart track with funnel on the chest with lockette, it is possible to steal all items.

    With hopper, lockette is dead!

    SOLUTION FOR HOPPER PROBLEM::: http://dev.bukkit.org/bukkit-plugins/friendlyhopper/

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


    What about... To fix the hopper thing, only hoppers that are locked under the same name can interact with locked chests, and can only place blocks into locked chests of the same name.
  9. Offline


    I have found a bug in the plugin: If you place a Minecar with Hopper they fall all the things of the chest protected to the minecar and it is possible to steal the chest.
    Thank you for his attention, I Hope that it fixes up.
  10. Offline


    Is lockette really inactive? Any plans to update it? Sorry if I missed a note, I didn't read the whole thing because I don't have so much time at the moment.
  11. Offline


    Is this never going to be updated to 1.6.4??? I know it still works but an update would be good.
  12. Offline


    ok i like this plugin but will you ever get it to work with ChestShop? otherwise is there a way to disable it automatically adding the [Private] text and wouldn't that fix the issue?
  13. Offline


    /i know it is still early however lockette does seem to be working with 1.7.2 and craftbukkit dev builds however redstone doors do not work if a sign is placed on them.
  14. Offline


    thanks for letting us now its working mostly 100%
  15. Offline


    I'd like to be able to change the color like instead of having "[lockette] place a sign headed [private] next to a chest to lock it" i'd like to change the color to blue instead of yellow, it really drives me nuts when i can change the text color of some plugins and not others, it makes for a ugly looking chat,please add support for me to change the chat color, and who really wants to have the same chat colors of every other server out there.
  16. Offline


    You should put on the brewing Stands
  17. Offline


    You can add brewing stands into the config and they will be protected.
  18. Offline


    Hi all,

    Has anyone been able to get access by group inheritance to work?

    Example, I have a TECH group in PermissionsBukkit and the group name [TECH] placed on the Lockette Signs.

    Group "Admins" has inheritance with group TECH
        - default
        - admins
        - tech
          aaa.foo.bar: true
    I am a member of Admins (confirmed by checking that I do indeed get the permission "aaa.foo.bar"), yet Lockette won't open the door for me.
    However, if I explicitly add the group "TECH" to my user groups, then it works.

  19. Offline


    Yeah, this is a suggestion for a distant future (when both minecraft and bukkit 1.8 have been released) but it's an interesting thing I saw in the changelog of the latest snapshots. Now there's a tag called NBT "Lock" which will serve to lock chests. If blank, the chest will be unlocked. If the value is the name of an item, that item can only open the chest. If anything, I think the bag is completely locked. I believe that in the future it could facilitate the working of the plugin. But for now, it applies only as a hint.

    More info: http://minecraft.gamepedia.com/Upcoming_features
  20. Several chests are being wiped out which have Lockette on them. Is this a lockette error
  21. Offline


    My user name is one letter too long to fit one the sign. what can i do to still protect my chests.
  22. Hello! How to a fee in the door?
  23. Offline


    If i want to put a sign on something that automatically locks, but not have it lock, how do i do it.

    basically i just wanna write on the sign. :/
  24. Is it normal that the Permission nodes don't work?

    I've edit the config file, to look at permissions. Edited my Groupmanager and still i cannot bypass the chest protection as admin or owner. Also not as op anymore.
  25. Will this plugin update to UUID's once 1.8 is released?
  26. Offline


    There will likely be a full recode of the plugin. Its a pretty big mess code-wise.
  27. Offline


    I wonder when will they update this to the current version
  28. Offline


    It doesn't fully work. Anybody can glitch wood doors and open them when they should be locked. They can even freeze them open and allow mobs to wander into other people's places.
  29. Offline


    Lockette is going to see a complete recode to make it UUID ready. I'm sure a lot of the quirks will be fixed.
  30. Offline


    Either that or it will just simply be abandoned... as it has been for over a year now.
  31. Offline


    Elgarl maintains it and has plans to update it.

Share This Page