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.

Installing HungerBridge takes only a few minutes. The process differs slightly between Fabric and Paper, but in both cases it boils down to dropping a single JAR file into the right directory and starting your server. This page walks you through every step for both platforms.

​
Prerequisites

Make sure your environment meets these requirements before downloading HungerBridge.

Java 21

HungerBridge is compiled for Java 21. The GitHub Actions release pipeline uses the Temurin distribution. Both Fabric and Paper require Java 21 for Minecraft 1.21.x anyway, so no extra setup is needed in most cases.

Minecraft 1.21.11

The current release targets Minecraft 1.21.11. Fabric requires loader ≥ 0.18.4 and Minecraft ≥ 1.21.10. Paper requires API 1.21 or newer.
HungerBridge is a server-side only mod/plugin. It does not need to be installed on clients. On Fabric, the fabric.mod.json declares "environment": "server".

​
Download

All releases are published on the HungerBridge GitHub Releases page. Each release provides two JARs — one per platform — following this naming convention: 
HungerBridge-fabric-{version}+{mc_version}.jar
HungerBridge-paper-{version}+{mc_version}.jar
For example, the 2.5.2-alpha release for Minecraft 1.21.11 is distributed as: 
HungerBridge-fabric-2.5.2-alpha+1.21.11.jar
HungerBridge-paper-2.5.2-alpha+1.21.11.jar
Download the JAR that matches your server platform and keep it handy for the installation steps below.

​
Installation

1

Verify Fabric Loader version

HungerBridge requires Fabric Loader ≥ 0.18.4. Check your loader version in the Fabric installer or in your server’s startup log. Upgrade the loader if necessary before continuing.
2

Download the Fabric JAR

From the Releases page, download the file named:
HungerBridge-fabric-2.5.2-alpha+1.21.11.jar
3

Place the JAR in mods/

Copy the downloaded JAR into your server’s mods/ directory:
cp HungerBridge-fabric-2.5.2-alpha+1.21.11.jar /path/to/server/mods/
Your mods/ directory should now contain the HungerBridge JAR alongside any other server-side mods.
4

Start the server

Start (or restart) your Fabric server normally. On the very first run, HungerBridge will detect that no configuration file exists and generate one automatically.You will see a log line similar to:
[HungerBridge] WARN Config file not found, generating default config at config/HungerBridge/config.yaml
[HungerBridge] INFO HungerBridge HTTP server started on port 30007
5

Locate the generated config

The auto-generated configuration file is written to:
config/HungerBridge/config.yaml
This file contains your randomly generated auth key. See the Configuration page for a full reference of every available option.

​
First-Run Behavior

When HungerBridge starts and cannot find a config.yaml, it:
  1. Creates the containing directory (config/HungerBridge/ or plugins/HungerBridge/) if it does not exist.
  2. Generates a fresh config.yaml with port: 30007 and a randomly generated UUID as the auth.key.
  3. Enables all v2 endpoints and leaves v1 and legacy endpoints disabled.
  4. Starts the HTTP server on the configured port.
The auth key is generated once and written to config.yaml. Copy the key to your HungerLib configuration before making any API requests. If you lose the key, you can replace it manually in the config file and restart the server.

​
Verifying the Installation

After the server starts, you can confirm HungerBridge is running by sending a quick ping to the health-check endpoint. Replace YOUR_AUTH_KEY with the value of auth.key from config.yaml: 
curl -s -X GET http://localhost:30007/v2/ping \
  -H "X-Auth-Key: YOUR_AUTH_KEY"
A successful response looks like: 
{
  "ok": true,
  "server_time": 1718000000000
}
If you receive 401 Unauthorized, double-check that the X-Auth-Key header matches the key in your config file exactly.

​
Next Steps

Configuration →

Customize the HTTP port, rotate the auth key, and toggle individual API endpoints.

Build docs developers (and LLMs) love

Get started for freeTalk to us