Compatibility
Hytale will run on popular distros as long as the minimum requirements are met.
Install Notes
Hytale is not on Steam. LinuxGSM installs and updates the server with the official Hytale downloader, which needs a one-time login with an account that owns Hytale. During install, LinuxGSM shows a device code: open the link, sign in and approve it.
After the first start, log the server itself in once: run ./hytserver send "/auth login device" and approve the code. The login is saved and reused on restart.
Hytale requires Java 25.
Server
For consistant uptime it is recomended you host a server in a data center. If you dont already have a server, you can rent a dedicated or vitual server from one of our sponsored providers, OVHCloud, Linode, Vultr.
Minimum Recommended Distros
Other Distros
Although not tested, any distro with tmux => 1.6 and JRE => 25 should also be compatible with Hytale servers.Install Dependencies Using LinuxGSM
LinuxGSM will attempt to install dependencies either by having the hytserver user account with sudo access or running the installer as root.user with sudo access
During the installation if the game server user has sudo permissions LinuxGSM will attempt to install any missing dependencies itself.root user
if hytserver is already installed run./hytserver install as root and LinuxGSM will automatically install missing dependencies.
Install
From the command-line do the following. Ensuring you have also installed the required dependencies.
1. Create a user and login.adduser hytserver
For security best practice, ensure you set a strong password. Random password:
su - hytserver2. Download linuxgsm.sh.
curl -Lo linuxgsm.sh https://linuxgsm.sh && chmod +x linuxgsm.sh && bash linuxgsm.sh hytserver3. Run the installer following the on-screen instructions.
./hytserver install
Basic Usage
All Commands
A complete list of commands can be found by typing../hytserverBelow are the most common commands available.
Running
start
./hytserver start
stop
./hytserver stop
restart
./hytserver restart
console
Console allows you to view the live console of a server as it is running and allow you to enter commands; if supported../hytserver console
To exit the console press CTRL+b d. Pressing CTRL+c will terminate the server.
Updating
update
Update checks for any server updates and applies them. The server will update and restart only if required../hytserver update
Debugging
Details
You can get all important and useful details about the server such as passwords, ports, config files etc.
./hytserver details
Debug
Use debug mode to help you if you are having issues with the server. Debug allows you to see the output of the server directly to your terminal allowing you to diagnose any problems the server might be having.
./hytserver debug
Logs
Server logs are available to monitor and diagnose your server. Script, console and game server (if available) logs are created for the server.
/home/hytserver/logs
Backup
Backup will allow you to create a complete tar bzip2 archive of the whole server.
./hytserver backup
Monitor
LinuxGSM can monitor the game server by checking that the proccess is running and querying it. Should the server go offline LinuxGSM can restart the server and send you an alert. You can use cronjobs to setup monitoring.
./hytserver monitor
Configure LinuxGSM
For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.
Documentation
For detailed documentation visit the LinuxGSM docs.
Cronjobs
To automate LinuxGSM you can set scheduled tasks using cronjobs, to run any command at any given time. You can edit the crontab using the following.
crontab -e
Below are the recommended cron tasks.
*/5 * * * * /home/hytserver/hytserver monitor > /dev/null 2>&1 */30 * * * * /home/hytserver/hytserver update > /dev/null 2>&1 0 0 * * 0 /home/hytserver/hytserver update-lgsm > /dev/null 2>&1
Configure LinuxGSM
For details on how to alter LinuxGSM settings visit LinuxGSM Config Files page.
Documentation
For detailed documentation visit the LinuxGSM docs.