<\/p>\n
> **IMPORTANT:**
\n> Changes to the config file will not take effect until the server is restarted<\/p>\n
# KrepAPI-Plugin<\/p>\n
**Run server commands when a player presses a key**\u2014configured in a simple YAML file, no programming required.<\/p>\n
This plugin is the \u201cserver side\u201d of KrepAPI. It talks to the official **KrepAPI mod** on the player\u2019s game client, registers your custom keys, and when someone presses a key you assigned, it runs the command **as that player** (same permissions as if they typed it in chat).<\/p>\n
—<\/p>\n
## Is this for me?<\/p>\n
| You want\u2026 | This plugin |
\n|———–|————-|
\n| Extra keys that run `\/menu`, `\/warp shop`, etc. | Yes |
\n| A server where **everyone can join with a plain vanilla client** | Only if you turn off strict mod checks (see below); otherwise players need the **KrepAPI mod** |
\n| Something that works on **Spigot** only, or without Fabric + KrepAPI on the client | No\u2014players need the matching **KrepAPI** mod for their Minecraft version |<\/p>\n
—<\/p>\n
## What you need<\/p>\n
– **Paper** server, roughly **1.21.4 through 26.1.1** (one plugin JAR for that range; always **test on your exact Paper build** after updates).
\n– **Java** version required by **your** Paper download (often 21; newer Minecraft lines may ask for a newer Java\u2014follow Paper\u2019s download page).
\n– On each **player\u2019s PC**: **Minecraft + Fabric + the KrepAPI mod** build that matches **their** game version (e.g. different mod files for 1.21.x vs 26.x\u2014see the KrepAPI project).<\/p>\n
**Straight talk:** we aim for one JAR across many Paper versions by using only common, stable APIs. If a future Paper update breaks something, you may need a plugin update\u2014report it if that happens.<\/p>\n
—<\/p>\n
## Install (normal server owner)<\/p>\n
1. Download **`KrepAPI-Plugin-*.jar`** (from releases or build it yourself\u2014see below).
\n2. Put it in your server\u2019s **`plugins`** folder.
\n3. Start the server once so **`config.yml`** is created.
\n4. Edit **`plugins\/KrepAPI\/config.yml`** (bindings, timeouts, etc.).
\n5. **Restart** the server so changes apply reliably (avoid `\/reload` unless you know what you\u2019re doing).<\/p>\n
—<\/p>\n
## Configure (`config.yml`)<\/p>\n
**Global options**<\/p>\n
| Setting | Default | In plain English |
\n|———|———|——————|
\n| `require-krepapi` | `true` | If `true`, players **without** the mod (or who don\u2019t finish setup in time) can be **kicked**. Set `false` only if you accept vanilla clients or incomplete handshakes. |
\n| `minimum-mod-version` | `”1.0″` | Lowest KrepAPI **mod** version you allow. Wrong syntax here **disables** the plugin at startup\u2014check the server log. |
\n| `handshake-timeout-ticks` | `200` | How long to wait for the client to answer before kicking (20 ticks \u2248 1 second). |<\/p>\n
**Per key: `bindings. | Setting | Default | In plain English | **Example**<\/p>\n “`yaml Broken binding blocks are skipped and **logged** in the console. There is a **large upper limit** on how many bindings you can define (thousands); you won\u2019t hit it on a normal server.<\/p>\n —<\/p>\n ## Safety (read this)<\/p>\n – Keys only run commands you **listed in `config.yml`**. Random or forged packets can\u2019t trigger other commands through this plugin. —<\/p>\n ## Building from source (optional)<\/p>\n Only needed if you develop or don\u2019t use a prebuilt JAR.<\/p>\n – You need the **KrepAPI** source repo **next to** this folder (default: `..\/KrepAPI`) so Gradle can pull the shared **protocol** module. —<\/p>\n ## For plugin developers<\/p>\n The main class is `net.shik.krepapi.plugin.KrepAPIPlugin`. Plugin name in Bukkit is **`KrepAPI`**. Other plugins can add **extra** minimum client versions:<\/p>\n “`java Protocol and version syntax: see the KrepAPI repo (`docs\/protocol.md`, `docs\/paper-plugin.md`). The source here is commented as a **template** for your own KrepAPI integrations.<\/p>\n —<\/p>\n ## License \/ authors<\/p>\n See this repository and `plugin.yml` for credits and licensing.<\/p>\n","protected":false},"excerpt":{"rendered":" Run server commands when a player presses a key- configured in a simple YAML file, no programming required.<\/p>\n","protected":false},"featured_media":91073,"template":"","meta":{"_minecraft_slug":"krepapi-pl","_minecraft_project_id":"fT3cXvWV","_minecraft_author":"ShinKuyomi","_minecraft_license":"Apache-2.0","_minecraft_downloads":13,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"krepapi-pl.zip","_minecraft_size_bytes":106277,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T22:56:57.242310Z","_minecraft_date_created":"2026-04-11T19:15:43.698469Z","_minecraft_date_modified":"2026-04-06T18:58:35.200899Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/krepapi-pl","_minecraft_icon_attachment_id":91073,"_minecraft_imported_at":"2026-06-05T04:49:49+00:00","_minecraft_import_hash":"8775a7e3f3cce043ac4c14f1ca4bd648","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[89,873,126,127,128,123,92],"mod_loader":[132,133],"minecraft_version":[40,41,38,78,79,80,81,82,83,167],"class_list":["post-91072","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-game-mechanics","mod_category-library","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-technology","mod_category-utility","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21-10","minecraft_version-1-21-11","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"],"yoast_head":"\n
\n|———|———|——————|
\n| `key` | *(required)* | Keyboard code used by the game (GLFW). Many lists exist online (e.g. `71` is often **G**). |
\n| `display-name` | *(required)* | Name players see in the **Controls** screen. |
\n| `command` | *(required)* | Command that runs **when the key is pressed** (with or without `\/`). Runs **as the player**, so permissions are the same as normal chat commands. |
\n| `override-vanilla` | `false` | If `true`, tries to stop Minecraft from using that key for its normal job (where the client supports it). |
\n| `category` | `server` | Group in the controls menu. |<\/p>\n
\nbindings:
\n open_menu:
\n key: 71
\n display-name: “Open server menu”
\n override-vanilla: false
\n category: server
\n command: “menu”
\n“`<\/p>\n
\n– There is a **short cooldown** per player so repeated packets can\u2019t spam commands.
\n– Still: a command runs **with that player\u2019s permissions**. Don\u2019t map a key to dangerous commands unless only trusted players have those permissions.<\/p>\n
\n– Run `.\/gradlew build`. Output: `build\/libs\/KrepAPI-Plugin-1.0.0.jar`.
\n– The **`net.shik:protocol:\u2026`** version in `build.gradle` must match **`mod_version`** in `KrepAPI\/gradle.properties`.<\/p>\n
\nPlugin k = getServer().getPluginManager().getPlugin(“KrepAPI”);
\nif (k instanceof KrepAPIPlugin krep) {
\n krep.versionGate(this).requireMinimumBuildVersion(“1.3.0”);
\n}
\n“`<\/p>\n