https://github.com/vorot93/grokstat

Fast game server query tool
https://github.com/vorot93/grokstat

game-server golang query

Last synced: 2 months ago
JSON representation

Fast game server query tool

• Host: GitHub
• URL: https://github.com/vorot93/grokstat
• Owner: vorot93
• License: gpl-3.0
• Created: 2015-12-06T17:04:28.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-10T19:57:53.000Z (over 7 years ago)
• Last Synced: 2024-06-20T15:44:28.751Z (4 months ago)
• Topics: game-server, golang, query
• Language: Go
• Homepage:
• Size: 122 KB
• Stars: 26
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome-lanparty-software - GrokStat

README

        
# GrokStat

[![Build Status](https://img.shields.io/travis/vorot93/grokstat.svg)](https://travis-ci.org/vorot93/grokstat)

[![Docker Pulls](https://img.shields.io/docker/pulls/vorot93/grokstat.svg)](https://hub.docker.com/r/vorot93/grokstat/)

Retrieves information about game servers. Inspired by [QStat](https://github.com/multiplay/qstat), written in Go. Yet even more simple, extensible and fast.

GrokStat accepts input data as JSON via stdin. The result is displayed in JSON form as well. In order to run a simple query you need to specify protocol and array of hosts to check. Please refer to the example below for more information.

The server query is asynchronous, done via inbuilt UDP server.

## Protocols

M stands for master server support. S stands for individual game server query support.

### Supported

- **M** **S** | Quake-derived games:

 - Quake II

 - Quake III

 - Xonotic

 - OpenArena

 - Warsow

 - Unvanquished

 - Soldiers of Fortune 2

- **M** **S** | OpenTTD

- **M** **S** | Teeworlds

- **M** **S** | Steam / SourceQuery

- **S** | Mumble

## Get it

### Docker (simple)

GrokStat project ships Docker images containing precompiled GrokStat, runnable out-of-the-box.

#### Install / update

    docker pull vorot93/grokstat

#### Run

    docker run -it --rm vorot93/grokstat 

### Manual

In addition to using docker you can compile and run manually.

#### Dependencies

    go get -u github.com/BurntSushi/toml github.com/jteeuwen/go-bindata/...

#### GrokStat itself

    git clone https://github.com/grokstat/grokstat.git

    cd grokstat && make build

    bin/grokstat

## Example

### Query servers

	docker run --rm grokstat/grokstat '{"hosts": {"openttdm": ["master.openttd.org:3978"], "q3m": ["master3.idsoftware.com"]}}'

or

    echo '{"hosts": {"openttdm": ["master.openttd.org:3978"], "q3m": ["master3.idsoftware.com"]}}' | bin/grokstat

or

	bin/grokstat '{"hosts": {"openttdm": ["master.openttd.org:3978"], "q3m": ["master3.idsoftware.com"]}}'

Always mind the single quotes.

### Review available protocols

    docker run --rm grokstat/grokstat '{"show-protocols": true}'

or

    echo '{"show-protocols": true}' | bin/grokstat

## License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.