Unreal Turnkey

Unreal Turnkey で、 SDK のインストールと管理を自動化してプラットフォームのセットアップを簡素化できます。

Windows
MacOS
Linux

TurnkeyUnreal Engine 5 で導入されたシステムです。これにより、ソースファイルを検索して SDK のインストールや開発キットのフラッシュを行う場合など、プラットフォーム サポートの設定に必要なほとんどの手順を自動化できます。

組織で Turnkey 用のファイルソース リポジトリのセットアップが完了した後は、個々のチーム メンバーが任意のターゲット プラットフォーム用にシステムをワンクリックでセットアップできるようになります。このページでは、Turnkey 用の SDK をホストする方法と、Turnkey を使用してそれらをダウンロードして Unreal Engine の個々のインスタンスにインストールする方法を説明します。

概要

Turnkey は AutomationTool スクリプトであり、 RunUAT.bat からアクセスできます。これには、SDK とのやり取りに使用できる多くのツールが備わっています。Turnkey は、組織用に設定したリポジトリにアクセスし、ファイルを自動的にダウンロードして、そのリポジトリから SDK を設定します。

Turnkey を実行して SDK をインストールすると、次のプロセスが実行されます。

  • Turnkey が起動し、 TurnkeyManifest.xml によって提供される情報を使用して SDK をスキャンします。

  • Turnkey が、ユーザーの入力に基づいてプラットフォームを選択します。

  • ビルド システムが、現在の Unreal Engine のバージョンで有効な SDK のバージョンを Turnkey に通知します。

  • 利用可能なすべての有効な SDK から最適な SDK が選択されます。

    • Turnkey は一連のプラットフォーム固有のルールを使用してバージョン番号を整数に変換し、有効な SDK の範囲内で最大の番号が選択されます。これらのルールの指定は、「*PlatformSDK.cs」ファイルで行います。

  • Turnkey によって、SDK ファイルがユーザーのマシンにダウンロードされます。

    • SDK ファイルが .zip ファイルに含まれている場合、それらは一時的な場所に自動的に解凍されます。

  • ビルド システムが、ダウンロードした SDK をインストールします。

これにより、利用可能な SDK バージョンが多数ある場合でも、Unreal Engine プロジェクトをすばやくセットアップしたり、SDK を更新する必要がある時はいつでも、そのメンテナンス作業を合理化したりできます。

Turnkey を設定する

Turnkey を使用するには、ファイルソース リポジトリで SDK をホストし、TurnkeyManifest.xml ファイルと TurnkeyStudioSettings.xml ファイル、そして Turnkey がそれらファイルを検出するために必要な情報をセットアップする必要があります。

以下のページでは、これらの各コンポーネントをセットアップする方法と、Turnkey による自動化が SDK バージョンを認識するようにディレクトリを構成する方法について説明しています。

使用方法

組織で Turnkey の設定が完了すると、ユーザーは Unreal Engine 内から直接 Turnkey を使用したり、コマンドライン インターフェースで RunUAT.bat を使用したりすることで、Turnkey とやり取りできるようになります。以下のページでは、それぞれの使用方法に関する情報が記載されています。