Skip to content

Commit 8cba0e0

Browse files
committed
docs: 补充文档
1 parent 61830f1 commit 8cba0e0

File tree

1 file changed

+53
-2
lines changed

1 file changed

+53
-2
lines changed

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,60 @@ Download LabAPI_QueryServer_x64.dll from Releases and place it in `%appdata%\SCP
1414

1515
从 Releases 中下载 LabAPI_QueryServer_x64.dll 并放入 `%appdata%\SCP Secret Laboratory\LabAPI\plugins\<port>`
1616

17-
All done!
17+
For example, when the server port is set to 7777 under default configuration.
1818

19-
大功告成!
19+
以默认配置情况下,服务器端口为7777时为例。
20+
21+
```HTTP
22+
GET http://127.0.0.1:7777/
23+
```
24+
25+
If everything is normal, it will return:
26+
27+
一切正常的话,将会返回:
28+
29+
```json
30+
{
31+
"name":"My Server Name",
32+
"port":7777,
33+
"player":{
34+
"online":4,
35+
"max":20,
36+
// or [] 或 []
37+
"list":[
38+
{
39+
"Nickname":"德二吹风机D2s",
40+
"RemoteAdminAccess":true
41+
}
42+
],
43+
"admins":1
44+
},
45+
// Round time 回合时间
46+
"time":83,
47+
// FriendlyFire 友伤
48+
"friendly_fire":false,
49+
// Warhead detonation 核弹引爆
50+
"warhead":false,
51+
// LCz Decontamination 轻收净化程序
52+
"decontamination":false,
53+
"success":true
54+
}
55+
```
56+
57+
If a request is made while the server is not fully started:
58+
59+
如果在服务器未完全启动时请求:
60+
61+
```json
62+
{
63+
"data":"The server has not yet fully started. Please try again later.",
64+
"success":true
65+
}
66+
```
67+
68+
Other potential errors may result in HTTP status code 500.
69+
70+
其他潜在错误可能导致 HTTP 状态码500。
2071

2172
## Config / 配置
2273

0 commit comments

Comments
 (0)