インストール ガイド

Caution

MRTK や Unity での Mixed Reality 開発が初めての場合は、Unity 開発ジャーニー のはじめから始めることをおすすめします。Unity 開発ジャーニーは MRTK の開始点としておすすめです。特に、インストール、コア コンセプト、Unity での MRTK の使用法について説明するために作られました。

前提条件

Mixed Reality Toolkit を始めるには、次のものが必要です。

  • Visual Studio 2019

  • Unity 2018.4 または Unity 2019.4

    MRTKは、 Unity 2018 で IL2CPP と .NET scripting backends の両方をサポートします。
    MRTK 2.5 から始める場合、Unity 2018 を使う方には Unity 2018.4.13f1 以降が強く推奨されます。Unity 2018.4 の以前のバージョンもサポートはされますが、セットアップや Unity 2019 へのアップグレードに追加のステップが必要となります。

  • Windows SDK 18362+

    これは WMR、HoloLens 1、または HoloLens 2 向けの UWP アプリを構築する場合に必要です。OpenVR 向けに構築する場合は不要です。

MRTK を Unity Project に追加する

Note

Unity 2019.4 以降のユーザーは、Unity Package Manager を使って MRTK をインポートできます。詳細は Unity Package Manager の利用 をご覧ください。

必須事項

  1. 最新の MRTK Unity package を取得する
  2. MRTK のパッケージを Unity プロジェクトにインポートする
  3. Unity プロジェクトをターゲット プラットフォームに切り替える
  4. MRTK を新しいシーン、または新しいプロジェクトに追加する

オプション

最新の MRTK Unity package を取得する

  1. MRTK リリース ページを開きます。
  2. Assets の下から、以下をダウンロードします。
    • Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage
    • (オプション) Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage
    • (オプション) Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage
    • (オプション) Microsoft.MixedRealityToolkit.Unity.TestUtilities.unitypackage
    • (バージョンのアップグレードに必要、そうでなければオプション) Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage

パッケージと内容の詳細については、MRTK Packages をご覧ください。

MRTK のパッケージを Unity プロジェクトにインポートする

  1. 新しい Unity プロジェクトを作成するか、既存のプロジェクトを開きます。新しいプロジェクトを作成する場合は、テンプレート タイプに 「3D」 が選択されていることを確認してください。
  2. ダウンロードした Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage をインポートします。「Asset -> Import Package -> Custom Package」から、 .unitypackage ファイルを選択し、 インポートする全ての項目がチェックされていることを確認してから、「Import」を選択します。
  3. (オプション) Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage を Foundation パッケージと同様にインポートします。 Extensions パッケージは、オプションで、 MRTK の便利なオプション コンポーネントのセットを提供します。
  4. (オプション) Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage を上記と同様の手順でインポートします。Examples のパッケージは、オプションであり、現在の MRTK の機能の有用なデモ シーンが含まれています。Examples パッケージは Extensions パッケージが必要であることにご注意ください
  5. (バージョンのアップグレードに必要、そうでなければオプション) Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage を Foundation パッケージと同様にインポートします。Tools のパッケージは、オプションであり、MRTK 開発者のエクスペリエンスを向上させる、ExtensionServiceCreator などの便利なツールが含まれています。
Note

Unity 2018.4.12f1 以前を使っている場合は、コンソールにコンパイル エラーが表示されることにご注意ください。プロジェクト ウィンドウで Assets\MRTK\Providers\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.asmdef を開き、インスペクターで missing reference を削除してください。このステップを Assets\MRTK\Providers\Oculus\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.Oculus.asmdef と Assets\MRTK\Providers\WindowsMixedReality\XRSDK\Microsoft.MixedReality.Toolkit.Providers.XRSDK.WMR.asmdef でも行ってください。Unity 2019 にアップグレードする際にはこれら 3 つの asmdef ファイルをもとの修正されていないもので置き換えて変更を元に戻さなければならないことにご注意ください。

Note

Android と iOS の開発には、追加のパッケージ インストールが必要です。より多くの情報については、MRTK を iOS と Android 向けに設定する方法をご覧ください。 Foundation パッケージをインポートすると、次のようなプロンプトが表示される場合があります。

UnitySetupPrompt

MRTK は、以下を実行することで Mixed Reality ソリューションを構築するためのプロジェクトをセットアップします。

  • 現在のプラットフォームで XR Settings を有効にします (XR チェックボックスを有効にします)。
  • テキストのシリアライズを強制 / メタ ファイルの可視化をします （ソース管理をする Unity プロジェクトに推奨）。

これらのオプションを適用するかは選択的ですが、推奨されています。

一部のプレハブ、及びアセットには、TextMesh Pro が必要です。つまり、TextMesh Pro のパッケージをインストールし、アセットがプロジェクト内にあることが必要です。(Window -> TextMeshPro -> Import TMP Essential Resources) TMP Essentials Resources をインポートした後、変更を確認するには Unity を再起動する必要があります。

Unity プロジェクトをターゲット プラットフォームに切り替える

パッケージがインポートされたら、次のステップはアプリケーションの正しいプラットフォームを選択することです。

HoloLens アプリケーションを作成するには、Universal Windows Platform に切り替えます。

  • File > Build Settings からメニューを開きます。
  • Platform の一覧から、Universal Windows Platform を選択します。
  • Switch Platform ボタンを押します。

Switch Platform

Note

Mixed Reality Toolkit は、プラットフォームが選択された際にプロジェクトに推奨される変更を適用するためのプロンプトを表示します。プラットフォームが変更されたときはいつでも、必要であれば適切な設定がチェックされプロンプトに表示されます。

MRTK を新しいシーン、または新しいプロジェクトに追加する

  1. 新規のプロジェクトを作成する、あるいは新しいシーンを現在のプロジェクトに作成します。

  2. MRTK のパッケージが上記の手順 に従ってインポートされていることを確認します。(Examples は必須ではありませんが、 Foundation と Examles の両方をインポートすることを推奨します。 )

  3. メニュー バーから、Mixed Reality Toolkit -> Add to Scene and Configure を選択します。

    Configure to scene

    インスペクターには現在アクティブな MRTK の設定プロファイルとプロファイル選択のドロップダウンが表示され、デフォルトのプロファイルがあらかじめ選択されています。プロファイルは MRTK のコアコンポーネントの振る舞いを設定します。より詳しくはプロファイルの記事に記載されています。

    Note
    • もし Unity 2019.3 またはそれ以降で Unity の XR SDK を使っている場合、「DefaultXRSDKConfigurationProfile」 を選ぶべきです。このプロファイルは、MRTK の XR SDK のシステムとプロバイダーを必要な箇所に設定しています。
    • HoloLens または HoloLens 2 で始める場合は、「DefaultHoloLens1ConfigurationProfile」または「DefaultHoloLens2ConfigurationProfile」をかわりに選択すべきです。
    • DefaultMixedRealityToolkitConfigurationProfile と DefaultHoloLens2ConfigurationProfile の違いは、プロファイル を参照してください。

    シーンのヒエラルキーに以下が表示されます。

    MRTK Scene Setup

    ヒエラルキーには以下のものが含まれます。

    • Mixed Reality Toolkit - Toolkit それ自身であり、フレームワーク全体に対する中心的な設定のエントリ ポイントを提供します。
    • MixedRealityPlayspace - ヘッドセットの親オブジェクト。ヘッドセット / コントローラー及びその他の必要なシステムがシーンで正しく管理されるようにします。
    • Main Camera は Playspace の子要素として移動されます。- これにより、プレイスペースが SDK と連動してカメラを管理できるようになります。
    Note

    シーンで作業している間、Main Camera や MixedRealityPlayspace を動かさないでください 。これらはそれぞれ、アクティブな SDK と MRTK によって制御されます。Main Camera や MixedRealityPlayspace の transform に行った設定は良くても上書きされ、最悪の場合定義されていない振る舞いにつながります。

    Camera と Playspace という全体のリグは、別の GameObject をシーンに追加し、それを MixedRealityPlayspace の親にすることで動かすことができます。このオブジェクトが移動した場合、Playspace と Camera は アクティブな SDK と MRTK による追加のローカル トランスフォームの変更の影響を受け、緩やかに追従します。

    別の方法は、シーンのコンテンツをカメラから相対的に動かすことです。しかし、Nav Mesh、テライン、パーティクル システムといったコンテンツを組み込んだ高度なシナリオでは問題になることがあります。

    AR/VR のカメラ リグに関するさらなる議論は Unity のドキュメント などで見ることができます。

  4. Play を押して再生し、Space キーを押してハンド シミュレーションでテストします。

これで、デバイスにビルドしてデプロイする準備ができました！ MRTK のビルドとデプロイ の手順に従ってください。

チュートリアルを始める

MRTK、または MR 開発が初めての場合は、MRTK v2 を使った チュートリアルを始める をチェックすることをお勧めします。

MRTK のコアとなるビルディング ブロックについて学ぶ

コアとなるビルディング ブロックについて学ぶには、MRTK 101: How to use Mixed Reality Toolkit Unity for Basic Interactions (HoloLens 2, HoloLens, Windows Mixed Reality, Open VR) をチェックしてください。

HandInteractionExamples のシーンを Unity Editor で実行する

Hand Interaction のサンプル シーン の記事は、MRTK の UX コントロールとインタラクションについて学ぶには最適な場所です。

HandInteractionExample scene

ハンド インタラクション シーンを試すには、以下のステップを実行してください。

  1. Assets/MRTK/Examples/Demos/HandTracking/Scenes/HandInteractionExamples の中の HandInteractionExamples シーンを開きます。

  2. 「TMP Essentials」をインポートするかを尋ねるプロンプトが表示されます。

    TMP Essentials

    このようなプロンプトが表示された場合は、「Import TMP essentials」 ボタンを選択します。「TMP Essentials」とは、Text Mesh プラグインを指し、MRTK のサンプルの一部はテキスト レンダリングを改善するために使用しています。(詳細については、Unity のテキストを参照してください。)

  3. TMP ダイアログを閉じます。この後、シーンをリロードする必要があります。これを行うには、プロジェクト タブでシーンをダブルクリックします。

  4. シーンの乱雑さを抑えるため、Scene ビューの Gizmos タブの 3d Icons のチェックを外すかサイズを小さくします。

    Gizmos

  5. Play ボタンを押します。

Editor 内ハンド入力シミュレーションを使ってシーンをテストする

Editor 内の入力シミュレーション を使って、コントローラー (ハンド、モーション コントローラー)や目などの特定のタイプの入力に対し、バーチャルなオブジェクトの動作をテストすることができます。

シーン内を移動する方法:

  • W/A/S/D キーを使用して、カメラを前後/左右に移動します。
  • Q/E キーを使用して、カメラを上下に動かします。
  • マウスの右ボタンを押したままにして、カメラを回転させます。

手の入力をシミュレートする方法:

  • Space キーを押し続けて、右手を有効にします。
  • Space キーを押しながら、マウスを動かして手を動かします。
  • マウスのスクロールホイールを使用して、手の奥行を調整します。
  • マウスの左ボタンをクリックして、ピンチ ジェスチャをシミュレートします。
  • T/Y キーで、ハンドをビューに固定します。
  • CTRL キーを押しながら、マウスを動かして手を回転させます。

シーンの探索を楽しんでください！ UI コントロールの詳細については、ハンド インタラクションのサンプル ガイド で学ぶことができます。また、入力シミュレーションのドキュメントを読んで、MRTK の Editor 内の手の入力シミュレーションの詳細を確認してください。

おめでとうございます、最初の MRTK のシーンを使うことができました。これであなた自身のエクスペリエンスを創りはじめることができます。

次のステップ

お勧めの次のステップを紹介します。

助けを得る

もし MRTK によって引き起こされた問題にぶつかったり、何かをすることについて質問がある場合は、助けとなるリソースがいくつかあります。

HoloToolkit (HTK/MRTK v1) からアップグレードする

フレームワークが再構築されたため、HoloToolkit から Mixed Reality Toolkit v2 への直接的なアップグレード パスはありません。ただし、MRTK を HoloToolkit プロジェクトにインポートし、実装を移行することは可能です。詳細については、 HTK2017 から MRTK v2 への移植ガイド を参照してください。

Unity の XR SDK を始める

完全な操作手順と情報は、XR SDK getting started guide をご覧ください。