Add locks, keys and lockpicks to your server!
This plugin is currently abbandoned and won't recive any updates. until i feel like returning
Overview:
Locks and Lockpicking is a lock-picking plugin, with features including locks, keys, lockpicks and much more! Locks and Lockpicking is one of the only lockpicking plugins there is up-to-date and will be a perfect addition to any server.
Locks and Lockpicking integrates with Minecraft crafting mechanics, meaning players will never have to bother with commands or sign's.
If you come up with a new feature idea, don't hesitate to PM me so I can implement it. and if you need help or somthing is broken use the discussion tab. not the review section.
also english is my second language so i apolgize for any misspellings here and in the plugin.
i would like to add that this plugin is heavily inspired by https://dev.bukkit.org/projects/lorelocks
Features:
- 6 tiers of locks
- traps
- keys which can open multiple locks
- choose whice worlds locks, lokcpicks and keys are craftable in
- restrict who can craft locks, lokcpicks and keys with perms
- lockpicks with a interactiv lockpicking minigame instead of boring old chance
- can lock doors, chests and shulker boxes
- locked doors, chests and shulker boxes can only be broken with the right key
- a crafting.yml where you can change all the recipes
- you can change the type of item locks, keys, traps and lockpicks are, and even set their durrabilty(it will be unbreakable) to use the the custom item model trick
- in-game viewer of all recipes
- multiple language.ym included and you can easily make your own, ln which you can change most text from this plugin
- a config.yml where you can change different options such as the chance of a lockpick breaking.
- customizaable sounds for most actions.(be sure to check that the sounds actually exist for your version of spigot)
- override claiming plugins such as towny and factions (untested)
- loot boxes can either be spawned randomly or by command.
- option to make natural generated chest be locked in a simliar fashion to lootbox but stille containg the same loot as they normally would
- unstealable tag admins can put on locks(or any item) whice makes it impossiable for anyone without the proper perm to move the item from the slot its in
- autoclosing doors with configable time
- non steal option for doors, makes it so doors locks can´t be stolen
- you can leave doors with locks unlocked
- Creative gamemode can mess with some of the features of the plugin. known features to not work in Creative: Lockpicking.
Spoiler: How to craft locks, keys and lockpicks
this is the default recipes, you can chnage these in the crafting.yml
the key id says blank until you actually craft it where after it gets a unique id, the id looks like player uuids but they not in anyway coupled with the player who made the key. you can also make two keys have the same id simply take the one with the id you want, and drop ontop of another key now they will have the same id, this is usefull for shareing with friends
this is the default recipes, you can chnage these in the crafting.yml
the key id says blank until you actually craft it where after it gets a unique id, the id looks like player uuids but they not in anyway coupled with the player who made the key. you can also make two keys have the same id simply take the one with the id you want, and drop ontop of another key now they will have the same id, this is usefull for shareing with friends
Spoiler: How to use locks
Locks come in 6 difficulties, 1-5 change the cylinder count of the lock and the 6th difficulty makes the lock unpickable, or in other words only the person which has the key can open the lock.
Depending on the difficulty locks have a different amount of cylinders
Then place it in the first slot of the chest/shulker box(upper left slot) to lock the chest. Make sure to link a key to it by dropping a key onto the lock before locking the chest if you want to avoid picking your own chest/shulker box/door every time.
in case of doors:
sneak click a unlocked door will open up a menu where you can drop in the lock in the first slot, if the door is locked you can sneak click with the key to open the menu and take out/change the lock, this menu is also opend when you succesfully lockpick a door,
the rest is like chests and shulker boxes
If you forget to create a key from an unpickable lock ask an admin for help, they can bypass the lock and open the chest/shulker box/door for you.
to break a locked chest/shulker box/door you must use the key linked to they lock.
![[IMG]](//proxy.spigotmc.org/33b891c91a72e7695a4f4cac5847547ce2da4d97?url=https%3A%2F%2Fpasteboard.co%2FGYDO2uU.gif)
Depending on the difficulty locks have a different amount of cylinders
- Difficulty 1 has 3 cylinders
- Difficulty 2 has 4 cylinders
- Difficulty 3 has 5 cylinders
- Difficulty 4 has 6 cylinders
- Difficulty 5 has 7 cylinders
Then place it in the first slot of the chest/shulker box(upper left slot) to lock the chest. Make sure to link a key to it by dropping a key onto the lock before locking the chest if you want to avoid picking your own chest/shulker box/door every time.
in case of doors:
sneak click a unlocked door will open up a menu where you can drop in the lock in the first slot, if the door is locked you can sneak click with the key to open the menu and take out/change the lock, this menu is also opend when you succesfully lockpick a door,
the rest is like chests and shulker boxes
If you forget to create a key from an unpickable lock ask an admin for help, they can bypass the lock and open the chest/shulker box/door for you.
to break a locked chest/shulker box/door you must use the key linked to they lock.
![[IMG]](http://proxy.spigotmc.org/33b891c91a72e7695a4f4cac5847547ce2da4d97?url=https%3A%2F%2Fpasteboard.co%2FGYDO2uU.gif)
Spoiler: How to use keys
the locks id dosen´t need to be blank you can overide other peoples locks, if you want. multiple locks can have the same id, this allows for multiple keys to open multiple locks. you can also make keys have the same id by draging them on to other keys
the locks id dosen´t need to be blank you can overide other peoples locks, if you want. multiple locks can have the same id, this allows for multiple keys to open multiple locks. you can also make keys have the same id by draging them on to other keys
Spoiler: misc things
if you open a door with its key it will become unlocked and anyone can open and close it, if you close it with its key it will become locked and nobody without the key can open it,(right after you put a key in it will be unlocked you have to lock it once manneuly)
Spoiler: Lockpicking minigame
when picking the wrong cylinder there is a chance for you getting kicked out and the code reseting and one for a lockpick breaking. the default chance for geting kicked out is 10% for tier I, and a increase of 5% per tier above 1 and for lockpick breaking 30 for tier 1 and a 8% increase per tier above.
![[IMG]](//proxy.spigotmc.org/42fbf2a59eba2cb3e9bc0354ffd83ee38e292ad7?url=https%3A%2F%2Fpasteboard.co%2FGYDONej.gif)
when picking the wrong cylinder there is a chance for you getting kicked out and the code reseting and one for a lockpick breaking. the default chance for geting kicked out is 10% for tier I, and a increase of 5% per tier above 1 and for lockpick breaking 30 for tier 1 and a 8% increase per tier above.
![[IMG]](http://proxy.spigotmc.org/42fbf2a59eba2cb3e9bc0354ffd83ee38e292ad7?url=https%3A%2F%2Fpasteboard.co%2FGYDONej.gif)
Spoiler: Traps
traps are placed in the slot next to the lock.
Spoiler: Potion trap
the potion trap can be filled with any type of vanilla potion or splash potion, and will apply/throw a copy of that potion at any player who fails to lockpick youre lock.
filling is simple, you simply drag a potion over and drop it on the potion trap, if the potion trap already have some potion in it, then it most be of same type and strength,
you can also empty a potion trap by holding it and rightclicking with it.
filling is simple, you simply drag a potion over and drop it on the potion trap, if the potion trap already have some potion in it, then it most be of same type and strength,
you can also empty a potion trap by holding it and rightclicking with it.
Spoiler: Redstone trap
this simple yet really usefull trap, simply turns the block just beneath the locked item into a redstone block for 2 ticks. this can be used to make all kinds of traps from the floor disappering to shooting him out with slime blocks.
Spoiler: Loot boxes
Spoiler: normal
Loot boxes are locked chests you can either spawn with a command or by enabling the random spawner in the config. loot boxes have 5 tiers corresponding to they difficlty of the lock. and a loot table(see config)
Spoiler: permanent
permanent loot boxes is like normal lootboxes except a couple key diffrence. 1. they do not despawn when tried lockpicked 2. they have a cooldown between you can try to lockpick them(set in config) 3. they can only be set by command
permissions:
- lockpick.admin : let you use admin commands
- lockpick.override : let you open/break locked chest/shulker box/door without the key
- lockpick.move : lets you move a unstealable item
- lockpick.recipe.view : let players use /lockpick recipe. players have this perm by default
- lockpick.pick : let player pick locks. players have this perm by default
- lockpick.craft.lockpick : let players craft lockpicks. players have this perm by default
- lockpick.craft.key : let players craft keys. players have this perm by default
- lockpick.craft.locks : let players craft all locks. players have this perm by default
- lockpick.craft.traps : let players craft all traps. players have this perm by default
- /lockpick : show all commands. perm: lockpick.admin
- /lockpick lock 1-6 : gives you a lock of Difficulty 1 to 6. perm: lockpick.admin
- /lockpick unstealable : makes the item you holding unable to be moved unless you have the right perm.
- /lockpick lootbox : opens the gui where you can change loot tables
- /lockpick lootbox 1-5 true/false : spawns a lootbox of tier 1-5 either permnanet or not
- /lockpick reload : a experimental reload command
Setup
![[IMG]](http://proxy.spigotmc.org/eef44f007799e043ceee7bf63a50b65ec4a9d8f6?url=https%3A%2F%2Fpasteboard.co%2FGYDRryO.png)
- Dowenload the plugin
- restart you server and let the plugin generate its files
- change options in the config to fit you servers need
Spoiler: defualt configCode (Text):
# Locks and Lockpicking by Mathias0903(minecraft: DragonsIce)
# the language yml to use locate in LocksAndLocpicking/language
language: en
# list of worlds where crafting of LocksAndLockpicking items is enabled
worlds:
- World
- World_nether
- World_the_end
# chance of getting kicked out of the lockpicking gui and the sequnze reseting start/minimum. without %
tierkickstart: 10
# chance of getting kicked out of the lockpicking gui and the sequnze reseting per tier above 1. without %
tierkicklevel: 5
# chance of a lockpick breaking start/minimum. without %
tierbreakstart: 30
# chance of a lockpick breaking per tier above 1. without %
tierbreaklevel: 8
# setting this to true will make it so ids are given to locks instead of keys and
# when you click a lock with a key, the key gets the id of lock instead of the other way around
# this makes it less atractive to steal locks
invertid: false
# Changing this to false will make locked chests/shulker boxes/doors unexplodable
# in other words they dosen´t get destoryed by explosions
explodable: true
# what Material/item the lock/key/lockpick is. all possiable materials are list here
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
# something to note is that already crafted locks/keys/lockpick aren´t gona update(might add this later)
# and they will stile work. if you want to edit the the recipe check crafting.yml
# you can set the durrabilty of items with durrabilty, the item will be unbreakable
# and stille useable for its purpose, in other words if you set the lockMaterial
# to DIAMOND_SWORD:5 the lock will be a unbreakable diamond sword and do as much damage as a diamond sword and be enchantable
# the way to set it is: MATERIAL:(amount of durrabilty missing)
LockMaterial: FLINT
TrapMaterial: IRON_BARS
KeyMaterial: NAME_TAG
LockpickMaterial: STICK
CylinderMaterial: IRON_INGOT
GuideMaterial: STICK
BarMaterial: IRON_BARS
door:
# how long there goes before a lockpicked door autocloses in seconds
# setting this to 0, disables autoclose
autoclose: 10
#weather people can steal locks when they have lockpicked a door
steal: true
# before you use sounds be sure to check the sound enums of youre version
# genrally its https://jd.bukkit.org/org/bukkit/Sound.html befor 1.9
# and https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html after 1.9
# if you don´t want to use sounds simply set to nothing like this
# denybreak:
sound:
# played when player tries to break a locked chest/shulker box/door
denybreak:
sound: BLOCK_ANVIL_BREAK
volume: 1
pitch: 1
# played when player opens a lootbox lockpick minigame.
openlootbox:
sound: BLOCK_ANVIL_LAND
volume: 1
pitch: 1
# played when player opens a lock with a key
openlockkey:
sound:
volume: 1
pitch: 1
# played when player tries to lockpick a chest without lockpicks
nolockpick:
sound: BLOCK_DISPENSER_FAIL
volume: 1
pitch: 1
# played when player tries to lockpick a chest and the a lockpick breaks
lockpickbreak:
sound: BLOCK_DISPENSER_FAIL
volume: 1
pitch: 1
# played when a player links a lock to a key
linklock:
sound: BLOCK_ANVIL_USE
volume: 1
pitch: 1
# played when a player click the right cylinder
correctcylinder:
sound: ENTITY_ITEM_PICKUP
volume: 1
pitch: 1
# played when a player successfully lockpicks a lock
successe:
sound: ENTITY_PLAYER_LEVELUP
volume: 1
pitch: 1
# played when a player fails to lockpicks a lock
fail:
sound: ENTITY_PLAYER_DEATH
volume: 1
pitch: 1
# played when a player fill a potion trap with a potion
potiontrapfill:
sound: ENTITY_SPLASH_POTION_BREAK
volume: 1
pitch: 1
# played when a player emptys a potion trap
potiontrapempty:
sound: ENTITY_SPLASH_POTION_THROW
volume: 1
pitch: 1
# here you can change diffrent things abort the lootboxes
lootbox:
# how long there must go between trying to open a permanent lootbox(one set by command)
# setting this to -1 means they can only open it once. in seconds
delay: -1
# minimum and maximum amount of items in a lootbox
min: 1
max: 10
# the chance in % for it to stop adding items to inventory after min is reached.
# meaning after it add min items to the inventory(this happens before its showen to player)
# it will have a 10%(default) chance to stop adding items
chance: 10
world:
# if it should randomly spawn lootboxes in the world
enabled: false
# if naturally generated chests should be locked
# they will stile contain all the same loot
natural: false
# list of worlds it should be enabled in
# it also takes 2 or 3 values, the 2 first is required
# and the last is optional. look below for what the 2 first are
# the optional one is the max amount of loot chests in a world at any given time
# if its not set its or set to 0 and below its unlimted
# so in the end the format is: (world name):(x):(z):[max amount]
worlds:
- world:0:0
# the radius from the coordinates specifid after the world in this case 0:0 is x: 0 z:0 in a cuboid form
# in whice it will spawn lootboxes,
radius: 1000
# the delay between it spawing a lootbox, in minnuets
time: 10
# the chances of the loot box being tier x,
# the total should be 100
weak: 35
normal: 25
tough: 20
strong: 15
fine: 5
potiontrap:
maxcharges: 1000
time: 3
Spoiler: defualt crafting.ymlCode (Text):
#Locks and Lockpicking by Mathias0903(minecraft: DragonsIce)
#Recipes as you can see we have 3 line 1, 2, 3.
#these correspond to the a line in the crafting table
#so 1 is top row of crafting table, 3 is bottom
#then we have letters each letter corresponds to a material list in its materials
#just below, if there letter is not there it corresponds to notthing
#i however recommend to use * for air makes it more readable.
#as seen below. all possiable materials are list here
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
# you also have a sharpless recipe for lockpick this is just a list of Materials. MAX 9
# if youre server is 1.10 and below you will have to change iron_nugget
# to a material that acuttly exists in that version.
lockpick:
- IRON_INGOT
- IRON_NUGGET
- IRON_NUGGET
key:
1: 'AAA'
2: '*BB'
3: '***'
materials:
A: IRON_INGOT
B: IRON_NUGGET
weak:
1: '*B*'
2: 'BAB'
3: '*B*'
materials:
A: FLINT
B: COBBLESTONE
normal:
1: 'CBC'
2: 'BAB'
3: 'CBC'
materials:
A: FLINT
B: IRON_INGOT
C: COBBLESTONE
tough:
1: 'CBC'
2: 'BAB'
3: 'CBC'
materials:
A: FLINT
B: GOLD_INGOT
C: IRON_INGOT
strong:
1: 'CBC'
2: 'BAB'
3: 'CBC'
materials:
A: FLINT
B: DIAMOND
C: GOLD_INGOT
fine:
1: 'CBC'
2: 'BAB'
3: 'CBC'
materials:
A: FLINT
B: EMERALD
C: DIAMOND
# the default recipe for master(the unpickable lock) is made to be impossible
# for Normal Players. requreing both Command blocks and Bedrock.
master:
1: 'CBC'
2: 'BAB'
3: 'CBC'
materials:
A: FLINT
B: COMMAND
C: BEDROCK
- enjoy youre new plugin
![[IMG]](http://proxy.spigotmc.org/6be7ac0c28540398e17b40ca4185e66533f903f0?url=https%3A%2F%2Fpasteboard.co%2FGYDS8EN.png)
- more traps
- Api for developers
- maybe key chains.
- more commands
- more permmssions
Spoiler: Servers using this plugin
list of servers:
- play.agoriacraft.com (website: www.agoriacraft.com)
Spoiler: Bstats:
help support my plugin developerment here
Which data is sent?
If you don't want that your server sends data to bStats you can disable it by setting enabled to false in the bStats config file. The config can be found in the /plugins/bStats/config.yml file.
but i would really love it if you have it enabled, it helps me keep my motviation up and give valuable data abort its uses.
lastly here is a link to its data
https://bstats.org/plugin/bukkit/LocksAndLockpicking
- - Your server's randomly generated UUID
- - The amount of players on your server
- - The online mode of your server
- - The bukkit version of your server
- - The java version of your system (e.g. Java 8)
- - The name of your OS (e.g. Windows)
- - The version of your OS
- - The architecture of your OS (e.g. amd64)
- - The system cores of your OS (e.g. 8)
- - bStats-supported plugins
- - Plugin version of bStats-supported plugins
If you don't want that your server sends data to bStats you can disable it by setting enabled to false in the bStats config file. The config can be found in the /plugins/bStats/config.yml file.
but i would really love it if you have it enabled, it helps me keep my motviation up and give valuable data abort its uses.
lastly here is a link to its data
https://bstats.org/plugin/bukkit/LocksAndLockpicking
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5P356KWNJ6VXC&source=url
and if you infomere me of you discord tag in the message field
or trough pm on here(i will need to check you acuttly donated) then you will be added to a special discord server, where you can get the latest dev builds of this and other projects im working on, and also get faster support and youre suggestions will also be wegiht more heavily.
license: GNU GENERAL PUBLIC LICENSE.
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft version listed: 1.14
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
Locks and Lockpicking is a free Minecraft Java mod. Compatible with Minecraft 1.14. Downloaded 11,036 times (via Spigot). Download it and open it directly in the game.