Unreal Unreal logo for BugSplat

BugSplat’s Unreal Engine integration works for any Windows-based game. Other platforms are not yet supported. If you are interested in using it on other platforms, please reach out to support@bugsplat.com.

Please make sure you have completed the following checklist:

Configuration


  1. For testing purposes, configure your game to crash when some condition is met. To get the game to crash you can log a fatal error or execute the following snippet:

    *((int*) 0) = 0;

  2. Package your game, be sure to enable the Include Crash Reporter and Include Debug Files options in your build configuration:

  3. Integrating Unreal with BugSplat
    UE4_PackagingSetttings
  4. Once your game is packaged, download and unzip the BugSplatUnreal development kit. Extract the files from BugSplatUnreal.zip and copy them to /WindowsNoEditor/Engine/Binaries/Win64. Please click yes when you are prompted to overwrite the existing CrashReportClient.exe: unrealexe

  5. Modify bugsplat.config in your favorite text editor and include the name of your BugSplat database, application name and application version. You may optionally add the <additionalFilesFolder> key with a path to a folder containing additional files that will be uploaded with the crash report. Environment variables are supported in the path. For example, %TEMP%/foo will be expanded to the folder foo in the users TEMP directory. Please note that due to crash report size limitations we will only add files modified within the last hour. Also, if the total package size exceeds your crash size upload limit (default 2MB) the upload will fail.

  6. unreal3a
  7. Alternatively, BugSplat’s CrashReportClient.exe can be invoked with command line parameters in lieu of bugsplat.config. The bugsplat.config file will be ignored if the Unreal Engine calls CrashReportClient.exe with the required Database, AppName and AppVersion parameters.

    Please note that you will need to modify the Unreal Engine in order to pass additional parameters to CrashReportClient.exe. By default the Unreal Engine passes 4 parameters to CrashReportClient (crash folder, app name, crash guid, symbols location). Please do not remove or reorder the default parameters.

    The following is a list of command line parameters that are supported by CrashReportClient.exe:

      // 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>
      -AdditionalFilesFolder=<path to additional folder that will be attached to the crash report>
      -Silent=true
      -DebugToConsole=true
      -DebugToFile=true
    

    The optional -AdditionalFilesFolder argument is used to specify a path to a folder containing additional files that will be uploaded with the crash report. Environment variables are supported in the path. For example, %TEMP%/foo will be expanded to the folder foo in the users TEMP directory. Please note that due to crash report size limitations we will only add files modified within the last hour. Also, if the total package size exceeds your crash size upload limit (default 2MB) the upload will fail.

    Here’s an example that invokes CrashReportClient.exe with additional parameters:

     CrashReportClient.exe "c:/path/to/crash/folder" -AppName=MyGame -CrashGUID=UE4CC-Windows-9DF860F34631A3FCD62EC5914F5F3AF6_0000 -DebugSymbols=..\..\..\Engine\Intermediate\Symbols -Database=Fred -AppVersion=1.0.0.0 -User="Fred Flintstone" -Email="fred@bedrock.com" -Description="The description \r\n with newline support \r\n" -Silent=false
    
  8. Upload your game’s exe and pdb files. This can be done by using SendPdbs via the command line. If you run SendPdbs.exe with no parameters in the command prompt, it will display usage information that will help you upload your symbol files:

  9. Integrating Unreal with BugSplat
  10. Trigger a crash in your game. You will see a new crash appear on the AllCrash page. On the crash details page you will see a full description of the crash which includes the explanation, function names and line numbers. Good luck and happy bug crushing!

  11. unreal5

    Interested in non-Windows platforms?

    Other platforms are not yet supported, however we are planning on further integrations. If you want a specific platform please send us a note at support@bugsplat.com