Skip to content

Commit 52cf291

Browse files
SoulterKBVsent
authored andcommitted
docs: add aiocqhttp and satori protocol documentation; remove outdated lagrange and napcat guides
1 parent 0816126 commit 52cf291

8 files changed

Lines changed: 123 additions & 283 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -321,13 +321,7 @@ export default defineConfig({
321321
},
322322
{
323323
text: "OneBot v11",
324-
base: "/en/platform/aiocqhttp",
325-
collapsed: true,
326-
items: [
327-
{ text: "NapCat", link: "/napcat" },
328-
{ text: "Lagrange", link: "/lagrange" },
329-
{ text: "Other Clients", link: "/others" },
330-
],
324+
link: "/aiocqhttp",
331325
},
332326
{ text: "WeCom Application", link: "/wecom" },
333327
{ text: "WeCom AI Bot", link: "/wecom_ai_bot" },
@@ -344,7 +338,7 @@ export default defineConfig({
344338
base: "/en/platform/satori",
345339
collapsed: true,
346340
items: [
347-
{ text: "Using LLOneBot", link: "/llonebot" },
341+
{ text: "Connect Satori", link: "/guide" },
348342
{ text: "Using server-satori", link: "/server-satori" },
349343
],
350344
},

docs/en/platform/aiocqhttp.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Connect OneBot v11 Protocol Implementations
2+
3+
OneBot is a standardized bot application interface designed to unify bot development across different chat platforms, so developers can write business logic once and use it on multiple platforms.
4+
5+
AstrBot supports all client implementations that implement OneBot v11 reverse WebSocket (AstrBot acts as the server).
6+
7+
Common OneBot v11 implementation projects are listed below:
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+
Please refer to each implementation project's deployment documentation.
14+
15+
## 1. Configure OneBot v11
16+
17+
1. Open AstrBot's WebUI
18+
2. Click `Bots` in the left sidebar
19+
3. In the right panel, click `+ Create Bot`
20+
4. Select `OneBot v11`
21+
22+
Fill in the form:
23+
24+
- ID (`id`): any value, used only to distinguish instances of different platforms.
25+
- Enable (`enable`): check it.
26+
- Reverse WebSocket host: fill your machine IP, usually `0.0.0.0`.
27+
- Reverse WebSocket port: choose any port, default is `6199`.
28+
- Reverse WebSocket token: fill this only when NapCat network configuration has a token set.
29+
30+
Click `Save`.
31+
32+
## 2. Configure the protocol implementation side
33+
34+
Please refer to each protocol implementation project's deployment documentation.
35+
36+
Notes:
37+
38+
1. The implementation must support `Reverse WebSocket`, with AstrBot acting as the server and the implementation client as the client.
39+
2. The reverse WebSocket URL is `ws(s)://<your-host>:6199/ws`.
40+
41+
## 3. Verify
42+
43+
Go to AstrBot WebUI `Console`. If a blue log appears saying `aiocqhttp(OneBot v11) adapter connected.`, the connection is successful.
44+
If after a few seconds you see `aiocqhttp adapter has been closed`, it means the connection timed out (failed). Please double-check your configuration.

docs/en/platform/aiocqhttp/lagrange.md

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

docs/en/platform/aiocqhttp/napcat.md

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

docs/en/platform/aiocqhttp/others.md

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

docs/en/platform/satori/guide.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Connect to Satori Protocol
2+
3+
## Satori protocol overview
4+
5+
> Excerpt from: https://satori.chat/introduction.html
6+
7+
Satori is a unified chat protocol. It aims to reduce differences between chat platforms and let developers build cross-platform, extensible, high-performance chat applications with lower cost.
8+
9+
The protocol is named after [Komeiji Satori](https://satori.js.org) in Touhou Project. The idea is that Satori can serve as a bridge between chat platforms, as Komeiji Satori communicates telepathically.
10+
11+
The development team behind Satori has long worked on bot development and is familiar with the communication patterns of many platforms. After about 4 years, Satori now has a mature design and implementation. The official project currently provides adapters for more than 15 platforms, covering major messaging services worldwide such as QQ, Discord, WeCom, KOOK, and others.
12+
13+
## 1. Configure the protocol server side
14+
15+
Please refer to the deployment documentation of the chosen implementation project.
16+
17+
## 2. Configure Satori protocol in AstrBot
18+
19+
1. Open AstrBot WebUI.
20+
2. Click `Bots` in the left sidebar.
21+
3. In the right panel, click `+ Create Bot`.
22+
4. Select `satori`.
23+
24+
Fill in the form:
25+
26+
- Bot ID (`id`): e.g. `satori` (any value is fine).
27+
- Enable (`enable`): check it.
28+
- Satori API base URL (`satori_api_base_url`): `http://localhost:5600/v1` (same port as the protocol implementation).
29+
- Satori WebSocket endpoint (`satori_endpoint`): `ws://localhost:5600/v1/events` (same port as the protocol implementation).
30+
- Satori token (`satori_token`): fill according to implementation settings.
31+
32+
Click `Save`.

docs/en/platform/satori/llonebot.md

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

0 commit comments

Comments
 (0)