OpenPets docs
Codex pet install and validation guide
This page documents the V1 package shape and compatibility checks used by the gallery, preview player, and validator.
Install finished packs
Download a .codex-pet.zip package, unzip it into ~/.codex/pets/<pet-id>/, then choose the pet from Codex Settings → Appearance → Pet or use /pet in a session.
Manifest contract
A V1 pet pack includes pet.json and spritesheet.png or spritesheet.webp. The recommended atlas is 1536×1872 with 8 columns, 9 rows, and 192×208 cells.
Validator rules
OpenPets reports FAIL for invalid JSON, missing idle animation, unsupported spritesheet types, out-of-range frames, and dimension mismatches. WARN means installable with compatibility risk.
Creator submission
Submit a downloadable package with source, creator name, license, manifest, spritesheet, preview cover, and a validation report. Avoid unclear licensing.
Compatibility notes
- Browser preview can load a public URL, but local Codex install packages should keep spritesheetPath relative.
- The V1 player maps product states as thinking → waiting/running, success → review/waving, and error → failed.
- Full AI generation is intentionally outside V1. Creator tools start with validated finished packs and submission guidance.