Skip to content

ElpsyCN/el-bot-plugins

Repository files navigation

官方插件

el-bot-plugins lerna

此处提供一些 el-bot 可用的官方插件,以及社区插件的广告。

你可以直接为其提交 PR 或留下你的插件链接,提供给更多人使用。

部分插件逐步使用 ts 重写并移动到 el-bot/src/plugins。

此处的插件将由 el-bot 官方进行审核,并发布为 @el-bot 命名空间下的 npm 包。

如果 npm 包尚不存在,则该插件可能正在开发中。

  • [@el-bot/plugin-niubi] & [@el-bot/plugin-setu] had been moved to el-bot/plugins.

你也可以为 ./data/plugins.yml 提交 PR,留下你的仓库地址来给你的插件做广告。

请遵循 el-bot-plugin-xxx 的命名规范。

community:
  - name: el-bot-plugin-xxx # 插件名称
    author: 插件作者 # 你的 GitHub 用户名
    description: 插件描述

在 el-bot 中使用

npm install @el-bot/plugin-niubi
# yarn add @el-bot/plugin-niubi

# 按照社区插件
# npm install el-bot-plugin-xxx
# yarn add el-bot-plugin-xxx

修改你的配置文件:

module.exports = {
  // ...
  config: {
    plugin: {
      // 官方插件
      official: ["niubi"],
      // 使用社区插件 el-bot-plugin-xxx
      // community: ['xxx]
    },
  },
};

或 yml 插入对应想要加载的插件名(自行解析载入)

plugins:
  official:
    - niubi
    - setu

开发

欢迎提交更多有趣的插件。

插件可以默认使用 mirai-ts 中的 API 以提升开发效率。

同时也可以参考 配置讲解 中的一些配置设计,并可直接引入 el-bot 中已有的一些根据配置匹配、发送等函数。

更多插件开发内容见 插件系统。

命名规则

  • 纯小写字母
  • 多个单词时以 - 分割
  • 若插件含有自定义配置,请与插件名保持一致

如 niubi 插件对应的配置为:

niubi:
  url: https://el-bot-api.vercel.app/api/words/niubi
  match:
    - re:
        pattern: 来点(\S*)笑话
    - includes: nb

说明

  • 官方插件仓库中每个目录以插件名命名,不可重复。
  • 须附带 README.md 作为相关说明文档。
  • 并填写上名称、版本、描述、作者、协议等,这些将会在加载插件时,作为插件的信息记录。
  • 因为 mirai 属于 AGPL-3.0 协议,您提交在本仓库的插件将须默认使用 AGPL-3.0 协议。
  • dist 文件无须提交,将由仓库统一编译并发布于 @el-bot 命名空间下。

目录结构:

.
└── packages
    └── niubi
        ├── README.md
        ├── dist
        │   └── index.js
        ├── index.js
        └── package.json
    └── ...

packages/niubi/package.json :

{
  "name": "@el-bot/plugin-niubi",
  "version": "0.0.2",
  "description": "夸人牛逼",
  "main": "index.js",
  "author": "YunYouJun",
  "license": "AGPL-3.0",
  "publishConfig": {
    "access": "public"
  },
  "scripts": {
    "build": "echo index.js"
  }
}

JavaScript

原生 js 入口文件为 index.js,使用 nodejs 原生可运行的语法进行编写,发布时不会被编译。

TypeScript

入口文件为 dist/index.js,发布时将自动编译 src/index.ts 生成。