MRTKv2.3からMRTKv2.4へアップデートする

MRTKのアップデート

公式のリファレンスにアップデート方法が記載されていますが、そちらを参考に実際にアップデートを行いたいと思います。

また、今回はUnityのAssetファイルを更新する方法ですので、NuGet packagesでの更新方法は公式のリファレンスを参考ください。

新しいButton Config Helperなどを使うにはmigration toolという機能を使い、Assetないのアップデートを行う必要があります,その際に既存のManipulationHandlerが更新されていないなどのこともありますので、ハマったところを備忘録も含めて記載します。

過去のMRTKからのバージョンアップなど、公式リファレンスには有益な情報がたくさん含まれています。
ぜひまだチェックされていない方はチェックしてみてください。

事前準備

Unity , VisualStudioを閉じておく。
バックアップの作成
MRTKv2.4のダウンロード

下記サイトから以下4点をダウンロードする

Microsoft.MixedReality.Toolkit.Unity.Examples.2.4.0.unitypackage
Microsoft.MixedReality.Toolkit.Unity.Extensions.2.4.0.unitypackage
Microsoft.MixedReality.Toolkit.Unity.Foundation.2.4.0.unitypackage
Microsoft.MixedReality.Toolkit.Unity.Tools.2.4.0.unitypackage

https://github.com/microsoft/MixedRealityToolkit-Unity/releases

アップデート手順

MRTKの削除
Libraryフォルダの削除
MRTKv2.4のインストール
Libraryのキャッシュを更新
Sceneのtoolkitの更新
migration tool

1 MRTKの削除

削除する項目

MixedRealityToolkit
MixedRealityToolkit.meta
MixedRealityToolkit.Examples
MixedRealityToolkit.Examples.meta
MixedRealityToolkit.Extensions
MixedRealityToolkit.Extensions.meta
MixedRealityToolkit.Providers
MixedRealityToolkit.Providers.meta
MixedRealityToolkit.SDK
MixedRealityToolkit.SDK.meta
MixedRealityToolkit.Services
MixedRealityToolkit.Services.meta
MixedRealityToolkit.Staging
MixedRealityToolkit.Staging.meta

以上です。

MixedRealityToolkit.Generatedは削除しないでください。同様にmetaファイルの削除も厳禁です。

2 Libraryフォルダの削除

UnityではAssetのキャッシュ情報(ファイルの移動であったりなど)をLibraryフォルダで管理しています。
そのフォルダもアップデートにともなって更新しなくてはいけません。

詳しくは公式のリファレンスをご参照ください。
https://docs.unity3d.com/ja/2020.1/Manual/BehindtheScenes.html

3 MRTKv2.4のインストール

UnityProjectを開き、MRTKをインストールする。※インストールには順番があります。

Microsoft.MixedReality.Toolkit.Unity.Foundation.2.4.0.unitypackage
Microsoft.MixedReality.Toolkit.Unity.Tools.2.4.0.unitypackage
(オプション)
Microsoft.MixedReality.Toolkit.Unity.Extensions.2.4.0.unitypackage
Microsoft.MixedReality.Toolkit.Unity.Examples.2.4.0.unitypackage

上記の順番でインストールを行います。

私はいつもここからAssetのインポートを行っています。

4 Libraryのキャッシュを更新

インポートした後にもう一度Libraryの再構築を行う様です。
一度unityを落として、2 Libraryフォルダの削除　と同じことを行う様です。

5 Sceneのtoolkitの更新

再度 Unity を開いて今度はシーン上のToolKitの更新を行います。

削除する項目

Mixed Reality Toolkit
Mixed Reality Playspace

Sceneに新しいToolkitを適用させます。

以前までに使用していたカスタムプロファイルを適用させます。

以上で公式のアップデートは終了になります。

6 migration tool

新しくなったBounding box , Manipulation , Button Config helperを使用するには
既存のButtonなどの更新も必要になります。

MRTK2.3で使用していた

Manipulation Handler
Bounding Box Rig
はMigration toolを使用すると新しいコンポーネントに置き換わります。
その際に、AppBarなどで適用していたBoundingBoxのターゲットがインスペークター上から消えたりという現象が起こりますので、上記の2点のコンポーネントを操作しているscript、Inspectorの設定には注意が必要になります。

最後に

今回はMRTK2.3から2.4にアップデートすることを行いました。
SDKのアップデートは動かなくなったりなどのケースが多い印象ですが、今回のマイナーバージョンアップでは特にこれといった致命的な変更が行われていませんでしたので、すんなりと行うことができました。

次は、MRTKv2系でのNavMeshの動作環境を整えてみる。といった内容で投稿しようと考えています。