gc-opencommand-plugin/README_en-US.md

gc-opencommand-plugin

中文 | English

A plugin that opens the GC command execution interface for third-party clients

Server installation

1. Download the jar in Release
2. Put it in the plugins folder

Console connection

1. When starting for the first time, a opencommand-plugin directory will be generated under the plugins directory, open and edit config.json
2. Set the value of consoleToken to your connection key. It is recommended to use a long random string of at least 32 characters.
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

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

---

config.json

{
  "consoleToken": "",
  "codeExpirationTime_S": 60,
  "tempTokenExpirationTime_S": 300,
  "tokenLastUseExpirationTime_H": 48,
  "socketPort": 5746,
  "socketToken": "",
  "socketHost": "127.0.0.1"
}

API /opencommand/api

Example

https://127.0.0.1/opencommand/api

Request

public final class JsonRequest {
    public String token = "";
    public String action = "";
    public Object data = null;
}

Response

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)