Changelog

v2.0.0

This is a major rewrite of the library to increase the flexibility and re-usability of components. Many new abstractions have been introduced between the protocol, I/O layers, and the client.

Breaking Changes

• Packet and its subclasses are now only available through the berconpy.protocol package

• Packet.message property now returns bytes

• Packet.from_bytes() no longer raises IndexError

• ServerCommandPacket now raises ValueError when total is 0 or index is out of bounds

• AsyncRCONClient.client_id has been renamed to admin_id

• RCONClientDatagramProtocol is now replaced with AsyncClientConnector

• The protocol_cls parameter for AsyncRCONClient has been replaced with protocol and must take an AsyncClientProtocol instance

New Features

• Add Sans-I/O client and server implementations of the RCON protocol:

  • RCONGenericProtocol

  • RCONClientProtocol

  • RCONServerProtocol

• Add Sans-I/O base classes, inherited by their original asyncio components:

  • RCONClient

  • Ban

  • Player

• Allow customization of the client cache by using a subclass of RCONClientCache

• Allow customization of keep alive messages, reconnect parameters, and command handling for AsyncClientConnector using ConnectorConfig and AsyncCommander

• Add send/receive support for UTF-8 encoding

  Despite the BattlEye RCON protocol specifying that payloads be encoded in ASCII, RCON servers are willing to send UTF-8 encoded text back. As such, this library will begin processing strings in UTF-8.

• Improve validation of server responses to commands

  • Indexes must be within range

  • Indexes must not be repeated

  • Total must be consistent across associated packets

Bug Fixes

• Fix Ban.index not actually being stored as an integer

Miscellaneous

• Show full traceback for malformed data being received when using DEBUG logging level

• Add this changelog to the documentation

v1.1.1

Bug Fixes

• Fix AttributeError when attempting to convert a Ban instance into a string

Miscellaneous

• Rename the Getting Started page to Introduction

• Add section about logging in the Introduction guide

• Clean up table of contents

• Fix docs/ Makefile building in the wrong directory

v1.1.0

Bug Fixes

• Fix the user’s current task being cancelled when AsyncRCONClient.close() is called

Documentation

• Add Getting Started guide

• Add various clarifications and examples throughout the API reference

v1.0.0.post1

This version comes with a new online documentation providing an Event Reference and API reference for the various classes and methods in the library.

v1.0.0

This is the first release to be published on PyPI!

Breaking Changes

• Cancel the current task when the connection stops

  This prevents the body of async with client.connect(): continuing to run, even if the client is no longer running.

• Remove the name parameter from AsyncRCONClient

  This attribute is probably no longer necessary for logging purposes.

Bug Fixes

• Fix AsyncRCONClient.wait_for() hanging when the predicate returns False

• Fix potential InvalidStateError when a command times out and receives a response at the same time

• Fix protocol not resetting its own state when an error occurs

• Fix protocol silently failing due to an OSError (GH-2)

• Fix BattlEye kicks for players without GUIDs not being parsed correctly

Miscellaneous

• Tweak logging levels used during protocol’s lifetime

• Wait for three seconds before applying exponential backoff during a connection (re)attempt

v0.2.1

New Features

• Add facade methods to AsyncRCONClient:

  • is_running()

  • is_connected()

  • is_logged_in()

Miscellaneous

• Minor docstring tweaks for AsyncRCONClient

v0.2.0

Breaking Changes

• Refactor the Packet into refinement types:

  • ClientPacket

  • ClientLoginPacket

  • ClientCommandPacket

  • ClientMessagePacket

  • ServerPacket

  • ServerLoginPacket

  • ServerCommandPacket

  • ServerMessagePacket

  These classes improve type inference, reduces their constructor signatures, and help self-document what kind of packets are expected to be sent around each internal method.

• Packet.from_bytes() can now raise IndexError

• Packet constructor now raises ValueError when exceeding max packet size

New Features

• Use sequence number from server messages to avoid re-triggering on_message events in case of network instability

• Add berconpy.ext namespace package for third-party extension support

• Add berconpy.ext.arma extension containing an AsyncArmaRCONClient subclass with methods specific to the Arma game series

• Add new events:

  • on_admin_login(admin_id, addr)

  • on_player_connect(player)

  • on_player_guid(player)

  • on_player_verify_guid(player)

  • on_player_disconnect(player_id, name)

  • on_player_kick(player, reason)

  • on_admin_message(admin_id, channel, message)

  • on_admin_announcement(admin_id, message)

  • on_admin_whisper(player, admin_id, message)

  • on_player_message(player, channel, message)

• Add Player class and player cache to the client, accessed with the AsyncRCONClient.players property and the get_player() method

• After successfully connecting once, AsyncRCONClient will indefinitely attempt to reconnect when the connection is lost

• Exponential backoff to reduce excessive connection attempts

• New exceptions have been added to replace ValueError and RuntimeError in various locations:

  • RCONError

  • LoginFailure

  • RCONCommandError

• Add AsyncRCONClient.client_id property

• Add new methods to AsyncRCONClient:

  • ban()

  • fetch_admins()

  • fetch_bans()

  • fetch_missions()

  • fetch_players()

  • kick()

  • send()

  • unban()

  • whisper()

• Add a Ban dataclass which is returned by AsyncRCONClient.fetch_bans()

Bug Fixes

• Fix RuntimeError when sending a command fails on the first attempt

• Fix protocol hanging indefinitely when the server times out

• Fix temporary listeners not being removed after they are invoked

• Fix AttributeError when protocol closes before having connected

• Fix potential asyncio.CancelledError when calling AsyncRCONClient.send_command()

• Fix protocol parsing messages from addresses other than the connected server

• Fix protocol not acknowledging messages when reconnecting

• Fix on_command event potentially being called more than once for multiple responses to the same command

Miscellaneous

• Add logging configuration to repl.py

• Add repr to AsyncRCONClient

v0.1.0

New Features

• Finish implementation for AsyncRCONClient.wait_for()

Bug Fixes

• Fix AsyncRCONClient.send_command() returning bytes instead of str

Miscellaneous

• Add repl.py example

v0.0.1

This is the first version of berconpy, providing the initial implementation for the AsyncRCONClient, Packet, and RCONClientDatagramProtocol classes.