Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YunYouJun/el-bot
🤖 基于 mirai-ts，运行于 Node.js，可配置、可自定义插件的 QQ 机器人框架。
https://github.com/YunYouJun/el-bot
el-bot framework mirai nodejs qqbot rss
Last synced: about 1 month ago
JSON representation
🤖 基于 mirai-ts，运行于 Node.js，可配置、可自定义插件的 QQ 机器人框架。
- Host: GitHub
- URL: https://github.com/YunYouJun/el-bot
- Owner: YunYouJun
- License: agpl-3.0
- Created: 2020-06-08T17:03:56.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-20T17:45:31.000Z (about 1 year ago)
- Last Synced: 2024-05-19T11:32:09.759Z (4 months ago)
- Topics: el-bot, framework, mirai, nodejs, qqbot, rss
- Language: TypeScript
- Homepage: https://docs.bot.elpsy.cn
- Size: 1.3 MB
- Stars: 156
- Watchers: 6
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-mirai - YunYouJun/el-bot - ts](https://github.com/YunYouJun/mirai-ts)，使用 TS/JS 编写，可配置、可自定义插件的机器人框架 (基于其他语言sdk的应用)
README
# el-bot
[](https://www.yunyoujun.cn/el-bot/)
[](https://www.npmjs.com/package/el-bot)
[](https://github.com/YunYouJun/mirai-ts)
[](https://shang.qq.com/wpa/qunwpa?idkey=5b0eef3e3256ce23981f3b0aa2457175c66ca9194efd266fd0e9a7dbe43ed653)
[](https://t.me/elpsy_cn)
[](https://github.com/YunYouJun/el-bot/blob/master/LICENSE)
一个基于 [mirai-ts](https://github.com/YunYouJun/mirai-ts)，使用 TS/JS 编写，快速、可配置、可自定义插件的 QQ 机器人框架。
由于 mirai 频繁的内存泄漏，我决定将其迁移至 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)。
**正在重构开发中，因此它的很多代码可能已经失效，并将被移除。**
在此之后，它的目标更倾向于成为一个方便快捷启动与配置的工具/模版。
> el-bot 是一个非盈利的开源项目，仅供交流学习使用。请勿用于商业或非法用途，因使用而与腾讯公司产生的一切纠纷均与原作者无关。
- 使用文档：
- API 文档：
> El-Bot will be ESM only!
## 开始
mirai 1.0 版本以上推荐使用官方启动器 [mirai-console-loader](https://github.com/iTXTech/mirai-console-loader) 自行启动 [mirai](https://github.com/mamoe/mirai) 与 [mirai-api-http](https://github.com/mamoe/mirai-api-http) 插件。
（因为种种原因，本项目不接受任何关于如何使用 mirai 的问题，你应当具有自行启动 mirai 的能力，但欢迎 el-bot 项目本身的反馈。）
> 你也可以直接参考 [el-bot-template](https://github.com/ElpsyCN/el-bot-template)。
```sh
npm install el-bot
# pnpm i el-bot
```
```ts
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 文档](https://docs.bot.elpsy.cn/)。
## 升级
```sh
npm install el-bot@latest
```
相关变动请参见 [Releases](https://github.com/YunYouJun/el-bot/releases)。
## 反馈
有问题和建议欢迎提 Issue，谢谢！（在此之前，请确保您已仔细阅读文档。）
## 说明
请勿将其用于商业或非法用途。
### [与 koishi 的区别](https://docs.bot.elpsy.cn/about.html#与-koishi-的区别)
## 相关项目
- [el-bot](https://github.com/YunYouJun/el-bot)：机器人主体
- [el-bot-api](https://github.com/ElpsyCN/el-bot-api): 提供一些插件的默认 API
- [el-bot-plugins](https://github.com/ElpsyCN/el-bot-plugins): el-bot 的官方插件集中地（你也可以提交 PR 或一些自己的插件链接到 README 里打广告）
- [el-bot-docs](https://github.com/ElpsyCN/el-bot-docs): el-bot 使用文档
- [el-bot-template](https://github.com/ElpsyCN/el-bot-template)：机器人模版（你可以直接使用它来生成你的机器人）
- [el-bot-web](https://github.com/ElpsyCN/el-bot-web)：机器人前端（通过网页监控与控制你的机器人）（但是还在咕咕咕）
## Thanks
- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)
- [mirai](https://github.com/mamoe/mirai)
- [mirai-console](https://github.com/mamoe/mirai-console)
- [mirai-api-http](https://github.com/mamoe/mirai-api-http)
- [mirai-ts](https://github.com/YunYouJun/mirai-ts)
- [koishi](https://github.com/koishijs/koishi)
## 启动
```sh
git clone https://github.com/YunYouJun/el-bot
cd el-bot
pnpm i
```
配置测试机器人（看情况配置吧）
```sh
cp bot/.env.example .env
```
启动 cqhttp
```bash
pnpm cqhttp
```
### 运行 Demo
```bash
pnpm demo
```
## 开发
开发测试（运行起来吧）
```sh
npm run dev:bot
```
开发 el-bot 库
```sh
npm run dev:lib
```
### 构建
```sh
# 构建 el-bot
npm run build
```