Installation

How to install hatch-pet

hatch-pet is the Codex skill workflow used to create, validate, and package custom animated pets from a text concept or reference image.

Before you start

This guide assumes you are using a Codex environment that supports Skills and can run commands that begin with $.

Detailed steps

1. Run $skill-installer hatch-pet in a Codex conversation.
2. Restart Codex so the new skill is available.
3. Start a new conversation and run $hatch-pet with a pet description or reference image.
4. Review the contact sheet, then install the finished package under ~/.codex/pets/<pet-name>/.

1. Install the skill

Type this command in a Codex conversation:

$skill-installer hatch-pet

If Codex asks you to confirm the skill installation, follow the prompt. After installation, fully restart Codex.

2. Verify the skill

Open a fresh Codex conversation and type:

$hatch-pet

If Codex recognizes the command, the skill is available. If it does not, restart Codex and try again.

3. Create a first pet

Give hatch-pet a short, specific concept:

$hatch-pet Create a teal pixel robot pet with a white body, black screen face, small antenna, and cute compact proportions.

You can also attach a reference image and ask hatch-pet to use it as the visual source of truth.

4. Review the output

Before installing the package, check that:

• The pet identity stays consistent across every animation row.
• The atlas has no labels, grid lines, or unwanted background.
• The final package contains pet.json and spritesheet.webp.

5. Install the finished pet

~/.codex/pets/<pet-name>/
  pet.json
  spritesheet.webp

Restart Codex, then open Appearance / Pets and choose the new pet.

Common issues

The command does nothing

Make sure you are typing it in Codex, not in your system terminal. Skill commands begin with $.

hatch-pet is still unavailable

Restart Codex and test $hatch-pet in a new conversation. If it still fails, Skills may not be enabled in your current environment.

The pet does not show up

Check that the folder is under ~/.codex/pets/<pet-name>/ and contains pet.json plus spritesheet.webp. You can compare the package with the format spec.

Next: create your first Codex Pet.