Skip to content

Commit 9e0191f

Browse files
committed
readme update and better satori-python requirement version range
1 parent f5cb1f4 commit 9e0191f

File tree

2 files changed

+33
-6
lines changed

2 files changed

+33
-6
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ ChatBridge is mainly for custom use of TIS server, especially the bot/command co
2929
- Discord client
3030
- Kaiheila client
3131
- Online command client
32+
- ...
3233

3334
Therefore, for these bot and related clients:
3435

@@ -50,6 +51,7 @@ ChatBridge 是一个为 TIS 服务器定制使用的工具,尤其是 bot/指
5051
- Discord 客户端
5152
- Kaiheila 客户端
5253
- Online 指令客户端
54+
- ...
5355

5456
因此,对于这些 bot 及相关的客户端:
5557

@@ -190,7 +192,6 @@ python ChatBridge.pyz cqhttp_bot
190192
Extra requirements (also listed in `/chatbridge/impl/cqhttp/requirements.txt`):
191193

192194
```
193-
websocket>=0.2.1
194195
websocket-client>=1.2.1
195196
```
196197

@@ -217,21 +218,47 @@ Extra configure fields (compared to [CLI client](#cli-client))
217218
"server_display_name": "TIS" // The name of the server, used for display in some places
218219
```
219220

221+
## Client as a Satori client
222+
223+
```
224+
python ChatBridge.pyz cqhttp_bot
225+
```
226+
227+
Extra requirements (also listed in `/chatbridge/impl/satori/requirements.txt`):
228+
229+
```
230+
satori-python>=0.11
231+
```
232+
233+
Just like the CoolqHttp client, but it uses satori protocol
234+
235+
Extra configure fields (compared to [CLI client](#cli-client))
236+
237+
```json5
238+
"ws_address": "127.0.0.1", // satori server address
239+
"ws_port": 5500, // satori server port
240+
"ws_path": "", // satori server optional path prefix
241+
"satori_token": "xxxxx", // satori access token
242+
"react_channel_id": 12345, // the target channel id (for QQ, it's the group id)
243+
"chatbridge_message_prefix": "!!qq",
244+
"client_to_query_stats": "MyClient1", // it should be a client as an MCDR plugin, with stats_helper plugin installed in the MCDR
245+
"client_to_query_online": "MyClient2", // a client described in the following section "Client to respond online command"
246+
"server_display_name": "TIS" // The name of the server, used for display in some places
247+
```
248+
220249
## Kaiheila bot client
221250

222-
`python ChatBridge.pyz kaiheila_bot`
251+
`python ChatBridge.pyz satori_bot`
223252

224253
Extra requirements (also listed in `/chatbridge/impl/kaiheila/requirements.txt`):
225254

226255
```
227-
khl.py==0.0.10
256+
khl.py~=0.3.17
228257
```
229258

230259
Extra configure fields (compared to [CLI client](#cli-client))
231260

232261
```json5
233-
"client_id": "", // kaiheila client id
234-
"client_secret": "", // kaiheila client secret
235262
"token": "", // kaiheila token
236263
"channels_for_command": [ // a list of channels, public commands can be used here. use string
237264
"123400000000000000",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
satori-python
1+
satori-python>=0.11

0 commit comments

Comments
 (0)