Files
codex-game-studios/README.md

77 lines
3.5 KiB
Markdown

# Codex Game Studios
Codex Game Studios is a Codex plugin for game-production workflows. It follows
the normal plugin layout: `.codex-plugin/plugin.json` points to `./skills/`, and
skills expose the runtime workflows directly. Do not use a global
`~/.codex/skills/codex-game-studio` bridge as the plugin entry point.
## Current State
- Skills:
- `$brainstorm` guides game concept ideation into `design/gdd/game-concept.md`.
- `$art-bible` creates and maintains `design/art/art-bible.md` from the game concept's visual identity.
- `$setup-engine` configures engine/version, technical preferences, engine reference docs, and specialist routing.
- Runtime agents for Codex subagent workflows:
- Director agents: `creative-director`, `art-director`, `technical-director`, `producer`
- Art/UX support: `technical-artist`, `ux-designer`
- Godot specialists: `godot-specialist`, `godot-gdscript-specialist`, `godot-csharp-specialist`, `godot-shader-specialist`, `godot-gdextension-specialist`
- Unity specialists: `unity-specialist`, `unity-dots-specialist`, `unity-shader-specialist`, `unity-addressables-specialist`, `unity-ui-specialist`
- Unreal specialists: `unreal-specialist`, `ue-blueprint-specialist`, `ue-gas-specialist`, `ue-replication-specialist`, `ue-umg-specialist`
- Runtime source: `runtime/agents/`
- Project guide template: `project-template/AGENTS.md`
- References: `references/studio-docs/director-gates.md`, `references/studio-docs/templates/game-concept.md`, `references/studio-docs/templates/game-pillars.md`, `references/studio-docs/templates/art-bible.md`, `references/studio-docs/templates/technical-preferences.md`, `references/engine-reference/`
- Standards: `standards/design-docs.md`
- Marketplace: `.agents/plugins/marketplace.json`
- No hooks, rules, MCP servers, or app integrations yet
`$setup-engine` is the next technical step after `$brainstorm`: it pins the
engine version, writes the Technology Stack section in `AGENTS.md`, creates
`docs/technical-preferences.md`, and seeds `docs/engine-reference/<engine>/`.
`$art-bible` is the next visual step after `$brainstorm`: it uses the concept's
Visual Identity Anchor to build `design/art/art-bible.md` section by section,
then runs `AD-ART-BIBLE` through Codex subagent workflow in `full` review mode.
## Review Intensity
`production/review-mode.txt` controls review-gate intensity:
- `full`: all gates active — every workflow step reviewed.
- `lean`: PHASE-GATEs only (`/gate-check`) — per-skill gates skipped.
- `solo`: no director gates anywhere.
## Runtime Setup
To install the bundled project-scoped custom agents into a game project, run
the installer directly:
```bash
python3 scripts/install_codex_runtime.py /path/to/game-project
```
The installer writes all bundled director and engine specialist agents plus the
project guide to:
```text
/path/to/game-project/.codex/agents/
/path/to/game-project/AGENTS.md
```
Each runtime agent is a standalone TOML file with `name`, `description`, and
`developer_instructions`, matching Codex custom-agent conventions and usable by
Codex subagent workflows.
If the target project already has a different `AGENTS.md`, the installer reports
a conflict and leaves it unchanged. Use `--force-agents-md` only when you intend
to overwrite it.
## Packaging Hygiene
Only plugin source files should be packaged. `.git/`, `.env`, `.DS_Store`, local
caches, and generated artifacts are not part of the plugin runtime. Run the
validation script before publishing or refreshing an installed cache:
```bash
python3 scripts/validate_plugin.py
```