Awesome Codex Pet

This repository curates community-created "Codex pets" – interactive desktop companions. It offers users a simple, one-command installation across macOS, Linux, and Windows, enabling easy discovery and personalization of animated desktop characters. The project benefits users seeking to enhance their digital workspace with diverse, readily available animated elements.

How It Works

Pets are packaged as self-contained units (submission.json, pet.json, spritesheet.webp). A CI pipeline generates animated previews and maintains a live gallery website. Submissions are managed via GitHub issues/PRs, triggering automated validation. The system supports v1 (standard) and v2 (enhanced directional look) sprite versions, with an AI-assisted upgrade path. Pet assets are distinct from generated previews.

Quick Start & Requirements

• Installation: Single-command install via curl (macOS/Linux), PowerShell (Windows), or npx (Node.js). Example: curl -fsSL https://raw.githubusercontent.com/legeling/awesome-codex-pet/main/scripts/install-pet.sh | bash -s -- firefly--lingxiaotian.
• Prerequisites: Compatible shell environment or Node.js.
• Links: Live gallery: https://awesome-codex-pet.pages.dev; Install guide: https://awesome-codex-pet.pages.dev/install; Submit pet: https://awesome-codex-pet.pages.dev/guide.

Highlighted Details

• One-Command Install: Seamless setup across macOS, Linux, and Windows without manual configuration.
• Live Gallery: Interactive website with animated previews, filtering, and installation counters.
• GitHub-Native Submissions: Automated pet contribution workflow via issues/PRs.
• Dual Sprite Versions: Supports v1 (standard) and v2 (enhanced directional look) sprites, with AI-assisted v1-to-v2 upgrades.

Maintenance & Community

The project features active community contributions, with numerous pet creators listed. The primary maintainer is legeling. While explicit community channels are not detailed, the submission guide and live gallery indicate a vibrant, community-driven ecosystem focused on pet curation.

Licensing & Compatibility

Code and scripts are under the permissive MIT License. Pet assets and previews use CC BY-NC 4.0 (Creative Commons Attribution-NonCommercial 4.0 International). This non-commercial clause restricts asset use in commercial products or services, limiting broader adoption in business contexts.

Limitations & Caveats

The CC BY-NC 4.0 license for pet assets prohibits commercial use, a significant restriction for enterprise applications. The v1-to-v2 upgrade process primarily updates local installations and does not automatically resubmit modified assets. Documentation is available in English and Simplified Chinese.