Locks & Keys

Locks & Keys

 

Welcome to L&K! It adds keys for your locks! (Also check out LockInteract)

 

2.0.1 Update: Some new config options and a few config fixes to prevent crashes are added in this update, please delete and re-generate your config files.

2.0.3 Update:

• All vanilla metals added as key material. You can now use anything from Bismuth to Platinum for your keys
• Binding a key now does not require a specific tier of metal file, you can use any file on any key
• Files are now only seperated by durability
• File durability overall decreased

Part-1: Keys and Files

 

From the moment you install this mod, all locked blocks, doors etc. now require a matching key which exists in your inventory to interact with.

 

You do not need to hold the key in your hands, it can stay in your backpack and there are even key rings for you to conveniently carry your keys with you.

 

Keys are matched to a player or a player group, not to a specific lock.

 

To bind a key to yourself or to a group you are a part of, you first smith or cast a Key File and a Key

 

Then, you can bind a key to yourself or a group by using Interact with the File in your offhand, and the Key in your main hand.

 

Note: With the default configs, only the owners and OP members of groups can file keys.

 

Part-2: Using Keys

 

So now there are keys in the world that you can carry around, and they allow you to access the locks for your own self or your group.

 

But what happens if you misplace a key? Could nefarious troublemakers access your home and treasure?

Yes! but only to a limited extent.

 

The keys in L&K have a configurable value that determines how many times they can be used by unauthorised users before they break. By default, someone who is not you can use one of your keys to interact with one of your locks three times after which the key breaks.

 

This value does not decrease if an authorised owner uses the key, only an unauthorised ne'r-do-well accessing your locks will break a key.

 

Keys work even when you are not holding them in your hand. You can carry them loose in your inventory, or utilise a handy Keyring to make things easier for yourself.

 

Part-3: Keyrings

 

Keyrings are utility items that allow you to carry serveral keys on your person while using only 1 inventory slot.

 

They can be made cheaply from rope (these will have only 2 slots for keys) or can be forged from metal. Higher quality metals will grant you more key slots!

 

Keyrings use their own inventory system. You can access a keyring by pressing Interact, which will open an inventory window.

 

A key stored in a keyring will work exactly the same as a key carried loose in your pockets.

Config

 

The default config for the mod is as follows:

{
  "AdminBypassKeyRequirement": false,
  "ExemptPlayerUids": [],
  "ExemptGroupNames": [],
  "LimitUnauthorisedUse": true,
  "KeyDurability": 3,
  "GroupFilingRequiresOwnerOrOp": true,
  "AdminBypassPrivilege": "commandplayer",
  "ShowKeyBindingInfo": true,
  "KeyringSlotsByMaterial": {
    "rope": 2,
    "tinbronze": 3,
    "bismuthbronze": 3,
    "blackbronze": 3,
    "iron": 4,
    "meteoriciron": 5,
    "steel": 6
  },
  "DefaultKeyringSlots": 4
}

AdminBypassKeyRequirement => This option determines if an admin of sufficient privilege can open or close your locked blocked without a key

ExemptPlayerUids => UIDs in this list are not subject to the key-lock system of this mod. They don't need to carry keys around basically

ExemptGroupNames => Same as above, but now no-one in the group needs to carry keys

LimitUnauthorisedUse => This options turns on or off the system that makes keys break after X number of unauthorised uses

KeyDurability => This value is the number of times a key can be used by a stranger before breaking. Only useful if the above option is turned on

GroupFilingRequiresOwnerOrOp => Determines if binding a key to a group lock can only be done by the group admin or an OP member. If turned off, anyone in a group can produce keys for that group.

AdminBypassPrivilege => Determines the level of admin privilege needed for AdminBypassKeyRequirement to work

ShowKeyBindingInfo => Determines if users can see to which group or player a key is bound to. This option turns on or off the "Bound to: X" info line in the description for all players.

KeyringSlots => You can adjust how many slots a certain keyring has using this option. Keys might be lost if you change this option with keys still in your keyrings.

Compatibility

 

This mod is INCOMPATIBLE with Thievery. (Technically it CAN be compatible, but I would advise against it. They both touch the same systems)

 

Tested with so far:

LockInteract

Carry On

Future Plans:

 

Get better models and textures (I am an ameteur visual designer at best, taking any and all applications for help in this regard)

Fix item transforms so items are less floaty in world

Figure out if you can make keys render on a keyring (no promises on this one)