This repository was archived by the owner on May 1, 2025. It is now read-only.
File tree 1 file changed +19
-0
lines changed 1 file changed +19
-0
lines changed Original file line number Diff line number Diff line change @@ -8,6 +8,25 @@ All endpoints and response types remain the same as in the plugin.
8
8
9
9
> [ !Note]
10
10
> This server does not contain game state implementation and cannot be used for full-fledged gameplay.
11
+ >
12
+ ## How It Works
13
+ The plugin is installed on a Bukkit server (you can also add ViaVersion for a wider range of versions).
14
+ After installation, all connections will be disconnected with a message containing a 6-digit code.
15
+ On the server side, the plugin sets up an API on the port specified in the config, where all the requests described below should be sent.
16
+
17
+ ## Retrieving Data
18
+ ` GET /code/<6-digit code> `
19
+ After the user receives the code, you should send a request to the API endpoint, which will return data about the Minecraft account.
20
+ The code is valid only once and for 5 minutes (by default) after it is received. After this time, the code is deleted.
21
+
22
+ ** Example of a Successful Response:**
23
+ ``` json
24
+ {
25
+ "nickname" : " AndcoolSystems" ,
26
+ "UUID" : " 1420c63c-b111-4453-993f-b3479ba1d4c6" ,
27
+ "status" : " success"
28
+ }
29
+ ```
11
30
12
31
## Detailed description
13
32
You can’t perform that action at this time.
0 commit comments