This library is designed to control a Minecraft Java Server, such as Spigot or Paper running the mcproto plugin, with Python.
This library is heavily inspired by MCPI (and its corresponding plugin RaspberryJuice) and attempts a more modern approach for communication between server and client that also works for more modern versions of Minecraft.
This library uses Protocol Buffers and the gRPC library and protocols to communicate with the plugin on the server.
Due to the use of the new type annotations Python 3.10+ is required!
The versioning in this project looks a bit funny, but is very simple:
- The first 4 numbers of the version indicate the plugin version this library is compatible with.
- And the final number is this libraries patch number, which is incremented after smaller patches or quality of life changes that are independent of the plugin.
For example, the library version number 1.18.2.1.X would require the mcproto plugin version 1.18.2.1 or newer -
that is, this library should work for newer versions of the plugin if everything works out and no breaking changes are introduced.
On the other hand, the library will most likely not work for older versions of the plugin.
TLDR; make sure the first 4 numbers of the library version are the same as the plugin's and choose the last number as high as possible.
The library is currently not on PyPI. The package may be published there in the future.
You may instead install this package directly by using pip install git+https://github.com/icezyclon/mcproto-python.git@main to install it directly from Github (git is required for this).
If you cloned the repository already then pip install . can be used.
The library can be added as a requirement to requirements.txt like so:
mcproto @ git+https://github.com/icezyclon/mcproto-python.git@main
Building the library locally can be done by using python -m build, which will build the wheel and dist packages in dist/*.
Afterwards the tar file can be installed with pip: pip install mcproto-0.0.0.0.0.tar.gz.
If you want to play around with the library itself you can also clone the repository as git submodule.
The entire library is very much a work-in-progress, so there is still a lot to do!
Note: The intent behind the chosen license, is to allow the licensed software to be used (as is) in any type of project, even commercial or closed-source ones. However, changes or modifications to the licensed software itself must be shared via the same license openly. Checkout this blog for an in-depth explanation.