Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
7be0145b4This file is pinned to the selected release. Download the original to open it in your design tool.
# MODとサンプル
[English](./README.md)
**MOD**は、スタックチャンのホストファームウェア上で動くユーザーアプリケーションです。
このブランチで初めてコードを書く場合は、[SDK教材](../lessons/README_ja.md)から始めてください。実行可能な[全21パッケージ](examples/README_ja.md)は同じSDKへ移行済みです。元の32例は重複する役割を統合しました。[移行台帳](../../docs/architecture/legacy-mod-migration.md)で依存と未完了項目を確認できます。
MODには`stackchan-mod.json`の同梱が必要です。教材の`mod.js`・`manifest.json`・宣言を一緒にコピーし、最初は`mod.js`だけを編集します。情報のない古いXSAは再ビルドしてください。[互換性と復旧手順](../../docs/architecture/mod-package-compatibility.md)に各導入経路の条件をまとめています。
## MODを試す
公開MODは[MOD Gallery](https://stack-chan.github.io/stack-chan/web/mod-gallery/)から探せます。
名前や機能で検索し、シミュレーターまたは実機で試せます。
ブロックで作られたMODは、ブロックエディタで変更できます。
MODを選ぶときは、カードに表示される使用機能と対応機種を確認してください。
外部サービスやネットワークを使うMODは、リンク先のソースコードも確認してから書き込んでください。
実機へ書き込むときは、Galleryが対象チップ、XSバージョン、ファームウェア互換性を自動で検査します。
[](https://stack-chan.github.io/stack-chan/web/mod-gallery/)
このディレクトリの[`examples`](./examples/)には、APIの学習、テスト、ローカル開発に使えるMODのソースコードがあります。
その一部はGalleryにも掲載されています。
現在、Galleryと`examples`の収録内容は一致していませんが、今後そろえていく予定です。
## MODを作る
### ブラウザーで作る
[ブロックエディタ](https://stack-chan.github.io/stack-chan/web/editor/)では、Blocklyで処理を組み立て、ブラウザー内でMODをビルドできます。
作成したMODは[シミュレーター](https://stack-chan.github.io/stack-chan/web/simulator/)で確認し、対応する実機へ書き込めます。
最初のプロジェクトは[ブロックエディタのチュートリアル](https://stack-chan.github.io/stack-chan/web/editor/tutorial.html)に沿って作成できます。
[](https://stack-chan.github.io/stack-chan/web/editor/)
### ソースコードから作る
MODはJavaScriptまたはTypeScriptのモジュールとして実装できます。
TypeScriptのMODでは、`stackchan` と `stackchan/extensions/*` の公開型、アプリ内の相対importを使用します。
ローカル環境からMODを書き込む場合は、`firmware`ディレクトリで`manifest.json`を指定します。
```console
npm run mod -- mods/examples/look_around/manifest.json
```
環境構築、ターゲット別のコマンド、書き込み方法は[プログラムのビルドと書き込み](../docs/flashing-firmware_ja.md)を参照してください。
## MODの実行モデル
MODをインストールすると、ホストの通常動作に代わってそのMODが実行されます。
ボタンや画面操作の意味は、インストールしたMODの実装で決まります。
MODは、対象機種とホストが使用するXSバージョンに合わせてビルドする必要があります。
WASM ホストでも標準の `npm run mod:build` で生成した、MOD 宣言を含む `.xsa` archive を読み込みます。
表示文字列は[SDKの `ui(app).localize` を使ったファームウェアのローカライズ](../docs/localization_ja.md)に従って追加します。
顔画面とホストのAppBarを維持したままPiu UIを追加する場合は、SDK の[Piu 画面拡張](../docs/mini-apps_ja.md)を利用できます。
## 代表的なソース例
| サンプル | 確認できる機能 |
| --- | --- |
| [`look_around`](./examples/look_around/) | モーションAPIを使った最小限の首振り |
| [`face`](./examples/face/) | SDKの翻訳メニュー、表情と色 |
| [`stackchan_minigames`](./examples/stackchan_minigames/) | JUMPとCATCHを1つのarchiveへまとめるミニゲーム集 |
| [`local_peer_hello`](./examples/local_peer_hello/) | インターネットを経由しない端末間の型付きメッセージ |
| [`web_radio`](./examples/web_radio/) | M5StackChan CoreS3でのネットワーク音声再生 |
| [`board_diagnostics`](./examples/board_diagnostics/) | [M5StackChan CoreS3のサーボ電源とヘッドLEDの確認](../docs/m5stackchan-cores3-smoke.md) |
## 参考資料
- [プログラムのビルドと書き込み](../docs/flashing-firmware_ja.md)
- [ファームウェアAPI](../docs/api_ja.md)
- [MODパッケージ仕様](../../docs/specs/stackchan-mod.md)
- [ローカライズ](../docs/localization_ja.md)
- [ミニアプリ(実験的)](../docs/mini-apps_ja.md)