# com.gameframex.unity
**Repository Path**: dotlive/com.gameframex.unity
## Basic Information
- **Project Name**: com.gameframex.unity
- **Description**: GameFrameX - An all-in-one game framework for Unity providing comprehensive systems including asset management, event handling, UI, networking, audio, and more for indie game developers
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-26
- **Last Updated**: 2026-05-26
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# GameFrameX Unity Package
[](https://github.com/GameFrameX/com.gameframex.unity)
[](https://unity3d.com/get-unity/download)
[](LICENSE.md)
[](https://gameframex.doc.alianblank.com)
**All-in-One Solution for Indie Game Development ยท Empowering Indie Developers' Dreams**
[๐ Documentation](https://gameframex.doc.alianblank.com) โข [๐ Quick Start](#quick-start) โข [๐ฌ QQ Group: 467608841](https://qm.qq.com/cgi-bin/qm/qr?k=sYFd1nv6m2KZIWFLorZ5pBR0AE5ZhbuL&jump_from=webapi&authKey=oCu+uoL3n35fT5SEt7iLgGtROPxh31n/rHUxRlp0w1f+j38W4tKBuWyRH3KEdwHN)
---
๐ **Language**: **English** | [็น้ซไธญๆ](./README.zh-TW.md) | [็ฎไฝไธญๆ](./README.zh-CN.md) | [ๆฅๆฌ่ช](./README.ja.md) | [ํ๊ตญ์ด](./README.ko.md)
---
## ๐ Table of Contents
- [๐๏ธ Project Overview](#๐๏ธ-project-overview)
- [๐ Architecture](#๐-architecture)
- [Runtime Module](#-runtime-module)
- [Plugins Module](#-plugins-module)
- [Editor Module](#-editor-module)
- [๐ Quick Start](#๐-quick-start)
- [๐ก Usage Examples](#๐ก-usage-examples)
- [Runtime Examples](#runtime-usage-examples)
- [Editor Tools](#editor-tools)
- [๐ฏ Platform Support](#๐ฏ-platform-support)
- [๐ Documentation & Resources](#๐-documentation--resources)
- [๐ค Community & Support](#๐ค-community--support)
- [๐ License](#๐-license)
---
## ๐๏ธ Project Overview
GameFrameX is a modern Unity game framework designed for independent game developers, providing a complete end-to-end solution for game development. The framework follows a **three-layer modular architecture** design with rich built-in game development tools and components, helping developers quickly build high-quality game projects.
### ๐ฏ Key Features
- ๐๏ธ **Three-Layer Architecture** - Clear separation: Runtime, Plugins, and Editor
- ๐ง **Rich Toolset** - Built-in development aids and editor extensions
- ๐ฆ **Object Pool Management** - Efficient memory management and object reuse
- ๐จ **Extension Methods Library** - Extensive Unity engine extensions
- ๐ ๏ธ **Utility Classes** - Encryption, compression, networking, and more
- ๐ฑ **Multi-Platform Support** - PC, Mobile, WebGL and more
- ๐ฅ **Hotfix Support** - Built-in HybridCLR hotfix solution
- ๐ฎ **Mini Game Adaptation** - One-click switch between multiple mini game platforms
### ๐ System Requirements
- **Unity Version**: 2019.4 or higher
- **Platform Support**: Windows, macOS, Linux, iOS, Android, WebGL
- **.NET Version**: .NET Standard 2.0+
---
## ๐ Architecture
GameFrameX uses a clear three-layer architecture design, with each module having its own responsibilities and working together.
### ๐ฆ Runtime Module
Core runtime code providing all functionality needed for game runtime.
```
Runtime/
โโโ Base/ # Framework Core Foundation
โ โโโ DataStruct/ # Data Structures
โ โ โโโ TypeNamePair.cs # Type Name Pair
โ โโโ EventPool/ # Event Pool System
โ โ โโโ BaseEventArgs.cs # Base Event Args
โ โ โโโ EventPool.EventNode.cs # Event Node
โ โ โโโ EventPool.cs # Event Pool Core
โ โ โโโ EventPoolMode.cs # Event Pool Mode
โ โโโ Log/ # Logging System
โ โ โโโ GameFrameworkLog.ILogHelper.cs # Log Interface
โ โ โโโ GameFrameworkLog.cs # Log Core
โ โ โโโ GameFrameworkLogLevel.cs # Log Level
โ โโโ ReferencePool/ # Reference Pool System
โ โ โโโ IReference.cs # Reference Interface
โ โ โโโ ReferencePool.ReferenceCollection.cs # Reference Collection
โ โ โโโ ReferencePool.cs # Reference Pool Core
โ โ โโโ ReferencePoolInfo.cs # Reference Pool Info
โ โโโ TaskPool/ # Task Pool System
โ โ โโโ ITaskAgent.cs # Task Agent Interface
โ โ โโโ StartTaskStatus.cs # Task Status
โ โ โโโ TaskBase.cs # Task Base
โ โ โโโ TaskInfo.cs # Task Info
โ โ โโโ TaskPool.cs # Task Pool Core
โ โ โโโ TaskStatus.cs # Task Status
โ โโโ Variable/ # Variable System
โ โ โโโ GenericVariable.cs # Generic Variable
โ โ โโโ Variable.cs # Variable Base
โ โโโ Version/ # Version Management
โ โ โโโ Version.IVersionHelper.cs # Version Interface
โ โ โโโ Version.cs # Version Core
โ โโโ BaseComponent.cs # Base Component
โ โโโ GameEntry.cs # Game Entry
โ โโโ GameFrameworkComponent.cs # Framework Component
โ โโโ GameFrameworkEntry.cs # Framework Entry
โ โโโ GameFrameworkEventArgs.cs # Framework Event Args
โ โโโ GameFrameworkException.cs # Framework Exception
โ โโโ GameFrameworkGuard.cs # Framework Guard
โ โโโ GameFrameworkLinkedList.cs # Linked List
โ โโโ GameFrameworkLinkedListRange.cs # Linked List Range
โ โโโ GameFrameworkModule.cs # Framework Module
โ โโโ GameFrameworkMonoSingleton.cs # Mono Singleton
โ โโโ GameFrameworkMultiDictionary.cs # Multi-Value Dictionary
โ โโโ GameFrameworkSerializer.cs # Serializer
โ โโโ GameFrameworkSingleton.cs # Singleton Base
โ โโโ ObjectDontDestroyOnLoad.cs # Scene Persistent Object
โ โโโ ShutdownType.cs # Shutdown Type
โโโ Extension/ # Extension Methods Library
โ โโโ Extension/ # Common Extensions
โ โ โโโ BidirectionalDictionary.cs # Bidirectional Dictionary
โ โ โโโ BinaryExtension.cs # Binary Extension
โ โ โโโ BufferExtension.cs # Buffer Extension
โ โ โโโ CollectionExtensions.cs # Collection Extensions
โ โ โโโ DateTimeExtensions.cs # DateTime Extension
โ โ โโโ ObjectExtension.cs # Object Extension
โ โ โโโ SpanExtension.cs # Span Extension
โ โ โโโ StringExtensions.cs # String Extensions
โ โ โโโ ThreadLocalRandom.cs # Thread Local Random
โ โ โโโ TypeExtensions.cs # Type Extensions
โ โโโ SequenceReader/ # Sequence Reader
โ โ โโโ SequenceReader.cs # Sequence Reader Core
โ โ โโโ SequenceReaderExtensions.cs # Sequence Reader Extensions
โ โโโ UnityEngage.GameObject/ # GameObject Extension
โ โ โโโ UnityEngage.GameObjectExtension.cs # GameObject Extension
โ โโโ UnityEngine/ # Unity Type Extensions
โ โโโ Transform/ # Transform Extension
โ โโโ Vector2/ # Vector2 Extension
โ โโโ Vector3/ # Vector3 Extension
โ โโโ Vector4/ # Vector4 Extension
โโโ Helper/ # Helper Classes
โ โโโ ApplicationHelper.cs # Application Helper
โ โโโ CameraHelper.cs # Camera Helper
โ โโโ DefaultCompressionHelper.cs # Default Compression Helper
โ โโโ DefaultLogHelper.cs # Default Log Helper
โ โโโ DefaultTextHelper.cs # Default Text Helper
โ โโโ DefaultVersionHelper.cs # Default Version Helper
โ โโโ DistinctHelper.cs # Distinct Helper
โ โโโ DoTweenHelper.cs # DoTween Animation Helper
โ โโโ FileHelper.cs # File Helper
โ โโโ GameObjectHelper.cs # GameObject Helper
โ โโโ Helper.cs # Helper Base Class
โ โโโ MathHelper.cs # Math Helper
โ โโโ NetworkHelper.cs # Network Helper
โ โโโ NewtonsoftJsonHelper.cs # Newtonsoft JSON Helper
โ โโโ ObjectHelper.cs # Object Helper
โ โโโ PathHelper.cs # Path Helper
โ โโโ PositionHelper.cs # Position Helper
โ โโโ RandomHelper.cs # Random Helper
โ โโโ TimerHelper/ # Timer Helper
โ โ โโโ TimerHelper.cs # Timer Core
โ โ โโโ TimerHelper.Current.cs # Current Time
โ โ โโโ TimerHelper.Day.cs # Day Calculation
โ โ โโโ TimerHelper.Difference.cs # Time Difference
โ โ โโโ TimerHelper.Month.cs # Month Calculation
โ โ โโโ TimerHelper.Range.cs # Time Range
โ โ โโโ TimerHelper.TimeOffset.cs # Time Offset
โ โ โโโ TimerHelper.Timestamp.cs # Timestamp
โ โ โโโ TimerHelper.Week.cs # Week Calculation
โ โ โโโ TimerHelper.Year.cs # Year Calculation
โ โโโ UnityRendererHelper.cs # Unity Renderer Helper
โ โโโ ZipHelper.cs # ZIP Compression Helper
โโโ ObjectPool/ # Object Pool System
โ โโโ IObjectPool.cs # Object Pool Interface
โ โโโ ObjectBase.cs # Object Pool Base
โ โโโ ObjectPoolComponent.cs # Object Pool Component
โโโ Property/ # Property System
โ โโโ BindableProperty.cs # Bindable Property
โโโ ReferencePool/ # Reference Pool System
โ โโโ ReferencePoolComponent.cs # Reference Pool Component
โโโ Utility/ # Utility Classes
โโโ Log.cs # Log Utility
โโโ Utility.Assembly.cs # Assembly Utility
โโโ Utility.Asset.Path.cs # Asset Path Utility
โโโ Utility.Compression/ # Compression
โ โโโ ICompressionHelper.cs # Compression Interface
โ โโโ Utility.Compression.cs # Compression Core
โโโ Utility.Const/ # Constants
โ โโโ FileNameSuffix.cs # File Name Suffix
โโโ Utility.Converter.cs # Type Converter
โโโ Utility.Encryption/ # Encryption
โ โโโ Utility.Encryption.cs # Encryption Core
โ โโโ Aes.cs # AES Encryption
โ โโโ Rsa.cs # RSA Encryption
โ โโโ Dsa.cs # DSA Encryption
โโโ Utility.File.cs # File Operations
โโโ Utility.Hash/ # Hash Calculation
โ โโโ HMACSha256.cs # HMAC SHA256
โ โโโ Md5.cs # MD5
โ โโโ Sha1.cs # SHA1
โ โโโ MurmurHash3.cs # MurmurHash3
โ โโโ XxHash.cs # XxHash
โโโ Utility.IdGenerator.cs # ID Generator
โโโ Utility.Json/ # JSON Serialization
โ โโโ IJsonHelper.cs # JSON Interface
โ โโโ Utility.Json.cs # JSON Core
โโโ Utility.Marshal.cs # Marshal Utility
โโโ Utility.Net.cs # Network Utility
โโโ Utility.Object.cs # Object Utility
โโโ Utility.Path.cs # Path Handling
โโโ Utility.Random.cs # Random Number
โโโ Utility.Text/ # Text Processing
โ โโโ ITextHelper.cs # Text Interface
โ โโโ Utility.Text.cs # Text Core
โโโ Utility.Verifier/ # Verifier
โ โโโ Verifier.cs # Verifier Core
โ โโโ Crc32.cs # CRC32
โ โโโ Crc64.cs # CRC64
โโโ Utility.cs # Utility Entry
โโโ XString.cs # Efficient String
```
#### Runtime Sub-Modules
| Sub-Module | Description | Main Features |
| ----------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Base** | Framework Core | Component management, event pool, logging, reference pool, task pool, variable system, lifecycle management, singleton pattern |
| **Extension** | Extension Library | Common extensions (string, collection, datetime), Unity type extensions (Transform, Vector), sequence reader, GameObject extensions |
| **Helper** | Helper Classes | Application, camera, file, path, math, random, timer, network, JSON, rendering, position and more |
| **ObjectPool** | Object Pool System | Object reuse, memory optimization, performance improvement |
| **Property** | Property System | Bindable properties, data binding, MVVM support |
| **ReferencePool** | Reference Pool System | Reference type management, GC optimization |
| **Utility** | Utility Classes | Encryption (AES/RSA/DSA), compression, hash (MD5/SHA1/HMAC), CRC, JSON, file operations, ID generation, type conversion, text processing, logging |
### ๐ Plugins Module
Native platform plugins and third-party dependencies.
```
Plugins/
โโโ iOS/ # iOS Native Plugin
โ โโโ GameFrameX/
โ โโโ GameFrameX.mm # Core Functionality
โ โโโ GameFrameXTrackingAuthorization.mm # Permission Tracking
โโโ ICSharpCode.SharpZipLib.dll # ZIP Compression Library
โโโ Microsoft.NET.StringTools.dll # String Tools
โโโ System.Buffers.dll # Memory Buffer
โโโ System.IO.Pipelines.dll # IO Pipeline
โโโ System.Memory.dll # Memory Management
โโโ System.Runtime.CompilerServices.Unsafe.dll # Runtime Support
```
#### Plugins Sub-Modules
| Sub-Module | Description | Dependencies |
| ----------------------- | ---------------------------------- | ---------------------------- |
| **iOS Plugin** | iOS native functionality | GameFrameX.mm |
| **Compression Library** | ZIP file compression/decompression | SharpZipLib |
| **Memory Management** | Efficient memory operations | StringTools, Memory, Buffers |
| **Runtime Support** | .NET runtime extensions | CompilerServices.Unsafe |
### ๐ ๏ธ Editor Module
Editor tools and extensions for improved development efficiency.
```
Editor/
โโโ BuildHotfix/ # Hotfix Build Tools
โ โโโ BuildHotfixHelper.cs # Build Helper
โ โโโ HotFixAssemblyDefinitionHelper.cs # Hotfix Assembly
โ โโโ HotFixEditorCompilerHelper.cs # Editor Compiler
โโโ BuildProduct/ # Product Build Assistant
โ โโโ BuildProductHelper.cs # Build Helper
โ โโโ BuildPostProcessHelper.cs # Post Build Processing
โ โโโ IBuilderPreHookHandler.cs # Pre-Build Hook
โ โโโ IBuilderPostHookHandler.cs # Post-Build Hook
โโโ BuildWebGLTools/ # WebGL Build Tools
โ โโโ BuildWebGLToolsWithHybridCLR.cs # HybridCLR WebGL Build
โโโ Cropping/ # Image Cropping Tool
โ โโโ CroppingWindow.cs # Cropping Window
โโโ Inspector/ # Custom Inspector Panels
โ โโโ BaseComponentInspector.cs # Base Component Inspector
โ โโโ ObjectPoolComponentInspector.cs # Object Pool Inspector
โ โโโ ReferencePoolComponentInspector.cs # Reference Pool Inspector
โโโ InspectorLockShortcut/ # Inspector Lock
โ โโโ InspectorLockShortcut.cs # Keyboard Shortcut Lock
โโโ MiniGame/ # Mini Game Platform Adaptation (21 Platforms) โญ
โ โโโ MiniGameDefineSymbolHelper.cs # Base Define Symbol Manager
โ โโโ DomesticMiniGames/ # Domestic (China) Mini Games
โ โ โโโ MiniGameDefineSymbolHelper.WeChat.cs # WeChat
โ โ โโโ MiniGameDefineSymbolHelper.Alipay.cs # Alipay
โ โ โโโ MiniGameDefineSymbolHelper.DouYin.cs # DouYin
โ โ โโโ MiniGameDefineSymbolHelper.KuaiShou.cs # KuaiShou
โ โ โโโ MiniGameDefineSymbolHelper.Baidu.cs # Baidu
โ โ โโโ MiniGameDefineSymbolHelper.JingDong.cs # JingDong
โ โ โโโ MiniGameDefineSymbolHelper.Meituan.cs # Meituan
โ โ โโโ MiniGameDefineSymbolHelper.Taobao.cs # Taobao
โ โ โโโ MiniGameDefineSymbolHelper.Bilibili.cs # Bilibili
โ โโโ InternationalMiniGames/ # International Mini Games
โ โ โโโ MiniGameDefineSymbolHelper.CrazyGames.cs # CrazyGames
โ โ โโโ MiniGameDefineSymbolHelper.Discord.cs # Discord
โ โ โโโ MiniGameDefineSymbolHelper.Facebook.cs # Facebook
โ โ โโโ MiniGameDefineSymbolHelper.GooglePlay.cs # Google Play
โ โ โโโ MiniGameDefineSymbolHelper.Poki.cs # Poki
โ โ โโโ MiniGameDefineSymbolHelper.TikTok.cs # TikTok
โ โ โโโ MiniGameDefineSymbolHelper.YouTube.cs # YouTube
โ โโโ DeviceOEMs/ # Device OEM Mini Games
โ โ โโโ MiniGameDefineSymbolHelper.Huawei.cs # Huawei
โ โ โโโ MiniGameDefineSymbolHelper.OPPO.cs # OPPO
โ โ โโโ MiniGameDefineSymbolHelper.Vivo.cs # vivo
โ โ โโโ MiniGameDefineSymbolHelper.Xiaomi.cs # Xiaomi
โ โโโ GamePlatforms/ # Game Platform
โ โโโ MiniGameDefineSymbolHelper.TapTap.cs # TapTap
โโโ PackageManager/ # Package Manager Window
โ โโโ PackageManagerWindow.cs # Package Manager Window
โ โโโ PackagesManifest.cs # Package Manifest
โโโ UpdatePackages/ # Package Update Tools
โ โโโ UpdateAllPackageHelper.cs # Batch Update
โโโ Welcome/ # Welcome Window
โ โโโ WelcomeWindow.cs # Welcome Interface
โโโ Misc/ # Miscellaneous Tools
โโโ HelperInfo.cs # Helper Info
โโโ LogRedirection.cs # Log Redirection
โโโ ScriptingDefineSymbols.cs # Define Symbol Manager
โโโ Type.cs # Type Utility
โโโ OpenFolder.cs # Open Folder
```
#### Editor Sub-Modules
| Sub-Module | Description | Main Features |
| ------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **BuildHotfix** | Hotfix Build | HybridCLR hotfix assembly build and management |
| **BuildProduct** | Product Build | Build process automation, pre/post hooks |
| **BuildWebGLTools** | WebGL Build | WebGL platform specific build tools |
| **Cropping** | Image Cropping | Visual image cropping tool |
| **Inspector** | Custom Inspectors | Object pool, reference pool visual monitoring |
| **InspectorLockShortcut** | Inspector Lock | Keyboard shortcut for locking Inspector panel |
| **MiniGame** | Mini Game Adaptation | One-click switch between 21 mini game platforms (categorized into domestic, international, device OEMs, game platforms) |
| **PackageManager** | Package Management | Visual package management interface |
| **UpdatePackages** | Package Update | Batch update project dependencies |
| **Welcome** | Welcome Interface | New user guide and quick access |
| **Misc** | Miscellaneous | Logging, define symbols, types and more |
---
## ๐ Quick Start
### Installation
#### Method 1: Unity Package Manager (Recommended)
1. Open Unity Editor
2. Go to `Window` โ `Package Manager`
3. Click the `+` button in the top-left corner
4. Select `Add package from git URL`
5. Enter: `https://github.com/GameFrameX/com.gameframex.unity.git`
#### Method 2: Manual Download
1. Download the latest [Release](https://github.com/GameFrameX/com.gameframex.unity/releases)
2. Extract to your project's `Packages` directory
#### Method 3: Using scopedRegistries (UPM)
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
```json
{
"scopedRegistries": [
{
"name": "GameFrameX",
"url": "https://gameframex.upm.alianblank.uk",
"scopes": [
"com.gameframex"
]
}
],
"dependencies": {
"com.gameframex.unity": "1.10.1"
}
}
```
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
### Basic Usage
```csharp
using GameFrameX.Runtime;
public class GameManager : MonoBehaviour
{
void Start()
{
// Get object pool component
var objectPool = GameEntry.GetComponent();
// Get reference pool component
var referencePool = GameEntry.GetComponent();
// Use extension methods
transform.SetPositionX(10f);
gameObject.SetActiveOptimized(true);
}
}
```
---
## ๐ก Usage Examples
### Runtime Usage Examples
#### ๐ฏ Object Pool System
```csharp
// Get object pool component
var objectPool = GameEntry.GetComponent();
// Create object pool
objectPool.CreatePool("MyObjectPool", 10, 100);
// Spawn object from pool
var obj = objectPool.Spawn("MyObjectPool");
// Return object to pool
objectPool.Unspawn(obj);
// Destroy object pool
objectPool.DestroyPool("MyObjectPool");
```
#### ๐ Extension Methods
```csharp
// Transform extensions
transform.SetPositionX(10f);
transform.SetLocalScaleXYZ(2f, 2f, 2f);
transform.ResetTransformation();
// Vector3 extensions
Vector3 pos = transform.position;
pos = pos.WithX(5f).WithY(10f);
// GameObject extensions
gameObject.SetActiveOptimized(true);
gameObject.SetLayerRecursively(LayerMask.NameToLayer("UI"));
```
#### ๐ Utility Classes
```csharp
// File operations
Utility.File.WriteAllBytes("path/to/file", data);
byte[] content = Utility.File.ReadAllBytes("path/to/file");
// AES encryption/decryption
string encrypted = Utility.Encryption.Aes.Encrypt("plaintext", "key");
string decrypted = Utility.Encryption.Aes.Decrypt(encrypted, "key");
// Hash calculation
string md5 = Utility.Hash.Md5.ComputeHash("input");
string sha1 = Utility.Hash.Sha1.ComputeHash("input");
// JSON serialization
var json = Utility.Json.ToJson(myObject);
var obj = Utility.Json.FromJson(json);
```
#### ๐ก Event System
```csharp
// Define event args
public class PlayerDeadEventArgs : BaseEventArgs
{
public int PlayerId { get; set; }
public float Damage { get; set; }
}
// Subscribe to event
GameEntry.Event.Subscribe(PlayerDeadEventArgs.EventId, OnPlayerDead);
// Fire event
GameEntry.Event.Fire(this, PlayerDeadEventArgs.Create(playerId, damage));
// Unsubscribe from event
GameEntry.Event.Unsubscribe(PlayerDeadEventArgs.EventId, OnPlayerDead);
```
### Editor Tools
#### ๐ฎ Mini Game Platform Adaptation
Quickly switch between mini game platforms in Unity menu:
```
GameFrameX/
โโโ Scripting Define Symbols/
โ โโโ Domestic Mini Games/
โ โ โโโ Enable WeChat Mini Game
โ โ โโโ Enable Alipay Mini Game
โ โ โโโ Enable DouYin Mini Game
โ โ โโโ Enable KuaiShou Mini Game
โ โ โโโ Enable Baidu Mini Game
โ โ โโโ Enable JingDong Mini Game
โ โ โโโ Enable Meituan Mini Game
โ โ โโโ Enable Taobao Mini Game
โ โ โโโ Enable Bilibili Mini Game
โ โโโ International Mini Games/
โ โ โโโ Enable Discord Mini Game
โ โ โโโ Enable YouTube Mini Game
โ โ โโโ Enable Facebook Mini Game
โ โ โโโ Enable Google Play Mini Game
โ โ โโโ Enable TikTok Mini Game
โ โ โโโ Enable CrazyGames Mini Game
โ โ โโโ Enable Poki Mini Game
โ โโโ Device OEMs/
โ โ โโโ Enable Huawei Mini Game
โ โ โโโ Enable OPPO Mini Game
โ โ โโโ Enable Vivo Mini Game
โ โ โโโ Enable Xiaomi Mini Game
โ โโโ Game Platforms/
โ โโโ Enable TapTap Mini Game
```
#### ๐๏ธ Build Tools
```
GameFrameX/
โโโ Build Hotfix
โโโ Build Product
โโโ Build WebGL With HybridCLR
```
#### ๐ฆ Package Management
```
GameFrameX/
โโโ Package Manager
โโโ Update All Packages
```
---
## ๐ฏ Platform Support
### Operating Systems
| Platform | Status | Supported Version |
| -------- | ----------- | ----------------- |
| Windows | โ
Supported | Unity 2019.4+ |
| macOS | โ
Supported | Unity 2019.4+ |
| Linux | โ
Supported | Unity 2019.4+ |
| iOS | โ
Supported | Unity 2019.4+ |
| Android | โ
Supported | Unity 2019.4+ |
| WebGL | โ
Supported | Unity 2019.4+ |
### Mini Game Platform Adaptation
GameFrameX provides one-click mini game platform adaptation, supporting **21 mainstream mini game platforms** worldwide:
#### ๐จ๐ณ Domestic Mini Games (9)
| Platform | Define Symbol | Region | Menu Priority |
| ------------------- | ------------------------------------------------ | ------- | ------------- |
| WeChat Mini Game | `ENABLE_WECHAT_MINI_GAME` / `WEIXINMINIGAME` | ๐จ๐ณ China | 2000 |
| Alipay Mini Game | `ENABLE_ALIPAY_MINI_GAME` / `ALIPAYMINIGAME` | ๐จ๐ณ China | 2400 |
| DouYin Mini Game | `ENABLE_DOUYIN_MINI_GAME` / `DOUYINMINIGAME` | ๐จ๐ณ China | 2100 |
| KuaiShou Mini Game | `ENABLE_KUAISHOU_MINI_GAME` / `KUAISHOUMINIGAME` | ๐จ๐ณ China | 2200 |
| Baidu Mini Game | `ENABLE_BAIDU_MINI_GAME` / `BAIDUMINIGAME` | ๐จ๐ณ China | 2300 |
| JD Mini Game | `ENABLE_JINGDONG_MINI_GAME` / `JINGDONGMINIGAME` | ๐จ๐ณ China | 2500 |
| Taobao Mini Program | `ENABLE_TAOBAO_MINI_GAME` / `TAOBAOMINIGAME` | ๐จ๐ณ China | 2600 |
| Meituan Mini Game | `ENABLE_MEITUAN_MINI_GAME` / `MEITUANMINIGAME` | ๐จ๐ณ China | 2800 |
| Bilibili Mini Game | `ENABLE_BILIBILI_MINI_GAME` / `BILIBILIMINIGAME` | ๐จ๐ณ China | 2900 |
#### ๐ International Mini Games (7)
| Platform | Define Symbol | Region | Menu Priority |
| ----------- | ---------------------------------------------------- | -------- | ------------- |
| Discord | `ENABLE_DISCORD_MINI_GAME` / `DISCORDMINIGAME` | ๐ Global | 2700 |
| YouTube | `ENABLE_YOUTUBE_MINI_GAME` / `YOUTUBEMINIGAME` | ๐ Global | 2800 |
| Facebook | `ENABLE_FACEBOOK_MINI_GAME` / `FACEBOOKMINIGAME` | ๐ Global | 2900 |
| Google Play | `ENABLE_GOOGLEPLAY_MINI_GAME` / `GOOGLEPLAYMINIGAME` | ๐ Global | 3000 |
| TikTok | `ENABLE_TIKTOK_MINI_GAME` / `TIKTOKMINIGAME` | ๐ Global | 3500 |
| CrazyGames | `ENABLE_CRAZYGAMES_MINI_GAME` / `CRAZYGAMESMINIGAME` | ๐ Global | 3600 |
| Poki | `ENABLE_POKI_MINI_GAME` / `POKIMINIGAME` | ๐ Global | 3700 |
#### ๐ฑ Device OEMs (4)
| Platform | Define Symbol | Region | Menu Priority |
| ---------------- | -------------------------------------------- | ------- | ------------- |
| Huawei Mini Game | `ENABLE_HUAWEI_MINI_GAME` / `HUAWEIMINIGAME` | ๐จ๐ณ China | 3400 |
| OPPO Mini Game | `ENABLE_OPPO_MINI_GAME` / `OPPOSMINIGAME` | ๐จ๐ณ China | 3200 |
| Vivo Mini Game | `ENABLE_VIVO_MINI_GAME` / `VIVOMINIGAME` | ๐จ๐ณ China | 3100 |
| Xiaomi Mini Game | `ENABLE_XIAOMI_MINI_GAME` / `XIAOMIMINIGAME` | ๐จ๐ณ China | 3300 |
#### ๐ฎ Game Platforms (1)
| Platform | Define Symbol | Region | Menu Priority |
| ---------------- | -------------------------------------------- | ------- | ------------- |
| TapTap Mini Game | `ENABLE_TAPTAP_MINI_GAME` / `TAPTAPMINIGAME` | ๐จ๐ณ China | 2700 |
#### Define Symbol Details
- **Unified Define**: `ENABLE_WEBGL_MINI_GAME` - Shared by all mini game platforms
- **Platform Defines**: Independent defines for conditional compilation per platform
- **Mutex Mechanism**: Enabling one mini game platform automatically disables others
- **Menu Path**: `GameFrameX/Scripting Define Symbols/[Category]/Enable [Platform] Mini Game`
---
## ๐ Documentation & Resources
- ๐ **Full Documentation**: [https://gameframex.doc.alianblank.com](https://gameframex.doc.alianblank.com)
- ๐ฏ **API Reference**: [API Documentation](https://gameframex.doc.alianblank.com/api)
- ๐ **Example Projects**: [Examples Repository](https://github.com/GameFrameX/Examples)
- ๐ฌ **Video Tutorials**: [YouTube Channel](https://youtube.com/gameframex)
---
## ๐ค Community & Support
- ๐ฌ **QQ Group**: [467608841](https://qm.qq.com/cgi-bin/qm/qr?k=sYFd1nv6m2KZIWFLorZ5pBR0AE5ZhbuL&jump_from=webapi&authKey=oCu+uoL3n35fT5SEt7iLgGtROPxh31n/rHUxRlp0w1f+j38W4tKBuWyRH3KEdwHN)
- ๐ **Issue Tracker**: [GitHub Issues](https://github.com/GameFrameX/com.gameframex.unity/issues)
- ๐ก **Feature Requests**: [GitHub Discussions](https://github.com/GameFrameX/com.gameframex.unity/discussions)
---
## ๐ Changelog
### v1.4.0 (2025-04-16)
- โจ Added 13 new mini game platforms (JD, Taobao, Discord, YouTube, Facebook, Google Play, vivo, OPPO, Xiaomi, Huawei, TikTok, CrazyGames, Poki)
- โจ Expanded from 8 to 21 platforms, covering global mainstream mini game platforms
- ๐ Updated all language versions of README documentation with latest platform support
- ๐ Optimized platform define symbol management and improved mutex mechanism stability
### v1.3.6 (2025-05-28)
- ๐ Fixed duplicate GUID issues
- โจ Added Meituan, Bilibili mini game platform adaptation
- โจ Added more extension methods
- ๐ Enhanced README documentation with complete module structure
- ๐ง Optimized object pool performance
- ๐ Improved documentation
View full changelog: [CHANGELOG.md](CHANGELOG.md)
---
## ๐ License
This project is distributed under **MIT License** and **Apache License 2.0** dual licensing.
See full license text: [LICENSE.md](LICENSE.md)
---
## ๐จโ๐ป Author
**Blank**
- ๐ Website: [https://gameframex.doc.alianblank.com](https://gameframex.doc.alianblank.com)
- ๐ GitHub: [@GameFrameX](https://github.com/GameFrameX)
---
**If this project helps you, please give us a โญ Star!**
[โฌ Back to Top](#gameframex-unity-package)