[UE4] シングルパックファイル内のアセットリストを取得する

検証バージョン:UE4.26

背景

　ゲームを開発する際にテクスチャ、マップ、アニメーションなど様々なアセットが登場しますが、ゲームで使用するアセットを1つのかたまりにまとめておくことがあります。例えば、ステージ(マップ)のアセットにはオブジェクトやエフェクトなどの配置物がありますが、それらはレベルとメッシュやパーティクルから構成されます。このように1つアセットに紐づくようなケースや、1つのグループとして管理したい場合には「チャンク」というものを利用します。エディタ上ではあまり意識することはありませんが、実際にゲームをダウンロードする場合などにはチャンク単位で分けておくと様々な面で有利です。この詳細については以下のドキュメントにもあります。

[公式ドキュメント] クック処理とチャンク化

　もう少し分かりやすく図示したものが以下の図です。例えば「ダウンロードコンテンツとして新しいステージを追加したい」ような場合においては、追加するステージに紐づくアセットをチャンクで1まとまりにしておくとよいです。

　チャンクはPrimaryAssetLabelを使用して管理し、設定した内容がどのようにチャンク毎に格納されるかはEditorのAssetAuditを使用しても確認することができます。以下の図ではチャンクID毎にPrimaryAssetLabelとマップがきちんと分離されていることを確認できます。

　そしてPrimaryAssetLabelでどのアセットがどのチャンクになるかを指定していたら、チャンク毎に.pakファイルという1つの塊ファイルが作成されます。ShooterGameのサンプルは最初からPrimaryAssetLabelが設定してあるので、プロジェクト設定でGenerateChunksを有効にしてパッケージを作成すると、チャンク毎に.pakファイルが作成されます。

チャンクに設定したアセットは.pakファイルになりますが、パッケージの以下の工程で作成されます。
[UE4] ビルドプロセスの流れ の内容を参照。

チャンク毎にきちんと格納されている？

　何も特別な設定をしていなければPrimaryAssetLabelで設定したチャンクIDに従ってアセットは.pakファイルに格納されますが、PrimaryAssetLabelでの設定が正しくなかったり、以下の内容のようなパッケージまでの過程において.pakファイルに含めたいアセットを追加したり除外できるので、結局のところ作成された.pakの中身を見てみないことには正確な状態はわかりません。

[UE4] アセットの追加/除外する設定と機能

シングルパックファイルのアセットを確認

そこで正しくチャンク毎にアセットが格納されているかを調べる方法を以下に示します。これを利用することによって、.pakファイルに格納されているアセット一覧を出力して、想定されたアセットが想定されたチャンクに含まれているかを確認することができます。

.pakファイル使用時 (IOStore=OFF)

以下の内容をバッチファイルにして環境ごとに併せた内容に編集することで、格納されたアセットリストを.csvとして出力できます。

IOStore有効時[.pakファイル用]

rem @ UnrealPak.exe のパス
set UNREALPAK_PATH=D:\Release-4.26\Engine\Binaries\Win64\UnrealPak.exe
rem @ .pak のパス
set PAK_PATH=D:\MyProject\Saved\StagedBuilds\WindowsNoEditor\MyProject\Content\Paks\MyProject-WindowsNoEditor.pak
rem @ アセットリストの出力先
set CSV_PATH=D:\Batch\List\MyProject-pak.csv

%UNREALPAK_PATH% %PAK_PATH% -list -csv=%CSV_PATH%

出力された結果は以下のように出力されます。

.utocファイル使用時 (IOStore=ON)

UE4.25から入ったIOStoreの機能を利用する場合はアセットを格納する先が変わるので、異なる方法で確認します。
やり方は殆ど同じですが、以下の内容をバッチファイルにして環境に併せて内容に編集しアセットリストを.csvとして出力できます。

IOStore有効時[.utocファイル用]

rem @ UE4Editor-Cmd.exe のパス
set CMDEXE_PATH=D:\Release-4.26\Engine\Binaries\Win64\UE4Editor-Cmd.exe
rem @ .utoc のパス
set UTOC_PATH=D:\MyProject\Saved\StagedBuilds\WindowsNoEditor\MyProject\Content\Paks\MyProject-WindowsNoEditor.utoc
rem @ アセットリストの出力先
set CSV_PATH=D:\Batch\List\MyProject-utoc.csv

%CMDEXE_PATH% -run=IOStore -list=%UTOC_PATH% -csv=%CSV_PATH%

出力された結果は以下のように出力されます。

注意点

このような方法でアセットリストが取得できるのですが、通常は.pakを暗号化してからリリースするので解析できないようになっています。そのため暗号化済の.pakファイルは出力しようとしてもクラッシュして見れないようになっています。逆に.pakファイルは暗号化することが必須です。

.csvファイルが出力されない時

暗号化されている、.pakまでのパスが異なる、エンジンバージョンが異なるなど、上記のコマンドが失敗するケースは様々あります。もしそのような場合はコマンドプロンプトからバッチファイルを実行したり、バッチファイル実行時にpauseを追加して、出力されるコールスタックを確認してみましょう。