# ChestKey<\/p>\n
ChestKey is a Minecraft plugin for Paper (1.21.11) for locking and
\nprotecting chests using unique keys. It works on
\nJava-based servers using Paper API 1.21 or higher and uses
\nonly the official Adventure API for texts. It does not require NMS
\nor Reflection.<\/p>\n
## Features<\/p>\n
– **Unique keys**: Each key is a `TRIPWIRE_HOOK` with a
\n random UUID in the `PersistentDataContainer`, a visible short ID in the
\n Lore, and a glitter effect.
\n– **Lock\/unlock chest**: Shift-right-click on a (Trapped)Chest
\n with a key links the chest to the key without consuming it.
\n Double chests are treated as a single unit.
\n– **Opening**: Only players with a key in their main or off-hand can
\n open locked chests. Incorrect or missing keys block
\n opening and display particles\/indicators.
\n– **Break rules**: Locked chests can only be broken with the correct key.
\n Admins with `chestlock.admin.break` can break any chest.<\/p>\n
– **Crafting duplication**: Mixing a key and an iron ingot
\nproduces two keys with identical UUIDs (provided by a
\n Shapeless recipe).
\n– **Bypass protection**: Hoppers, pistons, and explosions cannot affect
\n locked chests.
\n– **Configurable visual effects**: Particles and small hint signs
\n can be turned on\/off in `config.yml`.<\/p>\n
## Installation<\/p>\n
1. Build the project with Maven:
\n“`bash
\nmvn package
\n“`
\n2. Copy the generated JAR (`target\/chestlock-1.0-SNAPSHOT.jar`) to the
\n`plugins` directory of your Paper server.
\n3. Start the server. When starting for the first time, `messages.yml` and
\n `config.yml` will be created in the plugin data folder.
\n4. Customise `messages.yml` or `config.yml` as needed.<\/p>\n
## Configuration<\/p>\n
`config.yml` currently contains two options:<\/p>\n
“`yaml
\nvisual:
\n particles: true
\n indicator: true
\n“`<\/p>\n
– `particles`: activates particle effects when opening attempts fail
\n and after locking.
\n– `indicator`: displays a temporary \u2018closed\u2019 sign above the chest.<\/p>\n
A complete sample configuration is included in the plugin archive.<\/p>\n
## Messages<\/p>\n
All texts come from `messages.yml` and use the
\nMiniMessage format. You
\ncan customise this file to use translations or your own colours.<\/p>\n
Example entries:<\/p>\n
“`yaml ChestKey is a Paper (1.21.11+) Minecraft plugin that lets you lock and protect chests using unique keys. It uses only the official Adventure API (no NMS or reflection).<\/p>\n","protected":false},"featured_media":39377,"template":"","meta":{"_minecraft_slug":"chestkey","_minecraft_project_id":"YTOxvCyB","_minecraft_author":"leotrax3d","_minecraft_license":"MIT","_minecraft_downloads":57,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"chestkey.zip","_minecraft_size_bytes":116142,"_minecraft_version_count":4,"_minecraft_updated_at":"2026-05-15T20:57:20.366577Z","_minecraft_date_created":"2026-03-04T21:27:21.771475Z","_minecraft_date_modified":"2026-02-28T15:31:05.902122Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/chestkey","_minecraft_icon_attachment_id":39377,"_minecraft_imported_at":"2026-06-01T20:45:28+00:00","_minecraft_import_hash":"a368167c9d9d6d71c43b919eed506c64","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[87,124,844,88,126,127,867,129,91,869,92],"mod_loader":[130,132,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-39376","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-adventure","mod_category-bukkit","mod_category-economy","mod_category-equipment","mod_category-management","mod_category-paper","mod_category-social","mod_category-spigot","mod_category-storage","mod_category-transportation","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\nchest:
\n locked: \u2018
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"