Configuring your server: config.json files

The config.json file is a central element of your server configuration, allowing you to define crucial parameters for the gaming experience. Whether it concerns general rules, specifics for a world, or mod integration, these JSON files are your dashboard.

Global server settings

The main config.json file, located at the root of your server folder, contains settings that apply to your entire server, or “universe” as Hytale calls it. It is a true server configuration file that influences the experience of all players.

Location: [Your server folder]/config.json

Tip: Manual changes made while the server is running are likely to be overwritten. Always remember to stop your server, modify the file, and then restart it for changes to take effect.

World-specific settings

Each world in your Hytale universe has its own configuration file, allowing you to customize unique aspects for different game zones. This is ideal for creating creative worlds dedicated to building or exploration servers with distinct rules.

Location: [Your server folder]/universe/worlds/<world_name>/config.json

Here is an overview of the game rules and world behaviors you can adjust:

Tip: These settings are essential for defining the atmosphere and rules of a specific world, such as an exploration mode server or a combat arena.

Mod/plugin-specific settings

Mods and plugins bring incredible depth to Hytale, and each can have its own configuration file. Hytale uses a “Codec system” to serialize and deserialize JSON data, which allows developers to create robust custom configuration files.

Location: [Your server folder]/plugins/com.yourgroup_YourPluginName/YourPluginConfig.example.json

These files allow users to customize a plugin’s behavior without modifying its code. If a configuration file is missing, the system will automatically generate it with default values.

Structure of a plugin configuration file (example):

{
  "LuckIncreaseChance": 0.40,
  "MaxPlayers": 100,
  "ServerMessage": "Welcome to the custom server!",
  "EnableFeature": true,
  "BannedWords": ["swear", "inappropriate"],
  "DropRateMultiplier": 1.0,
  "DebugMode": false
}

Tip: To avoid conflicts and ensure compatibility, plugin developers use specific “Codecs” and ensure their JSON keys follow a convention (PascalCase, for example "ServerName" and not "serverName"). If you are an administrator, strictly respect the case of the keys.

Best practices and troubleshooting

• Mods/Plugins: Server plugin configuration files are stored in the mods/ folder (or earlyplugins/ for low-level plugins) of your server.
• Backups: Before any modification of config.json files, always perform a backup of your server and your worlds. This is the golden rule!
• JSON Syntax: config.json files must respect strict JSON structure. A misplaced comma or brace can prevent your server or plugins from starting. Use an online JSON validator if you have doubts.
• Restart: Most configuration changes require a full server restart to take effect. For some plugins, a reload may suffice, but this must be specifically implemented by the plugin developer.
• Documentation: Every quality mod or plugin should provide its own documentation for its configuration files. Refer to this documentation to understand specific options.
• Logs: In case of a problem, check your server’s log files (logs/) to identify errors. They can indicate which part of the config.json is causing issues.