rcon

An RCON protocol client implementation.

Requirements

rcon requires Python 3.8 or higher.

Documentation

Documentation is available on readthedocs.

Installations

Install rcon from the AUR or via:

pip install rcon

Quick start

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

from rcon import Client

with Client('127.0.0.1', 5000) as client:
    client.login('mysecretpassword')    # Perform initial login.
    seed = client.seed                  # Get the server's seed.
    players = client.players            # Get the server's players info.
    mansion = client.locate('Mansion')  # Get the next mansion's location.

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

License

Copyright (C) 2018-2020 Richard Neumann

rcon 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.

rcon 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 rcon. If not, see http://www.gnu.org/licenses/.