Merge pull request #34 from GameAnalytics/v3.0.0

[WIP] Major Release v3.0.0

Author: dorin-ga

.gitignore

@@ -6,13 +6,15 @@
 *.d
 *.apk
 *.bc
+/.vscode
 
 /builds
 .project
 .settings
 
 # Godot 4+ specific ignores
 .godot/
+*.dblite
 
 # Godot-specific ignores
 .import/
@@ -25,4 +27,40 @@ export_presets.cfg
 # Mono-specific ignores
 .mono/
 data_*/
-mono_crash.*.json
+mono_crash.*.json
+
+# android
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Log/OS Files
+*.log
+
+# Android Studio generated files and folders
+captures/
+.externalNativeBuild/
+.cxx/
+*.aab
+*.apk
+output-metadata.json
+
+# IntelliJ
+*.iml
+.idea/
+misc.xml
+deploymentTargetDropDown.xml
+render.experimental.xml
+
+# Keystore files
+*.jks
+*.keystore
+
+# Google Services (e.g. APIs or Firebase)
+google-services.json
+
+# Android Profiling
+*.hprof

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "godot-cpp"]
+	path = godot-cpp
+	url = https://github.com/godotengine/godot-cpp/
+	branch = 4.5

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 GameAnalytics
+Copyright (c) 2026 GameAnalytics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,22 +1,85 @@
 # GA-SDK-GODOT
 GameAnalytics SDK for Godot.
 
-For Android, iOS and OSX you can also get the SDK via Nativelib like described [here](https://github.com/GameAnalytics/godot-gameanalytics).
-
 Documentation is located [here](https://gameanalytics.com/docs/item/godot-sdk).
 
 If you have any issues or feedback regarding the SDK, please contact our friendly support team [here](https://gameanalytics.com/contact).
 
-> :information_source:
->
-> The Godot SDK include support for **iOS**, **Android**, **Web**, **Windows**, **Mac** and **Linux** platforms
->
-> Requirements:
-> * **Godot:** 4.0+   
+## Supported Platforms
+
+- Windows
+- MacOS
+- Linux
+- Android
+- iOS
+- Web
+
+## Requirements
+
+- Godot 4.5 or newer
+- SCons
+- Python 3.6 or newer
+
+## Compilation
+
+Run the following command in the trunk of the cloned repository with the desired platform and configuration:
+
+```sh
+python ./build.py [platform] [debug or release]
+```
+
+Afterwards, you can open the `example/project.godot` project. The resulting `.gdextension` can be found in `example/addons/GameAnalytics`.
+
+## Usage
+
+After building the gdextension for your platform, you can copy the `example/addons/GameAnalytics` folder to your own project `your_project/addons/GameAnalytics`.
+
+Inisde `Project Settings -> Plugins` enable the `GameAnalytics` plugin.
 
-Changelog
+### Windows, Linux and MacOS
+
+No additional steps are necessary, the plugin can also be used directly from within the editor.
+
+### iOS
+
+Export the project for iOS.
+
+### Android
+
+In the `Project` menu run `Install Android Build Template...`. Afterwards you will be able to export the plugin to Android.
+
+### Web
+
+In the `Export` dialog, add the following line in `HTML -> Head Include`:
+
+```js
+<script src="GameAnalytics.js"></script>
+```
+
+<br/>
+
+## Changelog
 ---------
 <!--(CHANGELOG_TOP)-->
+**3.0.0**
+* support for Godot 4.5
+* migrate plugin to .gdextension
+* add Health Event functionality for Desktop (Windows, Linux, MacOS), Android and iOS platforms
+* add support for Remote Configurations v2 with json support
+* add functionality to set/retrieve external user id (getExternalUserId, setExternalUserid)
+* add missing A/B test functions: getABTestingId, getABTestingVariantId
+* add possibility to set a custom writable path for Desktop platforms
+* add playtime tracking support
+* add option to enable/disable randomized user id on platform that support it
+* update GameAnalytics dependencies for Desktop (v5.1.0), iOS (v5.0.0) and Android (v7.0.1)
+* add mandatory arguments for addEvent functions, keep dictionary argument for optional values
+* expose all functions to gdscript
+* use GAWrapper to handle different platforms (keep it in line with GameAnalytics Unreal SDK)
+* rewritten the whole Android plugin implementation
+* remove requirement to manually call onQuit
+* update dependency management
+* various bug fixes
+
 **2.4.0**
 * support for godot 4.0+
 

SConstruct

@@ -0,0 +1,116 @@
+#!/usr/bin/env python
+import os
+import sys
+from glob import glob
+
+env = SConscript("godot-cpp/SConstruct")
+
+sources = Glob("src/gameanalytics/*.cpp")
+
+platform_path = 'src'
+libname = ''
+
+target = 'debug'
+
+if env['target'] == 'template_release':
+    target = 'release'
+
+binpath = 'bin/{}/{}'.format(env['platform'], target)
+libpath = "src/libs"
+
+################################
+
+# iphone
+if env['platform'] == 'ios':
+    sources.append("src/ios/GAWrapperIOS.mm")
+    platform_path = os.path.join(platform_path, 'ios')
+    
+    framework_path = "src/libs/iOS/GameAnalytics.xcframework/ios-arm64"
+    framework_headers = os.path.join(framework_path, "GameAnalytics.framework", "Headers")
+    env.Append(CCFLAGS=["-I{}".format(framework_headers)])
+    env.Append(LINKFLAGS=[
+        "-ObjC",
+        "-framework", "AdSupport",
+        "-framework", "SystemConfiguration",
+        "-framework", "AppTrackingTransparency",
+        "-framework", "GameAnalytics",
+        "-l", "sqlite3",
+        "-l", "z"
+    ])
+
+# android
+if env['platform'] == 'android':
+    sources.append("src/android/GAWrapperAndroid.cpp")
+    libname = '{}/libGodotGameAnalytics{}'.format(binpath, env["SHLIBSUFFIX"])
+    platform_path = os.path.join(platform_path, 'android')
+    env.Append(LINKFLAGS=["-llog"])
+
+# desktop
+if env["platform"] == "windows" or env["platform"] == "macos" or env["platform"] == "osx" or env["platform"] == "linux":
+    sources.append("src/desktop/GAWrapperCpp.cpp")
+    libname = '{}/libGodotGameAnalytics{}'.format(binpath, env["SHLIBSUFFIX"])
+    platform_path = os.path.join(platform_path, 'desktop')
+
+    env.Append(LIBS=["GameAnalytics", "curl", "ssl"])
+
+    libpath = os.path.join(libpath, env['platform'])
+
+    if(env["platform"] == "windows"):
+        env.Append(LIBS=[
+            "user32",
+            "kernel32",
+            "advapi32",
+            "ws2_32",
+            "bcrypt",
+            "crypt32",
+            "secur32",
+            "shell32",
+            "Ole32",
+            "eay32",
+            "ssleay32"
+        ])
+
+    if(env['platform'] == 'linux'):
+        env.Append(LIBS=["crypto"])
+
+    if(env["platform"] == "macos"):
+        env.Append(LINKFLAGS=[
+            "-framework", "CoreFoundation",
+            "-framework", "Foundation",
+            "-framework", "CoreServices",
+            "-framework", "SystemConfiguration",
+            "-framework", "Metal",
+            "-framework", "MetalKit"
+            ])
+        env.Append(LIBS=["crypto"])
+
+# web
+if env["platform"] == "web":
+    sources.append("src/web/GAWrapperWeb.cpp")
+    libname = '{}/libGodotGameAnalytics{}'.format(binpath, env["SHLIBSUFFIX"])
+    platform_path = os.path.join(platform_path, 'web')
+
+#################################
+
+env.Append(CPPPATH=["src/gameanalytics",
+    platform_path,
+    'godot-cpp/godot_headers/', 
+    'godot-cpp/include/', 
+    'godot-cpp/include/core/', 
+    'godot-cpp/include/gen/'])
+
+env.Append(LIBPATH=[libpath, os.path.join(libpath, '3rdParty')])
+
+if env['platform'] == 'ios':
+    library = env.StaticLibrary(
+        "lib/libgameanalytics.{}.{}.a".format(
+            env["platform"], env["target"]),
+        source=sources,
+    )
+else:
+    library = env.SharedLibrary(
+        libname,
+        source=sources,
+    )
+
+Default(library)

android/.gitignore

@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

…_godot_3_2/godotgameanalytics/.gitignore android/app/.gitignoreandroid_godot_3_2/godotgameanalytics/.gitignore renamed to android/app/.gitignore android_godot_3_2/godotgameanalytics/.gitignore renamed to android/app/.gitignore

@@ -0,0 +1,45 @@
+plugins {
+    alias(libs.plugins.android.application)
+}
+
+android {
+    namespace 'com.gameanalytics.godotapp'
+    compileSdk 34
+
+    defaultConfig {
+        applicationId "com.gameanalytics.godotapp"
+        minSdk 24
+        targetSdk 34
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+
+        debug {
+            minifyEnabled false
+            debuggable true
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+dependencies {
+
+    implementation libs.appcompat
+    implementation libs.material
+    testImplementation libs.junit
+    androidTestImplementation libs.ext.junit
+    androidTestImplementation libs.espresso.core
+}

android/app/build.gradle

@@ -0,0 +1,26 @@
+package com.gameanalytics.godotapp;
+
+import android.content.Context;
+
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.junit.Assert.*;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class ExampleInstrumentedTest {
+    @Test
+    public void useAppContext() {
+        // Context of the app under test.
+        Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
+        assertEquals("com.gameanalytics.godotapp", appContext.getPackageName());
+    }
+}