Codex Pets

A small collection of installable pets for Codex. Each pet package contains the runtime files Codex reads plus a preview and its own asset notice.

Preview

BMO — a cheerful game-console companion inspired by BMO from Adventure Time. This is an unofficial fan-made Codex Pet.

Quick start

git clone https://github.com/BazingaOrg/codex-pets.git
cd codex-pets
./scripts/install.sh bmo

Fully quit and reopen Codex, then select the pet from the Pet selector.

Available pets

ID	Pet
bmo	BMO, a cheerful teal game-console friend inspired by Adventure Time.

Install, update, and uninstall

Install refuses to replace an existing pet. To update a pet after pulling new files, use --force:

./scripts/install.sh --force bmo

Uninstall only a pet supplied by this repository:

./scripts/uninstall.sh bmo

Validate all packages before sharing changes:

python3 scripts/validate.py

Contributing

See adding a pet for the package contract and asset requirements.

Compatibility

The scripts support macOS, Linux, and Windows through WSL. Native PowerShell and Command Prompt are not currently supported. Pets use Codex sprite format v2; restart Codex after installing or changing a pet.

License

Repository code and original documentation are MIT licensed. Pet artwork has separate terms: see NOTICE and each pet's ASSET-LICENSE.md.