Note

DEPRECATED see the new sample here.

MyUnrealCrasher

Summary

MyUnrealCrasher is a C++ project based on the Unreal Engine programming quick start tutorial that demonstrates the power of BugSplat crash reporting. A prebuilt version of this project is available here. The fastest way to evaluate BugSplat is to download and run the prebuilt version of this project. For more information about how to integrate BugSplat into your game, please see the documentation on our website.

Configuration

The following steps will configure MyUnrealCrasher to post crash reports to BugSplat. When you're prompted to log into BugSplat use the username Fred and password Flintstone:

1. Download the BugSplatUnreal SDK
2. Open MyUnrealCrasher.uproject
3. File > Package Project > Packaging Settings. Enable Include Crash Reporter and Include Debug Files
4. Package the project and make note of the output folder
5. Copy the files from the ...\BugSplatUnreal\BugSplat\bin folder to ...\WindowsNoEditor\Engine\Binaries\Win64. Confirm that you want to overwrite the existing files
6. Run SendPdbs.bat to upload symbol files to BugSplat. This will allow BugSplat to resolve function names and line numbers in the crash report
7. Run MyUnrealCrasher.exe. It should crash after 100 ticks
8. Visit the All Crashes page on BugSplat and click the Crash Id of the crash you just posted to view detailed information including the stack trace and additional files sent with your crash report
9. Replace the database value in bugsplat.config and the username, password and database values SendPdbs.bat to configure BugSplat with your database

That's it, you're well on your way to crushing your bugs and improving the stability of your game!

Command Line Invokation

BugSplat's CrashReportClient can also be configured via command line arguments in lieu of the bugsplat.config file. You can add additional command line arguments by modifying WindowsPlatformCrashContext.cpp.

The arguments BugSplat's CrashReportClient supports are:

// Required
-Database=<your database name>
-AppName=<your application name>
-AppVersion=<your application version>

// Optional
-Unattended
-User=<name of your user>
-Email=<email of your user>
-Description=<description of why crash occurred (use \r\n for newline)>
-Key=<additional application identifier>
-Silent=true

The unattended and silent arguments will supress the BugSplat dialog but still send the crash report. The user, email and description arguments will be loaded in the crash dialog as defaults, but can be overwritted by an end user. The key argument can be used to display a specific support response to your user such as a translated version of your support response based on your user's language settings.

Additional Information

The Windows Fall Creator's Update introduced a defect that affects the creation of crash reports on some Windows 10 systems. As a workaround, the prebuilt sample of this project includes older versions of dbgeng.dll, dbghelp.dll and dbgcore.dll in the same directory as MyUnrealCrasher.exe. This allows the Unreal Engine to load the working versions of these dlls instead of the broken versions in the System32 directory. More information on this issue can be found here and here.