# CraftPinger

CraftPinger is a simple, command-line program to see if any minecraft servers have friends online, without having to open the game. It's primarily useful when you have multiple servers across multiple instances of the game, especially large modpacks that can take several minutes to load. I was primarily motivated to make this because most other tools for this purpose are only hosted as web tools, and thus cannot be configured at all, while also having no guarantees against tracking.

## USAGE

The config file is located at $HOME/.config/craftpinger/config.toml. Servers are added to the list to scan by adding to the list `[[servers]]`, as demonstrated by the two examples in the file.

To use, simply run `craftpinger` from the terminal. By default, servers with no players online will be hidden from the list; to change this, set `show_empty_servers` to `true` in the config file.

By default, the timeout for the request is 5 seconds; to change this, use `-t` or `--timeout`. Run `craftpinger --help` for details.

For scripts, consider spawning a new thread ahead of time to avoid blocking on network responses.

## DEPENDENCIES

To run, no dependencies are needed except a stable internet connection. Cargo is required in order to build from source.

## LICENSE

CraftPinger is licensed under the MIT license.