mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-24 09:05:04 +08:00
Ju4tCode
GitHub
commit
bb93757f51
@ -26,74 +26,17 @@ QQ 协议端举例:
|
||||
|
||||
### 选项 1 反向 WebSocket 连接
|
||||
|
||||
```yml{2,3,18,57,58}
|
||||
```yml{2,3,6,10}
|
||||
account:
|
||||
uin: 机器人QQ号
|
||||
password: "机器人密码"
|
||||
encrypt: false
|
||||
relogin:
|
||||
disabled: false
|
||||
delay: 3
|
||||
interval: 0
|
||||
max-times: 0
|
||||
|
||||
use-sso-address: true
|
||||
|
||||
heartbeat:
|
||||
disabled: false
|
||||
interval: 5
|
||||
|
||||
message:
|
||||
post-format: array
|
||||
ignore-invalid-cqcode: false
|
||||
force-fragment: false
|
||||
fix-url: false
|
||||
proxy-rewrite: ""
|
||||
report-self-message: false
|
||||
remove-reply-at: false
|
||||
extra-reply-data: false
|
||||
|
||||
output:
|
||||
log-level: warn
|
||||
debug: false
|
||||
|
||||
default-middlewares: &default
|
||||
access-token: ""
|
||||
filter: ""
|
||||
rate-limit:
|
||||
enabled: false
|
||||
frequency: 1
|
||||
bucket: 1
|
||||
|
||||
servers:
|
||||
- http:
|
||||
disabled: true
|
||||
host: 127.0.0.1
|
||||
port: 5700
|
||||
timeout: 5
|
||||
middlewares:
|
||||
<<: *default
|
||||
post:
|
||||
|
||||
- ws:
|
||||
disabled: true
|
||||
host: 127.0.0.1
|
||||
port: 6700
|
||||
middlewares:
|
||||
<<: *default
|
||||
|
||||
- ws-reverse:
|
||||
disabled: false
|
||||
universal: ws://127.0.0.1:8080/cqhttp/ws
|
||||
api: ws://your_websocket_api.server
|
||||
event: ws://your_websocket_event.server
|
||||
reconnect-interval: 3000
|
||||
middlewares:
|
||||
<<: *default
|
||||
|
||||
database:
|
||||
leveldb:
|
||||
enable: true
|
||||
```
|
||||
|
||||
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||||
@ -102,8 +45,54 @@ database:
|
||||
|
||||
### 选项 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 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
||||
|
||||
@ -67,12 +67,6 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
4. 修改配置文件
|
||||
|
||||
::: warning
|
||||
|
||||
由于NoneBot2的架构设计等原因, 部分功能的支持可能需要推迟到MAH 2.0正式发布后再完成
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
在此之前, 你可能需要了解我们为 MAH 设计的两种通信方式
|
||||
@ -98,9 +92,14 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
- 这是当使用正向 Websocket 时的配置举例
|
||||
|
||||
正向连接可以选择支持客户端连接方式的 `Driver` 来进行连接，请根据需求进行选择：
|
||||
|
||||
- `nonebot.drivers.fastapi`: 同时支持正向和反向
|
||||
- `nonebot.drivers.aiohttp`: 仅支持正向
|
||||
|
||||
::: warning
|
||||
|
||||
在默认情况下, NoneBot和MAH会同时监听8080端口, 这会导致端口冲突的错误
|
||||
在默认情况下, NoneBot 和 MAH 会同时监听 8080 端口, 这会导致端口冲突的错误
|
||||
请确保二者配置不在同一端口下
|
||||
|
||||
:::
|
||||
@ -131,10 +130,10 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
- ```python
|
||||
import nonebot
|
||||
from nonebot.adapters.mirai import WebsocketBot
|
||||
from nonebot.adapters.mirai import Bot
|
||||
|
||||
nonebot.init()
|
||||
nonebot.get_driver().register_adapter('mirai-ws', WebsocketBot, qq=12345678) # qq参数需要填在mah中登录的qq
|
||||
nonebot.get_driver().register_adapter('mirai', Bot, qq=12345678) # qq参数需要填在mah中登录的qq
|
||||
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
||||
nonebot.run()
|
||||
```
|
||||
|
||||
@ -26,74 +26,17 @@ QQ 协议端举例:
|
||||
|
||||
### 选项 1 反向 WebSocket 连接
|
||||
|
||||
```yml{2,3,18,57,58}
|
||||
```yml{2,3,6,10}
|
||||
account:
|
||||
uin: 机器人QQ号
|
||||
password: "机器人密码"
|
||||
encrypt: false
|
||||
relogin:
|
||||
disabled: false
|
||||
delay: 3
|
||||
interval: 0
|
||||
max-times: 0
|
||||
|
||||
use-sso-address: true
|
||||
|
||||
heartbeat:
|
||||
disabled: false
|
||||
interval: 5
|
||||
|
||||
message:
|
||||
post-format: array
|
||||
ignore-invalid-cqcode: false
|
||||
force-fragment: false
|
||||
fix-url: false
|
||||
proxy-rewrite: ""
|
||||
report-self-message: false
|
||||
remove-reply-at: false
|
||||
extra-reply-data: false
|
||||
|
||||
output:
|
||||
log-level: warn
|
||||
debug: false
|
||||
|
||||
default-middlewares: &default
|
||||
access-token: ""
|
||||
filter: ""
|
||||
rate-limit:
|
||||
enabled: false
|
||||
frequency: 1
|
||||
bucket: 1
|
||||
|
||||
servers:
|
||||
- http:
|
||||
disabled: true
|
||||
host: 127.0.0.1
|
||||
port: 5700
|
||||
timeout: 5
|
||||
middlewares:
|
||||
<<: *default
|
||||
post:
|
||||
|
||||
- ws:
|
||||
disabled: true
|
||||
host: 127.0.0.1
|
||||
port: 6700
|
||||
middlewares:
|
||||
<<: *default
|
||||
|
||||
- ws-reverse:
|
||||
disabled: false
|
||||
universal: ws://127.0.0.1:8080/cqhttp/ws
|
||||
api: ws://your_websocket_api.server
|
||||
event: ws://your_websocket_event.server
|
||||
reconnect-interval: 3000
|
||||
middlewares:
|
||||
<<: *default
|
||||
|
||||
database:
|
||||
leveldb:
|
||||
enable: true
|
||||
```
|
||||
|
||||
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||||
@ -102,8 +45,54 @@ database:
|
||||
|
||||
### 选项 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 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
||||
|
||||
@ -67,12 +67,6 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
4. 修改配置文件
|
||||
|
||||
::: warning
|
||||
|
||||
由于NoneBot2的架构设计等原因, 部分功能的支持可能需要推迟到MAH 2.0正式发布后再完成
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
在此之前, 你可能需要了解我们为 MAH 设计的两种通信方式
|
||||
@ -98,9 +92,14 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
- 这是当使用正向 Websocket 时的配置举例
|
||||
|
||||
正向连接可以选择支持客户端连接方式的 `Driver` 来进行连接，请根据需求进行选择：
|
||||
|
||||
- `nonebot.drivers.fastapi`: 同时支持正向和反向
|
||||
- `nonebot.drivers.aiohttp`: 仅支持正向
|
||||
|
||||
::: warning
|
||||
|
||||
在默认情况下, NoneBot和MAH会同时监听8080端口, 这会导致端口冲突的错误
|
||||
在默认情况下, NoneBot 和 MAH 会同时监听 8080 端口, 这会导致端口冲突的错误
|
||||
请确保二者配置不在同一端口下
|
||||
|
||||
:::
|
||||
@ -131,10 +130,10 @@ pip install nonebot-adapter-mirai
|
||||
|
||||
- ```python
|
||||
import nonebot
|
||||
from nonebot.adapters.mirai import WebsocketBot
|
||||
from nonebot.adapters.mirai import Bot
|
||||
|
||||
nonebot.init()
|
||||
nonebot.get_driver().register_adapter('mirai-ws', WebsocketBot, qq=12345678) # qq参数需要填在mah中登录的qq
|
||||
nonebot.get_driver().register_adapter('mirai', Bot, qq=12345678) # qq参数需要填在mah中登录的qq
|
||||
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
||||
nonebot.run()
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user