Game Frame X UI UGUI

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

Documentation · Quick Start · QQ Group: 467608841 / 233840761

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

Features

Core Functionality

• UGUI Component Wrappers: High-level wrappers for Unity UGUI components
• UI Manager: Complete UI form management system
• Code Generator: Automatic UI code generation for improved development efficiency
• Extension Methods: Rich UGUI component extension methods
• Form Helpers: UI form creation and management helper tools

Main Components

UI Management System

• UIManager: Form manager handling UI open/close and lifecycle management
• UGUI: Abstract UI base class providing UI visibility state control
• UGUIFormHelper: UI form helper handling UI instantiation and creation

Extension Features

• UGUIButtonExtension: Button component extension methods
• UGUIImageExtension: Image component extension methods
• RectTransformExtension: RectTransform extension methods
• UIImage: Enhanced Image component with async image loading support

Editor Tools

• UGUICodeGenerator: UGUI code generator
• UGUIComponentInspector: UGUI component inspector
• UIImageReplaceHandler: UI image replacement handler

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.ui.ugui": "2.5.1"
     }
   }

   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.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
   }

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

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

Dependencies

Package	Description
com.gameframex.unity	1.1.1
com.gameframex.unity.asset	1.0.6
com.gameframex.unity.event	1.0.0
com.gameframex.unity.ui	1.0.0

Documentation & Resources

• Documentation

Community & Support

• QQ Group: 467608841 / 233840761

Changelog

See Releases for changelog.

License

See LICENSE.md for license information.