NOISE知识效率集
🤖 基于 mirai-ts,运行于 Node.js,可配置、可自定义插件的 QQ 机器人框架。

🤖 基于 mirai-ts,运行于 Node.js,可配置、可自定义插件的 QQ 机器人框架。

notion image

notion image

开始

mirai 1.0 版本以上推荐使用官方启动器 mirai-console-loader 自行启动 miraimirai-api-http 插件。
(因为种种原因,本项目不接受任何关于如何使用 mirai 的问题,你应当具有自行启动 mirai 的能力,但欢迎 el-bot 项目本身的反馈。)
npm install el-bot # pnpm i el-bot
import { Bot } = from "el-bot"; const bot = new Bot({ qq: 114514, setting: { host: "localhost", port: 4859, authKey: "el-psy-congroo", enableWebsocket: true } // bot: ... }); bot.start();
So easy! Right?
详细使用说明请参见 el-bot 文档

升级

npm install el-bot@latest
相关变动请参见 Releases

反馈

有问题和建议欢迎提 Issue,谢谢!(在此之前,请确保您已仔细阅读文档。)

说明

请勿将其用于商业或非法用途。

相关项目

  • el-bot-plugins: el-bot 的官方插件集中地(你也可以提交 PR 或一些自己的插件链接到 README 里打广告)
  • el-bot-template:机器人模版(你可以直接使用它来生成你的机器人)
  • el-bot-web:机器人前端(通过网页监控与控制你的机器人)(但是还在咕咕咕)

开发

git clone https://github.com/YunYouJun/el-bot cd el-bot pnpm i
配置测试机器人(看情况配置吧)
cp bot/.env.example .env
启动 mcl,须已配置 mirai-console-loader
npm run mcl
开发测试(运行起来吧)
npm run dev:bot
开发 el-bot 库
npm run dev:lib

构建

# 构建 el-bot npm run build
badge