CodexPetHub 文档

提交公开 GitHub 仓库后,服务端会解析配置、验证资源并生成不可伪造的草稿记录。缺少独立封面的项目不能公开。

配置发现顺序

  1. 1.codex-pet.yml
  2. 2.codex-pet.yaml
  3. 3.codex-pet.json
  4. 4..pet/codex-pet.yml
  5. 5..pet/codex-pet.json
  6. 6.package.json 的 codexPet 字段

动态预览

支持 HTML/Canvas、Lottie、Rive、GIF、APNG、视频、Sprite、SVG、GLB/GLTF、Live2D 项目运行时和静态图片。HTML 只获得 allow-scripts,通过带随机通道的消息协议接收状态。

preview:
  type: html
  entry: preview/index.html
  width: 560
  height: 420
  draggable: true

宠物许可证

每个宠物保留其仓库声明的许可证。安装前请在详情页和源仓库中确认许可证、版本与发布者;平台收录不改变原项目的权利归属。

可运行参考

仓库内的 Orbit 示例包含完整配置、自包含 HTML 动画和 v1 消息协议。部署后可直接打开静态示例,或在提交页导入你自己的公开仓库。