Enable the ADT Crash Reporter in a Game Server Build

Last updated on October 23, 2024

Overview

This guide shows you how to enable the AccelByte Development Toolkit (ADT) Crash Reporter and upload a server build's debug symbol. This allows you to get crash reporting from a server build with a valid stack trace.

Prerequisite

Ensure that Unattended Crash Reporting is properly set up.

info

The example commands in this guide do not use inline configuration. If you use inline configuration, adjust your commands accordingly. Read more about inline configuration here.

Enable ADT Crash Reporter

Follow these steps:

1. Call version add.

   BlackBoxCLI.exe version add --name <your version name>

2. Call build register with linux-server or windows-server as the platform name.

   BlackBoxCLI.exe build register --platform-name linux-server --platform-arch x64

3. Build and package your game server.

Upload the game server debug symbols

Follow these steps:

1. Use this command to upload the debug symbols for the game server build:

   info

   Use --game-server-archive instead of --game-archive when uploading debug symbols for the game server build.

   BlackBoxCLI.exe upload --platform-name linux-server --platform-arch x64 --game-server-archive <path to game server packaged build>

2. When you run the game server, add -unattended in the command line. For example:

   MyGameServer.sh MyGameMap -unattended 

Upload the game client debug symbols

note

Upload the game server first, before you do these steps.

To upload the game client's debug symbols under the same project, follow these steps:

1. Call build register and add your platform name (windows/linux/any game consoles) as the --platform-name.

   BlackBoxCLI.exe build register --platform-name linux --platform-arch x64

2. Build and package your game client.

3. Upload the debug symbols for the game client.

   BlackBoxCLI.exe upload --platform-name linux --platform-arch x64 --game-archive <path to game client packaged build>