All plugin scripts should include copyright notice (i.e. // Copyright to BugSplat, 2022)

Per recommendation from @itustanvski

Good suggestion from a customer today

Hi,

I integrated version 0.2.5 of BugSplat Unreal plugin in UE5.1.
I see crashes and symbols correctly uploaded and parsed for Linux server builds. But I am not seeing the crash at all reported for Android.
For iOS I see the crash but it is not symbolicated.

All the settings are standard. I am currently testing with development builds.

I have tried global as well as Project specific configs to try to make it work.

I am seeing Android symbol upload process start as part of packaged builds but never completes. No error in the logs either.
Is Android symbol upload supported when running UE Editor on Mac?

I see IOS symbols upload successfully.

I do not see any logs for crash being sent from Android client run.

Bootstrap crashpad via the bugsplat-unreal plugin.

Update the Readme and website screenshots and instructions now that the plugin is located in project settings.

The Nineva team built Crashpad as a .aar for our Unity plugin. We should do the same here as well to simplify the integration.

I'm unable to cook my version of 4.26 with the BugSplat plugin without deleting the Content folder.

  LogAssetRegistry: Error: Package ../../../ShooterGame/Plugins/BugSplat/Content/UI/W_BugSplatButton.uasset has newer custom version of FortniteMain
  LogAssetRegistry: Error: Package ../../../ShooterGame/Plugins/BugSplat/Content/UI/W_BugSplatDemo.uasset has newer custom version of FortniteMain

I get the above error when using it. I can't just resave the assets either, they don't show up in the content browser at all - I can see the other plugin content, just not those widgets.

Opening the my-unreal-crasher.uproject file fails and recommends building from source. This works on Windows, but prevents users from opening the project on macOS.

Looks like script is waiting for ue4completeDebug, but in Unreal 5 that task is ueCompleteDebug.

if (task.name == 'ue4CompleteDebug' || task.name == 'ue4CompleteRelease') {
  ...
}

should be

if (
  task.name == 'ue4CompleteDebug' ||
  task.name == 'ue4CompleteRelease' ||
  task.name == 'ueCompleteDebug' ||
  task.name == 'ueCompleteRelease'
) {
  ...
}

And remove BugSplatUser and BugSplatPassword.

Currently, the user must select the WindowsNoEditor folder in their packaged game for us to correctly locate DefaultEngine.ini.

This is not specified anywhere in the UI, so we should consider:

1. Adding this to documentation and
2. Adding console logging feedback whenever we unsuccessfully modify the packaged game DefaultEngine.ini when the path is wrong.

There should be a link in the docs to the Unreal Engine help page

Update text at the top to something that is more relevant now that we support both Desktop and Mobile.

Marketplace plugin URL will be required in .uplugin for publishing as well.

Per recommendation from @itustanvski

We had a customer reach out because they were using spaces in their application name. Wrapping the application name param in quotes on the symbol upload script fixed the issue. The plugin should handle this.

Hi! Please consider replace
args.Add(FPaths::Combine(FPaths::ConvertRelativePathToFull(FPaths::ProjectDir()), "Binaries"));
with
args.Add(FPaths::Combine(FPaths::ConvertRelativePathToFull(FPaths::ProjectDir()), FString("Binaries")));

Else the "Binaries" will become unknown characters in BugSplat.bat which will cause the build failed in UE4.26

Oof

In the symbol upload script we are hardcoding the path to the project plugins directory for symbol-uploads.exe. We need to fix this path to point to the Engine plugins dir.

Bootstrap bugsplat-ios via the bugsplat-unreal plugin.

I've tried this plugin by putting the content of this repo into the Plugins/Bugsplat of my project's directory. But after running the Editor the Bugsplat menu item is not visible in the Edit context menu of the Editor.

I got the following error in my logs if that helps.

Error: Package {Project}/Plugins/BugSplat/Content/UI/W_BugSplatButton.uasset has newer custom version of FortniteMain
Error: Package {Project}/Plugins/BugSplat/Content/UI/W_BugSplatDemo.uasset has newer custom version of FortniteMain

Environment -

• Customized version of UE 4.26.1
• VS 2019
• Win 10

What I've tried -
I tried to add these assets manually into the engine content folder but couldn't add. But when I tried that with UE 4.27 I could add it to the Content folder in the editor. So I opened these two blueprints using 4.27 and created duplicates of these two assets using our customized UE 4.26. And tried replacing {Project}/Plugins/BugSplat/Content/UI/W_BugSplatButton.uasset and {Project}/Plugins/BugSplat/Content/UI/W_BugSplatDemo.uasset with the newer ones I created using 4.26. But when I start the UE 4.26.1 again I get the above error.

Any clue on whats going on ?

Suggestion from one of our favorite customers (name redacted):

I think update game ini should also be UCommandlet Commandlet (command-line applet) class.

From one of our favorite customers (name redacted):

Friend — Today at 6:51 PM
does it have the ability to set via env var ?

that was the biggest blocker I had
and why we don't use the plugin itself

bobbyg — Today at 6:54 PM
i'd imagine that is something we could figure out

Friend — Today at 6:54 PM
🤔

bobbyg — Today at 6:54 PM
which values specifically needed to be env variables?

Friend — Today at 6:54 PM
ideally all of them pictured
clientid/secret can skip but it's NICE to have env secrets for build
then you don't need to check in secrets

bobbyg — Today at 6:55 PM
i buy that, we had been gitignoring that file
but i can see how that would be annoying for everyone else

Friend — Today at 6:55 PM
which file?
because it puts it in defaultgame I think?
can't really ignore THAT
or does it have a bugsplat specific in?

bobbyg — Today at 6:56 PM
well, i think since our sample doesn't change much, we checked in a default version of DefaultGame.ini without the ClientId and ClientSecret and then added it to gitignore

Friend — Today at 6:56 PM
ah

bobbyg — Today at 6:56 PM
but i can see how that would be annoying

This shouldn't be too difficult. It seems the Linux build outputs are LinuxNoEditor and Linux which is pretty similar to the Windows output!

My project just got stucked in ue4.26 any it's impossible to upgrade to ue5. So I'm wondering if it's possible to get bugsplat-unreal with ue4.26?

Use binary from https://github.com/BugSplat-Git/symbol-upload/releases to upload iOS symbols. We should also convert to using ClientId/ClientSecret instead of Username and Password.

The current version of Crashpad for Android does not reliably post crashes. We need to update the libraries.

Just realized that our Crashpad library init code was still using HTTP despite us adding https support.

In order to publish plugin at UE Marketplace .uplugin file should explicitly specify supported platforms and engine version. Note that last 3 UE versions have be supported (4.26, 4.27 and 5.0 atm).

Per recommendation from @itustanvski

This is the most common sticking point in integrating with BugSplat.

The vast majority of people using our Plugin do not care about the DataRouterUrl value in DefautlEngine.ini and likely don't care if we change it.

We hope anyone who cares will also understand why we changed it (and likely not need to use the plugin in the first place!)

Hello,

I noticed that the BlugSplat UE4 plugin is writing batch files into "/Plugins/BugSplat" directory. It assumes that the plugin can only be installed on this directory. Also the "Bugsplat/Scripts" folder has batch files that make this assumption, as well.

The plugin should be able to install in any directory under "Plugins". As is, it's creating artifacts in the hard coded directory mentioned.

Example: Consider that the github repo's root folder, "bugsplat-unreal", does not match the directory name the documentation say to use, "BugSplat". With UE4, It's common practice to just copy the repo of a plugin directly into "Plugins" (or even a subfolder in "Plugins")

For <= 4.25 ([BUILD_DIR]\WindowsNoEditor\Engine\Programs\CrashReportClient\Config\NoRedist)
For >= 4.26 ([BUILD_DIR]\WindowsNoEditor\Engine\Restricted\NoRedist\Programs\CrashReportClient\Config)

Packaged builds for games with dedicated servers output to different folders (and perhaps required different config locations).

Use the binaries from https://github.com/BugSplat-Git/symbol-upload/releases to upload Android .so file

Tasks

• Create Android symbol upload script that uploads unstripped intermediate .so files (eg {{gameRootDir}}/Binaries/Android/MyUnrealCrasher_Symbols_v1)
• Add symbol upload build step
• Re-enable Android symbol upload checkbox in UI

This is dependent on adding support for ClientId and ClientSecret on the iOS symbol upload endpoint.