Skip to main content

This library provides a straightforward implementation of Minecraft’s Rcon protocol in Python to provide a client for handling Remote Commands (RCON) to a Minecraft server.

Installation

The library is availble on PYPI and can be installed with pip:

pip install mcrcon

Usage

The recommend way to run this client is using the python ‘with’ statement. This ensures that the socket is correctly closed when you are done with it rather than being left open.

Example:

In [1]: from mcrcon import MCRcon
In [2]: with MCRcon("10.1.1.1", "sekret") as mcr:
   ...:     resp = mcr.command("/whitelist add bob")
   ...:     print(resp)

While you can use it without the ‘with’ statement, you have to connect manually, and ideally disconnect:

In [3]: mcr = MCRcon("10.1.1.1", "sekret")
In [4]: mcr.connect()
In [5]: resp = mcr.command("/whitelist add bob")
In [6]: print(resp)
In [7]: mcr.disconnect()

Command Line Usage

After installing the package a cli will be included that can be used.

Help can be gotten by doing:

mcrcon --help

You can connect from the console with commands like the following:

mcrcon 10.1.1.1

You will either be prompted for your password, or you can set it as follows as an environment variable:

export RCON_PASSWORD=sekret

And then you can run commands on the server interactively:

> /whitelist add bob

Release files for mcrcon 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mcrcon 0.7.0
File Size Uploaded
mcrcon-0.7.0.tar.gz 4.2 kB Details

Release files / mcrcon-0.7.0.tar.gz

Download URL mcrcon-0.7.0.tar.gz
Size 4.2 kB
Tags Source
SHA-256 checksum
How to use checksums
c2f1caf2467e283e0ccd2436f1ce21f04242b03c5fafb3860e3924d764a910d4
BLAKE2b-256 checksum
How to use checksums
77486aa55387b45cb8f8c69c4034b3438bb5c5b89e45d975ff60539e9ae7d8b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.11

Release history Release notifications | RSS feed

This release

0.7.0 This release

1 release file

0.6.0

1 release file

0.5.2

1 release file

0.5.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page