Monitoring Plugin

What is it?

The monitoring plugin is a server mod that allows you to query your server status and get the number of players online. This helps increase your server's rating and visibility on our site.

How it works

Plugin Installation

Install the plugin on your Hytale server to enable monitoring.

• Automatic status monitoring
• Real-time player count tracking
• Minimal server load

$ cd server/mods/  # Go to mods folder
$ wget github.com/.../HytaleOneQuery.jar  # Download plugin
$ systemctl restart hytale  # Restart server
Done! Plugin installed

Node.js Client

A library is available for developers to query servers from Node.js.

$ npm install @hytaleone/query

// example.ts
import { query } from '@hytaleone/query';

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

Technical Specifications

Open Source

The plugin and client library are open source. You can study the code, contribute, or adapt it to your needs.

Without Plugin

If you don't install the plugin, we will only show basic online/offline status based on UDP ping. For accurate player counts and server information, the plugin is recommended.