docs: correct Godot Games Client in the beta README

Evidence: spikersoft-games-godot@main Modes/MainMenu/main_menu.gd:28 routes dungeon and voxel into Space, and hex into the engine.
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
spikerjandCursor committed 2026-10-06 03:39:23 -04:00
1 parent 2544688fde
commit 6c2293e389
1 file changed
+10 -8
+10 -8
View File
@@ -906,16 +906,18 @@ A **path** merges recorded routes into a canonical course; routes attach to it a
| Mode | Status | Transport | | Mode | Status | Transport |
|---|---|---| |---|---|---|
| **Space** | Playable MVP: connect → create/list ship → join zone → 6DOF flight → peers → shoot → radar/survey → HUD | GameServer WSS + MessagePack | | **Space** | Playable. The engine assigns the ship and opens the arena. The legacy path still uses the lobby: connect, create or list a ship, join the zone, then 6DOF flight, peers, shoot, radar, survey, and the HUD. | Engine (`wss://engine.spikersoft.com/ws`, protocol 105) when the host sets `useEngine`, and on web and desktop release. GameServer (`wss://gameserver.spikersoft.com/ws`, ProtocolVersion 2) otherwise. |
| **Dungeon Crawler** | Menu stub | GameServer (planned) | | **Dungeon** | Not a separate mode. The button enters Space and says to descend through a portal. Without the engine it opens a stub that says the engine is required. | Engine, from Space |
| **Voxel** | Menu stub | GameServer (planned) | | **Voxel** | Not a separate mode. The button enters Space and says to land on a planet you hold. Without the engine, the same stub. | Engine, from Space |
| **Hex Tower Defence** | Menu stub | API SignalR `/hubs/hex-tower-defence` (not GameServer) | | **Hex Tower Defence** | Practice solo match (`hex_td_practice`). Planet conquest starts from Space. | Engine WebSocket. This client does not use the API SignalR hub `/hubs/hex-tower-defence`. |
> **Known gap:** both mobile Games hubs present a **Chess** card and launch the Godot host with `mode: "chess"`, but no chess mode exists in the Godot repo yet — the launch lands on the main menu. (Multiplayer chess is already gated behind a "Coming soon" alert; single-player is not.) > **Known gap:** both mobile Games hubs present a **Chess** card and launch the Godot host with `mode: "chess"`, but no chess mode exists in the Godot repo yet — the launch lands on the main menu. (Multiplayer chess is already gated behind a "Coming soon" alert; single-player is not.)
Space-mode client features: Descent-style 6DOF mobile controls (left stick slide, right stick pitch/yaw, roll buttons, thrust/reverse/fire/boost), a mobile-only cruise-throttle latch, a ship-anchored camera rig ported exactly from the web client, off-screen ship indicators at web-HUD parity, unified targeting across ships/radar contacts/celestial bodies, celestial **survey** scanning with a report panel (threat/age/bio/robotic/composition), and a destroyed overlay with ~5 s server auto-respawn. Space-mode client features: Descent-style 6DOF touch controls (left stick slide, right stick pitch/yaw, roll buttons, thrust/reverse/fire/boost; hidden when the device is not a touchscreen), a cruise-throttle slider that holds a baseline between momentary thrust and reverse, a ship-anchored camera rig ported exactly from the web client, off-screen ship indicators at web-HUD parity, unified targeting across ships/radar contacts/celestial bodies, celestial **survey** scanning with a report panel (threat/age/bio/robotic/composition), and a destroyed overlay with ~5 s server auto-respawn.
### Wire protocol (GameServer) ### Wire protocol
The mobile apps' Space mode, the web build, and a desktop release build connect to the Rust engine at `wss://engine.spikersoft.com/ws?token=<JWT>` (protocol version 105: MessagePack control messages, plus a binary tick packet). The bullets below are the legacy GameServer client, used by the editor and by a run that does not opt into the engine.
`wss://gameserver.spikersoft.com/ws?token=<JWT>` — Keycloak JWT in the query string; **MessagePack maps, camelCase keys, `type` discriminator**; server `ProtocolVersion = 2`. Full reference: `docs/PROTOCOL.md` in the repo. `wss://gameserver.spikersoft.com/ws?token=<JWT>` — Keycloak JWT in the query string; **MessagePack maps, camelCase keys, `type` discriminator**; server `ProtocolVersion = 2`. Full reference: `docs/PROTOCOL.md` in the repo.
@@ -928,10 +930,10 @@ Space-mode client features: Descent-style 6DOF mobile controls (left stick slide
- **Android**: `GamesActivity extends GodotActivity`; JWT + `mode`/`vs`/`difficulty` are injected through `SpikerSoftHostPlugin` (a `GodotPlugin` exposing `get_access_token()`, `get_mode()`, `request_exit()`, …). A Gradle `syncGodotProject` task copies the sibling `../spikersoft-games-godot` checkout into `app/src/main/assets` on every build. - **Android**: `GamesActivity extends GodotActivity`; JWT + `mode`/`vs`/`difficulty` are injected through `SpikerSoftHostPlugin` (a `GodotPlugin` exposing `get_access_token()`, `get_mode()`, `request_exit()`, …). A Gradle `syncGodotProject` task copies the sibling `../spikersoft-games-godot` checkout into `app/src/main/assets` on every build.
- **iOS**: **SwiftGodotKit** loads `Resources/games.pck` (exported with `godot --headless --export-pack`). SwiftGodotKit has no plugin channel, so the handoff is **file-based**: Swift writes `host_session.json` (`{token, mode, vs, difficulty}`) *before* engine construction; Godot reads it as a one-shot and deletes it so the JWT never sits on disk. Exit requests flow back the same way (Godot writes `user://host_exit_request.json`; the SwiftUI side polls and dismisses). - **iOS**: **SwiftGodotKit** loads `Resources/games.pck` (exported with `godot --headless --export-pack`). SwiftGodotKit has no plugin channel, so the handoff is **file-based**: Swift writes `host_session.json` (`{token, mode, vs, difficulty}`) *before* engine construction; Godot reads it as a one-shot and deletes it so the JWT never sits on disk. Exit requests flow back the same way (Godot writes `user://host_exit_request.json`; the SwiftUI side polls and dismisses).
- The shells draw **no chrome** over the game (nav/status bars hidden, full-bleed) — the only way out is the in-game `Exit Games`. All 2D UI sits inside a safe-area control inset to `DisplayServer.get_display_safe_area()` for notch/Dynamic-Island handling. - The shells draw **no app chrome** over the game. iOS also hides the status bar and leaves through the in-game `Exit Games` button; Android uses a no-action-bar theme and also has the hardware back button. All 2D UI sits inside a safe-area control inset to `DisplayServer.get_display_safe_area()` for notch/Dynamic-Island handling.
- **Desktop/editor**: paste a Keycloak token on the main menu or pass `--token=`; hosted sessions hide the paste UI. - **Desktop/editor**: paste a Keycloak token on the main menu or pass `--token=`; hosted sessions hide the paste UI.
Note: this repo currently has **no CI** — in-engine test scripts only (`tests/wire_selftest.gd`, `tests/arena_smoke.gd`). Note: Gitea Actions CI (`.gitea/workflows/ci.yml`) runs the in-engine scripts, including `tests/wire_selftest.gd` and `tests/arena_smoke.gd`.
--- ---