Skip to content

插件商店上架插件方式及准则

MicroBlock edited this page Feb 24, 2023 · 8 revisions

上架方式

为了能够让插件开发者制作的插件得以通过插件商店分享给大家使用,请按照以下步骤提交你的插件上传申请:

  1. 确认你的插件符合下文的上架准则
  2. 仿照 BetterNCM/BetterNCM-Plugins/plugins-list 中的插件元数据格式向 BetterNCM/BetterNCM-Plugins 仓库提交 Pull Request
  3. 脚本会定时抓取插件版本号更新,并自动提交审核

上架准则

为了保证插件质量和稳定,插件开发者及其插件上架插件前需要满足以下要求:

有一个独一无二的名称和 ID

考虑到冲突问题,插件商店内的 ID 不能有任何冲突,插件名称不做太多限制,但字数尽量不要过多,也尽量不要重名。

一个适用于插件商店显示的插件预览图

为了提高插件辨识度,内容随意。

必须开源插件源代码

由于 BetterNCM 使用了 GPL-v3 开源协议,所以任何形式引用了(其实都用了) BetterNCM 源代码的插件必须开放原始代码。

且必须保证开源代码可以编译,并且提交的插件内部的代码可以通过开源的原始代码编译/打包/构建得来。

对于native_plugin及任意其他原生应用,必须完全开源并由 Github Actions 编译

只保留需要的文件

请确保要同步到插件商店的目录/子目录中,除了插件运行所必须的文件和 manifest.json 中的预览图,没有多余的文件。

可以创建 .betterncm-ignore 文件来过滤不需要的文件及文件夹(格式类似 .gitignore)。

预览图文件大小不要过大

推荐使用 JPG 格式,动图使用 WEBP 格式,尺寸尽可能小

显著的源代码仓库渠道和问题反馈渠道

考虑到当前仓库的大部分提问都是有关插件而非 BetterNCM 自身问题,插件作者需要在设置页面提供你的源代码仓库链接和反馈渠道链接(例如 Github Issues)。

链接可以是图标形式或链接文本形式,且需要可以被点击跳转(以打开外部浏览器的方式),你可以通过调用 betterncm.ncm.openUrl(url: string) 函数来打开对应链接。

准确标注插件相关信息

标记好插件 Repo 链接,作者名称,支持的 betterncm 版本。

若为其他插件的变体/Fork,需在 manifest 的 fork_of 键中标记源插件 slug。

在用途不同的插件间尽可能保证插件兼容性

为了能够让你的插件可以搭配其它插件做出更出色的效果,除非功能完全一致无法兼容,请尽量做到不报错兼容。

具体方法可以是减少代码侵入性、使用 CSS 而非 JS、创建自己的元素而非删改网易云自带的元素等等。