Unreal Engine で Xcode を使用して iOS プロジェクトをデバッグする | Unreal Engine 5.3 ドキュメンテーション

テストのために iOS、tvOS、および iPadOS デバイスで Unreal Engine (UE) アプリケーションのデバッグビルドを起動するには、Xcode を実行している macOS デバイスが必要です。ただし、ビルドを完全にパッケージ化してファイナライズするには、Unreal Editor でコンテンツをクックする必要があります。これらの要件を満たすには、1 つの手順ですべてをパッケージ化して起動するのではなく、デバッグ用のビルドを準備するための専用ワークフローを使用してから、Xcode に戻ってビルドを起動する必要があります。

このページでは、このワークフローと、UE で提供されているこのプロセスを効率化するためのツールについて説明します。それには、最初にエディタビルドを作成する必要なしにデバッグビルドを起動するためのメソッドも含まれます。

1. 必要な設定

iOS のデバッグワークフローには、次のものが必要です。

Xcode がインストールされている macOS のマシン。macOS と Xcode の両方が iOS の開発要件を満たす最新の状態である必要があります。
アプリケーションの コード署名証明書 と プロビジョニングプロファイル。これらがないと、ビルドを iOS デバイスへデプロイすることができません。このプロセスの詳細については、「iOS プロビジョニング」を参照してください。
アプリケーションの Xcode プロジェクト (.xcodeproj)。Xcode プロジェクトがない場合は、プロジェクトの .uproject ファイルを見つけて右クリックし、[Generate Xcode Project (Xcode プロジェクトを生成)] を選択します。
エディタビルドの作成をスキップする場合、別のコンピュータでクックされたデータを用意してビルドに挿入する必要があります。このデータはプロジェクトの「Binaries/iOS」フォルダか「Binaries/tvOS」フォルダに含める必要があります。

2. ワークフローの概要

iOS、tvOS、iPadOS でのデバッグのワークフローは次のとおりです。

iOS/tvOS 向けにコンテンツをクックします。これは直接 macOS マシンで行うことも、別のコンピュータで行うこともできます。
Prepare for Debugging コマンドを使用して、クック済みのデータをビルド中に作成された Xcode ペイロード (.IPA) に挿入します。
Xcode で .IPA を使用してビルドを作成し、macOS マシンからビルドを起動します。

3. iOS 向けにコンテンツをクックする

Xcode ではデバッグビルドを作成して起動することはできますが、コンテンツをクックすることができません。そのため、別のマシンからクック済みのコンテンツをインポートするか、macOS マシン上で Unreal Editor をビルドしてコンテンツをクックする必要があります。

3A.別のマシンからクック済みのコンテンツをインポートする

すでにビルド用に使用できるクック済みのコンテンツがある場合、Unreal Editor をビルドしてコンテンツをクックする工程をスキップすることができます。これは、チームがビルドリソース (ビルドファームなど) を共有している場合や、ソースコントロールシステムでプロジェクトのバイナリをホストしている場合などが該当します。これらのファイルは「Binaries/iOS」フォルダか「Binaries/tvOS」フォルダに配置する必要があります。

クック済みのファイルを手動でプロジェクトに組み込む必要がある場合、別のマシンの .IPA ファイルをコピーして、プロジェクトの「Binaries/iOS」フォルダまたは「Binaries/tvOS」フォルダにペーストします。

3B.macOS マシンでコンテンツをクックする

macOS マシンでコンテンツをクックするには、次の手順を実行します。

Unreal Editor でプロジェクトを開きます。Unreal Engine のソースビルドを使用している場合は、Xcode からビルドする必要があります。
[Platforms (プラットフォーム)] ドロップダウンから、次のいずれかのオプションを使用します。
- iOS および iPadOS の場合
  - [Platforms] > [iOS] > [Cook Content (コンテンツをクック)]
  - [Platforms] > [iOS] > [Package Project (プロジェクトをパッケージ化)]
- tvOS の場合
  - [Platforms] > [tvOS] > [Cook Content]
  - [Platforms] > [tvOS] > [Package Project]

また、RunUAT.command スクリプトを使用してコマンドラインから BuildCookRun コマンドを実行することもできます。クックのみのコマンドの例を次に示します。

RunUAT.sh BuildCookRun -project=[ProjectName] -platform=iOS -build -cook -stage -pak -package -skipbuild

詳細については、「ビルド作業とコンテンツのクック処理」を参照してください。

4. デバッグを準備する

Prepare for Debugging コマンドを使用すると、以前にクックされたデータが Xcode からビルドに挿入され、Xcode からターゲットデバイスで起動するために使用できる .IPA ファイルが生成されます。これにより、プロジェクトのデバッグパイプラインが次の 2 つの方法で合理化されます。

Prepare for Debugging により、Xcode プロジェクトを再設定する必要なく、自動的にデバッグビルドの作成が処理されます。
Mac の台数が少ないプロジェクトでは、他のマシンからクックされたデータをインポートできます。これにより、Unreal Editor のビルドや使用をスキップして、ビルドを Xcode から起動することが可能になります。

Prepare for Debugging コマンドを使用するには、Unreal Editor の [Platforms] ドロップダウンメニューから実行するか、Unreal Automation Tool (UAT) の Turnkey コマンドライン から実行することができます。どちらのプロセスについても、詳細は後述します。

Prepare for Debugging は、リモート Mac ワークフローと連携するように設計されていて、セカンダリリモート Mac を使用してデバッグすると時間の節約になります。詳細については、「リモート Mac ビルド」を参照してください。

4A.コマンドラインを使用してデバッグを準備する

Turnkey コマンドラインで WrangleContentForDebugging コマンドを使用して、Prepare for Debugging を実行できます。その際、使用するプロジェクトの名前を指定します。このコマンドの形式の例を次に示します。

RunUAT.command Turnkey -command=WrangleContentForDebugging -project=[name of your .uproject file]

4B.プラットフォームのメニューを使用してデバッグを準備する

Unreal Editor で次のオプションのいずれかをクリックして、Prepare for Debugging を実行できます。

[Platforms] > [iOS] > [Prepare for Debugging]
[Platforms] > [tvOS] > [Prepare for Debugging]

The Prepare for Debugging option in the toolbar, under Platforms > iOS

5. Xcode でプロジェクトを起動する

アプリケーションの Xcode プロジェクトを開きます。
ターゲットデバイスを [My Mac] からターゲットの iOS または tvOS デバイスに変更します。
[Product (製品)] > [Perform Action (アクションを実行)] > [Run (実行)] の順にクリックするか、Command キー + R キー のキーボードショートカットを使用します。Prepare for Debugging で作成された .IPA を使用してビルドが作成されます。

これらの手順を完了したら、プロジェクトがビルドされ、デバイスで起動されます。これで、ブレークポイント、ログ、LLDB コマンドを使用してプロジェクトをデバッグし、ランタイム時に情報を調査できます。

6. デバッグ用にプロジェクトを手動でリビルドする

Prepare for Debugging コマンドにアクセスできない場合、次の手順を実行して、手動で Xcode からデバッグ用にプロジェクトをリビルドすることができます。この場合も、このワークフローを使用する前に、プロジェクトをクックしてパッケージ化する必要があります。

アプリケーションの Xcode プロジェクトを開きます。Xcode のメインメニューで [Product] > [Scheme (スキーム)] > [Edit Scheme (スキーム編集)] の順に選択します。
[Run] カテゴリをクリックし、[Build Configuration (ビルドコンフィギュレーション)] を [DebugGame] に変更します。

Unreal Engine のソースコードビルドを使用している場合は、[Debug (デバッグ)] コンフィギュレーションを使用してエンジンコードをデバッグできます。
ターゲットデバイスを [My Mac] から接続している iPhone に変更します。
[Build and Run (ビルドして実行)] ボタンをクリックして Xcode でプロジェクトのビルドを開始し、デバイスで起動します。