Minecraft plugin packetevents

🔌 About PacketEvents

PacketEvents — is a plugin/library for Minecraft servers that provides a high‑performance packet (Netty) API and an injectable plugin build to let other plugins read, modify and send raw Minecraft packets.

🎯 Purpose

PacketEvents exists to give plugin developers a portable, efficient way to work with Minecraft network packets. It solves the problem of directly handling low‑level Netty packet code and protocol differences across server platforms by offering a unified API and platform adapters. PacketEvents is intended for developers building advanced features (for example custom client entities, packet‑level optimizations, anti‑cheat systems or other networked gameplay tweaks) rather than direct end‑user gameplay features.

⚙ Main capabilities

• Provide a platform‑agnostic packet API and packet wrappers.
• Inject into Netty channel pipeline to intercept and send packets.
• Offer adapters for multiple platforms (Spigot/Paper, BungeeCord, Velocity, Fabric, Sponge and others where Netty is used).
• Provide example projects and Javadocs to speed up development. ()

🧩 Who it's for

PacketEvents targets plugin developers and server projects that need low‑level packet access. It is not a user‑facing gameplay plugin; rather, it is a developer library/plugin that other plugins depend on.

🏗 Usage examples

• A plugin creates client‑side fake entities visible only to certain players by sending crafted entity packets via PacketEvents.
• An anti‑cheat uses PacketEvents to monitor and validate client movement packets at high throughput.
• A scoreboard or GUI system sends optimized packet updates to reduce server load.

⚡ Notable facts

• PacketEvents is published and maintained on GitHub (retrooper/packetevents) under GPL‑3.0 license. ()
• Binary/plugin builds are distributed on Modrinth and GitHub Releases; keep them updated to avoid mismatches with shaded copies. ()

⌨️ Commands

🔐 Permissions

⚙ Installation

📥 Install

• Download the appropriate packetevents server plugin jar (e.g., packetevents‑spigot) from Modrinth or GitHub Releases.
• Place the .jar into your server's plugins/ directory.
• Restart the server (full restart is recommended; do not rely on /reload).

📦 Dependencies and recommendations

• PacketEvents is a Netty‑based library and runs on Netty‑powered platforms (Spigot/Paper, BungeeCord, Velocity, Fabric, Sponge). Use the platform build matching your server. ()
• The PacketEvents wiki recommends adding soft‑depends for several optional plugins when developing a Spigot module (examples: ProtocolLib, ProtocolSupport, ViaVersion, ViaBackwards, ViaRewind, Geyser‑Spigot) so injectors load in the correct order. These are recommendations for compatibility, not mandatory runtime dependencies. ()
• Do not bundle an outdated shaded copy of PacketEvents inside other plugins unless you understand relocation/shading; the project docs explain the problems of bundling. ()

🧾 Configuration

• Official documentation does not document a user‑facing config.yml created by the packetevents plugin itself; many users run PacketEvents as a library without requiring additional configuration. If a platform build generates a config, consult the specific release notes / Javadocs. (Information not fully specified in official docs.) ()

🗄 Database support

• PacketEvents is a packet library and does not provide built‑in MySQL/SQLite data features. Plugin authors using PacketEvents may add database support in their own plugins.

🧠 Additional information

Known conflicts & limitations

• Multiple plugins shading different versions of PacketEvents can cause runtime errors (injection failures, class conflicts). The docs explicitly discuss the problem of bundling/shading. ()
• Some server administrators report injection issues or player disconnects when PacketEvents or shaded copies are mismatched with server/platform versions; check release notes and issues before upgrading. Example: reported reload/injection issues in GitHub issues. ()

FAQ

Q: Should I shade PacketEvents into my plugin? A: The official docs advise caution: shading can cause version conflicts for server operators. Prefer depending on the server‑side packetevents plugin or shade with proper relocation and minimization per the project's shading guide. ()

Q: Can I run ProtocolLib and PacketEvents together? A: They can coexist, but both intercept packets; conflicts may occur in rare cases. Test on a staging server and follow the docs about injector order and soft‑depends. (Community reports and docs discuss compatibility caveats.) ()

Q: Does PacketEvents collect telemetry (bStats)? A: No official indication of built‑in bStats telemetry was found in the authoritative docs or repository. Plugin authors should check their specific builds. (Information absent from official sources.)

Q: Is there Discord support? A: PacketEvents maintains a Discord invite referenced in its documentation/wiki for support and community discussion. ()

🤝 When to use PacketEvents

Use PacketEvents when you need performant, low‑level packet control for plugin development on Netty‑based Minecraft platforms and when you can manage shading/injection concerns across your server ecosystem. It is a developer‑focused, cross‑platform packet API rather than a direct gameplay plugin. ()