HGS Query Plugin — Real-Time Server Sync for HytaleGameServers.net
Keep your Hytale server listing accurate, automated, and always up to date with the official HGS Query Plugin — built specifically for seamless integration with HytaleGameServers.net.
HGS Query replaces traditional Query Port polling with a modern, push-based system that sends real-time server data directly from your server to the listing platform. This results in faster updates, improved reliability, and zero manual maintenance.
HGS Query continuously syncs your server’s live data with your listing, including player counts, server status, and metadata. Instead of relying on slow external polling, your server actively pushes updates — ensuring your listing always reflects what’s happening in-game.
This is especially useful for active or growing servers that need accurate visibility and responsiveness on the server list.
Real-Time Server Updates
Automatically sends player counts, MOTD, world info, and server status directly to your listing.
Network Mode (Multi-Server Support)
Run multiple servers under a single listing with automatic controller election and peer-to-peer communication.
High Performance (Fully Asynchronous)
All API communication runs on async threads — zero impact on gameplay or server performance.
Secure Data Transmission
Uses HTTPS with Bearer token authentication to ensure secure communication.
Advanced Privacy Controls
Choose exactly what data is shared:
Faster Update Intervals
When installed, the plugin periodically sends a snapshot of your server’s state to the HGS API. This replaces the website’s built-in Query Port system entirely while the plugin is active.
This ensures your server listing is always current without unnecessary external requests.
Api.json — Your server credentials
Config.json — Plugin settings and privacy options
Network.json — Multi-server setup (optional)
You have full control over how your data is shared and how your network is structured.
For multi-server setups, HGS Query supports a distributed system where:
If the controller goes offline, another node takes over automatically — no downtime or manual fixes required.
The plugin may send:
No sensitive data (like passwords) is ever transmitted.
All data is cleared automatically when the server goes offline.
Fully open source and available on GitHub:
https://github.com/HytaleGameServers/Query-Plugin
This is an unofficial community project. Hytale is a trademark of Hypixel Studios.
Keep your Hytale server listing accurate, automated, and always up to date with the official HGS Query Plugin — built specifically for seamless integration with HytaleGameServers.net.
HGS Query replaces traditional Query Port polling with a modern, push-based system that sends real-time server data directly from your server to the listing platform. This results in faster updates, improved reliability, and zero manual maintenance.
What This Plugin Does
HGS Query continuously syncs your server’s live data with your listing, including player counts, server status, and metadata. Instead of relying on slow external polling, your server actively pushes updates — ensuring your listing always reflects what’s happening in-game.This is especially useful for active or growing servers that need accurate visibility and responsiveness on the server list.
Key Features
Real-Time Server UpdatesAutomatically sends player counts, MOTD, world info, and server status directly to your listing.
Network Mode (Multi-Server Support)
Run multiple servers under a single listing with automatic controller election and peer-to-peer communication.
High Performance (Fully Asynchronous)
All API communication runs on async threads — zero impact on gameplay or server performance.
Secure Data Transmission
Uses HTTPS with Bearer token authentication to ensure secure communication.
Advanced Privacy Controls
Choose exactly what data is shared:
- Player usernames
- System environment
- Installed plugins
Faster Update Intervals
- Default: 3-minute updates
- Sponsored/real-time listings: 1-minute updates
Faster and more reliable than traditional Query Port polling.
How It Works
When installed, the plugin periodically sends a snapshot of your server’s state to the HGS API. This replaces the website’s built-in Query Port system entirely while the plugin is active.- Plugin-based updates: Faster, push-based
- Website polling: Disabled when plugin is active
This ensures your server listing is always current without unnecessary external requests.
Installation
- Download the plugin
- Place the .jar file into your server’s mods/ folder
- Start your server to generate config files
- Create a server listing on HytaleGameServers.net
- Go to your Dashboard and click "Api"
- Add your Server ID and API Token to Api.json
- Restart your server — done!
Configuration Overview
Api.json — Your server credentialsConfig.json — Plugin settings and privacy options
Network.json — Multi-server setup (optional)
You have full control over how your data is shared and how your network is structured.
Network Mode (Advanced)
For multi-server setups, HGS Query supports a distributed system where:- Each server node communicates over TCP
- A controller node is automatically elected
- Data is aggregated and sent as a single update
If the controller goes offline, another node takes over automatically — no downtime or manual fixes required.
Data Collected
The plugin may send:- Server name, address, and port
- Player counts (current/max)
- Player usernames (optional)
- World information
- Server version
- Installed plugins (optional)
- System environment (optional)
No sensitive data (like passwords) is ever transmitted.All data is cleared automatically when the server goes offline.
Requirements
- Hytale Server (official release)
- Java 21+
- HytaleGameServers.net account
- Outbound HTTPS access to hytalegameservers.net
Open Source
Fully open source and available on GitHub:https://github.com/HytaleGameServers/Query-Plugin
Support
- Website: https://hytalegameservers.net
- Discord: https://hytalegameservers.net/discord
This is an unofficial community project. Hytale is a trademark of Hypixel Studios.
