Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MrXiaoM committed Dec 5, 2023
1 parent 70dac82 commit 9767f88
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
- [x] 测试一些简单插件的运行效果
- [x] 解决登录后 mirai-console 被阻塞导致无法关闭的问题
- [x] 接口与实现分离,新建 `overflow-core-api` 模块
- [ ] 反向 WebSocket 支持
- [x] 反向 WebSocket 支持
16 changes: 11 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,19 @@ java -cp "$CLASSPATH:./libs/*" net.mamoe.mirai.console.terminal.MiraiConsoleTerm

## 安装完成后的配置

启动后会生成配置文件 `overflow.json`,修改其中的 `ws_host` 为服务端地址,再次启动即可,
服务端地址如 Shamrock 的 `主动WebSocket地址`
启动后会生成配置文件 `overflow.json`,编辑配置文件再次启动即可。

若修改 `reversed_ws_port``[1, 65535]` 区间的数 (端口号有效值),则代表使用`反向WebSocket` (又称`被动WebSocket`)连接。
该选项会覆盖`正向WebSocket` (又称 `主动WebSocket`) 地址配置。
需要注意的是,**OpenShamrock** 不管是主动(正向) WebSocket 还是被动(反向) WebSocket 的接口信息配置,都需要**重新启动QQ**才能生效

**反向WebSocket当前为实验性功能,可能存在问题,勿投入生产环境使用。**
### 正向 WebSocket

修改其中的 `ws_host` 为服务端地址,如 `ws://127.0.0.1:5700`,再次启动即可。

### 反向 WebSocket

设置反向 WebSocket 的端口,将在启动时开启反向 WebSocket 服务器等待连接。该选项优先级比正向 WebSocket 高,也就是设置了反向连接配置后将不使用正向连接。

修改 `reversed_ws_port``[1, 65535]` 区间的数 (端口号有效值) 即可。

# 项目进度相关说明

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,12 @@ class WSServer(
}

override fun onStart() {
logger.info("▌ 启动反向WebSocket服务端 $address")
logger.info("▌ 反向 WebSocket 服务端已在 $address 启动")
logger.info("▌ 正在等待客户端连接...")
}

override fun onOpen(conn: WebSocket, handshake: ClientHandshake) {
logger.info("反向WebSocket ${conn.remoteSocketAddress} 已连接 ┈━═☆")
logger.info("反向 WebSocket 客户端 ${conn.remoteSocketAddress} 已连接 ┈━═☆")
def.complete(Bot(conn, actionHandler))
}

Expand Down

0 comments on commit 9767f88

Please sign in to comment.