crafter-station/petdex:README 來源編輯指南
根據 README、倉庫資料與授權整理 crafter-station/petdex 的安裝與核驗路徑。
專案定位
crafter-station/petdex 的 README 將專案描述為「The public gallery of animated pet for Codex, Claude Code, OpenCode y Gemini CLI」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:The public gallery of animated companions for Codex. Browse, install, and submit pets with one command.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「For builders」與相關條目,可以先判斷它是否處理你的實際問題:The pet package format. Every pet is a pet.json plus a spritesheet.{webp,png} rendered as an 8×9 grid of 192×208 frames.。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:The HTTP API. petdex.dev/api/manifest returns every approved pet with its slug, spritesheet URL, animation states, and metadata.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「What is Petdex」等段落。可確認的線索包括:Every pet is a folder. Every folder is a Pokédex entry. Every entry is one npx petdex install away.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: crafter-station/petdex ├── src/ │ ├── app/[locale]/ Public site: gallery, /pets/<slug>, /collections, /built-with, /community, /create, /download, /submit, /u/<handle>, ... │ ├── app/api/cli/ CLI endpoints: OAuth config, submit (zip → presigned R2), dedup check, register │ ├── app/api/manifest/ Public manifest: every approved pet with its spritesheet URL │ ├── app/api/admin/ Admin review surface for submissions, edits, collection requests │ └── lib/db/sc 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Quick start」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Quick start」段落提到:Follow this checklist to get a pet installed, visible in Codex, and connected to the desktop app.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Submit a pet: petdex.dev/submit or npx petdex submit .。