Skip to content

Commit 70e7f2b

Browse files
committed
docs(readme): 安装说明改用 scopedRegistries UPM 注册表
所有语言版本的 Quick Start 安装章节统一替换为 scopedRegistries 配置模板,包含 scopes 含义说明。
1 parent 8f5a7b0 commit 70e7f2b

5 files changed

Lines changed: 67 additions & 10 deletions

File tree

README.ja.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,27 @@
3434

3535
### インストール
3636

37-
プロジェクトの `Packages/manifest.json` に追加
37+
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください
3838

3939
```json
4040
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
4150
"dependencies": {
42-
"com.gameframex.unity.android": "https://github.com/gameframex/com.gameframex.unity.android.git"
51+
"com.gameframex.unity.android": "1.0.0"
4352
}
4453
}
4554
```
4655

56+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
57+
4758
### 使用例
4859

4960
プロジェクト内の任意の場所に `AndroidBuildConfig.json` ファイルを配置(例:`Assets/``Packages/` 下の任意のディレクトリ):

README.ko.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,27 @@
3434

3535
### 설치
3636

37-
프로젝트의 `Packages/manifest.json`에 추가:
37+
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
3838

3939
```json
4040
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
4150
"dependencies": {
42-
"com.gameframex.unity.android": "https://github.com/gameframex/com.gameframex.unity.android.git"
51+
"com.gameframex.unity.android": "1.0.0"
4352
}
4453
}
4554
```
4655

56+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
57+
4758
### 사용 예시
4859

4960
프로젝트 내 임의의 위치에 `AndroidBuildConfig.json` 파일을 배치합니다 (예: `Assets/` 또는 `Packages/` 하위 디렉토리):

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,27 @@ Key features:
3434

3535
### Installation
3636

37-
Add the package to your project's `Packages/manifest.json`:
37+
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
3838

3939
```json
4040
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
4150
"dependencies": {
42-
"com.gameframex.unity.android": "https://github.com/gameframex/com.gameframex.unity.android.git"
51+
"com.gameframex.unity.android": "1.0.0"
4352
}
4453
}
4554
```
4655

56+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
57+
4758
### Usage Examples
4859

4960
Place an `AndroidBuildConfig.json` file anywhere in your project (e.g., under `Assets/` or `Packages/`):
@@ -267,3 +278,5 @@ See [CHANGELOG.md](CHANGELOG.md) for details.
267278
## License
268279

269280
Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). See [LICENSE.md](LICENSE.md) for details.
281+
282+
GameFrameX and its derivative projects' copyright, trademarks, patents, and other related rights are protected by applicable laws and regulations. This project must not be used for any activities prohibited by laws and regulations, including endangering national security, disrupting social order, or infringing upon others' legitimate rights and interests.

README.zh-CN.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,27 @@
3434

3535
### 安装
3636

37-
在项目的 `Packages/manifest.json` 中添加依赖
37+
编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分
3838

3939
```json
4040
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
4150
"dependencies": {
42-
"com.gameframex.unity.android": "https://github.com/gameframex/com.gameframex.unity.android.git"
51+
"com.gameframex.unity.android": "1.0.0"
4352
}
4453
}
4554
```
4655

56+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
57+
4758
### 使用示例
4859

4960
在项目的任意位置放置 `AndroidBuildConfig.json` 文件(如 `Assets/``Packages/` 下的任何目录):

README.zh-TW.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,27 @@
3434

3535
### 安裝
3636

37-
在專案的 `Packages/manifest.json` 中新增依賴
37+
編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分
3838

3939
```json
4040
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
4150
"dependencies": {
42-
"com.gameframex.unity.android": "https://github.com/gameframex/com.gameframex.unity.android.git"
51+
"com.gameframex.unity.android": "1.0.0"
4352
}
4453
}
4554
```
4655

56+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
57+
4758
### 使用範例
4859

4960
在專案的任意位置放置 `AndroidBuildConfig.json` 檔案(如 `Assets/``Packages/` 下的任何目錄):

0 commit comments

Comments
 (0)