Submit your own Codex pet
A short walkthrough of categories, the folder layout, and what reviewers look for.
Categories
We keep the taxonomy small so browsing stays simple. Pick the closest match when you submit.
Anime CharactersOriginal CharactersAnimalsRobotsMemes
Folder layout
Each pet lives under pets/<pet-slug>--<author-slug>/ and only contains three files.
pets/
└── pet-slug--author-slug/
├── submission.json
├── pet.json
└── spritesheet.webpGenerated previews land in assets/previews/<pet-id>/ and are produced by the build pipeline.
Choose a pet version
v1 keeps the standard 8×9 animation atlas. v2 uses an 8×11 atlas and adds 16 clockwise look directions.
v1: 1536×1872. Omit spriteVersionNumber or set it to 1.
v2: 1536×2288. Set spriteVersionNumber to 2.
Upgrade an installed v1 pet
In Codex, open Settings → Pets and choose Update. Hatch Pet preserves approved standard rows, adds the look-direction rows, and updates the local package. Review it before submitting the three final files to this repository.
Reviewer checklist
- Folder name matches the pet slug and author slug.
- pet.json id equals the folder name.
- spritesheet.webp is the final runtime asset.
- License is declared in submission.json.
- One pet per pull request.