GameFrameX GameAnalytics

All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams

Documentation · Quick Start · QQ Group: 467608841 / 233840761

English | 简体中文 | 繁體中文 | 日本語 | 한국어

Project Overview

GameFrameX GameAnalytics Component - Provides game developers with an interface for integrating and using game analytics functionality. This component wraps the GameAnalytics SDK to offer event tracking, timer functionality, and custom event reporting.

Features

• Event Tracking - Report simple events, value-based events, and custom field events
• Timer Functionality - Start and stop timers for measuring event durations
• Initialization Guard - All methods check initialization status before executing
• Custom Fields - Support for dictionary-based custom event data

Quick Start

Installation

Choose one of the following methods:

1. Edit your Unity project's Packages/manifest.json and add the scopedRegistries section:

   {
     "scopedRegistries": [
       {
         "name": "GameFrameX",
         "url": "https://gameframex.upm.alianblank.uk",
         "scopes": [
           "com.gameframex"
         ]
       }
     ],
     "dependencies": {
       "com.gameframex.unity.gameanalytics.gameanalytics": "1.1.0"
     }
   }

   scopes controls which packages are resolved through this registry. Only packages whose names start with com.gameframex will be fetched from it.

2. Add to manifest.json dependencies:

   {
      "com.gameframex.unity.gameanalytics.gameanalytics": "https://github.com/gameframex/com.gameframex.unity.gameanalytics.gameanalytics.git"
   }

3. Use Package Manager in Unity with Git URL: https://github.com/gameframex/com.gameframex.unity.gameanalytics.gameanalytics.git

4. Clone the repository into your Unity project's Packages directory. It will be loaded automatically.

Usage Notes

• Ensure the component is properly initialized before calling any methods
• If _isInit is false, no operations will be performed, ensuring events are only reported after initialization
• Event names should be representative and unique to ensure accurate data analysis

Integration Tips

• Import the namespace GameFrameX.GameAnalytics.Runtime in your project
• Ensure GameAnalyticsManager is properly instantiated and registered with GameFramework
• Use Dictionary<string, string> for custom fields

Changelog

See CHANGELOG.md for details.

Dependencies

Package	Description
(无)	-

Documentation & Resources

• Documentation

Community & Support

• QQ Group: 467608841 / 233840761

License

See LICENSE.md for license information.