We are your new 5-Star Hosting Company. At least according to ★ Trustpilot

Following along with a Hytale server? Deploy yours in minutes.

All servers come with a 24-Hour Trial, Free Backups, and 40Gbps DDoS Protection included!

Use code SAVE15 to take 15% OFF Your First Invoice with ChicagoServers! Limited Time!
Hytale guide

Hytale Server Updates and Versions: /update Commands and Patchlines

By the ChicagoServers team · Updated · 8 min read

Hytale is in Early Access, and the game changes often. Every time it does, your server has to catch up, because a Hytale client and server only talk to each other when they are on the same version. A server that is one update behind is, from a player's point of view, a server that is down.

This guide explains the version-matching rule, the built-in /update commands, the Update block in config.json, patchlines, the HYTALE_DISABLE_UPDATES environment variable, and a backup routine that protects your world. It ends with a checklist for the moment players say they cannot join. Official details come from Hytale's Server Manual. Anything about release timing comes from Hytale's announcements and community reporting, and is marked as such. Timing can change.

Quick answer
  • The client and server must be on the exact same protocol version. Hytale checks with a hash, and if the hashes do not match exactly, the connection is rejected.
  • The built-in updater uses /update check, /update download and /update apply --confirm. Applying backs up files, then shuts the server down with exit code 8 so the wrapper script can restart it.
  • /update patchline [name] shows or sets the patchline. The default is the build's own, usually release.
  • Set the HYTALE_DISABLE_UPDATES environment variable to turn updating off entirely.
  • Back up universe/ and your config files before any update. Early Access updates can change things in ways that are hard to reverse.
  • Players cannot join after an update? Compare the server's version (/update status) with the player's client and patchline first.
On this page
  1. The rule that drives everything: matching versions
  2. Ways to update a Hytale server
  3. The /update commands
  4. Why updates may not work on a custom setup
  5. The Update block in config.json
  6. Patchlines
  7. Back up before every update
  8. Players cannot join after an update
  9. Running this on ChicagoServers
  10. Frequently asked questions

The rule that drives everything: matching versions

Hytale's Server Manual is blunt about this. The protocol uses a hash to check client and server compatibility. If the hashes do not match exactly, the connection is rejected. In the manual's words, client and server must be on the exact same protocol version, which is why it advises that servers should update promptly after a release.

Practically, that gives you three situations to recognise:

SituationWhat players experienceFix
Server older than the clientCannot connect after the game updatesUpdate the server.
Server newer than the clientCannot connect after you update firstPlayers update the game through the launcher.
Different patchlinesCannot connect even when both seem currentPut the server and the clients on the same patchline (below).

Ways to update a Hytale server

MethodHow it worksWhen to use it
Built-in updaterThe /update commands download and stage a new version, then the wrapper script restarts the server on it.Servers started by start.sh or start.bat in the standard layout.
Hytale Downloader CLIRun ./hytale-downloader to fetch the latest release, then replace the server files.Production servers where you control the files.
Manual copyCopy the Server folder and Assets.zip from the launcher install.Quick tests. Easiest to get wrong.
Hosted serverDepends on how the host starts the server.Check the panel, or ask support.

A community write-up describes the Downloader CLI route as: stop the server, back up, run ./hytale-downloader -print-version to see what is available, run ./hytale-downloader to download it, replace the Server/ folder and Assets.zip, and restart. It also says not to overwrite world or config files. That matches the manual's own description of what the wrapper scripts replace and keep.

The /update commands

CommandWhat it does
/update checkChecks whether an update is available.
/update downloadDownloads an available update to staging.
/update download --forceDownloads even if you are already on the latest version. Useful for creating the update layout.
/update apply --confirmApplies the staged update after backing up files, then shuts the server down with exit code 8.
/update cancelCancels and deletes the staged update.
/update statusShows the current version and update status.
/update patchline [name]Shows or sets the patchline.
/update setupWrites start.sh and start.bat to the parent directory. Must be run from a Server/ directory unless you add --force. No download needed.
  1. Check

    Run /update status to see where you are, then /update check.

  2. Download

    Run /update download. The update is staged in updater/staging/ and nothing changes yet.

  3. Warn players and back up

    Give players notice, and take a backup of your own as described below.

  4. Apply

    Run /update apply --confirm. The server backs up files into updater/backup/ and shuts down with exit code 8.

  5. Let the wrapper restart it

    The wrapper script treats exit code 8 as a restart request, applies the staged update at the start of its cycle and starts the server again. Any other exit code stops the loop.

The wrapper replaces only server binaries, Licenses, Assets.zip and the launcher scripts, and it keeps your config, saves and mods.

Why updates may not work on a custom setup

The updater has a layout requirement. The server must be started from the Server/ directory, and the parent directory must contain Assets.zip and the launcher script. The manual states plainly that if this layout is not detected, the update checker is disabled. The bootstrap install and the Downloader CLI both create the right layout.

If /update check does nothing on your own machine, this is the first thing to verify. On a hosted server the host controls how the process starts, so contact ChicagoServers support to find out how your server follows new releases.

The Update block in config.json

Automatic behaviour is controlled by an Update block in config.json. Edit it with the server stopped, as explained in the config files guide.

FieldDefaultNotes
EnabledtrueEnables automatic update checks.
CheckIntervalSeconds3600Seconds between checks.
NotifyPlayersOnAvailabletrueNotifies players with permission when an update is available.
PatchlinenullOverrides the patchline. Defaults to the build's, usually release.
RunBackupBeforeUpdatetrueRuns a full backup first. Requires a configured backup directory.
BackupConfigBeforeUpdatetrueBacks up config.json, permissions.json, bans.json and whitelist.json.
AutoApplyModeDisabledDisabled, WhenEmpty or Scheduled.
AutoApplyDelayMinutes30Minutes to wait before applying in Scheduled mode.
  • Disabled never applies an update by itself. You run /update apply --confirm.
  • WhenEmpty applies when no players are online.
  • Scheduled applies after the delay even if players are online, and warns them periodically.

Disabled is the safest default for a community server, because nobody is surprised by a restart. WhenEmpty suits a small private server. To switch updating off completely, set the HYTALE_DISABLE_UPDATES environment variable. That is the right choice if you pin a version on purpose, for example while waiting for a mod to catch up, but remember that players on a newer client will not be able to join.

Patchlines

A patchline is an update channel. The Server Manual refers to release as the usual default and uses pre-release as the example of another. You select one with the Patchline field in config.json, with /update patchline [name], or with -patchline pre-release on the Downloader CLI.

The manual does not describe the character of each channel. Hytale has said it plans weekly pre-release patches that are experimental and unstable by design, bundled into a stable update every two to six weeks. In practice stable updates have often landed further apart than that, so treat the cadence as an intention, not a guarantee, and check Hytale's own announcements for the current schedule.

Back up before every update

Early Access updates can change data in ways you cannot easily reverse. One host's guide warns that updates can alter the save format and that some upgraded worlds may not open on an older version. That is a single source, but it costs little to take it seriously.

WhatWhy
universe/Worlds and player data.
config.json, permissions.json, whitelist.json, bans.jsonYour settings and player lists.
mods/So you can restore the exact mod set that worked.

The game does some of this itself. /update apply --confirm backs up files before applying, pre-update backups go in updater/backup/, and the wrapper script points you there for rollback after a crash shortly after an update. The RunBackupBeforeUpdate field needs a configured backup directory, and the wrapper scripts pass --backup --backup-dir backups --backup-frequency 30. Do not treat these as a substitute for your own backup, because they live on the same disk.

On ChicagoServers, open the Backups tab, choose World and settings (or Whole server), and click Back up now if your plan includes backups. To undo an update, click Restore next to the backup, then choose Put it back. The Schedules tab can also include a Make a backup step.

Players cannot join after an update

Work through the list from the top. Most cases are version mismatches.

CheckHowIf it fails
Server versionRun /update status and read the startup lines in the console.Run the update steps above.
Player versionAsk the player to update through the Hytale launcher and restart.Have them update, then retry.
PatchlineCompare the server's patchline with the launcher's patchline dropdown.Align them.
AuthenticationRun /auth status. See the authentication guide.Run /auth login device.
ModsMods built for the previous version may fail to load, according to a host's guide.Check each mod for an update, or remove the newest one.
PortConfirm the server still listens on the UDP port players use.See the setup guide.
Whitelist or passwordCheck you did not change them while editing.Review whitelist.json and Password.

If the update itself caused the problem and you cannot fix it, restore the backup taken before the update, and make sure the world and the server files come from the same point in time.

Running this on ChicagoServers

The Hytale hosting plan costs $15/mo, with instant setup, 24/7 support and a 7-day money-back guarantee. Updates are the area where Early Access servers need the most attention, so contact support if you are unsure how your server follows new releases.

Frequently asked questions

Why can't players join my Hytale server after an update?

Almost always a version mismatch. Hytale rejects the connection when client and server protocol versions differ. Update the server (or have players update their game) so both match, and check that everyone is on the same patchline.

How do I update a Hytale server?

With the built-in updater, run /update check, then /update download, then /update apply --confirm. The server backs up files and exits with code 8, and the start.sh or start.bat wrapper restarts it on the new version. Alternatively, use the Hytale Downloader CLI and replace the server files.

What is a Hytale patchline?

An update channel. Hytale's manual names release as the usual default and pre-release as another option. Set it with /update patchline, the Patchline field in config.json, or the downloader's -patchline flag. Players' launchers generally need to use the same one.

How do I stop my Hytale server updating automatically?

Set AutoApplyMode to Disabled in the Update block of config.json, which is the default and means updates are never applied automatically. To disable updating entirely, set the HYTALE_DISABLE_UPDATES environment variable.

How often does Hytale update?

Hytale is in Early Access and the schedule is not fixed in the official manual. Hytale has said it plans weekly pre-release builds and a stable update every two to six weeks, but in practice stable updates have often come further apart. Check Hytale's own announcements for current timing.

Should I back up before updating?

Yes. Back up universe/, config.json, permissions.json, whitelist.json, bans.json and mods/. The game also takes its own backup when you apply an update, but keep a separate copy.

We are your new 5-Star Hosting Company. At least according to ★ Trustpilot

Following along with a Hytale server? Deploy yours in minutes.

All servers come with a 24-Hour Trial, Free Backups, and 40Gbps DDoS Protection included!

We offer quality support, a detailed knowledgebase, video tutorials on most topics, and even live support in case you prefer a live human.

Use code SAVE15 to take 15% OFF Your First Invoice with ChicagoServers! Limited Time!