Files
codex-game-studio/docs/examples/README.md
T

3.0 KiB

Examples

This directory contains scenario-oriented examples for using Codex Game Studio. Each example focuses on the workflow shape: what you are trying to do, which commands you run, and what you learn.

Start here

If you are new to the system, read the root README, run the quick start, then come back here for common scenarios.

Available examples

Create and validate a Godot prototype

Type: project initialization
Complexity: low

Create a local project, inspect its state, and run validation.

./codex-game-studio init --name "Rogue Core" --engine godot --mode prototype --non-interactive \
  --competitor "Mini Metro" --competitor "Dorfromantik"
./codex-game-studio status --project projects/rogue-core
./codex-game-studio validate --project projects/rogue-core

Learn: project creation, generated project location, status output, and project validation.


Run a producer market pass

Type: role execution
Complexity: low-medium

Inspect the prompt first, then run the producer role through Codex.

./codex-game-studio run producer --project projects/rogue-core \
  "Create the initial market overview." --print-prompt

./codex-game-studio run producer --project projects/rogue-core \
  "Create the initial market overview."

Learn: role selection, prompt inspection, direct Codex execution, and review-before-trust workflow.


Prepare focused workflow prompts

Type: workflow prompt rendering
Complexity: low

Render workflow prompts without launching Codex.

./codex-game-studio market --project projects/rogue-core --dry-run
./codex-game-studio analytics --project projects/rogue-core --dry-run
./codex-game-studio handoff --project projects/rogue-core --dry-run
./codex-game-studio design-spec --project projects/rogue-core --dry-run
./codex-game-studio feel-review --project projects/rogue-core --dry-run
./codex-game-studio ui-review --project projects/rogue-core --dry-run

Learn: workflow shortcuts are preparation surfaces; they do not launch Codex or create run records.


Create a vertical-slice task plan

Type: file-backed task workflow
Complexity: medium

Turn a supported workflow recipe into explicit project tasks.

./codex-game-studio workflow create-tasks vertical-slice --project projects/rogue-core
./codex-game-studio validate --project projects/rogue-core

Learn: task recipes, .codex/tasks.json, and validation after task-state changes.


Discover packaged templates

Type: template discovery
Complexity: low

List templates and inspect one before using it in a role prompt or design session.

./codex-game-studio templates list
./codex-game-studio templates show market_analysis

Learn: packaged template IDs and how templates support studio workflows.

More detail