Unreal Engine
Last updated
Was this helpful?
Last updated
Was this helpful?
BugSplat’s Unreal Engine integration supports capturing crashes on Windows, macOS, Linux, iOS, Android, Xbox, and PlayStation games. Support for the Nintendo Switch is coming soon. BugSplat also supports both Windows and Linux servers.
There are two options for configuring BugSplat. If you are integrating BugSplat for an organization that uses a dedicated build machine, please continue reading.
You must upload symbol and executable files to create symbolic call stacks on Windows platforms. The easiest way to upload files is to use our command line utility. You can download symbol-upload
.
Add a step to your build pipeline that uploads .exe
, .dll
, and .pdb
files via . We recommend creating an pair for authentication.
The appName
and appVersion
parameters will be associated with your uploaded symbols, allowing logical grouping of files within BugSplat for easier symbol management. BugSplat will automatically remove symbol stores that have not been accessed recently. See our for a description of these rules.
Package your game, and check the Include Crash Reporter and Include Debug Files options are selected in your build configuration:
If you're building via the command line, please add the -CrashReporter
flag to your build arguments to ensure CrashReportClient is included in your build output.
There are two options for configuring CrashReportClient. The first option is modifying the DefaultEngine.ini
file for an engine install or source build. Modifying the engine's config file is the easiest approach but has the downside of affecting every game you build with this version. Alternatively, you can add DefaultEngine.ini
to a specific path in your packaged build directory, which will overwrite values specified by the engine.
Unreal Editor can also be configured to send crash reports to BugSplat. To do this, add the following DefaultEngine.ini file in C:\Path\To\Engine_Install_or_Source_Checkout\Programs\CrashReportClient\Config\DefaultEngine.ini.
To configure crash uploads to your BugSplat database, create a file named DefaultEngine.ini
with the following contents:
Replace {database}
, {appName}
, and {appVersion}
with the names of your BugSplat database, application name, and version. The appName and appVersion parameters will be assigned to each crash report posted to your database, allowing you to group and filter crashes within BugSplat. These parameters should match the corresponding values used for SendPdbs.
Be sure to URL encode spaces and special characters in {appName} or {appVersion}
For capturing crashes in packaged games in Unreal Engine 4.25 and earlier, copy DefaultEngine.ini
to {{output directory}}\Engine\Programs\CrashReportClient\Config\NoRedist
making sure to create folders that don't exist (where{{output directory}}
is the location of your packaged build).
For capturing crashes in packaged games in Unreal Engine 4.26 and newer, copyDefaultEngine.ini
to {{output directory}}\Engine\Restricted\NoRedist\Programs\CrashReportClient\Config
making sure to create folders that don't exist (where{{output directory}}
is the location of your packaged build).
If DefaultEngine.ini
already exists, add the snippet above anywhere in the file. There are multiple DefaultEngine.ini
files in your tree. Ensure you edit the right DefaultEngine.ini file; otherwise, crash reports will not be sent to BugSplat.
Run your game. For testing, a crash can be forced from the console using the command "debug crash". After posting the crash report, log in to BugSplat to view the report.
The default CrashReportClient contains text explaining to the user that the crash reports are being sent to Epic. However, by overwriting the CrashReportClient configuration settings, crash reports are instead sent to BugSplat. It is a good idea to change the text and rebuild CrashReportClient. Customizing CrashReportClient requires rebuilding the engine source.
Special instructions for Linux servers:
Package the crash reporter with your Linux server build by adding the -CrashReporter
flag to PackageBuildLinuxServer.bat
Force a test crash by running your server executable with the option -ExecCmds="debug crash"
To upload crash reports to BugSplat, recompile with bSendUnattendedBugReports = true
.
The following XML fields, if created as child properties of RuntimeProperties
or GameData
can be used to set the BugSplat crash Notes and Key fields.
BugSplatNotes
Sets the value of the crash Notes field
BugSplatApplicationKey
Sets the value of the crash Key field
Sending crash reports to BugSplat can be done via a simple configuration change to Unreal Engine's .
Please see our for more information on how to .
Symbolic call stacks are resolved if you deploy symbols on your server. This is the typical case. However, if symbols aren't available locally, upload the Unreal Linux custom symbol files (.psym
extension) using .
You will need to configure to capture iOS crash reports. Additionally, you'll need to upload .dSYM
files for function names and line numbers to be included in crash reports. Symbol files can be uploaded automatically by invoking .
You will need to configure to capture Android crash reports. Additionally, you'll need to generate symbol files from your .so
files for function names and line numbers to be included in crash reports. Symbol files can be generated and uploaded automatically by invoking with the -m
flag.
Some forks of Unreal (e.g., Oculus) are set up as a "Licensee" build. Regardless of other settings, crash reports won't be sent because of this :
BugSplat extracts metadata from the CrashContext.runtime-xml
file attached to Unreal Engine crash reports and convert those values into that can be displayed in the web application. See the for information on adding additional data.
All other properties will be parsed as .