kovagoadiandClaude
f7ca395a4f
The last commit noted in passing that the server-side half of the admin
GameScript channel "is not in this repo -- docker/config is gitignored --
so it has to be updated separately for any of this to work." That was true
of all nine features the README documents: list_vehicles, list_stations,
list_cargo, get_timetable, get_station, get_station_cargo, get_dispatch and
the event stream all answer from 705 lines of Squirrel that no clone could
reproduce, no reviewer could see, and CI never touched.
The bridge now lives in gamescript/AdminBridge/ with its own README, the
same arrangement docker/patches/ uses for the local JGRPP patches, and
docker-compose.yml bind-mounts it read-only over the container's
game/AdminBridge. docker/config stays ignored -- it also holds savegames,
downloaded content and generated config -- so the copy under it is now
shadowed and can be deleted. main.nut is byte-identical to what was running,
apart from the version work below.
Adds a version handshake, because the channel gives no way to tell a stale
bridge from a hung one: a bridge that does not recognise a command drops it
silently, so a client ahead of the server sees nothing but timeouts. The
bridge now answers get_version with its protocol version plus its command
and event catalogues, and get_bridge_version() raises when that is below
GS_BRIDGE_VERSION. It is opt-in rather than checked on connect: GameScripts
do not tick while the game is paused, so an automatic check would refuse to
connect to a paused server. A bridge older than 4 predates get_version
itself and can only fail by timing out, so the E2E test catches that and
reports it by name instead.
tests/test_gamescript.py gives CI a foothold on the GameScript without a
Squirrel toolchain: it parses the .nut files and pins the protocol version
across info.nut, main.nut and protocol.py, the event catalogue against
GameEventType, and the command table against the commands client.py sends.
The version has to be declared three times because a GameScript cannot read
its own info.nut at runtime -- GSController.GetVersion() returns the OpenTTD
version, not the script's.
info.nut also gains MinVersionToLoad() { return 1; }. The engine defaults it
to GetVersion(), so without it this bump would orphan every savegame pinned
to version 3: the scanner finds no compatible script and falls back with a
warning. The bridge keeps no savegame state, so any version can take over.
HandleCommand now dispatches through the same table get_version reports,
rather than an if/else chain, so the catalogue a client feature-detects
against cannot drift from what is implemented.
Co-Authored-By: Claude <[email protected]>
2.0 KiB
OpenTTD JGRPP Docker Server
This setup builds OpenTTD with the JGR Patch Pack (JGRPP) from source and runs it in a Docker container.
Getting Started
-
Build and start the server:
docker-compose up -d --build -
Accessing the console:
docker exec -it openttd-jgrpp openttd -D(Actually, the server runs in dedicated mode. You can view logs with:)
docker-compose logs -f -
Configuration: The configuration is stored in
config/openttd.cfg. The default password is set toasd. -
Save Games: Save games are stored in
config/save/.
AdminBridge GameScript
config/ is gitignored (it holds savegames, downloaded content and generated config), so the
AdminBridge GameScript — the server-side half of the Python client's admin GameScript channel —
is kept in gamescript/AdminBridge/ instead and bind-mounted
read-only over the container's game/AdminBridge by docker-compose.yml. Nothing to install:
docker-compose up serves the tracked copy. Edit it there, not under config/game/, which the
mount shadows. A GameScript is loaded at game start, so restart the server to pick up a change.
Running the server outside this compose file? Copy the directory in by hand instead:
cp -r ../gamescript/AdminBridge ~/.local/share/openttd/game/
JGRPP Source
The source code is cloned from the jgrpp branch of https://github.com/JGRennison/OpenTTD-patches
(currently at tag jgrpp-0.71.1) and carries local patches from patches/ — see
patches/README.md. After a fresh clone of the source, apply them with
git -C OpenTTD-patches am ../patches/*.patch before building.
To update the server to a newer JGRPP version:
- Update the
OpenTTD-patchesdirectory:cd OpenTTD-patches && git pull && cd .. - Reapply (rebase if needed) the local patches from
patches/. - Rebuild the image:
docker-compose up -d --build