mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-29 00:25:58 +08:00
118 lines
3.9 KiB
Markdown
118 lines
3.9 KiB
Markdown
# CQHTTP 协议使用指南
|
||
|
||
## 安装 NoneBot CQHTTP 适配器
|
||
|
||
```bash
|
||
pip install nonebot-adapter-cqhttp
|
||
```
|
||
|
||
## 配置 CQHTTP 协议端（以 QQ 为例）
|
||
|
||
单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
|
||
|
||
QQ 协议端举例:
|
||
|
||
- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) (基于 [MiraiGo](https://github.com/Mrs4s/MiraiGo))
|
||
- [onebot-kotlin](https://github.com/yyuueexxiinngg/onebot-kotlin)
|
||
- [Mirai](https://github.com/mamoe/mirai) + [onebot-mirai](https://github.com/yyuueexxiinngg/onebot-kotlin)
|
||
- [Mirai](https://github.com/mamoe/mirai) + [Mirai Native](https://github.com/iTXTech/mirai-native) + [CQHTTP](https://github.com/richardchien/coolq-http-api)
|
||
- [node-onebot](https://github.com/takayama-lily/node-onebot) (基于 [abot](https://github.com/takayama-lily/abot), [OICQ](https://github.com/takayama-lily/oicq))
|
||
|
||
这里以 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 为例
|
||
|
||
1. 下载 go-cqhttp 对应平台的 release 文件，[点此前往](https://github.com/Mrs4s/go-cqhttp/releases)
|
||
2. 运行 exe 文件或者使用 `./go-cqhttp` 启动
|
||
3. 生成默认配置文件并修改默认配置
|
||
|
||
### 选项 1 反向 WebSocket 连接
|
||
|
||
```yml{2,3,6,10}
|
||
account:
|
||
uin: 机器人QQ号
|
||
password: "机器人密码"
|
||
|
||
message:
|
||
post-format: array
|
||
|
||
servers:
|
||
- ws-reverse:
|
||
universal: ws://127.0.0.1:8080/cqhttp/ws
|
||
```
|
||
|
||
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||
|
||
`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
|
||
|
||
### 选项 2 HTTP POST 上报
|
||
|
||
```yml{2,3,6,11}
|
||
account:
|
||
uin: 机器人QQ号
|
||
password: "机器人密码"
|
||
|
||
message:
|
||
post-format: array
|
||
|
||
servers:
|
||
- http:
|
||
post:
|
||
- url: "http://127.0.0.1:8080/cqhttp/http"
|
||
secret: ""
|
||
```
|
||
|
||
其中 `ws://127.0.0.1:8080/cqhttp/http` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||
|
||
`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
|
||
|
||
### 选项 3 正向 WebSocket 连接
|
||
|
||
```yml{2,3,6,10,11}
|
||
account:
|
||
uin: 机器人QQ号
|
||
password: "机器人密码"
|
||
|
||
message:
|
||
post-format: array
|
||
|
||
servers:
|
||
- ws:
|
||
host: 127.0.0.1
|
||
port: 6700
|
||
```
|
||
|
||
NoneBot 配置
|
||
|
||
```dotenv
|
||
CQHTTP_WS_URLS={"机器人QQ号": "ws://127.0.0.1:6700/"}
|
||
```
|
||
|
||
其中 `ws://127.0.0.1:6700/` 中的 `127.0.0.1` 和 `6700` 应分别对应 go-cqhttp 配置的 HOST 和 PORT。
|
||
|
||
正向连接可以选择支持客户端连接方式的 `Driver` 来进行连接，请根据需求进行选择：
|
||
|
||
- `nonebot.drivers.fastapi`: 同时支持正向和反向
|
||
- `nonebot.drivers.aiohttp`: 仅支持正向
|
||
|
||
## 历史性的第一次对话
|
||
|
||
一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
||
|
||
```default
|
||
09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
|
||
09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
|
||
```
|
||
|
||
这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
|
||
|
||
现在，尝试向你的机器人账号发送如下内容：
|
||
|
||
```default
|
||
/echo 你好，世界
|
||
```
|
||
|
||
到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
|
||
|
||
<ClientOnly>
|
||
<Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
|
||
</ClientOnly>
|