{"id":17967751,"url":"https://github.com/yunyoujun/el-bot","last_synced_at":"2025-10-24T05:48:36.071Z","repository":{"id":54853656,"uuid":"270753014","full_name":"YunYouJun/el-bot","owner":"YunYouJun","description":"🤖 基于 Node.js，可配置、可自定义插件的 QQ 机器人框架。（Refactoring...）","archived":false,"fork":false,"pushed_at":"2024-09-29T22:16:18.000Z","size":2712,"stargazers_count":160,"open_issues_count":4,"forks_count":16,"subscribers_count":6,"default_branch":"dev","last_synced_at":"2024-10-29T15:49:13.072Z","etag":null,"topics":["el-bot","framework","mirai","nodejs","qqbot","rss"],"latest_commit_sha":null,"homepage":"https://docs.bot.elpsy.cn","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YunYouJun.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["YunYouJun"]}},"created_at":"2020-06-08T17:03:56.000Z","updated_at":"2024-10-24T08:49:48.000Z","dependencies_parsed_at":"2025-01-07T18:46:04.608Z","dependency_job_id":null,"html_url":"https://github.com/YunYouJun/el-bot","commit_stats":{"total_commits":292,"total_committers":2,"mean_commits":146.0,"dds":0.003424657534246589,"last_synced_commit":"4a0ab18b1cfee90a4365b82700246046fedc057d"},"previous_names":["elpsycn/el-bot"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fel-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fel-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fel-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fel-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YunYouJun","download_url":"https://codeload.github.com/YunYouJun/el-bot/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247112739,"owners_count":20885606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["el-bot","framework","mirai","nodejs","qqbot","rss"],"created_at":"2024-10-29T14:09:23.582Z","updated_at":"2025-10-24T05:48:36.003Z","avatar_url":"https://github.com/YunYouJun.png","language":"TypeScript","funding_links":["https://github.com/sponsors/YunYouJun"],"categories":[],"sub_categories":[],"readme":"# el-bot\n\n[![api](https://github.com/YunYouJun/el-bot/workflows/api/badge.svg)](https://www.yunyoujun.cn/el-bot/)\n[![npm](https://img.shields.io/npm/v/el-bot?logo=npm)](https://www.npmjs.com/package/el-bot)\n[![GitHub package.json dependency version (subfolder of monorepo)](https://img.shields.io/github/package-json/dependency-version/YunYouJun/el-bot/mirai-ts?filename=packages%2Fel-bot%2Fpackage.json\u0026logo=typescript)](https://github.com/YunYouJun/mirai-ts)\n[![QQ Group](https://img.shields.io/badge/QQ%20Group-707408530-12B7F5?logo=tencent-qq)](https://shang.qq.com/wpa/qunwpa?idkey=5b0eef3e3256ce23981f3b0aa2457175c66ca9194efd266fd0e9a7dbe43ed653)\n[![Telegram](https://img.shields.io/badge/Telegram-elpsy__cn-blue?logo=telegram)](https://t.me/elpsy_cn)\n[![GitHub](https://img.shields.io/github/license/YunYouJun/el-bot)](https://github.com/YunYouJun/el-bot/blob/master/LICENSE)\n![node-current](https://img.shields.io/node/v/el-bot)\n\n一个基于 Bun，使用 TS 编写，快速、可配置、可自定义插件的 QQ 机器人框架。\n\n\u003e el-bot 是一个非盈利的开源项目，仅供交流学习使用。请勿用于商业或非法用途。\n\u003e 本项目为个人学习项目，与腾讯公司并无关联。\n\n- 使用文档：\u003chttps://docs.bot.elpsy.cn\u003e\n- API 文档：\u003chttps://www.yunyoujun.cn/el-bot/\u003e\n\n## ⚠️ BREAKING CHANGES (REFACTORING)\n\n**正在重构开发中，因此它的很多代码可能已经失效，并将被移除。**\n\n- QQ\n  - 迁移 [mirai](https://github.com/mamoe/mirai) 至 [NapCatQQ](https://github.com/NapNeko/NapCatQQ)\n  - 迁移 [mirai-ts](https://github.com/YunYouJun/mirai-ts) 至 [node-napcat-ts](https://github.com/huankong-team/node-napcat-ts)\n- 使用 TypeScript 作为一等公民，使用 Bun 作为默认运行时，不再支持 JS（如需要，可自行编译）\n- 使用 [bun](https://bun.sh/) 替代 pnpm\n\n## 开始\n\n参考以下文档，启动 QQ 协议端。\n\n- [NapCatQQ](https://github.com/NapNeko/NapCatQQ)\n\n### 安装 Bun\n\n```bash\n# Windows\npowershell -c \"irm bun.sh/install.ps1 | iex\"\n# Linux/macOS\ncurl -fsSL https://bun.sh/install | bash\n```\n\n```sh\nnpm install el-bot\n# pnpm i el-bot\n```\n\n### 初始化文件\n\n\u003e 你也可以直接参考 [el-bot-template](https://github.com/ElpsyCN/el-bot-template)。\n\n```ts\nimport { Bot } from 'el-bot'\n\nconst bot = new Bot({\n  qq: 114514,\n  setting: {\n    host: 'localhost',\n    port: 4859,\n    authKey: 'el-psy-congroo',\n    enableWebsocket: true,\n  },\n  // bot: ...\n})\nbot.start()\n```\n\nSo easy! Right?\n\n详细使用说明请参见 [el-bot 文档](https://docs.bot.elpsy.cn/)。\n\n### 编写插件\n\n- [node-napcat-ts](https://github.com/huankong-team/node-napcat-ts)\n\n### 启动\n\n```bash\nnpx el-bot\n```\n\n### 升级\n\n```sh\nnpm install el-bot@latest\n```\n\n相关变动请参见 [Releases](https://github.com/YunYouJun/el-bot/releases)。\n\n## 反馈\n\n有问题和建议欢迎提 Issue，谢谢！（在此之前，请确保您已仔细阅读文档。）\n\n## 说明\n\n### [与 koishi 的区别](https://docs.bot.elpsy.cn/about.html#与-koishi-的区别)\n\n## 相关项目\n\n- [el-bot](https://github.com/YunYouJun/el-bot)：机器人主体\n- [el-bot-api](https://github.com/ElpsyCN/el-bot-api): 提供一些插件的默认 API\n- [el-bot-plugins](https://github.com/ElpsyCN/el-bot-plugins): el-bot 的官方插件集中地（你也可以提交 PR 或一些自己的插件链接到 README 里打广告）\n- [el-bot-docs](https://github.com/ElpsyCN/el-bot-docs): el-bot 使用文档\n- [el-bot-template](https://github.com/ElpsyCN/el-bot-template)：机器人模版（你可以直接使用它来生成你的机器人）\n- [el-bot-web](https://github.com/ElpsyCN/el-bot-web)：机器人前端（通过网页监控与控制你的机器人）（但是还在咕咕咕）\n\n## Thanks\n\n- [NapCatQQ](https://github.com/NapNeko/NapCatQQ)\n- [node-napcat-ts](https://github.com/huankong-team/node-napcat-ts)\n- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)\n- [mirai](https://github.com/mamoe/mirai)\n- [mirai-console](https://github.com/mamoe/mirai-console)\n- [mirai-api-http](https://github.com/mamoe/mirai-api-http)\n- [mirai-ts](https://github.com/YunYouJun/mirai-ts)\n- [koishi](https://github.com/koishijs/koishi)\n\n## 启动\n\n配置测试机器人（看情况配置吧）\n\n```sh\ncp bot/.env.example .env\n```\n\n## 参与开发\n\n开发测试（运行起来吧）\n\n```sh\ngit clone https://github.com/YunYouJun/el-bot\ncd el-bot\npnpm i\n```\n\n```sh\n# 启动 demo\npnpm demo\n\nnpm run dev:bot\n```\n\n开发 el-bot 库\n\n```sh\nnpm run dev:lib\n```\n\n## CHANGELOG\n\nSee [CHANGELOG.md](./CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunyoujun%2Fel-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyunyoujun%2Fel-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunyoujun%2Fel-bot/lists"}