Phira 查房接口接入说明

想让你的 Phira 多人游戏服务器出现在查房列表里，把下面这些信息发我即可。

需要提供的信息

字段	必填	说明
接口地址（API 端口）	是	形如 `https://example.com:8080/api/rooms`，请求后直接返回下面那份 JSON
接口密钥（如有）	否	需要鉴权就一并给出，并说明密钥放在 header 还是 query
服务器名称	是	列表里显示的名字
服务器图标 icon	否	一张方形图片的直链，建议不小于 128×128

建议的接口格式

一个 GET 接口，返回 JSON 即可，核心是 rooms 数组：

json

{
  "rooms": [
    {
      "roomid": "112233",
      "cycle": false,
      "lock": true,
      "host": {
        "name": "泪稚苒",
        "id": "3461054"
      },
      "state": "playing",
      "chart": {
        "name": "星降る夜と一輪の花",
        "id": "69901"
      },
      "players": [
        {
          "name": "泪稚苒",
          "id": 3461054
        },
        {
          "name": "聆碎a",
          "id": 3462386
        }
      ]
    }
  ]
}

各字段含义：

字段	类型	说明
roomid	string	房间号
cycle	boolean	是否循环
lock	boolean	是否上锁
host	object	房主，`{ id, name }`
state	string	房间状态，如 `playing`、`selecting`
chart	object	当前谱面，`{ id, name }`
players	array	房内玩家列表