From 19aeac6b4ff967b1c292848f15d124d608c8e843 Mon Sep 17 00:00:00 2001 From: Joseph Spiker Date: Tue, 6 Oct 2026 05:20:24 -0400 Subject: [PATCH] docs: correct spikersoft-gaming-engine in the beta README spikersoft-gaming-engine@main protocol/game-protocol.yaml:19 Co-authored-by: Cursor --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 2e39f2a..2bc1af2 100644 --- a/README.md +++ b/README.md @@ -944,6 +944,14 @@ Note: Gitea Actions CI (`.gitea/workflows/ci.yml`) runs the in-engine scripts, i --- +## Gaming Engine + +`spikersoft-gaming-engine` is the Rust simulation that replaces the C# GameServer for clients that opt in. The Godot client, the web build, and the desktop release connect at `wss://engine.spikersoft.com/ws?token=`. Protocol version **105**. Control messages are MessagePack maps. Each tick is a binary packet. The first frame is `ServerHello`; the client must answer `ClientHello` within 5 seconds or the server closes the socket (4002). A version mismatch closes with 4001. + +The zone runs at 30 Hz. A Hex Tower Defence match runs at 25 Hz. A planet surface runs at 10 Hz. On the engine path the Space client predicts its own ship on that shared sim and reconciles to the server. The license is `LicenseRef-Proprietary`, and the crates are not published. + +--- + ## Desktop Stacker (spikersoft-stacker) A **local, offline-first** focus-stacking application (Zerene/Helicon class) for macro photography — one self-contained executable per OS (macOS / Windows / Linux). It began as a port of the platform's former PhotoStack pipeline (artpipe `align.py` + `fusion.py`, retired 2026-09-25) to a fast desktop workflow; algorithm parity with the Python implementation is verified by a test harness in the repo. @@ -1509,6 +1517,7 @@ dotnet test --filter "Category!=Integration" # Skip tests tagged Category=Integ | Python art pipeline, model backends, its Dockerfiles | `spikersoft-artpipe` | | Native mobile apps | `spikersoft-ios` / `spikersoft-android` | | Godot client | `spikersoft-games-godot` | +| Rust game engine | `spikersoft-gaming-engine` | **There is no central tracker.** `spikerj/spikersoft-issues` was retired on 2026-08-07 and now holds this README only — do not file there. @@ -1614,6 +1623,7 @@ docker build -t spikersoft-angular -f Dockerfile . | Native Mobile Apps | See main README — [Native Mobile Apps](#native-mobile-apps-ios--android); repos: `spikersoft-ios/`, `spikersoft-android/` | | Activity Tracker | See main README — [Activity Tracker, Routes & Paths](#activity-tracker-routes--paths) | | Godot Games Client | See main README — [Godot Games Client](#godot-games-client); protocol: `spikersoft-games-godot/docs/PROTOCOL.md` | +| Gaming Engine | See main README — [Gaming Engine](#gaming-engine); repo: `spikersoft-gaming-engine/README.md` | | Desktop Stacker | See main README — [Desktop Stacker](#desktop-stacker-spikersoft-stacker); repo: `spikersoft-stacker/README.md` | | Time & Materials | See main README — [Time & Materials](#time--materials-apitm); repo: `spikersoft-time-and-materials/README.md` | | Marks Field Service (legacy) | See main README — [Marks Field Service](#marks-field-service-legacy-crm) | @@ -2688,6 +2698,7 @@ Licensing is **not uniform across the monorepo**; use the SPDX / files in each p - **Angular app** ([`spikersoft-angular/package.json`](spikersoft-angular/package.json)): `"license": "AGPL-3.0"`. - **Backend** ([`spikersoft-backend/README.md`](spikersoft-backend/README.md)): that file says there is no `LICENSE` in the repository. [`SpikerSoft.sln`](spikersoft-backend/SpikerSoft.sln) still names `LICENSE.md` as a solution item, but the file is not in the tree, and the repo states no license. +- **Gaming engine** ([`spikersoft-gaming-engine/Cargo.toml`](spikersoft-gaming-engine/Cargo.toml)): `"license": "LicenseRef-Proprietary"`. The crates are not published. Earlier text here referred to an “Academic License” and a single `LICENSE` at repo root — **there is no shared root license file in this workspace layout**; rely on the paths above.