Pets for Codex

Custom animated pets for Codex. This repository starts with Neymar, a football-inspired mascot prepared for the Codex v2 sprite format.

Independent and unofficial project. Not affiliated with, sponsored by, or endorsed by Neymar, his representatives, clubs, federations, or any associated brands.

Neymar

Previews

Field	Value
ID	neymar
Sprite version	2
Format	WebP
Atlas	8 columns x 11 rows
Cell	192 x 208 px
Total size	1536 x 2288 px

Pet files:

• neymar/pet.json - pet manifest.
• neymar/spritesheet.webp - animation atlas.

Local installation

Copy the neymar/ directory to the custom pets directory used by Codex:

<CODEX_HOME>/pets/neymar/

Keep the manifest and spritesheet together with their original filenames.

Project rules

1. One pet per directory, always including pet.json and spritesheet.webp.
2. The manifest must declare spriteVersionNumber: 2 and point to the actual atlas file.
3. The final atlas must be 1536 x 2288 px, using 192 x 208 px cells.
4. Do not include logos, text, trademarks, or third-party material without permission.
5. Pets inspired by real people must be described as unofficial interpretations and must not suggest endorsement.
6. Visual changes must preserve transparency, identity, small-size readability, and the 9 standard animations plus 16 look directions.
7. Generated files, temporary previews, and credentials must never be committed.
8. Every contribution must pass validation and review before merging.

License

Code and documentation are distributed under the MIT License. Pet artwork, including spritesheets and references, is distributed under the Creative Commons Attribution-NonCommercial 4.0 International license (CC BY-NC 4.0), unless a different notice exists in the relevant pet directory.

See LICENSE, LICENSE-ARTWORK, and CONTRIBUTING.md.

Current release

v0.1.0 - Neymar

• First pet published in the project.
• Complete v2 atlas for Codex.
• Manifest, spritesheet, previews, and validation workflow included.

Status

Pet	Status
Neymar	Available - v2

New pets will be added in their own directories without changing another pet's files unless explicitly required.