Codex Anime Pets

English | 中文

A searchable collection of Codex desktop pets. Each pet is stored as a self-contained folder under pets/<pet-id>/, with install files, preview media, QA metadata, and the saved creation prompt.

Currently included:

• Assistant-004 - original chibi AI lab assistant, skeptical coding partner, retro sci-fi researcher.
• March 7th - unofficial fan-made chibi Codex pet of the cheerful pink-haired Star Rail photographer.
• Cirno (009) - unofficial fan-made chibi Codex pet of the overconfident ice fairy.

AI Search Catalog

For AI agents, scripts, and search tools:

• catalog.json - machine-readable pet registry
• PETS.md - human-readable pet list
• indexes/ai-search-index.json - flattened retrieval index
• indexes/tags.json - tag-to-pet lookup table
• schemas/catalog.schema.json - lightweight schema for future entries
• manifest.json - package file hashes

Suggested AI search query examples:

Find a Codex pet that feels like a skeptical AI lab assistant.
Find a chibi coding partner pet with retro sci-fi research vibes.
Find a desktop pet for AI engineers, code review, debugging, and model training.

Quick Install

Default installs assistant-004. Fan-made pets can be installed by passing their pet id.

Windows

Double-click:

scripts\install.bat

Or run:

powershell -ExecutionPolicy Bypass -File .\scripts\install.ps1

Install a specific pet:

powershell -ExecutionPolicy Bypass -File .\scripts\install.ps1 -PetId assistant-004

List available pets:

powershell -ExecutionPolicy Bypass -File .\scripts\install.ps1 -List

macOS / Linux

chmod +x scripts/install.sh
./scripts/install.sh

Install a specific pet:

./scripts/install.sh --pet assistant-004

List available pets:

./scripts/install.sh --list

Universal Python Installer

python scripts/install.py

Install a specific pet:

python scripts/install.py --pet assistant-004

Install all pets:

python scripts/install.py --all

List pets:

python scripts/install.py --list

The installer copies each selected pet's pet.json and spritesheet.webp to:

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

If CODEX_HOME is set, the installer uses:

$CODEX_HOME/pets/<pet-id>/

Manual Install

Copy:

pets/assistant-004/pet.json
pets/assistant-004/spritesheet.webp

to:

~/.codex/pets/assistant-004/

Expected final layout:

.codex/
  pets/
    assistant-004/
      pet.json
      spritesheet.webp

Repository Layout

catalog.json
PETS.md
indexes/
  ai-search-index.json
  tags.json
manifest.json
schemas/catalog.schema.json
scripts/
  install.bat
  install.ps1
  install.py
  install.sh
pets/
  assistant-004/
    README.md
    pet.json
    spritesheet.webp
    creation-prompt.md
    assets/
      contact-sheet.png
      previews/*.gif
      validation.json
      review.json

Adding More Pets

To add another pet later:

1. Create pets/<new-pet-id>/.
2. Add pet.json and spritesheet.webp.
3. Add preview media and prompt files if available.
4. Add a new entry to catalog.json.
5. Add a short listing to PETS.md.
6. Regenerate manifest.json.

License and Fan Notice

Repository code and original metadata are MIT-licensed unless stated otherwise. Fan-made character pets are unofficial derivative fan assets; the underlying characters and franchises remain owned by their respective rights holders. See NOTICE.md and each pet README before redistribution.

GitHub Sharing

This repository is ready to clone, install, and extend:

git clone git@github.com:David-Lzy/codex_anime_pets.git
cd codex_anime_pets
python scripts/install.py --list
python scripts/install.py --pet assistant-004