Configure the Unity SDK
Configure ADT Crash Reporter
Once you've installed the ADT Unity plugins to your game project, you need to configure the plugin's properties so that ADT can record from which build does the crash come from.
-
Click on the BlackBox menu on the Taskbar.
-
Hover to the sub-menu and select Properties. A pop-up window will appear.
-
Fill out the following fields:
a. Namespace: your namespace acquired during registration to ADT.
b. API Key: ADT game's namespace acquired during setup wizard through ADT. (This API Key only shown once during creation, If it's lost, you can create another from the ADT Web's Game Settings. Check this Manage API Key document to learn more.)
c. Game Version id: Your version id acquired when you runversion add
command on ADT CLI.
d. Game Build id: Your build id acquired when you runbuild register
command on ADT CLI.
e. Base URL: Fill this with https://blackbox.accelbyte.io
f. Is Auto Initialize: Check this to allow the SDK to automatically run the plugins when the game runs.
g. Enable Logs: Check this to collect the crash logs and display it in the ADT Web.
h. Capture Exceptions: Enable this to allow the SDK to automatically detect and record errors (exceptions) that occur while the application is running.
i. Crash Config Option: Select the web settings to follow your game setting from ADT Web.
j. Enable Basic Profiling: Enable this to capture the basic profiling when a session is in motion.
k. Enable Crash Reporter: Check this to enable the Crash Reporter in the SDK.
l. Store Hardware Information: Enable this to collect the user's hardware information so that you can isolate the crash to a certain GPU issue or other hardware issue.
m. Debug Platform: DebugPlatform tells BlackBox whether the game is running in the Editor or as a Package Build. Use default so that the usage depends on the state of the build. -
Click on the Save config button to keep the changes.
Configure the Issue Reporter
The issue reporter that comes with the SDK is used to capture any moments within the game and report it to the developer. Please note that Issue Reporter only works on Windows platform. To enable this, follow the instructions:
- Check the Enable Issue Reporter
- Select the Issue Reporter Hotkey
a. Click on the Key field box then press the available hotkey from your keyboard.
b. Alt Check the Alt to combine the Alt button with the hotkey to trigger Issue Reporter.
c. Ctrl Check the Ctrl to combine the Ctrl button with the hotkey to trigger Issue Reporter.
d. Shift Check the Shift to combine the Shift button with the hotkey to trigger Issue Reporter.
e. Include Log in Issue Reporter: Check this to include the game logs in the Issue Reporter. - Click on the Save config button to keep the changes.