ADT CLI を設定する

Last updated on December 3, 2024

概要

ADT CLI は、ビルドエンジニアが ADT のツールスイートを扱うために使用するものです。これは ADT バックエンドと直接連携し、 ほとんどの ADT 機能と要素の get、set、list、upload、download が可能です。ADT CLI は手動で実行したり、 スクリプトにビルドしてパイプラインを構築したりできます。

手順

ベース URL を設定

ADT CLI を使用する前に、BlackBoxCLI.exe と同じフォルダに config.ini ファイルがあることを確認します。

1. config.ini ファイルがない場合は、任意のテキストエディタでこれを作成し、以下のコードを追加します。

   [url]
   base_url = https://blackbox.accelbyte.io

2. config.ini ファイルを BlackBoxCLI.exe と同じフォルダに保存します。

ADT CLI のバージョン確認

実行している ADT CLI のバージョンを確認するには、実行時に --help 引数を追加します。

BlackBoxCLI.exe --help

ヒント

--help 引数により、以下を含め、ADT CLI に関するその他の有用な情報が表示されます。

BlackBox Command Line Interface tools v2.24.0
Build date: 2024-10-24T10:53:02Z
GIT Commit: 1e1a4428
Copyright 2020-2024 AccelByte Inc.

サブコマンドの使用

ADT CLI には下記の表で説明するいくつかのサブコマンドがあります。サブコマンドを使用するには、 以下のように、コマンドライン命令の最初の引数としてサブコマンドを入力します。

BlackBoxCLI.exe <subcommand> <second argument>

次の表で、サブコマンドとその使用方法を説明します。

サブコマンド	説明
build	新しく作成したゲームビルドのビルド ID を登録する
credentials	API キーなどの認証情報を設定する
config	ADT CLI を設定する
crash-url	エンジンクラッシュ URL のエンドポイントを管理する
upload	ゲームの実行ファイルを解析し、フィルタリングした PDB コンテンツを ADT バックエンドにアップロードする
version	ADT CLI からゲームのバージョンを管理する
build-channel	ADT バックエンドでプロジェクトのチャネル管理をビルドする
game-binary	ゲームのバイナリをアップロードまたはダウンロードする (認証情報が必要)

ADT CLI 用の独自の API キーを設定

credentials サブコマンドを使用する場合、システムから API キーの設定を求められます。システムはこのキーを使用して、ADT サービスへのアクセス権を 付与します。API キーはゲームに固有のものです。安全に保管することが重要であり、共有したり、メールや安全でないチャネルを介して送信したりしては いけません。API キーを使用して .pdb ファイルをシステムにアップロードし、非公開にします。また、ゲームの新しいバージョンを作成し、 ビルドを管理するのにも、API キーが必要です。

備考

If you lose your API Key, your admin can generate a new one from the Game Settings > API Key Management page and manage the associated permissions. For more information, refer to the Manage multiple API keys guide.

以下の手順は、API キーを設定または取得する方法を示しています。

認証情報の値を設定

認証情報は、C:\\User<Username>\\.blackbox\\default file にあります。認証情報名 (この場合は API キー) から値を設定するには、 次のコマンドを使用します。

BlackBoxCLI.exe credentials set <creds_name> <creds_value>

認証情報の値を設定するコマンドの例を以下に示します。

BlackBoxCLI.exe credentials set APIKey <YOUR_API_KEY>

単一の認証情報の値を取得

以下のコマンドを実行して API キーを取得します。

BlackBoxCLI.exe credentials get APIKey

このコマンドは API キーを返します。

[Credentials]
APIKey = YOUR_API_KEY

すべての認証情報の値を取得

以下のコマンドを使用すると、すべての認証情報の値を画面に表示できます。

BlackBoxCLI.exe credentials list

このコマンドは API キーを返します。

APIKey: YOUR_API_KEY

ADT CLI の設定

これで認証情報を設定できました。ADT CLI 設定の次の手順は、名前空間とプロジェクトの場所を入力することです。 ADT CLI を設定する方法は 3 つあります。

1. インタラクティブサブコマンド
2. 環境変数
3. インライン設定

インタラクティブサブコマンド

インタラクティブモードのサブコマンドを使用するように ADT CLI を設定するには、次のコマンドを使用します。

BlackBoxCLI.exe config set

インタラクティブインターフェイスが表示され、そこに設定の詳細を入力できます。

BlackBoxCLI.exe config set
New configuration file created...
namespace[]: avengers
game_engine[]: F:\UE4\UE_4.21
game_archive[]: D:\Work\SampleGame\OuputGithubSource\WindowsNoEditor
game_server_archive[]: D:\Work\SampleGame\OuputGithubSource\WindowsServer
game_project[]: D:\Work\SampleGame

インタラクティブモードを使用しない場合は、以下のように、シングルコマンドラインを使用して設定できます。

シングルコマンドライン

ADT CLI の認証情報の詳細を入力します。認証情報とその説明については、以下を参照してください。

認証情報	説明
namespace	ゲームの名前空間
game_engine	ゲームエンジンのルートパスであり、GenerateProjectFiles.bat と UE4.sln または UE5.sln の場所
game_archive	パッケージ化されたゲームの実行ファイルの場所
game_server_archive	パッケージ化されたサーバーゲームの実行ファイルの場所
game_project	.uproject ファイルを含むゲームプロジェクトのルートフォルダ

ADT CLI 認証情報を使用する例を以下に示します。

BlackBoxCLI.exe config set game_engine "F:\UE4\UE_4.21"
BlackBoxCLI.exe config set game_archive "D:\Projects\AccelByte\justice-crashreporter-accelmania_baked"

単一の設定値を取得

次のコマンドを実行して、設定名から設定値を取得します。

BlackBoxCLI.exe config get <config_name>

game_archive という名前の設定から単一の値を取得する例を以下に示します。

BlackBoxCLI.exe config get game_archive

このコマンドは、次のように、game_archive パスを返します。

[Path]
game_archive = D:\Projects\AccelByte\justice-crashreporter-accelmania_baked

シングルコマンドの例

次のコマンドを使用して設定を行ったり取得したりできます。

注意

設定の変数は大文字と小文字を区別します。

BlackBoxCLI config set game_engine <value>
BlackBoxCLI config set game_archive <value>
BlackBoxCLI config set game_server_archive <value>
BlackBoxCLI config set game_project <value>
BlackBoxCLI config set namespace <value>


BlackBoxCLI config get game_engine
BlackBoxCLI config get game_archive
BlackBoxCLI config get game_server_archive
BlackBoxCLI config get game_project
BlackBoxCLI config get namespace

プロジェクトのすべての設定値を一覧表示

次のコマンドを実行すると、すべての設定値を取得して画面に表示できます。

BlackBoxCLI.exe config list

このコマンドは、次のようなテキストを返します。

[Config]
namespace = mygamenamespace
[BaseURL]
profiling_url = https://blackbox.accelbyte.io/profiling
iam_url = https://blackbox.accelbyte.io/iam
symbol_service_url = https://blackbox.accelbyte.io/symbol
data_service_url = https://blackbox.accelbyte.io/data


[Path]
game_engine = D:\UE4\UE_4.25
game_archive = D:\Work\SampleGame\OuputGithubSource\WindowsNoEditor
game_server_archive = D:\Work\SampleGame\OuputGithubSource\WindowsServer
game_project = D:\Work\SampleGame

環境変数

未定

インライン設定

ADT CLI は、事前に設定値を定めることなく使用できます。これを行うには、メインコマンドで設定変数を入力します。以下の設定オプションを参照してください。

コマンド	説明
-a, --apikey	API キーを設定する
-n, --namespace	名前空間を設定する
-p, --game-project	ゲームプロジェクトのパスを設定する
-e, --game-engine	ゲームエンジンのパスを設定する
-r, --game-archive	パッケージ化されたゲームのパスを設定する
--game-server-archive	パッケージ化されたサーバーゲームのパスを設定する

例

BlackBoxCLI.exe upload --namespace MyAwesomeNamespace --game-project D:\MyProjects\MyAwesomeGame --game-engine D:\GameEngine\UE4-425 --game-archive D:\MyProjects\MyAwesomeGame\ClientBuild\WindowsNoEditor --apikey <your API key>

設定ファイル

設定の詳細は config.ini ファイルにあります。これは、ADT CLI 設定ファイルが生成します。config.ini ファイルは ADT CLI 実行ファイルと同じフォルダに あります。

[url]
base_url = <Blackbox Base URL>

[Config]
namespace = <Your Namespace>


[Path]
game_engine = <The location of game engine>
game_archive = <The location of your game's packaged build>
game_server_archive = <The location of the packaged server build of your game>
game_project = <The root folder of your game project>

ADT CLI config コマンドの実行後の例を以下に示します。

[url]
base_url = https://blackbox.accelbyte.io

[Config]
namespace = myawesomegame


[Path]
game_engine = F:\UE4\UE_4.21
game_archive = D:\Work\SampleGame\OuputGithubSource\WindowsNoEditor
game_server_archive = D:\Work\SampleGame\OuputGithubSource\WindowsServer
game_project = D:\Work\SampleGame

備考

インライン設定でコマンドを実行する場合は、config.ini ファイルは、作成も変更もされません。ただし、これらのコマンドは config.ini ファイル内のコマンドよりも優先されます。

設定ファイル内の用語

config.ini ファイル内で設定名に使用する用語を以下に示します。

ゲームエンジン

これは、Unreal Engine のルートディレクトリです。たとえば、Unreal Engine を C:\\Program Files\\UE4\\UE\_4.21 にインストールすると、game_engine の値は C:\Program Files\UE4\UE_4.21 になります。

[Path]
game_engine = C:\Program Files\UE4\UE_4.21

ゲームアーカイブディレクトリ

これは、パッケージ化されたゲームのディレクトリです。通常、ディレクトリ構造は <パッケージ化されたビルドのパス>/<プラットフォーム名> です。たとえば、パッケージ化された ビルドのパスを E:\Project\Output for Windows に設定する場合、ゲームアーカイブは E:\Project\Output\WindowsNoEditor です。ゲームアーカイブは、パッケージ化されたゲームの 実行ファイルが存在するディレクトリです。

ゲームプロジェクトディレクトリ

ゲームプロジェクトは、.uproject ファイルが存在するディレクトリです。

+-- Config
    +-- DefaultEditor.ini
    +-- DefaultEditorPerProjectUserSettings.ini
    +-- DefaultEngine.ini
    +-- DefaultGame.ini
    +-- DefaultInput.ini
+-- Content
+-- Plugins
+-- Source
+-- MyAwesomeGame.sln
+-- MyAwesomeGame.uproject

備考

game_project が D:\GameProjects\MyAwesomeGame にある場合、.uproject ファイルが同じディレクトリにあることを確認します。ADT CLI は、 Config/DefaultEngine.ini で [/Script/BlackBoxSDK.BlackBoxSettings] を探して、設定値を読み取ります。

エンジン名

ADT CLI はゲームエンジンごとに異なる動作をします。ゲームエンジン名を入力すると、これが ADT CLI の動作モードを指定します。

[base]
engine_name = ue4

有効な engine_name の値は、ue4、ue5、unity です。

Unreal クラッシュレポート URL の設定

備考

このコマンドは、Windows と Linux でのみ使用できます。

詳細については、Unreal Crash Report Client URL の管理を参照してください。