Minecraft plugin packetevents

🔌 O PacketEvents

PacketEvents je protokolová knihovna pro Minecraft Java Edition, která nabízí API pro zachytávání, kontrolu, rušení a odesílání raw protocol packets. Lze ji použít jako samostatný plugin na server/proxy nebo ji přibalit jako knihovní závislost pro jiné pluginy a mody.

🎯 Účel

Poskytnout stabilní, multiplatformní vrstvu packetů pro vývojáře pluginů a modů, aby mohli reagovat na Minecraft protocol packets a pracovat s nimi (login, play, status, handshake atd.) bez psaní nízkoúrovňového kódu Netty nebo bez vlastní údržby mnoha verzově specifických implementací protokolu.

⚙️ Funkce

• Intercept packetů řízený událostmi pro příchozí a odchozí packety (receive/send events a události na úrovni protokolu).
• Možnost zrušit nebo upravit packet předtím, než jej server/client zpracuje.
• API pro programové odesílání a simulaci packetů.
• Čistý lifecycle: create/load/init/terminate instance PacketEvents pro správnou správu prostředků.
• Podpora multi-module: samostatné buildy/moduly pro běžné platformy, aby stejné API fungovalo napříč různými prostředími server/proxy/mod.
• Publikované Javadocs a zdokumentované nastavení pro vývojáře pro použití s Maven/Gradle.

🧩 Pro koho je určeno

• Vývojáře pluginů a modů, kteří potřebují přístup na úrovni protokolu (odesílání, simulace nebo úprava packetů).
• Provozovatele serverů, kteří instalují PacketEvents jako závislost pro pluginy vyžadující packet interception.

🏗️ Příklady použití

• Plugin zaregistruje packet listener a zruší konkrétní příchozí packet, aby zabránil výchozímu zpracování.
• Mod odešle klientovi syntetické packety a vytvoří vlastní vizuální efekty nebo UI bez změn entity na straně serveru.
• Proxy plugin zpracuje login/handshake packety pro vlastní autentizační tok.

⚙️ Instalace

📥 Nastavení (provozovatel serveru)

• Stáhněte oficiální plugin JAR a umístěte jej do adresáře plugins/ na serveru/proxy (nebo do odpovídajícího adresáře).
• Restartujte server/proxy a zkontrolujte logy, abyste potvrdili, že PacketEvents byl načten správně.

🛠️ Pro vývojáře (nastavení buildu)

PacketEvents je distribuován jako moduly specifické pro platformu. Dokumentace ukazuje příklady pro Maven/Gradle; knihovna se má přidávat se scope provided/compileOnly. V dokumentaci se používá placeholder pro název modulu; při přidávání dependency jej nahraďte modulem cílové platformy (například spigot, velocity, bungeecord, fabric, sponge).

Příklad (Gradle snippet uvedený v oficiální dokumentaci):

// Replace INSERT_MODULE_HERE with a supported module name (spigot, velocity, bungeecord, fabric, sponge)
compileOnly("com.github.retrooper:packetevents-~~INSERT_MODULE_HERE~~:2.12.1")

Volajte metody lifecycle knihovny z vašeho pluginu/modu (load -> init) a ukončete ji, když se plugin vypne.

🧠 Technické poznámky

• Mezi oficiálně poskytované moduly patří Spigot, Velocity, BungeeCord, Fabric a Sponge.
• Projekt uvádí, že modul Spigot je navržen pro práci na běžně používaných forkách, jako jsou Paper, Purpur a Folia, a modul BungeeCord je určen pro Waterfall.
• Projekt je publikován se source, releases a Javadocs; je licencován pod GPL-3.0.
• Knihovna je určena k přidání se scope provided/compileOnly do plugin buildů, pokud není žádoucí bundling; pokyny pro bundling jsou zdokumentovány pro případy, kdy plugin zahrnuje PacketEvents ve své distribuci.

🤝 Kdy je tento plugin užitečný

Pokud váš projekt vyžaduje přímou kontrolu nad Minecraft protocol — pro vlastní autentizaci, efekty založené na packetech, zpracování proxy nebo nízkoúrovňové integrace — PacketEvents poskytuje multiplatformní API a správu lifecycle, takže můžete tyto funkce vytvářet bez opětovné implementace zpracování protokolu pro každý server nebo proxy implementation.