Skip to content

Latest commit

 

History

History
74 lines (62 loc) · 3.32 KB

README.md

File metadata and controls

74 lines (62 loc) · 3.32 KB

BetterNCM - Plugin Library

本 Repo 是 BetterNCM 的插件库

插件提交及更新

  1. 确认你的插件符合上架准则
  2. Fork 本仓库
  3. plugins-list 目录下创建一个 JSON 文件,内容如下
{
    "name": "ExamplePlugin", // 插件名
    "repo": "BetterNCM/example-plugin", // 插件的 Repo
    "branch": "main", // 分支名
    "subpath": "/", // 插件在 repo 中的子目录 (可选)
    "author": "Author" // 作者
}
  1. 提交 PR
  2. 脚本会定时抓取插件 Manifest 中的版本号,并自动提交更新及审核。你还可以在 QQ 群中发送 update 以手动触发抓取脚本。

image

注意

  • 请确保要同步到此仓库的插件目录中,没有多余的文件(除了插件运行所必须的文件和插件预览图)。
  • 或者创建 .betterncm-ignore 文件来过滤不需要的文件(格式类似 .gitignore)。
  • 请压缩预览图,保证预览图不要过大
  • Native 插件必须使用 GitHub Action 编译。

Manifest.json 格式

{
    "manifest_version": 1, // manifest 版本,必为 1
    "name": "ExamplePlugin", // 插件名
    "slug": "example-plugin", // 插件唯一识别名(英文、数字、横杠与下划线) (留空则根据插件名自动生成)(如果插件名有中文请填写该字段)
    "version": "0.1.0", // 插件版本,推荐使用语义化版本(https://semver.org/)
    "betterncm_version": ">=1.0.0", // 依赖的 BetterNCM 版本
    "author": "Author", // 插件作者
    "author_link": "https://example.com", // 作者链接(可选)
    "description": "Description of the plugin", // 插件描述
    "preview": "preview.png", // 插件预览图
    "type": "extension", // 插件类型(可选):extension (默认) | theme | dependency"
    "requirements": ["example-dependency"], // 依赖的插件 Slug(可选)
    "force-install": false, // 强制安装(需要在审核中告知理由)
    "force-update": "< 0.1.0", // 强制更新(如此处强制更新版本号 < 0.1.0 的版本到最新)
    "force-uninstall": false, // 强制卸载(适用于插件崩了的情况)
    "ncm3-compatible": true, // 是否兼容网易云 3.0.0+ 版本

    "injects": { // 普通注入
        "Main": [  // 网易云主页面
            {
                "file": "main.js"  // 需注入的文件
            }
        ]
    },
    "hijacks": {  // 网易云请求修改(可选)
        "> 2.10.0 <= 2.10.6": {  // 版本,支持Range
            "orpheus://orpheus/pub/core.e5842f1.js": { // URL,开头部分匹配即可
            //(如 orpheus://orpheus/pub/core.e5842f1.js?abcdefg 将被匹配到)

                "type":"replace", // 类型,目前支持 replace 和 regex
                "from":"var o;if(((this.U()||C).from||C).id==t)", // 搜索项
                "to":";expose(a);var o;if(((this.U()||C).from||C).id==t)" // 替换为
            }
        }
    },
    "native_plugin": "native.dll", // 需要注入的 native dll (可选)(接口参考文档及已有 native 插件)
}