Why Display Live Player Counts?

In the competitive world of Hytale servers, social proof is everything.

Sending live player counts allows potential members to see exactly how active and popular your community is in real-time. A "0/100" server listing often gets skipped, while a server showing active users signals a thriving community. By enabling live tracking on Hytale-Servers.pro, you give players the confidence to copy your ip and join your server, effectively boosting your conversion rate and growing your server population.

Choosing Your Status Plugin

To sync your server data with our list, you need a compatible query plugin. We currently support two primary methods.

• HyQuery (Recommended): This is the gold standard. It opens a UDP network on the same port as your server, meaning you don't need to open extra ports. It is safer, faster, and easier to configure.
• Nitrado Query: This creates a web interface on a separate port to expose your server data. It is a reliable alternative if you are already using the Nitrado ecosystem.

Method 1: Setting up HyQuery (Recommended)

HyQuery is the most efficient way to broadcast your server status. Here is how to get it running.

For Single Servers

1. Download the Plugin: Grab the latest version of HyQuery from CurseForge.
2. Install: Drag the downloaded file into your server's mods folder, just like any other mod.
3. Restart & Verify: Restart your server. We will automatically detect the protocol and start tracking your counts!

Pro Tip: In your HyQuery config file, set "showPlayerList": true. This allows users on our website to see who is online, adding a personal touch to your listing.

For Server Networks

If you run a BungeeCord-style network with multiple instances (lobbies, minigames, etc.), you need a centralized setup to show the total global player count.

1. Install Everywhere: Install the HyQuery plugin on all server instances (Hub and Workers).

2. Configure the Hub (Primary Server): Edit the config on the server linked to your main IP address (usually the lobby/proxy).

{
  "enabled": true,
  "showPlayerList": true,
  "showPlugins": false,
  "useCustomMotd": false,
  "customMotd": "My Network",
  "network": {
    "enabled": true,
    "role": "primary",
    "workerTimeoutSeconds": 30,
    "workers": [
      { "id": "minigame-1", "key": "your-secret-key" },
      { "id": "minigame-2", "key": "your-secret-key" }
    ]
  }
}

3. Configure the Workers (Sub-servers): Edit the config on your sub-servers (e.g., Minigames, Survival, Creative) to report back to the Hub.

{
  "enabled": true,
  "showPlayerList": true,
  "showPlugins": false,
  "useCustomMotd": true,
  "customMotd": "Minigame Server",
  "network": {
    "enabled": true,
    "role": "worker",
    "id": "minigame-1",
    "primaryHost": "lobby.example.com",
    "primaryPort": 5520,
    "key": "your-secret-key",
    "updateIntervalSeconds": 5
  }
}

4. Final Step: Ensure the port on your Hub/Primary server is open. It acts as the gateway to receive updates from workers and display the total count to Hytale-Servers.pro.

Method 2: Setting up Nitrado Query

If you prefer Nitrado Query, the setup is slightly different but equally effective.

1. Download Dependencies: You will need both the WebServer and the Query mod:

   • Nitrado Query
   • Nitrado WebServer

2. Install: Place both files into your server's mods folder.

3. Configure Permissions: You must allow external sources to read your server data. Edit your permissions.json to include the ANONYMOUS group:

{
  "Groups": {
    "ANONYMOUS": [
      "nitrado.query.web.read.basic",
      "nitrado.query.web.read.players"
    ]
  }
}

Note: Include the read.players line if you want to display the names of online players.

Final Check: Ensure you Port Forward port 5523 (the default Nitrado port) so our system can ping your server.

Testing

On your server's dashboard you can go to the Server Status tab. In here you can manually ping your server to see and test if your setup properly works.

Need Help or Want New Features?

If you are stuck or think we should support a different query plugin, let us know! We are constantly updating our platform to support the Hytale community.

Join our Discord Server to get support or request features directly from the dev team.