indifferentbroccoli/hytale-server-docker repository overview

Game server hosting

Fast RAM, high-speed internet

Eat lag for breakfast

Try our Hytale server hosting free for 2 days!⁠

⁠Hytale Dedicated Server Docker

A Docker container for running a Hytale dedicated server with automatic downloading and updates using the official Hytale Downloader CLI.

⁠Server Requirements

⁠How to use

Copy the .env.example file to a new file called .env and adjust the settings as needed.

⁠Quick Start

# 1. Start server
docker-compose up -d

# 2. Check logs for OAuth URL
docker-compose logs -f

# 3. Visit the URL in your browser and authenticate
# Server continues automatically after authentication

⁠Docker Compose

Then use either docker compose or docker run:

services:
  hytale:
    image: indifferentbroccoli/hytale-server-docker
    restart: unless-stopped
    container_name: hytale
    stop_grace_period: 30s
    ports:
      - 5520:5520/udp
    env_file:
      - .env
    volumes:
      - ./server-files:/home/hytale/server-files
    stdin_open: true
    tty: true

Then run:

docker-compose up -d

⁠Docker Run

docker run -d \
    --restart unless-stopped \
    --name hytale \
    --stop-timeout 30 \
    -p 5520:5520/udp \
    --env-file .env \
    -v ./server-files:/home/hytale/server-files \
    -it \
    indifferentbroccoli/hytale-server-docker

⁠Environment Variables

You can use the following values to change the settings of the server on boot.

⁠Port Configuration

Hytale uses the QUIC protocol over UDP (not TCP). Make sure to:

1. Open UDP port 5520 (or your custom port) in your firewall
2. Forward UDP port 5520 in your router if hosting from home
3. Configure firewall rules for UDP only

⁠File Structure

After first run, the following structure will be created in your server-files directory:

server-files/
├── Server/
│   ├── HytaleServer.jar       # Main server executable
│   └── HytaleServer.aot       # AOT cache for faster startup
├── Assets.zip                 # Game assets
├── downloader/                # Hytale downloader CLI
├── .cache/                    # Optimized file cache
├── logs/                      # Server log files
├── mods/                      # Installed mods (place .jar or .zip files here)
├── universe/                  # World and player save data
│   └── worlds/                # Individual world folders
├── bans.json                  # Banned players
├── config.json                # Server configuration
├── permissions.json           # Permission configuration
└── whitelist.json             # Whitelisted players

⁠Installing Mods

1. Download mods (.jar or .zip files) from sources like CurseForge⁠
2. Place them in the server-files/mods/ directory
3. Restart the server

⁠View Distance & Performance

View distance is the primary driver for RAM usage:

• Default: 12 chunks (384 blocks) ≈ 24 Minecraft chunks
• Recommended Max: 12 chunks for optimal performance
• RAM Impact: Higher view distances exponentially increase memory requirements

Tune MAX_MEMORY and VIEW_DISTANCE based on:

• Number of concurrent players
• How spread out players are in the world
• Available server resources

⁠Useful Commands

⁠View server logs

docker logs hytale -f
# or
docker-compose logs -f

⁠Stop the server

docker-compose down

⁠Restart the server

docker-compose restart

⁠Update server files

Server files are automatically updated on restart if DOWNLOAD_ON_START=true. To force an update:

docker-compose restart

⁠Support

• Official Hytale Server Manual⁠
• GitHub Issues⁠

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.