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 Minecraft server mod (Fabric) and plugin (Paper/Purpur) that starts a small HTTP server inside your Minecraft process. It gives HungerLib — and any other authorized HTTP client — a simple, secure way to run console commands, write log entries, check TPS, and list online players, all without enabling RCON.

Installation

Download the JAR for Fabric or Paper and drop it into your server.

Configuration

Set your port, auth key, and toggle individual endpoints via YAML.

API Reference

Explore every HTTP endpoint — request fields, responses, and error codes.

Authentication

Learn how the X-Auth-Key header protects every request.

How it works

When your Minecraft server starts, HungerBridge binds to a configurable TCP port (default 30007) and registers a set of HTTP routes. Every request must carry a shared secret in the X-Auth-Key header. Depending on the platform, commands are dispatched through Fabric’s command dispatcher or Paper’s dispatchCommand API — both on the server’s main thread — ensuring thread-safety and proper command lifecycle.
1

Install HungerBridge

Place the appropriate JAR (fabric or paper) in your server’s mods/ or plugins/ directory.
2

Start the server once

HungerBridge generates config/HungerBridge/config.yaml (Fabric) or plugins/HungerBridge/config.yaml (Paper) with a random auth key and sensible defaults.
3

Set your auth key

Open the generated config, copy your auth.key, and share it with HungerLib or your HTTP client.
4

Make your first request

Send a GET /v2/ping with X-Auth-Key: <your-key> to confirm the bridge is running.

Platform support

Fabric 1.21.11

Install as a server-side mod. Requires Fabric Loader ≥ 0.18.4.

Paper / Purpur 1.21.11

Install as a Bukkit-compatible plugin. Requires Paper API 1.21.
HungerBridge is designed to work alongside HungerLib. It can also be used independently by any HTTP client that holds the auth key.

Build docs developers (and LLMs) love