Compare commits

..

2 Commits

Author SHA1 Message Date
896b802bff
Update README_en-US.md 2023-11-22 20:44:26 +08:00
4c4840be36
Update README.md 2023-11-22 20:42:04 +08:00
2 changed files with 24 additions and 18 deletions

View File

@ -21,21 +21,24 @@
## 服务端安装 ## 服务端安装
1. 在 [Release](https://github.com/jie65535/gc-opencommand-plugin/releases) 下载 `jar` 1. 在 [Release](https://github.com/jie65535/gc-opencommand-plugin/releases) 下载 `jar`
2. 放入 `plugins` 文件夹即可 2. 放入 `grasscutter/plugins` 文件夹
3. 重启 `grasscutter` 即可生效
## 玩家使用流程
1. 在远程工具中填写服务地址,查询插件状态
2. 填写UID发送验证码需要在线
3. 将游戏内收到的**4位整数验证码**填入工具校验
4. 享受便利!
## 控制台连接 ## 控制台连接
1. 首次启动时,会在 `plugins` 目录下生成一个 `opencommand-plugin` 目录,打开并编辑 `config.json` 1. 首次启动时,会在 `plugins` 目录下生成一个 `opencommand-plugin` 目录,打开并编辑 `config.json`
2. 设置 `consoleToken` 的值为你的连接秘钥建议使用至少32字符的长随机字符串。检测到为空时会自动生成 2. 设置 `consoleToken` 的值为你的连接秘钥建议使用至少32字符的长随机字符串。检测到为空时会自动生成,生成时会在控制台中输出
3. 重新启动服务端即可生效配置 3. 重新启动服务端即可生效配置
4. 在客户端中选择控制台身份,并填写你的 `consoleToken` 即可以控制台身份运行指令 4. 在工具中选择控制台身份,并填写你的 `consoleToken` 即可以控制台身份运行指令
## 玩家使用流程 ---
1. 在客户端中填写服务地址,确认是否支持
2. 填写UID发送验证码
3. 将游戏内收到的**4位整数验证码**填入客户端校验
4. 享受便利!
## 客户端请求流程 ## 客户端请求流程
@ -48,8 +51,8 @@
1. 克隆仓库 1. 克隆仓库
2. 在目录下新建 `lib` 目录 2. 在目录下新建 `lib` 目录
3. 将 `grasscutter-1.1.x-dev.jar` 放入 `lib` 目录 3. 将 `grasscutter.jar` 放入 `lib` 目录
4. `gradle build` 4. 执行 `gradle build`
## 多服务器 ## 多服务器
### 主服务器 (Dispatch) ### 主服务器 (Dispatch)

View File

@ -21,7 +21,15 @@ Invoking `ping` the response data will contain the plugin version.
## Server installation ## Server installation
1. Download the `jar` in [Release](https://github.com/jie65535/gc-opencommand-plugin/releases) 1. Download the `jar` in [Release](https://github.com/jie65535/gc-opencommand-plugin/releases)
2. Put it in the `plugins` folder 2. Put it in the `grasscutter/plugins` folder
3. Restart `grasscutter` server
## Player
1. Fill in the service address in the Tool to check plugin status
2. Fill in the UID and send the verification code
3. Fill in the **4-digit integer verification code** received in the game into the Tool verification
4. Enjoy the convenience!
## Console connection ## Console connection
@ -32,12 +40,7 @@ Invoking `ping` the response data will contain the plugin version.
3. Restart the server to take effect 3. Restart the server to take effect
4. Select the console identity in the client, and fill in your `consoleToken` to run the command as the console identity 4. Select the console identity in the client, and fill in your `consoleToken` to run the command as the console identity
## Player ---
1. Fill in the service address in the client to confirm whether it supports
2. Fill in the UID and send the verification code
3. Fill in the **4-digit integer verification code** received in the game into the client verification
4. Enjoy the convenience!
## Client request ## Client request