Guide

How to Set Up Automatic Server Backups in Hytale

With Hytale now in early access, implementing robust automatic server backup solutions is crucial for any server owner, ensuring the safety and longevity of their world and player data. Automatic backups provide a critical safety net against data corruption, hardware failure, accidental deletions, or even malicious activity, allowing for quick restoration to a previous, stable state.

Mechanics of Hytale Server Backups

At its core, a Hytale server backup involves preserving all essential data that defines your server’s state. This typically includes the world itself, player inventories, character data, and any server-side modifications you might be running. Understanding where this data resides is key to effective backup strategies.

World Data: The primary component is usually found within the universe folder in your server’s root directory. This folder contains all world files, map chunks, player data, and inventories. It is the most critical element to back up for world preservation.
Player Information: Player-specific data, such as inventories, progress, and positions, is stored within the universe folder alongside the world data. A complete backup of the universe folder ensures all player progress is saved.
Installed Mods: If your server utilizes any mods, the mods folder is equally important. Backing up this folder ensures that your server can be restored with all its intended functionalities and content. Without the mods, a restored world might be unplayable or lose mod-specific items and blocks.
Configuration Files: Server configuration files, often found in the root directory or a dedicated config folder, are also vital for maintaining server settings, permissions, and other operational parameters.

Backups can range from full server archives, encompassing every file, to more granular solutions allowing for the restoration of specific worlds, individual player data, or even single configuration files. The method you choose will influence the flexibility of your restoration process.

Setting Up Automatic Server Backups

There are several reliable approaches to setting up automatic server backups in Hytale, catering to different levels of technical expertise and hosting environments.

1. Using Built-in Hytale Server Features

The Hytale dedicated server software includes an integrated backup mechanism that can be configured directly via command-line arguments when starting your server. This method is ideal for self-hosted servers or those with direct control over their server startup scripts.

When initiating your Hytale server, you can append specific arguments to the startup command to enable and configure automatic backups.
Include the --backup argument to activate the automatic backup system.
Specify the destination directory for your backup archives using --backup-dir <Path>. Replace <Path> with the absolute or relative path to your desired backup storage location.
Set the backup frequency in minutes using --backup-frequency <Integer>. For example, 60 would create a backup every hour. The default frequency is 30 minutes if this argument is omitted.
A complete example of a server startup command with backup configuration would look like this:
```
java -jar HytaleServer.jar --assets Assets.zip --backup --backup-dir /path/to/your/backups --backup-frequency 60
```
This command starts the server, loads assets, and configures it to create a backup every 60 minutes, storing the archives in the specified directory.
If you are running your Hytale server within a Docker container, you can configure these backup settings using environment variables. Common variables might include HYTALE_ENABLE_BACKUP=true to activate backups and HYTALE_BACKUP_DIR=/app/backups to set the backup location within the container. Consult your Docker image’s documentation for specific variable names.

2. Utilizing Third-Party Mods

For server owners who prefer a mod-based solution or require more granular control over backup content and scheduling, third-party mods can provide robust options. An example of such a mod is “HyBackup” available on platforms like CurseForge.

Begin by downloading the mod’s JAR file, for instance, HyBackup-<version>.jar, from its official distribution platform.
Place the downloaded JAR file directly into the mods/ folder located within your Hytale server’s root directory.
Start your Hytale server at least once. This action will allow the mod to initialize and generate its default configuration files. Typically, these will be found in a new subfolder, such as mods/HyBackup/, containing files like config.json and messages.json.
Edit the config.json file using a text editor. This file allows you to define various backup parameters, including:
- Scheduling: Configure backups to run daily at a specific time (e.g., "dailyAt": "03:00") or at regular intervals (e.g., "everyNMinutes": 120).
- Backup Scope: Specify what data should be included in the backup. Options might include backing up only the world folder, the entire server directory (with exclusions for the backup folder itself), or a list of specific folders you define.
- Retention: Set how many old backups to keep before they are automatically deleted.
- Compression: Choose the compression level for the backup archives.
After saving your changes to config.json, you can apply them without restarting the server by using an in-game command, such as /hybackup-configreload (if provided by the mod), or by simply restarting your Hytale server.
Backups created by such mods are typically saved as compressed archives (e.g., .zip files) within a dedicated backup directory, often organized into date-named subfolders for easy navigation (e.g., mods/HyBackup/backups/YYYY-MM-DD/).

3. Through Game Server Hosting Providers

For many Hytale server owners, utilizing a game server hosting provider is the most convenient option. Most reputable hosting companies offer integrated, user-friendly automatic backup solutions as part of their service package.

Access your hosting provider’s server control panel. This is usually a web-based interface (e.g., Nodecraft Dashboard, HolyHosting server panel, BisectHosting control panel).
Navigate to the section dedicated to “Backups,” “File Management,” or “Server Management.” The exact naming may vary between providers.
Look for options to enable, schedule, or configure automatic backups. Many hosts provide automatic backups free of charge for a certain retention period (e.g., 3 days of backups).
Within the backup configuration, you may find options to:
- Enable/Disable: Toggle the automatic backup feature on or off.
- Schedule: Define the frequency (e.g., daily, hourly) and specific times for backups to run.
- Retention Policy: Set how many backup copies to keep before older ones are automatically removed.
- Backup Naming: Assign custom names or prefixes to your backups for easier identification.
- Exclusions: Specify files or folders to exclude from backups (e.g., temporary logs).
- Lock Backups: Some providers allow you to “lock” specific backups to prevent them from being automatically deleted, ensuring critical recovery points are always available.
To restore your server, select the desired backup from the list in your control panel and initiate the restore process. Hosting panels typically offer options to restore the entire server, or in some cases, allow you to download backup archives to manually recover individual worlds or files.

Tips for Automatic Server Backups

Regularity is Key: Configure backups to run frequently enough to minimize potential data loss. Consider your server’s activity level; a busy server might benefit from hourly backups, while a less active one might be fine with daily.
Test Restorations: Periodically perform a test restoration on a separate, temporary server or a local instance. This verifies that your backup process is working correctly and that you understand the restoration steps before an actual emergency arises.
Offsite Storage: For maximum security, consider syncing your primary backup directory to an offsite location, such as a cloud storage service (e.g., Google Drive, Dropbox, Amazon S3) or another physical drive. This protects your data against local disasters like hardware failure or fire.
Backup Before Updates: Always create a full, manual server backup immediately before applying any major server updates, installing new mods, or making significant world edits. This provides a clean rollback point if something goes wrong.
Manage Backup Retention: Be mindful of how many backups your system stores and for how long. While more backups offer greater recovery flexibility, they also consume significant storage space. Adjust your retention policies to balance data safety with available storage. Many hosting providers automatically delete older backups unless explicitly “locked.”
Understand What’s Backed Up: Ensure your backup strategy comprehensively covers all critical data. This includes the universe folder (for world and player data) and the mods folder (if you use server-side modifications).

Common Mistakes

Not Stopping the Server for Manual Restores: When manually restoring specific files or worlds from a backup, always stop the Hytale server completely first. Attempting to restore files while the server is running can lead to data corruption, inconsistencies, or server crashes.
Forgetting to Backup Mods: If your server relies on mods, a backup of only the world data (universe folder) is insufficient. Always ensure that your mods folder is included in your backup strategy. When restoring a modded world, ensure the exact same mods are present on the server to prevent crashes, lost items, or corrupted chunks.
Insufficient Storage: Running out of disk space for your backups is a common issue that can cause automatic backups to fail silently. Regularly monitor your available storage and adjust your backup retention policy or expand storage as needed.
Incorrect File Paths: When configuring manual or built-in backups, double-check that all specified backup directory paths are accurate and accessible by the server process. Incorrect paths will lead to failed backups.
Over-reliance on a Single Backup Method: While hosting providers offer convenient solutions, having a secondary, independent backup method (e.g., using the built-in --backup command or a separate mod) can provide an extra layer of security and redundancy.
Ignoring Backup Logs: Always check backup logs or your hosting panel’s backup status reports regularly. This confirms that backups are completing successfully and alerts you to any errors or failures that need attention.

Uncertainties

As Hytale is currently in early access, its features and optimal practices are subject to evolution. While the core mechanisms for server backups are established and functional, future updates could introduce new tools, modify existing processes, or change file structures. For instance, there are plans for advanced Hytale server tools, such as a “Backup Planner” to assist with retention and storage estimates.

Always refer to the latest official Hytale Server Manual and your specific hosting provider’s documentation for the most up-to-date and accurate information regarding server management and backup procedures.