the hatchery

docs · updated 2026-05-03

Package a pet

The metadata and sprite files needed for Codex-compatible pets.

Ship two files

A pet package starts with metadata and a spritesheet. The metadata gives Codex a stable ID and state map; the spritesheet carries the visible frames.

bashtree
# works as of 2026-05-03
pet_kernel/
petet.json
spritesheetet.webp

Describe the package

Keep metadata factual. Names, creator handles, state keys, and license text should survive a catalog import without extra interpretation.

jsoncpet.json
// works as of 2026-05-03
{
  "id": "pet_kernel",
  "name": "Kernel",
  "states": ["idle", "thinking", "working", "celebrating"],
  "license": "personal + commercial use"
}