インストール
このページを終えると、MingToon がエラーなく入った Unity プロジェクトができます。 約 15 分かかります。
始める前の準備
- Unity Hub と下の表に合う Unity バージョン、そして作業するプロジェクトのバックアップ
- VRChat が対象なら VRChat SDK3 (Avatars)
1. Unity のバージョンを合わせます
| 対象 | Unity |
|---|---|
| VRChat PC | 2022.3.22f1 |
| Warudo | 2021.3.45f2 |
| 一般 Unity | 2021.3 LTS |
VRChat が対象なら 2022.3.22f1 を使ってください。 MingToon の VRChat ビルドフックは 2022.3 以上でのみコンパイルされます。 2021.3 のプロジェクトにはアップロード時の自動最適化がまったくありません。 1 つのプロジェクトで VRChat と Warudo の両方には対応できないので、分けてください。
2. パッケージをインストールします
公式ダウンロード案内で VCC または BOOTH を選びます。
VCC でインストールする場合:
- ダウンロード案内で VCC に追加を押します。
- VCC でリポジトリの追加を確認します。
- 対象プロジェクトの Manage Project を開きます。
- MingToon を追加して Unity を開きます。
BOOTH インストーラーでインストールする場合:
- BOOTH 商品でインストーラーの
.unitypackageを入手します。 - Unity で
Assets > Import Package > Custom Packageからインポートします。 - インターネットに接続したまま待ちます。インストーラーが本体を自動で取得します。
VCC でインストールした場合は、更新も VCC で行います。対象プロジェクトの Manage Project > Manage Packages で MingToon を更新します。 BOOTH インストーラーは Unity を起動したときに新しいバージョンを案内します。
どちらでインストールした場合も、StudioRaming > MingToon > Update で MingToon アップデートウィンドウを開けます。
ウィンドウを開くと最新情報を自動取得し、現在のバージョンと候補バージョンを表示します。
ボタンは アップデート 1 つです。インストール可能な候補があると有効になり、失敗したインストールの状態確認や再取得も同じボタンで行います。
候補は設定された配信先とインストール状態によって変わります。インストール済みの開発版・プレビュー版より低いバージョンを新しい更新として案内しません。
変更内容は MingToon Inspector で選んだ言語の本文だけを表示します。Markdown の見出し・リスト・強調・コード・リンクを描画します。
更新前に Unity プロジェクトをバックアップしてください。ベータ版では UI・機能・見た目が変わるため、更新後は元のマテリアルから新しいコピーを変換することをおすすめします。 以前のコピーを残したまま新しい結果と比較してください。アップロード済みアバターに反映するには再アップロードが必要です。
3. 最初のコンパイルが終わるまで待ちます
MingToon の初回追加や更新では、Unity がスクリプトを再コンパイルします。 その後、MingToon が現在の環境の初回表示に必要なシェーダーの組み合わせを準備します。 すべての照明・影・インスタンシング・アップロード用バリアントをコンパイルする処理ではありません。
- 新規インストール・更新のどちらも、前面に MingToonウォームアップの進行バーが出ます。エディターは応答し続け、キャッシュ済みの処理はスキップします。
Cancelはバーだけを閉じ、残りの準備は画面右下のBackground Tasksで続行します。 - 終了後にマテリアルを開きます。準備範囲外の組み合わせは初回描画時に追加コンパイルされる場合があります。
この作業が始まるのは次の 3 つのうちどれかのときです。
- このプロジェクトに MingToon のコンパイル記録がないとき。はじめて入れたときと、
Libraryフォルダーを削除したときです - 名前に
MingToonを含む.unitypackageのインポートが終わったとき。BOOTH インストーラーの経路です - VCC（VPM）で MingToon パッケージが新しく入るかバージョンが変わり、Unity がパッケージの登録を終えたとき。0.1.12 で加わった経路です
コンパイル記録はプロジェクトの Library/StudioRaming/MingToon.warmup ファイルに残ります。
有効な記録と Unity の実際のパスキャッシュを確認し、準備済みの組み合わせのコンパイル要求を省きます。
記録にはシェーダーソース・Unity バージョン・グラフィックス API などの条件が一致する必要があります。ソースが変わった場合やパスが未準備の場合は、必要な組み合わせを再準備します。
このキャッシュは現在のプロジェクト用です。別の PC や新しいプロジェクトの初回コンパイルまではなくなりません。
進行バーの Cancel はバーを閉じるだけです。コンパイルは Unity の Progress の項目に移って続き、進行と中止はエディター右下のステータスバーで見ます。そこで中止すると、それまでに終えた分は記録に残ります。 残りのバリアントは、そのシェーダーをはじめて描画するときに Unity がコンパイルするため、エディターが一瞬止まることがあります。
コンパイル時間は PC と Unity のシェーダーコンパイラーの数によって大きく変わるため、このページでは時間を書きません。 開発版でのキャッシュ検証と、公開パッケージの新規インストール・更新の受け入れ検証は別の段階です。 コンパイルが一切ないことや、初回インストール時間が一定割合で短くなることは保証しません。
4. シェーダーが入ったか確認します
マテリアルを 1 つ選び、Inspector 最上部のシェーダー一覧を開きます。
StudioRaming/MingToon/MingToon BRP が見えれば正常です。
URP シェーダーは今回の BRP オープンベータには含まれていません。
5. VRChat 連携を確認します
VRChat が対象の場合のみ該当します。リロードが終わったあと、Console に次の行があるはずです。
[MingToon] VRChat build hook compiled and registered.
VRChat ビルドフックがない状態です。 アップロードしても自動最適化がかかりません。
6. プロジェクトを検証します
メニューから StudioRaming > MingToon > Validate Project を実行します。
ビルドターゲットがシェーダーモデル 4.5 を満たせない場合は MING-ENV-BUILD-TARGET エラーが出ます。
その状態で進めると、マテリアルがマゼンタ（ピンク色）になります。
エディターが 2021.3 で VRC SDK がある場合は MING-VRC-UNITY-VERSION 警告が出ます。
うまくいったかの確認
- Console に赤いエラーがありません。
- シェーダー一覧に
StudioRaming/MingToon/MingToon BRPがあります。 - VRChat が対象ならビルドフックのログが出ています。
Validate Projectの結果にエラーがありません。
4 つのうち 1 つでも合わなければトラブルシューティングへ進んでください。
以前のバージョンから上げた場合
0.1.11から更新を開始するときに「置き換えるファイルを削除できません」と表示された場合は、旧バージョンの更新エラーへの対処に従って状態を確認してから再試行してください。同じエラーが続く場合はインストールを繰り返さないでください。
更新の直後は、上の最初のコンパイルの進行バーがもう一度出ることがあります。 すでに Manager が付いたアバターでは、更新しても変換ウィザードは自動では開きません。 ベイクキャッシュが一度作り直されます。 手で消すものはなく、次のビルドやアップロードがその分だけ長くかかります。 VRChat のアバターは再アップロードしないと今回のバージョンが反映されません。 シェーダーがアバターに一緒に載るためです。条件は VRChat にあります。
任意: Post Processing Stack v2
MingToon は PPv2 がなくても完全に動作します。シーン確認と撮影用です。
- PPv2 3.4.0 をインストールします。
- Player Settings > Scripting Define Symbols に
UNITY_POST_PROCESSING_STACK_V2を手動で追加します。 - Unity が再コンパイルを終えるまで待ちます。
StudioRaming > MingToon > Create or Repair BRP PPv2 Global Volumeを実行します。
2 番を飛ばすと、4 番のメニューは何もしません。