me.virmesh.world.listWorlds

サーバーがホストする world の一覧を取得します。

WorldServer が現在ホストしている world の基本情報一覧を取得する public action です。 この action はサーバーによる任意サポートです。サポートしないサーバーは status+me.virmesh.action.not_supported (501) を返します。 単一の world のみをホストするサーバーも、その world を要素 1 の配列で返します。

draft

Endpoint

Method

GET

Path

/public/me.virmesh.world.listWorlds

Auth

none

Host

VirMesh.WorldServer

Request schema

No request fields are defined.

Request example

{
  "query": {}
}

Responses

200

status+me.virmesh.success.worldsListed

world 一覧が正常に取得されたことを示します。

Response body

payload.worldsobject[]Required

サーバーがホストする world 一覧です。各エントリは world の基本情報（worldId, endpoint, profile, instancePolicy）を含みます。

payload.worlds[].worldIdstringRequired

world identifier です。形式は medi:world:<scheme>:<publicKey> です。

payload.worlds[].endpointstringRequired

world の base URL です。

payload.worlds[].profileobjectRequired

world profile module の payload です。検索 UI は name, description, tags, addresses を検索対象にできます。

payload.worlds[].profile.namestringRequired

world 表示名です。

payload.worlds[].profile.descriptionstringOptional

world の説明です。

payload.worlds[].profile.tagsstring[]Optional

world に紐づくタグ一覧です。

payload.worlds[].profile.addressesstring[]Optional

world address 一覧です。例: example.com/world。配列の先頭を primary address として扱います。

payload.worlds[].instancePolicyobjectRequired

world instance policy module の payload です。

payload.worlds[].instancePolicy.createInstancebooleanRequired

プレイヤーによる instance 作成が許可されているかどうかです。

payload.worlds[].instancePolicy.defaultCapacityintegerRequired

instance の既定 capacity です。

payload.worlds[].instancePolicy.joinPoliciesstring[]Required

許可された join policy 一覧（public, invite, private のいずれか）です。

Response example

{
  "payload": {
    "worlds": [
      {
        "worldId": "medi:world:ed25519:base64url-world-public-key",
        "endpoint": "https://worlds.example.com/",
        "profile": {
          "name": "Example World",
          "description": "A small social world.",
          "tags": [
            "social",
            "music"
          ],
          "addresses": [
            "example.com/world"
          ]
        },
        "instancePolicy": {
          "createInstance": false,
          "defaultCapacity": 32,
          "joinPolicies": [
            "public"
          ]
        }
      }
    ]
  }
}

me.virmesh.world.listWorlds が正常終了し、WorldServer がホストする world 一覧を返したことを示します。

501

status+me.virmesh.action.not_supported

要求した action が現在の server では利用できないことを示します。

指定されたactionがサーバー上で無効化されており、使用できないことを示します。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

action is disabled

{
  "status": "status+me.virmesh.action.not_supported",
  "payload": {
    "message": "registerAccountKeyによる登録がサポートされていません。"
  }
}