External/codex-game-studio
1
0
Fork 0
mirror of https://github.com/merlinhu1/codex-game-studio.git synced 2026-08-25 07:54:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: polish Open Game Studio README

Browse Source
This commit is contained in:
MerlinH
2026-05-31 01:16:00 +00:00
parent 94d88fe4e1
commit b9275b809a
7 changed files with 164 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture/flows/README.md
+1 -1
View File
@@ -12,7 +12,7 @@ source_of_truth:
## Purpose
These Architecture Flow Guides document Open GameStudio's important runtime scenarios, branching logic, failure paths, and code/truth-doc traceability. They are Markdown docs-as-code runtime views: readable in GitHub/VS Code, reviewable in pull requests, and detailed enough to guide humans and agents through the system.
These Architecture Flow Guides document Open Game Studio's important runtime scenarios, branching logic, failure paths, and code/truth-doc traceability. They are Markdown docs-as-code runtime views: readable in GitHub/VS Code, reviewable in pull requests, and detailed enough to guide humans and agents through the system.
## Professional Framing
docs/architecture/flows/validation-and-repository-truth.md
+5 -5
View File
@@ -13,9 +13,9 @@ source_of_truth:
## Purpose
This architecture flow guide documents the validation path around Open GameStudio behavior changes and the injected Truthmark repository-truth workflow around documentation/routing updates.
This architecture flow guide documents the validation path around Open Game Studio behavior changes and the injected Truthmark repository-truth workflow around documentation/routing updates.
Validation is an Open GameStudio CLI/package behavior. Truthmark is an injected repository-truth workflow/tooling layer for documentation authority, routing, and agent workflow surfaces; it is not an Open GameStudio runtime feature unless product code explicitly implements Truthmark-facing behavior.
Validation is an Open Game Studio CLI/package behavior. Truthmark is an injected repository-truth workflow/tooling layer for documentation authority, routing, and agent workflow surfaces; it is not an Open Game Studio runtime feature unless product code explicitly implements Truthmark-facing behavior.
## Scope
@@ -28,7 +28,7 @@ The guide ends when validation/truth checks have either passed or produced diagn
## Boundaries
Repository validation is an Open GameStudio package behavior implemented by the CLI and validation modules. Truthmark checks are an injected repository-truth workflow/tooling layer for documentation authority and generated agent surfaces, not an Open GameStudio runtime feature.
Repository validation is an Open Game Studio package behavior implemented by the CLI and validation modules. Truthmark checks are an injected repository-truth workflow/tooling layer for documentation authority and generated agent surfaces, not an Open Game Studio runtime feature.
## Entry Points
@@ -107,7 +107,7 @@ flowchart TD
| Condition | Branch | Required action | Output/diagnostic | Owner |
| --- | --- | --- | --- | --- |
| Source/package behavior changed | Functional validation branch | Run relevant tests and `npm run validate`. | Failing package/project check if contract is broken. | Open GameStudio repo |
| Source/package behavior changed | Functional validation branch | Run relevant tests and `npm run validate`. | Failing package/project check if contract is broken. | Open Game Studio repo |
| Generated project behavior changed | Project validation branch | Validate generated-project contracts. | Missing/invalid generated surface diagnostic. | `src/validation.ts` and scaffold owners |
| Public CLI claim changed | CLI contract branch | Update contract truth doc and validation/readme claims together. | Validation or doc drift if missed. | `docs/truth/contracts/cli-and-validation.md` |
| Behavior claim changed | Truth sync branch | Update owning bounded truth doc. | Truthmark may flag stale/unmapped surfaces. | Truthmark docs workflow |
@@ -140,7 +140,7 @@ flowchart TD
## Product Decisions
- `npm run validate` remains the readiness gate before repository parity claims.
- Truthmark checks validate repository-truth routing and generated workflow surfaces without redefining Open GameStudio runtime behavior.
- Truthmark checks validate repository-truth routing and generated workflow surfaces without redefining Open Game Studio runtime behavior.
- Markdown truth docs remain canonical; generated portal HTML remains non-canonical presentation.
## Rationale
docs/architecture/repository-structure.md
+1 -1
View File
@@ -11,7 +11,7 @@ source_of_truth:
## Purpose
Open GameStudio is a Node/TypeScript CLI package that installs and operates Codex-native game studio project workflows.
Open Game Studio is a Node/TypeScript CLI package that installs and operates Codex-native game studio project workflows.
## Scope
docs/plans/codex-game-studio-deep-integration.md
+2 -2
View File
@@ -2,7 +2,7 @@
> **For Hermes:** Do not implement this plan until Merlin explicitly approves it. When approved, use subagent-driven-development skill to implement this plan task-by-task. Do not rewrite git history or push commits unless Merlin explicitly asks.
**Goal:** Reorient Open GameStudio into a Codex-native game-development workflow layer, even if that reduces compatibility with Claude Code, OpenCode, or generic agent backends.
**Goal:** Reorient Open Game Studio into a Codex-native game-development workflow layer, even if that reduces compatibility with Claude Code, OpenCode, or generic agent backends.
**Architecture:** Codex becomes the required runtime spine rather than an optional `--exec` backend. The CLI routes studio roles and workflows through a structured Codex session model, generated projects gain Codex-native instruction/state files, and validation checks Codex readiness plus prompt/workflow rendering. Keep the first implementation file-backed and package-friendly; defer databases, parallel orchestration, and broad backend abstractions until they are proven necessary.
@@ -210,7 +210,7 @@ Add tests for:
- `resolveCodexCommand()` uses `CODEX_BIN` if provided.
- `resolveCodexCommand()` defaults to `codex`.
- `resolveCodexCommand()` does not read legacy Open GameStudio env names.
- `resolveCodexCommand()` does not read legacy Open Game Studio env names.
- `buildCodexExecArgs()` uses `exec`, `--cd <projectRoot>`, sandbox args, and stdin/file prompt mode.
- `checkCodexAvailability()` returns structured diagnostics for tests and error messages.
- normal execution and `validate` fail hard when Codex is unavailable or unauthenticated.
docs/truth/codex/roles-and-workflows.md
+1 -1
View File
@@ -11,7 +11,7 @@ source_of_truth:
## Purpose
Codex roles and workflows provide the role-specific prompt contracts, context boundaries, templates, and render-only workflow shortcuts that make Open GameStudio a Codex-native game-development layer.
Codex roles and workflows provide the role-specific prompt contracts, context boundaries, templates, and render-only workflow shortcuts that make Open Game Studio a Codex-native game-development layer.
## Scope
docs/truth/repository/overview.md
+3 -3
View File
@@ -12,7 +12,7 @@ source_of_truth:
## Purpose
Open GameStudio exists as a Codex-native workflow layer for game-development projects. The repository packages a TypeScript CLI that scaffolds game projects, renders role/workflow prompts for Codex, executes bounded Codex run lifecycles, and validates both repository and generated-project contracts.
Open Game Studio exists as a Codex-native workflow layer for game-development projects. The repository packages a TypeScript CLI that scaffolds game projects, renders role/workflow prompts for Codex, executes bounded Codex run lifecycles, and validates both repository and generated-project contracts.
## Scope
@@ -32,7 +32,7 @@ This bounded leaf truth doc summarizes the repository-level behavior surface. Mo
- Repository behavior is grouped by behavior ownership rather than by mechanically mirroring every source file.
- Generated project instruction contracts use Codex-native `AGENTS.md`; the repository does not introduce `CODEX.md` as a primary instruction contract.
- Runtime execution is explicit: dry-run and print-prompt modes are inspection paths, while non-dry runs write prompt/run metadata before executing Codex.
- Truthmark is an injected repository-truth workflow/tooling layer for agent surfaces and documentation routing. It is not an Open GameStudio runtime feature unless product code explicitly implements Truthmark-facing behavior.
- Truthmark is an injected repository-truth workflow/tooling layer for agent surfaces and documentation routing. It is not an Open Game Studio runtime feature unless product code explicitly implements Truthmark-facing behavior.
## Flows And States
@@ -58,7 +58,7 @@ Architecture runtime walkthroughs live under `docs/architecture/flows/**`; they
## Rationale
The repository combines scaffolding, prompt generation, runtime execution, and validation in one package. Keeping those surfaces bounded makes the architecture easier to reason about and prevents generated agent workflow scaffolding from being mistaken for user-facing Open GameStudio product behavior.
The repository combines scaffolding, prompt generation, runtime execution, and validation in one package. Keeping those surfaces bounded makes the architecture easier to reason about and prevents generated agent workflow scaffolding from being mistaken for user-facing Open Game Studio product behavior.
## Non-Goals