mirror of
https://github.com/onyx-and-iris/q3rcon-cli.git
synced 2026-03-24 02:39:18 +00:00
Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 305af813b8 | |||
| 80638762d3 | |||
| 68f917286f | |||
| 3062cfa4d8 | |||
| 03597b580f | |||
| 296b1eff3e | |||
| 26a00bff42 | |||
| 60afda97dc | |||
| 968cd2dc8a | |||
| d7ea4d9fad | |||
| d0519bb8e9 | |||
| 3a7cc3eacb | |||
| fce5858a93 | |||
| a9aff25c4e | |||
| 7af5caad89 | |||
| ac5b117e2c | |||
| 4f5272ac32 | |||
| 04c4e40063 | |||
| 2233f5eda1 | |||
| 12bcaca00c | |||
| bfb45efb32 | |||
| 9a4fefcbbb | |||
| e2fb241bc2 | |||
| dd7f9775f2 | |||
| 36e54e89b7 | |||
| 84702a5360 | |||
| 7ec51293e4 | |||
| 0e962e5aa0 |
2
.gitignore
vendored
2
.gitignore
vendored
@ -210,3 +210,5 @@ marimo/_lsp/
|
|||||||
__marimo__/
|
__marimo__/
|
||||||
|
|
||||||
# End of ignr
|
# End of ignr
|
||||||
|
|
||||||
|
test-*.py
|
||||||
|
|||||||
15
.pre-commit-config.yaml
Normal file
15
.pre-commit-config.yaml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v2.3.0
|
||||||
|
hooks:
|
||||||
|
- id: check-yaml
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: trailing-whitespace
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: update-readme
|
||||||
|
name: update-readme
|
||||||
|
entry: python tools/update_readme_help.py
|
||||||
|
language: python
|
||||||
|
pass_filenames: false
|
||||||
35
README.md
35
README.md
@ -10,6 +10,9 @@
|
|||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Use](#use)
|
||||||
|
- [Shell Completion](#shell-completion)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -49,8 +52,8 @@ example .envrc:
|
|||||||
```env
|
```env
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
export Q3RCON_CLI_HOST="localhost"
|
export Q3RCON_CLI_HOST=localhost
|
||||||
export Q3RCON_CLI_PORT="28960"
|
export Q3RCON_CLI_PORT=28960
|
||||||
export Q3RCON_CLI_PASSWORD="<rcon password>"
|
export Q3RCON_CLI_PASSWORD="<rcon password>"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -59,26 +62,36 @@ export Q3RCON_CLI_PASSWORD="<rcon password>"
|
|||||||
```console
|
```console
|
||||||
Usage: q3rcon-cli [OPTIONS] COMMAND
|
Usage: q3rcon-cli [OPTIONS] COMMAND
|
||||||
|
|
||||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
┃ status Prints the status of the server ┃
|
|
||||||
┃ mapname Prints the current map name of the server ┃
|
|
||||||
┃ maprotate Rotates the map to the next one in the map rotation list ┃
|
|
||||||
┃ fastrestart Executes a fast restart of the server ┃
|
┃ fastrestart Executes a fast restart of the server ┃
|
||||||
┃ gametype Get or set the current gametype of the server ┃
|
┃ gametype Get or set the current gametype of the server ┃
|
||||||
┃ hostname Get or set the current hostname of the server ┃
|
┃ hostname Get or set the current hostname of the server ┃
|
||||||
┃ map Get the current map or change to a new one ┃
|
┃ map Get the current map or change to a new one ┃
|
||||||
|
┃ mapname Prints the current map name of the server ┃
|
||||||
|
┃ maprestart Restarts the current map ┃
|
||||||
|
┃ maprotate Rotates the map to the next one in the map rotation list ┃
|
||||||
┃ plugins Prints the currently loaded plugins of the server ┃
|
┃ plugins Prints the currently loaded plugins of the server ┃
|
||||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
┃ status Prints the status of the server ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
┃ -i, --interactive Whether to start in interactive mode (defaults to false) ┃
|
┃ -i, --interactive Whether to start in interactive mode (defaults to false) ┃
|
||||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
┃ -v, --version Show the version and exit ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
┃ -h, --host <HOST> The host to connect to ┃
|
┃ -h, --host <HOST> The host to connect to ┃
|
||||||
┃ -p, --port <PORT> The port to connect to ┃
|
┃ -p, --port <PORT> The port to connect to ┃
|
||||||
┃ -P, --password <PASSWORD> The password for authentication ┃
|
┃ -P, --password <PASSWORD> The password for authentication ┃
|
||||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
```
|
||||||
|
|
||||||
|
## Shell Completion
|
||||||
|
|
||||||
|
Shell completion scripts are available for *bash*, *zsh*, and *fish*.
|
||||||
|
|
||||||
|
```console
|
||||||
|
q3rcon-cli --install-autocomplete
|
||||||
```
|
```
|
||||||
|
|
||||||
## Special Thanks
|
## Special Thanks
|
||||||
|
|||||||
@ -20,7 +20,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: Implementation :: CPython",
|
"Programming Language :: Python :: Implementation :: CPython",
|
||||||
"Programming Language :: Python :: Implementation :: PyPy",
|
"Programming Language :: Python :: Implementation :: PyPy",
|
||||||
]
|
]
|
||||||
dependencies = ["aio-q3-rcon>=1.0.0", "clypi>=1.8.2"]
|
dependencies = ["aio-q3-rcon>=1.0.1", "clypi>=1.8.2"]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
q3rcon-cli = "q3rcon_cli.cli:main"
|
q3rcon-cli = "q3rcon_cli.cli:main"
|
||||||
@ -33,6 +33,9 @@ Source = "https://github.com/onyx-and-iris/q3rcon-cli"
|
|||||||
[tool.hatch.version]
|
[tool.hatch.version]
|
||||||
path = "src/q3rcon_cli/__about__.py"
|
path = "src/q3rcon_cli/__about__.py"
|
||||||
|
|
||||||
|
[tool.hatch.envs.default]
|
||||||
|
workspace.members = [{ path = "../aio-q3-rcon" }]
|
||||||
|
|
||||||
[tool.hatch.envs.types]
|
[tool.hatch.envs.types]
|
||||||
extra-dependencies = ["mypy>=1.0.0"]
|
extra-dependencies = ["mypy>=1.0.0"]
|
||||||
[tool.hatch.envs.types.scripts]
|
[tool.hatch.envs.types.scripts]
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
|
# SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
__version__ = "0.1.0"
|
__version__ = '0.3.3'
|
||||||
|
|||||||
@ -1,22 +1,33 @@
|
|||||||
import clypi
|
import clypi
|
||||||
from aioq3rcon import Client
|
from aioq3rcon import Client, IncorrectPasswordError
|
||||||
from clypi import Command, arg
|
from clypi import Command, Spinner, arg
|
||||||
|
from clypi import parsers as cp
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
|
from . import console
|
||||||
|
from .__about__ import __version__
|
||||||
from .commands import (
|
from .commands import (
|
||||||
Fastrestart,
|
Fastrestart,
|
||||||
Gametype,
|
Gametype,
|
||||||
Hostname,
|
Hostname,
|
||||||
Map,
|
Map,
|
||||||
Mapname,
|
Mapname,
|
||||||
|
Maprestart,
|
||||||
Maprotate,
|
Maprotate,
|
||||||
Plugins,
|
Plugins,
|
||||||
Status,
|
Status,
|
||||||
)
|
)
|
||||||
from .console import Console
|
|
||||||
|
|
||||||
Subcommands = (
|
Subcommands = (
|
||||||
Status | Mapname | Maprotate | Fastrestart | Gametype | Hostname | Map | Plugins
|
Fastrestart
|
||||||
|
| Gametype
|
||||||
|
| Hostname
|
||||||
|
| Map
|
||||||
|
| Mapname
|
||||||
|
| Maprestart
|
||||||
|
| Maprotate
|
||||||
|
| Plugins
|
||||||
|
| Status
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@ -28,6 +39,7 @@ class Q3rconCli(Command):
|
|||||||
help='The host to connect to',
|
help='The host to connect to',
|
||||||
env='Q3RCON_CLI_HOST',
|
env='Q3RCON_CLI_HOST',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Str(min=1),
|
||||||
)
|
)
|
||||||
port: int = arg(
|
port: int = arg(
|
||||||
28960,
|
28960,
|
||||||
@ -35,6 +47,7 @@ class Q3rconCli(Command):
|
|||||||
help='The port to connect to',
|
help='The port to connect to',
|
||||||
env='Q3RCON_CLI_PORT',
|
env='Q3RCON_CLI_PORT',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Int(min=1, max=65535),
|
||||||
)
|
)
|
||||||
password: str = arg(
|
password: str = arg(
|
||||||
'',
|
'',
|
||||||
@ -42,61 +55,82 @@ class Q3rconCli(Command):
|
|||||||
help='The password for authentication',
|
help='The password for authentication',
|
||||||
env='Q3RCON_CLI_PASSWORD',
|
env='Q3RCON_CLI_PASSWORD',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Str(min=8),
|
||||||
)
|
)
|
||||||
interactive: bool = arg(
|
interactive: bool = arg(
|
||||||
False,
|
False,
|
||||||
short='i',
|
short='i',
|
||||||
help='Whether to start in interactive mode (defaults to false)',
|
help='Whether to start in interactive mode (defaults to false)',
|
||||||
)
|
)
|
||||||
|
version: bool = arg(
|
||||||
|
False,
|
||||||
|
short='v',
|
||||||
|
help='Show the version and exit',
|
||||||
|
)
|
||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
|
if self.version:
|
||||||
|
print(f'q3rcon-cli version: {clypi.style(__version__, fg="green")}')
|
||||||
|
return
|
||||||
|
|
||||||
if self.interactive:
|
if self.interactive:
|
||||||
await self.run_interactive()
|
await self.run_interactive()
|
||||||
else:
|
else:
|
||||||
await Status.run(self)
|
await Status(self.host, self.port, self.password).run()
|
||||||
|
|
||||||
async def run_interactive(self):
|
async def run_interactive(self):
|
||||||
print(
|
print(
|
||||||
clypi.style('Entering interactive mode. Type', fg='blue'),
|
clypi.style('Entering interactive mode. Type', fg='blue'),
|
||||||
clypi.style("'Q'", fg='red'),
|
clypi.style("'Q'", fg='yellow'),
|
||||||
clypi.style('to quit.', fg='blue'),
|
clypi.style('to quit.', fg='blue'),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
DEFAULT_TIMEOUT = 2
|
||||||
DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
|
DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
|
||||||
while command := input(clypi.style('cmd: ', fg='green')):
|
while command := input(clypi.style('cmd: ', fg='green')):
|
||||||
if command.lower() == 'q':
|
if command.lower() == 'q':
|
||||||
break
|
break
|
||||||
|
|
||||||
fragment_read_timeout = None
|
CMD_CONFIG = {
|
||||||
if command in (
|
'status': (2, 1, False),
|
||||||
'status',
|
'fast_restart': (3, 1, True),
|
||||||
'fast_restart',
|
'map_restart': (3, 1, True),
|
||||||
'map_restart',
|
'map': (3, 1, True),
|
||||||
'map',
|
'map_rotate': (3, 1, True),
|
||||||
'map_rotate',
|
}
|
||||||
):
|
timeout, fragment_read_timeout, interpret = CMD_CONFIG.get(
|
||||||
fragment_read_timeout = 1
|
command.split()[0].lower(),
|
||||||
|
(DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
|
||||||
|
)
|
||||||
|
|
||||||
|
async with Spinner(f"Sending command: '{command}'", suffix='...'):
|
||||||
async with Client(
|
async with Client(
|
||||||
self.host,
|
self.host,
|
||||||
self.port,
|
self.port,
|
||||||
self.password,
|
self.password,
|
||||||
fragment_read_timeout=fragment_read_timeout
|
timeout=timeout,
|
||||||
or DEFAULT_FRAGMENT_READ_TIMEOUT,
|
fragment_read_timeout=fragment_read_timeout,
|
||||||
) as client:
|
) as client:
|
||||||
try:
|
try:
|
||||||
if response := await client.send_command(command):
|
response = await client.send_command(
|
||||||
Console.print_response(response)
|
command, interpret=interpret
|
||||||
except TimeoutError:
|
|
||||||
print(
|
|
||||||
clypi.style(
|
|
||||||
'Timeout waiting for response for command:', fg='red'
|
|
||||||
),
|
|
||||||
clypi.style(command, fg='yellow'),
|
|
||||||
)
|
)
|
||||||
|
except TimeoutError:
|
||||||
|
console.err.print(
|
||||||
|
f"Timeout waiting for response for command: '{command}'"
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print_response(response)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
try:
|
||||||
cli = Q3rconCli().parse()
|
cli = Q3rconCli().parse()
|
||||||
cli.start()
|
cli.start()
|
||||||
|
except IncorrectPasswordError:
|
||||||
|
console.err.print('Incorrect password provided.')
|
||||||
|
except TimeoutError:
|
||||||
|
console.err.print(
|
||||||
|
f"Timeout waiting for response for command: '{type(cli.subcommand).__name__.lower()}'"
|
||||||
|
)
|
||||||
|
|||||||
@ -3,6 +3,7 @@ from .gametype import Gametype
|
|||||||
from .hostname import Hostname
|
from .hostname import Hostname
|
||||||
from .map import Map
|
from .map import Map
|
||||||
from .mapname import Mapname
|
from .mapname import Mapname
|
||||||
|
from .maprestart import Maprestart
|
||||||
from .maprotate import Maprotate
|
from .maprotate import Maprotate
|
||||||
from .plugins import Plugins
|
from .plugins import Plugins
|
||||||
from .status import Status
|
from .status import Status
|
||||||
@ -16,4 +17,5 @@ __all__ = [
|
|||||||
'Hostname',
|
'Hostname',
|
||||||
'Map',
|
'Map',
|
||||||
'Plugins',
|
'Plugins',
|
||||||
|
'Maprestart',
|
||||||
]
|
]
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
from aioq3rcon import Client
|
from aioq3rcon import Client
|
||||||
from clypi import Command, arg
|
from clypi import Command, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Fastrestart(Command):
|
class Fastrestart(Command):
|
||||||
@ -14,6 +14,8 @@ class Fastrestart(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
|
async with Spinner('Executing fast restart', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('fast_restart'):
|
response = await client.send_command('fast_restart', interpret=True)
|
||||||
Console.print_response(response)
|
|
||||||
|
console.out.print_response(response)
|
||||||
|
|||||||
@ -2,7 +2,7 @@ from aioq3rcon import Client
|
|||||||
from clypi import Command, Positional, Spinner, arg
|
from clypi import Command, Positional, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Gametype(Command):
|
class Gametype(Command):
|
||||||
@ -23,21 +23,24 @@ class Gametype(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
if not Gametype.new_gametype:
|
if not self.new_gametype:
|
||||||
|
async with Spinner('Fetching current gametype', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('g_gametype'):
|
response = await client.send_command('g_gametype')
|
||||||
Console.print_cvar(response)
|
console.out.print_cvar(response)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
async with Spinner(f'Changing gametype to {self.new_gametype}', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
DEFAULT_FRAGMENT_READ_TIMEOUT = client.fragment_read_timeout
|
|
||||||
|
|
||||||
await client.send_command(f'g_gametype {self.new_gametype}')
|
await client.send_command(f'g_gametype {self.new_gametype}')
|
||||||
|
|
||||||
if self.force:
|
if self.force:
|
||||||
async with Spinner('Forcing gametype change...'):
|
async with Spinner('Forcing gametype change', suffix='...'):
|
||||||
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
|
client.timeout = 3
|
||||||
client.fragment_read_timeout = 1
|
client.fragment_read_timeout = 1
|
||||||
await client.send_command('map_restart')
|
await client.send_command('map_restart')
|
||||||
|
|
||||||
client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT
|
console.out.print(
|
||||||
if response := await client.send_command('g_gametype'):
|
f'Gametype changed successfully to {self.new_gametype}.', style='green'
|
||||||
Console.print_cvar(response)
|
)
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
from aioq3rcon import Client
|
from aioq3rcon import Client
|
||||||
from clypi import Command, Positional, arg
|
from clypi import Command, Positional, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Hostname(Command):
|
class Hostname(Command):
|
||||||
@ -19,12 +19,14 @@ class Hostname(Command):
|
|||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
if not self.new_hostname:
|
if not self.new_hostname:
|
||||||
|
async with Spinner('Fetching current hostname', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('sv_hostname'):
|
response = await client.send_command('sv_hostname')
|
||||||
Console.print_cvar(response)
|
console.out.print_cvar(response)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
async with Spinner(f'Changing hostname to {self.new_hostname}', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
await client.send_command(f'sv_hostname {self.new_hostname}')
|
await client.send_command(f'sv_hostname {self.new_hostname}')
|
||||||
if response := await client.send_command('sv_hostname'):
|
|
||||||
Console.print_cvar(response)
|
console.out.print(f'Hostname changed to: {self.new_hostname}', style='green')
|
||||||
|
|||||||
@ -2,7 +2,7 @@ from aioq3rcon import Client
|
|||||||
from clypi import Command, Positional, Spinner, arg
|
from clypi import Command, Positional, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Map(Command):
|
class Map(Command):
|
||||||
@ -19,15 +19,18 @@ class Map(Command):
|
|||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
if not self.new_map:
|
if not self.new_map:
|
||||||
|
async with Spinner('Getting current map', suffix='...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('mapname'):
|
response = await client.send_command('mapname')
|
||||||
Console.print_cvar(response)
|
console.out.print_cvar(response)
|
||||||
return
|
return
|
||||||
|
|
||||||
async with Spinner('Changing map...'):
|
async with Spinner('Changing map', suffix='...'):
|
||||||
async with Client(
|
async with Client(
|
||||||
self.host, self.port, self.password, fragment_read_timeout=1
|
self.host, self.port, self.password, fragment_read_timeout=1
|
||||||
) as client:
|
) as client:
|
||||||
await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
|
await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
|
||||||
if response := await client.send_command('mapname'):
|
|
||||||
Console.print_cvar(response)
|
console.out.print(
|
||||||
|
f'Map changed to {self.new_map.removeprefix("mp_")}', style='green'
|
||||||
|
)
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
from aioq3rcon import Client
|
from aioq3rcon import Client
|
||||||
from clypi import Command, arg
|
from clypi import Command, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Mapname(Command):
|
class Mapname(Command):
|
||||||
@ -14,6 +14,8 @@ class Mapname(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
|
async with Spinner('Getting map name...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('mapname'):
|
response = await client.send_command('mapname')
|
||||||
Console.print_cvar(response)
|
|
||||||
|
console.out.print_cvar(response)
|
||||||
|
|||||||
23
src/q3rcon_cli/commands/maprestart.py
Normal file
23
src/q3rcon_cli/commands/maprestart.py
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
from aioq3rcon import Client
|
||||||
|
from clypi import Command, Spinner, arg
|
||||||
|
from typing_extensions import override
|
||||||
|
|
||||||
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
|
class Maprestart(Command):
|
||||||
|
"""Restarts the current map."""
|
||||||
|
|
||||||
|
host: str = arg(inherited=True)
|
||||||
|
port: int = arg(inherited=True)
|
||||||
|
password: str = arg(inherited=True)
|
||||||
|
|
||||||
|
@override
|
||||||
|
async def run(self):
|
||||||
|
async with Spinner('Restarting map', suffix='...'):
|
||||||
|
async with Client(
|
||||||
|
self.host, self.port, self.password, timeout=3, fragment_read_timeout=1
|
||||||
|
) as client:
|
||||||
|
response = await client.send_command('map_restart', interpret=True)
|
||||||
|
|
||||||
|
console.out.print_response(response)
|
||||||
@ -2,7 +2,7 @@ from aioq3rcon import Client
|
|||||||
from clypi import Command, Spinner, arg
|
from clypi import Command, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Maprotate(Command):
|
class Maprotate(Command):
|
||||||
@ -14,9 +14,14 @@ class Maprotate(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
async with Spinner('Rotating map...'):
|
async with Spinner('Rotating map', suffix='...'):
|
||||||
async with Client(
|
async with Client(
|
||||||
self.host, self.port, self.password, fragment_read_timeout=1
|
self.host,
|
||||||
|
self.port,
|
||||||
|
self.password,
|
||||||
|
timeout=3,
|
||||||
|
fragment_read_timeout=1,
|
||||||
) as client:
|
) as client:
|
||||||
if response := await client.send_command('map_rotate'):
|
response = await client.send_command('map_rotate', interpret=True)
|
||||||
Console.print_response(response)
|
|
||||||
|
console.out.print_response(response)
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
from aioq3rcon import Client
|
from aioq3rcon import Client
|
||||||
from clypi import Command, arg
|
from clypi import Command, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Plugins(Command):
|
class Plugins(Command):
|
||||||
@ -14,6 +14,8 @@ class Plugins(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
|
async with Spinner('Fetching plugins...'):
|
||||||
async with Client(self.host, self.port, self.password) as client:
|
async with Client(self.host, self.port, self.password) as client:
|
||||||
if response := await client.send_command('plugins'):
|
response = await client.send_command('plugins')
|
||||||
Console.print_response(response)
|
|
||||||
|
console.out.print_response(response)
|
||||||
|
|||||||
@ -2,7 +2,7 @@ from aioq3rcon import Client
|
|||||||
from clypi import Command, Spinner, arg
|
from clypi import Command, Spinner, arg
|
||||||
from typing_extensions import override
|
from typing_extensions import override
|
||||||
|
|
||||||
from q3rcon_cli.console import Console
|
from q3rcon_cli import console
|
||||||
|
|
||||||
|
|
||||||
class Status(Command):
|
class Status(Command):
|
||||||
@ -14,9 +14,10 @@ class Status(Command):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def run(self):
|
async def run(self):
|
||||||
async with Spinner('Fetching status...'):
|
async with Spinner('Fetching status', suffix='...'):
|
||||||
async with Client(
|
async with Client(
|
||||||
self.host, self.port, self.password, fragment_read_timeout=0.5
|
self.host, self.port, self.password, fragment_read_timeout=1
|
||||||
) as client:
|
) as client:
|
||||||
if response := await client.send_command('status'):
|
response = await client.send_command('status')
|
||||||
Console.print_status(response)
|
|
||||||
|
console.out.print_status(response)
|
||||||
|
|||||||
@ -1,10 +1,23 @@
|
|||||||
import re
|
import re
|
||||||
|
|
||||||
import clypi
|
import clypi
|
||||||
from clypi import cprint
|
from clypi import Boxes, cprint
|
||||||
|
|
||||||
|
|
||||||
class Console:
|
class Console:
|
||||||
|
def __init__(self, style: str = 'yellow'):
|
||||||
|
self.style = style
|
||||||
|
|
||||||
|
def print(self, message: str, style: str | None = None):
|
||||||
|
cprint(message, fg=style or self.style)
|
||||||
|
|
||||||
|
|
||||||
|
class ErrorConsole(Console):
|
||||||
|
def __init__(self):
|
||||||
|
super().__init__(style='red')
|
||||||
|
|
||||||
|
|
||||||
|
class OutConsole(Console):
|
||||||
COLOUR_CODE_REGEX = re.compile(r'\^[0-9]')
|
COLOUR_CODE_REGEX = re.compile(r'\^[0-9]')
|
||||||
STATUS_PLAYER_REGEX = re.compile(
|
STATUS_PLAYER_REGEX = re.compile(
|
||||||
r'^\s*(?P<slot>[0-9]+)\s+'
|
r'^\s*(?P<slot>[0-9]+)\s+'
|
||||||
@ -20,6 +33,8 @@ class Console:
|
|||||||
r'(?P<rate>[0-9]+)$',
|
r'(?P<rate>[0-9]+)$',
|
||||||
re.IGNORECASE | re.VERBOSE,
|
re.IGNORECASE | re.VERBOSE,
|
||||||
)
|
)
|
||||||
|
STATUS_MAP_REGEX = re.compile(r'^map: (?P<mapname>mp_[a-z_]+)$')
|
||||||
|
|
||||||
CVAR_REGEX = re.compile(
|
CVAR_REGEX = re.compile(
|
||||||
r'^["](?P<name>[a-z_]+)["]\sis[:]\s'
|
r'^["](?P<name>[a-z_]+)["]\sis[:]\s'
|
||||||
r'["](?P<value>.*?)["]\s'
|
r'["](?P<value>.*?)["]\s'
|
||||||
@ -30,18 +45,15 @@ class Console:
|
|||||||
)
|
)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def remove_colour_codes(s: str) -> str:
|
def _remove_colour_codes(s: str) -> str:
|
||||||
"""Remove Quake 3 colour codes from a string."""
|
"""Remove Quake 3 colour codes from a string."""
|
||||||
return Console.COLOUR_CODE_REGEX.sub('', s)
|
return OutConsole.COLOUR_CODE_REGEX.sub('', s)
|
||||||
|
|
||||||
@staticmethod
|
def print_response(self, response: str):
|
||||||
def print_response(response: str):
|
if response := self._remove_colour_codes(response).removeprefix('print\n'):
|
||||||
response = Console.remove_colour_codes(response).removeprefix('print\n')
|
cprint(response, fg=self.style)
|
||||||
|
|
||||||
cprint(f'\n{response}\n', fg='yellow')
|
def print_status(self, response: str):
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def print_status(response: str):
|
|
||||||
_slots = []
|
_slots = []
|
||||||
_scores = []
|
_scores = []
|
||||||
_pings = []
|
_pings = []
|
||||||
@ -51,45 +63,76 @@ class Console:
|
|||||||
|
|
||||||
lines = response.splitlines()
|
lines = response.splitlines()
|
||||||
for line in lines:
|
for line in lines:
|
||||||
if m := Console.STATUS_PLAYER_REGEX.match(line):
|
if m := OutConsole.STATUS_PLAYER_REGEX.match(line):
|
||||||
_slots.append(m.group('slot'))
|
_slots.append(m.group('slot'))
|
||||||
_scores.append(m.group('score'))
|
_scores.append(m.group('score'))
|
||||||
_pings.append(m.group('ping'))
|
_pings.append(m.group('ping'))
|
||||||
_guids.append(m.group('guid'))
|
_guids.append(m.group('guid'))
|
||||||
_names.append(m.group('name'))
|
_names.append(self._remove_colour_codes(m.group('name')))
|
||||||
_ips.append(m.group('ip'))
|
_ips.append(m.group('ip'))
|
||||||
|
elif m := OutConsole.STATUS_MAP_REGEX.match(line):
|
||||||
|
cprint(f'Current map: {m.group("mapname")}', fg=self.style)
|
||||||
|
|
||||||
if not _slots:
|
if not _slots:
|
||||||
cprint('\nNo players connected.\n', fg='yellow')
|
cprint('No players connected.', fg='red')
|
||||||
return
|
return
|
||||||
|
|
||||||
slots = clypi.boxed(_slots, title='Slot', width=15)
|
slots = clypi.boxed(
|
||||||
scores = clypi.boxed(_scores, title='Score', width=15)
|
_slots, title='Slot', width=10, align='center', style=Boxes.ROUNDED
|
||||||
pings = clypi.boxed(_pings, title='Ping', width=15)
|
)
|
||||||
guids = clypi.boxed(_guids, title='GUID', width=40)
|
scores = clypi.boxed(
|
||||||
names = clypi.boxed(_names, title='Name', width=30)
|
_scores, title='Score', width=10, align='center', style=Boxes.ROUNDED
|
||||||
ips = clypi.boxed(_ips, title='IP', width=30)
|
)
|
||||||
print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
|
pings = clypi.boxed(
|
||||||
|
_pings, title='Ping', width=10, align='center', style=Boxes.ROUNDED
|
||||||
|
)
|
||||||
|
guids = clypi.boxed(
|
||||||
|
_guids,
|
||||||
|
title='GUID',
|
||||||
|
width=len(max(_guids, key=len)) + 4,
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
|
)
|
||||||
|
names = clypi.boxed(
|
||||||
|
_names,
|
||||||
|
title='Name',
|
||||||
|
width=len(max(_names, key=len)) + 4,
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
|
)
|
||||||
|
ips = clypi.boxed(
|
||||||
|
_ips, title='IP', width=len(max(_ips, key=len)) + 4, style=Boxes.ROUNDED
|
||||||
|
)
|
||||||
|
print(f'{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
|
||||||
|
|
||||||
@staticmethod
|
def print_cvar(self, response: str):
|
||||||
def print_cvar(response: str):
|
response = self._remove_colour_codes(response).removeprefix('print\n')
|
||||||
response = Console.remove_colour_codes(response).removeprefix('print\n')
|
|
||||||
|
|
||||||
if m := Console.CVAR_REGEX.match(response):
|
if m := self.CVAR_REGEX.match(response):
|
||||||
name = clypi.boxed(
|
name = clypi.boxed(
|
||||||
[m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 30)
|
[m.group('name')],
|
||||||
|
title='Name',
|
||||||
|
width=max(len(m.group('name')) + 4, 15),
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
)
|
)
|
||||||
value = clypi.boxed(
|
value = clypi.boxed(
|
||||||
[m.group('value')],
|
[m.group('value')],
|
||||||
title='Value',
|
title='Value',
|
||||||
width=max(len(m.group('value')) + 4, 30),
|
width=max(len(m.group('value')) + 4, 15),
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
)
|
)
|
||||||
default = clypi.boxed(
|
default = clypi.boxed(
|
||||||
[m.group('default')],
|
[m.group('default')],
|
||||||
title='Default',
|
title='Default',
|
||||||
width=max(len(m.group('default')) + 4, 30),
|
width=max(len(m.group('default')) + 4, 15),
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
)
|
)
|
||||||
info = clypi.boxed(
|
info = clypi.boxed(
|
||||||
[m.group('info')], title='Info', width=max(len(m.group('info')) + 4, 30)
|
[m.group('info')],
|
||||||
|
title='Info',
|
||||||
|
width=max(len(m.group('info')) + 4, 15),
|
||||||
|
style=Boxes.ROUNDED,
|
||||||
)
|
)
|
||||||
print(f'\n{clypi.stack(name, value, default, info, padding=0)}')
|
print(f'{clypi.stack(name, value, default, info, padding=0)}')
|
||||||
|
|
||||||
|
|
||||||
|
out = OutConsole()
|
||||||
|
err = ErrorConsole()
|
||||||
|
|||||||
41
tools/update_readme_help.py
Normal file
41
tools/update_readme_help.py
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
import re
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
REPO_ROOT = Path(__file__).parent.parent
|
||||||
|
README_PATH = REPO_ROOT / 'README.md'
|
||||||
|
HELP_CMD = ['hatch', 'run', 'q3rcon-cli', '--help']
|
||||||
|
|
||||||
|
|
||||||
|
def get_help_output():
|
||||||
|
result = subprocess.run(HELP_CMD, capture_output=True, text=True, check=True)
|
||||||
|
output = result.stdout.strip()
|
||||||
|
ansi_escape = re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]')
|
||||||
|
output = ansi_escape.sub('', output)
|
||||||
|
return output
|
||||||
|
|
||||||
|
|
||||||
|
def update_readme(help_text):
|
||||||
|
readme = README_PATH.read_text()
|
||||||
|
|
||||||
|
pattern = re.compile(
|
||||||
|
r'```console\nUsage: q3rcon-cli \[OPTIONS\] COMMAND.*?```', re.DOTALL
|
||||||
|
)
|
||||||
|
new_block = f'```console\n{help_text}\n```'
|
||||||
|
new_readme, n = pattern.subn(new_block, readme, count=1)
|
||||||
|
if n == 0:
|
||||||
|
raise RuntimeError(
|
||||||
|
'Could not find the q3rcon-cli usage console block to replace in README.md'
|
||||||
|
)
|
||||||
|
README_PATH.write_text(new_readme)
|
||||||
|
print('README.md updated with latest --help output.')
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
help_text = get_help_output()
|
||||||
|
update_readme(help_text)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
Loading…
x
Reference in New Issue
Block a user