120 lines
3.2 KiB
Markdown
120 lines
3.2 KiB
Markdown
# Codex Game Studios Project Guide
|
|
|
|
This file is the root project guide for Codex. It is installed at the game
|
|
project root so Codex and bundled subagents have shared context before running
|
|
game-production workflows.
|
|
|
|
## Technology Stack
|
|
|
|
- **Engine**: [CHOOSE: Godot 4 / Unity / Unreal Engine 5]
|
|
- **Language**: [CHOOSE: GDScript / C# / C++ / Blueprint]
|
|
- **Version Control**: Git with trunk-based development
|
|
- **Build System**: [SPECIFY after choosing engine]
|
|
- **Asset Pipeline**: [SPECIFY after choosing engine]
|
|
|
|
> Engine-specialist agents will be added later. For now, use the four bundled
|
|
> director agents only when a workflow explicitly asks for them.
|
|
|
|
## Runtime Agents
|
|
|
|
Bundled custom agents are installed into:
|
|
|
|
```text
|
|
.codex/agents/
|
|
```
|
|
|
|
Current bundled agents:
|
|
|
|
- `creative-director`
|
|
- `art-director`
|
|
- `technical-director`
|
|
- `producer`
|
|
|
|
These agents are primarily used by director / lead review gates. They are not a
|
|
replacement for user decisions.
|
|
|
|
## Review Intensity
|
|
|
|
Review intensity is configured by:
|
|
|
|
```text
|
|
production/review-mode.txt
|
|
```
|
|
|
|
Allowed values:
|
|
|
|
- `full` — all key director / lead review gates call their custom agents.
|
|
- `lean` — only PHASE-GATE review gates such as `/gate-check` call directors;
|
|
ordinary per-skill review gates are skipped.
|
|
- `solo` — all director review gates are skipped.
|
|
|
|
Default when the file is missing: `lean`.
|
|
|
|
This is not a global switch for all custom-agent usage. Future team workflows
|
|
may still call specialist subagents as part of their core work.
|
|
|
|
## Collaboration Protocol
|
|
|
|
User-driven collaboration, not autonomous execution. Every workflow follows:
|
|
|
|
```text
|
|
Question -> Options -> Decision -> Draft -> Approval
|
|
```
|
|
|
|
- Ask clarifying questions when the user's intent or constraints are unclear.
|
|
- Present options with trade-offs before major creative or technical decisions.
|
|
- The user makes final strategic decisions.
|
|
- Show drafts or summaries before writing important project files.
|
|
- Do not commit changes unless the user asks.
|
|
- Do not overwrite existing project guidance or design documents without
|
|
explicit approval.
|
|
|
|
## Current Workflow Surface
|
|
|
|
The current plugin build exposes only the migrated `/brainstorm` workflow.
|
|
|
|
`/brainstorm` produces:
|
|
|
|
```text
|
|
design/gdd/game-concept.md
|
|
design/gdd/game-pillars.md
|
|
```
|
|
|
|
In default `lean` mode, `/brainstorm` writes the initial pillar document itself.
|
|
In `full` mode, the `creative-director` review gate participates in creating or
|
|
updating the pillar document.
|
|
|
|
## Design Documents
|
|
|
|
Use these project paths:
|
|
|
|
```text
|
|
design/gdd/
|
|
design/ux/
|
|
docs/architecture/
|
|
production/
|
|
```
|
|
|
|
`design/gdd/game-concept.md`, `design/gdd/game-pillars.md`, and
|
|
`design/gdd/systems-index.md` are top-level design documents. They are not
|
|
per-system GDDs.
|
|
|
|
Per-system GDDs under `design/gdd/` should include:
|
|
|
|
1. Overview
|
|
2. Player Fantasy
|
|
3. Detailed Rules
|
|
4. Formulas
|
|
5. Edge Cases
|
|
6. Dependencies
|
|
7. Tuning Knobs
|
|
8. Acceptance Criteria
|
|
|
|
## Context Management
|
|
|
|
- If a workflow becomes long, persist decisions into the relevant project file
|
|
instead of relying only on chat context.
|
|
- When resuming, read existing project documents before restarting a workflow.
|
|
- Preserve user-authored content and update only the sections needed for the
|
|
active task.
|