An async library for utilizing remote console on Minecraft Java Edition servers
Project description
Aio-MC-RCON
An asynchronous RCON client/wrapper written in Python for Minecraft Java Edition servers!
Installation
pip install -U aio-mc-rcon
Example Usage
- See the examples folder.
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 underrcon.password
in theserver.properties
file.
- Methods:
connect(timeout: int = 2)
- wheretimeout
has a default value of 2 seconds.send_cmd(cmd: str, timeout: int = 2)
- wherecmd
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
Release history Release notifications | RSS feed
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.1.tar.gz
(3.9 kB
view hashes)
Built Distribution
Close
Hashes for aio_mc_rcon-3.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5941a6fe8f642d2cfb77f991201a63f0ce4ecdbd1e901fd7287542b6897bb913 |
|
MD5 | e6337dd8bfe660031ef4e4474e6f61da |
|
BLAKE2b-256 | bb7d55f3f60421b8bb9ccfce1397bebbcf8ee88c78eed016b3ad9187507d83f5 |