From 58bce5c21fb5cd6387b6421968efd0349ff13551 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Sun, 17 Nov 2024 00:23:24 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E9=83=A8=E7=BD=B2=E6=95=99=E7=A8=8B?= =?UTF-8?q?=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- docs/config/function/platform.md | 23 +++++++-------------- docs/deploy/langbot/manual.md | 7 ++++++- docs/deploy/platforms/aiocqhttp/lagrange.md | 5 +++-- docs/deploy/platforms/aiocqhttp/llonebot.md | 4 +++- docs/deploy/platforms/aiocqhttp/napcat.md | 2 +- docs/deploy/quick-config/config.md | 4 ++-- 7 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e3808e394..4f4e22f1a 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -131,7 +131,7 @@ export default defineConfig({ { text: "插件开发", link: "/plugin/plugin-dev" }, { text: "组件拓展", link: "/plugin/extension" }, { text: "API参考", link: "/plugin/api-ref" }, - { text: "技术信息", link: "/plugin/tech-info" }, + // { text: "技术信息", link: "/plugin/tech-info" }, ], }, { diff --git a/docs/config/function/platform.md b/docs/config/function/platform.md index 41fdd197c..f4392f150 100644 --- a/docs/config/function/platform.md +++ b/docs/config/function/platform.md @@ -10,14 +10,6 @@ ```json "platform-adapters": [ - { - "adapter": "yiri-mirai", - "enable": false, - "host": "127.0.0.1", - "port": 8080, - "verifyKey": "yirimirai", - "qq": 123456789 - }, { "adapter": "nakuru", "enable": false, @@ -30,7 +22,7 @@ "adapter": "aiocqhttp", "enable": false, "host": "0.0.0.0", - "port": 8080, + "port": 2280, "access-token": "", }, { @@ -46,7 +38,7 @@ ], ``` -目前支持 `mirai`、`go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器。 +目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器。 各个消息平台的配置方式请查看部署文档。 ### 多开示例 @@ -54,12 +46,11 @@ ```json "platform-adapters": [ { - "adapter": "yiri-mirai", - "enable": true, - "host": "127.0.0.1", - "port": 8080, - "verifyKey": "yirimirai", - "qq": 123456789 + "adapter": "aiocqhttp", + "enable": false, + "host": "0.0.0.0", + "port": 2280, + "access-token": "", }, { "adapter": "nakuru", diff --git a/docs/deploy/langbot/manual.md b/docs/deploy/langbot/manual.md index b1997ca95..530a673dd 100644 --- a/docs/deploy/langbot/manual.md +++ b/docs/deploy/langbot/manual.md @@ -7,7 +7,7 @@ ## 安装主程序 -1. 前往[Release](https://github.com/RockChinQ/LangBot/releases)页面下载最新版本的压缩包（推荐）并解压，在解压目录打开命令行（终端） +1. 前往[Release](https://github.com/RockChinQ/LangBot/releases)页面下载最新版本的压缩包（推荐）`langbot-xxx-all.zip`（请勿下载 Source Code，因为其中不包含 WebUI）。解压，在解压目录打开命令行（终端） ![下载Release](/assets/image/dl_release.png) @@ -18,6 +18,11 @@ ```bash git clone https://github.com/RockChinQ/LangBot cd LangBot + +# 构建前端，需要 NodeJS >= 22 +cd web +npm install && npm run build +cd .. ``` ::: diff --git a/docs/deploy/platforms/aiocqhttp/lagrange.md b/docs/deploy/platforms/aiocqhttp/lagrange.md index bbd719b59..961969609 100644 --- a/docs/deploy/platforms/aiocqhttp/lagrange.md +++ b/docs/deploy/platforms/aiocqhttp/lagrange.md @@ -49,5 +49,6 @@ Lagrange 是一个 QQNT 协议逆向工程框架，比 Shamrock 或 Mirai 更加 ![配置连接](/assets/image/config_lgr.png) 其中 Type 必须为 `ReverseWebSocket`; -Host 为 LangBot 运行的主机 IP，若在同一主机上，可以写 `127.0.0.1`; -Suffix 必须为 `/ws` \ No newline at end of file +Host 为 LangBot 运行的主机 IP，若在同一主机上，可以写 `127.0.0.1`； +Suffix 必须为 `/ws`； +Port 必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同。 \ No newline at end of file diff --git a/docs/deploy/platforms/aiocqhttp/llonebot.md b/docs/deploy/platforms/aiocqhttp/llonebot.md index 4519a6a89..be3da77ed 100644 --- a/docs/deploy/platforms/aiocqhttp/llonebot.md +++ b/docs/deploy/platforms/aiocqhttp/llonebot.md @@ -6,4 +6,6 @@ 安装LiteLoaderQQNT的教程：https://llonebot.github.io/zh-CN/guide/getting-started -![image-20240515185909108](/assets/image/llob_cfg.png) \ No newline at end of file +![image-20240515185909108](/assets/image/llob_cfg.png) + +确保地址中 IP地址 是 LangBot 运行的主机的地址（若在同一网络内运行则为 127.0.0.1），端口必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同，后缀必须为`/ws`： \ No newline at end of file diff --git a/docs/deploy/platforms/aiocqhttp/napcat.md b/docs/deploy/platforms/aiocqhttp/napcat.md index d8a8b9ad6..b5aba0510 100644 --- a/docs/deploy/platforms/aiocqhttp/napcat.md +++ b/docs/deploy/platforms/aiocqhttp/napcat.md @@ -20,7 +20,7 @@ NapCat 是一个 QQNT 协议逆向工程框架。 登录后，可以在config文件夹中，找到并修改文件（数字对应机器人QQ号）：![image-20240514231529613](/assets/image/napcat_cfg_1.png) -参考下图红框修改内容，确保地址中 IP地址 是 LangBot 运行的主机的地址（若在同一网络内运行则为 127.0.0.1），后缀须为`/ws`： +参考下图红框修改内容，确保地址中 IP地址 是 LangBot 运行的主机的地址（若在同一网络内运行则为 127.0.0.1），端口必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同，后缀必须为`/ws`： ![image-20240514231932514](/assets/image/napcat_cfg_2.png) diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md index 06f9e0d1c..5488900e6 100644 --- a/docs/deploy/quick-config/config.md +++ b/docs/deploy/quick-config/config.md @@ -14,7 +14,7 @@ ### aiocqhttp 适配器 -用于接入 Lagrange 等兼容 OneBot 协议的机器人框架（仅支持反向ws）。 +用于接入 Lagrange/NapCat/LLOneBot 等兼容 OneBot 协议的机器人端（仅支持反向ws）。 ```json { @@ -32,7 +32,7 @@ `host`：监听的 IP 地址，一般就保持 0.0.0.0 就可以了。使用 aiocqhttp 时，LangBot 作为服务端被动等待框架连接，请在 Shamrock 等框架中设置`被动 ws 地址`或者`反向 ws 地址`（具体视框架而定）为 LangBot 监听的地址，且路径为`/ws`，例如：`ws://127.0.0.1:2280/ws`。 -`port`：设置监听的端口，默认2280，需在 Napcat 等框架中设置为与此处一致的端口 +`port`：设置监听的端口，默认2280，需在 Napcat 等框架中设置为与此处一致的端口。使用容器启动的 LangBot 默认暴露了 2280-2290 端口，请选用其中任意一个端口。 `access-token`：设置访问密钥，与 Napcat 等框架中设置的保持一致