一个基于 mirai-ts,使用 TS/JS 编写,快速、可配置、可自定义插件的 QQ 机器人框架。
由于 mirai 频繁的内存泄漏,我决定将其迁移至 go-cqhttp。 正在重构开发中,因此它的很多代码可能已经失效,并将被移除。
在此之后,它的目标更倾向于成为一个方便快捷启动与配置的工具/模版。
el-bot 是一个非盈利的开源项目,仅供交流学习使用。请勿用于商业或非法用途,因使用而与腾讯公司产生的一切纠纷均与原作者无关。
El-Bot will be ESM only!
mirai 1.0 版本以上推荐使用官方启动器 mirai-console-loader 自行启动 mirai 与 mirai-api-http 插件。
(因为种种原因,本项目不接受任何关于如何使用 mirai 的问题,你应当具有自行启动 mirai 的能力,但欢迎 el-bot 项目本身的反馈。)
你也可以直接参考 el-bot-template。
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:机器人主体
- el-bot-api: 提供一些插件的默认 API
- el-bot-plugins: el-bot 的官方插件集中地(你也可以提交 PR 或一些自己的插件链接到 README 里打广告)
- el-bot-docs: el-bot 使用文档
- el-bot-template:机器人模版(你可以直接使用它来生成你的机器人)
- el-bot-web:机器人前端(通过网页监控与控制你的机器人)(但是还在咕咕咕)
git clone https://github.com/YunYouJun/el-bot
cd el-bot
pnpm i
配置测试机器人(看情况配置吧)
cp bot/.env.example .env
启动 cqhttp
pnpm cqhttp
pnpm demo
开发测试(运行起来吧)
npm run dev:bot
开发 el-bot 库
npm run dev:lib
# 构建 el-bot
npm run build