mcping 0.2.0

Get statuses from Minecraft servers

mcping

Get statuses from Minecraft servers.

Difference between this and mcstatus

This package uses some classes and functions from mcstatus.

Unlike mcstatus, this package will only attempt to handshake and get the status. It doesn't do any DNS lookups or pings that aren't strictly required to get the status.

This package also doesn't convert the status response into a series of nested classes, which should make the results much easier to work with, especially when dealing with non-standard status responses (eg. Forge mod lists).

A side effect of this is that there isn't any guarantee that the status response will have all of the keys that it should, meaning you'll need to do some validation before assuming that keys are present, or that they're the types you think.

Docs

Documentation is available at https://mcping.readthedocs.io.

Installation

If you want to use the library, install with pip:

pip install mcping

If you only want the CLI, pipx is recommended:

pipx install mcping

Use

Library

import mcping

# Synchronous
mcping.status('127.0.0.1')

# Asynchronous
async def main():
    await mcping.async_status('127.0.0.1')

CLI

The package also includes a CLI to get server statuses. It can be run from a cloned repo using the cli.py file:

python3 cli.py example.com
python3 cli.py example.com:25565

If the library is installed, the mcping script should also be installed and available globally:

mcping example.com
mcping example.com:25565

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Some code in mcping/__init__.py is modified from the mcstatus project's code, licensed under the Apache License, Version 2.0.