rconx

rconx is a Python library for communicating with TCP servers that use the Source RCON packet format. It provides synchronous and asynchronous clients for authentication and command execution, together with servers for exposing an application's own command handlers over RCON.

The clients collect command results using selectable presets, including SRCDS, Minecraft, and Cuberite. Low-level clients and servers are available for applications that need to exchange individual RCON packets. The command-line interface executes commands from a terminal or script.

Installation

rconx supports Python 3.8 and later, with best-effort compatibility for Python 3.6 and 3.7. The examples below use Python 3.8 or later.

rconx is available on PyPI:

python -m pip install rconx

Quick start

Application code should import public APIs directly from rconx. Only these public exports are guaranteed to remain stable across releases. Internal modules such as rconx.client are outside this guarantee.

These examples execute list on a Minecraft server with RCON enabled.

Synchronous

import rconx

response = rconx.execute('127.0.0.1', 25575, 'list', password='MY_PASSWORD', preset='minecraft')
print(response.text)

Asynchronous

import asyncio

import rconx


async def main():
    response = await rconx.execute_async('127.0.0.1', 25575, 'list', password='MY_PASSWORD', preset='minecraft')
    print(response.text)


asyncio.run(main())

Documentation

• The client guide describes client usage, presets, command results, and error handling. It also records compatibility and testing status for individual servers.
• The server guide describes business callbacks, connection handling, and service lifecycle.
• The command-line guide describes installation, command execution, interactive mode, and output handling.

License

rconx is licensed under LGPL-3.0-only.