English

kieAplMenuTarget

AvatarPoseLibrary（HhotateA）のメニューを、好きな場所へ設置できるようにする NDMF プラグイン。

APL 本体には一切手を入れない。

何のために

APL のメニューは既定でアバターメニューの最上位に出る。位置を変える手段は APL にもあるが、Avatar Pose Library コンポーネントそのものをメニュー階層の中へ動かす必要があり、MA Menu Install Target は効かない。

たくさんのアバターを 1 プロジェクトで構造化して管理していると、コンポーネントは自分の階層に置いたまま、メニューだけメニューツリーへ入れたい。これはその 2 つを切り離す。

MA Menu Install Target が効かない理由

APL は ModularAvatarMenuInstaller をビルド中に生成する。MA Menu Install Target は既存の Installer を参照する仕組みなので、編集時に参照先が存在しない。さらに APL は生成ツリー内の Installer を無条件でアバタールートへ移動するため、階層で位置を指定しても捨てられる。

使い方

  1. メニューを置きたい場所に MA Menu Item（SubMenu / メニューソース 子オブジェクト）か MA Menu Group を用意する
  2. その同じ GameObject へ Add Component > Kie > kieAplMenuTarget を付ける

以上。Avatar Pose Library コンポーネントはどこに置いたままでもよい。

kieAplMenuTarget は入れ物と同じ GameObject に置くこと。子オブジェクトへ置くと効かない。判定はコンポーネント自身が乗っているオブジェクトしか見ない。

複数のライブラリを別々の場所へ出す

Avatar Pose Library が 2 つ以上あり、それぞれ違う場所へ出したい場合は、設置先を出したい数だけ置き、各設置先の 対象ライブラリ 欄へ、そこへ出すライブラリの GameObject を入れる。欄に何か入っている設置先は選択制になり、指定したものだけが来る。

**欄を空にした設置先は「受け皿」**で、どこにも指定されなかったライブラリを全部受け取る。一部だけ場所を決めて残りはまとめたい、という使い方ができる。受け皿を 2 つ以上置いた場合は階層順で最初だけが効き、警告が出る。指定を持つ設置先はいくつ置いてもよい。

欄を空のままにすれば、設置先 1 つで全ライブラリを受ける従来どおりの動きになる。

APL のメニュー階層は Avatar Pose Library のメニュー名欄（スラッシュ区切り）で決まる。つまり APL は自分の名前のフォルダを自分で作る。

付けるもの結果
MA Menu Item (SubMenu)段が 1 つ増える。 APL 側にも同名の階層があると AvatarPoseLibrary > AvatarPoseLibrary > … と二重になる
MA Menu Group段を増やさず親メニューへ流し込む。通常はこちら

既定では MA Menu Group を選ぶこと。Menu Item が要るのは、APL のメニュー名が階層を持たず、フォルダを 1 段作りたい場合だけ。

両方を同じ GameObject に付けないこと。MA 側で競合する。

ビルドすると Console にこの行が出る。移したライブラリの件数と、移した先のパスが入る。この行が無ければメニューは移っていない:

[kieAplMenuTarget] AvatarPoseLibrary 1 件を 'Menu/ポーズ' の下へ移しました

付ける先がメニューの入れ物でない場合は何もしない。インスペクタが赤く警告し、その場で MA Menu Item / MA Menu Group を足すボタンが出る。

設定が正しくないときは Console に [kieAplMenuTarget] から始まる警告が出る。ビルドは止まらないので、メニューが出ないときは Console を先に見ること。

仕組み

APL には元から位置指定の経路がある — Avatar Pose Library コンポーネントの親が MA Menu Group か 子オブジェクト ソースの SubMenu Menu Item なら、生成メニューをその親の中へ置く。

このプラグインは NDMF の Generating フェーズで APL より前に走り、その条件を満たすようコンポーネントを付け替えるだけ。生成物の形に依存しないので、APL がメニューの作り方を変えても壊れにくい。

制限

  • 対象ライブラリ欄を空にした設置先（受け皿）は、アバターに 1 つだけ。2 つ以上あると警告を出し、階層順で最初の 1 つを使う。対象ライブラリを指定した設置先はいくつでも置ける。
  • どの設置先にも指定されず、受け皿も無いライブラリは動かない（APL の既定位置に出る）。Console へ情報として出す。
  • 次の 2 つは動かしようがないので、そのライブラリだけスキップして警告を出す（他のライブラリは動かす）。
    • Avatar Pose Library がアバターのルートに付いている
    • 設置先が、その Avatar Pose Library の子孫にある（親子が循環する）
  • APL 側の「Target」（VRCExpressionsMenu アセット参照）とは併用しないこと。APL のソースに「削除予定」と書かれている機能なので、こちらもそれには乗っていない。

必要なもの

  • Unity 2022.3
  • VRChat Avatars SDK 3.7 以降 / NDMF 1.14 以降 / Modular Avatar 1.10 以降
  • AvatarPoseLibrary（HhotateA）— 無い場合は何もしない。動作確認済みは 1.2.42。 APL は VPM 依存に入れていない（無くてもインストールでき、その場合は何もしない）ため、 版の整合はここに書くだけで強制していない

ライセンス

MIT

Package Name

com.kie.kie-apl-menu-target

Documentation

Undefined

Repositories

Version

1.0.0 (Changelog)

Unity version

2022.3 or later

Dependencies

No dependencies

VPM Dependencies

Legacy Packages

No legacy packages

License

MIT

Author

Kie

Package JSON from Repository

{
  "name": "com.kie.kie-apl-menu-target",
  "displayName": "kieAplMenuTarget",
  "version": "1.0.0",
  "unity": "2022.3",
  "description": "AvatarPoseLibrary のメニューを好きな場所へ設置できるようにする NDMF プラグイン。",
  "vpmDependencies": {
    "com.vrchat.avatars": "^3.7.0",
    "nadena.dev.ndmf": "^1.14.0",
    "nadena.dev.modular-avatar": "^1.10.0"
  },
  "changelogUrl": "https://github.com/Kie610/kie-apl-menu-target/blob/main/CHANGELOG.md",
  "author": {
    "name": "Kie",
    "email": "64377537+Kie610@users.noreply.github.com",
    "url": "https://github.com/Kie610"
  },
  "license": "MIT",
  "zipSHA256": "025eb2dbf5a23ea6fe6d2563b169cb5ffa291774138d04bbf0ba011739045f57",
  "url": "https://github.com/Kie610/kie-apl-menu-target/releases/download/1.0.0/com.kie.kie-apl-menu-target-1.0.0.zip"
}