mctools 1.0.0

Minecraft connection tools

Minecraft Connection Tools

A python implementation for interacting with Minecraft servers.

Introduction

mctools allows you to interact with Minecraft servers via rcon, query, and server list ping protocol.

This allows you to the following:

• Send and receive Minecraft server commands
• Get player count(max and currently playing)
• Get server version
• Get the message of the day
• Get currently installed plugins
• And much more!

All of this can be achieved using simple, intuitive calls to mctools. mctools does all the heavy lifting for you! Also, mctools has no external dependencies(Unless you are a windows user and need color support), and only uses the python standard library. Just download and go!

Example

Send a command to the Minecraft server via rcon:

from mctools import RCONClient  # Import the RCONClient

HOST = 'mc.server.net'  # Hostname of the Minecraft server
PORT = 1234  # Port number of the RCON server

# Create the RCONClient:

rcon = RCONClient(HOST, port=PORT)

# Login to RCON:

if rcon.login("password"):

    # Send command to RCON - broadcast message to all players:

    resp = rcon.command("broadcast Hello RCON!")

Instillation

You can install mctools via pip:

$ pip install mctools

If you are a windows user and want color support, then install mctools like so:

$ pip install mctools[color]

For more information on installing mctools, check out the instillation section in our documentation.

Formatting

mctools has support for handling Minecraft formatting codes. You can decide weather mctools replaces formatting charcters with intended values, removes them, or leaves them be.

For example, lets say you received the following content during a rcon session:

§e--------- §fHelp: Index (1/40) §e--------------------
§7Use /help [n] to get page n of help.
§6Aliases: §fLists command aliases
§6Bukkit: §fAll commands for Bukkit
§6ClearLag: §fAll commands for ClearLag
§6Essentials: §fAll commands for Essentials
§6LuckPerms: §fAll commands for LuckPerms
§6Minecraft: §fAll commands for Minecraft
§6Vault: §fAll commands for Vault
§6WorldEdit: §fAll commands for WorldEdit

As you can see, this text is somewhat hard to read. If you told mctools to remove the formatting characters, then the output will look like this:

--------- Help: Index (1/40) --------------------
Use /help [n] to get page n of help.
Aliases: Lists command aliases
Bukkit: All commands for Bukkit
ClearLag: All commands for ClearLag
Essentials: All commands for Essentials
LuckPerms: All commands for LuckPerms
Minecraft: All commands for Minecraft
Vault: All commands for Vault
WorldEdit: All commands for WorldEdit

Much easier to read and process. mctools handles this operation automatically, so you don't have to. mctools also handels situations where content is sent in ChatObject notation, and can extract messages from the player sample list.

To learn more about formatters, and how to create your own, then please check out the formatting documentation.

Command line tool

mctools is shipped with a CLI front end called mcli, which you can use to start rcon sessions, get stats via query/ping, check if a Minecraft server is up, ect.

After installing mctools(through pip or setuptools), you can invoke mcli like so:

$ mcli --help

You can also run mcli.py(which is located in the parent directory) if you downloaded the source code and did not install via pip/setuptools.

This will generate the help menu for mcli. To learn more about mcli, please check out the mcli documentation.

Documentation

mctools has an extensive documentation. It contains tutorials, the API reference, and best practice recommendations. You can find the documentation here.

Be sure to also check out the mctools PyPi page for more information.

Conclusion

mctools offers a pythonic, reliable way to interact with Minecraft servers, without being too complicated. If you have any questions or issues, then please open an issue. Pull requests of any kind a welcome and encouraged!

Thank you for reading!