Manifest reference

Codex Pet pet.json Reference

The manifest identifies the pet and tells Codex which spritesheet contract to use. Keep pet.json and spritesheet.webp together in the same pet directory or ZIP root.

V2 example

{
  "id": "miso-byte",
  "displayName": "Miso Byte",
  "description": "A tiny debugging cat for Codex.",
  "spritesheetPath": "spritesheet.webp",
  "spriteVersionNumber": 2,
  "kind": "animal"
}

Field rules

  • id: lowercase letters, numbers, and hyphens
  • displayName: human-readable pet name
  • description: short explanation shown in galleries
  • spritesheetPath: spritesheet.webp
  • spriteVersionNumber: use 2 for an 8×11 atlas
  • kind: optional category such as animal or person

Common errors

  • Manifest id does not match the installation directory
  • spriteVersionNumber is missing from a V2 atlas
  • spritesheetPath points to another filename
  • WebP dimensions do not match the selected version
  • Files are nested inside an extra ZIP directory

Related resources