gamedig

LinuxGSM Docs Dev Docs

Search…

Home

Getting Started

gamedig

​GameDig is a tool that queries game servers and returns outputs data from a query into json format. It can not only check if the game server is online but also return various data such as current maps and players. This allows ./gameserver details to display live information.
GameDig super-seeds gsquery as the tool to monitor game servers. GameDig is currently optional but recommended and gsquery is kept to ensure compatibility as gamedig requires Node.js to be installed.
Install Node.js
GameDig requires Node.js a JavaScript runtime environment installed to work. Use the following instructions to install Node.js.
Remove existing NodeJS
If you already have an older version of nodejs installed or be having issues with node dependencies. It may be worth reinstalling Node.js.
Ubuntu/Debian
1
sudo apt remove --purge nodejs npm
2
sudo apt clean
3
sudo apt autoclean
4
sudo apt install -f
5
sudo apt autoremove
Copied!
CentOS
Work in progress
Install NodeJS
Installing nodejs can be problematic, however, using the below should work well.
Ubuntu/Debian
1
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
2
sudo apt update && sudo apt install -y nodejs
Copied!
CentOS
1
curl -fsSL https://rpm.nodesource.com/setup_16.x | bash -
2
yum install nodejs npm
Copied!
Install GameDig npm
Once nodejs is installed use npm to install gamedig with the following command.
1
npm install gamedig -g
Copied!
Update GameDig
Updates to GameDig are regularly made. It is possible to update by running the npm update command.
1
npm update -g
Copied!
You can also see which version of gamedig is installed by running the following.
1
 npm list -g gamedig
Copied!
Sample output
Details
Extra info becomes available for game server details.
1
Players:          0/8
2
Current Map:      Outpost
Copied!
Raw output
1
gamedig --type "protocol-valve" --host "1.2.3.4" --port "27015"
Copied!
1
{
2
  "name": "LinuxGSM Server",
3
  "map": "StationKappa",
4
  "password": false,
5
  "raw": {
6
    "protocol": 17,
7
    "folder": "StickyBots",
8
    "game": "StickyBots",
9
    "steamappid": 0,
10
    "numplayers": 0,
11
    "numbots": 0,
12
    "listentype": "d",
13
    "environment": "l",
14
    "secure": 0,
15
    "version": "0.0.6.22",
16
    "port": 7777,
17
    "steamid": "90122418420694019",
18
    "tags": "BUILDID:622,OWNINGID:90122418420694019,OWNINGNAME:LinuxGSM Server,P2PADDR:90122418420694019,P2PPORT:7777,SESSIONFLAGS:171",
19
    "gameid": "889400",
20
    "rules": {
21
      "BUILDID_i": "622",
22
      "NP_i": "0",
23
      "OWNINGID": "90122418420694019",
24
      "OWNINGNAME": "LinuxGSM Server",
25
      "P2PADDR": "90122418420694019",
26
      "P2PPORT": "7777",
27
      "SESSIONFLAGS": "171",
28
      "SN_s": "LinuxGSM Server"
29
    }
30
  },
31
  "maxplayers": 8,
32
  "players": [],
33
  "bots": [],
34
  "query": {
35
    "host": "1.2.3.4",
36
    "address": "1.2.3.4",
37
    "port": 27015,
38
    "port_query": 27015,
39
    "type": "protocol-valve",
40
    "duration": 90,
41
    "attempts": 1
42
  }
43
}
Copied!

glibc

Last modified 7mo ago

Export as PDF

Copy link

Contents

Install Node.js

Remove existing NodeJS