MChat

A console chat client for most Minecraft server versions. This project is a combination of @ammaraskar's PyCraft client library, and @willmcgugan's rich text library for Python.

Installation

From PIP

# Install PyCraft
python3 -m pip install https://github.com/ammaraskar/pyCraft.git

# Install MChat
python3 -m pip install mchat

From Source

To install from source using the Poetry build tool and pyenv, clone this repository, then run:

pyenv install 3.9.0
pyenv local 3.9.0
poetry install

Usage

MChat can be run as mchat if installed from PIP or as poetry run python3 -m mchat if running from the GIT repo.

Usage is as follows:

usage: mchat [-h] [-p PORT] [-u USERNAME] [-v VERSION] server_address

A console chat client for most Minecraft server versions

positional arguments:
  server_address        IP address of a Minecraft server

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  Minecraft server port (default: 25565)
  -u USERNAME, --username USERNAME
                        Minecraft username or email
  -v VERSION, --version VERSION
                        Client -> Server protocol version to use (default: 1.16.4)

You will be prompted for a username (if not passed as an argument), and password when running the program.

FAQ

Are colors configurable?

No. Terminal colors are not directly configurable from this program, as server-sent formatting data is fed directly into the rich text formatter. Your terminal emulator may allow you to customize your pallette though.

What Minecraft versions are supported?

Anything supported by PyCraft. Entering an invalid version when running mchat will tell you what is supported by the version of PyCraft you have installed. For example, this is the result at the time of writing:

$ mchat -v 0.0.0 example.com
0.0.0 is not a valid Minecraft version. Versions from 1.7.2 to 20w48a are allowed.

You can update PyCraft from PIP to pull in new version support as needed.

Screenshots

Demo on mcctf.com