Skip to content

About

Nine animated Codex v2 desktop pets with checksum-verified installers for macOS, Linux, and Windows. Unofficial, non-commercial fan project.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

codex-nikeru8-pets

codex-nikeru8-pets icon: a tiny coding companion peeking from a terminal window

English | 繁體中文

Validate pets Latest tag

Bring Frieren, Fern, Stark, the Elric Brothers, the Nina and Alexander Chimera, original Lucy, Lucy Pixel, Rebecca, and Miss Minutes along while you work in Codex.

This repository contains nine animated Codex v2 pets maintained by Nikeru8. Every pet includes complete idle, movement, interaction, work-state, and 16-direction look animations. Install just your favorites or bring home the entire collection.

curl -fsSL https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.sh | bash -s -- all

Choose a desktop companion by series

Every preview uses a fixed 192 × 208 display area so that different source GIF dimensions do not distort the table layout.

Fantasy adventure | Frieren: Beyond Journey's End

Preview Character and highlights
Frieren summons magic circles and fires magic missiles Frieren v2
The hover animation summons one to three magic circles before firing magic missiles.
frieren-v2--nikeru8
Fern transitions smoothly from a thrust to a reverse follow-up attack Fern v2
While Codex is working, Fern charges briefly, fires down and to the left, crosses her staff through a transition, and follows with a rising reverse shot. All six frames that Codex plays are arranged as continuous in-betweens. Her scale changes gradually through 100% → 96% → 91% → 87% → 91% → 96%, moving her away and then back toward the viewer. The magic circles flash only at the two firing moments, preserving a sense of speed while making the mid-animation turn and loop transition feel more cohesive.
fern--nikeru8
Stark leaps, swings his axe downward, and shatters rock Stark v2
While Codex is working, Stark gathers strength, leaps with his axe raised, and slams downward. Small rock fragments fly when the blade lands before he settles into a crouch.
stark--nikeru8

Alchemical fantasy | Fullmetal Alchemist: Brotherhood

Preview Character and highlights
Edward and Alphonse wave together in a two-character animation Elric Brothers v2
Edward and Alphonse act side by side in every frame as a single two-character pet. Its lightly pixelated visual language complements the Frieren collection in this repository. While Codex is working, both brothers crouch as Edward activates a cyan transmutation circle with his automail hand. See the work animation and idle animation.
elric-brothers--nikeru8
Nina and Alexander Chimera idle animation Nina & Alexander Chimera v2
An unofficial chibi pet based on Nina Tucker and Alexander after their tragic transmutation. Warning: 「用了會下地獄,請小心使用」 (“Using it may send you to hell—please use with care.”) See the work animation and wave animation.
nina-alexander-chimera--nikeru8

Science fiction / cyberpunk | Cyberpunk: Edgerunners

Preview Character and highlights
Original Lucy idle animation Lucy v2 (Original)
A cool-toned, super-deformed cel-shaded design with the correct outfit and a consistent character scale across nine states and all look directions.
See the work animation and wave animation.
lucy--nikeru8
Lucy Pixel idle animation Lucy Pixel v2
A pixel-style design that preserves the correct outfit and keeps the character at a consistent scale across all animations. See the wave animation.
lucy-pixel--nikeru8
Rebecca fires repeatedly Rebecca v2
A neon cel-shaded design with a light pixel texture. Her wave is replaced by a gleeful burst of gunfire; see the reload animation with its stabilized character scale.
rebecca--nikeru8

Retro science fiction | Marvel Studios' Loki

Preview Character and highlights
Miss Minutes wave animation Miss Minutes v2
An orange clock mascot in a retro television-animation style, smiling along while you wait and work. See the idle animation.
miss-minutes--nikeru8

Installation

The commands below are pinned to v1.7.0, so later changes on main cannot install unverified content unexpectedly.

macOS / Linux

Install all nine pets:

curl -fsSL https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.sh | bash -s -- all

Install one pet (Fern in this example):

curl -fsSL https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.sh | bash -s -- fern--nikeru8

Available IDs:

Series Pet ID
Frieren: Beyond Journey's End Frieren v2 frieren-v2--nikeru8
Frieren: Beyond Journey's End Fern v2 fern--nikeru8
Frieren: Beyond Journey's End Stark v2 stark--nikeru8
Fullmetal Alchemist: Brotherhood Elric Brothers v2 elric-brothers--nikeru8
Fullmetal Alchemist: Brotherhood Nina & Alexander Chimera v2 nina-alexander-chimera--nikeru8
Cyberpunk: Edgerunners Lucy v2 (Original) lucy--nikeru8
Cyberpunk: Edgerunners Lucy Pixel v2 lucy-pixel--nikeru8
Cyberpunk: Edgerunners Rebecca v2 rebecca--nikeru8
Marvel Studios' Loki Miss Minutes v2 miss-minutes--nikeru8

Windows PowerShell

Install all nine pets:

& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.ps1'))) -PetId 'all'

To install a single pet, replace all with an ID from the table above.

Updating an existing installation

The installers refuse to overwrite an existing pet by default. Add --force (-Force in PowerShell) to move the old directory into pet-backups/<id>.backup.<timestamp> under your Codex home before installing the new version. Backups are kept outside the pets directory, so Codex will not mistake one for a duplicate pet.

v1.7.0 adds the Nina & Alexander Chimera pet. Its warning is intentional: 「用了會下地獄,請小心使用」.

curl -fsSL https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.sh | bash -s -- fern--nikeru8 --force
& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/nikeru8/codex-nikeru8-pets/v1.7.0/install.ps1'))) -PetId 'fern--nikeru8' -Force

Enabling a pet in Codex

After installation, open Settings → Pets → Refresh, then select the newly installed pet. See the official Codex Pets documentation for the complete workflow.

Default install locations:

  • macOS / Linux: ${CODEX_HOME:-$HOME/.codex}/pets/<id>/; --codex-home <path> takes precedence.
  • Windows: <CodexHome>\pets\<id>\; the root is selected in this order: -CodexHome, $env:CODEX_HOME, then $HOME\.codex.

How the animations work

Every atlas is a 1536 × 2288 WebP: 8 columns × 11 rows, with 192 × 208 cells. Its pet.json declares spriteVersionNumber: 2.

Atlas row State
row 0 idle
rows 1–2 running-right / running-left: horizontal movement while dragging the pet
row 3 waving
row 4 jumping: pointer-hover interaction
row 5 failed: task failure or blockage
row 6 waiting: waiting for user input
row 7 running: Codex is working on a task
row 8 review: work is ready for review
rows 9–10 16 clockwise look directions

The current Codex desktop app plays row 4 (jumping) three times on hover and then returns to the slower row 0 (idle) animation. It does not continue automatically into row 7; row 7 is reserved for the real running task state.

What the installers do

Before installation, each script downloads pet.json and spritesheet.webp into a temporary directory, verifies the package ID and SHA-256 checksum, and moves the files into the Codex pet directory only after every check passes. Those are the only two files installed, and the scripts do not send installation analytics.

To install from a local checkout:

git clone https://github.com/nikeru8/codex-nikeru8-pets.git
cd codex-nikeru8-pets
NIKERU8_CODEX_PETS_RAW_BASE="file://$PWD" ./install.sh all

Validation and development

python3 -m pip install -r requirements-dev.txt
python3 scripts/validate.py
bash -n install.sh

The validator checks all nine manifests, required v2 fields, each 1536 × 2288 WebP and its 8 × 11 grid of 192 × 208 cells, alpha channels, and all 18 entries in CHECKSUMS.sha256. It validates package structure, not the semantic meaning or visual quality of the animations. On pushes to main, v* tags, and pull requests, GitHub Actions runs package validation and Bash installer tests on Ubuntu, plus PowerShell installer tests on Windows.

Creation, sources, and permitted use

  • Frieren v2 is based on the pinned Frieren Codex pet published by Lingxiaotian / @legeling. Nikeru8 created the v2 atlas, look directions, and magic hover animation. This derivative enhancement remains subject to the original asset's CC BY-NC 4.0 terms and preserves both attributions.
  • Fern and Stark v2 are complete AI-assisted atlases designed, generated, and arranged by Nikeru8 with reference to the official Fern character profile and Stark character profile. Their production process did not directly extract or reuse pixels from the upstream Frieren atlas.
  • Elric Brothers v2 is an unofficial, AI-assisted chibi pet with a light pixel style. Nikeru8 produced, curated, designed, and arranged its two-character actions; Edward and Alphonse appear together in every frame as one pet.
  • Nina & Alexander Chimera v2 is an unofficial, AI-assisted chibi fan pet produced, curated, action-designed, and arranged by Nikeru8. Warning: 「用了會下地獄,請小心使用」.
  • Lucy v2 (Original) is an unofficial, AI-assisted, super-deformed cel-shaded fan pet produced, curated, outfit-corrected, scale-corrected, and arranged by Nikeru8.
  • Lucy Pixel v2 is an unofficial, AI-assisted pixel-style fan pet produced, curated, outfit-corrected, scale-corrected, and arranged by Nikeru8.
  • Rebecca v2 is an unofficial, AI-assisted neon cel-shaded / lightly pixelated fan pet produced, curated, action-designed, and arranged by Nikeru8.
  • Miss Minutes v2 is an unofficial, AI-assisted retro television-animation-style fan pet produced, curated, action-designed, and arranged by Nikeru8.

The Fern, Stark, Elric Brothers, Nina & Alexander Chimera, Lucy, Lucy Pixel, Rebecca, and Miss Minutes assets are provided for personal, non-commercial use only. All rights in the characters, names, images, and trademarks remain with their respective rights holders. This project is not affiliated with, sponsored by, or endorsed by those rights holders, their production companies, or OpenAI.

Full notices:

License

The installer and validation tools, together with the project's original documentation, are available under the MIT License. Character images under pets/ and previews/ are not licensed under the root MIT License; use each asset only under the attribution and non-commercial terms in its corresponding notice.

About

Nine animated Codex v2 desktop pets with checksum-verified installers for macOS, Linux, and Windows. Unofficial, non-commercial fan project.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages