Hatch pet guide

Hatch Pet Guide for Codex

Hatch pet helps you turn a character idea into custom Codex pets with generated animation frames, pet.json metadata, and a spritesheet.webp file.

What is hatch-pet?

hatch-pet is the Codex workflow for creating a custom pet: describe the character, let Codex build the animation frames, then choose the finished pet in settings.

Install hatch-pet

Install hatch-pet in Codex first, then restart Codex if the skill installer asks for a restart before you create the pet.

Create custom Codex pets

Write a specific prompt with the pet name, species, mood, colors, and pixel style so the generated result can become a usable Codex pet package.

Check pet.json and spritesheet.webp

A finished package should include pet.json for the pet name and description, plus spritesheet.webp for the animation preview used by Codex Pet Gallery.

Publish the finished pet

Upload the finished package to Studio so visitors can preview the pet, copy the install command, download the files, and share the page.

Publish your pet

Put your pet on a page people can use.

Upload pet.json and spritesheet.webp together. The page shows the preview, file links, package download, creator name, and related pets.