Welten

Base: /api/worlds

Dauerhafte Welten anlegen, laden, auslagern, zurücksetzen und löschen

Verarbeitung: WorldsHandler

Endpunkte

GET /api/worlds Welten-Übersicht POST /api/worlds/create Welt anlegen POST /api/worlds/load Welt laden POST /api/worlds/unload Welt entladen POST /api/worlds/delete Welt in den Papierkorb POST /api/worlds/restore Welt zurückholen POST /api/worlds/purge Welt endgültig löschen POST /api/worlds/park Welt auslagern POST /api/worlds/unpark Welt zurücklegen POST /api/worlds/mark Weltart setzen POST /api/worlds/default Standardwelt setzen POST /api/worlds/settings Welt-Einstellungen POST /api/worlds/reset Welt zurücksetzen POST /api/worlds/send Spieler in Welt schicken

GET /api/worlds

Welten-Übersicht

Liefert geladene Welten (Standardwelt zuerst) mit Art, Besitzer, Einstellungen und Größe sowie entladene, ausgelagerte und gelöschte Welten und die verfügbaren Generatoren.

Antwort-Beispiel

{
  "default": "default",
  "worlds": [
    {
      "name": "default",
      "kind": "server",
      "owner": null,
      "display_name": null,
      "default": true,
      "players": 1,
      "player_names": [
        "Steve"
      ],
      "generator": "Hytale",
      "seed": "12345",
      "pvp": true,
      "fall_damage": true,
      "npc_spawning": true,
      "npc_frozen": false,
      "time_paused": false,
      "game_mode": "Adventure",
      "size_mb": 128.4
    }
  ],
  "unloaded": [
    {
      "name": "arena",
      "kind": "server",
      "owner": null,
      "size_mb": 10.2
    }
  ],
  "parked": [
    {
      "name": "pw-1234abcd-1",
      "kind": "player",
      "owner": "Steve",
      "size_mb": 5.1
    }
  ],
  "trash": [
    {
      "folder": "oldworld_20260101_010000",
      "size_mb": 2.0
    }
  ],
  "generators": [
    "Hytale",
    "Flat",
    "Void"
  ]
}

cURL

curl -X GET 'http://localhost:5550/api/worlds' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internes Verhalten

Kombiniert das Universe, die Ordner universe/worlds, worlds-parked und worlds-trash und worlds-meta.json. Instanzen fehlen absichtlich.

POST /api/worlds/create

Welt anlegen

Legt eine dauerhafte Welt an. Hytale lädt sie bei jedem Start.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	a-z, 0-9, _ und -, 2 bis 32 Zeichen
`generator`	string	Nein	Hytale (Standard), Flat oder Void
`kind`	string	Nein	server (Standard) oder player
`owner`	string	Nein	Besitzer für das Panel
`display_name`	string	Nein	Anzeigename
`game_mode`	string	Nein	Adventure oder Creative
`pvp`	boolean	Nein	PvP
`fall_damage`	boolean	Nein	Fallschaden
`npc_spawning`	boolean	Nein	Kreaturen spawnen
`npc_frozen`	boolean	Nein	Kreaturen einfrieren
`time_paused`	boolean	Nein	Zeit anhalten

Antwort-Beispiel

{
  "success": true,
  "world": "arena",
  "generator": "Hytale"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/create' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt", "generator": "Hytale", "display_name": "Farmwelt", "pvp": false}'

Internes Verhalten

Ruft Universe.addWorld auf (bis 60 Sekunden), übernimmt die Einstellungen und speichert Art und Besitzer.

POST /api/worlds/load

Welt laden

Lädt eine entladene Welt.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Weltordner in universe/worlds

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/load' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt"}'

Internes Verhalten

Ruft Universe.loadWorld auf.

POST /api/worlds/unload

Welt entladen

Speichert und entlädt eine Welt; der Ordner bleibt.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Geladene Welt (nicht die Standardwelt, keine Spieler drin)

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/unload' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt"}'

Internes Verhalten

Schaltet deleteOnRemove aus und ruft Universe.removeWorld auf.

POST /api/worlds/delete

Welt in den Papierkorb

Verschiebt eine Welt in den Papierkorb; gelöscht wird noch nichts.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Welt (geladen, entladen oder ausgelagert)

Antwort-Beispiel

{
  "success": true,
  "world": "arena",
  "folder": "arena_20260101_010000"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/delete' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt"}'

Internes Verhalten

Entlädt bei Bedarf und verschiebt den Ordner nach universe/worlds-trash/<Name>_<Datum>.

POST /api/worlds/restore

Welt zurückholen

Holt eine Welt aus dem Papierkorb zurück und lädt sie.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`folder`	string	Ja	Ordnername im Papierkorb

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/restore' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"folder": "farmwelt_20261013_101500"}'

Internes Verhalten

Entfernt den Datumszusatz und ruft Universe.loadWorld auf.

POST /api/worlds/purge

Welt endgültig löschen

Löscht einen Papierkorb-Eintrag von der Platte.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`folder`	string	Ja	Ordnername im Papierkorb

Antwort-Beispiel

{
  "success": true,
  "folder": "arena_20260101_010000"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/purge' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"folder": "farmwelt_20261013_101500"}'

Internes Verhalten

Löscht den Ordner vollständig und entfernt den Art-Eintrag, wenn keine andere Kopie existiert.

POST /api/worlds/park

Welt auslagern

Entlädt eine Welt und verschiebt sie nach universe/worlds-parked, damit Hytale sie beim Start nicht lädt.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Welt (geladen oder entladen)

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/park' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "lasttest-001"}'

Internes Verhalten

Entlädt bei Bedarf und verschiebt den Ordner.

POST /api/worlds/unpark

Welt zurücklegen

Legt eine ausgelagerte Welt zurück und lädt sie.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Ausgelagerte Welt
`load`	boolean	Nein	Sofort laden, Standard true

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/unpark' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "lasttest-001"}'

Internes Verhalten

Verschiebt den Ordner nach universe/worlds und ruft Universe.loadWorld auf.

POST /api/worlds/mark

Weltart setzen

Markiert eine Welt als Server- oder Spielerwelt mit Besitzer (für das Panel).

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Welt
`kind`	string	Nein	server (Standard) oder player
`owner`	string	Nein	Besitzer

Antwort-Beispiel

{
  "success": true,
  "world": "arena",
  "kind": "server"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/mark' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "lasttest-001", "kind": "player", "owner": "Eranio"}'

Internes Verhalten

Schreibt worlds-meta.json.

POST /api/worlds/default

Standardwelt setzen

Macht eine Welt zur Standardwelt des Servers.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Geladene Welt

Antwort-Beispiel

{
  "success": true,
  "world": "default"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/default' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "default"}'

Internes Verhalten

Ändert die Standardwelt in der Serverkonfiguration.

POST /api/worlds/settings

Welt-Einstellungen

Ändert Einstellungen einer geladenen Welt; nur die übergebenen Felder ändern sich.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Geladene Welt
`display_name`	string	Nein	Anzeigename, leer entfernt ihn
`game_mode`	string	Nein	Adventure oder Creative
`pvp`	boolean	Nein	PvP
`fall_damage`	boolean	Nein	Fallschaden
`npc_spawning`	boolean	Nein	Kreaturen spawnen
`npc_frozen`	boolean	Nein	Kreaturen einfrieren
`time_paused`	boolean	Nein	Zeit anhalten

Antwort-Beispiel

{
  "success": true,
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/settings' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt", "pvp": true, "time_paused": false}'

Internes Verhalten

Übernimmt die Felder auf dem Welt-Thread in WorldConfig.

POST /api/worlds/reset

Welt zurücksetzen

Löscht eine Welt und erzeugt sie mit neuem Seed neu (Farmwelt). Generator, Einstellungen und Anzeigename bleiben.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`name`	string	Ja	Geladene Welt, nicht die Standardwelt, keine Spieler drin
`move_warps`	boolean	Nein	Warps dieser Welt auf den neuen Spawn verlegen, Standard true

Antwort-Beispiel

{
  "success": true,
  "world": "arena",
  "seed": "67890",
  "warps_moved": 2,
  "spawn": "0, 64, 0"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/reset' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "farmwelt", "move_warps": true}'

Internes Verhalten

Entfernt die Welt mit deleteOnRemove, legt sie neu an und verlegt die Warps auf den neuen Spawn.

POST /api/worlds/send

Spieler in Welt schicken

Teleportiert einen Spieler zum Spawn einer anderen Welt.

Anfragekörper

Feld	Typ	Pflicht	Beschreibung
`player`	string	Ja	Online-Spieler
`world`	string	Ja	Geladene Zielwelt

Antwort-Beispiel

{
  "success": true,
  "player": "Steve",
  "world": "arena"
}

cURL

curl -X POST 'http://localhost:5550/api/worlds/send' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"player": "Eranio", "world": "farmwelt"}'

Internes Verhalten

Schreibt einen Eintrag in den Teleport-Verlauf und setzt eine Teleport-Komponente.