Hytale config.json Server Configuration

We continually strive to improve our knowledge base so that our customers have access to the most relevant and up-to-date information. We highly value your suggestions and feedback — if you feel something should be added or corrected, please let us know on our Discord server.

Open a support ticket on our Discord server to let us know how we can improve.

Warning

The server must be stopped while editing server files. Save your edits and restart the server for any changes to take effect.

Editing your configuration files through the official NexLink Core admin dashboard is quick and easy. Follow the steps below to edit your config.json efficiently.

Open the File Manager tab inside your admin dashboard.
Locate and open the config.json file at the root of your server files.
Make your edits and click Save Content, then safely restart your server to apply the changes.

Below you’ll find a reference for every value in config.json that is currently safe to modify, along with guidance on recommended values.

Default config.json

The default file looks like this. Use it as a reference for structure and formatting:

{
  "AuthCredentialStore": {
    "Path": "auth.enc",
    "Type": "Encrypted"
  },
  "Backup": {},
  "ConnectionTimeouts": {},
  "Defaults": {
    "GameMode": "Adventure",
    "World": "default"
  },
  "DisplayTmpTagsInStrings": false,
  "LocalCompressionEnabled": false,
  "LogLevels": {},
  "MOTD": "Welcome to our Hytale server! - NLC",
  "MaxPlayers": 21,
  "MaxViewRadius": 6,
  "Mods": {},
  "Modules": {
    "PathPlugin": {
      "Modules": {}
    }
  },
  "Password": "",
  "PlayerStorage": {
    "Type": "Hytale"
  },
  "RateLimit": {},
  "ServerName": "Hytale Server NLC",
  "Update": {},
  "Version": 4,
  "WorldMap": {}
}

Tip

Only the settings documented below are currently safe to change. Any keys not listed either have no effect on the server yet or should be left at their default values.

Defaults

Settings that live under the "Defaults" object.

Config Name:	Description
`GameMode`	The gamemode players join in when they first connect. Defaults to `Adventure`. Valid values are `Adventure` and `Creative`.
`World`	The world loaded by default when the server starts. Defaults to `default`. This value must match the folder name of a world located in `universe/worlds/[world name]`.

General Server Settings

Top-level settings inside config.json.

Config Name:	Description
`ServerName`	The name of the server as it appears to players. This is purely a descriptive field.
`MOTD`	Optional message-of-the-day shown to players when they log in. Leave this empty (`""`) to display no message.
`Password`	Optional server password. Leave empty (`""`) for an open server. If a password is set, players will be prompted for it when joining.
`MaxPlayers`	The maximum number of players that can be connected at one time. This value must be consistent with the CPU and RAM resources available on your server.
`MaxViewRadius`	The maximum server-side view distance players can see. Higher values increase server load and resource usage significantly.

Performance

Config Name:	Description
`LocalCompressionEnabled`	Enables local data compression. Defaults to `false`.

Modules & Mods

Config Name:	Description
`Modules`	Reserved for the activation of server modules. Leave at its default structure unless a module explicitly asks you to edit this section.
`Mods`	List of mods that are loaded by your server. Each entry in this object represents a mod to be loaded at startup.

config.json Example

Tip

JSON does not support comments, so every key you do not want applied must be removed from the file rather than commented out. Keep a backup before making large changes.

{
  "AuthCredentialStore": {
    "Path": "auth.enc",
    "Type": "Encrypted"
  },
  "Defaults": {
    "GameMode": "Adventure",
    "World": "default"
  },
  "LocalCompressionEnabled": false,
  "MOTD": "Welcome to our Hytale server! - NLC",
  "MaxPlayers": 21,
  "MaxViewRadius": 6,
  "Mods": {},
  "Modules": {
    "PathPlugin": {
      "Modules": {}
    }
  },
  "Password": "",
  "PlayerStorage": {
    "Type": "Hytale"
  },
  "ServerName": "Hytale Server NLC",
  "Version": 4
}

Warning

config.json must remain valid JSON at all times. A single missing comma, quote, or brace will prevent your server from starting. If your server fails to boot after an edit, validate the file with a JSON linter before contacting support.