Python bindings for controlling the Minecraft Console Client Websocket bot
Project description
mcc.py
A Python module for controlling Minecraft Console Client Webhook bots
Getting started
Beforehand note that this library only provides bindings/ for the Minecraft Console Client WebSocket bot, it does not provide the functionality to connect to a minecraft server on its own.
You will need to have Minecraft Console Client setup with the "Websocket" bot enabled. Installation Usage It is recommended to run MCC without config, so that the default config file gets created where you can then set the server ip that you want, and enable the Websocket bot (at the bottom of the config).
Install this module via pip: pip install mcc.py
An example of the usage of this library can be found in the file example.py
.
For more advanced usage, there are a number of scenarios in the tests
folder,
including end to end tests which show server, Minecraft Console Client and a Robot
Framework library, which uses mcc.py to control a player on the server that is hosted.
These are run on Github Actions.
Design
Interface roughly based on MCC.JS
Additions to the base design
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.
Useful links
Documentation that proved useful: https://websockets.readthedocs.io/en/stable/index.html
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mcc_py-0.0.23.tar.gz
.
File metadata
- Download URL: mcc_py-0.0.23.tar.gz
- Upload date:
- Size: 11.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | eeb576821cdabd9ae0b1264df917d2d5b5cad066b52547baac74c53da8eb8d96 |
|
MD5 | ea08254151150f044b65ed4856137031 |
|
BLAKE2b-256 | 8aec9e4b8ad4824ca056e19f853e93acf82b4287292d78705be8e327e43dbeef |
File details
Details for the file mcc.py-0.0.23-py3-none-any.whl
.
File metadata
- Download URL: mcc.py-0.0.23-py3-none-any.whl
- Upload date:
- Size: 24.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2659208e46816466e2142978ac2e451898e7b7c0779a0e54f459c02bf41a90cc |
|
MD5 | 08842657b7d6a40936bad557a4488713 |
|
BLAKE2b-256 | 3e2edf2efd613b6a0b6f7d78b23dcb683b129bec613c099d6d3f47ff22f3c395 |