接口

启动器接口

启动器从这里读取更新信息和公告。所有地址都失败时，更新检查退回到 GitHub API，公告不显示。

地址

按顺序尝试，前一个失败就用下一个：

https://pixelworld.zhuzhi.site/api/v1/
https://raw.githubusercontent.com/zhuzhi-09/PixelWorld/site/docs/api/v1/

路径里的 v1 是格式版本：以后格式不兼容时新建 v2，v1 继续保留给旧版启动器。响应必须是 JSON，且 format 为 1，否则整个文件会被忽略。

update.json

各更新通道的最新发布。由发布工作流（.github/workflows/release.yml 的 Update API 步骤，脚本 tool/update_api.py）在每次发布后自动生成，不要手动修改。

{
  "format": 1,
  "generatedAt": "2026-11-06T10:06:09Z",
  "channels": {
    "stable": {
      "tag": "v0.3.3",
      "name": "Pixel World v0.3.3",
      "body": "## 新增\n\n- ...",
      "prerelease": false,
      "commit": "main",
      "publishedAt": "2026-11-05T14:48:23Z",
      "page": "https://github.com/zhuzhi-09/PixelWorld/releases/tag/v0.3.3",
      "assets": [
        {
          "name": "Pixel World-0.3.3-windows-x64-setup.exe",
          "url": "https://github.com/.../Pixel World-0.3.3-windows-x64-setup.exe",
          "size": 15575552,
          "sha256": "06e49780..."
        }
      ]
    }
  }
}

顶层字段

字段	类型	说明
`format`	number	格式版本，目前固定为 `1`。
`generatedAt`	string	生成时间，ISO 8601。
`channels`	object	键为更新通道 `stable`、`preview`、`nightly`；没有发布的通道可以省略。

通道字段

字段	类型	说明
`tag`	string	发布标签，正式版形如 `v0.3.3`，Nightly 固定为 `nightly`。版本比较会去掉开头的 `v`。
`name`	string	显示名称。
`body`	string	更新说明，Markdown。
`prerelease`	boolean	是否为预发布。Nightly 为 `true`。
`commit`	string	Nightly 的提交号，用于判断是否需要更新；其他通道可能是 `main`。
`publishedAt`	string	发布时间，ISO 8601。
`page`	string	发布页面地址。
`assets`	array	发布文件，字段见下。

文件字段

字段	类型	说明
`name`	string	文件名，启动器按后缀选择当前平台的包。
`url`	string	下载地址。
`size`	number	字节数，下载后核对。
`sha256`	string	SHA-256；为 `null` 或格式不对时跳过校验。

启动器按平台选择文件：安卓 *-android-arm64.apk、macOS *-macos.dmg、Windows 安装版 *-windows-x64-setup.exe、Windows 便携版 *-windows-x64-portable.zip。

notices.json

首页公告，手动维护：编辑后提交到 site 分支即可。启动器每次打开时读取，显示在首页提示条与「Minecraft 版本动态」之间。

{
  "format": 1,
  "notices": [
    {
      "id": "2026-11-05-example",
      "level": "info",
      "title": "标题",
      "body": "正文，支持 Markdown",
      "url": "https://github.com/zhuzhi-09/PixelWorld/releases",
      "urlText": "查看详情",
      "platforms": ["windows", "android", "macos"],
      "channels": ["stable", "preview", "nightly"],
      "minVersion": "0.3.0",
      "maxVersion": "0.4.0",
      "start": "2026-11-05T00:00:00+08:00",
      "end": "2026-11-12T00:00:00+08:00",
      "dismissible": true
    }
  ]
}

字段	必填	说明
`id`	是	唯一标识。用户关闭后按 id 记住，不再显示；内容有重要修改时换一个 id。
`level`	否	`info`（默认）、`warning`、`error`，决定图标和颜色。
`title` / `body`	是	标题和正文，正文支持 Markdown。
`url` / `urlText`	否	操作按钮。只接受 `http` 与 `https`。
`platforms`	否	只在这些平台显示，省略为全部。取值为 `windows`、`android`、`macos`、`linux`。
`channels`	否	只在这些更新通道显示，省略为全部。
`minVersion` / `maxVersion`	否	只在这个版本范围内显示，包含两端。
`start` / `end`	否	显示的时间范围，ISO 8601。
`dismissible`	否	能否关闭，默认 `true`；设为 `false` 时用户无法关闭。

本地或镜像使用

接口只要求 HTTP(S) 能访问到 JSON，并且 format 为 1。如果想给启动器做镜像，保持同样的目录结构和字段即可；新增字段应保持旧版启动器可忽略，不兼容的改动请新建 v2。