Skip to content

🤖 基于 Node.js,可配置、可自定义插件的 QQ 机器人框架。(Refactoring...)

License

Notifications You must be signed in to change notification settings

YunYouJun/el-bot

Repository files navigation

el-bot

api npm GitHub package.json dependency version (subfolder of monorepo) QQ Group Telegram GitHub node-current

一个基于 Bun,使用 TS 编写,快速、可配置、可自定义插件的 QQ 机器人框架。

el-bot 是一个非盈利的开源项目,仅供交流学习使用。请勿用于商业或非法用途。 本项目为个人学习项目,与腾讯公司并无关联。

⚠️ BREAKING CHANGES (REFACTORING)

正在重构开发中,因此它的很多代码可能已经失效,并将被移除。

  • QQ
  • 使用 TypeScript 作为一等公民,使用 Bun 作为默认运行时,不再支持 JS(如需要,可自行编译)
  • 使用 bun 替代 pnpm

开始

参考以下文档,启动 QQ 协议端。

安装 Bun

# Windows
powershell -c "irm bun.sh/install.ps1 | iex"
# Linux/macOS
curl -fsSL https://bun.sh/install | bash
npm install el-bot
# pnpm i el-bot

初始化文件

你也可以直接参考 el-bot-template

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 文档

编写插件

启动

npx 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:机器人前端(通过网页监控与控制你的机器人)(但是还在咕咕咕)

Thanks

启动

配置测试机器人(看情况配置吧)

cp bot/.env.example .env

参与开发

开发测试(运行起来吧)

git clone https://github.com/YunYouJun/el-bot
cd el-bot
pnpm i
# 启动 demo
pnpm demo

npm run dev:bot

开发 el-bot 库

npm run dev:lib

CHANGELOG

See CHANGELOG.md.