ゲームのバージョンを管理する
概要
名前空間には多くのゲームを関連付けることができます。それぞれのゲームは複数のバージョンを持つことが可能で、ゲームのバージョン ID はそれぞれに固有です。このセクションでは、BlackBox CLI を使用してゲームの バージョンを一覧表示、設定、制御する方法を説明します。
ゲームのバージョン ID は、名前空間で各ゲームに生成される固有の ID であり、 ［Versions (バージョン)］ページに表示されるバージョンとは関係ないことに ご注意ください。この従来の命名規則は現在改善中です。
手順
ゲームのバージョンを一覧表示
新しいゲームバージョンを追加する前に、コマンドを下記のリストから選択して、利用可能なバージョンを一覧表示します。
インライン設定なし
BlackBoxCLI.exe version list
インライン設定あり
BlackBoxCLI.exe version list --namespace <your namespace> --apikey <yourapikey>
コマンドを実行すると、利用可能なゲームバージョンが下記のように一覧表示されます。ゲームバージョン ID が左側に、バージョン名が右側に表示されます。
ID | Name
-----------------------------------------------------------
2646fc64-b247-4150-8fcd-46ab883cb110 | 1.2.0
f5d6c34e-8391-4fb1-8863-f67d28247371 | 1.1.0
-----------------------------------------------------------
新しいゲームバージョンの追加
新しいゲームバージョンを追加するため、下記の設定に応じて次のコマンドを実行します。
インライン設定なし
BlackBoxCLI.exe version add --name <new version name>
インライン設定あり
BlackBoxCLI.exe version add --name <new version name> --namespace <your namespace> --apikey asdf1234 --game-project <your project path>
この例では、バージョン 1.1.9 を追加します。
BlackBoxCLI.exe version add --name "1.1.9" --namespace MyAwesomeNamespace --apikey asdf1234 --game-project D:\MyProject\MyAwesomeGame
BlackBox CLI でゲームのバージョンを設定しない場合は、
--no-set option を使用します。
バージョンを作成した場合は、使用するバージョンを選択できます。この例では、バージョン 1.1.9 を使用します。
BlackBoxCLI version set --name "1.1.9" --namespace MyAwesomeNamespace --apikey asdf1234 --game-project D:\MyProject\MyAwesomeGame
version add コマンドと version set コマンドには --enable-set-datarouter フラグがあります。
これを使用すると Unreal Crash Report Client の宛先 URL を変更できます。
カスタムメタデータの追加 [非推奨]
このサブコマンドは非推奨です。ADT では、バージョンへのメタデータ追加が非対応になりました。
このコマンドに従って、バージョンと結び付けたいファイルにカスタムデータを追加します。
BlackBoxCLI.exe version upload-metadata <option and parameter>
インライン設定なし
BlackBoxCLI.exe version upload-metadata --type sniffTest --directory D:\path\to\sniffTestdir
インライン設定あり
BlackBoxCLI.exe version upload-metadata --type sniffTest --directory D:\path\to\sniffTestdir --game-project D:\path\to\myawesomegame --apikey asdf1234 --namespace myawesomegame
任意のデータを追加するのに役立つサブコマンドについては、以下を参照できます。
| メインコマンド | サブコマンド | オプションとパラメータ | |
|---|---|---|---|
| 名前 | 説明 | ||
version | upload-metadata | -d, --directory | アップロード用のデータのディレクトリ |
| -f, --file | アップロード用ファイル | ||
| -t, --type | メタデータのタイプ | ||
| -n, --namespace | 名前空間 | ||
| -a, --apikey | API キー | ||
| -p, --game-project | ゲームプロジェクトのパス | ||
| -F, --force-parse | ヘッダーとフッターの解析を強制 | ||
| -N,--version-name | バージョン名でバージョンを上書き (オプション) | | ||
メタデータの値については、任意のファイルタイプを入力してバージョンと結び付けることができます。次のような、事前定義済みのファイルタイプもあります。
| タイプ | 説明 |
|---|---|
| performanceTest | パフォーマンステストとしてファイルを指定する |
| sniffTest | スニッフィングテストとしてファイルを指定する |
Perforce 変更リスト情報を追加する
Perforce (P4 ともいう) で Unreal Engine ゲームを扱うときは、場合により、変更リスト名、作成者などの情報をビルドパイプラインに入力する必要があります。これを行う場合のサブコマンドを例示します。
BlackBoxCLI.exe version add-changelist-info --author johndoe --changelist-num 1234 --datetime "2020-01-01T09:37:56Z" --description "add more awesomeness"
BlackBoxCLI.exe version add-changelist-info --author johndoe --changelist-num 1234 --datetime "2020-01-01T09:37:56Z" --description "add more awesomeness" --namespace myawesomegame --apikey asdf1234 --game-project D:\path\to\myawesomegame
add-changelist-info と add-changelist-bulk については、以下を参照できます。
| メインコマンド | サブコマンド | オプションとパラメータ | |
|---|---|---|---|
| 名前 | 説明 | ||
version | add-changelist-info | -a, --apikey | API キー |
| -n, --namespace | 名前空間 | ||
| -A, --author | 変更リストの作成者 | ||
| -t, --datetime | 変更リストの日時 (ISO8601 形式) | ||
| -D, --description | 変更リストの説明 | ||
| -c, --changelist-num | 変更リストの番号 | ||
| -p, --game-project | ゲームプロジェクトのパス | ||
version | add-changelists-bulk | -a, --apikey | API キー |
| -n, --namespace | 名前空間 | ||
| -f, --file | 変更リストファイル | ||
| -p, --game-project | ゲームプロジェクトのパス | ||
利用可能な変更リストをアップロードする場合は、add-changelists-bulk コマンドを使用してゲームバージョンと結び付けます。JSON 形式を例示します。
[
{
"id" : <change list number>,
"description" : "commit description",
"Author":"author name",
"Time":"datetime in ISO 8601 format",
},
...
]
値を入力すると、次のようになります。
[
{
"id" : 139737,
"description" : "adding weapon to the main character",
"author":"hdarwintha",
"time":"2020-09-15T03:08:00+00:00",
},
{
"id" : 139720,
"description" : "remove unused shader on main menu UI",
"author":"tomnook",
"time":"2020-09-14T03:08:00+00:00",
},
]
インライン設定のない add-changelist-bulk コマンドの例を示します。
BlackBoxCLI.exe version add-changelist-bulk --file D:\path\to\changelist_list.json