Skip to main content

An async library for utilizing remote console on Minecraft Java Edition servers

Project description

Aio-MC-RCON Code Quality PYPI Version PYPI Downloads

An asynchronous RCON client/wrapper written in Python for Minecraft Java Edition servers!


pip install -U aio-mc-rcon

Example Usage


class aiomcrcon.Client(host: str, port: int, password: str):

  • Arguments:
    • host: str - The hostname / ip of the server to connect to.
    • port: int - The port of the server to connect to.
    • password: str - The password to connect, can be found as the value under rcon.password in the file.
  • Methods:
    • connect(timeout: int = 2) - where timeout has a default value of 2 seconds.
    • send_cmd(cmd: str, timeout: int = 2) - where cmd is the command to be executed on the server and timeout has a default value of 2 seconds.
    • close() - closes the connection between the client and server.

exception aiomcrcon.RCONConnectionError

  • Raised when the connection to the server fails.

exception aiomcrcon.IncorrectPasswordError

  • Raised when the provided password/authentication is invalid.

exception aiomcrcon.ClientNotConnectedError

  • Raised when the connect() method hasn't been called yet, and commands cannot be sent.

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

aio_mc_rcon-3.2.2.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

aio_mc_rcon-3.2.2-py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page