-
Notifications
You must be signed in to change notification settings - Fork 9
Installation
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を追加

VPM CLI を使用してインポートする場合、コマンドラインを開き以下のコマンドを入力してください。
vpm add repo https://vpm.mimylab.com/index.json
VCC から任意のプロジェクトを選択し、「Manage Project」から Manage Packages 画面に移動します。
読み込んだパッケージが一覧に出てくるので、 Fukuro Udon の右にある「+」ボタンを押すか「Installed Version」から直接バージョンを選ぶことで、プロジェクトにインストールします。
このとき一覧に出てこない場合は、右上の [Selected Repos] から MimyLab リポジトリーのチェックが外れていないか確認してください。

リポジトリーを使わずに導入したい場合は、Release から unitypackage ファイルをダウンロードして、プロジェクトにインポートしてください。
Fukuro Udon は以下のパッケージに依存しています。Fukuro Udon インストール時に一緒にインストールされるはずですが、インストールされていない場合はインストールし、Fukuro Udon 利用前に初期設定を行ってください。
VRChat ワールド前提パッケージのためインストール済みのはずです。
初期設定として、メニューバーの Edit > Project Settings から Project Settings ウィンドウを開き、TextMesh Pro タブから「Import TMP Essentials」を実行してください。グレーアウトしている場合は設定済みです。
Fukuro Udon の一部 uGUI プレハブには TextMesh Pro VRC Fallback Font JP の空フォントを採用しています。
こちらの使い方を参考に、TextMesh Pro とこの VPM の初期設定をしてください。
パッケージは Assets フォルダーではなく Packages フォルダーに展開されます。サンプル Prefab もここに含まれています。
また、特定の U# スクリプトを決め打ちで使いたい場合は、付けたいオブジェクトの「Add Component」ボタンからスクリプト名で検索してアタッチするのでもOKです。

本 VPM はモジュール構造を尊重したいのと、最適化の観点から、Auto Referenced をオフにしています。
参考: Assembly Definitionを利用するべきシチュエーション
この状態の Fukuro Udon 内の U# スクリプトにアクセスする方法としては2パターンあります。
引数のない関数であれば UdonBehaviour.SendCustomEvent("関数名") で実行可能です。
変数に対しては UdonBehaviour.GetProgramVariable("変数名") / UdonBehaviour.SetProgramVariable("変数名", 値) で実行可能です。
こちらは最初の設定が少々複雑ですが、一度設定してしまえばこのフォルダー内のスクリプトからは Fukuro Udon 内のスクリプトにアクセスできるようになります。
- ご自身の U# スクリプトを纏めたフォルダーに、 Assembly Definition ファイルと U# Assembly Definition ファイルを設定します。ファイル名は同じにしてください。
- Assembly Definition の Assembly Definition References に、FukuroUdon の asmdef を追加します。
- Assembly Definition の Assembly Definition References に、UdonSharpRuntime やその他必要な asmdef を追加していきます。
- U# Assembly Definition の Source Assembly に Assembly Definition ファイルをセットします。
参考: https://vrclibrary.com/wiki/books/varneons-udonsharp-development-practices/page/assembly-definitions
Note
この Assembly Definition ファイルの Auto Referenced は有効にしても大丈夫です。

