Hytale

games
Report Issue

Set out on an adventure built for both creation and play. Hytale blends the freedom of a sandbox with the momentum of an RPG: explore a procedurally generated world full of dungeons, secrets, and a variety of creatures, then shape it block by block.

Contributors:
william@venner.io
README

Hytale

Set out on an adventure built for both creation and play. Hytale blends the freedom of a sandbox with the momentum of an RPG: explore a procedurally generated world full of dungeons, secrets, and a variety of creatures, then shape it block by block.

Server Ports

Hytale uses a single UDP port for gameplay, operating over the QUIC transport protocol. An optional query port is available for server discovery using the Source Query Protocol.

Port Type Default
Game 5520
Query (Optional) 5521
Docker Images (1)
Name Image
ghcr.io/pterodactyl/games:hytale ghcr.io/pterodactyl/games:hytale
Startup Command 
java $( ((USE_AOT_CACHE)) && printf %s "-XX:AOTCache=Server/HytaleServer.aot" ) -Xms128M $( ((SERVER_MEMORY)) && printf %s "-Xmx${SERVER_MEMORY}M" ) -jar Server/HytaleServer.jar $( ((HYTALE_ALLOW_OP)) && printf %s "--allow-op" ) $( ((HYTALE_ACCEPT_EARLY_PLUGINS)) && printf %s "--accept-early-plugins" ) $( ((DISABLE_SENTRY)) && printf %s "--disable-sentry" ) --auth-mode ${HYTALE_AUTH_MODE} --assets Assets.zip --bind 0.0.0.0:${SERVER_PORT}
Variables (8)

Accept Early Plugins

Hytale warns that loading early plugins is unsupported and may cause stability issues.

Environment:
HYTALE_ACCEPT_EARLY_PLUGINS
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Auth Mode

Authentication mode.

Environment:
HYTALE_AUTH_MODE
Default:
authenticated
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:authenticated,offline

Patchline

The branch of Hytale to install.

Environment:
HYTALE_PATCHLINE
Default:
release
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:release,pre-release

Disable Sentry

Hytale uses Sentry to track crashes. Disable Sentry during active plugin development.

Environment:
DISABLE_SENTRY
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Use Ahead-of-Time Cache

Hytale provides a pre-trained AOT Java cache which can significantly improve boot times.

Environment:
USE_AOT_CACHE
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Allow operators

Allow operators

Environment:
HYTALE_ALLOW_OP
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Install Source Query plugin

Installs the Soruce Query plugin, so that your server responds to Source Query A2S requests (player count, server name, etc.)

Environment:
INSTALL_SOURCEQUERY_PLUGIN
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Source Query Port

The port that the Source Query plugin will use to respond to A2S requests. This should be different from the main server port. Defaults to the game port + 1.

Environment:
QUERY_PORT
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|integer|between:1,65535
Installation Script
Container: ghcr.io/pterodactyl/installers:alpine
Entrypoint: ash
#!/bin/ash
set -e

mkdir -p /mnt/server
cd /mnt/server

echo -e "Downloading Hytale Downloader CLI..."

DOWNLOAD_URL="https://downloader.hytale.com/hytale-downloader.zip"

rm -f hytale-downloader.zip
curl -o hytale-downloader.zip $DOWNLOAD_URL
unzip -o hytale-downloader.zip -d hytale-downloader
mv hytale-downloader/hytale-downloader-linux-amd64 hytale-downloader/hytale-downloader-linux
chmod 555 hytale-downloader/hytale-downloader-linux

echo -e "Verifying Hytale Downloader installation..."

echo -e "Hytale Downloader version: `./hytale-downloader/hytale-downloader-linux -version`"

echo -e "Hytale Downloader installed successfully."