Sueta

LockSecurity

3.0.0

Locking containers with keys so only you and your friends can have access to them!

·Plugin

[!] GOING PREMIUM [!]

LockSecurity has gone premium! Well... sort of... As of July 9th, 2020, LockSecurity will receive its final free update. Any future releases will be made under premium status which is available for purchase here. I would greatly appreciate the support as this is my first premium resource, I have worked hard to ensure this version has next to no bugs. This final release matches the initial release on the premium version of LockSecurity for those that have not updated beyond 1.12.2. Please read the release notes!

Premium version:
https://www.spigotmc.org/resources/locksecurity.81282/

[!] IMPORTANT [!]

This plugin DOES NOT support versions older than Spigot 1.16.1 and does not support CraftBukkit servers. You MUST be running Spigot 1.16.1 or higher in order to run this plugin. Please do not download if you are running any version older than this. I will never support anything older no matter how many times you ask. Period.

LockSecurity_Header.png

LockSecurity, the easiest and most intuitive container protection plugin to complete that RPG feel for your server.

  • Locking a configurable set of blocks using craftable keys
  • Private blocks only accessible with the key used to lock them
  • Support for multi-blocks such as double chests and doors
  • Key merging, duplicating and resetting to condense keys for multiple blocks
  • Changeable key flags including "break on use", "prevent merging" and more
  • Extensive set of commands, permission nodes and configuration options
  • A plethora of administrative capabilities to better control your server
  • Future-proof code base virtually guaranteed to work on versions of Spigot beyond 1.16.1 without an update

For a full set of in-depth features provided by LockSecurity, please see the official wiki page on GitHub! If you believe anything is missing, I welcome you to contribute to the wiki and update any missing or outdated information.


LockSecurity is proudly open source and welcomes contributions from anybody so long as you're familiar with the Bukkit and Spigot API! Source may be found on GitHub

LockSecurity_Commands.png

All commands are accompanied by intelligent command completion and permission nodes to prevent clients from seeing commands you don't want them to see! This section briefly covers the available commands in LockSecurity. For a more detailed look into what each command does, please see the official wiki.

/locksecurity (Alias... /ls)

View a basic overview of the plugin, its author and version information, as well as administrative functionality.
Arguments:
- /locksecurity reload - Reload the plugin's configuration file and apply any changes

/editkey (Aliases... /editkeys, /keyedit and /ek)

Edit the flags of the smithed key in the player's hand (for more on key flags, see the official wiki).
Arguments:
- /editkey get - Get a list of all flags in the player's hand
- /editkey get <flag> - Get the value of the specified flag on the key in the player's hand
- /editkey set <flag> <true|false> - Set the value of the specified flag on the key in the player's hand

/givekey (Alias... /givekeys)

Give an unsmithed key to yourself or another player.
Arguments:
- /givekey [player] [amount] - Give the specified player the given amount of unsmithed keys. Both arguments are optional

/ignorelocks (Aliases... /ignorelock and /il)

Enable the ignore locks mode! For more information on ignoring locks, see the official wiki.

/locklist (Aliases... /lockslist and /ll)

Get a list of all locks owned by yourself or another player.
Arguments:
- /locklist [player] - Get a list of locks owned by the specified player

/locknotify (Aliases... /locknotifications and /ln)

Enable the lock notification mode! For more information on lock notifications, see the official wiki.

/refreshkeys (Aliases... /refreshkey, /keyrefresh, /updatekey, /updatekeys and /keyupdate)

Refresh all keys in the player's inventory. This will remove any blocks that no longer exist in the world and convert any keys into unsmithed keys if they are no longer associated with a locked block. Additionally, this will also update the key if flags have been added or removed but the lore has not yet updated.

LockSecurity_Permission_Nodes.png

LockSecurity provides server owners with an extensive set of permission nodes to better control what players should be allowed to do. This section briefly covers all available permission nodes in LockSecurity. For a more detailed description of what each permission node does, see the official wiki.

locksecurity.command.* - Grant access to all commands in LockSecurity
locksecurity.command.editkey - Grant access to the /editkey command
locksecurity.command.givekey - Grant access to the /givekey command
locksecurity.command.ignorelocks - Grant access to the /ignorelocks command
locksecurity.command.locklist - Grant access to the /locklist command
locksecurity.command.locklist.other - Grant access to the /locklist [player] subcommand
locksecurity.command.locknotify - Grant access to the /locknotify command
locksecurity.command.refreshkeys - Grant access to the /refreshkeys command
locksecurity.command.reload - Grant access to the /locksecurity reload subcommand

locksecurity.block.* - Grant access to various block-related functionality. This is a default permission node
locksecurity.block.clonekey - Allow the owner of a locked block to create a smithed key to unlock it by right clicking the block
locksecurity.block.inspect - Allow a player to view information about a block by sneak right clicking with an empty hand
locksecurity.block.lock - Allow a player to lock a block using an unsmithed key
locksecurity.block.ignorelimit - Ignore the block limit in every world
locksecurity.block.nickname - Allow a player to nickname a locked block using a nametag

locksecurity.crafting.* - Grant access to various crafting-related functionality. This is a default permission node
locksecurity.crafting.duplicate - Allow a player to duplicate a smithed key in a crafting table
locksecurity.crafting.merge - Allow a player to merge a smithed key in a crafting table
locksecurity.crafting.reset - Allow a player to reset a smithed key in a crafting table
locksecurity.crafting.unsmithed - Allow a player to craft an unsmithed key in a crafting table

LockSecurity_Configuration.png

A detailed and ever-expanding set of configuration options are provided by LockSecurity. This section will briefly cover the default options in LockSecurity. For more information on the configuration file and all available options, see the official wiki. The default configuration file is as follows:

Metrics: true # Whether or not to send anonymous statistics
PerformUpdateChecks: true # Whether or not to check for updates

# Key-related configuration options
Keys:
  Unsmithed:
   ModelData: 1 # The resource pack model data for unsmithed keys
   RecipeYield: 1 # The amount of keys to yield in the crafting recipe
  Smithed:
   ModelData: 2 # The resource pack model data for smithed keys
  AllowKeyDuplication: true # Whether or not to allow key duplication
  AllowKeyMerging: true # Whether or not to allow key merging
  AllowKeyResetting: true # Whether or not to allow key resetting

# A key-value pair of world names to the maximum amount of locks
# You may enter any world here. If set to -1, no limit is set
# The default value (if a world is not found in this section) is -1
MaxLocks:
  world: -1
  world_nether: 0
  world_the_end: 0

# A list of all blocks lockable by players using unsmithed keys
LockableBlocks:
- 'minecraft:chest'
- 'minecraft:trapped_chest'
- 'minecraft:acacia_trapdoor'
- 'minecraft:acacia_door'
- 'minecraft:acacia_fence_gate'
- 'minecraft:birch_trapdoor'
- 'minecraft:birch_door'
- 'minecraft:birch_fence_gate'
- 'minecraft:dark_oak_trapdoor'
- 'minecraft:dark_oak_door'
- 'minecraft:dark_oak_fence_gate'
- 'minecraft:jungle_trapdoor'
- 'minecraft:jungle_door'
- 'minecraft:jungle_fence_gate'
- 'minecraft:oak_trapdoor'
- 'minecraft:oak_door'
- 'minecraft:oak_fence_gate'
- 'minecraft:spruce_trapdoor'
- 'minecraft:spruce_door'
- 'minecraft:spruce_fence_gate'

LockSecurity_Resource_Pack.png

LockSecurity comes pre-packaged with a resource pack to give your keys a bit more of a realistic feel! This resource pack is obviously optional but it's highly encouraged to use this whether or not you already have a server resource pack installed. Upon first run of LockSecurity, you will find the resource pack archive under the plugins/LockSecurity/resourcePack directory.

LockSecurity_Open_Source.png

LockSecurity is proudly open source and welcomes contributions from anybody so long as you're familiar with the Bukkit and Spigot API! Source may be found on GitHub! There will never be any malware or hidden code from you or your server and I encourage direct code modifications. I would, however, appreciate if any changes you make are directed upstream so other users may also benefit!

LockSecurity_API.png

While LockSecurity is now a premium plugin, it is understood that developers may want to interact with the plugin without having to purchase the resource on SpigotMC. As such, LockSecurity provides developers with an API free of charge as a separate artifact without having to distribute the plugin! Additionally, this artifact is hosted on a Maven repository to be more easy and convenient for developers.

Depending with Maven

<project>
  ...
  <repositories>
   <id>jitpack</id>
   <url>https://jitpack.io/</url>
  </repositories>
  ...
  <dependencies>
   <dependency>
     <groupId>com.github.2008Choco</groupId>
     <artifactId>LockSecurity</artifactId>
     <version>API-VERSION-HERE</version>
     <scope>provided</scope>
   </dependency>
  </dependencies>
  ...
</project>

Depending with Gradle

repositories {
 jcenter()
 maven { url "https://jitpack.io" }
}

dependencies {
 implementation 'com.github.2008Choco:LockSecurity:API-VERSION-HERE'
}

[!] CLOSING REMARKS [!]

Please be aware that when downloading this plugin, you acknowledge that time and effort went into the development of this plugin. While yes the plugin is open sourced and yes you may compile it yourself, it would be much appreciated that you purchase this resource to receive future updates. If you have any concerns with the plugin, do not hesitate to contact me on my official support Discord and I will answer whenever available!

Additionally, I also happily welcome contributions to the API if you believe it is necessary for development purposes, or to the plugin if you wish to see more features that you believe you may add yourself! Thank you and enjoy!

Similar projects

Plugin →