Compare commits

..

No commits in common. "main" and "v0.2.3" have entirely different histories.
main ... v0.2.3

13 changed files with 91 additions and 174 deletions

View File

@ -10,9 +10,6 @@
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Use](#use)
- [Shell Completion](#shell-completion)
- [License](#license)
## Installation
@ -76,7 +73,6 @@ Usage: q3rcon-cli [OPTIONS] COMMAND
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ -i, --interactive Whether to start in interactive mode (defaults to false) ┃
┃ -v, --version Show the version and exit ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@ -86,14 +82,6 @@ Usage: q3rcon-cli [OPTIONS] COMMAND
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
```
## Shell Completion
Shell completion scripts are available for *bash*, *zsh*, and *fish*.
```console
q3rcon-cli --install-autocomplete
```
## Special Thanks
- [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.

View File

@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
#
# SPDX-License-Identifier: MIT
__version__ = '0.3.3'
__version__ = '0.2.3'

View File

@ -1,11 +1,9 @@
import clypi
from aioq3rcon import Client, IncorrectPasswordError
from clypi import Command, Spinner, arg
from clypi import parsers as cp
from clypi import Command, arg
from typing_extensions import override
from . import console
from .__about__ import __version__
from .commands import (
Fastrestart,
Gametype,
@ -39,7 +37,6 @@ class Q3rconCli(Command):
help='The host to connect to',
env='Q3RCON_CLI_HOST',
group='Connection',
parser=cp.Str(min=1),
)
port: int = arg(
28960,
@ -47,7 +44,6 @@ class Q3rconCli(Command):
help='The port to connect to',
env='Q3RCON_CLI_PORT',
group='Connection',
parser=cp.Int(min=1, max=65535),
)
password: str = arg(
'',
@ -55,25 +51,15 @@ class Q3rconCli(Command):
help='The password for authentication',
env='Q3RCON_CLI_PASSWORD',
group='Connection',
parser=cp.Str(min=8),
)
interactive: bool = arg(
False,
short='i',
help='Whether to start in interactive mode (defaults to false)',
)
version: bool = arg(
False,
short='v',
help='Show the version and exit',
)
@override
async def run(self):
if self.version:
print(f'q3rcon-cli version: {clypi.style(__version__, fg="green")}')
return
if self.interactive:
await self.run_interactive()
else:
@ -82,47 +68,40 @@ class Q3rconCli(Command):
async def run_interactive(self):
print(
clypi.style('Entering interactive mode. Type', fg='blue'),
clypi.style("'Q'", fg='yellow'),
clypi.style("'Q'", fg='red'),
clypi.style('to quit.', fg='blue'),
)
DEFAULT_TIMEOUT = 2
DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
while command := input(clypi.style('cmd: ', fg='green')):
if command.lower() == 'q':
break
CMD_CONFIG = {
'status': (2, 1, False),
'fast_restart': (3, 1, True),
'map_restart': (3, 1, True),
'map': (3, 1, True),
'map_rotate': (3, 1, True),
}
timeout, fragment_read_timeout, interpret = CMD_CONFIG.get(
command.split()[0].lower(),
(DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
)
fragment_read_timeout = None
if command in (
'status',
'fast_restart',
'map_restart',
'map',
'map_rotate',
):
fragment_read_timeout = 1
async with Spinner(f"Sending command: '{command}'", suffix='...'):
async with Client(
self.host,
self.port,
self.password,
timeout=timeout,
fragment_read_timeout=fragment_read_timeout,
fragment_read_timeout=fragment_read_timeout
or DEFAULT_FRAGMENT_READ_TIMEOUT,
) as client:
try:
response = await client.send_command(
command, interpret=interpret
)
if response := await client.send_command(command):
console.out.print_response(response)
except TimeoutError:
console.err.print(
f"Timeout waiting for response for command: '{command}'"
)
console.out.print_response(response)
def main():
try:

View File

@ -1,5 +1,5 @@
from aioq3rcon import Client
from clypi import Command, Spinner, arg
from clypi import Command, arg
from typing_extensions import override
from q3rcon_cli import console
@ -14,8 +14,6 @@ class Fastrestart(Command):
@override
async def run(self):
async with Spinner('Executing fast restart', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('fast_restart', interpret=True)
if response := await client.send_command('fast_restart'):
console.out.print_response(response)

View File

@ -23,24 +23,21 @@ class Gametype(Command):
@override
async def run(self):
if not self.new_gametype:
async with Spinner('Fetching current gametype', suffix='...'):
if not Gametype.new_gametype:
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('g_gametype')
if response := await client.send_command('g_gametype'):
console.out.print_cvar(response)
return
async with Spinner(f'Changing gametype to {self.new_gametype}', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
await client.send_command(f'g_gametype {self.new_gametype}')
DEFAULT_FRAGMENT_READ_TIMEOUT = client.fragment_read_timeout
await client.send_command(f'g_gametype {self.new_gametype}')
if self.force:
async with Spinner('Forcing gametype change', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
client.timeout = 3
async with Spinner('Forcing gametype change...'):
client.fragment_read_timeout = 1
await client.send_command('map_restart')
console.out.print(
f'Gametype changed successfully to {self.new_gametype}.', style='green'
)
client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT
if response := await client.send_command('g_gametype'):
console.out.print_cvar(response)

View File

@ -1,5 +1,5 @@
from aioq3rcon import Client
from clypi import Command, Positional, Spinner, arg
from clypi import Command, Positional, arg
from typing_extensions import override
from q3rcon_cli import console
@ -19,14 +19,12 @@ class Hostname(Command):
@override
async def run(self):
if not self.new_hostname:
async with Spinner('Fetching current hostname', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('sv_hostname')
if response := await client.send_command('sv_hostname'):
console.out.print_cvar(response)
return
async with Spinner(f'Changing hostname to {self.new_hostname}', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
await client.send_command(f'sv_hostname {self.new_hostname}')
console.out.print(f'Hostname changed to: {self.new_hostname}', style='green')
if response := await client.send_command('sv_hostname'):
console.out.print_cvar(response)

View File

@ -19,18 +19,15 @@ class Map(Command):
@override
async def run(self):
if not self.new_map:
async with Spinner('Getting current map', suffix='...'):
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('mapname')
if response := await client.send_command('mapname'):
console.out.print_cvar(response)
return
async with Spinner('Changing map', suffix='...'):
async with Spinner('Changing map...'):
async with Client(
self.host, self.port, self.password, fragment_read_timeout=1
) as client:
await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
console.out.print(
f'Map changed to {self.new_map.removeprefix("mp_")}', style='green'
)
if response := await client.send_command('mapname'):
console.out.print_cvar(response)

View File

@ -1,5 +1,5 @@
from aioq3rcon import Client
from clypi import Command, Spinner, arg
from clypi import Command, arg
from typing_extensions import override
from q3rcon_cli import console
@ -14,8 +14,6 @@ class Mapname(Command):
@override
async def run(self):
async with Spinner('Getting map name...'):
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('mapname')
if response := await client.send_command('mapname'):
console.out.print_cvar(response)

View File

@ -14,10 +14,9 @@ class Maprestart(Command):
@override
async def run(self):
async with Spinner('Restarting map', suffix='...'):
async with Spinner('Restarting map...'):
async with Client(
self.host, self.port, self.password, timeout=3, fragment_read_timeout=1
self.host, self.port, self.password, fragment_read_timeout=1
) as client:
response = await client.send_command('map_restart', interpret=True)
if response := await client.send_command('map_restart'):
console.out.print_response(response)

View File

@ -14,14 +14,9 @@ class Maprotate(Command):
@override
async def run(self):
async with Spinner('Rotating map', suffix='...'):
async with Spinner('Rotating map...'):
async with Client(
self.host,
self.port,
self.password,
timeout=3,
fragment_read_timeout=1,
self.host, self.port, self.password, fragment_read_timeout=1
) as client:
response = await client.send_command('map_rotate', interpret=True)
if response := await client.send_command('map_rotate'):
console.out.print_response(response)

View File

@ -1,5 +1,5 @@
from aioq3rcon import Client
from clypi import Command, Spinner, arg
from clypi import Command, arg
from typing_extensions import override
from q3rcon_cli import console
@ -14,8 +14,6 @@ class Plugins(Command):
@override
async def run(self):
async with Spinner('Fetching plugins...'):
async with Client(self.host, self.port, self.password) as client:
response = await client.send_command('plugins')
if response := await client.send_command('plugins'):
console.out.print_response(response)

View File

@ -14,10 +14,9 @@ class Status(Command):
@override
async def run(self):
async with Spinner('Fetching status', suffix='...'):
async with Spinner('Fetching status...'):
async with Client(
self.host, self.port, self.password, fragment_read_timeout=1
self.host, self.port, self.password, fragment_read_timeout=0.5
) as client:
response = await client.send_command('status')
if response := await client.send_command('status'):
console.out.print_status(response)

View File

@ -1,7 +1,7 @@
import re
import clypi
from clypi import Boxes, cprint
from clypi import cprint
class Console:
@ -33,8 +33,6 @@ class OutConsole(Console):
r'(?P<rate>[0-9]+)$',
re.IGNORECASE | re.VERBOSE,
)
STATUS_MAP_REGEX = re.compile(r'^map: (?P<mapname>mp_[a-z_]+)$')
CVAR_REGEX = re.compile(
r'^["](?P<name>[a-z_]+)["]\sis[:]\s'
r'["](?P<value>.*?)["]\s'
@ -50,8 +48,9 @@ class OutConsole(Console):
return OutConsole.COLOUR_CODE_REGEX.sub('', s)
def print_response(self, response: str):
if response := self._remove_colour_codes(response).removeprefix('print\n'):
cprint(response, fg=self.style)
response = self._remove_colour_codes(response).removeprefix('print\n')
cprint(f'\n{response}\n', fg=self.style)
def print_status(self, response: str):
_slots = []
@ -70,68 +69,40 @@ class OutConsole(Console):
_guids.append(m.group('guid'))
_names.append(self._remove_colour_codes(m.group('name')))
_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:
cprint('No players connected.', fg='red')
cprint('\nNo players connected.\n', fg=self.style)
return
slots = clypi.boxed(
_slots, title='Slot', width=10, align='center', style=Boxes.ROUNDED
)
scores = clypi.boxed(
_scores, title='Score', width=10, align='center', style=Boxes.ROUNDED
)
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)}')
slots = clypi.boxed(_slots, title='Slot', width=10, align='center')
scores = clypi.boxed(_scores, title='Score', width=10, align='center')
pings = clypi.boxed(_pings, title='Ping', width=10, align='center')
guids = clypi.boxed(_guids, title='GUID', width=len(max(_guids, key=len)) + 4)
names = clypi.boxed(_names, title='Name', width=len(max(_names, key=len)) + 4)
ips = clypi.boxed(_ips, title='IP', width=len(max(_ips, key=len)) + 4)
print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
def print_cvar(self, response: str):
response = self._remove_colour_codes(response).removeprefix('print\n')
if m := self.CVAR_REGEX.match(response):
name = clypi.boxed(
[m.group('name')],
title='Name',
width=max(len(m.group('name')) + 4, 15),
style=Boxes.ROUNDED,
[m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 15)
)
value = clypi.boxed(
[m.group('value')],
title='Value',
width=max(len(m.group('value')) + 4, 15),
style=Boxes.ROUNDED,
)
default = clypi.boxed(
[m.group('default')],
title='Default',
width=max(len(m.group('default')) + 4, 15),
style=Boxes.ROUNDED,
)
info = clypi.boxed(
[m.group('info')],
title='Info',
width=max(len(m.group('info')) + 4, 15),
style=Boxes.ROUNDED,
[m.group('info')], title='Info', width=max(len(m.group('info')) + 4, 15)
)
print(f'{clypi.stack(name, value, default, info, padding=0)}')
print(f'\n{clypi.stack(name, value, default, info, padding=0)}')
out = OutConsole()