LockIT: Physical and Immersive Protection System
LockIT is a protection plugin designed for Paper servers. It replaces traditional chat-command protection systems with a physical and interactive mechanic. The plugin requires players to use tangible items, specifically locks and forged keys, to secure their chests and doors, introducing a new layer of economy and strategy to the game.
Unlike absolute protection systems, LockIT implements a skill-based lockpicking system. This allows players to attempt to breach protections via a minigame, provided they have the appropriate tools and the target lock is not of the maximum tier.
Key Features
- Physical Protection: Security is applied by physically installing a lock item onto the target block.
- Smithing Mechanics: Keys must be forged in a Smithing Table to receive a unique identification code.
- Fully Configurable: All items, crafting recipes, minigame difficulties, and messages can be modified via configuration files.
- Texture Support: Native support for Custom Model Data for servers utilizing Resource Packs.
Gameplay Mechanics
1. Key Management
To protect an inventory, a player requires a valid key.
- Creation: Keys are crafted in a "blank" state using a crafting table.
- Forging: Interacting with a Smithing Table grants the key a unique ID.
- Copies: In Survival mode, players can create duplicates by clicking a forged key onto a blank key within their inventory.
- Reset: A key code can be erased using a Grindstone.
2. Installation and Usage
The player must hold a Lock in their main hand and the corresponding Key in their inventory.
- Install: Sneak and Right Click on the target block.
- Open/Close: Right Click with the correct key toggles the block state.
- Remove: Sneak and Left Click with the correct key removes the lock and returns the item.
3. Lockpicking System
Players may attempt to open locks using the Lockpick tool. This action opens a graphical interface where the objective is to discover a hidden sequence of pins.
- Failure: Selecting the wrong pin consumes a "life" and breaks the Lockpick item.
- Success: Correctly identifying the entire sequence unlocks the block.
- Penalty: Lives do not regenerate during the session. If they reach zero, the attempt fails completely.
Lock Levels
The plugin offers 6 tiers of locks with progressive crafting costs and difficulty settings. Difficulty determines the number of pins in the minigame and the number of allowed errors.
| Level | Pins (Sequence) | Lives (Attempts) |
|---|---|---|
| 1 | 6 Pins | 5 Lives |
| 2 | 7 Pins | 5 Lives |
| 3 | 8 Pins | 5 Lives |
| 4 | 8 Pins | 4 Lives |
| 5 | 9 Pins | 4 Lives |
| 6 | N/A | Immune to Lockpicks |
Note: The Level 6 lock is technically inviolable via lockpicking, serving as the ultimate protection tier.
Configuration
The plugin generates four main files for server customization:
- items.yml: Allows modification of names, materials, and Custom Model Data for keys, lockpicks, and each lock level.
- craftings.yml: Allows definition or deactivation of crafting recipes for each item.
- lockpick.yml: Allows adjustment of mathematical difficulty (pin count and lives) for each lock level.
- messages.yml: Translation file for all chat and action bar messages.
Commands and Permissions
Routine gameplay does not require commands. The command below is intended for administration and the distribution of special items.
Command: /lockit Permission: lockit.admin (Default: OP)
- /lockit key: Receive a blank key.
- /lockit customkey : Generate a key with a specific code.
- /lockit universalkey: Receive a Universal Key (opens any lock from level 1 to 6).
- /lockit lock <1-6>: Receive a lock of the specified level.
- /lockit lockpick: Receive the lockpicking tool.
Installation
- Download the .jar file.
- Place it in the /plugins folder of your server.
- Restart the server to generate the configuration files.
This plugin is highly inspired by the Locks and Lockpicking plugin, which was discontinued in 2019.
If you'd like to request a new feature or report a bug, reach me on Discord: o_stein
