Installed Build のリファレンス

Installed Build のスクリプトの書き方をはじめ、Installed Build プロセスについて説明します。

Windows
MacOS
Linux

デベロッパーは多様なハードウェア プロファイルとオペレーション システム向けにビルド ソリューションを効率的に提供する方法を常に求めています。 Installed Build は十分な機能を備えたエンジンのビルドであり、チームでエンジンをすぐに使えるように再配布することができます。 技術的な観点から、Installed ビルドには Unreal Editor のプリコンパイルされたバイナリと開発中の各ターゲット プラットフォームの静的ライブラリ、 シッピングのコンフィギュレーションが含まれます。

Installed Build プロセスは、UE4 を Installed Build バージョンにするために必要なパッケージやツールのビルドを自動化します。つまり、 Installed Build を作るということは、デフォルトのターゲット プラットフォームを設定し、 UE4 をツール、エディタと共にコンパイルし、テストを実行し、ターゲット プラットフォーム向けに UE4 の Installed Build バージョンをデプロイするというプロセスです。

Installed Build を作成する

BuildGraph スクリプティング システムで [UE4Root]/Engine/Build/InstalledBuild.xml を使って Installed Build を作成することができます。

Installed Build の作成手順

  1. Installed Build スクリプトを以下のコマンドラインで AutomationTool を呼び出して実行します。 [PLATFORM]Win64 または Mac で置き換えます。利用可能な Installed Build Script Options を使ってビルドを設定することもできます。

    BuildGraph -target="Make Installed Build [PLATFORM]" -script=Engine/Build/InstalledEngineBuild.xml -clean
  2. Unreal Engine ディレクトリの LocalBuilds/Engine/ フォルダに進み作成した Installed Build を表示します。パブリッシュ先として別のディレクトリを指定した場合は、代わりにそのディレクトリに進んでください。

Installed Build スクリプトのオプション

InstalledEngineBuild.xml スクリプトは、Installed Build のすべてのデフォルト オプションとプラットフォームを有効にします。ただし、これは オプション一式を指定し、どのプラットフォームを対象にするかを有効にし、ビルドをどこにパブリッシュするかなどを設定します。このビルド プロセスのカスタマイズに使えるオプション リスト (ビルドされるノートのリストも併せて) をご覧になりたい場合は、 -listonly オプションをスクリプトに渡します。

以下は利用可能なオプションです。

オプション

デフォルト

説明

-set:HostPlatformOnly=[true/false]

false

インストールしたビルドをホスト プラットフォームのみを対象にするヘルパー オプションです。各プラットフォームを個別に無効にする必要がなくなります。

-set:WithWin64=[true/false]

true

Win64 ターゲット プラットフォームを含みます。

-set:WithWin32=[true/false]

true

Win32 ターゲット プラットフォームを含みます。

-set:WithMac=[true/false]

true

Mac ターゲット プラットフォームを含みます。

-set:WithAndroid=[true/false]

true

Android ターゲット プラットフォームを含みます。

-set:WithIOS=[true/false]

true

iOS ターゲット プラットフォームを含みます。

このオプションを有効にすると、リモート ビルド用に Mac を設定する必要があります。

-set:WithTVOS=[true/false]

true

tvOS ターゲット プラットフォームを含みます。

このオプションを有効にすると、リモート ビルド用に Mac を設定する必要があります。

-set:WithLinux=[true/false]

true

Linux ターゲット プラットフォームを含みます。

-set:WithLumin=[true/false]

true

Lumin ターゲット プラットフォームを含みます。

-set:WithHTML5=[true/false]

true

HTML5 ターゲット プラットフォームを含みます。

-set:WithPS4=[true/false]

false

PS4 ターゲット プラットフォームを含みます。

このオプションを有効にするには、PS4 SDK が必要です。

-set:WithXboxOne=[true/false]

false

XboxOne ターゲット プラットフォームを含みます。

このオプションを有効にするには Xbox One SDK が必要です。

-set:WithDDC=[true/false]

true

エンジンのコンテンツとテンプレート用にスタンドアロンの派生データ キャッシュをビルドします。

エンジンとテンプレートのコンテンツ用のスタンドアロンの 派生データ キャッシュ (DDC) ビルドは、処理に時間がかかります。スタンドアロンの DDC が不要な場合は、コマンドラインに -set:WithDDC=false を追加することでこのステップをスキップできます。

-set:WithFullDebugInfo=[true/false]

false

バイナリ エディタとパッケージ化されたアプリケーションのビルドに対してフル デバッグ情報を生成します。

-set:SignExecutables=[true/false]

false

ビルド プロセスの一部として実行ファイルに署名するようにマシンをセットアップしなければならない場合は、署名します。

-set:AnalyticsTypeOverride=[ID]

N/A

送信する分析イベントの識別子です。

-set:GameConfigurations=[Configurations]

Development;Shipping

パッケージ化されたアプリケーションのコンフィギュレーションを指定します。

追加ファイルをインクルードする

RuntimeDependencies (各モジュールの build.cs ファイルで設定) は自動的に照合し、どのファイルが Installed Build に含まれているかを判断します。 ただし、このやり方では必要であってもインクルードできないファイルがいくつかあります。そのため、こうしたファイルは [UE4Root]/Engine/Build/InstalledEngineFilters.xml で定義されます。 InstalledEngineFilters XML ファイルは、ビルドから除外すべきファイルのパターンを一覧表示し、削除または署名する必要があるファイルのタイプを決めます。 最後にどのプロジェクトに DDC をビルドするかを決めます。Installed Buildにさらにファイルを追加する必要があれば、 `InstalledEngineFilters`XML ファイルから始めるとよいでしょう。

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback