WeqBot 文档
WeqBot 是一个独立的 QQ bot 框架:自己完成登录、上线注册与心跳,不借用 QQ 客户端的 在线会话;也可以作为纯 TypeScript 嵌进 WeQ desktop,由宿主注入已有的原生组件。
本页是入口索引。按你正要做的事挑一组即可。
三种运行形态
| 形态 | 原生组件 | 入口 | 状态 |
|---|---|---|---|
| 独立进程 | nt_helper 完整产物(native/<platform>/<arch>/nt_helper.node) | @weqbot/node | 骨架 |
| 嵌入 WeQ desktop | 复用 WeQ 的 full 产物,不带 .node | --sidecar + @weqbot/control | 契约已定 |
| 测试 | 桩实现 | 任意包 | 可用 |
WeQ 侧是 sidecar 子进程,不是同进程对象注入:一个进程只服务一个账号,多账号 = 多进程。 凭据通过控制通道交付,不跨进程共享内存。
按目标找文档
| 我想…… | 看这篇 |
|---|---|
| 装起来、跑起来 | 下载与安装 |
| 知道凭据从哪来、怎么换机 | 登录与凭据 |
| 改配置(端口、日志、预检) | 配置文件 |
| 让 NoneBot / cc-connect 连上来 | OneBot 接入 |
| 知道消息、通知、请求长什么样 | 事件推送 |
| 读懂分层与依赖方向 | 项目架构 |
| 往 WeQ 里嵌 | 嵌入 WeQ |
先说清三条边界
读任何一篇之前,这三条决定了框架不做什么:
- 不做「扫描凭据 + 自己上线」。扫描得到的会话物料属于 QQ 本体正在用的那条会话, 拿它去自建上线会与 QQ 互踢。自建上线的票据只能来自
quickLogin/qrLogin。 - 同一账号同一时刻只有一条凭据路径。QQ 在线 → 借会话(mode 1);QQ 离线 → 自建 (mode 2)。框架不会在 QQ 在线时强行抢登录。
- 不读 QQ 的数据库。bot 的消息只来自推送,不靠本地库补历史。
版本与状态标记
WeqBot 尚未发布,0.0.0 是占位版本号。文档里统一用这几种标记:
- 已实现 —— 代码存在且通过测试,部分有真机验证(正文会写清是哪一种);
- 骨架 —— 接口与结构就位,核心逻辑未接通;
- 尚未实现 —— 只有规划,正文说明依赖什么才能开始。
OneBot 的 214 条动作是全部注册的(后端能力不足的会被跳过并返回 1404),但其中大部分 还没有真机验收。这一区别在 动作列表 里按能力判定方式标出。
