Welcome to the bugsplat-unreal wiki!

Random development notes copied from Notion

If you can't build the MyUnrealCrasher project, ensure there are no errors running the script located in Plugins\BugSplat\Source\Scripts\BugSplat.bat.

If you see the following after running GenerateProjectFiles.bat:

PS C:\Users\bobby\Desktop\GitHub\UnrealEngine> .\GenerateProjectFiles.bat
Setting up Unreal Engine project files...
Using bundled DotNet SDK version: 6.0.302
Log file: C:\Users\bobby\Desktop\GitHub\UnrealEngine\Engine\Programs\UnrealBuildTool\Log_GPF.txt

Some Platforms were skipped due to invalid SDK setup: Mac, IOS, Linux, LinuxArm64, TVOS.
See the log file for detailed information


Generating VisualStudio project files:
Available x64 toolchains (4):
 * C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Tools\MSVC\14.38.33130
    (Family=14.38.33130, FamilyRank=0, Version=14.38.33140, Is64Bit=True, ReleaseChannel=Latest, Architecture=x64)
 * C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Tools\MSVC\14.38.33130
    (Family=14.38.33130, FamilyRank=0, Version=14.38.33140, Is64Bit=True, ReleaseChannel=Latest, Architecture=x64)
 * C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Tools\MSVC\14.36.32532
    (Family=14.36.32532, FamilyRank=2, Version=14.36.32546, Is64Bit=True, ReleaseChannel=Latest, Architecture=x64)
 * C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Tools\MSVC\14.41.34120
    (Family=14.41.34120, FamilyRank=5, Version=14.41.34120, Is64Bit=True, ReleaseChannel=Latest, Architecture=x64)
Total execution time: 0.78 seconds
Unable to find valid 14.38.33135 C++ toolchain for VisualStudio2022 x64

Delete the file "%AppData%\Roaming\Unreal Engine\UnrealBuildTool\BuildConfiguration.xml"

If you can't load the plugin, try re-generating project assets

sh "/Users/Shared/Epic Games/UE_5.0/Engine/Build/BatchFiles/Mac/GenerateProjectFiles.sh" -project="/path/to/my-unreal-crasher/MyUnrealCrasher.uproject" -game

Newer versions of Unreal Engine (5.3 and above) may encounter issues packaging CrashReportClient and third-party frameworks. See here for a nice write-up of several common issues packaging for Apple devices.

XCode likes to complain if frameworks aren't signed. To update the frameworks, build BugSplat.xcframework from the bugsplat-apple repo. Copy the iOS-arm64 BugSplat.framework variant to Source/ThirdParty/IOS. Sign this framework by running the following command:

codesign -f -s "Apple Distribution: BugSplat, LLC (TN6R4Q475K)" ./BugSplat.framework

Next, verify the signature.

codesign -dv --verbose ./BugSplat.framework

Repeat the process with HockeySDK.framework, ensuring you use a version of HockeySDK.framework that statically links libCrashReporter.a (PlCrashReporter), otherwise the build will fail with a duplicate symbols issue because Unreal statically links a copy of libCrashReporter.a.

To create the embeddedframework.zip files, create a new folder BugSplat.embeddedframework and copy BugSplat.framework into it. Zip BugSplat.embeddedframework and repeat the process for HockeySDK.embeddedframework.