Skip to content

Alathra/SimpleLockpicking

SimpleLockpicking

A simple plugin for your lockpicking needs

GitHub License GitHub Downloads (all assets, all releases) GitHub Release GitHub Actions Workflow Status GitHub Issues or Pull Requests GitHub last commit


Description

SimpleLockpicking adds lockpick items which can be used to open doors, fence gates, trapdoors, chests and more. It is designed to be used in conjunciton with a block protection or "private sign" plugin like BlockLocker, LWC Extended, or Bolt. Lockpicks are able to bypass the protections of these plugin, facilitating a simple and dynamic lockpicking mechanic.


Usage

Lockpicks are a configurable custom item that are used by holding them in your main hand and shift right clicking a block or entity. Note that lockpicking requires the player to have the permission simplelockpicking.lockpick and that the world is in the enabledWorlds section of the config. An example resourcepack is included that gives the lockpick item a custom texture and model. Below is a list of lockpickable things.

Name Type Lockpick Action Notes
barrel block opens inventory
chests block opens inventory Does not include trapped chests
chest boats entity opens inventory Includes all chest boat variants
chest minecarts entity opens inventory
copper doors block toggles state Includes all copper variants
copper trapdoors block toggles state Includes all copper variants
fence gates block toggles state Includes all fence gate variants
iron doors block toggles state
iron trapdoors block toggles state
shulker boxes block opens inventory Includes all shulker box variants
trapped chests block opens inventory
wooden doors block toggles state Includes bamboo, crimson and warped variants
wooden trapdoors block toggles state Includes bamboo, crimson and warped variants

Based on the chances defined in the LockpickChances section of the config, a lockpick will either be successful and trigger the "LockpickAction" defined above, or break and the player will lose the item.

Lockpick Success

Lockpick Success

Lockpick Fail (It breaks)

Lockpick Fail

Crafting Lockpicks

SimpleLockpicking includes a default crafting recipe for lockpicks. Please note that for players to craft lockpicks you must have enableDefaultLockpickCraftingRecipe set to true in the config and grant the permissionm simplellockpicking.lockpick.

Lockpick Recipe


Hooks & Compatibility

Tested Protection Plugins

Optional Hooks

  • Adds the ability to lockpick CraftBook bridges, doors and gates. This feature can be configured in the CraftBookCompatibility section of the config.
  • If Towny is enabled, the lockpicking of containers (barrels, chests, shulker boxes, etc.) will automatically be disabled within Towny claims.
  • The above plugins are used to create and manage custom items. SimpleLockpicking supports the use of either of them for the lockpick item. If you wish to create a custom lock item using one of these item frameworks, you can define item id for simplelockpicking to link and use in the Lockpick Item section of the config..

Permissions

SimpleLockpicking contains the following permission nodes:

  • simplelockpicking.admin Grants the user all other permissions and also the /simplelockpicking getlockpick command.
  • simplelockpicking.lock Grants the user the ability to use lockpicks.
  • simplelockpicking.craft Grants the user the ability to craft lockpicks using the default crafting recipe.

Commands

SimpleLockpicking adds the following commands:

  • /simplelockpicking getlockpick <amount> Spawns the specified amount of lockpick items in the player's inventory, defaults to 1. This command requires the permission node simplelockpicking.admin.

Configuration

Simplelockpicking can be configured by editing values in the config.yml. SimpleLockpicking does not have a reload command because it automatically checks for updates in the config file. When you make edits to the file the changes will be applied immediately. The only the exeption is the field enableDefaultLockpickCraftingRecipe, which is applied when the plugin is enabled.


About

A simple plugin for your lockpicking needs.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors 2

  •  
  •  

Languages