mirror of
https://github.com/jie65535/gc-opencommand-plugin.git
synced 2025-07-28 18:59:16 +08:00
Add README_en-US.md
This commit is contained in:
parent
d291d2a8d8
commit
9a15414f3c
@ -1,5 +1,7 @@
|
||||
# gc-opencommand-plugin
|
||||
|
||||
中文 | [English](README_en-US.md)
|
||||
|
||||
一个为第三方客户端开放GC命令执行接口的插件
|
||||
|
||||
# 服务端安装
|
||||
|
79
README_en-US.md
Normal file
79
README_en-US.md
Normal file
@ -0,0 +1,79 @@
|
||||
# gc-opencommand-plugin
|
||||
|
||||
[中文](README.md) | English
|
||||
|
||||
A plugin that opens the GC command execution interface for third-party clients
|
||||
|
||||
# Server installation
|
||||
1. Download the `jar` in [Release](https://github.com/jie65535/gc-opencommand-plugin/releases)
|
||||
2. Put it in the `plugins` folder
|
||||
|
||||
# Build
|
||||
1. `git clone https://github.com/jie65535/gc-opencommand-plugin`
|
||||
2. `cd gc-opencommand-plugin`
|
||||
3. `mkdir lib`
|
||||
4. `mv path/to/grasscutter-1.x.x-dev.jar ./lib`
|
||||
5. `gradle build`
|
||||
|
||||
# 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
|
||||
1. `ping` to confirm whether the `opencommand` plugin is supported
|
||||
2. `sendCode` sends a verification code to the specified player (re-send is not allowed within 1 minute), and save the returned `token`
|
||||
3. Send `verify` check using `token` and **4-digit integer verification code**
|
||||
4. If the verification is passed, you can use the `token` to execute the `command` action
|
||||
|
||||
---
|
||||
|
||||
# API `/opencommand/api`
|
||||
Example
|
||||
```
|
||||
https://127.0.0.1/opencommand/api
|
||||
```
|
||||
|
||||
# Request
|
||||
```java
|
||||
public final class JsonRequest {
|
||||
public String token = "";
|
||||
public String action = "";
|
||||
public Object data = null;
|
||||
}
|
||||
```
|
||||
|
||||
# Response
|
||||
```java
|
||||
public final class JsonResponse {
|
||||
public int retcode = 200;
|
||||
public String message = "success";
|
||||
public Object data;
|
||||
}
|
||||
```
|
||||
|
||||
# Actions
|
||||
## `ping`
|
||||
data = null
|
||||
|
||||
## `sendCode`
|
||||
### Request
|
||||
data = uid (int)
|
||||
### Response
|
||||
data = token (string)
|
||||
|
||||
## `verify`: Requires `token`
|
||||
### Request
|
||||
data = code (int)
|
||||
### Response
|
||||
#### Success:
|
||||
code = 200
|
||||
#### Verification failed:
|
||||
code = 400
|
||||
|
||||
## `command`: Requires `token`
|
||||
### Request
|
||||
data = command (string)
|
||||
### Response
|
||||
data = message (string)
|
Loading…
Reference in New Issue
Block a user