Hytale server config

The settings of a Hytale 0.7.7 dedicated server: config.json, each world's own config file, and the options HytaleServer.jar takes on the command line. Keys, types and defaults come from the JSON schemas the server generates for itself, and launch options from its --help. Where the server gives no description, only the type and default are shown.

config.json 64 keys
World config 44 keys
Launch options 46
The default file
How to run a server

config.json

Lives next to HytaleServer.jar; the server writes it on its first start. Dotted keys are nested objects: Backup.FrequencyMinutes is FrequencyMinutes inside Backup. 19 of the 64 keys carry a description in the schema.

Key	Type	Default	What it does
`Version`	integer	–	–
`ServerName`	string	Hytale Server	The server's name.
`MOTD`	string	(empty)	Message of the day.
`Password`	string	(empty)	Password players must enter to join; empty means none.
`SentryDsn`	string	–	The Sentry DSN for error reports. If absent, the server uses the Hytale DSN. If blank, Sentry is off. A custom DSN also receives errors from third-party plugins. Singleplayer ignores this key.
`MaxPlayers`	integer	100	Most players online at once.
`MaxViewRadius`	integer	32	Largest view distance the server sends, in chunks.
`Defaults`	object	{"World":"default","GameMode":"Adventure","HardcoreMode":"None","CrashRecovery":{}}	–
`Defaults.World`	string	default	The world players join by default.
`Defaults.GameMode`	string	Adventure	The game mode players get by default.
`Defaults.GameModeTypeOnDeath`	string	–	–
`Defaults.HardcoreMode`	string	–	–
`Defaults.HardcoreLives`	integer	–	Lives per player for PerPlayer, or the shared pool size for Global. Defaults to 1. None ignores it.
`Defaults.CrashRecovery`	object	{}	Recovery policy for the default world when its thread crashes.
`ConnectionTimeouts`	object	{}	–
`ConnectionTimeouts.InitialTimeout`	string	–	–
`ConnectionTimeouts.AuxStreamPendingTimeout`	string	–	–
`ConnectionTimeouts.AuthTimeout`	string	–	–
`ConnectionTimeouts.AuthGrantTimeout`	string	–	–
`ConnectionTimeouts.AuthTokenTimeout`	string	–	–
`ConnectionTimeouts.AuthServerExchangeTimeout`	string	–	–
`ConnectionTimeouts.PasswordTimeout`	string	–	–
`ConnectionTimeouts.PlayTimeout`	string	–	–
`ConnectionTimeouts.SetupWorldSettings`	string	–	–
`ConnectionTimeouts.SetupAssetsRequest`	string	–	–
`ConnectionTimeouts.SetupSendAssets`	string	–	–
`ConnectionTimeouts.SetupAddToUniverse`	string	–	–
`RateLimit`	object	{}	–
`RateLimit.Enabled`	boolean	–	Determines whether packet rate limiting is enabled.
`RateLimit.PacketsPerSecond`	integer	–	The number of packets allowed per second.
`RateLimit.BurstCapacity`	integer	–	The number of packets that can be sent in a burst before rate limiting is applied.
`Modules`	object	–	–
`LogLevels`	object	–	–
`Plugins`	object	–	–
`Mods`	object	–	–
`ModLoadOrder`	array	–	–
`DefaultModsEnabled`	boolean	–	–
`RequireJoinPermission`	boolean	false	–
`DisplayTmpTagsInStrings`	boolean	false	–
`PlayerStorage`	–	–	–
`UniverseResourceStorage`	–	–	–
`BanStorage`	–	–	–
`AuthCredentialStore`	–	–	–
`Update`	object	{}	–
`Update.Enabled`	boolean	–	Determines whether to enable automatic update checks.
`Update.CheckIntervalSeconds`	integer	–	The interval, in seconds, between automatic update checks.
`Update.NotifyPlayersOnAvailable`	boolean	–	Whether to notify players in-game when an update is available.
`Update.Patchline`	string	–	The patchline to check for updates on.
`Update.RunBackupBeforeUpdate`	boolean	–	Determines whether to run a backup before applying an update.
`Update.BackupConfigBeforeUpdate`	boolean	–	Determines whether to backup the server config before applying an update.
`Update.AutoApplyMode`	string	–	The mode for automatically applying updates.
`Update.AutoApplyDelayMinutes`	integer	–	The delay in minutes before auto-applying an update while using SCHEDULED mode.
`Backup`	object	{}	–
`Backup.Enabled`	boolean	–	Determines whether automatic backups are enabled. Can be overridden by the --backup CLI option.
`Backup.FrequencyMinutes`	integer	–	The backup frequency in minutes. Must be at least 1. Can be overridden by the --backup-frequency CLI option.
`Backup.Directory`	string	–	The backup directory path. Can be overridden by the --backup-directory CLI option.
`Backup.MaxCount`	integer	–	The maximum number of recent backups to retain. Must be at least 1. Can be overridden by the --backup-max-count CLI option.
`Backup.ArchiveMaxCount`	integer	–	The maximum number of archived backups to retain. Must be at least 1. Can be overridden by the --backup-archive-max-count CLI option.
`WorldMap`	object	{}	–
`WorldMap.ViewRadiusMin`	integer	–	–
`WorldMap.ViewRadiusMax`	integer	–	–
`FallbackServer`	object	–	–
`FallbackServer.Host`	string	(empty)	Address of the fallback server.
`FallbackServer.Port`	integer	0	Port of the fallback server.

World config

Each world has its own universe/worlds/<name>/config.json with these keys: PvP, fall damage, NPC spawning, time of day and more. 40 of the 44 keys carry a description in the schema.

Key	Type	Default	What it does
`Version`	integer	–	–
`UUID`	string	–	The unique identifier for this world. Instances will ignore this and replace it with a freshly generated UUID when spawning the instance.
`DisplayName`	string	–	The player facing name of this world.
`Seed`	integer	–	The seed of the world, used for world generation. If a seed is not set then one will be randomly generated.
`SpawnPoint`	object	–	Deprecated: Please use SpawnProvider instead.
`SpawnProvider`	–	–	Sets the spawn provider for the world. This controls where new players will enter the world at. This can be provided by world generation in some cases.
`WorldGen`	–	–	Sets the world generator that will be used by the world.
`WorldMap`	–	–	–
`WorldMapConfig`	object	–	Optional per-world overrides for world map configuration and limits.
`ChunkStorage`	–	–	Sets the storage system that will be used by the world to store chunks.
`ChunkConfig`	object	{}	Configuration for chunk related settings
`IsTicking`	boolean	true	Sets whether chunks in this world are ticking or not.
`IsBlockTicking`	boolean	true	Sets whether blocks in this world are ticking or not.
`IsPvpEnabled`	boolean	false	Sets whether PvP is allowed in this world or not.
`IsFallDamageEnabled`	boolean	true	Sets whether fall damage is allowed in this world or not.
`IsGameTimePaused`	boolean	false	Sets whether the game time is paused. This effects things like day/night cycles and things that rely on those.
`GameTime`	string	–	The current time of day in the world.
`ForcedWeather`	string	–	Sets the type of weather that is being forced to be active in this world.
`ClientEffects`	object	{"SunHeightPercent":100,"SunAngleDegrees":0,"BloomIntensity":0.30000001192092896,"BloomPower":8,"SunIntensity":0.25,"SunshaftIntensity":0.30000001192092896,"SunshaftScaleFactor":4}	Settings for the client's weather and post-processing effects in this world.
`PregenerateRegion`	object	–	–
`RequiredPlugins`	object	–	Sets the plugins that are required to be enabled for this world to function.
`GameMode`	string	–	Sets the default gamemode for this world.
`DefaultPermissionGroup`	string	–	The default permission group assigned to new players joining this world.
`IsSpawningNPC`	boolean	true	Whether NPCs can spawn in this world or not.
`IsBlockSpawnersEnabled`	boolean	true	Whether block spawners resolve into their target blocks in this world.
`IsSpawnMarkersEnabled`	boolean	true	Whether spawn markers are enabled for this world.
`IsAllNPCFrozen`	boolean	false	Whether all NPCs are frozen for this world
`GameplayConfig`	string	Default	The gameplay configuration being used by this world
`Death`	object	–	Inline death configuration overrides for this world. If set, these values take precedence over the referenced GameplayConfig.
`DaytimeDurationSeconds`	integer	–	Override for the duration of daytime in seconds. If set, takes precedence over the referenced GameplayConfig.
`NighttimeDurationSeconds`	integer	–	Override for the duration of nighttime in seconds. If set, takes precedence over the referenced GameplayConfig.
`IsCompassUpdating`	boolean	true	Whether the compass is updating in this world
`IsSavingPlayers`	boolean	true	Whether the configuration for player's is being saved for players in this world.
`IsSavingChunks`	boolean	true	Whether the chunk data is allowed to be saved to the disk for this world.
`SaveNewChunks`	boolean	true	Whether newly generated chunks should be marked for saving or not. Enabling this can prevent random chunks from being out of place if/when worldgen changes but will increase the size of the world on disk.
`IsUnloadingChunks`	boolean	true	Whether the chunks should be unloaded like normally, or should be prevented from unloading at all.
`IsObjectiveMarkersEnabled`	boolean	true	Whether objective markers are enabled for this world.
`DeleteOnUniverseStart`	boolean	false	Whether this world should be deleted when loaded from Universe start. By default this is when going through the world folders in the universe directory.
`DeleteOnRemove`	boolean	false	Whether this world should be deleted once its been removed from the server
`CrashRecovery`	object	–	Recovery policy for this world when its thread crashes. Overrides the server default.
`Instance`	object	–	Instance specific configuration.
`DisabledFluidTickers`	array	–	A set of fluid tag strings (e.g. "Fluid=Water", "Fire=Fire") whose tickers should be disabled in this world. Fluids matching any of these tags will not tick.
`ResourceStorage`	–	–	Sets the storage system that will be used to store resources.
`Plugin`	object	–	–

Launch options

Options for java -jar HytaleServer.jar, as its own --help prints them. The bundled start.sh already passes --assets ../Assets.zip and the backup options.

Option	Value	Default	What it does
`--accept-early-plugins`	switch	–	You acknowledge that loading early plugins is unsupported and may cause stability issues.
`--allow-install-dir`	switch	–	Allows the server to run inside the launcher install directory. You accept the risk of data loss.
`--allow-op`	switch	–	–
`--assets`	`<Path>`	../HytaleAssets	Asset directory
`--auth-mode`	`<authenticated\|offline\|insecure>`	AUTHENTICATED	Authentication mode
`--bind` or -b	`<InetSocketAddress>`	0.0.0.0:5520	Port to listen on
`--backup`	switch	–	–
`--backup-archive-max-count`	`<Integer>`	5	–
`--backup-dir`	`<Path>`	–	–
`--backup-frequency`	`<Integer>`	30	–
`--backup-max-count`	`<Integer>`	5	–
`--bare`	switch	–	Runs the server bare. For example without loading worlds, binding to ports or creating directories. (Note: Plugins will still be loaded which may not respect this flag)
`--boot-command`	`<String>`	–	Runs command on boot. If multiple commands are provided they are executed synchronously in order.
`--bootstrap`	switch	–	Runs the server in bootstrap mode. Only the plugins required to authenticate and download the full server payload are loaded; use '/update download' to populate the current directory with Assets.zip, start.sh/bat and the Server/ JAR layout. Implies --bare.
`--client-pid`	`<Integer>`	–	–
`--disable-asset-compare`	switch	–	–
`--disable-cpb-build`	switch	–	Disables building of compact prefab buffers
`--disable-file-watcher`	switch	–	–
`--disable-sentry`	switch	–	–
`--early-plugins`	`<Path>`	–	Additional early plugin directories to load from
`--event-debug`	switch	–	–
`--force-network-flush`	`<Boolean>`	true	–
`--generate-asset-schema`	`<Path>`	–	Generate asset JSON schemas to the specified directory and exit
`--generate-config-schema`	`<Path>`	–	Generate config JSON schemas to the specified directory and exit
`--help`	switch	–	Print's this message.
`--identity-token`	`<String>`	–	Identity token (JWT)
`--ignore-broken-mods`	switch	–	Ignores broken mods, attempting to allow the server to boot even if one fails to load
`--log`	`<KeyValueHolder>`	–	Sets the logger level.
`--migrate-worlds`	`<String>`	–	Worlds to migrate
`--migrations`	`<Object2ObjectOpenHashMap>`	–	The migrations to run
`--mods`	`<Path>`	–	Additional mods directories
`--owner-name`	`<String>`	–	–
`--owner-uuid`	`<UUID>`	–	–
`--prefab-cache`	`<Path>`	–	Prefab cache directory for immutable assets
`--recovery-mode`	`<Options$RecoveryMode>`	–	How to handle broken chunks when encountered during recovery
`--session-token`	`<String>`	–	Session token for Session Service API
`--shutdown-after-validate`	switch	–	Automatically shutdown the server after asset and/or prefab validation.
`--singleplayer`	switch	–	–
`--transport` or -t	`<TransportType>`	QUIC	Transport type
`--universe`	`<Path>`	–	–
`--validate-assets`	switch	–	Causes the server to exit with an error code if any assets are invalid.
`--validate-prefabs`	switch	–	Causes the server to exit with an error code if any prefabs are invalid.
`--validate-world-gen`	switch	–	Causes the server to exit with an error code if default world gen is invalid.
`--verify-worlds`	switch	–	Verify all worlds and then exits
`--version`	switch	–	Prints version information.
`--world-gen`	`<Path>`	–	World gen directory

The default config.json

What a fresh 0.7.7 server writes on its first start, before any change:

{
  "Version": 4,
  "ServerName": "Hytale Server",
  "MOTD": "",
  "Password": "",
  "MaxPlayers": 100,
  "MaxViewRadius": 32,
  "Defaults": {
    "World": "default",
    "GameMode": "Adventure",
    "HardcoreMode": "None",
    "CrashRecovery": {}
  },
  "ConnectionTimeouts": {},
  "RateLimit": {},
  "Modules": {
    "Telemetry": {
      "Modules": {}
    }
  },
  "LogLevels": {},
  "Mods": {},
  "RequireJoinPermission": false,
  "DisplayTmpTagsInStrings": false,
  "PlayerStorage": {
    "Type": "Hytale"
  },
  "UniverseResourceStorage": {
    "Type": "Hytale"
  },
  "BanStorage": {
    "Type": "Disk",
    "Path": "bans.json"
  },
  "AuthCredentialStore": {
    "Type": "Encrypted",
    "Path": "auth.enc"
  },
  "Update": {},
  "Backup": {},
  "WorldMap": {}
}

Read from the Hytale 0.7.7 server: its config schemas, its --help and one offline boot.