diff --git a/.github/hangar-description.md b/.github/hangar-description.md index 4665a0e56..432a0a740 100644 --- a/.github/hangar-description.md +++ b/.github/hangar-description.md @@ -19,6 +19,15 @@ the normal plugin setup does not require a backend Geyser installation. For more routing features and the connector that receives the most frequent updates, consider the [Gate connector](https://connect.minekube.com/guide/connectors/). +## Requirements + +- **Minecraft 1.13+** on Paper/Spigot (and supported proxy versions on Velocity and + BungeeCord) — the declared `api-version` floor and the first version whose servers + ship the Netty 4.1+ the plugin's bundled Netty (4.2.x, unrelocated) requires. + Servers 1.8–1.11 ship Netty 4.0.x, where the packet listener injection fails with + `AbstractMethodError` (missing `newChild` implementation). +- **Java 17+** to run the plugin. + ## Quick start 1. Download the jar for your platform and place it in the server or proxy diff --git a/README.md b/README.md index ef708f29f..833775d46 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,16 @@ low latency edge proxies network nearest to you. Please refer to https://connect.minekube.com for more documentation. +## Requirements + +- **Minecraft 1.13 or newer** — the declared `api-version` floor in `plugin.yml`, and + the version from which servers ship the Netty 4.1+ the plugin's bundled Netty (4.2.x, + unrelocated) requires. Servers 1.8–1.11 ship Netty 4.0.x, where the packet listener + injection fails with `AbstractMethodError` (missing `newChild` implementation) and the + plugin disables itself. +- **Java 17 or newer** — the plugin is compiled for Java 17; older server JVMs + (Java 8/11, typical for Minecraft ≤1.12 servers) cannot load it. + ## Integrating with login / auth plugins Connect authenticates players at the edge, so login plugins that force online mode on a