Skip to main content

World Management

Manage your Hytale server worlds including configuration, file editing, and world settings.

Overview

The Worlds page provides:

  • World tree navigation - Browse all worlds and their files
  • Config editor - Visual form for world settings
  • File editor - Edit any world file as JSON
  • Danger zone - Destructive operations with confirmation

World Tree

The left sidebar displays:

  • List of all worlds
  • File count per world
  • Expandable file trees
  • First world auto-expands on load

File Categories

Each world contains:

  • Root files - config.json and other base files
  • Resources folder - Nested resource files
  • Player data - Per-player world data

World Configuration

Config Editor

Select a world's config.json to open the visual editor with grouped sections:

World Info (Read-only)

SettingDescription
SeedWorld generation seed
Game TimeCurrent in-game time

Gameplay Settings

SettingDescriptionDefault
PvP EnabledAllow player vs playertrue
Fall DamagePlayers take fall damagetrue
NPC SpawningNPCs can spawntrue
All NPCs FrozenFreeze all NPCsfalse
Compass UpdatingCompass points to objectivetrue
Spawn MarkersShow spawn markerstrue
Objective MarkersShow objective markerstrue

World Ticking

SettingDescriptionDefault
World TickingWorld updates (time, weather)true
Block TickingBlock updates (growth, decay)true
Game Time PausedPause day/night cyclefalse

Storage & Saving

SettingDescriptionDefault
Save PlayersSave player datatrue
Save ChunksSave chunk datatrue
Save New ChunksSave newly generated chunkstrue
Unload ChunksUnload unused chunkstrue

Danger Zone

danger

These operations can cause data loss!

SettingDescription
Delete on Universe StartDelete world when universe starts
Delete on RemoveDelete files when world removed

A confirmation dialog appears before enabling these options.

Text Mode

Toggle to Text Mode for raw JSON editing:

  • Direct JSON editing
  • Full file content access
  • Manual save required

File Editor

For non-config.json files:

  1. Click any file in the tree
  2. Editor opens on the right
  3. Edit JSON content
  4. Click Save

Supported File Types

All world files are JSON format:

  • config.json - World settings
  • resources/*.json - Resource definitions
  • Other configuration files

Form Editor Features

The intelligent form editor provides:

  • String fields - Text inputs
  • Number fields - Number inputs
  • Boolean fields - Toggle switches
  • Arrays - JSON textarea with validation
  • Nested objects - Indented sub-forms

Labels are auto-generated from property names (camelCase → Title Case).

API Reference

Endpoints

MethodEndpointDescription
GET/api/management/worldsList all worlds
GET/api/management/worlds/:name/configGet world config
PUT/api/management/worlds/:name/configUpdate world config
GET/api/management/worlds/:name/files/:pathGet any file
PUT/api/management/worlds/:name/files/:pathUpdate any file

World Info Response

{
"worlds": [
{
"name": "world",
"hasConfig": true,
"files": [
{
"name": "config.json",
"path": "config.json",
"size": 1024,
"lastModified": "2024-01-15T10:30:00Z"
}
]
}
]
}

World Config Response

{
"name": "world",
"seed": 12345,
"isTicking": true,
"isBlockTicking": true,
"isPvpEnabled": true,
"isFallDamageEnabled": true,
"isGameTimePaused": false,
"gameTime": "12:00",
"isSpawningNPC": true,
"isAllNPCFrozen": false,
"isSpawnMarkersEnabled": true,
"isObjectiveMarkersEnabled": true,
"isSavingPlayers": true,
"isSavingChunks": true,
"saveNewChunks": true,
"isUnloadingChunks": true,
"isCompassUpdating": true,
"deleteOnUniverseStart": false,
"deleteOnRemove": false
}

Permissions

PermissionDescription
worlds.viewBrowse worlds and files
worlds.manageEdit and save world files

Quick Settings

For common settings, use Quick Settings in the Configuration page:

SettingDescription
Server NameServer display name
MOTDMessage of the day
Max PlayersMaximum concurrent players
PasswordServer password
Max View RadiusRender distance (1-64 chunks)
Default Game ModeAdventure or Creative

Quick Settings changes require server restart.

Server Configuration

Config Files

View and edit server config files from Configuration page:

  • config.json - Main server config
  • panel-config.json - Panel settings
  • Other configuration files

Update Configuration

Configure automatic updates:

SettingOptions
EnabledOn/Off
Check Interval30min, 1h, 2h, 6h, 12h, 24h
PatchlineRelease or Pre-Release
Auto-Apply ModeDisabled, When Empty, Scheduled
Apply Delay1-60 minutes (scheduled only)
Player NotificationsOn/Off
Backup BeforeOn/Off
Backup ConfigOn/Off

Best Practices

  1. Backup before editing - Always backup worlds before major changes
  2. Use form mode - Reduces JSON syntax errors
  3. Test on copy - Test changes on a world copy first
  4. Don't disable saving - Only disable for testing
  5. Be careful with danger zone - These settings delete data

Troubleshooting

Changes Not Applying

  1. Server restart may be required
  2. Check file permissions
  3. Verify JSON syntax is valid

World Not Listed

  1. Check world folder exists
  2. Verify config.json is present
  3. Restart panel to refresh

File Save Fails

  1. Check disk space
  2. Verify container permissions
  3. Check for JSON syntax errors