24 lines
941 B
Markdown
24 lines
941 B
Markdown
---
|
|
name: setup-runtime
|
|
description: "Use when a user asks to initialize, install, or refresh the Codex Game Studios runtime in a game project. Installs bundled director custom agents into the target project's .codex/agents directory."
|
|
---
|
|
|
|
# Setup Runtime
|
|
|
|
Install the Codex Game Studios runtime assets into the current game project.
|
|
|
|
## Workflow
|
|
|
|
1. Treat the current working directory as the target project unless the user names another path.
|
|
2. Run `scripts/install_codex_runtime.py <target-project>`.
|
|
3. Report installed, unchanged, and conflicting agent files.
|
|
4. If conflicts are reported, do not overwrite them unless the user explicitly asks for `--force`.
|
|
|
|
The installer copies runtime agents from the plugin's `runtime/agents/` directory to:
|
|
|
|
```text
|
|
<target-project>/.codex/agents/
|
|
```
|
|
|
|
The runtime currently contains only Codex custom-agent TOML files. It does not install hooks, rules, MCP servers, apps, or project templates.
|