HyVotifier Setup Guide

Connect your Hytale server to HyServers.gg so you get notified when players vote, and optionally reward them with in-game items.

Compatible with Votifier V1 (RSA) & V2 (Token)

What is HyVotifier?

When a player votes for your server on HyServers.gg, Votifier is the bridge that tells your game server about it. It's an open protocol supported by most server list sites — once configured, your server instantly knows who voted and can hand out rewards automatically.

Two protocol versions exist: V1 encrypts messages with an RSA public key, while V2 uses a shared token for authentication. V2 is simpler to set up and recommended for new installations, but both work with HyServers.gg.

Requirements

A Hytale server with mod support

You need to be able to install plugins/mods on your server.

Your server listed on HyServers.gg

Add your server to get access to the voting dashboard.

An open port for incoming connections

Default: 8192 (Votifier) or 5520 (HyServers Plugin). Must be open in your firewall.

A compatible Votifier plugin

Either HyVotifier or the HyServers Plugin.

Choose Your Integration Method

HyServers.gg supports three ways to connect voting to your server. Choose the one that fits your needs.

HyVotifier Plugin

Use any standard Votifier plugin (V1 or V2) to receive encrypted vote notifications.

  • Works with any Votifier-compatible plugin
  • V1 (RSA) or V2 (Token) support
Recommended

HyServers Plugin

Our official plugin with vote rewards, review rewards, live status pings, and more.

  • Vote & review reward commands
  • Live status pings to HyServers.gg
  • Players choose rewards on the vote page
  • Multi-server / network support

REST API

Submit votes programmatically via our REST API for full custom integration.

  • Full control over vote flow
  • Check vote status, submit votes
View API Docs

Option 1: Standard Votifier Plugin

Step 1

Install HyVotifier on your server

Download HyVotifier from CurseForge and place the .jar file in your server's mods/ folder. Restart your server to generate the default config file.

Step 2

Choose your protocol version

In your server dashboard on HyServers.gg, navigate to the Voting tab and select the Votifier Plugin option. Then choose your protocol version:

V1 (RSA Key)

The original Votifier protocol. You'll paste your RSA public key from your Votifier plugin config into HyServers.gg.

  • 1. Set your Votifier IP to your server's public IP or domain
  • 2. Set the Votifier Port (default: 8192)
  • 3. Copy the RSA Public Key from your HyVotifier config and paste it into the field on HyServers.gg

V2 (Token)

The newer, simpler protocol. HyServers.gg generates a token for you — just copy it into your plugin config.

  • 1. Set your Votifier IP and Port
  • 2. Copy the Token shown on HyServers.gg
  • 3. Paste it into the Tokens section of your HyVotifier config
Step 3

Configure HyVotifier on your server

Open the HyVotifier config file on your server and make sure the port and token/key match what you entered on HyServers.gg. Here's an example V2 config:

HyVotifier config.json
# HyVotifier config.json
{
  "Host": "0.0.0.0",
  "Port": 8192,
  "Tokens": {
    "HyServers.gg": "YOUR_TOKEN_FROM_HYSERVERS"
  },
  "Commands": {
    "OnVote": [
      "give {player} Rock_Gem_Diamond 5",
      "msg {player} Thanks for voting on {service}!"
    ]
  }
}

Replace YOUR_TOKEN_FROM_HYSERVERS with the token shown on your HyServers.gg dashboard. The service name must be HyServers.gg exactly.

Step 4

Test your setup

Back on HyServers.gg, use the Test Votifier section to send a test vote. Enter a username and click the send button. If everything is configured correctly, your server will receive the vote and execute your reward commands.

Not working? Make sure port 8192 (or your custom port) is open in your server's firewall and not blocked by your hosting provider.

Option 2: HyServers Plugin (Recommended)

Our custom plugin goes beyond basic Votifier — it supports rewarding players for both votes and reviews, sends live status pings to the website, and lets players choose their reward directly on the voting page.

Vote Rewards
Review Rewards
Live Status Pings
Network Support
Step 1

Download and install the plugin

On your server dashboard, select the HyServers Plugin tab and click Download Plugin. Place the HyServersPlugin.jar file in your server's mods/ folder.

Step 2

Restart and configure

Restart your server — a config file will be created at mods/HyServers/HyServersPlugin.json. Copy the config snippet shown on HyServers.gg into that file, then restart again.

mods/HyServers/HyServersPlugin.json
{
  "ServerId": "your-server-uuid-from-hyservers-gg",
  "ApiBaseUrl": "https://hyservers.gg",
  "StatusPingEnabled": true,
  "ListenPort": 5520,
  "SharedSecret": "your-shared-secret",
  "VoteCommands": [
    "give {player} Rock_Gem_Diamond 5",
    "msg {player} Thanks for voting!"
  ],
  "ReviewCommands": [
    "give {player} Rock_Gem_Emerald 10"
  ],
  "BroadcastVotes": true,
  "BroadcastMessage": "{player} just voted! Use /vote to support us!"
}
Step 3

Set your Shared Secret

On HyServers.gg, click Generate to create a shared secret. Copy that secret and paste it into the SharedSecret field in your plugin config. Both must match exactly.

Step 4

Configure your port

The default Plugin Port is 5520 (same as the game port — the plugin uses TCP while the game uses UDP, so no conflicts). Make sure the ListenPort in your config matches what's shown on HyServers.gg.

Step 5

Restart and verify

Restart your server. The plugin will automatically start sending status pings to HyServers.gg. Players can use /vote in-game to get a clickable link to your vote page.

Server Networks

Running multiple connected servers? You can forward votes so every server in your network gets notified when a player votes.

With HyServers Plugin

Install the plugin on your hub/frontend server and list your backend server addresses in the plugin config. Votes are forwarded automatically to all backends.

With HyVotifier

HyVotifier has built-in vote forwarding. Install it on every server in your network, each with a unique port. On your main (public-facing) server, enable voteForwarding.json and list each backend's IP, port, and ForwardingSecret. Backend ports don't need to be public — they just need to be reachable from the main server.

Full HyVotifier network forwarding docs on CurseForge

Configuring Vote Rewards

HyServers Plugin only

The HyServers Plugin lets you reward players for voting and reviewing your server. In your server dashboard, you'll see three reward modes:

No Rewards

Players can still vote and it counts toward your ranking — the plugin just won't execute any reward commands.

Configure on Website

Set up reward options directly on HyServers.gg. Players will see a list of rewards to choose from when they vote. The HyServers Plugin then executes the selected reward command on your server automatically.

Configure in Plugin

Define your VoteCommands and ReviewCommands directly in your plugin config file. Every vote/review triggers the same set of commands.

Tip: Using "Configure on Website" lets players pick their own reward — a great way to increase vote engagement.

Hosting Provider Tips

Nitrado

On Nitrado, the Votifier port is typically your game port + 3 (e.g., if your game port is 5520, Votifier would use 5523). Check your Nitrado dashboard under "General Settings" for the exact WebServer port. You'll also need to make sure the port is enabled in the Nitrado port settings.

Self-Hosted / VPS

Make sure the Votifier port (default 8192 or 5520 for HyServers Plugin) is open in your firewall. For example, on Ubuntu/Debian: sudo ufw allow 8192/tcp. If your server is behind a reverse proxy or NAT, you'll need to configure port forwarding.

Shared Hosting Panels (Pterodactyl, etc.)

Most game panels require you to allocate an additional port for Votifier. Go to your server's "Network" or "Ports" settings and add a new allocation. Then use that port in both your Votifier plugin config and on HyServers.gg.

Troubleshooting

Test vote says "success" but my server didn't receive it
Make sure the Votifier port (default 8192 for Votifier, 5520 for HyServers Plugin) is open in your firewall. Many hosting providers block non-standard ports by default. Check your server console for connection errors.
V2 token not working
The service name in your plugin config must exactly match what HyServers.gg shows (usually "HyServers.gg"). Copy the token directly — don't add extra spaces or quotes around it.
V1 RSA key rejected
Make sure you're copying the entire key including the "-----BEGIN PUBLIC KEY-----" and "-----END PUBLIC KEY-----" lines. The key must be from your Votifier plugin's config, not generated elsewhere.
Vote commands not executing
The player must be online for commands using {player} to work. If the player is offline when they vote, the reward will be queued and delivered when they next join (if your plugin supports queuing).
HyServers Plugin not connecting
Verify the SharedSecret matches exactly between HyServers.gg and your plugin config. Check that the ListenPort in your config matches the Plugin Port shown on HyServers.gg. Review your server console for error messages.
Status pings not showing on HyServers.gg
Make sure "StatusPingEnabled" is set to true in your HyServers Plugin config. The plugin sends pings automatically — you should see status updates within a few minutes of starting your server.
What placeholders can I use in reward commands?
You can use {player} for the voting player's username and {service} for the voting site name (e.g., "HyServers.gg"). For example: give {player} Rock_Gem_Diamond 5

Need Help?

Stuck on something? Join our Discord server and we'll help you get Votifier configured. You can also open a support ticket directly from your server dashboard.

Ready to Set Up Voting?

Add your server to HyServers.gg, install the plugin, and start receiving votes in minutes.