mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-24 17:15:05 +08:00
3.5 KiB
3.5 KiB
CQHTTP 协议使用指南
配置 NoneBot CQHTTP 适配器
pip install nonebot-adapter-cqhttp
配置 CQHTTP 协议端(以 QQ 为例)
单纯运行 NoneBot 实例并不会产生任何效果,因为此刻 QQ 这边还不知道 NoneBot 的存在,也就无法把消息发送给它,因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
QQ 协议端举例:
- go-cqhttp (基于 MiraiGo)
- cqhttp-mirai-embedded
- Mirai + cqhttp-mirai
- Mirai + Mirai Native + CQHTTP
- OICQ-http-api (基于 OICQ)
这里以 go-cqhttp 为例
- 下载 go-cqhttp 对应平台的 release 文件,点此前往
- 运行 exe 文件或者使用
./go-cqhttp
启动 - 生成默认配置文件并修改默认配置
{
uin: 机器人QQ号
password: 机器人密码
encrypt_password: false
password_encrypted: ""
enable_db: true
access_token: ""
relogin: {
enabled: true
relogin_delay: 3
max_relogin_times: 0
}
_rate_limit: {
enabled: false
frequency: 1
bucket_size: 1
}
ignore_invalid_cqcode: false
force_fragmented: false
heartbeat_interval: 0
http_config: {
enabled: false
host: "0.0.0.0"
port: 5700
timeout: 0
post_urls: {}
}
ws_config: {
enabled: false
host: "0.0.0.0"
port: 6700
}
ws_reverse_servers: [
{
enabled: true
reverse_url: ws://127.0.0.1:8080/cqhttp/ws
reverse_api_url: ws://you_websocket_api.server
reverse_event_url: ws://you_websocket_event.server
reverse_reconnect_interval: 3000
}
]
post_message_format: array
use_sso_address: false
debug: false
log_level: ""
web_ui: {
enabled: false
host: 127.0.0.1
web_ui_port: 9999
web_input: false
}
}
其中 ws://127.0.0.1:8080/cqhttp/ws
中的 127.0.0.1
和 8080
应分别对应 nonebot 配置的 HOST 和 PORT。
cqhttp
是前述 register_adapter
时传入的第一个参数,代表设置的 CQHTTPBot
适配器的路径,你可以对不同的适配器设置不同路径以作区别。
历史性的第一次对话
一旦新的配置文件正确生效之后,NoneBot 所在的控制台(如果正在运行的话)应该会输出类似下面的内容(两条访问日志):
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。
现在,尝试向你的机器人账号发送如下内容:
/echo 你好,世界
到这里如果一切 OK,你应该会收到机器人给你回复了 你好,世界
。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例,开始了编写更强大的 QQ 机器人的创意之旅!