Color theme

Player worlds

Base: /api/playerworlds

Worlds that players create in game with /myworld

Handler: PlayerWorldsHandler
GET /api/playerworlds

Player worlds overview

Returns the settings and every player world with display name, owner, members, guests, loaded and unlocked state.

Response Example

{
  "max_per_player": 1,
  "idle_park_minutes": 5,
  "creation_enabled": true,
  "worlds": [
    {
      "name": "pw-1234abcd-1",
      "display_name": "Steve's World",
      "owner": "Steve",
      "owner_uuid": "1234...",
      "members": [
        "Alex"
      ],
      "guests": [
        "Bob"
      ],
      "loaded": true,
      "unlocked": false,
      "created": 1737000000000
    }
  ]
}

cURL

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

Internal Behavior

Reads player-worlds.json and the live state (unlock is kept in memory until the next restart).
POST /api/playerworlds/config

Player world settings

Changes the global settings for player worlds.

Request Body

Field Type Required Description
creation_enabled boolean No Players may create worlds
max_per_player integer No Worlds per player, 0 to 50 (0 turns it off)
idle_park_minutes integer No Park empty worlds after 1 to 1440 minutes

Response Example

{
  "max_per_player": 2,
  "idle_park_minutes": 10,
  "creation_enabled": true,
  "success": true
}

cURL

curl -X POST 'http://localhost:5550/api/playerworlds/config' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"creation_enabled": true, "max_per_player": 2, "idle_park_minutes": 10}'

Internal Behavior

Writes player-worlds.json; values are clamped to the allowed range.