Skip to content

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.

egg-hytale.json

updated

Ports
5520, 5521
Runtime
hytale image
Variables
8

Ports

Add an allocation on the node for each port.

  • Game 5520
  • Query (Optional) 5521

Install

Installer image
ghcr.io/pterodactyl/installers:alpine
Install script
21 lines

Image

  • hytale image ghcr.io/pterodactyl/games:hytale

Panel features

  • java_version

    The Panel lets the user change the Java version when the server needs a different one.

Startup

The Panel runs this command to start the server. It replaces each variable in the command with the value of that variable.

8 variables

Startup command

java $( ((USE_AOT_CACHE)) && printf %s "-XX:AOTCache=Server/HytaleServer.aot" ) -Xms128M $( ((SERVER_MEMORY)) && printf %s "-Xmx1024M" ) -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 authenticated --assets Assets.zip --bind 0.0.0.0:5520

Dotted values come from the server settings. These values are examples.

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

    HYTALE_ACCEPT_EARLY_PLUGINSUsers can edit

    required|boolean

  • Authentication mode.

    HYTALE_AUTH_MODEUsers can edit

    required|string|in:authenticated,offline,insecure

  • The branch of Hytale to install.

    HYTALE_PATCHLINEUsers can edit

    required|string|in:release,pre-release

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

    DISABLE_SENTRYUsers can edit

    required|boolean

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

    USE_AOT_CACHEUsers can edit

    required|boolean

  • Allow operators

    HYTALE_ALLOW_OPUsers can edit

    required|boolean

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

    INSTALL_SOURCEQUERY_PLUGINUsers can edit

    required|boolean

  • 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.

    QUERY_PORTUsers can edit

    nullable|integer|between:1,65535

Wings

Stop command
/stop
Running when the console shows
Hytale Server Booted

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

Changes

  1. Hytale: Add insecure auth mode to list of auth modes (#531)

    · Luna · 92c7285

  2. Hytale: Install Source Query plugin

    · William Venner · fed1c07

  3. Add missing args

    · William Venner · 29ec0d9

  4. unzip -o

    · William Venner · 1ee617e

  5. /stop

    · William Venner · e8fdc67

  6. bind-addr

    · William Venner · e060149

All changes on GitHub

Problem with this egg?

Open an issue on GitHub. Include your Panel and Wings versions.

Report an issue
Install script 21 lines ash in ghcr.io/pterodactyl/installers:alpine Show 
#!/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."