Skip to content

An asynchronous RCON client/wrapper for Minecraft Java Edition

License

Notifications You must be signed in to change notification settings

Iapetus-11/aio-mc-rcon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aio-MC-RCON Code Quality PYPI Version PYPI Downloads

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

Installation

pip install -U aio-mc-rcon

Example Usage

Documentation

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 server.properties 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.