Unreal Engine でのビルド作業：プロジェクトのクック、パッケージ化、デプロイ、実行 | Unreal Engine 5.1 ドキュメンテーション

Unreal Engine (UE) プロジェクトを操作するための一連のユーティリティスクリプトを利用するために、パッケージ化プロセスの一環として Automation ツール ( Unreal Automation Tool または UAT とも呼ばれます) が使用されます。Automation ツールでは、パッケージ化に BuildCookRun と呼ばれる特定のコマンドを使用します。このコマンドは、プラットフォーム向けにコンテンツをクックして、配布用にプラットフォームのネイティブ形式にパッケージ化し、デバイスにデプロイして、(可能な場合は) プロジェクトを自動的に実行します。ただし、プロジェクトのパッケージ化は UAT だけが行えるわけではなく、UE ツールバー の [Platforms (プラットフォーム)] ボタンを使って利用可能なプラットフォームを選択したり、コマンドラインで特定のプラットフォーム向けにコンテンツをクックおよびパッケージ化したりすることもできます。

UAT の BuildCookRun コマンドの一環として、以下で説明するさまざまなステージがパッケージ化パイプラインに存在します。

ビルド： 選択したプラットフォーム向けに実行可能ファイルをコンパイルします。
クック： UE を特殊なモードで実行することでコンテンツをクックします。
ステージ： 実行可能ファイルとコンテンツをステージング領域 (開発ディレクトリ外のスタンドアローンのディレクトリ) にコピーします。
パッケージ化： プロジェクトをプラットフォームのネイティブ配布形式にパッケージ化します。
デプロイ： ビルドをターゲットデバイスにデプロイします。
実行： パッケージ化されたプロジェクトをターゲットプラットフォームで開始します。

事前定義されたタスクのリストについては、「BuildGraph スクリプトタスク」リファレンスページを参照してください。

パッケージ化の方法

コンテンツをターゲットプラットフォームにさまざまな方法でデプロイして、テスティングやデバッグ、製品リリースに向けた準備をすることができるため、パッケージのテストには以下のさまざまな方法を使用できます。

UE ツールバーを使って、テスティングとデバッグのために、現在ロードしている レベル を部分的にすばやくテストする。
プロジェクトランチャーでデフォルトプロファイルを使用するか、カスタム仕様のものを作成して、プロジェクトの最新ビルドのプロファイリングやデバッグを実行する。
すでにパッケージ化済みのゲームを、コンソールやモバイルデバイスなどのプラットフォームにデプロイする。

以下のセクションでは、上記のパッケージ化の方法の詳細と、これらの方法を使ってゲームをパッケージ化する方法について説明します。

UE ツールバー

UE ツールバー の [Platforms (プラットフォーム)] ボタンを使って、プロジェクトをパッケージ化するプラットフォームを選択します。このオプションを使ってプロジェクトをパッケージ化すると、パッケージ化されたプロジェクトが選択したフォルダに保存されますが、デバイスにはデプロイされません。

[Platforms] ドロップダウンメニューから、以下のアクションを実行できます。

利用可能なデバイス上でプロジェクトをビルドして起動する。クリックすると、起動プロセスによって必要なコンテンツが自動的にクックされてコードがビルドされ、選択したプラットフォームで起動します。このビルドは開発中に機能をテストする迅速な方法であり、何かをテストするたびにプロジェクト全体をコンパイルして実行する必要はありません。
ターゲットプラットフォームを選択してその [Build Configuration (ビルドコンフィギュレーション)] ( [Development (開発)] や [Shipping (出荷)] など) を調整する。
[Project Launcher (プロジェクトランチャー)]、[Device Manager (デバイスマネージャー)]、[Packaging Settings (パッケージング設定)]、[Supported Platforms (対応プラットフォーム)] にアクセスする。

デプロイしたプラットフォームが表示されない場合や、メニューでグレーアウトされている場合は、次の点を確認してください。

当該のプラットフォームに対して正しい SDK がインストールされていること (必要な場合) と、現在使用しているエンジンのバージョンがサポートされていること。ほとんどの場合は、「Engine/Source/Programmings/UnrealBuiltTools/Platforms」にあるプラットフォームの「UEBuild.cs」ファイルで確認できます。たとえば、Android でサポートされている SDK のバージョンを調べるには、「UEBuildAndroid.cs」ファイルを確認します。
必要な Visual Studio 拡張機能またはファイルがインストールされていること。
デバイスの接続に外部ツールが必要な場合 (コンソールなど) は、外部ツールが適切に動作してデバイスが検出されること。
エンジンの デバイスマネージャー を使って必要なデバイスを「要求」すること。これにより、そのデバイスがローカルマシンのみで使用可能になることが確実になります。

プロジェクトランチャー

プロジェクトランチャーでは、一つの場所または単一の起動プロファイルから、さまざまなプラットフォームに向けてデプロイすることができます。プロジェクトランチャーを起動するには、[Platforms] > [Project Launcher] をクリックします。

デプロイ先となるプラットフォームには、それぞれ独自のデフォルト起動プロファイル (メインウィンドウに表示されます) が備わっています。カスタム仕様の起動プロファイルを作成することもできます。これにより、さまざまな詳細設定を使用して、特定の方法でプロジェクトをビルドできるようになります。これには、コマンドライン引数の適用や、ダウンロード可能なコンテンツ (DLC) およびパッチリリースのテストなどがあります。

詳細については、「プロジェクトランチャー」リファレンスページを参照してください。

カスタム仕様の起動プロファイル

プロジェクトランチャーでは、すべてのプラットフォームまたは特定のプラットフォームで使用可能な カスタム仕様の起動プロファイル を作成できます。カスタム仕様のプロファイルを使用することで、実行可能なビルド操作を使ったクック、パッケージ化、デプロイの方法を設定して、コンテンツを特定の方法でビルドすることができます。

独自のカスタム仕様の起動プロファイルを追加するには、ウィンドウの右側にある [+ Add (+ 追加)] ボタンをクリックします。

ボタンをクリックすると、カスタム仕様の起動プロファイルがすぐに開きます。後で見つけやすいように、名前と説明を加えます。

コマンドライン

Automation ツールを使用すると、コマンドラインを使ってゲームをクックおよびパッケージ化することができます。すべてのビルド操作は UAT で実行されるので、「RunUAT.bat」ファイルを使って、UAT を有効な引数とともにコマンドラインで直接実行することができます。

RunUAT ファイルは「Engine/Build/BatchFiles」にあります。Windows には「RunUAT.bat」ファイル、Mac/Linux には「RunUAT.sh」を使用します。

基本的なクックは、「UnrealEditor.exe」または「UnrealEditor-cmd.exe」ファイルのいずれかの後に以下のコマンドラインを加えることで実行できます。

	UnrealEditor.exe [GameName or .uproject] -run=cook -targetplatform=[Platform] -cookonthefly -iterate -map=[Map Name]

コマンドレットは -run=cook で指定する必要があります。また、クック対象のプラットフォームも指定する必要があります。これで、指定したプラットフォーム向けにクックされたデータが生成されて、以下の場所に保存されます。

	[UnrealEditor Project]/Saved/Sandboxes/Cooked-[Platform]

手動でのコマンドライン引数の指定は複雑になりがちで、誤ってエラーを起こす可能性も高くなります。そのため、カスタム仕様の起動プロファイルを使ってビルド用のコマンドラインを正確に生成することを推奨します。カスタム仕様の起動プロファイルに入力したパラメータによってコマンドラインが自動的に生成されて、プロジェクトのクックおよびビルドで使用される際に [Output Log (アウトプットログ)] ウィンドウに表示されます。BuildCookRun に続くテキストは、「RunUAT.bat」を使ってコマンドライン引数として直接パスすることができます。

以下は、プロジェクトランチャーで生成された出力と、「RunUAT.bat」で使用するために手動で作成した同等のコマンドラインから生成された出力の例です。

プロジェクトランチャーのログウィンドウ
```
              Automation.ParseCommandLine: Parsing Command Line: -ScriptsForProject=MyProject.uproject BuildCookRun -project=MyProject.uproject -clientconfig=Development
```
Automation.ParseCommandLine: Parsing Command Line: -ScriptsForProject=MyProject.uproject BuildCookRun -project=MyProject.uproject -clientconfig=Development

手動での作成

              [UnrealEngineRoot]/Engine/Build/BatchFiles/RunUAT.bat BuildCookRun -project=MyProject.uproject -clientconfig=Development

詳細については「コンテンツのクック処理」ページを参照してください。

コンテンツのクック

UE では、コンテンツはサポートされている特定の形式 (テクスチャデータは PNG、オーディオは WAV など) で格納されますが、このコンテンツが目的のターゲットプラットフォームで使用可能な形式であるとは限りません。クック とは、UE で使用していた アセット を、デプロイ対象のプラットフォーム上で読み取り可能なアセットに変換する処理を指します。場合によっては、クックされたコンテンツが、特定のプラットフォームのみで読み取り可能な独自のプロプライエタリ形式に変換されることがあります。

さまざまなプラットフォームに向けてコンテンツをクックするには、コマンドラインを使用するか、プロジェクトランチャーとその UE インターフェースを使用します。プラットフォームによっては、コンテンツをデバイス上で正しく機能させるために、すべてのコンテンツを事前にクックしておく必要があります。このような場合は、対象のプラットフォームについて確認する必要があります。

プロジェクトのコンテンツは、By the book (バイザブック) と On the fly (オンザフライ) という 2 つの方法でクックできます。

By the Book によるクック

By the book によるクック (CBTB) では、クックプロセス全体を事前に実行して、レベルをプレイしながら (クックサーバーを使用している場合)、クック済みのアセットを必要に応じてではなく、すべて一度にビルドでデプロイすることができます。これは、個々のアセット上で反復作業を行わないデベロッパーや、必要なクック済みのコンテンツがサーバーから配信されるのを待たずに、ゲームをフルスピードで実行したいと考えるデベロッパーに便利なオプションです。通常、この方法はパフォーマンステスティングとプレイテストで使用されます。

CBTB を実行する場合は、ビルドに追加の設定を行う必要ありません。プロジェクトランチャーを使ってカスタム仕様の起動プロファイルを作成し、[Cook (クック)] セクションのドロップダウンメニューで [By the book (バイザブック)] を選択します。

ゲーム固有のコマンドラインを追加するには、[Advanced Settings (詳細設定)] を展開して、その引数を [Additional Cooker Options (追加のクッカオプション)] に追加します。

次に例を示します。

	-nomcp

このクック方法と利用可能な設定の詳細については、「プロジェクトランチャー」リファレンスページを参照してください。

On the Fly によるクック

On the fly によるクック (COTF) を選んだ場合は、ゲームがプラットフォームにデプロイされてからコンテンツがクックされます。実行ファイルとその他の基本ファイルのみがインストールされ、コンテンツが必要になると、それらが クックサーバー とのネットワーク通信を使ってオンデマンドリクエストを行います。COTF を使用することで、定期的にコンテンツを変更したり、ゲームの一部のみを検証したりするデベロッパーは、反復作業をより迅速に行うことができるようになります。

On the fly でクックするには、まずプロジェクト全体にアクセス可能なマシン上でクックサーバーを起動する必要があります。これは、クックを実行するローカルマシンかリモートサーバーのいずれかになります。クックサーバーは、以下の引数を「UnrealEditor-cmd.exe」とともに使用して、UE をコマンドラインモードで起動することで実行できます。

		UnrialEditor-cmd.exe [FullAbsolutePathToProject.uproject]-run=cook -targetplatform=Windows -cookonthefly

デベロッパーのローカルマシンで、プロジェクトランチャーからカスタム仕様の起動プロファイルにアクセスし、その [Deploy (デプロイ)] セクションでデプロイ方法を [File Server (ファイルサーバー)] に設定します。任意で、[Default Deploy Platform (デフォルトのデプロイプラットフォーム)] を使って単一のプラットフォームを選択したり、各トグルを使って複数のプラットフォームにビルドおよびデプロイしたりすることもできます。

実行可能ファイルでコンテンツのロード元を特定できるようにするには、クックサーバーを実行するマシンの IP アドレスをそのファイルに知らせる必要があります。そのためには、以下のコマンドライン引数をクライアントのコマンドライン上でパスする必要があります ( x.x.x.x はホストの IP)。

	-filehostip=123.456.78.90

この引数は、カスタム仕様の起動プロファイルの [Launch (起動)] セクションにある [Additional Command Line Parameters (追加コマンドラインパラメータ)] テキストボックスで指定できます。IP アドレスを未指定のままにすると、ビルドは既存のローカルファイルからロードして、クックサーバーには接続しようとしません。