Xboxコンソールクラッシュレポーター統合ガイド
注釈:本資料はAI技術を用いて翻訳されています。
概要
このガイドでは、Microsoft Game Development Kit(GDK)で作成したXbox Series X|S(XSX)およびXbox Oneビルドについて、devkitとプレイヤーのリテールコンソールでAccelByte Development Toolkit(ADT)Crash Reporterを有効にする方法を説明します。
ゲームがクラッシュすると、ADT SDKはクラッシュレポートをコンソールに保存します。次回ゲームが起動すると、SDKはレポートをADTに送信し、クラッシュがADT Webに表示されます。
前提条件
-
ADT SDKの統合
ADT SDKのWindows版がすでに統合されていることを確認してください。方法については、ADT SDK の統合を参照してください。
-
Unreal Engineのソースコード
Unreal EngineがEpic Games Storeからダウンロードしたものではなく、ソースからビルドしたものであることを確認してください。Epic Games Store版はコンソール開発をサポートしていません。
-
ADT SDKとCLIのバージョン
- devkitの場合:サポートされている任意のADT SDKバージョン。
- リテールコンソールの場合:ADT SDK 2.34.4以降およびADT CLI 2.31.1以降。
-
Xboxアドオン
a. ADT Webで、Game Settings > Game Integrationに移動します。
b. Target Platformセクションで、Xbox One (GDK)またはXbox Series Xを選択します。
c. ADT Downloadページから必要なアドオンをダウンロードします。
Xboxアドオンの統合
-
ダウンロードしたアドオンを解凍します。
BlackBox-UE4SDK-x64-XSX-<SDKVersion>という名前のフォルダが作成されます。 -
フォルダを開き、
BlackBoxSDKディレクトリをコピーします。 -
BlackBoxSDKディレクトリを、ゲームプロジェクトのPluginsフォルダに貼り付けます。
Xboxクラッシュレポーターを有効にする
バージョンを作成した後、次の手順に従います。バージョンの作成方法については、バージョンを作成してビルドを登録するを参照してください。
-
Xboxビルドを登録する
ターゲットプラットフォームを選択します:
a. Xbox Oneビルドの場合はxboxonegdk。
b. Xbox Series X|Sビルドの場合はxsx。
c. 次のコマンドを実行して、新しいビルドIDを追加します。この例では
xsxを使用しています:.\BlackBoxCLI.exe build register --namespace <your_namespace> --smartbuild --platform-name xsx --platform-arch x64 --apikey <your_api_key> --game-project <game_project_path> --game-engine <game_engine_path>XboxビルドはクラッシュURLではなくADT SDKを通じてクラッシュを送信するため、
crash-url setを実行する必要はありません。プレイヤーにリリースするビルドの場合は、
--release-candidateも追加します。詳細については、ライブ(リテール)クラッシュレポートを参照してください。 -
Unreal Engineを変更する(制限付き)
この手順は、MicrosoftとのNDAコンプライアンスのため、ADTカスタマーに制限されています。詳細な手順については、AccelByteサポートにお問い合わせください。
パッケージ化とアップロード
-
ゲームをパッケージ化する
a.
.uprojectファイルを開きます。b. Unreal Engine Editorで、Platform > XSX > Package Projectを選択します。
-
プログラムデータベース(PDB)ファイルをアップロードする
クックが完了したら、次のコマンドでPDBファイルをアップロードします:
.\BlackBoxCLI.exe upload --namespace <your_namespace> --game-archive <game_archive_path> --platform-name xsx --platform-arch x64 --apikey <your_api_key> --game-project <game_project_path> --game-engine <game_engine_path> -
バイナリファイルをアップロードする(ADT Hubを使用したdevkitテスト用)
ADT Hubを使用してビルドをdevkitにデプロイするには、バイナリファイルをアップロードします:
.\BlackBoxCLI.exe build upload-binaries --namespace <your_namespace> --game-archive <game_archive_path> --entry-point <the .xvc file for the game> --apikey <your_api_key> --game-project <game_project_path> --game-engine <game_engine_path>
クラッシュレポートの保存場所
SDKは、各クラッシュレポートをxboxgdk_crash_<iso8601_time>という名前のフォルダに、次のうち最初に使用可能な場所に保存します:
- ゲームのPersistent Local Storage(ゲームが確保している場合)。リテールコンソールでは必須です。
D:\(devkitのSystem Scratch)。
次回の起動時に、SDKは保存されたレポートをADTに送信し、送信後に各フォルダを削除します。SDKが保持する未送信のレポートは最大5件で、各レポートは最大256 MBです。
| 項目 | devkitの場合 | リテールコンソールの場合 |
|---|---|---|
| 保存場所 | Persistent Local Storage、またはD:\(System Scratch) | Persistent Local Storageのみ |
| クラッシュビデオ | あり | なし |
| ビルドのデプロイ | ADT HubまたはMicrosoft GDKのツール | Microsoft Partner Center |
devkitでテストする
-
ビルドをダウンロードしてデプロイする
a. ADT Hubにログインします。インストールされていない場合は、ADT Webからダウンロードしてください。
b. ChannelsまたはVersionsページに移動して、アップロードしたビルドを見つけます。
c. Downloadをクリックします。ダウンロードが完了すると、ボタンがDeployに変わります。
d. devkitを選択してビルドをデプロイします。方法については、DevKitを接続してビルドをデプロイするを参照してください。
-
クラッシュをトリガーする
a. devkitでゲームを起動し、完全に起動した後で意図的にクラッシュさせます。
b. クラッシュレポートの保存場所で説明している保存場所で、クラッシュレポートのフォルダ
xboxgdk_crash_<iso8601_time>を見つけます。 -
クラッシュレポートのアップロードを確認する
a. ゲームを再度起動して、クラッシュレポートをADTに送信します。
b. ADT WebのCrashesでクラッシュを確認します。
ライブ(リテール)クラッシュレポート
このセクションはXboxのみを対象としています。Windows、Linux、macOS、PlayStation 5については、ライブ(リテール)クラッシュレポートのページを参照してください。
リテールコンソールにはD:\ドライブがありません。プレイヤーのリテールコンソールからクラッシュを取得するには、上記の手順に加えて次の手順に従ってください。前提条件に記載されているADT SDKとCLIのバージョンを使用していることを確認してください。
1. クラッシュダンプをリテールで使用できる場所に保存する(制限付き)
Shippingビルドでは、エンジンがリテールコンソールに存在する場所にクラッシュダンプを書き込む必要があります。これはエンジンのXboxプラットフォームコードの変更であり、MicrosoftとのNDAコンプライアンスのため制限されています。手順については、AccelByteサポートにお問い合わせください。
この変更は、Xboxクラッシュレポーターを有効にするの手順2の変更とは別のものです。リテールビルドには両方の変更が必要です。両方の手順を1回の問い合わせでサポートに依頼できます。
2. Persistent Local Storageを確保する
SDKは、次回の起動までクラッシュレポートをPersistent Local Storageに保持します。これがないと、リテールコンソールからのクラッシュレポートは失われます。次のいずれかの方法で64 MBを確保してください:
-
Project Settings > Platforms > Xbox Series X|S > Featuresで、**Persistent Local Storage (MB)**を
64に設定します。Xbox Oneでもリリースする場合は、Xbox Oneでも同じ設定を行います。 -
<Project>\Platforms\XSX\Config\XSXEngine.iniに次の内容を追加します:[/Script/XSXPlatformEditor.XSXTargetSettings]
PersistentLocalStorage=64
ゲームがすでにPersistent Local Storageを使用しており、約64 MBの空きがある場合は、現在のサイズのままにしてください。タイトルアップデートでサイズを増やすと、プレイヤーのコンソール上の既存のストレージが消去されます。
3. ビルドをリリース候補として登録して準備する
このビルドからのクラッシュをADT WebでPlayersとしてラベル付けするには、ビルドをリリース候補(RC)として登録し、パッケージ化する前に準備します:
.\BlackBoxCLI.exe build register --namespace <your_namespace> --smartbuild --platform-name xsx --platform-arch x64 --apikey <your_api_key> --game-project <game_project_path> --game-engine <game_engine_path> --release-candidate
.\BlackBoxCLI.exe build prepare --namespace <your_namespace> --apikey <your_api_key> --game-project <game_project_path> --game-engine <game_engine_path>
build prepareはADT SDKを有効のままにし、Config/BlackBox.iniにLiveBuild=trueを設定します。その後、SDKはこのビルドのクラッシュをライブフラグ付きで送信します。
- ADTは、Xboxのクラッシュをコンソールではなくビルドによってラベル付けします。準備したRCビルドからのクラッシュは、devkit上でもPlayersとしてラベル付けされます。RCとして登録していないビルドを含め、それ以外のビルドからのクラッシュは、リテールコンソール上でもInternalとしてラベル付けされます。
- ラベルはビルドをパッケージ化する時点で決まります。後からADT WebでビルドをLiveに設定しても、Xboxクラッシュのラベルは変わりません。
4. パッケージ化、シンボルのアップロード、リリース
パッケージ化する前に、ビルド構成をShippingに設定します。次に、パッケージ化とアップロードの説明に従ってゲームをパッケージ化してPDBファイルをアップロードし、Microsoft Partner Centerを通じてビルドをリリースします。
5. リテールコンソールで確認する
-
リテールのXboxにビルドをインストールし、ゲームをクラッシュさせます。
-
ゲームを再度起動します。SDKはこの起動中にクラッシュレポートを送信します。
-
ゲームログで次の行を探します。
R:\は、コンソールがゲームに割り当てるPersistent Local Storageの場所で、手順2で確保したものです:LogBlackBox: [INFO] Crash storage: R:\
LogBlackBox: [INFO] Successfully sent the crashbinary: R:/xboxgdk_crash_<time> -
ADT WebでCrashesに移動し、OriginフィルターをPlayersに設定して、クラッシュを確認します。
- SDKは、クラッシュ後の次回ゲーム起動時にXboxのクラッシュレポートを送信します。
- SDKが送信したクラッシュは、Playersとしてラベル付けされたものも含めて、ネームスペースの開発用の1日あたりのクラッシュ制限にカウントされます。制限に達した場合、レポートはコンソールに残り、SDKは後の起動時に送信します。詳細については、クラッシュ制限管理を参照してください。