Documentation

🎮 For Players

HyServerList helps you discover the best Hytale servers. Browse our listings, read descriptions, and vote for your favorites!

How to Vote

1. Find a server you enjoy playing on
2. Click the "Vote" button on the server's page
3. Enter your in-game username
4. Complete the captcha verification
5. Your vote is counted and delivered to the server!

Vote Cooldown

You can vote for each server once every 24 hours. The cooldown resets exactly 24 hours after your last vote.

🖥️ For Server Owners

List your Hytale server to gain visibility and grow your community!

Adding Your Server

1. Create an account or login
2. Click "Add Server" and fill in your server details
3. Submit for approval (usually within 24 hours)
4. Once approved, your server appears in the listings!

Ranking System

Servers are ranked by monthly votes. More votes = higher rank = more visibility. Rankings reset at the start of each month.

⚙️ Votifier V2 Setup

Receive vote notifications on your server using Votifier V2 protocol.

Step 1: Install Plugin

Install a Votifier V2 compatible plugin on your server (NuVotifier, Votifier, etc.)

Step 2: Get Your Token

Find your Votifier Secret Token in your Dashboard under your server settings.

Step 3: Configure Plugin

Add your token to your Votifier config:

tokens:
  HyServerList: "YOUR_TOKEN_FROM_DASHBOARD"

Step 4: Set Port

Make sure your Votifier port (default 8192) is open and accessible. Configure the port in your Dashboard server settings.

📡 API Reference

Public API for developers.

Base URL: https://api.hyserverlist.com/api/v1

GET /servers	List all approved servers
GET /servers/:slug	Get server details
POST /votes	Submit a vote (requires captcha)
GET /votes/check/:id	Check vote cooldown status