HytaleONE Query

Let players and server lists check your server status instantly

Think of it like Minecraft's query protocol, but built specifically for Hytale.

What is it?

A server query system for Hytale. It lets players, server lists, and tools check your server's status - player count, server name, MOTD, and more.

How it works

Send Request

Client sends a small query packet

Server Responds

Your server replies with current info

Done

Instant response in milliseconds

The entire exchange takes milliseconds.

Server Plugin

The plugin runs on your Hytale server. Once installed, your server responds to query requests automatically.

  • No extra ports needed - uses the game port
  • No configuration required - works immediately
  • Optionally registers with HytaleONE server list
Installation
$
cd server/mods/# Navigate to mods folder
$
wget github.com/.../HytaleOneQuery.jar# Download plugin
$
systemctl restart hytale# Restart server
Plugin installed and ready!

Node.js Client

A TypeScript library for querying servers from your apps.

terminal
$ npm install @hytaleone/query
example.ts
import { query } from '@hytaleone/query';

// Get server info
const server = await query('play.example.com', 5520);
console.log(server.serverName); // "My Server"
console.log(server.currentPlayers); // 42
console.log(server.maxPlayers); // 100

// Get full info including player list
const full = await query('play.example.com', 5520, { full: true });
console.log(full.players); // [{ name: "Steve", uuid: "..." }]
console.log(full.plugins); // [{ id: "HytaleOne:Query", version: "1.0.0" }]

Available Information

Basic Query

query(host, port)
Server name
MOTD (message of the day)
Current player count
Maximum players
Server port
Server version

Full Query

query(host, port, { full: true })

Everything from basic query, plus:

Online players (name + UUID)
Installed plugins (name + version)

Why use it

For Server Owners

  • Get listed on server browsers
  • Let players check if you're online
  • No setup hassle - just install and go

For Developers

  • Simple protocol - easy to implement in any language
  • Fast responses - UDP, no overhead
  • Full TypeScript types included

Compared to HTTP

10xFaster
0Extra ports
UDPProtocol
<1KBPayload size

Technical Details

ProtocolUDP
Port5520 (same as game)
Response time< 10ms typical
Request size9 bytes
Response size~100-500 bytes

The protocol uses magic bytes (HYQUERY / HYREPLY) to distinguish query packets from game traffic. This allows both to coexist on the same port without interference.

Open Source

Everything is MIT licensed and free to use.