Game Frame X Builder

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 Builder is an automated build tool for Unity, providing streamlined build pipeline automation for game projects.

For detailed usage, refer to Unity/Automated Build section in the documentation.

Features

• Automated Unity build pipeline via -executeMethod for Android / iOS / WebGL / standalone and other platforms
• Configurable via Unity command line arguments (build number, channel, language, package version, etc.)
• Asset bundle build with multiple pipelines: Builtin / Scriptable / RawFile
• Optional HybridCLR integration (when com.code-philosophy.hybridclr is installed)
• Optional object storage upload (QiNiu / Tencent / ALiYun via GameFrameX object storage packages)
• Built-in enterprise WeChat bot notification after build

Quick Start

System Requirements

• Unity 2019.4 or higher

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.unity"
         ]
       }
     ],
     "dependencies": {
       "com.gameframex.unity.builder": "2.2.1"
     }
   }

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

2. Add to manifest.json dependencies:

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

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

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

Usage Examples

Parameters are passed as Unity command line arguments (e.g. -flag value).

Required

Parameter	Description
-executeMethod	Method to execute (e.g. GameFrameX.Builder.Editor.Builder.BuildApk)
-BUILD_NUMBER	Build number

General

Parameter	Type	Default	Description
-logFile	string	auto-generated	Log file path
-JOB_NAME	string		Job name
-BundleId	string	project setting	Application bundle identifier
-AppVersion	string	project setting	Application version
-ChannelName	string	default	Channel name
-Language	string	default	Language

Asset Build (BuildAsset)

Parameter	Type	Default	Description
-PackageName	string	DefaultPackage	Asset bundle package name
-PackageVersion	string	timestamp	Package version (auto-generated timestamp if empty)
-BuildPipeline	enum	BuiltinBuildPipeline	Build pipeline: BuiltinBuildPipeline / ScriptableBuildPipeline / RawFileBuildPipeline
-BuildinFileCopyOption	enum	ClearAndCopyAll	Built-in file copy option: None / ClearAndCopyAll / ClearAndCopyByTags / OnlyCopyNew
-IsIncrementalBuildPackage	flag	false	Use incremental build

Upload & Notification

Parameter	Type	Default	Description
-IsUploadLogFile	flag	false	Upload log file
-IsUploadAsset	flag	false	Upload asset bundle
-IsUploadApk	flag	false	Upload APK/IPA (BuildApk only)
-IsUpdateAssetPackageVersion	flag	false	Update asset package version
-UpdateAssetPackageVersionUrl	string		URL for updating asset package version
-UpdateAssetPackageVersionAuthorization	string		Authorization for version update
-WeChatBotKey	string		WeChat Work bot webhook key

Object Storage

Parameter	Type	Default	Description
-ObjectStorageKey	string		Object storage access key
-ObjectStorageSecret	string		Object storage secret key
-ObjectStorageBucketName	string		Object storage bucket name
-ObjectStorageEndPoint	string		Object storage endpoint URL

Dependencies

Package	Description
com.gameframex.unity	GameFrameX core runtime and editor foundation
com.gameframex.unity.litjson	LitJSON-based JSON serialization
com.gameframex.unity.tuyoogame.yooasset	YooAsset asset bundle build pipeline

Optional (resolved via versionDefines):

Package	Description
com.code-philosophy.hybridclr	HybridCLR hot-update support
com.gameframex.unity.objectstorage	Object storage upload (QiNiu / Tencent / ALiYun)

Documentation & Resources

• Documentation: https://gameframex.doc.alianblank.com
• Repository: https://github.com/GameFrameX/com.gameframex.unity.builder
• Issues: https://github.com/GameFrameX/com.gameframex.unity.builder/issues

Community & Support

Changelog

See Releases for changelog.

License

See LICENSE.md for license information.