Metamo(メタモ)— パーティクルを使った変身・お着替えエフェクトのシステム(lilToon 対応)
Metamo(メタモ)は、VRChat アバターに、パーティクルを使った変身・お着替えエフェクト(登場・退場と衣装チェンジ)を簡単に入れられるシステムです。Modular Avatar 対応のプレハブをアバター直下に置くだけで、Ex メニューから使えます。lilToon の上に載るカスタムシェーダー(lilToon のカスタムシェーダー機構で生成)と、NDMF プラグインで構成されます。
- 版 1.0.0。PC 専用です(Quest 非対応)。
- 導入と基本の使い方は
Docs/README_ja.md(説明書)にまとめています。このファイルは、細かい仕様と制限の一覧です。
用語
境界(ディゾルブで消える部分と残る部分の境目)から出るパーティクルには 2 種類あります。名前が似ているので、この文書では次のように書き分けます。
| 呼び方 | 仕組み | パフォーマンスランク |
|---|---|---|
| ジオメトリパーティクル | ジオメトリシェーダーを使い、メッシュの面から直接出すパーティクルです。Unity の Particle System は使いません。境界が通った面そのものから出るので、体の形にぴったり沿います。 | 変わりません(境界の向きを横や斜めにしたときだけ、向きを合わせるための Constraint が 1 つ増えます) |
| パーティクル(Particle System) | Unity 標準の Particle System で出すパーティクルです。境界の高さに合わせて動く楕円体の中から出て、空中を漂います。 | Particle System が 1 つ増え、最大パーティクル数の分だけ影響します |
どちらも既定で ON で、それぞれ別に OFF にできます。両方をまとめて言うときは「境界のパーティクル」と書きます。
使い方(登場・退場)
Runtime/Prefabs/Metamo.prefabをアバターのルート直下にドラッグします。- 必要なら
Metamo Installerの項目を変えます: メニュー(使う項目と名前・「Ex メニュー」の節)、登場・退場の秒数(既定 3.0 秒/2.5 秒)、最初から非表示にするか(Start Hidden・既定 OFF)、境界の進む向き(Dissolve Direction・既定 上)と退場の向き(既定: 登場は足元から上へ、退場は頭から下へ)、掃引範囲の自動設定(既定 ON・レスト姿勢の頂点から Hips 相対で決める)、境界の色(任意)。 - VRChat SDK でビルド/アップロードします。NDMF がビルド時に、lilToon のマテリアルごとに派生マテリアルを作り、登場・退場のアニメーション・FX レイヤー・Ex メニュー(既定はトグル「登場・退場」1 つ)・Expression Parameters(既定は
KY_FxBool 1 bit。強度のラジアルを使うとKY_Strengthfloat 8 bit、衣装チェンジを使うとKY_Setint 8 bit が加わり、全部使うと 17 bit。「パーティクル OFF」をメニューに出すと、さらに 1 bit)を自動生成します。元のマテリアル・アニメーターは変更しません。 - VRChat で Ex メニューの「登場・退場」は最初 ON(表示)です。OFF にすると頭から消え、もう一度 ON にするまで消えたままです。ON にすると足元から現れ、現れ終わると元のマテリアルに戻ります。退場〜消えている間〜登場の間だけ派生マテリアルに差し替わり、表示中は何も書き込まないので、調整済みの見た目・他の lilToon 拡張・色替えなどのマテリアル差し替えギミックはそのまま使えます。
ビルドの前に対象を確かめる
Metamo Installer の Inspector の「対象の確認」を開いて「対象を調べる」を押すと、いまのアバターで、演出に乗るマテリアルと、消えている間だけ隠すもの(対応していないシェーダーなど)が一覧で出ます。ビルドのときと同じ判定です。他のツールがビルドの途中でマテリアルを変える場合は、結果が変わることがあります。マテリアルが入っていないスロット(Missing・None)は「マテリアルが入っていない」として別に出ます。そのスロットは演出に乗らず、消えている間も隠れません(マゼンタのまま残ります)。先にマテリアルを入れてください。
Ex メニュー
Metamo の項目は「登場・退場」(トグル)・「強度」(ラジアル)・「パーティクル OFF」(トグル)・「ジェスチャー」(トグル)・「衣装」(サブメニュー・衣装チェンジを使うとき)の 5 つで、Installer でそれぞれ使う/使わないを選べます(既定で出るのは「登場・退場」だけです)。Ex メニューのいちばん上には、いつも 1 項目しか出しません。
- 使う項目が 2 つ以上なら、
Submenu Label(既定「メタモ」)のサブメニュー 1 つにまとめます(中は 登場・退場 → 強度 → パーティクル OFF → ジェスチャー → 衣装 の順)。 - 1 つだけなら、その項目をいちばん上に直接置きます(例: 衣装チェンジだけなら「衣装」サブメニュー)。
- 使わない項目はパラメータも作らないので、Expression Parameters の枠をその分(登場・退場 1 bit・強度 8 bit・衣装 8 bit)使いません。
Use Entrance Exit(既定 ON): OFF にすると、アバターはいつも表示のままです(Start Hiddenは使われず、ON なら警告が出ます)。衣装チェンジはそのまま使えます。登場・退場も衣装チェンジも無いと、演出を出せないので警告が出ます。Use Strength(既定 OFF): 強度は、境界の光・境界のそばの頂点の揺れ・ジオメトリパーティクルの明るさの強さです(0〜1。0 にしても溶ける動きは同じで、光らず揺れなくなります)。パーティクル(Particle System)は、放出数だけが強度に連動します。OFF のときはStrength(既定 1)で固定、ON のときはラジアルの初期値になります。Use Particle Off Menu(既定 OFF): ON にすると、メニューに「パーティクル OFF」が出ます。VRChat の中でこれを ON にしている間は、ジオメトリパーティクルもパーティクル(Particle System)も出しません(ディゾルブ・境界の光・衣装の入れ替わりはそのままです)。人の多い場所や、パーティクルを見せたくない場面で使えます。同期するパラメータが 1 bit 増えます(KY_ParticleOff)。名前はParticle Off Labelで変えられます。- 「ジェスチャー」は、下の「ハンドジェスチャーで変身」を使うときだけ出ます。
- 名前は
Menu Label(登場・退場)・Strength Label(既定「強度」)・Submenu Label、衣装はMetamo OutfitsのMenu Labelで変えられます。 - 自分のサブメニューの中に入れたいときは、プレハブの
MA Menu Installerのインストール先を変えます。
使い方(衣装チェンジ)
同じディゾルブの境界で衣装を入れ替える、または消えている間に着替える機能です。衣装でも「2 体を合体したアバターの身体ごと」でも、仕組みは同じ(セットの表示切替)です。
- Metamo のオブジェクト(Installer と同じでよい)に
Metamo Outfitsコンポーネントを追加します。 - 「衣装セット」(
Sets)を並べます: 名前と、そのセットで表示する GameObject(子孫ごと)。先頭のセットがアップロード時の状態です。同じオブジェクトを複数のセットに入れてかまいません(共通のアクセサリ)。別のセットに入れたオブジェクトの子孫は登録できません。最大 8 セット、推奨 2〜4。 - 切替方式(
Mode)を選びます: 境界で(At Boundary・既定・2.5 秒・頭から下へ。旧セットが消えるのと同じ境界で新セットが現れる)/消えてから(While Gone・全身が退場 → 消えている間に切替 → 新セットで登場。秒数は Installer の登場・退場秒数)。「選択を保存」(Save Selection)が ON なら次回も同じ衣装で出ます。 - ビルドすると Ex メニューに「衣装」サブメニュー(セットごとのトグル)が増えます(登場・退場も使うときは、2 つが「メタモ」サブメニューの中にまとまります)。消えている間(登場・退場が OFF)に選ぶと演出なしで切り替わり、次の登場で新しい衣装が出ます。遅れて入った相手にも選択中のセットが出ます。
- (任意)衣装に合わせて衣装の外の値も変えるときは、各セットの「値」(
Values)に行を足します。1 行は、対象のレンダラー・種類(シェイプキー/マテリアルの float)・名前(シェイプキー名、またはプロパティ名。色やベクトルは_Color.r・_Vec.xのように成分ごと)・そのセットを着ている間の値・切り替える秒数・切り替え中の値(任意)です。- 切り替える秒数: 境界モードの切替の始めから何秒で値を入れ替えるか。境界がその部位を通る秒数を入れます(例: 2.5 秒で頭から足元まで進むなら、胸は 0.75 秒ほど)。既定は「終わり」(確定のとき)。
- 切り替え中の値: 入れると、そのセットへ・そのセットからの切替の間はずっとその値になり、確定で行き先の値になります(例: 服で隠れる肌を消すマスクを、衣装が重なる切替中だけ外す)。
- 登録していないセットを着ている間は、シーンのレンダラー・マテリアルに入っている値(既定の値)になります。先頭のセットの見た目に要る値は、シーンに入れておいてください(アップロード時や、アニメーションを止めている相手にはこの見た目が出ます。先頭のセットにシーンと違う値を登録するとビルド時に警告が出ます)。
- 消えている間の切替・消えてからモード・読み込み時は、秒数を使わずに切り替わります。値は段で切り替わります(なめらかには変わりません)。
衣装チェンジの制限:
- 登録したオブジェクトは、他のトグル(アバターに最初から付いている部位ごとのトグル・Modular Avatar の Object Toggle・自作の FX)で表示を切り替えないでください。Metamo とそのトグルの両方が同じオブジェクトの表示(
m_IsActive)を書くので、どちらかが効かなくなります。- Write Defaults が ON のアバターでは、衣装セットの表示が優先され、そのトグルは登録したオブジェクトに効かなくなります(衣装チェンジは動きます)。例: 元の衣装を先頭のセットに登録すると、アバターに付いている「コート OFF」を押してもコートは出たままになります。
- Write Defaults が OFF のアバターや、そのトグルのレイヤーが Metamo より後ろにあるときは、逆にそのトグルが優先され、別のセットを着ているのに登録したオブジェクトが出る・出るはずのオブジェクトが消えたままになることがあります。
- そのトグルが体や髪のシェイプキーも一緒に動かしている場合、シェイプキーはそのまま動きます(表示は変わらないのに、シェイプキーだけ変わることがあります)。
- ビルド時に、他のレイヤー(Merge Animator・Object Toggle を含む)が登録したオブジェクトそのものの表示を動かしていると、NDMF Console に警告を出します(セットの子を動かすのは問題ありません)。
- そのトグルも使いたいときは、トグルをレンダラーの有効・無効(
m_Enabled)で書き直すか、セットには親のオブジェクトを登録して、トグルはその子を動かすようにしてください。
- 切り替わるのは GameObject の表示と、セットに登録した値(シェイプキー・マテリアルの float)です。マテリアルの差し替え(スロットに別のマテリアルを入れる)は連動しません(演出の派生マテリアルとぶつかるため)。マテリアルの float はそのレンダラーの全スロットに効きます。
- 登録した値を他のレイヤー(自作の FX・Merge Animator・MA の Shape Changer など)も動かしていると、ビルド時に警告が出ます。「下着姿のときは別の値」のような、他のトグルとの組み合わせには対応しません。
- 遷移中に「登場・退場」を OFF にすると、衣装の遷移は途中で打ち切られて退場に引き継がれます(0.1 秒ほど新しい衣装が全部見えることがあります)。別のセットを続けて選んだ場合は、遷移が終わってから次が始まります。退場の掃引中(OFF にしてから消え切るまで)にセットを選ぶと、古い衣装はその場で消え、新しい衣装は掃引の途中から現れてそのまま消えます。
- 別のアバター(別のアバター ID)への切替は VRChat の仕様上アバター側からはできません。
すでにある Modular Avatar のメニューから取り込む
すでに Modular Avatar で衣装の切り替えメニューを作ってある場合は、登録し直さずに衣装セットへ取り込めます。
Metamo Outfitsの Inspector のいちばん下の「MA のメニューから取り込む」を押します。- 取り込める組が 1 つなら、そのまま取り込みます。複数あるときは一覧が出るので、「取り込む組」で選んで「選んだ組を取り込む」を押します。
- 「衣装セット」に 1 項目 = 1 セットで入ります。内容を確かめ、必要なら手直しします。取り込むと今の衣装セットは置き換わります(Undo で戻せます)。
取り込める組:
- 同じパラメータ名を持つ、トグルの MA Menu Item が 2 つ以上あること。値は自動(
Automatic)でも手入力でもかまいません(手入力の値どうしが重なっている組は対象外)。 - それぞれの項目と同じオブジェクトに MA Object Toggle が付いていること。
- 上着や帽子のような、1 つずつ独立したトグル(パラメータが別々のもの・パラメータ名が空のもの)は対象外です。
- そのパラメータを MA Parameters で内部名・接頭辞・名前の変換にしている組と、
KY_で始まるパラメータの組は対象外です。 - 取り込めない組は、理由を Inspector に表示します。
取り込みの決まり:
- 既定の項目(
Is Default)があれば、それが先頭のセット(アップロード時の状態)になります。複数あるときは、階層でいちばん下のものです。 - 既定の項目が無いときは、「他の項目が隠す指定をしていて、いまシーンで表示されているオブジェクト」を集めた「既定」というセットを先頭に作ります。
- セットで表示するオブジェクトは、その項目の Object Toggle が「表示」にしているものです。
- 同じ項目に MA Shape Changer が付いていれば、「値を設定」の指定を、そのセットの値(シェイプキー)として取り込みます。「削除」の指定は取り込みません。
- 9 項目以上ある組は、8 セットまで取り込みます(補った「既定」も数えます)。
- アバターの外のオブジェクトや、別のセットに入ったオブジェクトの子孫などは取り込まず、理由を表示します。
ビルドのときの動き:
- シーンの MA の設定は書き換えません。ビルド(アップロード)のときだけ、取り込み元の Menu Item と、同じオブジェクトの Object Toggle・Shape Changer を外し、Metamo の「衣装」メニューに置き換えます。元のパラメータは作られません。取り込み元だけが入っていたサブメニューは、空になるので一緒に外します。
- 取り込んだあとで元の MA のメニューを変えた(項目を足した・対象や値を変えた・消した)ときは、ビルド時に NDMF Console に警告が出て、保存済みの衣装セットのままビルドします。足した項目は元のトグルのまま残るので、取り込み直してください。
- 同じパラメータを、自作の FX や Expression Parameters のアセットでも使っている場合、そちらは置き換えません。
- 取り込み元(パラメータ名と項目の数)は、
Metamo Outfitsの Inspector の下のほうに表示されます。「関連付けを外す」を押すと、衣装セットは残したまま、ビルド時の置き換えをやめます(Undo で戻せます)。外したあとは元の MA のトグルと衣装チェンジの両方が残り、登録したオブジェクトを元のトグルも切り替えることになるので、「衣装チェンジの制限」の警告が出ます。 - 取り込みをやめて元の MA のメニューだけに戻すときは、
Metamo Outfitsを消してください。
ハンドジェスチャーで変身
メニューを開かずに、両手の形で変身を始められます。ライブや撮影向けの機能で、既定では使いません。
Metamo Installerの「ハンドジェスチャー」でUse Gesture Triggerを ON にします。- 左手と右手の形(
Gesture Left/Gesture Right)を選びます。既定は両手とも「ロックンロール」(VRChat の RockNRoll)です。 - 起こすこと(
Gesture Action)を選びます: 次の衣装へ(既定。衣装セットを順番に切り替え、最後の次は先頭に戻ります)/登場・退場の切り替え。
- 両手がその形になった瞬間に、1 回だけ動きます。手の形を崩すまで、次は起きません。
- 「次の衣装へ」を選んでいても、衣装セットが 2 つ未満のときは、登場・退場の切り替えとして動きます。
- Ex メニューの「ジェスチャー」(名前は
Gesture Menu Label)で、VRChat の中から止められます(既定は ON)。誤って変身したくない場面では OFF にしてください。 - 同期するパラメータは増えません(判定は自分の画面の中だけで行い、結果だけが他の人に伝わります)。
- アバターが手の形に表情を割り当てている場合は、その表情も一緒に出ます。ふだんの操作で出にくい形を、両手とも指定するのをおすすめします。
境界の進む向き
Metamo Installer の Dissolve Direction(Vector3)で、境界が進む向きを決めます。向きはアバターのルートに対する向きで、アバターが振り向くと境界の向きも一緒に回ります。登場はこの向きに進み、退場は逆向きに進みます(退場の向き Leave From Top と、衣装チェンジの境界の向き Change From Top の反転はそのまま使えます)。Installer を選ぶと、SceneView に登場・退場・衣装チェンジの境界が進む向きが矢印で出ます。
- 既定の上向き(と真下)では、アバターには何も足しません。
- 横や斜めの向きにすると、ビルド時に基準のオブジェクト(
KyFx_SweepFrame・Hips の位置に追従・Constraint 1 個)を作り、演出の対象のメッシュの Root Bone をそこへ付け替えます(見た目のスキニングは変わりません)。カリング用の範囲(Bounds)は、腰を回してもはみ出さない立方体に広げます。Modular Avatar の Mesh Settings で決めた Root Bone も上書きします(警告が出ます)。 - 次のメッシュは付け替えず、そのメッシュ自身の向きに付いていきます(首振りや手の動きで、境界が少しずれることがあります。ビルド時に警告が出ます): lilToon の顔の SDF 影(Shadow Mask Type = SDF)を使うメッシュ(付け替えると顔の影が首振りに付いてこなくなるため)、骨の無い SkinnedMeshRenderer、MeshRenderer。
- Root Bone を付け替えると、lilToon のオブジェクト空間を使う機能(フラット影・本体の Position ディゾルブ・AudioLink の位置モード・ローカル指定のライト方向・オブジェクト単位の Distance Fade)の見え方が変わることがあります。気になる場合は向きを上下に戻してください。
- 衣装に合わせた値の「切り替える秒数」は、この向きに沿った境界の位置を表します。向きを変えたら秒数も見直してください。
境界のパーティクル
ディゾルブの境界を通過した直後の面からパーティクルが出ます(登場・退場・衣装チェンジのすべての境界)。既定で ON で、Metamo Installer の項目で調整/OFF にできます。2 つの仕組み(「用語」の節)を重ねています。
- ジオメトリパーティクル
Use Geometry Particles: 派生マテリアルのジオメトリシェーダーが、境界の面から直接出します。Particle System は使いません。密度(1 m² あたり)・大きさ・飛ぶ距離・上がる距離・寿命の長さ(境界の後ろ何 m まで)を Installer で調整できます。境界が上へ進んで消える演出(下からの衣装チェンジ・足元からの退場)では、ジオメトリパーティクルが境界に置いていかれないように、上がる距離をビルド時に自動で足します(Geometry Particle Upward Compensation・既定 1 = 頭から下へ消えるときと同じ速さで境界から離れる・0 = 足さない)。色は境界のグラデーション(または 2 色)、明るさは「強度」ラジアルに連動します。パフォーマンスランクは変わりません。 - パーティクル(Particle System)
Use Particle System: Unity の Particle System を 1 つ生成し、境界の高さに合わせて動く楕円体の中からパーティクルを出します。楕円体の幅は、足・胴・頭の太さをビルド時に高さごとに測って決めます(腕や小物の位置からは出ません)。境界が体の範囲を外れている間は出しません。演出が終わった後も、出ているパーティクルが消えるまで(既定の雛形で最大 2 秒)は残ります。- Installer で調整できるもの: 放出数(
Particle System Rate・既定 2000/秒・上限 5000/秒)・最大同時数(Particle System Max・既定 2500)・楕円体の厚さ・横の余白・進行方向のずれ・殻の厚さ。「強度」で放出数も減ります。 - 寿命・大きさ・初速・動き(Noise など)は、雛形の Particle System で決めます。変えたいときは「色やデザインを変える」の手順で雛形を複製して編集します(
Particle System Templateが空なら同梱の既定Runtime/Prefabs/KyFx_ParticleSystem_Default.prefab)。
- Installer で調整できるもの: 放出数(
- カメラの近く: どちらのパーティクルも、カメラから 0.2 m 以内は描かず、0.5 m までで滑らかに薄くします(自分の視点では目が頭の中にあるため、顔の近くを境界が通るとパーティクルが目の前で大きな玉に見えるのを防ぎます)。
- ジオメトリパーティクルの描き方と描画順: 既定は「加算」+
Geometry Particle Raise QueueON です。光を重ねて明るくし、ジオメトリパーティクルが壁・床・空に隠れないよう、演出中だけアバターの描画順(Render Queue)を 2501 に上げます。その数秒間は、髪などがワールドの半透明な物と重なったときに前後が狂ったり、カメラの深度テクスチャ(奥行きの情報)から外れて、被写界深度・SSAO などが素通ししたりします。気になる場合は Installer で次のどちらかを選んでください。- (a)
Geometry Particle Raise Queueを OFF: 元の描画順に戻ります。ただし、ジオメトリパーティクルは自分の体の上にしか見えなくなります。 - (b)「ジオメトリパーティクルの描き方」を「不透明(ディザー)」に変更: 元の描画順のまま、ジオメトリパーティクルの奥行きを書くことで壁・床・空に上書きされるのを防ぎます。薄さは細かい点描になります。HDR の色は保つのでワールドのブルームに反応しますが、加算のような重なりの明るさは出ません。このモードでは
Geometry Particle Raise Queueは効きません。 - 元から半透明のマテリアルを不透明に変える設定ではありません。パーティクル(Particle System)の描き方も変わりません。
- (a)
境界のパーティクルの制限:
- パーティクル(Particle System)を ON にすると、既定のままではパフォーマンスランク(PC)は Poor 以下になります。増えるのは Particle System +1・最大パーティクル数 2500(既定)・Constraint +1 です(Physics Collider は増えません)。最大パーティクル数の合計の上限は Good 300・Medium 1000・Poor 2500 で、アバターが元から Particle System を持っていると合計が 2500 を超えて Very Poor になります。ランクを保ちたいときは
Particle System Max(最大同時数)を下げ、それに合わせてParticle System Rate(放出数)も下げてください(例: 最大 300・放出 300/秒 で Good の範囲)。Use Particle Systemを OFF にすればランクは変わりません(ジオメトリパーティクルだけならランク不変です)。 - 他プレイヤーの Safety 設定やパーティクルリミッターで、パーティクル(Particle System)が消されることがあります(ジオメトリパーティクルは消されません)。
- Hips が無いアバターでは、パーティクル(Particle System)は生成しません(ジオメトリパーティクルは出ます)。
- 衣装チェンジでは境界の両側(消える衣装の消えた直後の面と、現れる衣装の現れる直前の面)にジオメトリパーティクルが出ます。
- 楕円体の幅を測るメッシュは
Particle System Rendererで指定できます(空なら演出の対象のメッシュ全部)。 - VRChat の中でパーティクルを止めたいときは、Ex メニューの「パーティクル OFF」を使えます(
Use Particle Off Menuを ON にしてビルドしたとき)。
既知の制限
- 対象は lilToon の Opaque/Cutout/Transparent(OnePass/TwoPass 含む・それぞれ Outline 付きも)、Fur/FurOnly、Gem、Refraction です。それ以外(lilToon の Lite/Tessellation/Multi/Overlay/FakeShadow/OutlineOnly と、lilToon 以外のシェーダー)は掃引に乗らず、消え切った後に非表示になり、登場完了で表示に戻ります(NDMF Console に情報として出ます)。アバターが元から持っている Particle System などの Renderer も、消えている間は非表示にします。
- SkinnedMeshRenderer の波面は rootBone(通常 Hips)を基準にしたワールド軸の掃引です。rootBone が Hips でないメッシュ(髪が Head など)と MeshRenderer は、レスト姿勢で高さを合わせますが、動くと数 cm ずれることがあります(NDMF Console に警告が出ます)。Modular Avatar の Mesh Settings(Root Bone)と Merge Armature(衣装のボーン併合)はビルド後の状態を先読みして判定します。Avatar Optimizer(AAO)の Merge Skinned Mesh で部品をまとめたアバターは、AAO の処理の後にまとめたメッシュの実際の原点で高さを合わせ直します(設定は不要)。原点が Hips の部品と Hips でない部品を 1 つにまとめると、AAO が「マテリアルのアニメーションが一部だけ」という警告を出すことがありますが、Metamo の境界は正しく揃います。AAO の自動統合(Trace and Optimize)は、Metamo の対象(マテリアルを差し替える部品)をまとめません。
- 退場〜消えている間〜登場の間は派生マテリアルがスロットに入るため、その間は色替えトグルなどのマテリアル差し替えギミックが効きません。登場が終わると元に戻り、表示中は Metamo はマテリアルを書き込みません。
- Metamo より後ろのレイヤーが対象のマテリアルを差し替えていると(Modular Avatar の Material Setter など)、演出中もそのマテリアルが優先され、そのスロットだけ溶けない・消えないことがあります。ビルド時に NDMF Console に警告を出します。マテリアルの切り替えは、Metamo より前のレイヤー(アバターの FX のレイヤーなど)で行ってください。
- 遅れてインスタンスに入った相手には、あなたが消えている状態(
KY_Fx= 0)が同期された時点で退場アニメーションが 1 回再生されてから、消えた状態になります。 - 登場の途中で OFF にすると、退場は最初から始まります(進行度は連結しません)。
- Metamo のレイヤーの Write Defaults は、ビルド時にアバターに合わせて自動で決めます。アバターの FX(記述子の FX と、FX へ入るすべての Modular Avatar の Merge Animator)に WD ON のステートが 1 つでもあれば WD ON、無ければ WD OFF です。WD OFF が主のアバターで WD ON になっても振る舞いは変わりません(WD OFF のステートがアクティブな間は、Metamo の WD ON も既定値を書き戻さないため)。WD ON のアバターに WD OFF のレイヤーを足すと、表情などの WD ON のレイヤーが既定に戻らなくなるためです。
- WD ON のとき、衣装チェンジは選んだセットの表示(
m_IsActive)を書き続けて保ちます(マテリアルなど他の値は書きません)。登録したオブジェクトを他のトグルで動かさないでください(WD OFF のときと同じ約束)。 - Metamo より後に FX へレイヤーを足す他の NDMF プラグインのステートは判定に入りません。ビルドの後で Write Defaults を書き換えるツール(VRCFury の Write Defaults 自動修正など)との併用は保証しません。
- WD ON のとき、衣装チェンジは選んだセットの表示(
- VRChat のアバター拡縮(身長変更)は、組み込みパラメータ
ScaleFactorを使って境界の位置を追従させます(拡縮に対応していない環境では等倍として扱います)。 - Forward Add(追加のポイント/スポットライト)のパスでも境界色を加算するので、追加ライトの近くでは境界がその分明るくなります。
- Outline 付きの変種では、境界の縁に輪郭線の色が出ます。輪郭線の幅と境界の色で調整してください。
色やデザインを変える
- アバターに置いた
Metamoの Inspector で、Lookの下の 「既定のデザインを複製して編集」 を押します。Assets/Metamo_User/に自分用の Look が作られ、Look欄に入ります。同名があれば連番になり、上書きしません。 - 「色・幅・ノイズを編集」 を開きます。ここで変えた設定はビルド時に反映されます。同じ 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 は頂点の散らばりと、その帯の幅です。
- Edge Use Gradient = ON:
- ジオメトリパーティクルとパーティクル(Particle System)の色は、どちらも境界の色から決まります。 色をまとめて変える場合は Look を編集してください。
Override Edge Colorsが ON だと、Look の色より Installer のEdge Color 1 / 2が優先されます。Look のグラデーションを使うときは OFF にします。 - ジオメトリパーティクルの画像は 「ジオメトリパーティクルのテクスチャ」 に入れます。空なら元マテリアルの設定を維持し、未設定なら同梱の画像を使います。パーティクル(Particle System)の画像とは別です。
- パーティクル(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 は欄への割り当てを戻します(複製ファイルは残ります)。ボタンを押さずに使う場合は既定のデザインのままです。
対応バージョン(検証環境)
| 項目 | バージョン |
|---|---|
| Unity | 2022.3.22f1 |
| VRChat SDK (Avatars) | 3.10.5 |
| lilToon | 2.3.4(この版で検証) |
| NDMF | 1.14.8 |
| Modular Avatar | 1.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 を置いてください。パラメータだけを作り、シェーダー・アニメーター・メニューは作りません。
Sourceに PC 版のMetamo(Installer)を入れると、その設定から PC 版と同じ内容でパラメータを作ります。入れない場合は、プレハブの 6 つの項目(Use Entrance Exit・Use Strength・Strength・Start Hidden・Use Outfits・Save Selection)を PC 版に合わせてください。- 並び順を揃えるため、Quest 版でも PC 版の
Metamoと同じ位置(例: アバター直下・他の MA Parameters との前後関係が同じ)に置いてください。 - Installer と同じアバターに置くと、何もせず警告します。
導入順
- VRChat Creator Companion(VCC)で VRChat SDK Avatars・lilToon・NDMF・Modular Avatar を導入する(本パッケージには同梱していません)。
- 本パッケージ(unitypackage)をインポートする。
Packages/com.kuyuri.metamo/に入ります。 - lilToon が未導入だと本パッケージの Editor 拡張は無効のままです(コンパイルエラーは出ません)。lilToon を入れてから再度インポートしてください。
新しい版に入れ替えるとき
古いフォルダーを消さずに上から取り込まないでください。 変わったファイルが更新されず、古い版のまま気づかないことがあります(エラーは出ません)。
- 空のシーンを開きます(
Metamoを置いたシーンを開いたまま消すと、Unity が落ちることがあります)。 Packages/com.kuyuri.metamo/フォルダーを消します。消した直後に、Console に「ファイルが見つからない」という一時的なコンパイルエラーが出ることがあります。次の手順でインポートすると消えます。- 新しい unitypackage をインポートします。
- インポートが終わっても Console にコンパイルエラー(
CS1061・CS0117など。「…の定義が含まれていません」)が残っているときは、Project ウィンドウのPackagesの中にある Metamo のフォルダーを右クリックしてReimportを選びます。Unity に古い版の情報が残っていることがあり、取り込み直すと消えます。 - 元のシーンを開き直します。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 → 同じモードの変種)に置き換わります。マテリアルは壊れません。
技術メモ
- 独自のシェーダープロパティは
_KY接頭辞だけです。キーワード(shader_feature)は使いません。 - ジオメトリパーティクルの描き方はマテリアルの値で切り替え、専用のキーワード・追加のパスは増やしません。ジオメトリパーティクルのパス(
KY_GEOMETRY_PARTICLES)には、VR のインスタンシング用に標準のmulti_compile_instancing(通常/インスタンシングの 2 通り)を指定しています。 - ジオメトリシェーダーを使うため、DirectX 11 以降(PC)が必要です。
ライセンス
LICENSE.md(利用規約)と THIRD-PARTY-NOTICES.md(第三者のライセンス表記)を参照してください。