Skip to content

README.md

Latest commit

 

History

History
146 lines (105 loc) · 7.41 KB

README.md

File metadata and controls

146 lines (105 loc) · 7.41 KB

napcat-plugin-index

NapCat 社区插件索引仓库

⚠️ 注意：社区插件索引库收录的所有插件均由第三方开发者提供，本仓库仅提供索引和基本的AI审核。我们无法确保插件的质量和安全，您在安装插件时建议自行对插件源码进行二次审核。

⚠️ 重要说明：本仓库已采用全自动审核机制。请使用 napcat-plugin-template 模板仓库开发插件，模板内置的 CI 会自动处理插件索引的提交与更新。手动提交的 PR 将不再被合入。

如果你不想使用模板仓库，请参考模板仓库中的 CI 工作流 自行实现自动提交 流程，确保 PR 由 CI 自动发起。

⚠️ 注意! PR时请不要修改 updateTime 字段, 会导致无法自动合并, 目前合并逻辑会自动拒绝修改 updateTime 字段的PR

🚀 插件提交方式

使用 napcat-plugin-template 模板开发插件，内置 CI 会在你发布 Release 时自动向本仓库提交 PR，经 CI 全自动审核通过后由维护者合并，无需手动操作。

流程：

插件仓库 push tag → CI 构建 + 发布 Release → 自动提交 PR 到本仓库 → CI 全自动审核 → 维护者合并

配置步骤：

  1. 使用模板创建插件仓库
  2. 编辑 package.json，填写插件信息和 napcat 字段： 
    {
  "name": "napcat-plugin-your-name",
  "plugin": "你的插件显示名",
  "version": "1.0.0",
  "description": "插件描述",
  "author": "你的名字",
  "napcat": {
    "tags": ["工具"],
    "minVersion": "4.14.0",
    "homepage": "https://github.com/username/napcat-plugin-your-name"
  }
}
  3. 在插件仓库 Settings > Secrets 中配置 INDEX_PAT（一个有 repo 权限的 Personal Access Token，用于向本仓库提交 PR）
  4. 正常开发，推送 v* tag 即可自动发布并更新索引

💡 详细的模板使用说明请参阅 napcat-plugin-template README

📋 插件信息字段说明

字段 类型 必填 说明
id string ✅ 插件唯一标识，格式：napcat-plugin-xxx（小写字母、数字、连字符）
name string ✅ 插件显示名称
version string ✅ 插件版本号（semver 格式）
description string ✅ 插件简短描述
author string ✅ 作者名称
homepage string ✅ 插件主页/仓库地址
downloadUrl string ✅ 插件下载地址（必须是可直接下载的 .zip 链接）
tags string[] 可选 插件标签
minVersion string ✅ 支持的最低 NapCat 版本

标签说明

标签不做限制，可自由填写，仅建议作为简单分类使用。

插件提交模板

{
  "id": "napcat-plugin-example",
  "name": "示例插件",
  "version": "1.0.0",
  "description": "这是一个示例插件的描述",
  "author": "YourName",
  "homepage": "https://github.com/username/napcat-plugin-example",
  "downloadUrl": "https://github.com/username/napcat-plugin-example/releases/download/v1.0.0/napcat-plugin-example.zip",
  "tags": ["工具"],
  "minVersion": "4.14.0"
}

🤖 CI 自动化

本仓库配置了以下自动化流程：

工作流 触发条件 功能
PR 自动审核 PR 修改 plugins.v4.json 校验 JSON 格式、字段完整性、ID 唯一性、版本号格式、包名一致性与规范、下载链接可达性，自动评论校验结果并打标签
AI 安全审计 PR 更新/新增插件 静态代码分析 + AI 深度审查，自动识别高危代码（混淆、恶意操作等），全自动合并低风险 PR，高危风险需人工审核
链接定时巡检 每天 UTC 04:00 检查所有插件的下载链接是否仍然有效，失效时自动创建 Issue 通知

⚠️ 注意事项

  1. 插件 id 必须全局唯一，且符合 napcat-plugin-xxx 命名规范
  2. 插件包内的 package.json 中的 name 必须与索引文件中的 id 完全一致
  3. 插件包内的 package.json 中的 name 必须符合命名规范（仅小写字母、数字、短横线，禁止中文/大写）
  4. downloadUrl 必须是可直接下载的 zip 文件链接，且在下载后可直接安装
  5. 提交流程推荐使用 napcat-plugin-template 模板开发，享受自动化测试和发布。
  6. 更新插件时必须提升 version，同版本重复提交会被拒绝。
  7. 本仓库启用 AI 技术对插件代码进行安全审查，请确保代码清晰，避免过度混淆。
  8. updateTime 由本仓库 CI 在合并后自动更新，PR 中不要修改该字段以避免冲突。

插件规范要求

  1. 插件 ID (包名) 必须以 napcat-plugin- 开头（如 napcat-plugin-music）
  2. 请确保 JSON 中的所有必填字段（ID、版本、描述、作者、下载链接等）完整且准确
  3. homepage 字段必须是有效的 GitHub 仓库链接或其他可访问的项目主页

📢 webui 跳转引导

为了提升体验，你可以在插件的 homepage 页面（通常是 GitHub 仓库主页）添加用于跳转到 NapCat webui 插件安装界面的引导信息，本仓库提供了一个按钮素材，你可以直接使用：

<a href="https://napneko.github.io/napcat-plugin-index?pluginId=<插件ID>" target="_blank">
  <img src="https://github.com/NapNeko/napcat-plugin-index/blob/pages/button.png?raw=true" alt="Logo" width="170">
</a>
Logo
将 `<插件ID>` 替换为你的插件 ID（如 `napcat-plugin-index`），点击后即可直接跳转到 NapCat webui 中该插件的安装界面。此功能在 NapCat 4.15.19 及以上版本中可用。

⚖️ 免责声明

本仓库收录的所有插件均由第三方开发者提供，仅作为索引和基本审核。

我们尽力确保插件的质量和安全，但不对因使用任何插件而导致的任何问题、损失或损害承担责任。用户在安装和使用插件时应自行承担风险。

📄 License

MIT License