Installation - mimyquality/FukuroUdon GitHub Wiki

導入手順

リポジトリーのインポート

[!NOTE] 既に MimyLab のリポジトリーをインポートしている場合はこの手順をスキップできます。VPM パッケージのインポートへ進んでください。

VCC(VRChat Creator Companion)または ALCOM から、以下のどちらか一つの手順を行うことで MimyLab のリポジトリーをインポートできます。
(ALCOM 利用者は適宜読み替えてください)

  • https://vpm.mimylab.com/ へアクセスし、「Add to VCC」から https://vpm.mimylab.com/index.json を追加
  • VCC のウィンドウで Setting -> Packages -> Add Repository の順に開き、https://vpm.mimylab.com/index.json を追加

Add Repository

VPM CLI を使用してインポートする場合、コマンドラインを開き以下のコマンドを入力してください。

vpm add repo https://vpm.mimylab.com/index.json

VPMパッケージのインポート

VCC から任意のプロジェクトを選択し、「Manage Project」から Manage Packages 画面に移動します。
読み込んだパッケージが一覧に出てくるので、 Fukuro Udon の右にある「＋」ボタンを押すか「Installed Version」から直接バージョンを選ぶことで、プロジェクトにインポートします。
このとき一覧に出てこない場合は、右上の [Selected Repos] から MimyLab リポジトリーのチェックが外れていないか確認してください。
vcc_userpackages_add

リポジトリーを使わずに導入したい場合は、Release から unitypackage ファイルをダウンロードして、プロジェクトにインポートしてください。

[!WARNING] VPM 版 Fukuro Udon パッケージをインポートする前に、BOOTH 版アセットからインポートしたものは予め削除しておいてください。

利用方法

パッケージは Assets フォルダーではなく Packages フォルダーに展開されるようになります。サンプル Prefab もここに含まれています。
また、特定の U# スクリプトを決め打ちで使いたい場合は、付けたいオブジェクトの「Add Component」ボタンからスクリプト名で検索してアタッチするのでもOKです。
fukuroudon_location

FukuroUdonスクリプトへの参照方法

本 VPM はモジュール構造を尊重したいのと、最適化の観点から、 Auto Referenced オフにしています。

参考： Assembly Definitionを利用するべきシチュエーション

この状態の Fukuro Udon 内の U# スクリプトにアクセスする方法としては2パターンあります。

直接クラス名の型を使用せずに、UdonBehaviour のメソッドを使う

引数のない関数であれば UdonBehaviour.SendCustomEvent("関数名") で実行可能です。
変数に対しては UdonBehaviour.GetProgramVariable("変数名") / UdonBehaviour.SetProgramVariable("変数名", 値) で実行可能です。

Fukuro Udon を参照する Assembly Definition を定義する

こちらは最初の設定が少々複雑ですが、一度設定してしまえばこのフォルダー内のスクリプトからは Fukuro Udon 内のスクリプトにアクセスできるようになります。

  1. ご自身の U# スクリプトを纏めたフォルダーに、 Assembly Definition ファイルと U# Assembly Definition ファイルを設定します。ファイル名は同じにしてください。
  2. Assembly Definition の Assembly Definition References に、FukuroUdon の asmdef を追加します。
  3. Assembly Definition の Assembly Definition References に、UdonSharpRuntime やその他必要な asmdef を追加していきます。
  4. U# Assembly Definition の Source Assembly に Assembly Definition ファイルをセットします。

参考： https://vrclibrary.com/wiki/books/varneons-udonsharp-development-practices/page/assembly-definitions

[!NOTE] この Assembly Definition ファイルの Auto Referenced は有効にしても大丈夫です。

image