mcc.py 0.0.16

Python bindings for controlling the Minecraft Console Client Websocket bot

mcc.py

A Python module for controlling Minecraft Console Client Webhook bots

Getting started

Currently an example script is provided as "example.py", it has very limited usage currently and is only able to send commands and receive their responses

Design

Interface roughly based on MCC.JS

Dealing with concurrency

There are effectively two queues, one for sending messages and one for receiving them They are not designed to be directly accessed, and have methods to allow for interacting with them in a way that is easier to use.

EXPERIMENTAL

This library is currently purely experimental, as it relies on experimental features of Minecraft Console Client. It may break with no warning due to changes that are not under the control of the maintainer.

My main goal is to play with the technologies and ideas, so this repo may not be maintained in the future.

Commands

To save time the command are auto generated from the Minecraft-Console-Client docs, using generate_commands.py.

Debugging

Unit tests have been scaffolding, but still need a lot better coverage currently Integration tests are not currently working E2e tests work, but require a modified MinecraftClient binary

To change the timeout of the function "wait_for_response" (used for waiting for the response to a command) set the environment variable "TIMEOUT".

Roadmap

[ ] Write e2e Robot Framework tests for the commands [ ] Test the tests [ ] Setup Github pipelines to run the tests automatically

Currently undecided

[ ] Publish the package to PyPi [ ] Publish the container to DockerHub

Useful links

Documentation that proved useful: https://websockets.readthedocs.io/en/stable/index.html