[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


    Guys, stop spamming this thread with "hurry up" and "please" requests.
    He already said he was working on it:
    Just wait until he posts an update.
  3. Offline


    Im glad to see your working on it! I have 50 people asking me "wer is locet"

    Oh god help me!
    Help me Arcu!
  4. Offline


    Excellent plugin you have Acru.Keep up the good work and don't rush to update.I love having this plugin for my server,but I'd rather have Lockette updated carefully so my server won't crash.
  5. Offline


    We can't legally distribute old versions, but you can use MCNostalgia to downgrade from a vanilla copy of minecraft. (No modifications at all.)
  6. Offline


    Awesome plugin :)
    Very Useful
  7. Offline


    I love this plugin but when will it be out for minecraft 1.2?????
  8. Offline


    Sending you a PM with a DL Link.
  9. Offline


    Can't wait till its done!
  10. Offline


    #2 plugin behind worldedit/guard
  11. Offline


    Firstly thanks for a great plugin

    Any chance of an update for 1.1-R6 doesn't seem to work at all now.
  12. Offline


    1.2.3 update?
  13. Offline


    Deadbolt sucks, don't use it.
  14. Offline


    May I ask why? It seams to have same features and more. As much as I LOVE lockette Acru seams busy with life and such (as we all are). It may be time to pass the torch to fresh blood.

    EDIT: Sorry for bringing this up, I was not aware of the situation/drama behind this. I was not aware of what the author did.
  15. Offline


    Deadbolt has no seams in it.

    It fails to load correctly.
  16. Offline


    FattyDave18 Acru has already said that the 1.2.3 update will work with R6, since it uses the new event system.

    Delois Deadbolt is a sore subject here. What md_5 did was not cool. There are other forums and PMs for those discussions.
  17. Offline


    I agree. Competition is good, but its not original.
  18. Offline


    Please update to R-6!!!
  19. Offline


    Lockette isn't working! I did everything to try to install it, but bukkit keep saying it failed to load Lockette. Why?
  20. Offline


    Patiiiiiiiiiiiiience ! Try to read the previous posts, Acru is working on the update. :)
  21. Offline


    Which version works?
  22. Offline


    Sorry, I was not aware there was any drama about it here, I will stop talking about it.
  23. Offline


    Does it work with 1.2
  24. Offline


    Acru has a bit to do tho - R6 introduces plugins telling you automatically when they have updates, zombies may potentially bi-pass the private sign and break down your door if its wood, there are new block types and god knows what else container wise added in there. Going by the delay on the v2 release i suspect Acru is adding some other good stuff too. Add to that all the api/calls/library blah blah blah changes in R6 and Acru probably going through a fair few cups of coffee on this. Personally I use group door permissions and players use chests - but lockette had a lot more in there. I wonder if Acru is also thinking about something relating to the old "break 2 blocks next to door to break in" thing popular with griefers. I know i nagged earlier for a quick door/chest protection release while Acru works on his full 2.0 release but I know theres is a bit involved even to do that. I setup a "fallback" server and gave half the players creative and let them vent frustration there while I wait for lockette... some even like it more than our production server LOL. Best not take too long as new players who cant get on their usual servers are going on there thinking its our real server.. ! LOL..
  25. Sorry for my bad english.

    But when does it release for 1.2.3 dev?
    Or is it not gonna release to the dev version?
  26. Offline


    It seems from checking these forums I got devs of most of my plugins... this one obviously is taking a bit to update.
    Incidentally I have a copy of 1.1 bin folder if you are still looking for it. I'm sure I'm not the only one though... pretty sure you have this sorted already.
  27. Offline


    I think this plugin shows how useful it is with these threads. This is my first post yet I have owned a server for a while. I wanted to say I feel frustration with all of you. Mine is also on hold till this is updated. LOL I tell them to go to desura or steam and buy a 99cent game till its finished :D. Good point with the zombie breaking down door thing. Bottom line is:
    • This plugin is well worth the wait.
    • Your loyal and mature players will understand.
    • Noobs won't understand. ( they barely understand what an update is or does )
    Keep up the great work Acru!!
    Marc-D and Tendonsie like this.
  28. Take your time Acru,
    It will be worth the wait.
  29. Offline


    Patiently waiting. Glad I don't have a 100-player server full of whiners. :)

    A tip for people looking for a simple chest locking alternative: ChestShop chests are secure. Just make one selling dirt and then stick your items in it.
  30. Offline


    This is why we simply tell our members not to update until we say it's safe. Our server is running completely unaffected because we're not silly enough to update until the majority (if not all) of the plugins we use are updated to an RB.
  31. Offline


    Indeed, that is the best way to go. Also I try to put out a plugin that can be used for older versions of Bukkit as well as the newest.

    This time however, I can't see any way to support both in the same plugin, due to a fundamental change in how Listeners are described...

    Will this effect anyone? (Aka, is anyone not updating past 1.1-R4 for the foreseeable future, for any reason?)
    Tendonsie and khamseen_air like this.

Share This Page