Skip to content

Repository files navigation

Hermes

MIT License

Report Bug · Request Feature

HermesAPI is a lightweight HTTP API mod for Fabric Minecraft servers that provides real-time server interaction through a simple HTTP interface.

🚀 Features

  • Server side only
  • Retrieve online player count
  • Get list of online player names
  • Real-time player join/leave events via SSE (Server-Sent Events)
  • Simple HTTP interface using Netty
  • Designed for Minecraft 1.21.1 with Fabric API

🛠️ Built With

  • Java
  • Netty
  • Fabric

📦 Installation

  1. Ensure Fabric Loader is installed
  2. Download the latest release from [Releases]
  3. Place the .jar in your mods folder
  4. Start your Fabric server

💻 Usage

The API runs on port 8080 by default:

Endpoint Description Example Response
GET /players/count Online player count {"count": 5}
GET /players/names Online player names {"players": ["redredl"]}
GET /players/connections SSE stream of join/leave events data: A player has joined!

🔄 Real-Time Player Events (SSE)

To listen for real-time events like player joins or leaves, connect to the following endpoint:

curl http://localhost:8080/players/connections

About

Lightweight HTTP API for communication between Minecraft Fabric Servers and web clients.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages