El Bot Docs

配置讲解

el-bot 默认提供了几个最为常用的功能，并可以通过编写配置文件快速实现你的基础需求。

如果你想要更为复杂个性化的功能，那么你可能需要自行编写插件。参见插件系统。

默认的每个功能本质也是一个插件。

自定义配置路径

如果你觉得将配置文件全部写在一起很臃肿，那么你可以在主配置文件中，自定义其他配置文件的路径（请确保文件存在）。

默认将会把这些文件中的配置合并在一起。（后者覆盖前者）

譬如：

config_files:
  - "./config/custom/plugins.yml"

主人与管理员

终端命令只有主人或者管理员才可以调用。

在应答、转发等插件的 listen 配置中你也可以直接使用 master 或 admin 替代，代表只监听该数组列表中的 QQ。

master:
  - 123456

admin:
  - 666666
  - 114514

监听与目标

其中 listen 与 target 分别代表监听对象和目标对象，是很多插件的通用配置属性（前提是插件编写者这么做了）。你可以举一反三。

注意此处的 listen 和 target 都为在对应数组中对象的字段。此处省略了 - 等书写。

listen

  • listen: 监听的对象
    • friend: 监听的 QQ
    • group: 监听的群
  • target: 接收转发的目标
    • friend: 接收转发的 QQ
    • group: 接收转发的群
NameType可选字段Description
listenString“master”/“admin”/“friend”/“group”可以是字符串
listenObjectfriend/group可以下设 friend 和 group 字段，friend 和 group 下则为数组列表
unlistenString/Object同上unlisten 与 listen 相反，代表不监听的意思
targetString/Object同上同上

TIP

listen:
  friend:
    - 114514

这种形式并不代表只监听私聊情况下的 114514，而是会对该好友在私聊或者群里的发言进行监听。

看不懂？简而言之，以下几种形式都是可以的。

listen: master

listen: group

listen:
  - master
  - admin
  # 无论 QQ 号还是 QQ 群号
  - 123456789

listen:
  friend:
    - 123456
  group:
    - 555555

target

结构基本与 listen 相同。

匹配

match 是一个匹配数组（类似于 answer），下可设置多个匹配方式。

使用正则时，将会返回匹配的字符串数组。

TIP

match 通常为某一个插件的子属性。

譬如：

niubi:
  match:
    - re:
        pattern: 来点(\S*)笑话
    - includes: nb

match:
  - is: np
  - includes: 早上好
  - is: 酷
  - re:
      pattern: 来点(\S*)笑话

编写插件时，可以通过导入 mirai-ts 的方式快速使用。

import { check } from "mirai-ts";

const { is, includes, re, match } = check;
config.match.forEach((obj) => {
  if (match(str, obj)) {
    msg.reply("xxxxx");
  }
});

定时任务

拥有定时任务的插件，通常使用 cron 作为子选项，并使用 node-schedule 实现定时功能。

譬如定时发一句 一言 到群中。

hitokoto:
  cron: 0 0 * * *
  target:
    group:
      - 389401003