跳到正文

发布与维护插件 ​

当前工坊没有登录上传、支付、评分或自动审核服务。你可以分享安装文件,维护自己的静态目录,或向官方申请收录。源码仓库、安装包、工坊目录是三样不同的东西:源码用于维护,.sfplugin 用于安装,目录 JSON 用于发现与下载。

发布前准备 ​

请准备安装包及其 SHA-256、插件 ID 和版本、支持的 API/SDK 与实测宿主提交、作者和许可、准确依赖列表、使用说明及截图、源码位置、更新说明和问题反馈方式。说明是否需要模型、网络、密钥或本机程序,数据保存到哪里、卸载后留下什么。

验证独立安装、刷新、跨作品隔离、停用再启用、卸载重装、备份往返、升级与失败恢复;涉及依赖、替换、AI、外部服务时分别验证。发布材料不能包含手稿、API key、本机绝对路径或私人测试备份。

路径一 分享安装文件 ​

  1. 按开发教程生成 .sfplugin,保留 pack 输出的 digest。
  2. 把安装包放到自己的下载位置,或通过你选择的渠道发给使用者,并附说明与摘要。
  3. 使用者下载原始文件,在工坊 从文件安装,选择作品/世界并启用。有依赖时一并提供准确版本。

这一方式不依赖目录服务器。可以另附源码 ZIP,但必须标明“用于开发,不可直接安装”。SHA-256 用于核对文件一致性,不是作者身份签名或安全审查证明。

路径二 维护社区目录 ​

在你控制的静态 HTTPS 地址放置 catalog.json 和包文件,例如:

text
catalog.json
packages/yourname.chapter-checklist-0.1.0.sfplugin

下面是目录模板。把 ID、版本等替换成安装包清单的真实内容,digest 替换成打包输出的 64 位小写十六进制摘要;占位字符串不能用于安装。

json
{
  "format": 1,
  "name": "我的插件目录",
  "entries": [{
    "id": "yourname.chapter-checklist",
    "version": "0.1.0",
    "name": "章节检查便笺",
    "description": "为当前作品保存章节修改清单",
    "author": "你的署名",
    "kind": "feature",
    "owner": "work",
    "url": "packages/yourname.chapter-checklist-0.1.0.sfplugin",
    "digest": "替换为真实的64位SHA256",
    "dependencies": {}
  }]
}

所有准确版本的依赖都应在同一目录中出现。包 URL 可相对目录地址;必须直接返回文件字节,不能返回登录页或通过重定向跳转到下载。目录和安装包服务器都需要允许熔炉站点跨域读取(CORS);本机应用同源目录可使用当前 HTTP 地址,外部目录要求 HTTPS。

用浏览器从工坊“添加社区目录”填入完整目录 JSON 地址,点击 读取目录,完成下载、依赖安装和启用验证。网页能在新标签打开,不代表跨域读取已经正常。整个目录不能超过 1 MB/1,000 条;包大小限制见开发规范。

路径三 申请官方收录 ​

在 StoryForge 仓库 创建 PR,目标为 main。请先确认宿主包含 PR #113,并注明实际测试的宿主提交与 API/SDK 版本。

在 public/workshop/catalog.json 的 entries 中追加准确元数据,不改已有条目。建议指向你控制的不可变 HTTPS 文件,附源码、许可、截图、实测版本、依赖、网络能力、迁移与验收记录。PR 只是申请,维护者核对作者许可、功能、数据与分发条件后决定收录;没有自动发布承诺。

重建官方示例时会保留社区目录条目。维护者仍需检查目录差异、依赖可用性和不可变包地址;生成器不能替代信任或内容审核。

不会提 PR 时,可先通过功能建议说明插件用途、源码及下载地址,请维护者协助;请勿在公开反馈中提交密钥或私稿。

发布新版本 ​

保持 ID 稳定,递增 x.y.z 版本;已发布的相同版本文件字节必须保持不变。即使只改文案,也应发布新版本与新摘要,保留旧包供旧作品恢复。

数据结构变更需递增 schema 版本并实现纯数据迁移。提供旧数据到新数据的成功、失败和恢复记录;相同 schema 版本不能悄悄改变定义。更新依赖时锁定准确版本,验证组合包一起运行。工坊不会自动后台更新、运行迁移或启用新版本。

说明停用消费者、切换提供者版本、重新安装匹配消费者的顺序;不要让用户删除浏览器数据库来升级。发现有问题的发布时公告受影响版本与恢复办法,保留作者数据,避免用同版本替换文件掩盖问题。

StoryForge · 故事熔炉官方用户文档