[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


    pay for lockette and permission that gives it for free
  3. Offline


    how do i do that ticked cuz i would love you to add the feature i requested thanks king man :)
  4. Offline


    Is there anything we need to know about these dev versions? Just bug fixes/rewriting or are there any new nodes we can use?
  5. Offline


    Would it be possible to add a configurable method for breaking into lockette chests? like... lockette sign is removed if affected by TNT. this would be awesome for my factions server! people get so mad when they raid another faction's keep and cant get into their vaults... or maybe even have two kinds of locked chests, and add a price tag for either. (configurable?) so that all free/cheap locked chests are breakable, but then you have the really expensive chests which require more TNT (or cant be broken at all?)
  6. Offline


    Hello, Acru, nice plugin you've created.

    I was wondering if it's possible to lock a chest/door to a specific Faction, as in the Factions Plugin.

    If not, is that possible to do? Don't worry about it if it's too complicated though I can try to find another plugin. I used LWC for awhile but it pissed me off and same with a few others on my server.
  7. Offline



    You prolly need a curse account, but you should get one anyway as the forum here will be obsoleted soon, for plugins.

    Well, superperms are working in them, and more supported plugins. No new nodes yet though.
    I'll post the full list along with Lockette 1.5, once I get to that point.

    I was considering a pvp option, though I'm still not sure what form it might take. Any other suggestions?

    Well, I already support groups from Towny, SimpleClans, mcMMO, and all the permissions+ groups plugins.
    I'll look into Factions next, to see if it provides a group interface. :3
    Edit: It has getPlayerFactionTag(Player player), so should be easy.

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


    Its all confusing :S Please man try add that feature Asap You'll be the best :p
  9. Offline


    as a pvp server host, i'd recommend something along the lines of two kinds of chests, both with configurable costs using economy plugins. first would be a basic chest; unbreakable by players, but setting tnt off next to it will cause the sign to be popped off as if the owner broke it himself. next is the expensive chest (price is configurable in the config file) which cannot be broken by anything and is truly indestructible. If the host chooses not to place a price on the chests, then people will be able to run their server just using the strong (expensive) chests, keeping griefing and looting down to a minimum. where as adding the pricing configuration and two chest types would enable Pvp server hosts like myself to create more reason for raiding castles (and using TNT)

    I hope this helps :D

  10. Offline


    @Acru Hey I'm running this new modified bukkit server with modloadermp. I was wondering if you be willing in the future I assume be really easy to enable an advance configure to allow us to create custom blocks to prevent opening in.

    For example Recycler is item 250:11 so it needs to use damage values if possible. I don't know if it's easy to do or not I assume just prevents the opening gui packet.

    Thanks so much =)
  11. Offline


    One point I was considering is that only those with a pvp permission would be able to engage in pvp breaking of locked chests. The problem with tnt, though, is that it has no player associated with it so one can't check permission directly.

    Well, as far as I can see from looking it up, a recycler is just a reverse workbench? In which case it doesn't have an actual inventory to protect, stuff falls out when you stop using it and someone else using it at the same time would see as empty. The upcoming Brewing Stand, however, is an example of a block with an inventory.

    I suppose one could add additional block types to protect from a list in the config, though then there are subtle issues like with quick-protect and permissions, and in any case it could only be a single block protection as doors and such need special block-step algorithms.

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


    Hello, I have a problem which need solving with lockette.

    I have four ranks with PermissionsEx; Admins, Moderators, Members & default. Admins and moderators are allowed to snoop, break etcetera. The problem is, although I haven't given my members permissions they can still bypass doors and do everything a moderator can, aswell as the default group. I use permissionsex with modifyworld and chatmanager. I'm using lockette 1.4.8 beta which recognises permissionsex and uses it aswell. When bypassing a door as a member (bypassing someone elses door) the console says '(Admin) Sizzlefish bypassed...' while I am not a admin at that point. The ops file is unedited.

    Any similar problems which have been solved?
  13. Offline


    Unedited as in blank? In any case, you can send me your console log and permissions file in a conversation and I can have a look.
  14. Offline


    so you're thinking just set it so that anybody with lockette.pvp would be able to break and loot a chest? I can see that working pretty nicely. what about the option for unbreakable chests?

    just re-read what you said. the way i see it, is that tnt could blow the sign off... as in safe cracking. so you dont need it to check the player's permissions, since everybody on mass pvp servers has permission to pvp (on servers with no pvp everybody could just use the 'expensive' chest (free of charge because no price will be configured... or a lower price one will be) which is invulnerable to tnt anyways. From what i've seen, a lot of pvp servers these days are more like structured anarchy than anything else, so for that idea... tnt break would work well. maybe toggle able in the config?
  15. Offline


    Not necessarily. There are some servers that use things like Towny or Factions, and occasional wars or just opposing factions. In such case you'd only want pvp theft between two people who are marked hostile towards each other Or perhaps not, but it should depend on the server ops.
  16. Offline


    true... i see your point, actually. would there be a way to make it so that it checks factions/towny to decide if someone is able to break a chest?
  17. Offline


    I dont know how to can you please just try to add the feature asap man U'll be the best :)
  18. Offline


    Greetings again.
    I have had some problems with Lockette 1.4.7 and 1.4.8 using CB1340 and PermissionsEx 1.15.1. Users with the permission lockette.user.create.* cannot place lockettes anywhere (it gives a message denying permission). I had to make enable-permissions=false in the lockette config to get it to work. I'm using perm files the same as for previous builds, and I've rolled back to 1.4.4 (which works fine with enable-permissions=true).
    It looks like the latest PEx isn't hooking into lockette's new permissions very well at all. :( Any ideas?
  19. Offline


    Don't know if this was proposed, but if so, take this as a vote for it.

    Signs on trapdoors look strange most of the times. Please add the posibility to place the sign below the trapdoor.

    You can check the sign rotation to decide which wall to attach to.
    Justin The Cynical likes this.
  20. Offline


    Well it should be working in 1.4.7 beta+... I'm assuming you are getting the permission denied as opposed to being denied by Towny? One thing that the beta does is use superperms, not using the PEX bridge at all. I can try the 1340 and 1.15.1 to be sure the new versions aren't a factor, I suppose.

    You could send me your console log and permissions file in a convorsation, too? Incidentally, there is built-in color tag support now. o3o
  21. Offline


    Is Lockette not compatible with Towny?

    When I have both towny and Lockette installed, Lockette does not work ,and the signs come up like


    And the error message that comes up is "Permission to Lock Container Denied".

    It worked without Towny, and that group has the right permissions to lock containers.
    Also with Towny when you do /town new name with an area with Lockette chests in, then after you do /town delete
    it wipes all Lockette chests?

    Please Help!
  22. Offline


    You can place the sign on the block that the trapdoor is attached to, as well. I'll probably add more placement options a bit later, but right now I'm updating mostly for integration.

    Add permission lockette.towny.wilds
    Edit: Also wiping signs on deleting a town would be a towny issue...

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
    Justin The Cynical likes this.
  23. Offline


    I though I tried that and it didn't work. I'll try again

    Nope - placing on the block the trapdoor is attached to doesn't work for me: lockette 1.4.4, RB 1317
    I assume it's in the 1.4.8 beta unless you reply to this and tell me otherwise.
    Also, fast placement with right-click doesn't work on trapdoors.

    Keep up the good work. I will wait till 1.4.8 isn't beta anymore.. not that important after all...

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


    Link is down
  25. Offline


    Anyone have the beta jar? It's not downloading from the link :/
  26. Offline


    You should place a wall sign (not a floor sign) on the block the trapdoor is attached to, mark it [Private], and it should work in 1.4+. If it doesn't work for you, something is going wrong. (What message and result do you get?)

    Also, quick-protect will not work on any sort of door, though I plan to add a quick-protect-door option in a future version.

    The link seems to work right now? Was probably just a temporary interruption.
  27. Offline


    Thanks, back up!
  28. Offline


    I've added lockette.towny.wilds, but it isn't working anymore?

    At first, I added it and it worked fine, but then when I restarted the server it no longer worked?

    I'm using Newest Towny/Lockette, and Permissions 3.1.6

    This is my Permissions:

            default: true
                prefix: '[Regular] '
                suffix: ''
                build: true
            - essentials.spawn
            - essentials.list
            - essentials.sethome
            - essentials.warp.list
            - essentials.warp
            - commandbook.say.me
            - essentials.balance
            - essentials.motd
            - commandbook.msg
            - essentials.home
            - essentials.signs.buy.use
            - essentials.signs.sell.use
            - essentials.tpaccept
            - essentials.tpdeny
            - essentials.pay
            - essentials.back
            - essentials.signs.balance.use
            - mcbans.vote
            - lockette.user.*
            - 'essentials.signs.spawnmob.use'
            - 'essentials.rules'
            - 'towny.town.*'
            - 'towny.wild.*'
            - 'mobbounty.collect'
            - 'lockette.towny.wilds'
  29. Offline


    Permissions 3? I forget, do all the .* items need to be in quotes for that one? (Some of your perms are in quotes anyway.)
    Otherwise, I'll need more info. Newest Lockette as in the 1.4.8 beta? Try restarting the server again?
    If its a towny.wilds issue, the error message should say something different in 1.4.8.
  30. Offline


    Im using 1.4.4 I believe, does this matter? Actually im not using the Newest Lockette :3

    Oh and the quotes don't matter, sometimes i'm just lazy.
  31. Offline


    Try 1.4.8 beta and tell me how it goes.

Share This Page