Manifest リファレンス

Codex pet.json 形式

pet.json はギャラリーに pet の名前、説明、使用する spritesheet ファイルを伝えます。

{
  "id": "happy-dog",
  "displayName": "Happy Dog",
  "description": "A cheerful pixel dog for focused coding sessions.",
  "spritesheetPath": "spritesheet.webp"
}

Required fields

Use id for the package name, displayName for the title, description for the page copy, and spritesheetPath for the animation file.

Naming rules

Keep ids lowercase and simple. The current uploader expects the referenced animation file to be named spritesheet.webp.

Description rules

Write one specific sentence. Mention what the pet is, not generic filler like cute pet or nice mascot.

Gallery tags

Keep gallery tags out of pet.json. Choose optional tags in Studio after loading the two package files.

Publish your pet

Put your pet on a page people can use.

Upload pet.json and spritesheet.webp together. The page shows the preview, file links, package download, creator name, and related pets.