GameFrameX Unity

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

📖 Documentation · 🚀 Quick Start · 💬 QQ Group: 467608841

---

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

---

Project Overview

GameFrameX Unity is the Unity client implementation of the GameFrameX comprehensive solution, providing 90+ modular components covering the entire game development pipeline: from core framework, asset management, UI systems, and network communication to advertising, payment, login, data analytics, and more. Compatible with Unity 2019.4 and above.

Features

• Modular Design — Each component is an independent package, import on demand
• Hot Update Support — Integrated HybridCLR for C# hot updates
• Multi-UI Solutions — Supports both FairyGUI and UGUI
• Async-First — UniTask-based async/await programming model
• Cross-Platform — iOS, Android, WebGL, WeChat/Douyin/Alipay mini games, and more
• Rich Operations Components — Advertising (CSJ, TopOn), Payment (Alipay, Apple, Google), Login (QQ, WeChat, Apple, Facebook, Google), Data Analytics, Object Storage, and more

Quick Start

1. Configure Scoped Registry

Add the GameFrameX scoped registry to your project's Packages/manifest.json:

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

2. Add Components

Add the packages you need under dependencies. Check the Releases page for available versions.

Example: Adding common components

{
  "dependencies": {
    "com.gameframex.unity": "1.11.0",
    "com.gameframex.unity.asset": "2.0.0",
    "com.gameframex.unity.ui": "2.1.1",
    "com.gameframex.unity.ui.fairygui": "3.0.0",
    "com.gameframex.unity.procedure": "1.0.4",
    "com.gameframex.unity.event": "1.0.2",
    "com.gameframex.unity.fsm": "1.0.3",
    "com.gameframex.unity.network": "2.5.1",
    "com.gameframex.unity.sound": "1.0.6",
    "com.gameframex.unity.localization": "2.0.0"
  }
}

Component List

Version numbers are fetched automatically from the GameFrameX UPM Registry. Packages marked with - are third-party components installed via Git URL.

Core Framework

Package	Description	Version
com.gameframex.unity	Core runtime and editor base (event pool, reference pool, task pool, object pool, variable system, etc.)
com.gameframex.unity.entry	Framework entry component
com.gameframex.unity.event	Event system
com.gameframex.unity.fsm	Finite state machine
com.gameframex.unity.procedure	Procedure management
com.gameframex.unity.mono	MonoBehaviour wrapper
com.gameframex.unity.coroutine	Coroutine component
com.gameframex.unity.timer	Timer
com.gameframex.unity.entity	Entity component system
com.gameframex.unity.globalconfig	Global configuration management
com.gameframex.unity.debugger	Debugger

Asset Management

Package	Description	Version
com.gameframex.unity.asset	Asset loading and management
com.gameframex.unity.download	File download component
com.gameframex.unity.tuyoogame.yooasset	YooAsset asset management (customized)
com.gameframex.unity.gwiazdorrr.betterstreamingassets	StreamingAssets direct access
com.gameframex.unity.builder	Build pipeline tools

UI Framework

Package	Description	Version
com.gameframex.unity.ui	UI base framework
com.gameframex.unity.ui.fairygui	FairyGUI adapter
com.gameframex.unity.ui.ugui	UGUI adapter

Networking

Package	Description	Version
com.gameframex.unity.web	HTTP network requests (with async/await)
com.gameframex.unity.web.protobuff	ProtoBuf network communication
com.gameframex.unity.psygames.unitywebsocket	WebSocket networking library
com.gameframex.unity.webview	WebView embedded browser

Data & Configuration

Package	Description	Version
com.gameframex.unity.config	Configuration management
com.gameframex.unity.localization	Localization / i18n
com.gameframex.unity.focus-creative-games.luban	Luban config data generation
com.gameframex.unity.google.protobuf	Protocol Buffers serialization
com.gameframex.unity.google.flatbuffers	FlatBuffers serialization
com.gameframex.unity.json.simplejson	SimpleJSON library
com.gameframex.unity.xincger.litjson	LitJSON library

Audio & Animation

Package	Description	Version
com.gameframex.unity.sound	Audio playback and management
com.gameframex.unity.demigiant.dotween	DoTween animation plugin
com.gameframex.unity.esotericsoftware.spine.spine-unity	Spine animation runtime

Scene & Settings

Package	Description	Version
com.gameframex.unity.scene	Scene management
com.gameframex.unity.setting	Settings management

Hot Update

Package	Description	Version
com.gameframex.unity.tencent.xlua	XLua (Tencent version)
com.gameframex.unity.xlua	XLua adapter

Advertising

Package	Description	Version
com.gameframex.unity.advertisement	Advertising base component
com.gameframex.unity.advertisement.csj	CSJ (穿山甲) Advertising
com.gameframex.unity.advertisement.topon	TopOn aggregated advertising
com.gameframex.unity.advertisement.wechatminigame	WeChat Mini Game ads
com.gameframex.unity.advertisement.douyinminigame	Douyin Mini Game ads
com.gameframex.unity.advertisement.alipayminigame	Alipay Mini Game ads
com.gameframex.unity.advertisement.kuaishouminigame	Kuaishou Mini Game ads

Payment

Package	Description	Version
com.gameframex.unity.payment	Payment base component
com.gameframex.unity.payment.alipay	Alipay payment
com.gameframex.unity.payment.apple	Apple in-app purchase
com.gameframex.unity.payment.google	Google Play in-app purchase

Login

Package	Description	Version
com.gameframex.unity.login.apple	Apple Sign-In
com.gameframex.unity.login.facebook	Facebook Login
com.gameframex.unity.login.google	Google Sign-In
com.gameframex.unity.login.qq	QQ Login
com.gameframex.unity.login.wechat	WeChat Login

Analytics

Package	Description	Version
com.gameframex.unity.gameanalytics	Analytics base
com.gameframex.unity.gameanalytics.gameanalytics	GameAnalytics SDK
com.gameframex.unity.gameanalytics.gravity-engine	Gravity Engine
com.gameframex.unity.gameanalytics.talkingdata	TalkingData
com.gameframex.unity.gameanalytics.talkingdata.sdk	TalkingData SDK
com.gameframex.unity.gameanalytics.grafanaloki	Grafana Loki logging
com.gameframex.unity.gravityinfinite.gravity-engine	Gravity Engine adapter
com.gameframex.unity.sentry	Sentry error tracking
com.gameframex.unity.adjust	Adjust attribution analytics

Object Storage

Package	Description	Version
com.gameframex.unity.objectstorage	Object storage base
com.gameframex.unity.objectstorage.aliyun	Alibaba Cloud OSS
com.gameframex.unity.objectstorage.qiniu	Qiniu Cloud Kodo
com.gameframex.unity.objectstorage.tencent	Tencent Cloud COS

Mini Games

Package	Description	Version
com.gameframex.unity.minigame.wechat	WeChat Mini Game adapter	-
com.gameframex.unity.tuyoogame.yooasset.minigame.alipay	YooAsset Alipay Mini Game
com.gameframex.unity.tuyoogame.yooasset.minigame.taptap	YooAsset TapTap Mini Game
com.gameframex.unity.tuyoogame.yooasset.minigame.tiktok	YooAsset Douyin Mini Game

Platform Tools

Package	Description	Version
com.gameframex.unity.getchannel	Channel information retrieval
com.gameframex.unity.operationclipboard	Clipboard operations
com.gameframex.unity.readassets	StreamingAssets file reading
com.gameframex.unity.xcode	Xcode post-build auto configuration
com.gameframex.unity.systeminfo	Device unique identifier (OAID/IDFA)
com.gameframex.unity.sharesdk	ShareSDK social sharing
com.gameframex.unity.android	Android native tools

Development Tools

Package	Description	Version
com.gameframex.unity.yasirkula.debugconsole	Runtime debug console

Third-party Libraries

Package	Description	Version
com.gameframex.unity.cysharp.unitask	UniTask async/await

Documentation & Resources

• Documentation: https://gameframex.doc.alianblank.com
• Mirror: https://gameframex-docs.pages.dev
• Mirror: https://gameframex.doc.cloudflare.alianblank.com
• Mirror: https://gameframex.doc.vercel.alianblank.com

All mirror sites have identical content.

Community & Support

• QQ Group: 467608841

License

Apache License 2.0

---

Disclaimer: Some components are derived from open-source projects on the internet and are intended for learning and communication purposes only. If any infringement is involved, please submit an Issue or contact us via Email, and we will remove it promptly.