diff --git a/docs/asset/img/configuration/koishi-install-onebot.png b/docs/asset/img/configuration/koishi-install-onebot.png new file mode 100644 index 0000000..8f6e217 Binary files /dev/null and b/docs/asset/img/configuration/koishi-install-onebot.png differ diff --git a/docs/asset/img/configuration/koishi-onebot-go-setting.png b/docs/asset/img/configuration/koishi-onebot-go-setting.png new file mode 100644 index 0000000..0b8da0c Binary files /dev/null and b/docs/asset/img/configuration/koishi-onebot-go-setting.png differ diff --git a/docs/asset/img/configuration/koishi-onebot-setting.png b/docs/asset/img/configuration/koishi-onebot-setting.png new file mode 100644 index 0000000..43b25af Binary files /dev/null and b/docs/asset/img/configuration/koishi-onebot-setting.png differ diff --git a/docs/asset/img/configuration/llonebot-koishi-rws-setting.png b/docs/asset/img/configuration/llonebot-koishi-rws-setting.png new file mode 100644 index 0000000..95655ee Binary files /dev/null and b/docs/asset/img/configuration/llonebot-koishi-rws-setting.png differ diff --git a/docs/asset/img/configuration/llonebot-nonebot-rws-setting.png b/docs/asset/img/configuration/llonebot-nonebot-rws-setting.png new file mode 100644 index 0000000..0e518ce Binary files /dev/null and b/docs/asset/img/configuration/llonebot-nonebot-rws-setting.png differ diff --git a/docs/zh-CN/guide/configuration.md b/docs/zh-CN/guide/configuration.md index 30620a0..c5956d9 100644 --- a/docs/zh-CN/guide/configuration.md +++ b/docs/zh-CN/guide/configuration.md @@ -1,25 +1,106 @@ # 配置 + +## 配置对接其他框架 + +::: details 配置 Koishi + +### 1.在 koishi 插件市场搜索 onebot 并安装 `adapter-onebot` + +![](../../asset/img/configuration/koishi-install-onebot.png) + +### 2.安装完之后点击修改->配置 + +![](../../asset/img/configuration/koishi-onebot-go-setting.png) + +### 3.配置 onebot + +这里以 ws 反向连接为例 + +填写 selfId 为你的机器人的 QQ 号 + +token 可以为空,需和 LLOneBot 配置的 token 一致 + +protocol 选择 ws-reverse + +其他配置保持默认即可,点击保存然后启用插件 + +![](../../asset/img/configuration/koishi-onebot-setting.png) + +3.配置完成后,LLOneBot 添加 ws 反向地址 + +koishi onebot 的 ws 反向地址为 `ws://127.0.0.1:5140/onebot` + + +![](../../asset/img/configuration/llonebot-koishi-rws-setting.png) + +点击保存即可 + +::: + +::: details 配置 NoneBot + LLOneBot + +### 1.配置 NoneBot + +这里假设你已经安装了 Onebot 适配器 + +默认情况 NoneBot 是启用了反向 ws 的,可能是默认配置问题,需要配置 token 才能正常连接 + +修改 NoneBot 配置文件 `.env`,添加 `ONEBOT_ACCESS_TOKEN=你的token`,token 需要和 LLOneBot 配置的 token 一致 + +然后启用 NoneBot,可以看到 NoneBot 输出的端口号,如 `8080` + +### 2.配置 LLOneBot + +![](../../asset/img/configuration/llonebot-nonebot-rws-setting.png) + +在 LLOneBot 配置页面添加反向 ws 地址,地址为 `ws://127.0.0.1:8080/onebot/v11`, 这里的 `8080` 是 NoneBot 输出的端口号,`/onebot/v11` 是 NoneBot onebot 适配器默认的路径 + +::: tip +记得 LLOneBot 配置的 token 需要和 NoneBot 配置的 一致,为空可能会连不上 + +::: + ## HTTP配置 -::: 用于接收应用端的 HTTP API 调用 -::: +::: details HTTP服务端口,用于接收应用端的 HTTP API 调用 + +如配置的3000端口,那么API地址为 `http://localhost:3000` + +一个简单的发送消息API调用示例 + +![](https://github.com/LLOneBot/LLOneBot/raw/main/doc/image/example.jpg) +::: + +::: details HTTP上报地址 + +当 LLOneBot 收到消息等事件时,会以 `POST` 请求的方式将事件上报到此地址 + +::: tip +上报地址必须是 `http://` 开头 + +http 事件上报,不支持快捷回复等快捷操作 +::: + + ## 正向WS配置 -::: details +::: details 用于接受应用端的正向WS连接 + +如正向 ws 绑定的端口为 3001 + +需要在应用端配置的WS地址为 `ws://localhost:3001` ::: + ## 反向WS配置 -::: details -![反向WS设置](/asset/img/RWS_Config.png) -::: +::: details 用于 LLOneBot 主动连接应用端绑定的反向WS地址 -## 配置 Koishi + LLOneBot -::: details +如在 NoneBot2 配置了 onebot 的端口为 8080,路径为 `/onebot/v11` -::: -## 配置 NoneBot + LLOneBot -::: details +那么在 LLOneBot 配置的反向WS地址为 `ws://localhost:8080/onebot/v11` ::: + + ## FFEMPG配置 ::: tip 前往侧栏语音配置查看