Turnkey コマンドラインの使用

コマンドライン インターフェースを使用して 「RunUAT.bat」 から Turnkey を実行する方法についてのリファレンス情報です。

Turnkey は、RunUAT.bat からアクセスする Unreal AutomationTool (UAT) のスクリプトです。ほとんどのユーザーにとっては Unreal Editor 内から Turnkey を使用するツールで十分ですが、コマンドラインを使用すると SDK を管理するためのより詳細で高度なオプションが使用できます。このガイドでは、Turnkey コマンドラインにアクセスする方法と、各種オプションの使い方について説明します。

Turnkey コマンドラインにアクセスする

コマンド ラインから Turnkey にアクセスするには、次の手順を実行します。

  1. Windows コマンドプロンプトなど、お好みのコマンドラインを開きます。

  2. Unreal Engine のインストールディレクトリに移動します。

  3. RunUAT.bat turnkey と入力して Turnkey を実行します。

コマンドラインは、AutomationTool の構築に少し時間がかかります。その後、Turnkey スクリプトを開始し、番号付きコマンドの一覧を表示します。

The Turnkey commandline interface

このメニューから実行したいコマンドに対応する番号を入力し、[Enter] キーを押します。これらのコマンドのほとんどは、そのコマンドに固有の追加オプションを含むサブメニューを表示します。

どのメニューでも「0」と入力すると現在の操作がキャンセルされます。サブメニューでキャンセルを選択すると、Turnkey のメインメニューに戻ります。メインメニューでキャンセルを選択すると、スクリプトが停止して終了します。以下のセクションで、その他の利用可能なコマンドとサブメニューを示します。

Turnkey コマンドラインの引数を使用する

または、「.bat」 ファイルを実行する際に、一連の指定子を追加することで、これらのプロンプトをスキップして、コマンドをすぐに実行することもできます。引数に -command=[コマンド名] を使用して、コマンドを選択してから、指定子を追加して、他のオプションを処理させます。

例えば、次のように入力すると、プラットフォームが Android に設定され、InstallSdk コマンドが実行されます。

`RunUAT.bat turnkey -command=InstallSdk -platform=Android`

各コマンドで使用可能な指定子については、以下のセクションを参照してください。

SDK をインストールする

InstallSdk コマンドを実行すると、Turnkey にインストールしたい SDK の種類を選択するプロンプトが表示されます。

SDK installation menu

次のオプションがあります。

  1. Full or Auto SDK` は、AutoSDK または Full SDK いずれかのインストールを試行し、利用可能な場合は AutoSDK を選択します。

  2. Full Sdk は、プロジェクトで利用できる、コンポーネントの完全な配列を備えたフル SDK をダウンロードします。

  3. AutoSdk は、AutoSDK が利用できれば、インストールを試みます。

  4. Device Software / Flash は、プロジェクトに最適な Flash SDK をダウンロードします。この SDK には、開発キットのフラッシュやテストに必要なコンポーネントのみが含まれています。

Turnkey が選択した SDK タイプを見つけられない場合、操作を中断してエラーをスローします。

SDK の種類を選択すると、Turnkey によってインストールするプラットフォームの SDK を選択するプロンプトが表示されます。

Platform selection menu

セットアップしたいプラットフォームの番号を入力すると、Turnkey はそのプラットフォームに対応する SDK のダウンロードとインストール処理を開始します。利用できる SDK が存在しない場合、プロセスは失敗し、エラー メッセージが表示され、メイン メニューに戻ります。

指定子

次の指定子は、コマンドラインで -command=InstallSdks を使用する場合に互換性があります。

指定子

説明

-Platform=

プラットフォームを選択します。プラットフォームの選択プロンプトに表示されるプラットフォームの名前を使用します。例えば、-Platform=Win64 は有効ですが、-Platform=Windows は有効ではありません。この指定子を使用すると、プラットフォーム選択のサブメニューはスキップされます。

-Platform=All は利用可能なすべてのプラットフォームを反復処理します。

-NeededOnly

Turnkey が SDK の種類として AutoSDK を検索するように指定します。

-BestAvailable

Turnkey が SDK の種類として完全な SDK を検索するように指定します。-NeededOnly と組み合わせると、完全な SDK または AutoSDK のいずれかが検索されます。

-UpdateOnly

Turnkey が完全なインストールを実行するのではなく、既にインストールされている SDK を更新するように指定します。

Auto Install All Needed SDKs コマンドは、指定子 -command=InstallSdk -Platform=All -NeededOnly -BestAvailable で Turnkey を実行します。これは、[Full or Auto SDK] を選択してから、プラットフォームに [All of the Above] を選択することと同じです。

Auto Update Installed Sdks コマンドは、指定子 -command=InstallSdk -Platform=All -UpdateOnly -BestAvailable で Turnkey を実行します。

SDK の確認

VerifySdk コマンドを実行すると、SDK を検証するプラットフォームを選択するためのプロンプトが表示されます。次に Turnkey は、現在の SDK インストールに関する情報を出力し、Unreal Engine が想定するパラメータと一致するかどうかを確認します。

Example of Turnkey verifying SDKs

指定子

-command=VerifySdk-Platform= 指定子と互換性があります。

ビルドの実行

ExecuteBuild コマンドは、選択したプラットフォームのプロジェクトをビルドします。このオプションを選択すると、ターゲット プラットフォームの一覧が表示された後に、別のプロンプトがビルド可能なプロジェクトを一覧表示します。

The project selection menu

プロジェクトは認識された .uproject 名に基づいています。例えば、ShooterGame はサンプル プロジェクトとして表示されます。プラットフォームとプロジェクトを選択すると、Turnkey はプロジェクトのクック処理とパッケージ化処理を開始します。

指定子

-command=ExecuteBuild-Platform= 指定子と互換性があります。また、-project= 指定子を使用して、認識されたプロジェクト名を選択し、プロンプトでの選択をスキップすることもできます。例えば、次の入力は Win64 プラットフォーム向けに ShooterGame のビルドを試みます。

`RunUAT.bat Turnkey -command=ExecuteBuild -platform=Win64 -Project=Shootergame`

ビルドのインストール

Turnkey でビルドをインストールする機能は、UE5 の早期アクセス ビルドでは開発途上ですが、信頼性を高めたものを最終リリースで提供する予定です。

InstallBuild コマンドを実行すると、以前に作成したデバイスへのインストール準備ができているビルドの一覧と、コンピュータに接続されている有効なデバイスの一覧が表示されます。。両方とも選択すると、Turnkey によって選択したデバイスにビルドがインストールされます

指定子

-command=InstallBuild-platform= 指定子と互換性があります。-device= 指定子を使用することもできます。デバイスの形式は [プラットフォームの種類]@[デバイス名] です。ここでのプラットフォームの種類は Turnkey によって認識されるプラットフォームであり、デバイス名はコンピュータに表示されるデバイスの ID です。例:-device=Android@ABCXYZ123.[ListPlatforms] を使用して、デバイスとその ID の一覧を表示できます。

ヘルプ

Help コマンドは、Turnkey の設定方法と使用方法に関する情報を提供するヘルプ メニューを開きます。これには TurnkeyManifest.xml の FileSource エントリの書式を設定する方法や、一部のプラットフォーム向けに特定バージョンの書式に関する情報が含まれます。

プラットフォーム情報の一覧表示

ListPlatforms コマンドは、選択したプラットフォーム用に設定された SDK とデバイスに関する情報を一覧表示します。併せて、現行バージョンの Unreal と互換性のある SDK のバージョンと、お使いのネットワーク上で確認できるデバイスに関する情報も表示されます。

Example of platform information output

指定子

-command=ListPlatforms-platform= 指定子と互換性があります。

SDK の一覧表示

ListSdks コマンドは、FileSource リポジトリで使用可能な SDK の一覧を出力します。Turnkey から、SDK を一覧表示するプラットフォームの選択を求められます。

指定子

-command=ListSdks-platform= 指定子と互換性があります。

設定の管理

ManageSettings コマンドは、設定可能な一連の変数を表示します。これらの変数は、組織のコピー プロバイダー設定と、特定のプラットフォームの資格情報に関連しています。通常、「MobileProvision.ini」ファイルや「TurnkeyStudioSettings.xml」ファイルなど異なる複数のファイル中に存在しますが、このコマンドは、それらをオーバーライドする一元的な場所を提供します。

指定子

-command=ManageSettings-ListOnly 指定子と互換性があります。これにより、構成可能なすべての変数の一覧および、各変数の機能についての説明が出力されます。Turnkey メニューの`List Settings コマンドは、-command=ManageSettings -ListOnly`.を実行します。

デバイスの制御

Control コマンドは、デバイスをリモートで制御するためのメニューを表示します。プラットフォームを選択すると、お使いのコンピュータからアクセスでき、そのプラットフォームにマッチしたデバイスがすべて表示されます。

The device control menu

デバイスの電源オン / オフ、再起動、接続 / 切断ができます。これと同じ機能が、Unreal Editor の デバイスマネージャー にも存在します。

Turnkey のテスト

Test コマンドは、診断テストを実行して、環境が正しくセットアップされているかどうか確認します。テストは、選択したコピー プロバイダーに接続し、必要なディレクトリを確認しようとします。ある段階で処理が失敗すると、エラーが報告されます。

Example of Turnkey testing output

Unreal Engine のドキュメントを改善するために協力をお願いします!どのような改善を望んでいるかご意見をお聞かせください。
調査に参加する
キャンセル