# \u2328\ufe0f Keybind<\/p>\n
Bind keys to server-side commands. Press a key, the server runs a command.<\/p>\n
**Client Mod (Fabric)** \u2022 **Server Plugin (Paper)**<\/p>\n
| Component | Environment | Platform |
\n| :— | :— | :— |
\n| `KeybindMod` | **Client only** | Fabric (MC 26.1.2) |
\n| `KeybindPlugin` | **Server only** | Paper 1.18.2+ |<\/p>\n
—<\/p>\n
## \u2728 Features<\/p>\n
– \ud83d\udd17 **Server-Driven**: Actions are defined entirely on the server and synced to the client on join. —<\/p>\n ## \ud83d\ude80 How It Works<\/p>\n 1. **Sync**: 1 second after a player joins, the plugin sends all configured actions (name, display name, default key) over the `keybind:sync` channel. —<\/p>\n ## \ud83d\udee0\ufe0f Installation<\/p>\n ### Server Side ### Client Side > The mod works on any server. On servers without the plugin, no keybinds are registered.<\/p>\n —<\/p>\n ## \u2699\ufe0f Configuration<\/p>\n ### `plugins\/Keybind\/config.yml` actions: home: **Notes:** —<\/p>\n ## \u2328\ufe0f Supported Keys<\/p>\n ### Keyboard ### Mouse —<\/p>\n ## \ud83d\udcdc Commands & Permissions<\/p>\n | Command | Description | Permission | | Permission | Description | Default | —<\/p>\n ## \ud83c\udfd7\ufe0f Building from Source<\/p>\n “`bash Output jars: Requires Java 17+ for the plugin, Java 25+ for the mod.<\/p>\n —<\/p>\n ## \ud83d\udd12 Security<\/p>\n – Action names are validated server-side against `^[a-zA-Z0-9_]+$` \u2014 arbitrary input is rejected. \u2328\ufe0f Bind keys to server-side commands. Press a key, the server runs a command.<\/p>\n","protected":false},"featured_media":90156,"template":"","meta":{"_minecraft_slug":"keybind","_minecraft_project_id":"yuttqmXl","_minecraft_author":"iM5LB1","_minecraft_license":"MIT","_minecraft_downloads":30,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"keybind.zip","_minecraft_size_bytes":40669,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T22:13:00.042114Z","_minecraft_date_created":"2026-05-08T04:08:59.810539Z","_minecraft_date_modified":"2026-05-08T02:08:27.476151Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/keybind","_minecraft_icon_attachment_id":90156,"_minecraft_imported_at":"2026-06-05T03:32:56+00:00","_minecraft_import_hash":"03294d80507227c32cb28d20d3e16b20","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,97,89,127,128,129,123,92],"mod_loader":[99],"minecraft_version":[51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82,83,167,163],"class_list":["post-90155","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-fabric","mod_category-game-mechanics","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-technology","mod_category-utility","mod_loader-fabric","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","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","minecraft_version-26-1","minecraft_version-26-1-1","minecraft_version-26-1-2"],"yoast_head":"\n
\n– \ud83d\udcc1 **Per-Server Storage**: Key assignments are saved per server IP in `.minecraft\/config\/keybind-servers\/` and never overwritten on rejoin.
\n– \ud83d\udee0\ufe0f **Dynamic Registration**: New server actions appear in your **Settings \u2192 Controls** menu without restarting the game.
\n– \ud83c\udff7\ufe0f **Custom Display Names**: Server owners set friendly names (e.g., `”Teleport to Spawn”` instead of `spawn`).
\n– \u23f1\ufe0f **Dual Cooldowns**: Both a global cooldown (between any actions) and per-action cooldowns prevent spam.
\n– \ud83d\udd10 **Permission Support**: Each action supports an optional extra permission node on top of `keybind.use`.
\n– \ud83d\udce1 **Plugin Messaging**: Uses `keybind:main` \/ `keybind:sync` plugin message channels. Falls back to `\/kbind
\n– \ud83e\uddf9 **Stale Action Cleanup**: Obsolete actions from previous sessions are automatically removed from the Controls menu and saved config.<\/p>\n
\n2. **Registration**: The mod registers each action as a native Minecraft keybind under the **Keybind** category in **Settings \u2192 Controls**.
\n3. **Trigger**: When a key is pressed (and no screen is open), the mod sends the action name over the `keybind:main` channel.
\n4. **Execution**: The plugin validates the action name (alphanumeric + underscores only), checks permissions and cooldowns, then runs the command.<\/p>\n
\n1. Place `KeybindPlugin.jar` into your `plugins\/` folder.
\n2. Restart the server \u2014 `plugins\/Keybind\/config.yml` is generated automatically.
\n3. Edit `config.yml` to define your actions, then run `\/kbind reload`.<\/p>\n
\n1. Place `KeybindMod.jar` into your `.minecraft\/mods\/` folder.
\n2. Requires **Fabric Loader 0.18.4+** and **Fabric API**.
\n3. Launch the game and connect to any server running the plugin.<\/p>\n
\n“`yaml
\n# Global cooldown between any keybind actions (milliseconds)
\nglobal-cooldown: 500<\/p>\n
\n spawn:
\n command: “spawn” # Command to run (without \/)
\n display-name: “Spawn” # Label shown in Controls menu
\n default-key: “LEFT_BRACKET” # Suggested key for first-time players
\n permission: “” # Optional extra permission node (leave empty for none)
\n cooldown: 1000 # Per-action cooldown (ms); defaults to global-cooldown
\n console: false # true = run as console with {player} replaced by player name<\/p>\n
\n command: “home”
\n display-name: “Home”
\n default-key: “RIGHT_BRACKET”
\n permission: “”
\n cooldown: 1000
\n console: false
\n“`<\/p>\n
\n– Action names must be alphanumeric + underscores only (e.g. `my_action`).
\n– `console: true` runs the command as the console sender. Use `{player}` as a placeholder for the player’s name (e.g. `command: “tp {player} spawn”`).
\n– `default-key` is only applied the first time a player connects. Their saved binding is used on subsequent joins.<\/p>\n
\n| Category | Values |
\n| :— | :— |
\n| Letters | `A`\u2013`Z` |
\n| Numbers | `0`\u2013`9` |
\n| Function | `F1`\u2013`F25` |
\n| Arrows | `UP`, `DOWN`, `LEFT`, `RIGHT` |
\n| Navigation | `PAGE_UP`, `PAGE_DOWN`, `HOME`, `END`, `INSERT`, `DELETE` |
\n| Special | `SPACE`, `ENTER`, `TAB`, `BACKSPACE`, `ESCAPE`, `PAUSE` |
\n| Lock keys | `CAPS_LOCK`, `SCROLL_LOCK`, `NUM_LOCK` |
\n| Other | `PRINT_SCREEN`, `MENU` |
\n| Modifiers | `LEFT_SHIFT`, `LEFT_CONTROL` (or `LEFT_CTRL`), `LEFT_ALT`, `LEFT_SUPER`, `RIGHT_SHIFT`, `RIGHT_CONTROL` (or `RIGHT_CTRL`), `RIGHT_ALT`, `RIGHT_SUPER` |
\n| Numpad | `KP_0`\u2013`KP_9`, `KP_ADD`, `KP_SUBTRACT`, `KP_MULTIPLY`, `KP_DIVIDE`, `KP_DECIMAL`, `KP_ENTER`, `KP_EQUAL` |
\n| Symbols | `LEFT_BRACKET`, `RIGHT_BRACKET`, `BACKSLASH`, `SEMICOLON`, `APOSTROPHE`, `COMMA`, `PERIOD`, `SLASH`, `GRAVE_ACCENT`, `MINUS`, `EQUAL` \u2014 or the character directly: `[`, `]`, “, `;`, `’`, `,`, `.`, `\/`, “ ` “, `-`, `=` |
\n| World keys | `WORLD_1`, `WORLD_2` (locale-specific keys on some keyboards) |<\/p>\n
\n| Value | Aliases | Button |
\n| :— | :— | :— |
\n| `MOUSE_LEFT` | `MOUSE_1` | Left click |
\n| `MOUSE_RIGHT` | `MOUSE_2` | Right click |
\n| `MOUSE_MIDDLE` | `MOUSE_3` | Middle click |
\n| `MOUSE_4`\u2013`MOUSE_8` | \u2014 | Side\/extra buttons |<\/p>\n
\n| :— | :— | :— |
\n| `\/kbind
\n| `\/kbind list` | List all configured action names | *(any)* |
\n| `\/kbind reload` | Reload config and re-sync all online players | `keybind.admin` |<\/p>\n
\n| :— | :— | :— |
\n| `keybind.use` | Required to trigger any action | `true` (everyone) |
\n| `keybind.admin` | Access to `\/kbind reload` | `op` |
\n| `keybind.bypass.cooldown` | Ignore all cooldowns | `op` |<\/p>\n
\n.\/gradlew clean build
\n“`<\/p>\n
\n– `keybind-plugin\/build\/libs\/KeybindPlugin-1.0.0.jar`
\n– `keybind-mod\/build\/libs\/KeybindMod-1.0.0.jar`<\/p>\n
\n– Packet length is capped at 256 bytes.
\n– All command execution happens on the main server thread.
\n– Players without `keybind.use` cannot trigger any action, even via direct `\/kbind` command.<\/p>\n","protected":false},"excerpt":{"rendered":"