Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/iFamishedX/HungerBridge/llms.txt

Use this file to discover all available pages before exploring further.

HungerBridge is a unified Fabric + Paper/Purpur server mod and plugin that gives HungerLib a reliable, secure channel for executing console commands, writing log entries, and querying live server data — all over a lightweight HTTP API, with no RCON required.

The Problem with RCON

Minecraft’s built-in RCON protocol was never designed for high-frequency programmatic use. It is a raw TCP protocol with limited error signaling, no structured response format, and a history of security and reliability concerns. HungerLib needs to run commands frequently and react to structured server state — something RCON cannot cleanly provide. HungerBridge replaces that entire layer with a small, self-contained HTTP server that speaks JSON and requires an explicit authentication key on every request.

Platform Support

HungerBridge ships as two independent JARs built from a shared common module, so behavior is identical regardless of which platform you run.

Fabric 1.21.11

Requires Fabric Loader ≥ 0.18.4 and Minecraft ≥ 1.21.10. Drop the fabric JAR into your mods/ directory and go.

Paper / Purpur 1.21.11

Requires Paper API 1.21. Compatible with any Paper fork, including Purpur. Drop the paper JAR into your plugins/ directory.

The HTTP API — Three Generations

HungerBridge exposes three generations of endpoints under a single HTTP server. All three live on the same port and share the same X-Auth-Key header for authentication.
GenerationPath prefixFormatStatus
Legacy/run, /logPlain-text bodyDisabled by default
v1/v1/run, /v1/log, /v1/status, /v1/versionJSONDisabled by default
v2/v2/ping, /v2/info, /v2/status, /v2/run, /v2/log, /v2/tps, /v2/playersJSONEnabled by default
The v2 generation is the current, fully-featured API and is the one HungerLib targets. The v1 and legacy generations are preserved for backward compatibility and can be selectively enabled in the configuration file if needed.
Every endpoint generation can be toggled individually per-endpoint in config.yaml. You always retain precise control over which surface area is exposed.

Key Features

No RCON Needed

HungerBridge replaces RCON entirely. The HTTP server starts automatically on plugin/mod load and stops cleanly on shutdown.

Shared-Secret Auth

Every request must carry an X-Auth-Key header matching the secret in config.yaml. A random UUID is generated on first run so you are protected out of the box.

Structured JSON Responses

v1 and v2 endpoints return well-formed JSON with a top-level ok boolean, making error handling straightforward for any HTTP client.

Command Execution

Execute any console command as the server console via POST /v2/run. Optional silent and show_console fields give you full control over output capture.

Live Server Metrics

Query real-time TPS (1-minute, 5-minute, and 15-minute averages plus raw tick time) and the current online player list via dedicated v2 endpoints.

Per-Endpoint Toggles

Each individual endpoint — across all three API generations — can be enabled or disabled independently in a single config.yaml.

Auto-Generated Config

On first run, HungerBridge writes a default config.yaml with a fresh random auth key. No manual setup is required to get started.

Identical on Both Platforms

The HTTP server logic lives in a shared common module. Behavior, endpoint paths, and config structure are identical on Fabric and Paper.

What’s Next

Ready to get HungerBridge running on your server?

Installation →

Download the right JAR for your platform and get HungerBridge installed in minutes.

Build docs developers (and LLMs) love