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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file berconpy-2.1.4.tar.gz.

File metadata

  • Download URL: berconpy-2.1.4.tar.gz
  • Upload date:
  • Size: 34.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for berconpy-2.1.4.tar.gz
Algorithm Hash digest
SHA256 b8af3a66963bc1b35e1b538d47c78c5a7c0dd74160f0d2726f3d06c2a1df4420
MD5 1ca872359da9df0d0efb3517c88a1a2e
BLAKE2b-256 4b7dcc87942306940fb2a96d8fdde77d106d33e2e25d4493b6fd299c8155a19f

See more details on using hashes here.

File details

Details for the file berconpy-2.1.4-py3-none-any.whl.

File metadata

  • Download URL: berconpy-2.1.4-py3-none-any.whl
  • Upload date:
  • Size: 43.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for berconpy-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 200001dafe14bf4672e295768c954977ac8ecee3d44e85a795747d77c5f462b5
MD5 c7cee9ece387ed0ed84173ea9372eb15
BLAKE2b-256 0dd605c30c994a9b93109fcdef968eb0e2338063c60429ebe3340b77d08b4d80

See more details on using hashes here.

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