Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A Minecraft server inter-process communication library.

Project description

Documentation Status Quality Gate Status

mcipc

A Minecraft inter-process communication API implementing the RCON and Query protocols.

News

2020-12-21 - mcipc-2.0

Great news: mcipc is now available in version 2. The version 2 update includes the outsourcing of the RCON protocol and client implementation into an own project. This allowes for the RCON library to be used independently of mcipc, e.g. for other games which support the RCON protocol. Furthermore mcipc's RCON client implementations have been overhauled. They now provide functions to interact with the respective server. It was therefor necessary to not have one implementation of mcipc.rcon.Client, but three:

  • mcipc.rcon.be.Client Client for Bedrock Edition servers.
  • mcipc.rcon.ee.Client Client for Education Edition servers.
  • mcipc.rcon.je.Client Client for Java Edition servers.

To provide some backwards compatibility, the mcipc.rcon.Client is now an alias for mcipc.rcon.je.Client. You'll find a full documentation of each client's capabilities, i.e. methods in the documentation.

Requirements

mcipc requires Python 3.9 or higher. It also depends on rcon which has been split from this project. If you install mcicp via pip, it will automatically be installed as a dependency.

Documentation

Documentation is available on readthedocs.

Quick start

Install mcipc from the AUR or via:

pip install mcipc

Query protocol

The Query protcol is used to query a Minecraft server for server information. The Minecraft query protocol has two query modes: basic stats and full stats.

from mcipc.query import Client

with Client('127.0.0.1', 25565) as client:
    basic_stats = client.stats()            # Get basic stats.
    full_stats = client.stats(full=True)    # Get full stats.

print(basic_stats)
print(full_stats)

RCON protocol

The RCON protocol is used to remotely control a Minecraft server, i.e. execute commands on a Minecraft server and receive the respective results.

from mcipc.rcon.je import Biome, Client     # For Java Edition servers.
#from mcipc.rcon.be import Client           # For Bedrock Edition servers.
#from mcipc.rcon.ee import Client           # For Education Edition servers.

with Client('127.0.0.1', 5000, passwd='mysecretpassword') as client:
    seed = client.seed                              # Get the server's seed.
    players = client.list()                         # Get the server's players info.
    mansion = client.locate('mansion')              # Get the next mansion's location.
    badlands = client.locatebiome(Biome.BADLANDS)   # Get the next location of a badlands biome.

print(seed)
print(players)
print(mansion)
print(badlands)

Example output of the above commands with a Java Edition client:

-8217057902979500137
Players(online=1, max=20, players=[Player(name='coNQP', uuid=None, state=None)])
Location(name='mansion', x=-7216, y=None, z=-1952, distance=7479)
Location(name='minecraft:badlands', x=1512, y=None, z=3388, distance=3634)

Credits

Many thanks to all contributers to the Minecraft Wiki and the Wiki.vg.

License

Copyright (C) 2018-2021 Richard Neumann <mail at richard dash neumann period de>

mcipc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

mcipc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with mcipc. If not, see http://www.gnu.org/licenses/.

Legal

Minecraft content and materials are trademarks and copyrights of Mojang and its licensors. All rights reserved. This program is free software and is not affiliated with Mojang.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mcipc, version 2.3.3
Filename, size File type Python version Upload date Hashes
Filename, size mcipc-2.3.3-py3-none-any.whl (125.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mcipc-2.3.3.tar.gz (102.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page