numas13
/
xash3d-master
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qeury: add README.md with few examples

This commit is contained in:
Denis Drakhnia 2023-12-29 09:34:25 +02:00
parent 142b28ad64
commit e643dcdc7a
1 changed files with 71 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
query/README.md Normal file
View File

@ -0,0 +1,71 @@
# xash3d-query
Receive and display information about servers.
# Usage
Fetch information about a server.
```sh
$ xash3d-query info 144.49.47.88:27016
server: 144.49.47.88:27016 [33.462 ms]
status: "ok"
host: "Test Server"
gamedir: "valve"
map: "crossfire"
protocol: "0"
numcl: "13"
maxcl: "30"
dm: "true"
team: "false"
coop: "false"
password: "false"
```
Fetch servers addresses from the master server.
```sh
$ xash3d-query list
144.49.47.88:27016
144.49.47.88:27017
```
Fetch information about all servers received from the master server.
```sh
$ xash3d-query
server: 144.49.47.88:27016 [33.462 ms]
status: "ok"
host: "Test Server"
gamedir: "valve"
map: "crossfire"
protocol: "0"
numcl: "13"
maxcl: "30"
dm: "true"
team: "false"
coop: "false"
password: "false"
server: 144.49.47.88:27017 [32.596 ms]
status: "ok"
host: "Test Server 2"
gamedir: "valve"
map: "crossfire"
protocol: "0"
numcl: "7"
maxcl: "30"
dm: "true"
team: "false"
coop: "false"
password: "false"
```
# JSON output
```sh
# Print table sorted by number of players.
$ xash3d-query -j | jq -r '[.servers[] | select(.status == "ok")] | sort_by(.numcl) | reverse | .[] | [.numcl, .map, .address, .host] | @tsv'
13 crossfile 144.49.47.88:27016 Test Server
7 crossfile 144.49.47.88:27017 Test Server 2
```