仓库名以 Breeze-plugin 开头
索引脚本每小时扫描一次 GitHub,按 Breeze-plugin 前缀识别插件仓库,读取根目录的 manifest.json 与最新 Release。
- manifest.json 要能被公开读取
- updateUrl 指向自己的 Release
- 按检查清单过一遍再提交
插件跑在 QuickJS-NG 里,用 TypeScript 写,构建成单文件 bundle。
export default 出去的每个函数,就是客户端能调用的一个能力。
不要从空目录开始。示例仓库已经配好 rspack 构建、类型检查与 manifest 生成。
git clone https://github.com/deretame/Breeze-plugin-example.git my-plugin
cd my-plugin && pnpm install
先跑通 searchComic → getComicDetail → getReadSnapshot → fetchImageBytes,一条阅读主链路就通了。
// src/common.ts
export const PLUGIN_ID = "你的插件UUID";
// src/get-info.ts
buildPluginInfo({
name: "我的漫画源",
describe: "一句话说明这个源能做什么",
iconUrl: "https://raw.githubusercontent.com/you/my-plugin/main/icon.png",
home: "https://github.com/you/my-plugin",
updateUrl: "https://api.github.com/repos/you/my-plugin/releases/latest",
});
pnpm run dev 会输出 bundle 地址与远程日志地址,在 App 的「插件商店 → 浏览安装 → 网络安装」填进去即可热更新。
pnpm run dev # 启动开发服务器 + 远程日志
pnpm run build # typecheck → manifest → rspack → brotli
搜索拿到列表 → 详情拿到章节 → 阅读页拿到图片清单 → 逐张取图片字节。客户端负责剩下的排版、缓存与翻页。
searchComic
按关键词或页码返回作品列表:标题、封面、作者、详情页标识。发现页、搜索页、排行榜都走这一条。
getComicDetail
给一个作品标识,返回简介、标签与完整章节目录,客户端据此渲染详情页与章节列表。
getReadSnapshot
给一个章节标识,返回这一话的图片地址清单与页数,构成阅读器的一次「快照」。
fetchImageBytes
真正把图片字节取回来。需要自定义请求头、Cookie 或解密时,逻辑都写在这里。
buildPluginInfo
生成插件元信息:name、describe、iconUrl、home、updateUrl。商店列表里显示的图标就是这里的 iconUrl。
索引仓库按仓库名前缀找插件,所以命名和 manifest 都有约定。
索引脚本每小时扫描一次 GitHub,按 Breeze-plugin 前缀识别插件仓库,读取根目录的 manifest.json 与最新 Release。
想在云收藏里跨设备漫游,需要按「云端收藏工作流」的约定实现对应能力,并在元信息里声明。列表里带蓝点的 13 个插件都做了这件事。