Skip to main content

An async wrapper for the BattlEye RCON protocol

Project description

berconpy

PyPI Docs

An asynchronous Python wrapper over the BattlEye RCON protocol.

Features

  • Easy to use event-based interface
  • Automatic network loss recovery
  • Included extension for using Arma-related commands

Basic Usage

import asyncio
import berconpy

client = berconpy.AsyncRCONClient()

IP = "XXX.XXX.XXX.XXX"
PORT = 9999
PASSWORD = "ASCII_PASSWORD"

@client.dispatch.on_login
async def on_login():
    print("We have logged in!")

async def main():
    async with client.connect(IP, PORT, PASSWORD):
        players = await client.send_command("players")
        print(players)

asyncio.run(main())

See the documentation for more details.

Installation

(Python 3.10 or higher is required)

This package can be installed from PyPi using the following command:

# Linux/macOS
python3 -m pip install berconpy

# Windows
py -m pip install berconpy

If you want to install the development version instead, and you have git installed:

pip install git+https://github.com/thegamecracks/berconpy

Related resources

License

This project uses the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

berconpy-2.1.4.tar.gz (34.2 kB view hashes)

Uploaded Source

Built Distribution

berconpy-2.1.4-py3-none-any.whl (43.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page