Skip to content

leecode/codex-pets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codex Pets

Custom Codex pet collection and distribution workspace.

Pet Previews

Pet Preview Animations Install
Cartman Cartman idle · running-right · running-left · waving · jumping · failed · waiting · running · review dist/cartman
BT Buddy BT Buddy idle · running-right · running-left · waving · jumping · failed · waiting · running · review dist/bt-buddy
Cartman — animation previews
idle running-right running-left
idle.mp4 running-right.mp4 running-left.mp4
waving jumping failed
waving.mp4 jumping.mp4 failed.mp4
waiting running review
waiting.mp4 running.mp4 review.mp4
BT Buddy — animation previews
idle running-right running-left
idle.mp4 running-right.mp4 running-left.mp4
waving jumping failed
waving.mp4 jumping.mp4 failed.mp4
waiting running review
waiting.mp4 running.mp4 review.mp4

Layout

codex-pets/
  dist/
    <pet-id>/
      pet.json
      spritesheet.webp
  pets/
    <pet-id>/
      README.md
      package/
        pet.json
        spritesheet.webp
      qa/
        contact-sheet.png
        videos/
        review.json
        run-summary.json
      source/
        decoded/
        final/
        prompts/
        references/
        imagegen-jobs.json
        pet_request.json

dist/<pet-id> is the minimal installable package to share with others. Copy that folder into:

~/.codex/pets/<pet-id>

pets/<pet-id> keeps the working archive for future revisions: QA contact sheet, preview videos, prompts, references, decoded rows, and validation outputs.

Install A Pet Locally

From this workspace:

# Install one or more pets
./install-pet.sh bt-buddy cartman

# List available pets
./install-pet.sh --list

Or manually:

PET_ID=cartman
mkdir -p ~/.codex/pets/$PET_ID
cp -R dist/$PET_ID/. ~/.codex/pets/$PET_ID/

Then choose the pet in Codex's pet selector. If the UI does not refresh immediately, switch to another pet and back.

Add A New Pet

  1. Generate and validate the pet with the hatch-pet workflow.
  2. Copy the minimal package into dist/<pet-id>/.
  3. Copy QA and source artifacts into pets/<pet-id>/.
  4. Add a short pets/<pet-id>/README.md with install notes and known caveats.

About

Custom Codex pet collection and distributable pet packages

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages