docs: add open-source Countdown Engine SOA architecture package - #54
Merged
Conversation
Adds the platform-neutral Countdown engine service-oriented architecture docs (from open-source-countdown-engine-soa.zip): SOA design, protocol, data models, round plugin API, decisions, roadmap, test strategy, and contributing template. Supports reuse of the Countdown engine outside the CYD firmware (desktop, mobile, web, test).
There was a problem hiding this comment.
Pull request overview
This PR adds a platform-neutral documentation package under docs/countdown-engine-soa/ describing a reusable Countdown-style game engine architecture (round plug-ins, command/event model, multiplayer authority/host migration, protocol outline, and testing strategy) intended to guide future implementations without touching firmware/source code.
Changes:
- Added the core SOA architecture spec (
SOA.md) describing engine boundaries, plug-in lifecycle, multiplayer authority, and host migration. - Added supporting docs for protocol envelope requirements, shared data models, round plug-in contract, testing approach, ADRs, and roadmap.
- Added license and contribution guidance templates for an eventual open-source release.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/countdown-engine-soa/README.md | Introduces the design package and its platform-neutral intent. |
| docs/countdown-engine-soa/SOA.md | Primary architecture/spec document covering engine structure, contracts, and key design choices. |
| docs/countdown-engine-soa/PROTOCOL.md | Defines the multiplayer authority model and required envelope fields at a high level. |
| docs/countdown-engine-soa/DATA_MODELS.md | Sketches shared core data models for rules, results, snapshots, and command handling. |
| docs/countdown-engine-soa/ROUND_PLUGIN_API.md | Documents a proposed round plug-in interface and constraints. |
| docs/countdown-engine-soa/DECISIONS.md | Captures ADRs to explain and preserve architectural rationale. |
| docs/countdown-engine-soa/ROADMAP.md | Outlines phased implementation milestones from core contracts to OSS readiness. |
| docs/countdown-engine-soa/TEST_STRATEGY.md | Lists testability principles, required test doubles, and regression scenarios. |
| docs/countdown-engine-soa/LICENSE_RECOMMENDATION.md | Recommends Apache-2.0 and highlights separate licensing needs for content packs. |
| docs/countdown-engine-soa/CONTRIBUTING_TEMPLATE.md | Provides a contribution checklist aligned with the architecture’s constraints. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,965 @@ | |||
| # System-Oriented Architecture: Open-Source Countdown Engine | |||
Comment on lines
+7
to
+14
| - unique type ID | ||
| - version | ||
| - initial-state factory | ||
| - command handler | ||
| - event reducer | ||
| - snapshot serializer | ||
| - result producer | ||
| - completion flag |
| - host retained on tie | ||
| - reconnect restores exact state | ||
| - replay reproduces final score | ||
| - invalid Number step does not consume operands |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the open-source Countdown Engine SOA (service-oriented architecture) design package from
open-source-countdown-engine-soa.zip, checked in underdocs/countdown-engine-soa/.This is a platform-neutral architecture/design spec for a reusable Countdown-style game engine (Numbers, Letters, Conundrum rounds) intended to work across embedded devices (CYD), desktop, mobile, web, and automated test environments — independent of any specific UI or hardware.
Contents added
README.md— package overviewSOA.md— core service-oriented architecture design (965 lines)PROTOCOL.md— sync/communication protocolDATA_MODELS.md— shared data model definitionsROUND_PLUGIN_API.md— plug-in API for round typesDECISIONS.md— architecture decision logROADMAP.md— implementation roadmapTEST_STRATEGY.md— testing approachLICENSE_RECOMMENDATION.mdCONTRIBUTING_TEMPLATE.mdRelation to existing work
This complements the in-progress
core/extraction onfeat/issue-52-countdown-engine(#53) and the Android companion BLE architecture work (#48–#51) by giving a portable, hardware-independent design target for the Countdown engine itself. No firmware/source code is touched — docs only.Testing
Docs-only change; nothing to build or run.