如何向 MoFox 插件中心贡献插件

非常感谢您愿意为 MoFox 生态系统贡献您的时间和才华！本指南将引导您完成提交插件的全过程。

推荐流程：从模板创建你的插件 (推荐新手)

为了简化插件开发流程，并确保所有插件都拥有一致的基础结构，我们强烈建议您使用我们的官方插件模板来开始您的项目。这就像是填写一份已经设计好的表格，而不是从一张白纸开始。

➡️ 模板仓库地址: MoFox-Studio/MoFox-Plugin-Template-repo

步骤一：从模板创建仓库

1. 访问上方的模板仓库链接。
2. 点击页面右上角的绿色按钮 "Use this template" -> "Create a new repository"。
3. 为您的插件仓库起一个合适的名称（例如 my-awesome-plugin），并填写描述。
4. 保持仓库为 Public，然后点击 "Create repository"。

现在，您的 GitHub 账户下就有了一个和模板结构完全一样的新仓库了！

步骤二：克隆你的新仓库

将您刚刚创建的仓库克隆到您的电脑上：

git clone https://github.com/YOUR-USERNAME/YOUR-PLUGIN-REPO.git
cd YOUR-PLUGIN-REPO

(请将 YOUR-USERNAME 和 YOUR-PLUGIN-REPO 替换为您自己的信息)

步骤三：修改插件内容

模板仓库的结构如下：

.
├── __init__.py         # 插件元数据文件 (给 MoFox 核心读取)
├── bot_status/         # 你的插件核心代码文件夹
│   ├── __init__.py     # 插件元数据文件 (给插件系统读取)
│   └── plugin.py       # 插件的主要逻辑代码
└── README.md           # 插件的说明文档

您需要修改以下部分：

1. 修改文件夹名称：将 bot_status 文件夹重命名为您插件的名称（例如 my_awesome_plugin）。请使用蛇形命名法 (snake_case)。
2. 修改元数据 (__init__.py)：

   IMPORTANT

   模板中有两个 __init__.py 文件，一个在根目录，一个在插件代码文件夹内。您需要同时修改它们，并确保它们的内容完全一致！

   • 打开这两个 __init__.py 文件，将 name, description, author 等字段修改为您插件的实际信息。
3. 编写插件逻辑：在您重命名后的文件夹中，修改 plugin.py 文件，实现您插件的强大功能。
4. 更新说明文档：修改 README.md，详细介绍您插件的功能、用法和配置，最好能配上截图。

步骤四：创建 LICENSE 文件

一个开源项目需要明确的许可证。您可以通过 GitHub 轻松添加：

1. 在您的插件仓库主页，点击 "Add file" -> "Create new file"。
2. 在文件名的位置输入 LICENSE。
3. 输入文件名后，右侧会神奇地出现一个 "Choose a license template" 按钮，点击它。
4. 选择一个您希望使用的许可证（例如 MIT License），然后根据提示填写年份和姓名。
5. 点击 "Review and submit"，然后提交文件。

完成以上步骤后，您的插件仓库就已经准备就绪了！

提交前的检查清单

在您提交插件之前，请最后确认一遍，您的仓库是否满足以下所有要求：

1. 代码仓库公开：您的插件必须是一个公开的 Git 仓库。
2. __init__.py 元数据文件：
   • 仓库的根目录下必须包含 __init__.py。
   • 插件代码目录下也必须包含 __init__.py。
   • 这两个文件的内容应保持完全一致。
   • 必需字段：name, description, author, license, repository_url, keywords 都已正确填写。
   • 元数据文件详解：链接
3. LICENSE 文件：仓库根目录下必须包含一个 LICENSE 文件，其许可证类型应与 __init__.py 中 license 字段的值一致。
4. 优秀的 README.md：我们强烈建议您的 README.md 文件包含清晰的功能介绍、使用说明以及至少一张截图或 GIF 动图。

TIP

一个结构清晰、内容详尽的元数据文件，是用户发现和了解您插件的关键。我们强烈建议您也填写 usage, version, categories 等字段来提供更丰富的信息。

步骤五：提交你的插件

当您的插件仓库准备就绪后，就可以将其提交到我们的插件中心了！

我们提供两种方式来提交您的插件，请根据您的熟悉程度选择其一即可。

方式一：通过 GitHub 网站 (推荐新手)

这种方法无需在您的电脑上安装任何工具，全程在网页上操作即可，非常简单。

1. Fork 插件中心仓库

   • 首先，请通过浏览器访问 MoFox-Studio/MoFox-Plugin-Repo 仓库地址。
   • 进入仓库主页后，点击页面右上角的 "Fork" 按钮，将其复刻到您自己的 GitHub 账户下。

2. 在线编辑 plugins.json 文件

   • 在您 Fork 好的仓库页面中，找到并点击 plugins.json 这个文件。
   • 进入文件页面后，点击右上角的 铅笔图标 ✏️ 进入编辑模式。
   • 在文件的 JSON 数组的末尾，添加一个指向您插件的新对象。请注意，要先在上一行的 } 后面加上一个英文逗号 ,。

   // plugins.json
   [
     // ... 其他已有的插件
     {
       "id": "your-github-username.your-plugin-repo-name",
       "repositoryUrl": "https://github.com/YOUR-USERNAME/YOUR-PLUGIN-REPO"
     }
   ]

   (请将 your-github-username 和 your-plugin-repo-name 替换为您自己的信息)

   WARNING

   plugin_details.json 是程序自动生成的文件，请不要手动修改它。

TIP

嫌手动修改 JSON 容易出错？试试我们为您准备的插件贡献助手吧！只需填写您的用户名和仓库名，即可一键生成并复制完整的 plugins.json 内容。

插件贡献助手

您的 GitHub 用户名

您的插件仓库名

生成内容预览

正在加载...

正在从插件仓库拉取最新数据...

使用方法： 点击上方按钮复制全部内容，然后直接覆盖您 Fork 的仓库中的 `plugins.json` 文件即可。

3. 提交您的更改

   • 编辑完成后，滚动到页面下方。
   • 在标题框（Commit changes）中填写一个清晰的提交信息，例如 feat: Add [你的插件名] plugin。
   • 确保选中 "Create a new branch for this commit and start a pull request." 选项。
   • 最后，点击绿色的 "Propose changes" 按钮。

4. 创建 Pull Request (PR)

   • 点击 "Propose changes" 后，页面会自动跳转到创建 Pull Request 的界面。
   • 系统会自动使用模板填充 PR 描述，请仔细阅读并填写模板中的所有内容。
   • 确认无误后，点击 "Create pull request"。

方式二：通过 Git 命令行 (适合有经验的开发者)

1. Fork 并 Clone 仓库

   # 访问 https://github.com/MoFox-Studio/MoFox-Plugin-Repo 并 Fork
   git clone https://github.com/YOUR-USERNAME/mofox-plugin-repo.git
   cd mofox-plugin-repo

   (请将 YOUR-USERNAME 替换为您自己的 GitHub 用户名)

2. 创建新分支

   git checkout -b add/your-plugin-name

3. 添加插件信息

   • 打开 plugins.json 文件，在数组的末尾添加您的插件信息。

   // plugins.json
   [
     // ... 其他已有的插件
     {
       "id": "your-github-username.your-plugin-repo-name",
       "repositoryUrl": "https://github.com/YOUR-USERNAME/YOUR-PLUGIN-REPO"
     }
   ]

   (请将 your-github-username 和 your-plugin-repo-name 替换为您自己的信息)

TIP

嫌手动修改 JSON 容易出错？试试我们为您准备的插件贡献助手吧！只需填写您的用户名和仓库名，即可一键生成并复制完整的 plugins.json 内容。

插件贡献助手

您的 GitHub 用户名

您的插件仓库名

生成内容预览

正在加载...

正在从插件仓库拉取最新数据...

使用方法： 点击上方按钮复制全部内容，然后直接覆盖您 Fork 的仓库中的 `plugins.json` 文件即可。

4. 提交并推送更改

   git add plugins.json
   git commit -m "feat: Add [Your Plugin Name] plugin"
   git push origin add/your-plugin-name

5. 创建 Pull Request

   • 回到您在 GitHub 上的 Fork 仓库页面，点击 "Compare & pull request" 按钮。
   • 仔细阅读并填写 PR 模板中的所有内容后，提交即可。

提交之后

提交后，我们的自动化系统会立即对您的 PR 进行检查。如果检查失败，请根据错误提示修改后再次提交。维护者审核通过后，您的插件就会正式加入 MoFox 插件大家庭！

贡献者

minecraft1024a

页面历史

最后编辑于 大约 1 个月前

查看完整历史

aa099b0-docs(plugins): 重构插件贡献指南，增加模板创建流程

3e74ba5-docs: 移除文档中多余的水平分割线

9603646-feat(docs): 新增插件贡献助手组件

3e46dc3-docs(plugins): 优化和重构插件贡献指南

4d53883-docs(config): 在侧边栏中添加如何贡献插件的链接