|
|
||
|---|---|---|
| .. | ||
| agents | ||
| references | ||
| scripts | ||
| LICENSE.txt | ||
| README.md | ||
| SKILL.md | ||
hatch-pet (vendored)
This directory is a vendored copy of the Codex hatch-pet skill. It is
checked into the Open Design repo (rather than pulled in as a Git submodule
or an npm package) so that:
- Any Open Design agent can run the skill end-to-end without a network fetch, an extra install step, or an out-of-tree clone.
- The packaged desktop build can ship the skill as inert static assets
alongside the rest of
skills/. - Reviews of changes that touch pet generation can see the skill source in the same diff as the daemon / web wiring that consumes it.
The vendoring trade-off is: this copy will not auto-track upstream revisions. If the upstream skill changes (atlas geometry, manifest shape, script CLIs), this copy must be re-synced by hand. Treat it as a frozen snapshot, not a live dependency.
Provenance
- Skill:
hatch-pet - Pinned upstream reference (declared in
SKILL.mdfrontmatter): see theupstream:field — at vendoring time this pointed to the Codex curatedskills/.curated/hatch-pettree. That URL was not publicly resolvable at the time this README was written; treat the vendored snapshot in this directory as the authoritative source-of-truth for Open Design and re-confirm the upstream pointer the next time a re-sync is performed. - License: Apache License 2.0 (
LICENSE.txtnext to this README). The copyright line in the bundledLICENSE.txtis left unfilled because no separate copyright holder was identified at vendoring time. If a future re-sync confirms the upstream copyright holder, populate the standard ApacheCopyright [yyyy] [name of copyright owner]line and add aNOTICEfile mirroring upstream attribution.
Re-syncing this skill
When the upstream skill changes:
- Locate the upstream source (Codex
skills/.curated/hatch-petor the superseding location). - Replace the contents of this directory with the upstream snapshot,
preserving only this
README.mdand any Open-Design-specific notes insideSKILL.md's> **Open Design integration.**blockquote. - Update the
upstream:field inSKILL.mdfrontmatter with the exact commit SHA / tag of the snapshot. - Update
LICENSE.txtand add aNOTICEfile if upstream now ships attribution metadata.
Where outputs land
The skill packages each pet under
${CODEX_HOME:-$HOME/.codex}/pets/<pet-id>/ with pet.json and
spritesheet.{webp,png,gif}. The daemon scans that directory in
apps/daemon/src/codex-pets.ts; the web pet settings list and one-click
adopt pets from there. See docs/codex-pets.md for the end-user setup
flow (including how Open Design behaves when Codex is not installed).