Game Frame X Asset

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

Documentation · Quick Start · QQ Group: 467608841 / 233840761

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

Project Overview

Game Frame X Asset is a Unity resource management package based on the GameFrameX framework, providing resource management functionality for easier and more efficient asset handling.

Asset Component - Provides resource-related interfaces.

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

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

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

Usage Examples

// Standard: via GameEntry (no dependency on com.gameframex.unity.entry)
var assetComponent = GameEntry.GetComponent<AssetComponent>();
assetComponent.LoadAsset("AssetPath");

Dependencies

• com.gameframex.unity: GameFrameX core framework
• com.gameframex.unity.tuyoogame.yooasset (≥ 3.1.0): YooAsset resource management package

Register-and-Dispatch Mechanism

Since 4.1.0, Web play mode initialization has converged into a single call to WebPlayModeFileSystemProviderRegistry.CreateFileSystemParameters(hostServerURL, fallbackHostServerURL), and all platform-specific conditional branches have been removed. Mini-game platform adapter packages (WeChat, Douyin, etc.) register themselves into the YooAsset main package's registry before scene load (earlier than the first Web initialization), and the registry resolves the provider with the highest priority, so only one platform is selected per initialization. For WebGL projects without any adapter package installed, the fallback to the default WebGL file system keeps behavior unchanged.

Upgrade Notes

• Starting from 4.1.0, the YooAsset main package com.gameframex.unity.tuyoogame.yooasset ≥ 3.1.0 must be installed (previously this worked only because host projects happened to install it directly).

• Documentation: https://gameframex.doc.alianblank.com

• Repository: https://github.com/gameframex/com.gameframex.unity.asset

• Issues: https://github.com/gameframex/com.gameframex.unity.asset/issues

Community & Support

• QQ Group: 467608841 / 233840761

Changelog

See Releases for changelog.

License

See LICENSE.md for license information.