重构插件入口与runtime安装流程
This commit is contained in:
58
README.md
58
README.md
@@ -1,47 +1,47 @@
|
||||
# Codex Game Studios
|
||||
|
||||
This repository is the minimal starting framework for a Codex plugin.
|
||||
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:
|
||||
## Current State
|
||||
|
||||
- Skills: `/brainstorm`
|
||||
- Codex custom agents: `creative-director`, `art-director`, `technical-director`, `producer`
|
||||
- Assets: `codex-game-studio.svg`
|
||||
- References: `director-gates.md`, `templates/game-concept.md`
|
||||
- Standards: `design-docs.md`
|
||||
- Commands: `/brainstorm` wrapper document
|
||||
- Scripts: `scripts/install_codex_runtime.py` installs bundled custom agents into a target project
|
||||
- Skills:
|
||||
- `$using-codex-game-studios` explains the plugin workflow and entry points.
|
||||
- `$setup-runtime` installs bundled director agents into a target game project.
|
||||
- `$brainstorm` guides game concept ideation into `design/gdd/game-concept.md`.
|
||||
- Runtime agents: `creative-director`, `art-director`, `technical-director`, `producer`
|
||||
- Runtime source: `runtime/agents/`
|
||||
- References: `references/studio-docs/director-gates.md`, `references/studio-docs/templates/game-concept.md`
|
||||
- Standards: `standards/design-docs.md`
|
||||
- Marketplace: `.agents/plugins/marketplace.json`
|
||||
- No hooks
|
||||
- No rules
|
||||
- No MCP servers
|
||||
- No app integrations
|
||||
- No hooks, rules, MCP servers, or app integrations yet
|
||||
|
||||
The director agents are pre-defined Codex custom agents stored in:
|
||||
## Runtime Setup
|
||||
|
||||
```text
|
||||
.codex/agents/
|
||||
```
|
||||
|
||||
Each custom agent is a standalone TOML file with `name`, `description`, and
|
||||
`developer_instructions`, matching the Codex subagents documentation.
|
||||
|
||||
To install the bundled custom agents into a game project:
|
||||
To install the bundled custom agents into a game project, invoke `$setup-runtime`
|
||||
or run the installer directly:
|
||||
|
||||
```bash
|
||||
python3 scripts/install_codex_runtime.py /path/to/game-project
|
||||
python3 skills/setup-runtime/scripts/install_codex_runtime.py /path/to/game-project
|
||||
```
|
||||
|
||||
The current installer only writes custom agents to:
|
||||
The installer writes custom agents to:
|
||||
|
||||
```text
|
||||
/path/to/game-project/.codex/agents/
|
||||
```
|
||||
|
||||
The only required plugin manifest is:
|
||||
Each runtime agent is a standalone TOML file with `name`, `description`, and
|
||||
`developer_instructions`, matching Codex custom-agent conventions.
|
||||
|
||||
```text
|
||||
.codex-plugin/plugin.json
|
||||
## 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
|
||||
```
|
||||
|
||||
Add plugin components one at a time so each addition can be reviewed, explained, and adjusted before the next component is introduced.
|
||||
|
||||
Reference in New Issue
Block a user