CodiePet

English | 简体中文

CodiePet is a local Codex plugin that turns one clear single-person photo into a Q-style animated avatar pack for Codex workspace replies.

Each generated pack is small, local, and workspace-scoped:

codie-pet/
  source/      original photo and approved character preview
  strips/      generated four-frame state strips
  frames/      sliced PNG frames
  gifs/        final Codex state GIFs
  previews/    preview.html and contact-sheet.png

Quick Install

1. Install from Codex App by asking:

   Install https://github.com/hxdflying/codie-pet.git
   

   Then restart Codex App if the plugin list does not refresh automatically. Enable CodiePet from plugin settings if needed.

2. Optional CLI install:

   codex plugin marketplace add hxdflying/codie-pet

3. Optional local development install:

   codex plugin marketplace add .

CodiePet has no third-party runtime Python package dependency.

State Pack

Action	Preview	Used When
idle		General chat, thinking, lightweight answers.
peek		Reading files, inspecting context, checking previews.
loading		Running commands, waiting, long tasks.
coding		Writing code, editing files, generating assets.
error		Failed commands, failed tests, blocked work.
done		Successful final results.

Each state is a four-frame GIF. The v0.1 pack contains 6 states and 24 total animation frames.

Make Your CodiePet

Open a workspace in Codex App and ask:

Create my CodiePet from this photo.

Attach one clear single-person photo. CodiePet will:

1. Save the source photo locally.
2. Generate one Q-style character preview.
3. Ask you to approve the preview.
4. Generate the six GIF states after approval.
5. Validate the pack and offer to install workspace rules.

Generated Files

Generated assets are written inside the current workspace:

codie-pet/
  source/
    original.png
    character-preview.png
  strips/
    idle.png
    peek.png
    loading.png
    coding.png
    error.png
    done.png
  frames/
  gifs/
    idle.gif
    peek.gif
    loading.gif
    coding.gif
    error.gif
    done.gif
  previews/
    contact-sheet.png
    preview.html
  avatar.config.json

The installer updates only the managed CodiePet block in AGENTS.md.

Scope

CodiePet v0.1 is intentionally narrow:

• It supports one clear single-person human photo.
• It does not support multi-person photos, pets, objects, scenery, logos, or custom visual styles.
• It does not modify the Codex desktop app UI.
• It does not create a floating desktop pet overlay.

Remove

Ask Codex:

Remove CodiePet from this workspace.

Or run the installed uninstall script:

python3 /path/to/installed/codie-pet/scripts/uninstall_avatar_rules.py --workspace .

Privacy

CodiePet stores the source photo, approved character preview, state strips, frames, and GIFs locally inside the current workspace under codie-pet/.

The plugin scripts do not add an additional upload step. Image generation is performed by Codex's own image-generation capability, which may use a cloud-hosted GPT Image model or another model selected by the Codex provider. CodiePet does not choose or force a specific image model. Only use photos you have the right to use.

See privacy and terms for plugin metadata policy links.

Development

Install test dependencies:

python3 -m pip install -r requirements-dev.txt

Run tests:

python3 -m pytest tests -q

Validate marketplace metadata:

python3 -m json.tool .agents/plugins/marketplace.json
python3 -m json.tool plugins/codie-pet/.codex-plugin/plugin.json

License

Code is licensed under MIT.