API Reference

Client Interface

berconpy.AsyncRCONClient

An asynchronous interface for connecting to an BattlEye RCON server.

Data Models

berconpy.Ban

Represents a GUID/IP ban on the server.

berconpy.Player

Represents a player in the server.

Protocol Message Classes

berconpy.Packet

The base class used for all messages sent between the BattlEye RCON server and client.

berconpy.PacketType

The type of packet received by the server.

berconpy.ClientPacket

The base class for packets sent by the client.

berconpy.ClientLoginPacket

The packet used to log in a client.

berconpy.ClientCommandPacket

The packet sent by the client issuing a command to the server.

berconpy.ClientMessagePacket

The packet sent to acknowledge a given server message.

berconpy.ServerPacket

The base class used for packets sent by the server.

berconpy.ServerLoginPacket

The packet indicating if login was successful.

berconpy.ServerCommandPacket

The packet(s) sent in response to a command.

berconpy.ServerMessagePacket

The packet sent to share a message to the client.

Exceptions

berconpy.RCONError

The base class for RCON errors.

berconpy.RCONCommandError

Raised when an issue occurs during execution of an RCON command.

berconpy.LoginFailure

Raised when either the RCON server could not respond to login attempts, or the password given to the server was incorrect.