feat: android/ios attributes (#106)

Author: bobbyg603

README.md

@@ -82,6 +82,10 @@ To enable crash reporting, ensure the `Enable iOS Crash Reporting` and `Enable A
 
 Note that sometimes iOS applications won't crash while the USB cable is connected. If this happens, disconnect the USB cable and re-run the application to trigger a crash.
 
+> [!NOTE]
+> The Unreal iOS project's build process includes a `Build Phase called Generate dSYM for archive, and strip`, which executes after the Unreal PostBuildSteps. However, this Build Phase must complete before the `dSYM` file (debug symbols) is generated. Due to this timing, BugSplat cannot upload the `dSYM` immediately during the initial build. Instead, BugSplat will upload the `dSYM` during the next incremental build in Xcode. Alternatively, you can follow the [example](https://github.com/BugSplat-Git/bugsplat-apple/blob/main/Symbol_Upload_Examples/Build-Phase-symbol-upload.sh) in our bugsplat-apple repo to configure your a custom Build Phase for symbol uploads.
+
+
 ### Xbox and PlayStation
 
 BugSplat can provide instructions for implementing Unreal crash reporting on Xbox and PlayStation. Please email us at [[email protected]](mailto:[email protected]) for more info.

Source/BugSplatRuntime/BugSplatRuntime.Build.cs

@@ -63,20 +63,29 @@ public BugSplatRuntime(ReadOnlyTargetRules Target) : base(Target)
 
 		if (Target.Platform == UnrealTargetPlatform.IOS)
 		{
-			PublicAdditionalFrameworks.Add(new Framework("Bugsplat", "../ThirdParty/IOS/Bugsplat.embeddedframework.zip", ""));
+			// Path to the framework directory
+			string FrameworkPath = Path.Combine(ModuleDirectory, "../ThirdParty/IOS");
 
+			// Add the framework (unzipped from .embeddedframework.zip by UPL)
+			PublicAdditionalFrameworks.Add(new Framework("BugSplat", Path.Combine(FrameworkPath, "BugSplat.embeddedframework.zip"), ""));
+
+			// Add the framework's Headers directory to the include path
+			PublicIncludePaths.Add(Path.Combine(FrameworkPath, "BugSplat.framework/Headers"));
+
+			// Dependencies
 			PrivateDependencyModuleNames.AddRange(new string[] { "Launch" });
-			string PluginPath = Utils.MakePathRelativeTo(ModuleDirectory, Target.RelativeEnginePath);
 
-			AdditionalPropertiesForReceipt.Add("IOSPlugin", Path.Combine(PluginPath, "Bugsplat_IOS_UPL.xml"));
+			// UPL path
+			string PluginPath = Utils.MakePathRelativeTo(ModuleDirectory, Target.RelativeEnginePath);
+			AdditionalPropertiesForReceipt.Add("IOSPlugin", Path.Combine(PluginPath, "BugSplat_IOS_UPL.xml"));
 		}
 
 		if (Target.Platform == UnrealTargetPlatform.Android)
 		{
 			PublicDependencyModuleNames.AddRange(new string[] { "Launch" });
 			string PluginPath = Utils.MakePathRelativeTo(ModuleDirectory, Target.RelativeEnginePath);
 
-			AdditionalPropertiesForReceipt.Add("AndroidPlugin", Path.Combine(PluginPath, "Bugsplat_Android_UPL.xml"));
+			AdditionalPropertiesForReceipt.Add("AndroidPlugin", Path.Combine(PluginPath, "BugSplat_Android_UPL.xml"));
 
 			PublicDefinitions.Add("DOXYGEN=0");
 		}

…BugSplatRuntime/Bugsplat_Android_UPL.xml …BugSplatRuntime/BugSplat_Android_UPL.xmlSource/BugSplatRuntime/Bugsplat_Android_UPL.xml renamed to Source/BugSplatRuntime/BugSplat_Android_UPL.xml Source/BugSplatRuntime/Bugsplat_Android_UPL.xml renamed to Source/BugSplatRuntime/BugSplat_Android_UPL.xml

@@ -127,8 +127,8 @@
 
     <proguardAdditions>
         <insert>
-            -keep class com.bugsplat.android.BugSplatBridge { *; }
-            -keepclassmembers class com.bugsplat.android.BugSplatBridge { *; }
+            -keep class com.bugsplat.android.BugSplat { *; }
+            -keepclassmembers class com.bugsplat.android.BugSplat { *; }
         </insert>
     </proguardAdditions>
 </root>

…rce/BugSplatRuntime/Bugsplat_IOS_UPL.xml …rce/BugSplatRuntime/BugSplat_IOS_UPL.xmlSource/BugSplatRuntime/Bugsplat_IOS_UPL.xml renamed to Source/BugSplatRuntime/BugSplat_IOS_UPL.xml Source/BugSplatRuntime/Bugsplat_IOS_UPL.xml renamed to Source/BugSplatRuntime/BugSplat_IOS_UPL.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <root>
     <init>
-        <log text="Bugsplat SDK iOS UPL initialization"/>
-        <copyDir src="$S(PluginDir)/../ThirdParty/IOS/Bugsplat.framework" dst="$S(BuildDir)/Frameworks/Bugsplat.framework" />
+        <log text="BugSplat SDK iOS UPL initialization"/>
+        <copyDir src="$S(PluginDir)/../ThirdParty/IOS/BugSplat.framework" dst="$S(BuildDir)/Frameworks/BugSplat.framework" />
 
         <setBoolFromProperty result="bEnableCrashReporting" ini="Engine" section="/Script/BugSplatRuntime.BugSplatEditorSettings" property="bEnableCrashReportingIos" default="true" />
         <setBoolFromProperty result="bUploadSymbols" ini="Engine" section="/Script/BugSplatRuntime.BugSplatEditorSettings" property="bUploadDebugSymbols" default="true" />
@@ -14,10 +14,10 @@
     <iosPListUpdates>
         <if condition="bEnableCrashReporting">
             <true>
-                <setElement result="BugsplatServerURLKey" xml="&lt;key&gt;BugsplatServerURL&lt;/key&gt;"/>
-                <addElement tag="dict" name="BugsplatServerURLKey" />
-                <setElement result="BugsplatServerURLValue" xml="&lt;string&gt;https://$S(DatabaseName).bugsplat.com/&lt;/string&gt;"/>
-                <addElement tag="dict" name="BugsplatServerURLValue" />
+                <setElement result="BugSplatDatabaseKey" xml="&lt;key&gt;BugSplatDatabase&lt;/key&gt;"/>
+                <addElement tag="dict" name="BugSplatDatabaseKey" />
+                <setElement result="BugSplatDatabaseValue" xml="&lt;string&gt;$S(DatabaseName)&lt;/string&gt;"/>
+                <addElement tag="dict" name="BugSplatDatabaseValue" />
                 <setElement result="CFBundleVersionKey" xml="&lt;key&gt;CFBundleVersion&lt;/key&gt;"/>
                 <addElement tag="dict" name="CFBundleVersionKey" />
                 <setElement result="CFBundleVersionValue" xml="&lt;string&gt;$S(VersionNumber)-ios&lt;/string&gt;"/>