Skip to content

Commit 0816126

Browse files
SoulterKBVsent
authored andcommitted
perf: onebot, satori docs improvement
1 parent a4e9a5c commit 0816126

7 files changed

Lines changed: 77 additions & 282 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,7 @@ export default defineConfig({
8787
},
8888
{
8989
text: "OneBot v11",
90-
base: "/platform/aiocqhttp",
91-
collapsed: true,
92-
items: [
93-
{ text: "NapCat", link: "/napcat" },
94-
{ text: "Lagrange", link: "/lagrange" },
95-
{ text: "其他端", link: "/others" },
96-
],
90+
link: "/aiocqhttp"
9791
},
9892
{ text: "企微应用", link: "/wecom" },
9993
{ text: "企微智能机器人", link: "/wecom_ai_bot" },
@@ -111,7 +105,7 @@ export default defineConfig({
111105
base: "/platform/satori",
112106
collapsed: true,
113107
items: [
114-
{ text: "使用 LLOneBot", link: "/llonebot" },
108+
{ text: "接入 Satori", link: "/guide" },
115109
{ text: "使用 server-satori", link: "/server-satori" },
116110
],
117111
},

docs/zh/platform/aiocqhttp.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# 接入 OneBot v11 协议实现
2+
3+
OneBot 是一个聊天机器人应用接口标准,旨在统一不同聊天平台上的机器人应用开发接口,使开发者只需编写一次业务逻辑代码即可应用到多种机器人平台。
4+
5+
AstrBot 支持接入所有适配了 OneBotv11 反向 Websockets(AstrBot 做服务器端)的机器人协议端。
6+
7+
下文给出一些常见的 OneBot v11 协议实现端项目。
8+
9+
- [NapCat](https://github.com/NapNeko/NapCatQQ)
10+
- [OneDisc](https://github.com/ITCraftDevelopmentTeam/OneDisc)
11+
- [Tele-KiraLink](https://github.com/Echomirix/Tele-KiraLink)
12+
13+
请参阅对应的协议实现端项目的部署文档。
14+
15+
## 1. 配置 OneBot v11
16+
17+
1. 进入 AstrBot 的 WebUI
18+
2. 点击左边栏 `机器人`
19+
3. 然后在右边的界面中,点击 `+ 创建机器人`
20+
4. 选择 `OneBot v11`
21+
22+
在出现的表单中,填写:
23+
24+
- ID(id):随意填写,仅用于区分不同的消息平台实例。
25+
- 启用(enable): 勾选。
26+
- 反向 WebSocket 主机地址:请填写你的机器的 IP 地址,一般情况下请直接填写 `0.0.0.0`
27+
- 反向 WebSocket 端口:填写一个端口,默认为 `6199`
28+
- 反向 Websocket Token:只有当 NapCat 网络配置中配置了 token 才需填写。
29+
30+
点击 `保存`
31+
32+
## 2. 配置协议实现端
33+
34+
请参阅对应的协议实现端项目的部署文档。
35+
36+
一些注意点:
37+
38+
1. 协议实现端需要支持 `反向 WebSocket` 实现,及 AstrBot 端作为服务端,实现端作为客户端。
39+
2. `反向 WebSocket` 的 URL 为 `ws(s)://<your-host>:6199/ws`
40+
41+
## 3. 验证
42+
43+
前往 AstrBot WebUI `控制台`,如果出现 ` aiocqhttp(OneBot v11) 适配器已连接。` 蓝色的日志,说明连接成功。如果没有,若干秒后出现` aiocqhttp 适配器已被关闭` 则为连接超时(失败),请检查配置是否正确。

docs/zh/platform/aiocqhttp/lagrange.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/zh/platform/aiocqhttp/napcat.md

Lines changed: 0 additions & 134 deletions
This file was deleted.

docs/zh/platform/aiocqhttp/others.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/zh/platform/satori/guide.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# 接入 Satori 协议
2+
3+
## Satori 协议简介
4+
5+
> 摘录自:https://satori.chat/zh-CN/introduction.html
6+
7+
Satori 是一个通用的聊天协议。Satori 协议希望能够抹平不同聊天平台之间的差异,让开发者以更低的成本开发出跨平台、可扩展、高性能的聊天应用。
8+
9+
Satori 的名称来源于游戏东方 Project 中的角色 [古明地觉 (Komeiji Satori)](https://zh.touhouwiki.net/wiki/%E5%8F%A4%E6%98%8E%E5%9C%B0%E8%A7%89)。古明地觉能够以心灵感应的方式与各种动物交流,取这个名字是希望 Satori 能够成为各个聊天平台之间的桥梁。
10+
11+
Satori 的开发团队长期从事聊天机器人开发,熟悉各种聊天平台的通信方式。经过长达 4 年的发展,Satori 有了健全的设计和完善的实现。目前,Satori 官方提供了超过 15 个聊天平台的适配器,完全覆盖了世界上主流的聊天平台,如 QQ、Discord、企业微信、KOOK 等等。
12+
13+
## 1. 配置协议实现端
14+
15+
请参阅对应的协议实现端项目的部署文档。
16+
17+
## 2. 配置 Satori 协议
18+
19+
1. 进入 AstrBot 的 WebUI
20+
2. 点击左边栏 `机器人`
21+
3. 然后在右边的界面中,点击 `+ 创建机器人`
22+
4. 选择 `Satori`
23+
24+
弹出的配置项填写:
25+
26+
- 机器人名称 (id): `satori` (随意)
27+
- 启用 (enable): 勾选
28+
- Satori API 终结点 (satori_api_base_url):`http://localhost:5600/v1`(端口和上面配置的协议端端口一致)
29+
- Satori WebSocket 终结点 (satori_endpoint):`ws://localhost:5600/v1/events`(端口和上面配置的协议端端口一致)
30+
- Satori 令牌 (satori_token):根据协议端配置情况选择填写
31+
32+
点击 `保存`

docs/zh/platform/satori/llonebot.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)