Server Configuration

Server Configuration

Edit server configuration, manage the whitelist, and view installed mods — all from the browser.


Server Config Editor

Detail Value
Permission (read) hytale-admin.serverconfig-read
Permission (edit) hytale-admin.serverconfig-manage
API (read) GET /config
API (save) Part of server config update flow
Success "Server config updated"
Failure "Server config update failed"
Logged as server:hytale-admin.update-server-config

The config editor reads serverconfig.json on the server and presents it as editable fields. Changes are saved directly back to the file.

Important: Most config changes require a server restart to take effect.


Whitelist Management

View Whitelist

Detail Value
Permission hytale-admin.serverconfig-read
API GET /whitelist

Add to Whitelist

Detail Value
Permission hytale-admin.serverconfig-manage
Success "Player added to whitelist: {player}"
Failure "Failed to add to whitelist"
Logged as server:hytale-admin.whitelist-add

Remove from Whitelist

Detail Value
Permission hytale-admin.serverconfig-manage
Success "Player removed from whitelist: {player}"
Failure "Failed to remove from whitelist"
Logged as server:hytale-admin.whitelist-remove

Whitelist Data Source

The whitelist is stored in whitelist.json on the server. The plugin reads and modifies this file via the Daemon file API.


Installed Mods List

View all installed Java mods on the Hytale server via GET /mods:

Column Description
Name Mod display name
Version Mod version
Status Loaded / Error

This is a read-only view — mod installation/removal is handled via the Setup page.


Mod Validation Toggle

The SkipModValidationForVersion toggle is available on the Setup/Config page:

State Value Purpose
Enabled Empty string "" Normal mode — mod validation active
Disabled Current server revision string Skips mod validation for this revision — useful during development or testing

Logged as: server:hytale-admin.toggle-mod-validation


Troubleshooting

"Server config update failed"

  • Config file may be locked by the server process
  • Invalid JSON in the config
  • Daemon file API unable to write

Whitelist changes don't take effect

  • Some changes require a server restart
  • whitelist.json must be readable and writable by the Daemon

Config editor shows empty/wrong fields

  • config.json missing or malformed
  • Java mod API not responding — check API connection
  • Restart the server to regenerate default config