[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


  3. i have this at 928 and it seems to work.
    VeryInsane likes this.
  4. Offline


    Is there a way I can disable Lockette from logging events into my server.log file? Every time someone bypasses a sign, it logs it and it actually used up so much space in my server.log file that it corrupted my server files. It's a great plugin but if you could tell me how to disable the log function, it'd be great.
  5. Offline


  6. Offline


    Hey it seems this plugin is disabling my permissions commands I.E. /pr -reload /permissions -reload all
    Is there a fix for this?
  7. Offline


    What build are you running as the RB 928 was disabling commands, I believe 935 fixed that issue
    Also have you removed everything except Lockette and Permissions, found the commands broken and then removed Lockette to find them fixed or did you just install Lockette and it broke?
  8. Offline


    Hey by any chance how do u install it.my friend server been havin probs as my friend been geting stuff stolden so can someone please help
  9. Offline


    Download the .jar, put it in your plugins folder
    It works out of the box, the config is to fine tune things
  10. Offline


    i dont have a plugins folder and does everyone that with the server have it or just the server?
  11. Offline


    The plugins folder is just the server
  12. Offline


    I had copyed my plugins folder and put it on my desktop. And. I deleted every plugin except for lockette and permissions in my /bukkitfolder/plugins folder. So yes. I am sure it is lockette
  13. Offline


    Again, what build are you using and you have tried it WITH lockette but have you tried it without
  14. Offline


    Yes as I tried to say. I did try with and without permissions and I am using the latest build sorry Im not sure of the build number
  15. Offline


    How's it going. Having some trouble protecting doors. While chest protection works fine, when attempting to protect a door, it says No unclaimed container nearby to make Private. Also, when trying to edit an existing sign, I cannot right click it. I am running mcmmo and easyrpg which both have right click actions implemented. Any ideas? I should state I have permissions set to * for the group I am in and am allowing users to create any protections with the proper permission set (can't remember it offhand).

    Bit more info here. I can get it to work on the door in question from one side and not the other. When placing it above a single iron door (can't be placed on block in front) I get the previously stated error. From the other side it works however. Not a big deal, but not sure why it won't work from the opposite side.
  16. Offline


    OK, remove Lockette and install the rest of your plugins and if it works fine then that is a bug for build 935
  17. Offline


    I was about to say " Rahh Multi-world support please! " Then I realized I can do this with perms yay lol.
  18. Offline


    I fully loved it :) but I wonder if it's possible to, when you lock a door, private yhe all "house". I mean, other users cannot destroy the house I privated.

    Anyway, it's great
  19. Offline


    Outside the scope of this plugin, although there is a hook for others so another plugin could detect a solid structure and protect it based on the Lockette signs
  20. Offline


    Which setting do I alter so that the admin snoop message does not display?
  21. Offline


    Change the snoop group to 123, so long as you don't have a group called 123 then no message
  22. Offline


    I just found this line under the Advanced Settings section in the first post:
    broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.

    Apparantly this is found in the config.yml, but my config doesn't have this.

    EDIT: I redownloaded the plugin and deleted my lockette folder and jar, and now the config file shows the new data.
  23. we get a lot of "conflicting door" problems when my users try to lock a door, already locked doors are working fine.
    please update for RB935.
  24. Offline


    Then this is a conflict and updating to 935 will not help, it's know to happen with Minecart Mania but there are others
  25. Offline


    A Dutch strings.yml translation by me :)

    alternate-private-tag: Privé
    alternate-moreusers-tag: Andere gebruiker
    alternate-everyone-tag: Iedereen
    alternate-operators-tag: Operators
    alternate-timer-tag: Tijdschakelaar
    msg-user-conflict-door: Deur verwijderd!
    msg-user-illegal: Foutgeplaatste kist of deur verwijderd!
    msg-user-resize-owned: Je kan geen kist vergroten die is geclaimd door ***.
    msg-help-chest: Plaats een bordje met [Private] naast de kist om deze te sluiten voor anderen.
    msg-owner-release: Je hebt een kist of deur opengesteld!
    msg-admin-release: (Admin) @@@ heeft een kist of deur opengesteld van ***!
    msg-user-release-owned: Je kan geen kist of deur openstellen van ***.
    msg-owner-remove: Je hebt gebruikers van de kist of deur verwijderd!
    msg-user-remove-owned: Je kan geen gebruikers van de kist of deur van *** verwijderen.
    msg-user-break-owned: Je kan de kist of deur van *** niet kapot maken.
    msg-user-denied-door: Je mag hier niet naar binnen.
    msg-user-touch-owned: Deze kist of deur is van ***.
    msg-help-select: Bordje geselecteerd, gebruik /lockette <regelnummer> <tekst> om te bewerken.
    msg-admin-bypass: (Admin) @@@ opent deur van ***. Sluit hem alsjeblieft achter je!
    msg-admin-snoop: (Admin) @@@ heeft rondgekeken in de kist van ***!
    msg-user-denied: Jij hebt geen toestemming om deze kist of deur te openen.
    msg-error-permission: Jij mag deze kist of deur niet sluiten.
    msg-error-claim: Geen kist of deur in de buurt om te sluiten!
    msg-error-claim-conflict: Conflict met een bestaande 'protected door'.
    msg-admin-claim-error: Gebruiker *** is niet online, gebruik alsjeblieft de goede naam.
    msg-admin-claim: Je hebt een kist of deur geclaimd voor ***.
    msg-owner-claim: Je hebt een kist of deur geclaimd!
    msg-error-adduser-owned: Je kan geen gebruikers toevoegen aan de kist of deur van ***.
    msg-error-adduser: Geen vrije kist of deur om gebruikers aan toe te voegen!
    msg-owner-adduser: Je hebt gebruikers toegevoegd aan een kist of deur!
    msg-help-command1: /lockette reload – Herlaad configuratiebestanden.
    msg-help-command2: /lockette <regelnummer> <tekst> - Klik met rechts op een bordje om dit te doen.
    msg-admin-reload: Configuratie herladen.
    msg-error-edit: Klik eerst met de rechter muisknop op een bordje.
    msg-owner-edit: Bordje succesvol gewijzigd!
  26. Offline


    Howdy... could you change the PlayerInteract listener priority? It's set to Highest and the only way to bypass this is using Monitor and I'd really like to avoid that.
    I'm having conflicts with my DoubleDoor plugin. (It fixes the double-door bug of Lockette as well - if one door is open and the other one is closed) but - as already mentioned - I have to use Monitor priority for it to work.

    And as stated here:
    Getting your priorities straight: The plugin version
    it should probably be changed to low/normal, since this is a protection plugin..
  27. Offline


    Does this support trapdoors yet? or is there any plugin that does?
  28. Offline


    where is lockette data stored exactly? I just removed the plugin and chests that were locked have been wiped clean :(
  29. Offline


    Hey Man! Love your work and I use it on my server but when are you going to bring out a version for Build 953? Cause I really want my server to go up soon! :)
    Thanks a ton for your plugin and keep up the good work!
  30. Offline


    Can anyone confirm whether this does or does not work on 953?

Share This Page