q3rcon-tui/README.md

1.3 KiB

q3rcon tui

Hatch project Ruff PyPI - Version PyPI - Python Version


img

Table of Contents

Installation

with uv

uv tool install q3rcon-tui

with pipx

pipx install q3rcon-tui

The TUI should now be discoverable as q3rcon-tui.

Configuration

Flags

Pass --host, --port and --password as flags:

q3rcon-tui --host=localhost --port=28960 --password=rconpassword

Environment Variables

Store and load from dotenv files located at:

  • .env in the cwd
  • user home directory / .config / q3rcon-tui / config.env

example .env:

Q3RCON_TUI_HOST=localhost
Q3RCON_TUI_PORT=28960
Q3RCON_TUI_PASSWORD=rconpassword
Q3RCON_TUI_REFRESH_OUTPUT=true

License

q3rcon-tui is distributed under the terms of the MIT license.