Minecraft-plugin packetevents

🔌 Om PacketEvents

PacketEvents är ett protokollbibliotek för Minecraft Java Edition som erbjuder ett API för att avlyssna, inspektera, avbryta och skicka raw protocol packets. Det kan användas som ett fristående plugin på en server/proxy eller paketeras som ett biblioteksberoende för andra plugins och mods.

🎯 Syfte

Att tillhandahålla ett stabilt, plattformsoberoende packetlager för utvecklare av plugins och mods så att de kan reagera på och manipulera Minecraft protocol packets (login, play, status, handshake, osv.) utan att skriva låg nivå-kod för Netty eller underhålla många versionsspecifika protokollimplementationer själva.

⚙️ Funktioner

• Händelsestyrd packetavlyssning för inkommande och utgående packets (receive/send events och events på protokollnivå).
• Möjlighet att avbryta eller ändra packets innan server/client behandlar dem.
• API för att skicka och simulera packets programmatiskt.
• Ren lifecycle: create/load/init/terminate en PacketEvents-instans för korrekt resurshantering.
• Stöd för flera moduler: separata builds/modules för vanliga plattformar så att samma API fungerar i olika server/proxy/mod-miljöer.
• Publicerade Javadocs och dokumenterad utvecklarsetup för användning med Maven/Gradle.

🧩 Vem det är för

• Utvecklare av plugins och mods som behöver åtkomst på protokollnivå (skicka, simulera eller ändra packets).
• Serveradministratörer som installerar PacketEvents som beroende för plugins som kräver packet interception.

🏗️ Exempel på användning

• Ett plugin registrerar en packet listener och avbryter ett specifikt inkommande packet för att förhindra standardbearbetning.
• En mod skickar syntetiska packets till en klient för att skapa anpassade visuella effekter eller UI utan ändringar av entities på serversidan.
• Ett proxy-plugin hanterar login/handshake packets för anpassade autentiseringsflöden.

⚙️ Installation

📥 Setup (serveradministratör)

• Ladda ner den officiella plugin-JAR:en och placera den i server/proxy-katalogen plugins/ (eller motsvarande).
• Starta om servern/proxyn och kontrollera loggarna för att bekräfta att PacketEvents laddades korrekt.

🛠️ För utvecklare (build-setup)

PacketEvents distribueras som plattformsspecifika moduler. Dokumentationen visar exempel för Maven/Gradle; biblioteket är avsett att läggas till med scope provided/compileOnly. Docs använder en placeholder för modulnamnet; ersätt den med målplattformens modul (till exempel spigot, velocity, bungeecord, fabric, sponge) när du lägger till en dependency.

Exempel (Gradle-snippet som visas i officiella docs):

// 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")

Anropa bibliotekets lifecycle-metoder från ditt plugin/mod (load -> init) och avsluta när ditt plugin stängs av.

🧠 Tekniska noteringar

• Officiellt tillhandahållna moduler inkluderar Spigot, Velocity, BungeeCord, Fabric och Sponge.
• Projektet noterar att Spigot-modulen är utformad för att fungera på vanligt använda forks som Paper, Purpur och Folia, och att BungeeCord-modulen är avsedd att fungera på Waterfall.
• Projektet publiceras med source, releases och Javadocs; det är licensierat under GPL-3.0.
• Biblioteket är avsett att läggas till med scope provided/compileOnly i plugin-builds när bundling inte är önskvärt; bundlingsinstruktioner är dokumenterade för fall där ett plugin inkluderar PacketEvents i sin distribution.

🤝 När detta plugin är användbart

Om ditt projekt behöver direkt kontroll över Minecraft protocol — för anpassad autentisering, packet-baserade effekter, proxy-hantering eller låg nivå-integrationer — erbjuder PacketEvents ett plattformsoberoende API och lifecycle-hantering så att du kan bygga dessa funktioner utan att behöva implementera om protokollhantering för varje server eller proxy implementation.