Unreal Engine でのコンテナイメージの使用についてのクイックスタートガイド | Unreal Engine 5.4 ドキュメンテーション

コンテナクイックスタートガイドでは、Unreal Engine の公式コンテナイメージにアクセスし、それらを使用して単純なコンテナを実行する方法を説明します。このガイドでは、次の手順について説明します。

コンピュータに Docker をインストールします。
GitHub Container Registry にログインして、Docker を使用してビルド済みの Unreal Engine コンテナイメージをダウンロードできるようにします。
Unreal Engine 用にビルド済みの Linux 開発コンテナイメージをダウンロードします。
開発イメージを使用してコンテナを開始します。
コンテナ内にプロジェクトをビルドしてパッケージ化します。

1. 要件

このクイックスタートガイドで Unreal Engine コンテナイメージを実行するには、コンピュータが「ハードウェアおよびソフトウェア要件」ページの Linux コンテナセクションのリストにあるハードウェアとソフトウェアの要件を満たしている必要があります。

2. GitHub へのアクセスを確認する

GitHub の https://github.com/EpicGames/UnrealEngine の Unreal Engine ソースコードリポジトリにアクセスできることを確認します。リポジトリにアクセスできない場合は、GitHub アカウントを Epic Games アカウントにリンクする必要があります。

3. Docker をインストールする

Unreal Engine に含まれているコンテナイメージをビルドおよび実行するには、Docker がおすすめです。Docker をインストールする手順は、使用しているオペレーティングシステムによって異なります。以下のリンクでは、利用可能な各プラットフォームでインストールを行う方法について説明しています。

Windows:Docker Desktop for Windows をインストールする
macOS:Docker Desktop for Mac をインストールする
Linux: 適切な手順に従って、特定の Linux ディストリビューション用の Docker Engine をインストールします。

4. GitHub Container Registry で認証する

Docker を使用して GitHub Container Registry からコンテナイメージをダウンロードするには、個人用アクセストークンを使用して認証する必要があります。read:packages スコープのパーソナルアクセストークンをまだ持っていない場合は、手順に従ってトークンを作成する必要があります。

必要なスコープで個人用アクセストークンを作成したら、『GitHub の手順の説明』に従って、 dockerlogin コマンドを使用し、GitHub Container Registry で認証します。このコマンドは、使用しているオペレーティングシステムに応じた、それぞれのコマンドラインインターフェースから実行する必要があります。

Windows: [Start (スタート)] メニューを開き、検索ボックスに「cmd」と入力します。アプリケーション「Command Prompt」が最初の検索結果として表示されます。それをクリックするか、Enter キーを押して、コマンドプロンプトを開きます。
macOS: Command と Space を同時押しして Spotlight 検索を開き、検索ボックスに「terminal」と入力します。アプリケーション「Terminal」が最初の検索結果として表示されます。それをクリックするか、Enter キーを押して、ターミナルを開きます。
Linux: デスクトップ環境の検索機能 (通常は Super キーを押してアクセスします) を開き、検索ボックスに「terminal」と入力します。「ターミナル」アプリケーションが最初の検索結果として表示されます。それをクリックするか、Enter キーを押して、ターミナルを開きます。

コマンドラインプロンプトを開いたら、以下に示すコマンドを実行し、ACCESS_TOKEN を個人用アクセストークンに、USERNAME を自分の GitHub ユーザー名に置き換えます。

	echo ACCESS_TOKEN | docker login ghcr.io -u USERNAME --password-stdin

認証プロセスが成功した場合は、 「Login Succeeded (ログインに成功しました)」 というメッセージが表示されます。

5. ビルド済みコンテナイメージをプルする

Unreal Engine の公式のビルド済みコンテナイメージは、 ghcr.io/epicgames/unreal-engine リポジトリにイメージタグとして保存されます。Unreal Engine 4.27 の Linux 開発イメージをダウンロードするには、以下に示す docker pull コマンドを使用します。

	docker pull ghcr.io/epicgames/unreal-engine:dev-4.27

これにより、Unreal Editor およびビルドツールのファイルをカプセル化した巨大なコンテナイメージがダウンロードされます。インターネットの速度によっては、ダウンロードに時間がかかる場合があります。ダウンロードが完了すると、「"Status:Downloaded newer image for ghcr.io/epicgames/unreal-engine:dev-4.27"」(ステータス: 新しい ghcr.io/epicgames/unreal-engine:dev-4.27 のイメージのダウンロード完了) と表示されます。

6. 開発コンテナでプロジェクトをビルドする

テスト目的で利用できる Unreal Engine プロジェクトがない場合は、手順に従って新しいプロジェクトを作成する必要があります。Linux と互換性のないコードプラグインをプロジェクトが使用していない限り、任意のプロジェクトで開発コンテナイメージをテストできます。

コマンドラインプロンプトを開き、以下に示すコマンドを実行して、開発イメージを使用して新しいコンテナを開始し、PROJECT_PATH をプロジェクトの「.uproject」ファイルを含むディレクトリへのパスに置き換えます。

	docker run --rm -ti -v "PROJECT_PATH:/project" ghcr.io/epicgames/unreal-engine:dev-4.27

これにより、プロジェクトのファイルにアクセスできるコンテナが起動します。コンテナは Linux を実行しているため、Linux デバイス用のプロジェクトのビルドおよびパッケージ化にこれを使用できるようになります。プロジェクトをパッケージ化するには、以下に示すコマンドを実行し、PROJECT_NAME をプロジェクトの名前に置き換えます。

	/home/ue4/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh \
	BuildCookRun \
	-utf8output \
	-platform=Linux \
	-clientconfig=Shipping \
	-serverconfig=Shipping \
	-project=/project/PROJECT_NAME.uproject \
	-noP4 -nodebuginfo -allmaps \
	-cook -build -stage -prereqs -pak -archive \
	-archivedirectory=/project/Packaged

プロジェクトがブループリント以外を含む場合は、プロジェクトの C++ コードモジュールがコンパイルされ、プロジェクトのアセットがクックされてパッケージ化されます。パッケージ化されたファイルは、「.uproject」ファイルを含むディレクトリ内にある「Packaged」というサブディレクトリに配置されます。

コンテナを停止するには、以下に示すコマンドを実行します。

	exit

Next Steps

ここまで来ると、ビルド済みのコンテナイメージの操作の基本に慣れてきたと思います。下記のリソースを確認すると、Unreal Engine コンテナの使用についてさらに学習することができます。

ビルド済みのコンテナイメージをダウンロードするだけでなく、Unreal Engine に含まれているすべてのイメージをカスタマイズして、ソースからビルドすることもできます。

*方法：ソースから Linux コンテナイメージをビルドする

*方法：ソースから Windows コンテナイメージをビルドする
開発イメージとランタイムイメージのどちらが必要かわからない場合は、Unreal Containers コミュニティハブの『クイックスタートガイド』を参照してください。
Unreal Engine コンテナの恩恵を受けることができるユースケースのリストを調べることもできます。

Prerequisite topics