Nitrado Query Plugin

This plugin exposes server information via an HTTP endpoint. It depends on Nitrado:WebServer.

Purpose of this Plugin

When running a Hytale server, external systems often need access to basic server information for monitoring, dashboards, or integration with other services. This plugin provides a simple HTTP endpoint that returns structured JSON data about the server, universe, players, and installed plugins.

Main Features

• Server Information: Exposes server name, version, protocol details, and maximum player count.
• Universe Data: Returns current player count and default world name.
• Player List: Provides a list of connected players with their names, UUIDs, and current world.
• Plugin Status: Shows installed plugins with their versions, load state, and enabled status.
• Permission-Based Responses: Returns only the data sections the authenticated user has permission to view.

Installation

1. Install the Nitrado:WebServer plugin.
2. Copy the JAR of this plugin into your Hytale server's `mods/` folder.

Usage

Endpoint

The plugin registers a single endpoint at `GET /Nitrado/Query`.

Example Response

```json { "Server": { "Name": "Hytale Server", "Version": "2026.01.10-ab2cd69ff", "Revision": "ab2cd69ff816cb831f8792a0782938dce22eeadc", "Patchline": "release", "ProtocolVersion": 1, "ProtocolHash": "34f442449d72fb78c4891edf9b218eb55ab2ad69ffd1cd152d66d71c814fcc7", "MaxPlayers": 100 }, "Universe": { "CurrentPlayers": 1, "DefaultWorld": "default" }, "Players": [ { "Name": "MyName", "UUID": "e5c4ef9a-6281-406e-8a71-21028279f547", "World": "default" } ], "Plugins": { "Nitrado:WebServer": { "Version": "1.0.0", "Loaded": true, "Enabled": true, "State": "ENABLED" }, "Nitrado:Query": { "Version": "1.0.0", "Loaded": true, "Enabled": true, "State": "ENABLED" } } } ```

You can find the full documentation in the GitHub repository.