# Game Frame X Android
[](https://github.com/GameFrameX/com.gameframex.unity.android/releases)
[](https://github.com/GameFrameX/com.gameframex.unity.android/blob/main/LICENSE.md)
[](https://gameframex.doc.alianblank.com)
独立游戏前后端一体化解决方案 · 独立游戏开发者的圆梦大使
[文档](https://gameframex.doc.alianblank.com) · [快速开始](#快速开始)
[English](README.md) | **简体中文** | [繁體中文](README.zh-TW.md) | [日本語](README.ja.md) | [한국어](README.ko.md)
---
## 项目简介
通用的 Android 构建自动配置系统。通过 JSON 数据文件驱动，自动发现项目中所有 `AndroidBuildConfig.json` 并在构建时注入 Maven 仓库、Gradle 依赖、AndroidManifest 配置、string 资源和本地化配置。
核心特性：
- **纯数据驱动**：SDK 包只需 JSON 文件，无需 C# 代码
- **多文件支持**：项目中可存在任意数量的配置文件
- **任意位置**：配置文件可放在 Unity 能识别的任何位置
- **自动合并去重**：多个配置文件按 key 自动合并去重
- **幂等操作**：多次构建安全，已有条目自动跳过
## 快速开始
### 安装
编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
```json
{
"scopedRegistries": [
{
"name": "GameFrameX",
"url": "https://gameframex.upm.alianblank.uk",
"scopes": [
"com.gameframex"
]
}
],
"dependencies": {
"com.gameframex.unity.android": "1.0.0"
}
}
```
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
### 使用示例
在项目的任意位置放置 `AndroidBuildConfig.json` 文件（如 `Assets/`、`Packages/` 下的任何目录）：
```json
{
"providerName": "My SDK",
"mavenRepositories": [
{ "name": "MyRepo", "url": "https://maven.example.com/repository/" }
],
"gradleWrapper": {
"distributionUrl": "https\\://services.gradle.org/distributions/gradle-8.4-bin.zip"
},
"gradleProperties": {
"android.useAndroidX": "true",
"org.gradle.jvmargs": "-Xmx4096m"
},
"fileCopies": {
"libs/your-sdk.aar": "launcher/libs/your-sdk.aar"
},
"directoryCopies": {
"jniLibs": "launcher/jniLibs"
},
"assetPacksEnabled": true,
"assetPacks": [
{
"name": "additional_assets",
"deliveryType": "install-time",
"streamingAssetsPath": "AdditionalAssets"
}
],
"localizedStringResources": {
"zh-rCN": {
"app_name": "我的应用"
},
"ja": {
"app_name": "マイアプリ"
}
},
"launcher": {
"compileSdkVersion": "34",
"buildToolsVersion": "34.0.0",
"minSdkVersion": "24",
"targetSdkVersion": "34",
"applicationId": "com.example.demo",
"versionName": "1.0.0",
"dependencies": [
{ "configuration": "implementation", "notation": "com.example:sdk-analytics:2.0.0" }
],
"permissions": [ "android.permission.INTERNET" ],
"metaData": [
{ "name": "com.example.APP_ID", "value": "your_app_id" }
],
"applicationAttributes": [
{ "name": "usesCleartextTraffic", "value": "true" }
],
"signingConfig": {
"storeFile": "keystore/release.jks",
"storePassword": "your_store_password",
"keyAlias": "release",
"keyPassword": "your_key_password"
},
"stringResources": {
"app_name": "My App",
"facebook_app_id": "your_facebook_app_id",
"facebook_client_token": "your_facebook_client_token",
"facebook_app_scheme": "fb_your_facebook_app_id"
},
"resources": {
"string": {
"facebook_app_id": {
"value": "your_facebook_app_id",
"translatable": "false"
}
},
"integer": {
"max_retry_count": "3"
},
"color": {
"primary": "#FF5722"
}
}
},
"unityLibrary": {
"compileSdkVersion": "34",
"buildToolsVersion": "34.0.0",
"minSdkVersion": "24",
"targetSdkVersion": "34",
"dependencies": [],
"permissions": [],
"metaData": [],
"applicationAttributes": [],
"stringResources": {},
"resources": {}
}
}
```
所有字段均为可选。项目中可放置多个配置文件，内容自动合并去重。
### 字段说明
#### 全局字段
| 字段 | 类型 | 合并策略 | 说明 |
|------|------|---------|------|
| `providerName` | string | 后写覆盖 | 配置提供者名称，仅用于构建日志标识 |
| `mavenRepositories` | `[{name, url}]` | 按 URL 去重 | Maven 仓库列表，注入到根 `settings.gradle` 的 `dependencyResolutionManagement.repositories` |
| `gradleWrapper` | `{key: value}` | 按 key 覆盖 | 键值对注入到 `gradle-wrapper.properties` |
| `gradleProperties` | `{key: value}` | 按 key 覆盖 | 键值对注入到 `gradle.properties` |
| `fileCopies` | `{源路径: 目标路径}` | 按 source 覆盖 | 文件复制映射。相对源路径基于配置文件目录解析，相对目标路径基于 Gradle 根目录解析 |
| `directoryCopies` | `{源路径: 目标路径}` | 按 source 覆盖 | 目录复制映射，路径解析同 `fileCopies` |
| `assetPacksEnabled` | bool | 后写覆盖 | 是否启用 Google Play Asset Delivery 功能，默认 `false` |
| `assetPacks` | `[{name, deliveryType, streamingAssetsPath}]` | 按 name 去重 | Asset Pack 配置列表，每个 pack 对应一个独立的 Gradle 子项目 |
| `localizedStringResources` | `{locale: {key: value}}` | 按 locale 分组，每组内按 key 后写覆盖 | 本地化 string 资源，注入到 launcher 的 `res/values-