{"id":13735892,"url":"https://github.com/vorot93/grokstat","last_synced_at":"2025-03-18T19:32:56.939Z","repository":{"id":87661268,"uuid":"47505577","full_name":"vorot93/grokstat","owner":"vorot93","description":"Fast game server query tool","archived":false,"fork":false,"pushed_at":"2017-02-10T19:57:53.000Z","size":125,"stargazers_count":27,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-11T12:47:38.640Z","etag":null,"topics":["game-server","golang","query"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vorot93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-12-06T17:04:28.000Z","updated_at":"2025-01-21T10:18:28.000Z","dependencies_parsed_at":"2023-03-13T18:40:12.116Z","dependency_job_id":null,"html_url":"https://github.com/vorot93/grokstat","commit_stats":null,"previous_names":["grokstat/grokstat"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vorot93%2Fgrokstat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vorot93%2Fgrokstat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vorot93%2Fgrokstat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vorot93%2Fgrokstat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vorot93","download_url":"https://codeload.github.com/vorot93/grokstat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243945561,"owners_count":20372897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["game-server","golang","query"],"created_at":"2024-08-03T03:01:12.647Z","updated_at":"2025-03-18T19:32:51.929Z","avatar_url":"https://github.com/vorot93.png","language":"Go","funding_links":[],"categories":["Software"],"sub_categories":["Network-related software"],"readme":"# GrokStat\n[![Build Status](https://img.shields.io/travis/vorot93/grokstat.svg)](https://travis-ci.org/vorot93/grokstat)\n[![Docker Pulls](https://img.shields.io/docker/pulls/vorot93/grokstat.svg)](https://hub.docker.com/r/vorot93/grokstat/)\n\nRetrieves information about game servers. Inspired by [QStat](https://github.com/multiplay/qstat), written in Go. Yet even more simple, extensible and fast.\n\nGrokStat 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.\n\nThe server query is asynchronous, done via inbuilt UDP server.\n\n## Protocols\nM stands for master server support. S stands for individual game server query support.\n\n### Supported\n- **M** **S** | Quake-derived games:\n - Quake II\n - Quake III\n - Xonotic\n - OpenArena\n - Warsow\n - Unvanquished\n - Soldiers of Fortune 2\n- **M** **S** | OpenTTD\n- **M** **S** | Teeworlds\n- **M** **S** | Steam / SourceQuery\n- **S** | Mumble\n\n## Get it\n### Docker (simple)\nGrokStat project ships Docker images containing precompiled GrokStat, runnable out-of-the-box.\n#### Install / update\n    docker pull vorot93/grokstat\n#### Run\n    docker run -it --rm vorot93/grokstat \u003cjson-input\u003e\n### Manual\nIn addition to using docker you can compile and run manually.\n#### Dependencies\n    go get -u github.com/BurntSushi/toml github.com/jteeuwen/go-bindata/...\n#### GrokStat itself\n    git clone https://github.com/grokstat/grokstat.git\n    cd grokstat \u0026\u0026 make build\n    bin/grokstat\n\n## Example\n### Query servers\n\tdocker run --rm grokstat/grokstat '{\"hosts\": {\"openttdm\": [\"master.openttd.org:3978\"], \"q3m\": [\"master3.idsoftware.com\"]}}'\n\nor\n\n    echo '{\"hosts\": {\"openttdm\": [\"master.openttd.org:3978\"], \"q3m\": [\"master3.idsoftware.com\"]}}' | bin/grokstat\n\nor\n\n\tbin/grokstat '{\"hosts\": {\"openttdm\": [\"master.openttd.org:3978\"], \"q3m\": [\"master3.idsoftware.com\"]}}'\n\nAlways mind the single quotes.\n### Review available protocols\n    docker run --rm grokstat/grokstat '{\"show-protocols\": true}'\n\nor\n\n    echo '{\"show-protocols\": true}' | bin/grokstat\n\n## License\nThis 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.\n\nThis 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvorot93%2Fgrokstat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvorot93%2Fgrokstat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvorot93%2Fgrokstat/lists"}