mctools 1.2.0

Python implementations of common Minecraft protocols.

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 do 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!")

Installation

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 characters 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 handles 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.

MCLI - mctools Command Line Interface

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.

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

We supply mcli as an executable built using pyinstaller under releases for windows systems that don't have python installed. The exe file provided may be buggy or have some weird quirks, so it is recommended to invoke mcli via python.

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.

Bug Reports

If you encounter a bug or any other event that does not seem normal, then please open an issue, or email me personally. I will be sure to get back to you as soon as possible.

Your feedback and reports are appreciated! Your comments and issues are an excellent way to correct issues with mctools.

Contributing

Pull requests are welcome and encouraged :) ! If you want to see a feature in mctools, a PR will be the quickest way to get it included. Feel free to email me or open an issue if you have any problems.

If you are interested in helping in the development of mctools, then send me an email, and we can get talking! Believe me, there is plenty of work that needs to be done. More help would be greatly appreciated!

Changelog

1.2.0

Clients (of any type!) can now be started after being stopped, so creating a new client after stopping it is no longer necessary.

The PINGClient will now auto stop itself after each operation.

Fixed a bug where the QUERYClient did not auto-start itself.

The documentation was updated to reflect these changes, and it now explains stopping/starting clients a lot better.

1.1.2

Fixed an issue where RCON command size handling was broken. Before, the remote server would kill the connection if a command is too large(Bigger than 1460 bytes). We now raise a new exception, 'RCONLengthError' and refuse to send the packet if the command is too big, thus keeping the connection alive. You can optionally disable this check, although this is not recommended.

The documentation has also been updated to make this limitation more clear, as well as correcting some minor errors, mostly correcting examples in the formatting documentation.

We also added some type hinting, as some IDEs were complaining about type mismatches.

1.1.1

Fixed an issue where clients hang when the connection is closed by the remote host.

New features mentioned in the previous changelog are still coming, albeit slowly!

1.1.0

This update adds some minor features and fixes some major bugs:

Bug Fixes:

• Fixed RCON packet fragmentation issue, mctools should now properly detect and handle RCON packet fragmentation
• Fixed bug where PINGFormatter was looking for 'dark_grey' instead of 'dark_gray'
• Fixed bug where ChatObjectFormatter did not properly parse ChatObjects
• We now raise an exception if the RCON write data is too big, instead of leaving the connection in a unstable state

Features Added:

• Users can now specify the format method on a per-call basis
• Users can change the timeout value after the object is instantiated
• The RCON login check feature can be disabled, meaning that you can attempt to send packets even if you are not authenticated
• Clients can now return raw packets
• RCON now has custom exceptions

This update is a prelude to another update I have working on. The next update will add numerous features, such as:

• RCON Mixins for easing the process of getting/editing the following info:
  • Players connected
  • World Seed
  • Game Rules
  • Target Selectors
  • Many more...
• Custom exceptions for Ping and Query
• Even Better error handling
• mcli RCON command/argument autocompletion
• Custom datatypes for all operations
• RCON SSH Forwarding support (You can technically do this as of now, but I want the library to invoke and handle this process) for a more secure RCON experience
• Unit tests for mctools

I have some of these complete as of now, but I wanted to push out the big bug fixes and minor stuff before I finish creating and refining the features, as they may take me some time to implement.

All of these features will be completely optional, and they will all be backwards compatible. So if you like the library as it is now, then you can completely ignore these new features.

The documentation has been updated to reflect these changes.

Conclusion

mctools offers a pythonic, reliable way to interact with Minecraft servers, without being too complicated. Please check the documentation for more information. More features (hopefully) coming soon!

Thank you for reading!