275fb7d4cd
* feat: add initial crates readmes * feat: add initial CLI readme * fix: some links * feat: fix node badge, split changelogs, fix some other links add docs in cli * feat: feature the gamedig site in the lib * feat: fill in cli package fields * feat: set CLI version to 0.1.0 * feat: update changelogs to set vers * feat: update the release workflow
2.8 KiB
rust-GameDig CLI
The official rust-GameDig Command Line Interface.
Community
Checkout the GameDig Community Discord Server here.
Note that it isn't be a replacement for GitHub issues, if you have found a problem
within the library or want to request a feature, it's better to do so here rather than
on Discord.
Usage
Just by running gamedig-cli prints the usage.
Note: Passing --help (or -h) shows the usage.
Here's also a quick rundown of a simple query with the json-pretty format:
Pick a game/service/protocol (check the GAMES, SERVICES and PROTOCOLS files to see the currently supported ones), provide the ip and the port (be aware that some game servers use a separate port for the info queries, the port can also be optional if the server is running the default ports) then query on it.
Team Fortress 2 query example:
gamedig-cli query -g teamfortress2 -i 127.0.0.1 -f json-pretty
What we are doing here:
-g(or--game) specifies the game.-i(or--ip) target ip.-f(or--format) our preferred format.
Note: We haven't specified a port (via -p or --port), so the default one for the game will be used (27015 in this case).
Response (note that some games have a different structure):
{
"name": "A cool server.",
"description": null,
"game_mode": "Team Fortress",
"game_version": "8690085",
"map": "cp_foundry",
"players_maximum": 24,
"players_online": 0,
"players_bots": 0,
"has_password": false,
"players": []
}
Documentation
The documentation is available at docs.rs.
Curious about the history and what changed between versions? Everything is in the CHANGELOG file.
Contributing
Please read CONTRIBUTING.