スマートビルドの管理
注釈:本資料はAI技術を用いて翻訳されています。
概要
スマートビルドは、最後のダウンロード以降に変更された部分のみをアップロードおよびダウンロードする機能です。これにより、AccelByte Developer Toolkit(ADT)ユーザーはローカルの変更を他のユーザーと迅速に共有できます。
互換性
スマートビルドは現在、次のゲーム仕様をサポートしています:
- プラットフォーム:Windows
- Unreal Engineバージョン:4.26.2、4.27.2、5.0.2、5.0.3、5.1.0、5.1.1、5.2、および5.3
- Unity(詳細については、スマートビルドのUnityサポートをお読みください。)
ゲームをコンパイルする際とスマートビルド機能でアップロードする際には、同じUnreal Engineバージョンを使用する必要があります。バージョンが一致しない場合、CLIで未定義の動作が発生し、再パッケージ化が失敗する可能性があります。
スマートビルドを設定する
-
ADT SDKをゲームに統合します。
-
ADT CLIを開き、次のコマンドで新しいバージョンを作成します。
.\BlackBoxCLI.exe version add --name <your version name> --namespace <your namespace> --apikey <your APIkey> --game-project <game project path> --base-url https://blackbox.accelbyte.ioまたは、次のコマンドを使用して目的のバージョンを設定できます:
.\BlackBoxCLI.exe version set --name <your version name> --namespace <your namespace> --apikey <your APIkey> --game-project <game project path> --base-url https://blackbox.accelbyte.io -
--smartbuildパラメータを使用して新しいビルドを登録します。.\BlackBoxCLI.exe build register --platform-name windows --platform-arch <platform-arch> --smartbuild --namespace <your namespace> --apikey <your apikey> --game-project <your project path> --base-url https://blackbox.accelbyte.io -
次のコマンドでビルドの名前を変更できます:
.\BlackBoxCLI.exe build add-metadata --key build-name --value <the new build name>注記ADT CLIを介してビルドの名前を変更できるのは1回のみですが、ADT Webでは必要な回数だけビルドの名前を変更できます。
-
Unreal Editorが開いている場合は閉じて、
.uprojectを再起動します。Unreal Editorが閉じている場合は、.uprojectを起動します。 -
ゲームをパッケージ化してフォルダに保存します。例:
C:\<upload_dir>。
CLIを介してスマートビルドをアップロードする
次の表には、スマートビルドをアップロードする際に使用できるサブコマンドが含まれています。
| メインコマンド | サブコマンド | オプションとパラメータ | |
|---|---|---|---|
| 名前 | 説明 | ||
| smartbuild | upload | --namespace | ユーザーネームスペース |
| --base-url | https://blackbox.accelbyte.io/ | ||
| --upload-dir | アップロードされるバイナリのディレクトリ | ||
| --entry-point | エントリポイント/実行可能ゲーム名 | ||
| --version-id | 目的のバージョンIDを設定 | ||
| --build-id | 目的のビルドIDを設定 | ||
| --multipart-size | メガバイト単位の目的のマルチパートサイズ。5未満にはできません。 | ||
| --operation-id | オプション。診断ログのID番号。詳細は以下のFAQセクションで確認できます。 | ||
| --temp-path | オプション。一時ファイルの保存に使用されるフォルダパス。詳細はFAQセクションで確認できます。 | ||
| --launch-argument | オプション。ビルドの起動引数 |
アップロード形式のログには次のステータスが表示されます:
-
パッケージファイルの前処理
[SmartBuild] [info] YYYY-MM-DD HH:mm:ss: Writing 2000 chunks into folder: `C:\Users\....\AppData\Local\Temp\....\` -
マニフェストの送信
[SmartBuild] [info] YYYY-MM-DD HH:mm:ss: Submitting initial manifest for build ID ce8c2221-45b3-4c74-97d2-1f805134ca8d -
ファイルのアップロード
{"status":"uploading files","current":1500,"total":2000,"filename":"long filename","filesize": in bytes, "current_byte":in bytes ,"total_byte":in bytes, "rate": rate value, "time_remaining": approximate in seconds}
アップロードが完了すると、CLIは次のログメッセージを表示します:
Smartbuild upload took 600 seconds.
Build is successfully uploaded using smartbuild.
スマートビルドをダウンロードする
ユーザーは、ビルド配信アプリであるADT Webを使用して、スマートビルドを使用してアップロードされたバイナリをダウンロードして再生することもできます。ダウンロードを実行する前に、ユーザーはsmartbuild uploadコマンドを使用してビルドがすでにアップロードされていることを確認する必要があります。
スマートビルドのキャッシュディレクトリを設定する
バイナリをダウンロードするには、キャッシュをローカルに保存するための追加のスペースが必要です。ユーザーがスマートビルドを使用してビルドをダウンロードすると、キャッシュが保存され、初期バイナリと更新されたバイナリの差分と同じだけサイズが増加します。ユーザーは、十分なストレージスペースがある場所にキャッシュフォルダを設定する必要があります。
-
ADT Hubにログインし、ゲーム名ドロップダウンからアプリケーション設定を開きます。
-
Smart Buildsタブを選択し、Local Cache Directoryセクションの下にあるBrowseボタンをクリックして、宛先フォルダを選択します。
-
フォルダを選択すると、ADT Hubはすべてのキャッシュを新しいディレクトリに移動します。
-
次のステップに進む前に、プロセスが完了したことを確認してください。
-
移動プロセスが完了すると、ダウンロードされたビルドキャッシュは新しいフォルダに保存されます。
プロセスに必要な時間は、フォルダ内のファイルのサイズによって異なります。
ADT Webバージョンページからスマートビルドをダウンロードする
-
ADT Webにログインします。
-
Versionメニューに移動します。
-
スマートビルドをアップロードしたバージョンをリストから選択します。
-
ADT Hubで指定されたビルドのDownloadをクリックします。
-
バイナリをダウンロードした後、ボタンがPlayに変わり、ビルドをプレイできます。
スマートビルドのビルドチャネルを設定する
-
ADT Webにログインします。
-
ビルドチャネルページに移動します。
-
Add new build channelボタンをクリックします。
-
Build Channel名を入力します。
-
New Build ChannelポップアップページでSmart Buildsビルドタイプオプションを選択します。
-
PlatformドロップダウンからWindowsを選択します。
-
スマートビルドでアップロードされたビルドを含む正しいチェンジリストを選択します。
-
Headとして設定するビルドを選択します。
-
Add confirmationボタンをクリックします。
-
ビルドチャネルがビルドチャネルリストに表示されます。
ADT Web概要ページからスマートビルドをダウンロードする
-
ADT Webにログインします。
-
Overviewページで、Configure Build Channelをクリックします。
-
スマートビルドを使用してアップロードしたビルドチャネルには、その横にSBアイコンがあります。サブスクライブするビルドチャネルを選択し、Save Changesをクリックします。
-
サブスクライブしたビルドチャネルがOverviewページに表示されます。
-
Downloadボタンをクリックして、スマートビルドのダウンロードを開始します。
ADT Webからスマートビルドを使用してダウンロードする場合、ステージプロセスがダウンロードプロセスの一部として含まれます。
スマートビルドで利用可能な追加機能
検証と修復
ビルドをダウンロードしてもプレイできない場合、ADT Webの検証と修復機能を使用して、指定されたビルドが破損しているかどうかを確認できます。
-
ADT Webからダウンロードを完了します。
a. Overviewから
b. Versionページから
-
ビルドチャネルの省略記号に移動し、Verifyをクリックします。
-
ボタンplayが検証進行状況バーに変わります。
-
検証の結果は2つの状態があります。
a. 破損したファイルがない場合、ボタンは再びPlayに戻ります。
b. 破損したファイルがある場合、ボタンはRepairとして表示されます。
-
修復を実行する前に、破損したファイルの詳細情報を保存しておきます。
a. 省略記号メニューに移動し、Open Folderを選択します。
b.
<root installation folder>\.smartbuildに移動し、verify.jsonを探します。c. ファイルをコピーして、インストールフォルダ以外の場所に保存します。この
verify.jsonファイルをADTチームと共有することで、問題のデバッグに役立てることができます。 -
Repairボタンをクリックしてビルドを修復します。
-
修復プロセス中、ADT Webは破損したキャッシュファイルを再ダウンロードするか、欠落しているファイルをステージングして、ゲームを正常にプレイできるようにします。
-
修復が完了すると、ユーザーは再びゲームをプレイできるようになります。
ビルドの切り替え
ビルドの切り替えは、ビルドチャネルのヘッドをシームレスに変更できる便利な機能です。新しいビルドの場合、最初にビルドチャネルページからヘッドを更新する必要があります。ただし、ビルドチャネルにすでにヘッドとして設定されたビルドがある場合は、概要ページでビルド間を簡単に切り替えることができます。
ビルドチャネルのヘッドを変更する方法
-
ビルドチャネルページに移動します。
-
目的のビルドチャネルでEditを選択します。
-
目的のチェンジリスト/バージョンを選択します。
-
選択したバージョンから(Build available)の詳細を持つ目的のビルドを選択します。
-
選択したビルドが現在のHeadと同じ場合、Saveボタンはクリックできません。
-
Saveをクリックして、ビルドチャネルヘッドの変更を確定します。
-
ユーザーは、ビルドチャネルが更新され、ビルドチャネルリストでヘッド値が変更されたという通知を受け取ります。
ビルドの切り替えを使用する方法
-
OverviewページからSmart Buildのダウンロードを完了します。
-
Switch Buildボタンがビルドチャネルの右隅側で利用可能になります。
-
Switch Buildをクリックします。これらのビルドチャネルでヘッドとして設定されたビルドのリスト(ビルド履歴のヘッド)が表示されます。
-
検索ボックスにビルド名を入力して、ヘッド履歴から特定のビルドを検索できます。
-
現在のビルド以外のビルド名をクリックします。
-
ADT Webは、切り替え先のビルドに必要なダウンロードサイズを計算します。すでにキャッシュが利用可能な場合、更新後の合計サイズは0になります。
-
Switchボタンをクリックして、ビルドチャネルHeadを変更します。
-
ADT Webは即座にステージングプロセスを実行します。
-
ビルドチャネルヘッドが変更され、プレイできます。
起動引数
CLIから追加
起動引数は、--launch-argumentパラメータを追加することで、スマートビルドアップロードコマンドの実行中にCLIから追加できます。
Versionページから追加
Versionページから起動引数を追加する方法については、起動引数を参照してください。
ローカル起動引数から追加
Local launch argumentsページから起動引数を追加する方法については、起動引数を参照してください。
自動更新と自動再生
この機能の詳細については、自動更新、デプロイ、遅延を参照してください。
現在のスマートビルドの制限
スマートビルドは、ドラッグアンドドロップ機能を完全にはサポートしていません。
FAQ
Q: 複数のビルドを同時にダウンロードできますか?
A: いいえ。ビルドをダウンロードすると、システムは次のダウンロードをキューに入れます。最初のダウンロードが完了またはキャンセルされると、次のダウンロードが開始されます。
Q: ダウンロードプロセス中にキャッシュディレクトリを変更できますか?
A: いいえ。キャッシュディレクトリはダウンロードプロセスの前または後に変更することをお勧めします。これにより、エラーやキャッシュの欠落を防ぎ、ダウンロードを最初からやり直す必要がなくなります。
Q: エラーメッセージが表示された場合、ログはどこで見つけることができますか?
A: ログはC:\Users\<Username>\.blackbox\diagnostic\<operation ID>にあります。ユーザーがoperation IDを指定しない場合、CLIは自動的に生成します。
Q: CLIコマンドを実行する前にoperation IDパラメータを定義する目的は何ですか?
A: operation IDを定義することで、関連するCLIコマンドプロセスのログを単一のフォルダにまとめて保持できます。
Q: temp-path機能は、パッケージファイルの前処理プロセスをどのように高速化できますか?
A: UCAS/PAKの再パッケージ化プロセスは、メモリとディスクの仕様に大きく依存しています。デフォルトでは、CLIはC:\Users\<Username>\AppDataのフォルダを使用します。十分なスペースがあるディスクに一時フォルダの場所を指定することで、再パッケージ化プロセスをよりスムーズに実行できます。