How to Set Up a Query Plugin for Your Hytale Server

What a query plugin does

Hytale servers do not publish their status on their own. A query plugin answers a small request from outside with your server’s player count, maximum players and version. HytaleLobby sends that request every 5 minutes. Without a plugin the server cannot be read, so it shows offline even when players can join, and after 14 days offline it is removed from the list.

You only need one plugin. Pick the one that fits your server, install it, and check that it is public.

Which one to choose

OneQuery and HyQuery are the quickest: one file and the same port your players already use. Nitrado Query makes sense if you already run Nitrado WebServer for other plugins or your host sets it up for you.

OneQuery

1. Download OneQuery and drop the .jar into your server’s mods/ folder.
2. Restart the server. It creates its config.json on the first start.
3. The defaults work. If you edited the file, check that Enabled is true and that the basic information is still public (Authentication.Public.Basic set to true).

Make sure the UDP port of your game server is open. OneQuery answers on that same port, so there is nothing extra to open.

HyQuery

1. Download HyQuery and drop the .jar into your server’s mods/ folder.
2. Restart the server. It creates mods/HyQuery/config.json on the first start.
3. The defaults work. If you edited the file, check these three settings:

   {
     "enabled": true,
     "v1Enabled": true,
     "v2Enabled": true
   }

   Keep authentication.publicAccess.basic on true as well, or the basic information will not be public.

Like OneQuery, it answers over UDP on your game port, so the port you already opened is enough.

Nitrado Query

This one works differently: it serves the information over HTTPS, through the Nitrado WebServer plugin, so it needs one more port and one more setting.

1. Install both plugins in mods/: Nitrado WebServer and Nitrado Query. Restart the server.
2. Open the web port for TCP. By default it is your game port plus 3, so 5523 if your game runs on 5520. If you changed BindPort in mods/Nitrado_WebServer/config.json, open that port instead and enter it as Web Query Port in the Advanced section of your server settings on HytaleLobby.
3. Make the basic information public. Nitrado Query answers 401 to anonymous visitors until you allow it. In your server’s permissions.json, add this inside the Groups object (create it if it is missing), then restart:

   "ANONYMOUS": [
     "nitrado.query.web.read.basic"
   ]

   Grant only nitrado.query.web.read.basic. The other permissions (players, plugins, server, universe) would show more than HytaleLobby needs.
4. Check it. Open https://your-address:5523/Nitrado/Query in a private browser window. Your browser will warn about the certificate, which is normal because it is self-signed. You should see the server information. A login page or an error means the permission is missing.

HytaleLobby accepts the self-signed certificate and also works if you switched the web server to plain HTTP. It only tries Nitrado Query when OneQuery and HyQuery do not answer.

Ports and firewalls

• OneQuery and HyQuery use UDP on your game port. If you set a separate Query Port in your server settings, HytaleLobby uses that one instead.
• Nitrado Query uses TCP on the web port. Opening UDP does not help here.
• Open the port in your hosting panel, your firewall and, if you self-host, your router. An anti-DDoS layer that drops traffic from unknown addresses can block the checks too.

Check that it works

Open your dashboard. Within 5 minutes your server should show online with its player count and version. If it still shows offline, go through the offline checklist and, for Votifier rewards, the Votifier guide.