ServerRoamSign inSubmit serverSubmit server

Votifier setup

ServerRoam hands every vote that comes with a player name to your server's Votifier, so a vote listener plugin can run your reward. This is how to set it up.

What you need

A Minecraft server that is listed here, a Votifier that accepts connections from the internet (NuVotifier is recommended and covers both protocols) and a plugin that rewards players for votes. Votifier itself only receives the vote; the reward is up to the plugin you pair it with.

If your server is not listed yet, submit it first. For server owners shows the whole path from listing to badge.

1. Claim your server

Open your server's page and choose Claim this server, then Get code. You get a short code such as serverroam-4f9k2x.

Put the code anywhere in the MOTD (motd in server.properties) and restart or reload the server. Minecraft servers are checked every 5 minutes. As soon as the code shows up, the page updates on its own and your listing is verified. Remove the code from the MOTD afterwards.

server.properties
motd=Example SMP serverroam-4f9k2x

The claim is bound to the browser you started it in. If you lose access, claim the server again: the new claim replaces the old one, including its reward settings.

2. Add the Votifier target

On the manage page (/minecraft/<slug>/manage, reached through the same Claim this server link on your server's page) find Vote rewards, then Votifier, and fill in three fields:

Votifier host: the hostname or IPv4 address your Votifier is reachable at, without a port. It is prefilled with your server's address. It has to resolve to a public IPv4 address; IPv6-only hosts and private networks are refused.

Port: the TCP port of your Votifier, 8192 unless you changed it. Ports from 1024 to 65535 are accepted.

Token or public key: paste either one, the type is recognised on its own. Save.

A saved secret is stored encrypted and never shown again. Leave the field empty on later saves to keep it, or paste a new one to replace it. Turn off removes the target.

Token or public key

A token uses NuVotifier's protocol 2: the vote is signed with the token and your server confirms it, so you see whether it arrived. Copy it from the Votifier config under tokens, usually plugins/Votifier/config.yml.

config.yml
host: 0.0.0.0
port: 8192

tokens:
  default: <your token>

A public key uses protocol 1, which classic Votifier and NuVotifier both accept. Paste the contents of the file below, a 2048-bit RSA key, with or without the BEGIN and END lines. Protocol 1 has no reply, so a vote can only be reported as sent, not as delivered. Use a token if your Votifier supports it.

Public key
plugins/Votifier/rsa/public.key

Votifier has to listen on the host and port you entered, and its port has to be open to the internet (firewall, hosting panel). We connect only to a public IPv4 address, and send nothing until your server has introduced itself as Votifier.

3. Send a test vote

Once the target is saved, enter a player name next to Send test vote and send it. The result of the last delivery is shown below the button:

Delivered: your Votifier confirmed the vote (token only). Sent: the vote was sent, protocol 1 does not confirm. Could not connect: check the host, the port and your firewall. Not Votifier: that port did not answer as Votifier. Refused: the token or public key is wrong. No confirmation: Votifier did not answer, check your server's console.

A test vote goes the same way as a real one, so your vote listener will run the reward for that name: use your own. It is not counted as a vote on the listing, is tried only once and you can send one every 20 seconds.

What your server receives

A standard Votifier vote: serviceName is ServerRoam, username is the player name exactly as entered, address is ServerRoam's own host (never the voter's IP address) and timestamp is the time of the vote.

Names are Java names (2 to 16 letters, digits or underscores), optionally with a . or * in front for Bedrock players who join through Geyser. A voter who leaves the name empty still counts as a vote but triggers no reward.

Limits and guarantees

Each player name gets one reward per server and UTC day. A second vote with the same name that day is refused when it is cast, so your server never sees it.

A vote is delivered at most once. If no connection to your Votifier could be made at all, it is tried again after one minute and once more ten minutes later. Anything beyond that is never repeated, including a vote your Votifier received but did not confirm, because it may already have been rewarded. A server that stays offline for longer than that misses the votes in between.

Prefer a webhook if you run a custom setup or want to deduplicate on your side.