Unreal Engine Plugin
You may choose to add BugSplat through the Unreal Marketplace or add the plugin to your Unreal project manually.
- 1.Navigate to your project folder containing your
- 2.Create a
Pluginsfolder if it does not already exist.
- 4.In the Unreal Editor, ensure you can access the BugSplat plugin via
Edit > Project Settingsand scroll to the
BugSplat's Unreal plugin currently supports adding crash reporting to Windows, macOS, Linux, Android, and iOS games. With a few clicks, the BugSplat plugin can be configured to automatically upload symbol files so crash report stack traces display function names and line numbers.
Next, open the BugSplat plugin menu in the Unreal Editor via
Edit > Project Settings. Scroll to the
Project Settingsand add values for
Client ID, and
BugSplat leverages Unreal's
CrashReportClientto provide crash reporting for Windows, macOS, and Linux games. Be sure to update your project settings and enable
Include Crash Reporterand
Include Debug Files in Shipping Builds:
Project Settings for Desktop Crash Reporting
CrashReportClientto post to BugSplat, the
DataRouterUrlvalue needs to be added to
bugsplat-unrealplugin automatically updates the value for
Update Engine DefaultEngine.inioption is enabled. Please note the
DataRouterUrlvalue is global and is shared across all packaged builds created by the affected engine. To override the
DataRouterUrlvalue a package build uses, you may optionally use the
Update Packaged Game INIbutton under the
In order to get function names and line numbers in crash reports, you'll need to upload your game's
.pdbfiles. To upload debug symbols for reach build, ensure that the
Enable Automatic Symbol Uploadsoption is selected. When selected, a script to execute symbol-upload will be added to the
BugSplat.uplugin. The symbol upload script will run automatically when your game is built.
In order to get function names and line numbers in your iOS crash reports, please make the following changes in the
To enable crash reporting, ensure the
Enable iOS Crash Reportingand
Enable Android Crash Reportingoptions are selected.
Note that sometimes iOS applications won't crash while the USB cable is connected. If this happens, disconnect the USB cable and re-run the application to trigger a crash.
Once you've installed the plugin, add the following C++ snippet to your game to generate a sample crash.
UE_LOG(LogTemp, Fatal, TEXT("BugSplat!"));
Run your application and submit a crash report.
On Desktops, submit a crash report via the Unreal CrashReportClient dialog that appears at crash time. We have developed a handy guide on how to customize the Unreal CrashReportClient dialog available here.
On iOS, after a crash occurs, restart the game and tap the
Send Reportoption when prompted. On Android, crashes are submitted automatically at crash time.
If everything is configured correctly, you should see something that resembles the following:
Symbolicate Crash Report on BugSplat