AsyncRCONClient is incompatible with Arma Reforger

[PovilasKud]

Description

Running the basic sample throws an ValueError. Seems like Logging in is successful but the code doesn't expect response from server

ValueError: unexpected server message: Logged In! Client ID: #1

Log:

(.venv) ➜  ARMA  cd /Users/t2069pov/DEVELOPMENT/PROJECTS/ARMA ; /usr/bin/env /Users/t2069pov/DEVELOPMENT/PROJECTS/ARMA/discord_bot/.venv/bin/python /Use
rs/t2069pov/.cursor/extensions/ms-python.debugpy-2024.6.0-darwin-arm64/bundled/libs/debugpy/adapter/../../debugpy/launcher 60823 -- /Users/t2069pov/DEVE
LOPMENT/PROJECTS/ARMA/discord_bot/commands.py 
We have logged in!
Task exception was never retrieved
future: <Task finished name='berconpy-on_message' coro=<maybe_coro() done, defined at /Users/t2069pov/DEVELOPMENT/PROJECTS/ARMA/discord_bot/.venv/lib/python3.12/site-packages/berconpy/utils.py:39> exception=ValueError('unexpected server message: Logged In! Client ID: #1')>
Traceback (most recent call last):
  File "/Users/t2069pov/DEVELOPMENT/PROJECTS/ARMA/discord_bot/.venv/lib/python3.12/site-packages/berconpy/utils.py", line 44, in maybe_coro
    ret = func(*args, **kwargs)
          ^^^^^^^^^^^^^^^^^^^^^
  File "/Users/t2069pov/DEVELOPMENT/PROJECTS/ARMA/discord_bot/.venv/lib/python3.12/site-packages/berconpy/client.py", line 419, in on_message
    raise ValueError(f"unexpected server message: {message}")
ValueError: unexpected server message: Logged In! Client ID: #1

Steps to Reproduce

Running sample code.

System Information

Python version: Python 3.12.1 (main, Feb 15 2025, 11:13:03) [Clang 15.0.0 (clang-1500.3.9.4)]
berconpy version: 2.1.4

[thegamecracks]

Ah, sorry about this! I hadn't updated the parser to support Arma Reforger servers, so it doesn't recognize messages from it. The library needs a refactor to allow swapping out the Arma 3/DayZ parser for one tailored to Reforger, or turning it off so only the generic on_login, on_command, and on_message events are fired.

[thegamecracks]

There is now a very preliminary, major refactor of the library in the arma-separation branch that can be used for Arma Reforger. Summary of changes:

• berconpy.RCONClient is now used for generic handling of BattlEye RCON
  • Works similarly to the now-removed berconpy.AsyncRCONClient, but all methods/events dependent on Arma 3's messages have been removed
• All commands and events related to Arma 3 have been moved to a new class, berconpy.ArmaClient
  • Replaces the former berconpy.ext.arma.AsyncArmaRCONClient class
• berconpy.Ban and berconpy.Player now exists only in the context of ArmaClient and cannot be used with RCONClient

Installation (requires Git):

pip install git+https://github.com/thegamecracks/berconpy@arma-separation

Usage:

import berconpy

client = berconpy.RCONClient()

@client.dispatch.on_login
async def on_login():
    print("on_login")

@client.dispatch.on_message
async def on_message(message: str):
    print("on_message:", message)

@client.dispatch.on_command
async def on_command(response: str):
    print("on_command:", response or "<empty>")

async def main():
    async with client.connect("1.2.3.4", 19999, "password"):
        await client.send_command("players")
        await asyncio.get_running_loop().create_future()

asyncio.run(main())

Outline of RCONClient:

class RCONClient:
    dispatch: EventDispatcher
    protocol: AsyncClientProtocol

    async def connect(self, ip: str, port: int, password: str): ...
    def close(self): ...

    def is_connected(self) -> bool: ...
    def is_logged_in(self) -> bool | None: ...
    def is_running(self) -> bool: ...

    async def send_command(self, command: str) -> str: ...

    # Proxy methods to EventDispatcher:
    def add_listener(self, event: str, func: Callable) -> None: ...
    def listen(self, event: str | None = None) -> Callable[[T], T]: ...
    def remove_listener(self, event: str, func: Callable) -> None: ...
    async def wait_for(self, event: str, *, check=None, timeout=None): ...

As I haven't thoroughly tested this refactor nor updated the documentation source files, I will likely not be merging this into the main branch and releasing it on PyPI any time soon. However, if it does happen, please make sure your project's requirements file is pinned to a specific commit on this branch, for example:

berconpy @ git+https://github.com/thegamecracks/berconpy@73cb1aad4a7f6fa11ed708c7d70dda99de7350ec

Or, if you are not using this branch and want to continue using the official release as-is, ensure your berconpy version is restricted to below 3.0.0, for example:

berconpy~=2.1
berconpy==2.1.4
berconpy>=2.1.4,<3

[marwanbd83487]

@thegamecracks

Hey, first off thank you for your amazing work!
I recently discovered that Arma Reforger supports two RCON implementations:

1. the Classic BattlEye RCON
2. Reforger's native RCON

use BattlEye CLI RCON client here to test both:
https://www.battleye.com/downloads/
Command reference:
https://www.battleye.com/support/documentation/

---

1. BattlEye RCON

• Location: battleye folder in the server directory
• Config File: BEServer_x64.cfg

Example configuration:

File: battleye/BEServer_x64.cfg

GameID armar
MasterPort 2001
RConPort 7117
RConPassword 1522853

---

2. Reforger Built-in RCON

• Location: Server configuration file (typically config.json or server.json)

Example configuration:

{
  "rcon": {
    "enabled": true,
    "bindAddress": "0.0.0.0",
    "port": 25575,
    "password": "your_secure_password"
  }
}

---

Useful links:

• https://community.bistudio.com/wiki/Arma_Reforger:Server_Config#rcon_2
• https://community.bistudio.com/wiki/Arma_Reforger:Server_Management

---

• Both RCON protocols can be used simultaneously.
• They differ in command sets, response output, and overall behavior