Minecraft plugin HamsterAPI

🔌 About HamsterAPI

HamsterAPI — is a lightweight Java library/API for Minecraft servers that lets plugin developers listen to, read, modify and send network packets without using NMS or extensive reflection. HamsterAPI targets server developers who need a stable packet listener/injector and utilities for titles, action bars and BungeeCord messaging. HamsterAPI is a library (not a gameplay plugin) intended for Spigot/Paper (Bukkit‑style) servers and third‑party plugins.

🎯 Purpose

HamsterAPI solves the problem of low‑level packet handling for plugin developers: it provides a safe API to intercept incoming/outgoing packets, decode/decompress raw byte buffers, and send crafted packets to players. This avoids each plugin implementing fragile Reflection/NMS code and centralizes packet injection logic. HamsterAPI is used as a dependency by other server plugins that require packet‑level access. ()

⚙ Main features

• Lightweight packet injection & listener (PacketDecodeEvent, PacketReceiveEvent, PacketSendEvent). ()
• Utilities: BufferIO for decoding bytebufs, Reflection helper to access NMS/Craft classes, PacketInjector management. ()
• High‑level helpers: send Title, Subtitle, ActionBar to players via API methods. ()
• Safe disconnect / instant channel close and BungeeCord messaging helpers (kick, switch server, channel messages). ()

🧩 Who it is for

• Plugin developers needing packet‑level control on Spigot/Paper servers.
• Server operators who run plugins that depend on a packet API (HamsterAPI as a library dependency).
• Authors of anti‑exploit, proxy or low‑level networking plugins. ()

🏗 Usage examples

• A minigame plugin uses HamsterAPI to send custom ActionBar messages and intercept specific client packets.
• An anti‑exploit plugin relies on HamsterAPI to decode incoming byte buffers and block malformed packets before they reach game logic. ()

⌨️ Commands

The HamsterAPI repository and Spigot resource describe the project as a library. It does not provide gameplay commands for end users.

The plugin does not add new commands. ()

🔐 Permissions

HamsterAPI is a developer library and does not declare runtime plugin permissions for players in the usual sense. If a plugin that depends on HamsterAPI defines permissions, those are defined by that plugin (not HamsterAPI itself). Information about runtime permissions usage is not present in official sources. ()

⚙ Installation

📥 Installation

• Download the HamsterAPI .jar (library) from the official resource (Spigot/GitHub releases). ()
• Place the .jar in your server's plugins/ folder or include it as a dependency in your plugin build.
• If you are building a plugin that uses HamsterAPI, add HamsterAPI as a dependency in your plugin.yml and your build system (Maven/Gradle). ()
• Restart the server (full restart recommended).

📦 Dependencies

• Official sources do not list external runtime dependencies required by HamsterAPI. It is distributed as a standalone library for Bukkit/Spigot/Paper. If your plugin uses economy/chat placeholders etc., include those libs separately. ()

🧾 Configuration

• Official resources do not document that HamsterAPI generates a config.yml or requires per‑server configuration. HamsterAPI is focused on providing Java APIs rather than user config. If configuration exists, it is documented in the library docs or in the dependent plugin. (Information not found in official sources.) ()

🧠 Additional information

⚠ Known issues & conflicts

• Some users reported injection failures or warnings when injecting on certain newer server versions; check server logs for "Failed to inject" messages. These are reported in Spigot resource reviews. ()
• User reports mention memory‑leak diagnostics and injection errors in older reviews—test on staging before production. ()
• Plugins that add alternate packet listeners may conflict; when combining packet listeners (e.g., ProtocolLib or other low‑level listeners), test carefully to avoid pipeline conflicts. Spigot listings and ecosystem notes recommend caution. ()

❓ FAQ

Q1: Which Minecraft versions are supported? A1: The Spigot resource lists tested versions from 1.8 through 1.21 and the project claims broad compatibility; still, test on your target version. ()

Q2: Does HamsterAPI add commands or permissions? A2: No — HamsterAPI is a developer library and exposes Java APIs; it does not add player commands or permissions itself. ()

Q3: Does HamsterAPI collect telemetry (bStats)? A3: Official sources do not mention bStats or telemetry. Information not found in the official docs. ()

Q4: Is there Discord support? A4: The Spigot resource links to a Discord for support; the project maintains community support via Discord. ()

📌 Summary

HamsterAPI is a focused Java packet API for plugin developers who need reliable packet injection/listening and helpers for titles/actionbars/Bungee communication. It is intended as a library dependency (not an end‑user gameplay plugin) for Spigot/Paper ecosystem. Always test injection on your server version and review logs for injector errors. ()