Kuyuri ドキュメント

Metamo(メタモ)— パーティクルを使った変身・お着替えエフェクトのシステム(lilToon 対応)

Metamo(メタモ)は、VRChat アバターに、パーティクルを使った変身・お着替えエフェクト(登場・退場と衣装チェンジ)を簡単に入れられるシステムです。Modular Avatar 対応のプレハブをアバター直下に置くだけで、Ex メニューから使えます。lilToon の上に載るカスタムシェーダー(lilToon のカスタムシェーダー機構で生成)と、NDMF プラグインで構成されます。

用語

境界(ディゾルブで消える部分と残る部分の境目)から出るパーティクルには 2 種類あります。名前が似ているので、この文書では次のように書き分けます。

呼び方仕組みパフォーマンスランク
ジオメトリパーティクルジオメトリシェーダーを使い、メッシュの面から直接出すパーティクルです。Unity の Particle System は使いません。境界が通った面そのものから出るので、体の形にぴったり沿います。変わりません(境界の向きを横や斜めにしたときだけ、向きを合わせるための Constraint が 1 つ増えます)
パーティクル(Particle System)Unity 標準の Particle System で出すパーティクルです。境界の高さに合わせて動く楕円体の中から出て、空中を漂います。Particle System が 1 つ増え、最大パーティクル数の分だけ影響します

どちらも既定で ON で、それぞれ別に OFF にできます。両方をまとめて言うときは「境界のパーティクル」と書きます。

使い方(登場・退場)

  1. Runtime/Prefabs/Metamo.prefab をアバターのルート直下にドラッグします。
  2. 必要なら Metamo Installer の項目を変えます: メニュー(使う項目と名前・「Ex メニュー」の節)、登場・退場の秒数(既定 3.0 秒/2.5 秒)、最初から非表示にするか(Start Hidden・既定 OFF)、境界の進む向き(Dissolve Direction・既定 上)と退場の向き(既定: 登場は足元から上へ、退場は頭から下へ)、掃引範囲の自動設定(既定 ON・レスト姿勢の頂点から Hips 相対で決める)、境界の色(任意)。
  3. VRChat SDK でビルド/アップロードします。NDMF がビルド時に、lilToon のマテリアルごとに派生マテリアルを作り、登場・退場のアニメーション・FX レイヤー・Ex メニュー(既定はトグル「登場・退場」1 つ)・Expression Parameters(既定は KY_Fx Bool 1 bit。強度のラジアルを使うと KY_Strength float 8 bit、衣装チェンジを使うと KY_Set int 8 bit が加わり、全部使うと 17 bit。「パーティクル OFF」をメニューに出すと、さらに 1 bit)を自動生成します。元のマテリアル・アニメーターは変更しません。
  4. VRChat で Ex メニューの「登場・退場」は最初 ON(表示)です。OFF にすると頭から消え、もう一度 ON にするまで消えたままです。ON にすると足元から現れ、現れ終わると元のマテリアルに戻ります。退場〜消えている間〜登場の間だけ派生マテリアルに差し替わり、表示中は何も書き込まないので、調整済みの見た目・他の lilToon 拡張・色替えなどのマテリアル差し替えギミックはそのまま使えます。

ビルドの前に対象を確かめる

Metamo Installer の Inspector の「対象の確認」を開いて「対象を調べる」を押すと、いまのアバターで、演出に乗るマテリアルと、消えている間だけ隠すもの(対応していないシェーダーなど)が一覧で出ます。ビルドのときと同じ判定です。他のツールがビルドの途中でマテリアルを変える場合は、結果が変わることがあります。マテリアルが入っていないスロット(Missing・None)は「マテリアルが入っていない」として別に出ます。そのスロットは演出に乗らず、消えている間も隠れません(マゼンタのまま残ります)。先にマテリアルを入れてください。

Ex メニュー

Metamo の項目は「登場・退場」(トグル)・「強度」(ラジアル)・「パーティクル OFF」(トグル)・「ジェスチャー」(トグル)・「衣装」(サブメニュー・衣装チェンジを使うとき)の 5 つで、Installer でそれぞれ使う/使わないを選べます(既定で出るのは「登場・退場」だけです)。Ex メニューのいちばん上には、いつも 1 項目しか出しません。

使い方(衣装チェンジ)

同じディゾルブの境界で衣装を入れ替える、または消えている間に着替える機能です。衣装でも「2 体を合体したアバターの身体ごと」でも、仕組みは同じ(セットの表示切替)です。

  1. Metamo のオブジェクト(Installer と同じでよい)に Metamo Outfits コンポーネントを追加します。
  2. 「衣装セット」(Sets)を並べます: 名前と、そのセットで表示する GameObject(子孫ごと)。先頭のセットがアップロード時の状態です。同じオブジェクトを複数のセットに入れてかまいません(共通のアクセサリ)。別のセットに入れたオブジェクトの子孫は登録できません。最大 8 セット、推奨 2〜4。
  3. 切替方式(Mode)を選びます: 境界で(At Boundary・既定・2.5 秒・頭から下へ。旧セットが消えるのと同じ境界で新セットが現れる)/消えてから(While Gone・全身が退場 → 消えている間に切替 → 新セットで登場。秒数は Installer の登場・退場秒数)。「選択を保存」(Save Selection)が ON なら次回も同じ衣装で出ます。
  4. ビルドすると Ex メニューに「衣装」サブメニュー(セットごとのトグル)が増えます(登場・退場も使うときは、2 つが「メタモ」サブメニューの中にまとまります)。消えている間(登場・退場が OFF)に選ぶと演出なしで切り替わり、次の登場で新しい衣装が出ます。遅れて入った相手にも選択中のセットが出ます。
  5. (任意)衣装に合わせて衣装の外の値も変えるときは、各セットの「値」(Values)に行を足します。1 行は、対象のレンダラー・種類(シェイプキー/マテリアルの float)・名前(シェイプキー名、またはプロパティ名。色やベクトルは _Color.r・_Vec.x のように成分ごと)・そのセットを着ている間の値・切り替える秒数・切り替え中の値(任意)です。
    • 切り替える秒数: 境界モードの切替の始めから何秒で値を入れ替えるか。境界がその部位を通る秒数を入れます(例: 2.5 秒で頭から足元まで進むなら、胸は 0.75 秒ほど)。既定は「終わり」(確定のとき)。
    • 切り替え中の値: 入れると、そのセットへ・そのセットからの切替の間はずっとその値になり、確定で行き先の値になります(例: 服で隠れる肌を消すマスクを、衣装が重なる切替中だけ外す)。
    • 登録していないセットを着ている間は、シーンのレンダラー・マテリアルに入っている値(既定の値)になります。先頭のセットの見た目に要る値は、シーンに入れておいてください(アップロード時や、アニメーションを止めている相手にはこの見た目が出ます。先頭のセットにシーンと違う値を登録するとビルド時に警告が出ます)。
    • 消えている間の切替・消えてからモード・読み込み時は、秒数を使わずに切り替わります。値は段で切り替わります(なめらかには変わりません)。

衣装チェンジの制限:

すでにある Modular Avatar のメニューから取り込む

すでに Modular Avatar で衣装の切り替えメニューを作ってある場合は、登録し直さずに衣装セットへ取り込めます。

  1. Metamo Outfits の Inspector のいちばん下の「MA のメニューから取り込む」を押します。
  2. 取り込める組が 1 つなら、そのまま取り込みます。複数あるときは一覧が出るので、「取り込む組」で選んで「選んだ組を取り込む」を押します。
  3. 「衣装セット」に 1 項目 = 1 セットで入ります。内容を確かめ、必要なら手直しします。取り込むと今の衣装セットは置き換わります(Undo で戻せます)。

取り込める組:

取り込みの決まり:

ビルドのときの動き:

ハンドジェスチャーで変身

メニューを開かずに、両手の形で変身を始められます。ライブや撮影向けの機能で、既定では使いません。

  1. Metamo Installer の「ハンドジェスチャー」で Use Gesture Trigger を ON にします。
  2. 左手と右手の形(Gesture Left/Gesture Right)を選びます。既定は両手とも「ロックンロール」(VRChat の RockNRoll)です。
  3. 起こすこと(Gesture Action)を選びます: 次の衣装へ(既定。衣装セットを順番に切り替え、最後の次は先頭に戻ります)/登場・退場の切り替え。

境界の進む向き

Metamo Installer の Dissolve Direction(Vector3)で、境界が進む向きを決めます。向きはアバターのルートに対する向きで、アバターが振り向くと境界の向きも一緒に回ります。登場はこの向きに進み、退場は逆向きに進みます(退場の向き Leave From Top と、衣装チェンジの境界の向き Change From Top の反転はそのまま使えます)。Installer を選ぶと、SceneView に登場・退場・衣装チェンジの境界が進む向きが矢印で出ます。

境界のパーティクル

ディゾルブの境界を通過した直後の面からパーティクルが出ます(登場・退場・衣装チェンジのすべての境界)。既定で ON で、Metamo Installer の項目で調整/OFF にできます。2 つの仕組み(「用語」の節)を重ねています。

境界のパーティクルの制限:

既知の制限

色やデザインを変える

  1. アバターに置いた Metamo の Inspector で、Look の下の 「既定のデザインを複製して編集」 を押します。Assets/Metamo_User/ に自分用の Look が作られ、Look 欄に入ります。同名があれば連番になり、上書きしません。
  2. 「色・幅・ノイズを編集」 を開きます。ここで変えた設定はビルド時に反映されます。同じ Look を使う Installer には共通の変更になります。
    • Edge Use Gradient = ON: Edge Gradient が境界の色です。左端が境界、右端が帯の外側、アルファが光の強さです。Edge Gradient Width は体の光る帯の幅、Geometry Particle Gradient Width はジオメトリパーティクルが色を拾う範囲です。
    • OFF: Edge Glow Color が内側、Edge Remains Color が外側の色です。Edge Glow Width/Edge Remains Width でそれぞれの幅を変えます。
    • Noise: Noise Scale はノイズの細かさ、Noise Strength は境界の揺れ幅、Noise Speed は流れる速さです。Vertex Scatter は頂点の散らばりと、その帯の幅です。
  3. ジオメトリパーティクルとパーティクル(Particle System)の色は、どちらも境界の色から決まります。 色をまとめて変える場合は Look を編集してください。Override Edge Colors が ON だと、Look の色より Installer の Edge Color 1 / 2 が優先されます。Look のグラデーションを使うときは OFF にします。
  4. ジオメトリパーティクルの画像は 「ジオメトリパーティクルのテクスチャ」 に入れます。空なら元マテリアルの設定を維持し、未設定なら同梱の画像を使います。パーティクル(Particle System)の画像とは別です。
  5. パーティクル(Particle System)の動きや画像は、Particle System Template の下の 「既定のパーティクルを複製して編集」 を押してから変更します。Prefab とマテリアルが同じ Assets/Metamo_User/ に作られ、Prefab は複製したマテリアルを参照します。Project でその Prefab を開き、Particle System の Start Lifetime(寿命)・Start Size(大きさ)・Start Speed(初速)・Noise などを編集します。画像は Renderer の Material を開き、Texture を変更します。Soft Disc を 0 にすると画像の形をそのまま使えます。画像ファイル自体は複製しないので、加工するときは自分用の画像を Assets に保存して指定してください。

パーティクル(Particle System)の放出数と最大数は Installer の Particle System Rate/Particle System Max で調整します。色・発生する楕円体・放出数・最大数・Trigger/Sub Emitters はビルド側が設定するため、雛形のこれらの欄は使いません。Particle System は 1 つです。別シェーダーのマテリアルを指定した場合も材質とテクスチャは引き継ぎますが、境界色の自動反映には、Metamo の Custom1 HDR 色の読み取りに対応したシェーダーが必要です。

同梱の資産を直接書き換えないでください。 新しい版への入れ替えではパッケージのフォルダーを消すため、直接編集した内容も消えます。パッケージ内の Look やパーティクルの雛形が欄に入っている場合も「このデザイン/このパーティクルを複製して編集」から始めます。Undo は欄への割り当てを戻します(複製ファイルは残ります)。ボタンを押さずに使う場合は既定のデザインのままです。

対応バージョン(検証環境)

項目バージョン
Unity2022.3.22f1
VRChat SDK (Avatars)3.10.5
lilToon2.3.4(この版で検証)
NDMF1.14.8
Modular Avatar1.18.7

PC 専用です。Quest(Android)版のアバターには Metamo の演出を入れられません(VRChat の仕様で、Quest 版は VRChat/Mobile 系のシェーダーしか使えないため)。Quest のユーザーからは、演出も衣装チェンジも見えません(その人には Quest 版の姿が表示されます)。

PC 版と Quest 版を同じ Blueprint ID で上げるとき

同じ ID の PC 版と Quest 版は Expression Parameters(名前・型・既定値・保存・並び順)を揃える必要があります。Metamo は PC 版にだけ KY_Fx(登場・退場を使うとき)・KY_Strength(強度を使うとき)・KY_Set(衣装チェンジを使うとき)を足すので、Quest 版には Runtime/Prefabs/Metamo_QuestParameters.prefab を置いてください。パラメータだけを作り、シェーダー・アニメーター・メニューは作りません。

導入順

  1. VRChat Creator Companion(VCC)で VRChat SDK Avatars・lilToon・NDMF・Modular Avatar を導入する(本パッケージには同梱していません)。
  2. 本パッケージ(unitypackage)をインポートする。Packages/com.kuyuri.metamo/ に入ります。
  3. lilToon が未導入だと本パッケージの Editor 拡張は無効のままです(コンパイルエラーは出ません)。lilToon を入れてから再度インポートしてください。

新しい版に入れ替えるとき

古いフォルダーを消さずに上から取り込まないでください。 変わったファイルが更新されず、古い版のまま気づかないことがあります(エラーは出ません)。

  1. 空のシーンを開きます(Metamo を置いたシーンを開いたまま消すと、Unity が落ちることがあります)。
  2. Packages/com.kuyuri.metamo/ フォルダーを消します。消した直後に、Console に「ファイルが見つからない」という一時的なコンパイルエラーが出ることがあります。次の手順でインポートすると消えます。
  3. 新しい unitypackage をインポートします。
  4. インポートが終わっても Console にコンパイルエラー(CS1061・CS0117 など。「…の定義が含まれていません」)が残っているときは、Project ウィンドウの Packages の中にある Metamo のフォルダーを右クリックして Reimport を選びます。Unity に古い版の情報が残っていることがあり、取り込み直すと消えます。
  5. 元のシーンを開き直します。Installer に入れた設定と、Assets/Metamo_User/ に複製したデザインはそのまま残ります。

対応する lilToon のシェーダー

Opaque/Cutout/Transparent(OnePass/TwoPass 含む)とそれぞれの Outline 付き、Fur/FurCutout/FurTwoPass、FurOnly 3 種、Gem、Refraction/RefractionBlur(計 19 変種)。Lite・Tessellation・Multi・Overlay・FakeShadow・OutlineOnly と lilToon 以外のシェーダーは対象外で、消えている間だけ非表示になります(ビルド時に情報として出ます)。

本パッケージのマテリアルを lilToon のインスペクタで開き、対象外の Rendering Mode を選んだ場合は、最も近い対応変種(例: Lite → 同じモードの通常変種、Tessellation → 同じモードの変種)に置き換わります。マテリアルは壊れません。

技術メモ

ライセンス

LICENSE.md(利用規約)と THIRD-PARTY-NOTICES.md(第三者のライセンス表記)を参照してください。