HungerBridge

HungerBridge is a **tiny, zero‑noise, multiloader HTTP bridge** that lets external services communicate with your Minecraft server safely and efficiently. Designed for **automation** and engineered to stay completely out of your way. --- ## What it does - Exposes a **minimal HTTP API** for remote automation - Supports **Paper** and **Fabric** with a shared common module - Provides **run** and **log** endpoints _(more coming soon!)_ - Zero commands, zero chat output, zero clutter - Safe by default — **shared secret authentication**, no open RCON, no exposed internals --- ## Why it exists Traditional RCON is slow, fragile, and unsafe to expose publicly. HungerBridge replaces it with a **modern, stateless, authenticated HTTP layer** that works identically across loaders. --- ## Features - 🔌 **Unified API** across all loaders - 🧩 **Python library** - 🔐 **Shared‑secret authentication** - ⚡ **Fast, lightweight, no tick overhead** - 📝 **Structured logging endpoint** - 🏃 **Command execution endpoint** --- ## Usage HungerBridge is designed to be paired with **HungerLib** or any external client that can send authenticated HTTP requests. Example integrations: - Automation scripts - Server orchestration - Custom dashboards - Server monitoring tools --- ## HungerLib support While **HungerBridge** can be used by any HTTP client, **HungerLib** is a Python library built for queries. ### Installation ```bash pip install hungerlib ``` ### Usage ```python from hungerlib import BridgeClient # Create the client bridge = BridgeClient(url="http://example.com:1913", token="YOUR_SECRET") # Run a command out = bridge.runCommand("say Hello from HungerBridge!", silent=False) print("Command output:", out) # Log something bridge.log("Example script ran successfully", level="info") # Get status bridge.getStatus() # Get version bridge.getVersion() ``` --- ## Supported Platforms | Platform | Supported | Version | |----------|-----------|---------| | Fabric | ✔ Yes | 1.21.10+| | Quilt | ✔ Yes | 1.21.10+| | Paper | ✔ Yes | 1.21.10+| | Purpur | ✔ Yes | 1.21.10+| ## Security Guide HungerBridge is designed to be exposed safely when paired with Cloudflare. This guide shows the minimal, recommended setup for securing your API over HTTPS. **Put HungerBridge Behind Cloudflare** Create a DNS record: | Type | Name | Value | Proxy | |:----:|:----:|:----------------:|:----------------------:| | A | api | <your-server-ip> | Proxied (orange cloud) | This gives you: - HTTPS - DDoS protection - Firewall - IP masking **Your API will be available at:** ```https://api.example.com:1913```