Unreal Engine の Zen Loader | Unreal Engine 5.3 ドキュメンテーション

Zen Loader は Unreal Engine 5(UE5) の新しいランタイムローダーです。Zen Loader は、ステージングフェーズにオフラインで計算した最適化パッケージおよびオブジェクト依存関係グラフを使用することで、CPU オーバーヘッドを減らします。Zen Loader は、ステージングフェーズにオフラインで計算した最適化パッケージおよびオブジェクト依存関係グラフを使用することで、CPU オーバーヘッドを減らします。

.pak ファイルは、頻繁にはアクセスされないルーズファイルに使用します。Pak ファイルがマウントされるとき、対応するコンテナファイルもマウントされます。.utoc ファイルには、チャンクサイズとオフセット、圧縮形式、チャンクが暗号化されているかどうかの情報を含め、コンテナファイルについて記述します。.uca ファイルに実際のデータが含まれます。コンテナファイルを使用すると、ファイルシステムの抽象化がなくなり、I/O Dispatcher という新しい I/O 抽象化レイヤーを使用して、CPU のオーバーヘッドを最小限に抑えて、データチャンクを見つけられるローダーを利用できます。プラットフォーム固有のバックエンドを使用し、ハードウェア機能と API からメリットを引き出します。

Zen Loader を使用する

Unreal Automation Tool(UAT) でステージ処理中に、デフォルトで、コンテナファイルを生成します。これらのコンテナファイルがあると、実行時に Zen Loader をアクティブ化します。

プロジェクトでコマンドを実行する方法の詳細については、「Unreal Automation の概要」を参照してください。

Event Driven Loader (EDL) のランタイムローダーは、非推奨で、将来のリリースから除外されます。ただし、まだ次のコマンドを使用して、ステージ処理中に、UAT とともに使用することができます。

		-SkipIoStore

他の方法として、C:\MyProject\Config\DefaultGame.ini ファイルを開き、[ProjectPackagingSettings] セクションに次の行を追加します。

	[/Script/UnrealEd.ProjectPackagingSettings]
	bUseIoStore=False

bUseIoStore ブーリアンに False 値を設定すると、Zen Loader に IOStore を使用しないように指示します。

制限事項

I/O Dispatcher は新しい I/O 抽象化レイヤーで、チャンク ID で示されるデータをロードします。つまり、I/O API でベースになっている標準ファイル/ディレクトリ形式で、データは検索やロードできません。アセットレジストリは、各ディレクトリでアセットを検索する機能と同等のものをサポートします。 Zen Loader を使用すると、初期のシリアル化が完了した後、インラインデータをロードすることが、バルクデータに対してできなくなります。つまりデータのロードが解除されると、再び取得することができません。頻繁にアクセスすることが必要なデータセットは、クッキングフェーズにインラインではないデータとして格納する必要があります。 Zen Loader はステージ段階で、オブジェクトの依存関係のプリプロセスをオフラインで実行します。これにより、ランタイム時に必須パッケージのリダイレクトが避けられます。コアリダイレクトやデリゲートリゾルバなどのシステムはロード中に無視されます。

コンテナファイルの内容を検証する

次の表では、コンテナファイルと互換性がある、UnrealPak でサポートされたコマンドを示します。

コマンド		説明
-list	コンテナ内のチャンクをリスト表示します。
-diff	2 つのコンテナの内容を比較します。
-extract	コンテナの内容を取得します。
IoStore -describe	コンテナの依存関係、パッケージ、インポートおよびエクスポートに関する詳細情報を示します。describe コマンドは `global.ucas` ファイルへのパスを受け取り、`.uasset` ファイルの PkgInfo コマンドレットと同様の、出力形式を使用します。 `UnrealPak.exe IoStore -Describe=MyProject/Saved/StagedBuilds/Windows/MyProject/Content/Paks/Global.ucas -DumpToFile=Output.txt -CryptoKeys=MyProject/Saved/Cooked/Windows/MyProject/Metadata/Crypto.jsonactive_button_content` UnrealPak.exe IoStore -Describe=MyProject/Saved/StagedBuilds/Windows/MyProject/Content/Paks/Global.ucas -DumpToFile=Output.txt -CryptoKeys=MyProject/Saved/Cooked/Windows/MyProject/Metadata/Crypto.jsonactive_button_content

トラブルシューティング

以下に示すのは便利なトラブルシューティングコマンドで、各ステージでエラーや警告を特定するのに利用できます。

ロード

ロード段階で、Zen Loader は LogStreaming ログチャンネルを使用します。Verbose/VeryVerbose ログ出力は、次のコマンドを使用してコマンドラインで一時的に有効にできます。

	-LogCmds="LogStreaming veryverbose"

大規模プロジェクトでは、ログ出力は大幅に時間がかかることがあります。特定のパッケージでのログをフィルタで選別できます。次のコマンドのとおり選択パッケージ名やパッケージ ID を設定します。

	-s.VerbosePackageNames="/Game/PackageA/Game/PackageB0xABCD1234ABCD1234"

デバッガをアタッチして実行する場合、次のコマンドを使用します。

	-s.DebugPackageNames

指定パッケージの特定のロードフェーズでブレイクポイントを自動で設定できます。

ステージング

ステージングフェーズで、UAT は次のコマンドを使用して、各コンテナに格納されたすべてのパッケージを、指定する (複数の) 応答ファイルのコマンドリストを生成します。

		-ScriptsForProject= "C:\MyProject\MyProject.uproject"

このコマンドと、次のディレクトリパスにある UAT ログファイルに別のものを見つけられます。

		c:Engine\Programs\AutomationTool\Saved\Logs\Log.txt

Zen Loader の内部

Zen Loader は Event Driven Loader(EDL) をベースにしていて、名前テーブル、インポート / エクスポートマップ、プリロード依存関係など、クッカーと同じ出力タイプが必要になります。レガシー EDL ランタイムロジックはオフラインになり、ステージングフェーズで生成されます。

プリプロセスをオフラインで実行する最適化により、ランタイムパッケージの依存関係の追跡にかかる時間が秒単位からミリ秒単位に削減されます。

さらに次の変更があります。

パッケージのサマリ、BLOB、バルクデータおよびシェーダーのエクスポートはコンテナファイルに配置されます。
最も重要なパッケージのメタデータとすべてのパッケージの依存関係は、パッケージ ID のインデックスが付いたパッケージストアに集められます。
.uasset パッケージヘッダは、最適化パッケージサマリに変換されます。
- 他のチェーンがあるインポートマップは除外され、エクスポートオブジェクトハッシュにより直接参照と置き換えられます。
- 名前テーブルには新しい最適化バッチ形式があります。
- プリロード依存関係はパッケージごとのエクスポートバンドルノードに平坦化されます。それぞれでは、CreateExport および SerializeExport コールのシーケンスと他のエクスポートバンドルノードへの依存関係を指定します。

Zen ストア

Zen ストアは実験段階の機能で、クック済みのアセットを、ローカルストレージサーバーのルーズファイルではなくローカルファイルシステムに格納できます。詳細は「Zen ストア」を参照してください。