概要
template は、他の人が出発点として開けるように共有された PicoPixel ファイルです。画面をゼロから作る代わりに、あなたの layout、widgets、styling がすでに入った状態から始められます。
Templates は GitHub 経由で提出します。.picopixel ファイル、表示したい画像、template を説明する README を含む public repo を作ります。承認されると、template はコミュニティの Templates gallery に表示され、誰でも閲覧して利用でき、あなたのクレジットも付きます。
このガイドでは、repo の準備、提出フォームの記入、付与する権利、承認されやすくするためのポイントを説明します。
始める前に
提出前に 2 つ準備してください。
- A GitHub account. template repo は GitHub にホストされている必要があります。アカウントがない場合は先に create one してください。
- A finalized design. 提出前に
.picopixelファイルが完成していることを確認してください。PicoPixel app から書き出し、repo に追加できる状態にします。
提出フォームにアクセスするには PicoPixel app にサインインしている必要があります。the PicoPixel app を開き、まだの場合は Google または GitHub でサインインしてください。
GitHub repo を設定する
template submission 用に新しい public GitHub repository を作成します。repo には 3 つのものを含めます。
1. Your .picopixel file
.picopixel design file を repo のルートに置きます。これは人々がダウンロードして PicoPixel で開くファイルなので、最終版であることを確認してください。
2. Showcase images
gallery で template と一緒に表示したい画像を追加します。ダウンロード前にデザインがどう見えるか分かるようにするためです。
- 画像は repo のルート、または
images/のようなフォルダーに置きます。 - 一般的な形式を使います:
.png、.jpg、.webp。 - デザインが動いているスクリーンショットを少なくとも 1 枚含めます。複数の角度や画面があればさらに良いです。
- 画像は適切なサイズにします。詳細が見える大きさで、不要に巨大にはしないでください。
3. A README
repo のルートに README.md を書きます。これは gallery で template の説明として使われるので、template の公開ページとして扱ってください。
強い README には次を含めるとよいです。
- What the template is — デザインの概要と用途。
- Target resolution and hardware — 対象のボードやディスプレイ。利用者が自分の環境に合うか判断できます。
- What's included — screens、widgets、主な機能の一覧。例:"two screens: a home dashboard and a settings page, with sliders, toggles, and a clock widget."
- Credits — 共有許可のある第三者 assets を使った場合、その名前と出典。
gallery で初めて template を見た人を想像してください。README が "what is this and will it work for me?" に答えられていれば、役割を果たしています。
Here's a minimal example:
# Weather Dashboard Template
A clean two-screen weather dashboard designed for 320×240 TFT displays.
## What's included
- **Home screen** — current temperature, humidity, and a 3-day forecast row
- **Settings screen** — unit toggle (°C/°F), update interval slider, and Wi-Fi status
## Built for
- 320×240 resolution
- ILI9341 or similar TFT displays
## Credits
Weather icons from [Meteocons](https://bas.dev/work/meteocons) (MIT license). フォームに記入する
repo の準備ができたら、提出フォームへ進みます。
- the PicoPixel app を開いてサインインします。
- 左サイドバー下部のアカウントをクリックし、Your account を選びます。
- Your-account サイドバーで Submit Template を開きます。
フォームには 3 つのフィールドがあります。
- GitHub Repo Link — public GitHub repository の URL(例:
https://github.com/yourname/my-template)。review team がアクセスできるよう、repo は public である必要があります。提出前に.picopixelファイル、画像、README が入っていることを確認してください。 - Author / Credits — template creator として表示したい名前。一緒にクレジットすべき人がいれば追加します。
- Notes(optional)— README に書いていない、review team が知るべき情報。たとえば gallery listing に使ってほしくない画像や、公開説明には入れないデザイン背景などです。
すべて問題なければ、フォームを送信します。
権利と許可
template の提出は実際の許可を与える行為なので、送信前に注意して読んでください。
著作権で保護されたコンテンツ、または自分が所有していないコンテンツを含むものを提出しないでください。repo 内のすべて、つまり .picopixel ファイル、画像、フォント、アイコン、その他の assets は、完全に自分のオリジナル作品か、公開共有する明確な許可を持つ素材でなければなりません。
提出することで、PicoPixel に repository の内容へアクセスし、ダウンロードし、コミュニティ templates gallery で公開する許可を与えます。公開された templates は、著作権上の制限やライセンス要件なしで提供され、誰でも自分のプロジェクトで自由に利用できます。商用利用も含みます。あなたのクレジットは表示されますが、template 自体は他の人が好きなように使えるものになります。
つまり、その条件で共有してよい作品だけを提出してください。デザインの一部に自分が作っていない asset(フォント、アイコンセット、画像など)が含まれ、自由かつ制限なく共有できるか確信がない場合は、提出前に削除してください。迷うなら入れないでください。後で取り下げる必要がある template より、クリーンな template の方がずっと役に立ちます。
PicoPixel は第三者の権利を侵害するコンテンツを削除する場合があります。Terms を参照してください。
次に起きること
提出後、PicoPixel チームは repo を clone して template を確認します。.picopixel ファイルが正しく開くか、画像と README が適切か、提出が Terms を満たしているかを確認します。
不明点や修正が必要な場合、チームが連絡することがあります。審査を通過すると、template は Templates gallery に公開され、あなたのクレジットと README の説明が表示されます。そこから誰でも、自分のデザインの出発点として開けます。
提出後も repo は残しておいてください。後で template を更新する必要がある場合、たとえば bug 修正、画像差し替え、説明改善などは repo を更新してチームに知らせることができます。
公開済み template を修正または削除する必要がある場合(自分のものでも他人のものでも)、How to report content を参照してください。
次のステップ
- Templates gallery、コミュニティ templates を見る
- How to submit a pet、animated sprite を共有する
- How to report content、pet や template の問題を報告する
- Terms、提出に適用されるルール