Androidモバイル向けビルド＆テスト

Build and Test機能を使用すれば、VRChatのワールドやアバターを公開せずにAndroid端末でテストできます。本ドキュメントでは、この機能を設定し、ワールドやアバターをより迅速にビルドする方法を解説します。

ビルド＆テストの準備

Androidモバイル向けビルド＆テストを使用するには、Unity Androidツール、プロジェクト、およびデバイスのセットアップが必要です。

Unity Androidツールのセットアップ

そもそもAndroid向けコンテンツを扱うには、VRChat対応のUnityエディタにAndroid Build Supportモジュールがインストールされている必要があります。VRChat Creator Companionでデフォルトでインストールされるため、すでに導入済みの場合もあります。以下の手順で確認してください。

1. Unity Hubを開き、左側の「インストール」に移動します。
2. プロジェクトで使用しているUnityバージョンのインストール項目を探します（現在推奨されているバージョンは2022.3.22f1です）。エディタパスの下に「Android」と表示されていればモジュールはインストール済みですので、プロジェクトのセットアップに進んでください。表示されていない場合は、以下の手順へ進んでください。

3. インストール項目の横にある歯車アイコンをクリックし、「Add modules」をクリックします。
4. 「Android Build Support」を見つけ、その横のチェックボックスにチェックを入れます。
5. 「Continue」をクリックして、Androidビルドサポートモジュールのインストールを進めます。

これでAndroid向けのコンテンツをビルドできるようになります。

プロジェクトのターゲットをAndroidに設定する

「VRChat SDK」→「Show Control Panel」を選択してSDKパネルを開き、「Builder」タブを選択します。

「Select Platform」セクションを見つけ、プラットフォームを「Android」に変更します。

テスト用Androidデバイスのセットアップ

「Build and Test for Mobile」では、ビルドしたアセットバンドルファイルをAndroidデバイスに転送するためにAndroid Debug Bridge (ADB) を使用します。

ADBは、Androidデバイス上の「USBデバッグ」を使用してデバイスと通信します。これにより、ADBはファイルの送信やアプリの起動など、その他多くのデバッグ関連機能を利用できるようになります。

USBデバッグを有効にするには、デバイスで「開発者向けオプション」を有効にする必要があります。

📱 Androidスマートフォンおよびタブレットでの開発者モードの有効化

Androidスマートフォンまたはタブレットで開発者モードを有効にするには、以下の手順を行ってください。

1. データ転送に対応したUSBケーブルを使用して、スマートフォンをコンピューターに接続してください。
2. 「設定」→「デバイス情報（または端末情報）」へ進み、一番下までスクロールして「ビルド番号」を探します。ビルド番号を7回連続でタップすると、開発者モードが有効になります。
3. 開発者モードを有効にすると、詳細な開発者向けオプションが表示されるようになります。「設定」→「システム」→「開発者向けオプション」へ進み、「USBデバッグ」のチェックボックスを探して有効にしてください。

🥽 Meta Questヘッドセットでの開発者モードの有効化

Meta Questデバイスでビルドやテストを行うには、開発者モードを有効にし、USBデバッグを許可する必要があります。

Meta Questヘッドセットを開発者モードに切り替えるには、Meta Quest Developer Hubを使用する必要があります。

ヘッドセットで開発者モードをセットアップする方法については、Metaのガイドを参照してください。

Build and Testの使用

開発者モードとUSBデバッグを有効にし、Androidデバイスを接続した状態で、ビルドとテストができるようになります。

初回起動

アバターとワールドの両方をAndroidデバイスでテストできます。プロセスはほとんど同じです。

アバター

Androidで新しいアバターをテストするには、まず上記の「USBデバッグを有効にする手順」に従う必要があります。

USBデバッグのセットアップが完了したら、VRChatアプリを起動してインスタンスに入ります。その後、SDK内の「Build and Test New Build」ボタンをクリックしてください。

アバターはメインメニューの「アバター」セクションにある「SDK Test Avatars」タブ内に表示されます。

テストアバターを使用する場合、ビルドしてテストするたびに自動的に最新バージョンへ切り替わります。

ワールド

ワールドのテストにはいくつかの追加要件があります。

• ワールドのテストを試みる前に、少なくとも一度はアプリを起動してアプリのディレクトリが生成されるようにしてから、VRChatを終了してください。表示されていない場合は、以下の手順へ進んでください。
• 初めてテストワールドを起動する前に、VRChatアプリケーションを終了しておく必要があります。
• ADBがVRChatアプリを起動してテストワールドへ接続できるように、Androidデバイスのロックを解除した状態にしておく必要があります。

上記の設定がすべて完了し、プロジェクトがAndroidモードになっている状態で、「Build and Test New Build」ボタンを押してデバイス上でワールドをテストします。

ワールドのビルド後、自動的にVRChatアプリが起動するはずです。アプリにまだログインしていない場合は、ログイン画面に直接遷移します。ログイン後、テストワールドへ直接移動します。

すでにログイン済みの場合は、クライアントの読み込み完了後にテストワールドへ直接移動するはずです。画面下部の再生ボタンがクライアントの読み込み状況を示しており、読み込みが完了すると少しの間をおいてワールドへ移動します。

ワールドに変更を加える際は、再度「Build and Test New Build」を押してください。ワールドが再ビルドされて端末に送信され、追加の操作なしで再読み込みされます。

ツールとトラブルシューティング

このセクションでは、よくある問題の解決方法や、モバイル開発に役立つツールについて説明します。

トラブルシューティング

他の目的でデバッグモードを使用する開発者の場合は、ビルドとテストを行う対象のAndroid端末以外のすべての端末で、USBデバッグを無効にするか、ケーブルを抜いてください。

Androidのスマートフォンやタブレットで、USBデバッグが有効になっているにもかかわらず、コンピュータ側で端末が認識されない場合は、USBデバッグのプロセスを一度完全にやり直すのが最も有効な解決策です。

1. Android端末をコンピュータから取り外します。
2. 開発者向けオプションとUSBデバッグを無効にします。
3. Android端末をコンピュータに接続します。
4. 「デバイス情報」（または「電話情報」）から「ビルド番号」を7回タップして、開発者向けオプションを有効にします。
5. 「設定」→「システム」→「開発者向けオプション」でUSBデバッグを有効にします。
6. 再度「Build and Test」を試してください。

何らかの理由でVRChatアプリのパッケージ名が com.vrchat.mobile.playstore ではない場合、プロジェクト設定でSDKが参照するパッケージ名を変更できます。この設定は「VRChat」->「SDK」->「Android App Package Name」から行えます。

この設定は、VRChatアプリのベータ版ビルドでビルドやテストを行う場合や、何らかの理由でGoogle Playストアのライブバージョンを使用していない場合に役立ちます。特に変更する理由がない限り、com.vrchat.mobile.playstore のままにしてください。

便利なデバイスミラーリングツール

その都度スマートフォンに目を向けるのではなく、デスクトップ上のウィンドウからスマートフォンを確認したい場合があるかもしれません。これには、オープンソースの便利なツールである scrcpy を使用するのがおすすめです。

scrcpy はADBを利用して、デバイスの画面キャプチャをデスクトップ上の小さなウィンドウに表示します。これを使用すれば、スマートフォンを直接操作する代わりに、マウスを使って操作することができます。

本ツールを使用するには、プラットフォームに合わせた最新のリリースをダウンロードしてください（例：Windowsの場合は scrcpy-win64 zipファイルをダウンロードします）。これにより、scrcpy.exeの実行に必要なすべてのファイルが含まれたzipフォルダーが取得できます。これを任意の場所に解凍してください。

scrcpy.exeは、ダブルクリックするか、そのフォルダー内でコマンドプロンプトからscrcpy.exeを実行することで起動できます。USBデバッグの設定が正しく完了していれば、デバイスの画面がミラーリングされたウィンドウが表示されます。

ADBはロック画面を記録できないため、ロック解除を試みている間、プレビューウィンドウは真っ暗になります。物理的にスマートフォンのロックを解除すれば、そのままミラーウィンドウを通して操作を継続できます。

また、Unityを起動した後にscrcpyを起動することを推奨します。これは、ADBサーバーが起動していない場合にscrcpyが独自のADBサーバーを立ち上げるためです。Unityは起動時に既存のADBサーバーを終了させる仕様となっており、その際にデバイスのミラーウィンドウが閉じてしまうためです。

「設定」→「システム」→「開発者向けオプション」にある「スリープモードにしない（Stay Awake）」を有効にすると便利です。これを有効にすると、デバイスの画面がロックされないよう定期的にタップする必要がなくなります。充電中にデバイスが接続されている間は、常にスリープ状態にならなくなります。

Wi-Fi経由でのビルドとテスト

ワイヤレスでビルドとテストを行うことも可能です。環境によっては便利ですが、接続のためにコマンドラインでの操作が必要となるため、基本的にはUSBデバッグの使用をお勧めします。

ワイヤレスデバッグを有効にするには、コマンドラインから直接ADBを操作する必要があります。

1. まず、ADBがUnityのADBサーバープロセスを使用するように、Unityを開いておいてください。
2. プロジェクトで使用しているUnityバージョンのインストールフォルダに移動します。
   • Unity Hubを開き、左側の「インストール（Installs）」をクリックし、該当するバージョンの横にある歯車アイコンをクリックして「エクスプローラーで表示（Show in Explorer）」を選択することで確認できます。
   • adb.exeは、Data/PlaybackEngines/AndroidPlayer/SDK/platform-tools内にあります。
   • コマンドプロンプトを起動し、cd [your unity install path]/Data/PlaybackEngines/AndroidPlayer/SDK/platform-toolsを使用してそのフォルダに移動し、コマンドプロンプトを開いてください。

これでADBコマンドが使用できるようになりました。USBデバッグが有効になっているか確認するには、adb devices -lというコマンドを実行するのが便利です。デバッグが有効になっているデバイスがすべて一覧表示されるはずです。また、adb shell lsを実行してデバイスのトップレベルのフォルダを表示してみることもできます。これらを実行するには、いずれもデバッグが有効である必要があります。

ADBの場所が特定できたところで、便利なWi-Fiデバッグについても見ていきましょう。

1. USBデバッグを無効にし、念のためデバイスを接続から外しておきます。
2. 「設定」→「システム」→「開発者向けオプション」で「ワイヤレスデバッグ」を有効にします。
3. 「ワイヤレスデバッグ」をタップして詳細オプションを開きます。
4. 「デバイスとペア設定する（ペア設定コード）」をタップすると、ペアリング用の6桁のコード、および使用するIPアドレスとポート番号が表示されます。
5. adb pair [ip]:[port]を実行します。
   • 例：ペアリング画面にIPアドレス127.0.0.1、ポート1234と表示されていた場合、adb pair 127.0.0.1:1234と入力します。
   • ポート番号は毎回ランダムに変更されるため、Wi-Fi経由でデバッグを行うたびにこの手順に戻る必要がある点に注意してください。
6. 求められたらペアリングコードを入力してください。
7. 次に、adb connect [ip]:[port] と入力してデバイスに接続します。

これでWi-Fi経由でADBを使用できるようになっているはずです。

adb devices -l を実行して動作を確認してください。デバイス一覧に自分のデバイスが表示されていれば成功です。

これでSDKに戻り、「Build & Test New Build」をクリックしてWi-Fi経由でコンテンツをテストできます。