Hytale Server Manual: Setup and Operations Guide
Hytale has released a server manual covering setup, configuration, and operations for dedicated servers. Here’s what you need to know.
Link: https://support.hytale.com/hc/en-us/articles/45326769420827-Hytale-Server-Manual
Getting Started: System Requirements and Setup
Servers run on any device with at least 4GB of RAM and Java 25. Both x64 and arm64 are supported. Resource usage depends on player behavior:
- CPU: high player or entity counts
- RAM: large loaded world area (high view distance, players exploring independently)
Install Java 25 (Adoptium recommended) and verify with `java --version`.
Server Files: Two Options
1. Manual copy from launcher: quick for testing, but harder to keep updated
2. Hytale Downloader CLI: better for production, easy to keep updated
The downloader supports OAuth2 authentication and can check for updates, download specific versions, and access pre-release channels.
Running Your Server
Start with:
java -jar HytaleServer.jar --assets PathToAssets.zip
First-time authentication uses device authorization. Visit the provided URL, enter the code, and your server will be authenticated. Note: there’s a limit of 100 servers per Hytale game license to prevent abuse.
Network Configuration: QUIC Protocol
Hytale uses QUIC over UDP (not TCP). Configure your firewall and port forwarding for UDP port 5520 (or your custom port). QUIC handles NAT traversal well, but symmetric NAT configurations may cause issues.
File Structure and Worlds
The server organizes files into:
- `.cache/` - Optimized file cache
- `logs/` - Server logs
- `mods/` - Installed mods
- `universe/` - World and player data
Each world runs on its own main thread with parallel work offloaded to a shared thread pool.
Tips & Tricks
- Mods: Drop `.zip` or `.jar` files into the `mods/` folder
- Disable Sentry during plugin development with `--disable-sentry`
- Use AOT cache for faster boot times: `-XX:AOTCache=HytaleServer.aot`
- Recommended plugins: Nitrado and Apex Hosting offer plugins for web servers, query APIs, performance optimization, and metrics
- View distance: Limit to 12 chunks (384 blocks) for performance. Hytale’s default is roughly equivalent to 24 Minecraft chunks
Multiserver Architecture: No Proxy Needed
Hytale supports native player routing between servers—no reverse proxy like BungeeCord required.
- Player Referral: Transfer connected players to another server with optional payload data
- Connection Redirect: Redirect players during handshake for load balancing or regional routing
- Disconnect Fallback: Automatically reconnect players to a fallback server after unexpected disconnects
Security note: Sign payloads cryptographically (e.g., HMAC) since they pass through the client.
Protocol and Configuration
- Protocol updates: Client and server must match exactly. Protocol tolerance allowing ±2 version difference is coming soon
- Configuration files: Read on startup, written during in-game actions. Manual changes while running may be overwritten
- Maven Central: The HytaleServer jar will be published to Maven Central for modding projects
Future Features
- Server Discovery: A catalogue where players can browse servers and minigames, with self-rating and player count verification via client telemetry
- Parties: Group players together across server transfers and minigame queues
- Integrated Payments: Built-in payment gateway for servers to accept payments securely
- SRV Record Support: Under evaluation (no battle-tested C# library available yet)
- First-Party API Endpoints: Authenticated servers will access official APIs for player data, versioning, and server operations
The manual provides a solid foundation for server operators, with clear guidance on setup, configuration, and future capabilities. Whether you’re running a small community server or a large network, these tools should help you get started.
For the full details, check the complete Hytale Server Manual.
Link: https://support.hytale.com/hc/en-us/articles/45326769420827-Hytale-Server-Manual
Hytale has released a server manual covering setup, configuration, and operations for dedicated servers. Here’s what you need to know.
Link: https://support.hytale.com/hc/en-us/articles/45326769420827-Hytale-Server-Manual
Getting Started: System Requirements and Setup
Servers run on any device with at least 4GB of RAM and Java 25. Both x64 and arm64 are supported. Resource usage depends on player behavior:
- CPU: high player or entity counts
- RAM: large loaded world area (high view distance, players exploring independently)
Install Java 25 (Adoptium recommended) and verify with `java --version`.
Server Files: Two Options
1. Manual copy from launcher: quick for testing, but harder to keep updated
2. Hytale Downloader CLI: better for production, easy to keep updated
The downloader supports OAuth2 authentication and can check for updates, download specific versions, and access pre-release channels.
Running Your Server
Start with:
java -jar HytaleServer.jar --assets PathToAssets.zip
First-time authentication uses device authorization. Visit the provided URL, enter the code, and your server will be authenticated. Note: there’s a limit of 100 servers per Hytale game license to prevent abuse.
Network Configuration: QUIC Protocol
Hytale uses QUIC over UDP (not TCP). Configure your firewall and port forwarding for UDP port 5520 (or your custom port). QUIC handles NAT traversal well, but symmetric NAT configurations may cause issues.
File Structure and Worlds
The server organizes files into:
- `.cache/` - Optimized file cache
- `logs/` - Server logs
- `mods/` - Installed mods
- `universe/` - World and player data
Each world runs on its own main thread with parallel work offloaded to a shared thread pool.
Tips & Tricks
- Mods: Drop `.zip` or `.jar` files into the `mods/` folder
- Disable Sentry during plugin development with `--disable-sentry`
- Use AOT cache for faster boot times: `-XX:AOTCache=HytaleServer.aot`
- Recommended plugins: Nitrado and Apex Hosting offer plugins for web servers, query APIs, performance optimization, and metrics
- View distance: Limit to 12 chunks (384 blocks) for performance. Hytale’s default is roughly equivalent to 24 Minecraft chunks
Multiserver Architecture: No Proxy Needed
Hytale supports native player routing between servers—no reverse proxy like BungeeCord required.
- Player Referral: Transfer connected players to another server with optional payload data
- Connection Redirect: Redirect players during handshake for load balancing or regional routing
- Disconnect Fallback: Automatically reconnect players to a fallback server after unexpected disconnects
Security note: Sign payloads cryptographically (e.g., HMAC) since they pass through the client.
Protocol and Configuration
- Protocol updates: Client and server must match exactly. Protocol tolerance allowing ±2 version difference is coming soon
- Configuration files: Read on startup, written during in-game actions. Manual changes while running may be overwritten
- Maven Central: The HytaleServer jar will be published to Maven Central for modding projects
Future Features
- Server Discovery: A catalogue where players can browse servers and minigames, with self-rating and player count verification via client telemetry
- Parties: Group players together across server transfers and minigame queues
- Integrated Payments: Built-in payment gateway for servers to accept payments securely
- SRV Record Support: Under evaluation (no battle-tested C# library available yet)
- First-Party API Endpoints: Authenticated servers will access official APIs for player data, versioning, and server operations
The manual provides a solid foundation for server operators, with clear guidance on setup, configuration, and future capabilities. Whether you’re running a small community server or a large network, these tools should help you get started.
For the full details, check the complete Hytale Server Manual.
Link: https://support.hytale.com/hc/en-us/articles/45326769420827-Hytale-Server-Manual