コンテナ クイック スタート ガイド

Unreal Engine のコンテナの使い方を説明します。

Windows
MacOS
Linux
前提トピック

このページは以下のトピックへの知識があることを前提にしています。まず以下のトピックの内容についてご確認をお願いします。

コンテナ クイック スタート ガイドでは、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 をインストールする手順は、使用しているオペレーティングシステムによって異なります。以下のリンクでは、利用可能な各プラットフォームでインストールを行う方法について説明しています。

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 のドキュメントを改善するために協力をお願いします!どのような改善を望んでいるかご意見をお聞かせください。
調査に参加する
閉じる