ペットを取り込む
ペットはキャラクターのファイルです。アプリに付属する基本ペットと、Codexのペットフォルダー（~/.codex/pets）にあるペットは、何もしなくても招待タブに表示されます。それ以外のペットは取り込む必要があります。
リンクから一度で取り込む 0.1.0から
ペットのギャラリーに「PlayPetsで開く」リンクがあれば、クリックするだけです。リンクはplaypets://import?url=<ペットページのURL>の形をしています。PlayPetsがインストールされていれば、まず「このペットを取り込みますか？」と尋ね、リンクの送信元のサイトを表示します。承認するとそのペットを取り込み、招待タブを開きます。ギャラリーを運営しているなら、ペットページにこのリンクを置いてください。
playpets://import?url=https%3A%2F%2Fpetdex.dev%2Fpets%2Fbobaペットを取り込む画面 0.1.0から
「招待」タブの上部にある「ペットを取り込む」をクリックすると画面が開きます。方法は2つあります。
- コミュニティサイトのペットページ、またはGitHubのペットフォルダーのURLを「ペットページのURL」に貼り付けて、「取り込む」をクリックします。ファイルはhttpsでだけ、貼り付けたURLのサイト（とそのサブドメイン）からだけ取得します。別のサイトのファイルを指すページには従いません。
- 「このパソコンのフォルダから取り込む」をクリックして、ペットのフォルダーを選びます。
取り込みが終わると、そのペットはすぐに友だちとして庭に招待されます。「新しいペットを取り込んで庭に招待しました。」と通知されます。
対応サイト 0.1.0から
ペットのURLと取り込みの操作を見つけやすいように、「ほかのペットを探す」は最初は折りたたまれています。開くと、サイトの一覧と取り込みの案内がコンパクトに表示されます。サイトをクリックするとブラウザーで開くので、ペットページのURLをコピーして上の欄に貼り付けてください。これらはコミュニティへのリンクで、掲載は提携を意味しません。
| サイト | サイトのアドレス |
|---|---|
| OpenPets Registry | openpets.sh |
| Petdex | petdex.dev |
| Codex PokéPets | github.com/dnnyngyen/codex-pokepets |
| Awesome Codex Pet | codexpet.top |
| Codex Pets | codex-pets.net |
チップのない場所も使えます。GitHubにあるペットフォルダー（pet.jsonを含むフォルダー）のURLや、codex-pet-shareで作られたサイトのペットページのURLです。
上のサイトには専用の取り込み処理があります。「(見るだけ)」と付いた掲載先には専用の取り込み処理がありません。ブラウザーで開くことはでき、互換性のある一般的なペットページなら、貼り付けると取り込めることもあります。新しいサイトを掲載しただけで、取り込みに対応するわけではありません。
URLが間違っていたり、サイトが応答しなかったりすると、画面に理由が表示されます。取り込みの途中は画面を閉じられません。
手元のフォルダー 0.1.0から
「このパソコンのフォルダから取り込む」で選んだフォルダーはコピーされず、アプリはその場所から読みます。そのため、招待タブの「このパソコンから選んだペット」に、フォルダー名と一緒に表示されます。
フォルダーを移動すると友だちは待ちます
友だちは、ペットフォルダーのパスで自分のペットを見分けます。選んだフォルダーを移動したり削除したり（またはそのフォルダーがあるドライブを外したり）すると、次にアプリを開いたとき、そのペットの友だちは庭に来られません。友だちは消えず、なかよし度を保ったまま待ちます。何人の友だちが待っているかは通知で知らせます。フォルダーを同じ場所に戻すと、友だちは戻ってきます。
保存場所 0.1.0から
URLから取り込んだペットは、データフォルダーのpets/に1つのフォルダーとして保存されます。招待タブの「URLから取り込んだペット」グループには「フォルダを開く」ボタンがあり、そのフォルダーをすぐに開けます。「PlayPetsの基本ペット」と「Codexのペットフォルダ」のグループにも同じボタンがあります。「このパソコンから選んだペット」グループにはボタンがなく、代わりに各カードにフォルダー名が表示されます。
取り込んだペットのpet.jsonには、どこから来たかが記録されます。招待タブのカードには、「Petdex · 作者 · CC BY-NC 4.0」のように、サイト、作者、ライセンスが1行で表示されます。コミュニティのペットは作者の作品なので、使う前にライセンスを確認してください。
使わなくなったペットを消すには、pets/の中のそのフォルダーを削除します。そのペットから作った友だちは、上で説明したように次回の起動から庭の外で待ちます。友だちも消したいなら、先にお別れしてください。
自分で作る
ペットは、pet.jsonとスプライトシート1枚（PNGまたはWebP）を入れた1つのフォルダーです。形式はCodexのペットと同じなので、Codex用に作ったペットはそのまま使えます。
{
"id": "white",
"displayName": "White",
"kind": "animal",
"description": "A puppy.",
"spriteVersionNumber": 2,
"spritesheetPath": "spritesheet.webp"
}- シートの幅は1536pxで、1セルは192×208px、1行は8セルです。v1は9行（1872px）、v2は11行（2288px）です。
- v1の9行は、順に休憩、右へ歩く、左へ歩く、手を振る、跳ぶ、エラー、待機、作業、完了です。v2には16方向の視線の行が2行加わり、デスクトップでペットがマウスを目で追います。
descriptionは、新しい友だちの最初の性格になります。
各行のアニメーションと検証のルールは、開発者向けドキュメントのペットファイルの形式（英語）にあります。作ったフォルダーは、「このパソコンのフォルダから取り込む」ですぐに招待できます。