简儿 - 插件主页

这里是简儿QQ机器人的插件市场，为市场中的插件提供下载与更新功能。

Main Repo

如何上传

Important

重要：请务必按照以下规范流程上传您的插件，不规范的上传可能会导致无法正常在设置向导中下载或更新你的插件，还有可能导致插件市场损坏。

对于造成插件市场损坏的账户，我们将联系其并在一段时间内撤销其推送权限。

1. Fork 本仓库

   • 访问 https://github.com/IntelliMarkets/Jianer_Plugins_Index。
   • 点击右上角的 "Fork" 按钮，将仓库复制到你的 GitHub 账号下。

2. 克隆 (Clone) 你 Fork 的仓库到本地

   • 在你的 GitHub 账号下找到你 Fork 的 Jianer_Plugins_Index 仓库。

   • 点击 "Code" 按钮，复制仓库的 URL (以 git@github.com 或 https://github.com 开头)。

   • 打开你的终端 (Terminal) 或 Git Bash，执行以下命令：

     git clone <你复制的仓库 URL>
     cd Jianer_Plugins_Index

3. 创建插件目录

   • 在本地仓库的根目录下，创建一个文件夹，文件夹名称必须与你的插件名称保持一致。 例如，如果你的插件名为 "YourIntelliPlugin"，则文件夹名称也必须是 "YourIntelliPlugin"。

     mkdir YourIntelliPlugin

4. 复制你的插件文件到插件目录

   • 将你的插件文件 (例如 YourIntelliPlugin.py，或者包含 setup.py 的插件文件夹) 复制到你创建的插件目录中。

5. 创建依赖和介绍信息

   • 在你的插件目录下，创建 requirements.txt ，记录你的插件所需要用到的第三方库。在从设置向导的插件中心安装插件时，设置向导会读取 requirements.txt 并进行依赖安装。

   • 在你的插件目录下，创建 README.md ，用于介绍你的插件（可选）。介绍内容会显示在设置向导的插件中心，插件详情页窗口中。

6. 提交 (Commit) 你的更改

   • 在终端中，使用以下 Git 命令来暂存、提交你的更改：

     git add . 
     git commit -m "添加插件：YourIntelliPlugin" 

7. 推送 (Push) 到你的 Fork 仓库

   • 使用以下 Git 命令将本地更改推送到你 Fork 的 GitHub 仓库：

     git push origin main  # 推送到 origin 仓库的 main 分支 (如果你的仓库使用其他分支，请替换 main)

8. 创建 Pull Request (PR)(拉取请求)（重要）

   • 访问你在 GitHub 账号下的 Fork 仓库。
   • GitHub 会提示你 "Compare & pull request"，点击该按钮。
   • 填写 PR 的标题和描述信息，描述你添加了什么插件，以及插件的功能和您的插件测试截图。
   • 点击 "Create pull request" 按钮，提交你的 PR。

Important

请注意，在进行拉取请求的创建时，请确保您已经完成了您的插件的测试，并且详细描述您的插件的功能,如果您在创建拉取请求时没有对于您的插件进行测试或者发生了任何因为没有仔细阅读Jianer_QQ_bot插件规范/Jianer_Plugin_Index插件上传教程导致的一切问题，均由插件开发者（您）来承担

9. 等待审核
   • 仓库维护者会审核你的 PR，如果一切符合规范，你的插件将被合并到主仓库中。

插件目录结构示例

Jianer_Plugins_Index/
├── Plugin_A/
│   ├── Plugin_A.py
│   ├── requirements.txt
│   └── README.md (可选)
└── Plugin_B/
    ├── Plugin_B/
    │   ├── setup.py
    │   └── ...
    ├── requirements.txt
    └── README.md (可选)

关于 Git 命令的补充说明：

• git clone: 将远程仓库复制到本地。
• git add: 将文件添加到暂存区，准备提交。
  • git add . 暂存所有更改。
  • git add <file_name> 暂存指定文件。
• git commit: 提交暂存区的更改，并添加描述信息。
• git push: 将本地更改推送到远程仓库。
• origin: 远程仓库的别名，通常指向你 Fork 的仓库。
• main (或 master): 分支名称，指定要推送到的分支。

至此，你已成功完成了插件上传。

Warning

作为一名合格的开发者，你不应该开发具有成人色情、暴力、血腥等违反 GitHub 社区规定 的插件上传至仓库，也不应改动别人的插件文件夹。一经审查发现有以上行为，将会被删除插件，并在一段时间内撤销其推送权限。

如何下载、更新和卸载

1. 在设置向导中打开插件中心
2. 点击想要下载或更新的插件
3. 在弹出的窗口中，点击下载、更新或卸载

关于

本文基于插件规范版本 NEXT 3 编写。插件可能基于 HypeR 框架和 OneBot 11 框架。