kovagoadi/openttd-client

Fork 0

Files

History

kovagoadi 81a4d9333d

Continuous Integration / lint-and-security (pull_request) Successful in 20s

Details

Continuous Integration / tests-and-coverage (pull_request) Successful in 24s

Details

Add station listing and cargo queries to admin client

Extends the AdminBridge GameScript JSON channel (the same relay used by
list_vehicles/get_timetable) with station support:

- list_stations(): enumerate stations, fire-and-forget like list_vehicles().
- get_station(): authoritative per-cargo snapshot of a station's live state,
  with both the real-time waiting amount (GSStation.GetCargoWaiting) and the
  planned cargodist link-graph flow (GetCargoPlanned), plus rating.
- get_station_cargo(): break one cargo type down by source station and by
  next hop (the cargodist routing destination) for both waiting and planned
  amounts, with optional from_station/via_station filters.

All three use stock GameScript API (no server patch, unlike timetables).
Refactors the shared GS request/reply correlation out of get_timetable and
get_station into a _gs_query() helper. Companion handlers must be added to
the server-side AdminBridge GameScript (not tracked in this repo).

Includes unit + e2e tests, a worked demo in main_admin.py, and protocol docs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-07-23 21:48:20 +02:00

__init__.py

Add admin port support with other major refactorations

2026-06-29 19:47:48 +02:00

client.py

Add station listing and cargo queries to admin client

2026-07-23 21:48:20 +02:00

decorators.py

Add admin port support with other major refactorations

2026-06-29 19:47:48 +02:00

protocol.py

Add vehicle timetable get/set support

2026-07-16 23:21:21 +02:00

README.md

Initialized openttd-client repo

2026-06-05 23:18:09 +02:00

README.md

Internal Package: openttd

This directory contains the core implementation of the OpenTTD network client.

Modules

__init__.py: Exposes the high-level OpenTTDClient API.
client.py: Implementation of the OpenTTDClient class. Manages the connection lifecycle, PAKE state, map synchronization, and keep-alive.
protocol.py: Implementation of the OpenTTDProtocol class. Handles low-level binary packet serialization, AEAD stream encryption, and static packet parsing.

Design Goals

Encapsulation: The user should never need to manually handle bytes or encryption keys.
Robustness: Gracefully handle server errors and unknown packet types.
Efficiency: Use asyncio for non-blocking I/O and monocypher for fast cryptographic operations.