Documentation

Learn how to set up player count tracking for your Hytale server

Step 1: Download the JAR File

To enable player count tracking on your server, you need to download and install our monitoring plugin.

Option 1: Download from CurseForge (Recommended)

Download the latest version from CurseForge for automatic updates and better version management.

Download from CurseForge

⏳ Pending approval - Coming soon

Option 2: Direct Download

Download the JAR file directly from our server.

player-count-updater-1.0.0.jar

Requirements:

  • Hytale server
  • Java 25
  • Server admin access
Step 2: Install the Plugin

Place the downloaded JAR file in your server's Mods directory.

Directory structure:

Server/
  ├── Mods/
  │   └── player-count-updater-1.0.0.jar
  └── ...

After placing the file, restart your server. The plugin will automatically create a configuration file.

Step 3: Get Your API Token

You need to obtain your private API token from your server dashboard.

  1. Log in to your account on this website
  2. Navigate to My Servers
  3. Find your approved server in the list
  4. Locate the API token field (it will be masked by default)
  5. Click the eye icon to reveal the token
  6. Click the copy icon to copy the token to your clipboard

⚠️ Important: Keep your API token private. Never share it publicly or commit it to version control.

Step 4: Configure the Plugin

After the plugin creates the configuration file, you need to add your API token.

Configuration file location:

Server/Mods/player-count-updater/config.json

Open the config.json file and add your API token:

{
  "api_token": "your-api-token-here",
  "update_interval": 60,
  "server_url": "https://hytaleserverslists.net"
}

Configuration options:

  • api_token - Your private API token from My Servers
  • update_interval - How often to update player count (in seconds, default: 60)
  • server_url - The base URL of this server list (optional)
Step 5: Verify It's Working

After configuring the plugin, restart your server and verify that player counts are updating.

  1. Restart your Hytale server
  2. Check the server logs for any errors related to the plugin
  3. Visit your server page on this website
  4. Verify that the player count is updating correctly
  5. The status should show as "Online" when players are connected

✓ Success: If you see the player count updating on your server page, the integration is working correctly!

Need Help?

If you encounter any issues during setup, please check the server logs for error messages. Common issues include incorrect API tokens or network connectivity problems.