Skip to content

Commit db3d58e

Browse files
AlianBlankclaude
andcommitted
docs: 补全 Quick Start 中的 UPM scopedRegistries 安装说明
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 76b4c62 commit db3d58e

5 files changed

Lines changed: 150 additions & 20 deletions

File tree

README.ja.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,36 @@ https://github.com/gameframex/com.gameframex.unity.xcode.git
6464

6565
## クイックスタート
6666

67-
1. パッケージ内の `Editor/XCodeConfigDemo.json` をプロジェクト内の任意のディレクトリにコピー
68-
2. `XCodeConfig.json` にリネーム
69-
3. 設定項目を必要に応じて変更(下記の設定リファレンスを参照)
70-
4. iOS プロジェクトをビルドすると、ツールがすべての設定を自動的に適用
67+
### インストール
68+
69+
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください:
70+
71+
```json
72+
{
73+
"scopedRegistries": [
74+
{
75+
"name": "GameFrameX",
76+
"url": "https://gameframex.upm.alianblank.uk",
77+
"scopes": [
78+
"com.gameframex"
79+
]
80+
}
81+
]
82+
}
83+
```
84+
85+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
86+
87+
Then add the package to `dependencies`:
88+
89+
```json
90+
{
91+
"dependencies": {
92+
"com.gameframex.unity.xcode": "1.11.1"
93+
}
94+
}
95+
```
96+
7197

7298
## 設定ファイル構造
7399

README.ko.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,36 @@ https://github.com/gameframex/com.gameframex.unity.xcode.git
6464

6565
## 빠른 시작
6666

67-
1. 패키지 내의 `Editor/XCodeConfigDemo.json`을 프로젝트 내 임의의 디렉토리에 복사
68-
2. `XCodeConfig.json`으로 이름 변경
69-
3. 필요에 따라 설정 항목 수정 (아래 설정 참조)
70-
4. iOS 프로젝트를 빌드하면 도구가 모든 설정을 자동으로 적용
67+
### 설치
68+
69+
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
70+
71+
```json
72+
{
73+
"scopedRegistries": [
74+
{
75+
"name": "GameFrameX",
76+
"url": "https://gameframex.upm.alianblank.uk",
77+
"scopes": [
78+
"com.gameframex"
79+
]
80+
}
81+
]
82+
}
83+
```
84+
85+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
86+
87+
Then add the package to `dependencies`:
88+
89+
```json
90+
{
91+
"dependencies": {
92+
"com.gameframex.unity.xcode": "1.11.1"
93+
}
94+
}
95+
```
96+
7197

7298
## 설정 파일 구조
7399

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,36 @@ Clone or download this repository and place it in your Unity project's `Packages
6464

6565
## Quick Start
6666

67-
1. Copy `Editor/XCodeConfigDemo.json` from the package to any directory in your project
68-
2. Rename it to `XCodeConfig.json`
69-
3. Modify the configuration as needed (see Configuration Reference below)
70-
4. Build the iOS project — the tool will automatically apply all settings
67+
### Installation
68+
69+
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
70+
71+
```json
72+
{
73+
"scopedRegistries": [
74+
{
75+
"name": "GameFrameX",
76+
"url": "https://gameframex.upm.alianblank.uk",
77+
"scopes": [
78+
"com.gameframex"
79+
]
80+
}
81+
]
82+
}
83+
```
84+
85+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
86+
87+
Then add the package to `dependencies`:
88+
89+
```json
90+
{
91+
"dependencies": {
92+
"com.gameframex.unity.xcode": "1.11.1"
93+
}
94+
}
95+
```
96+
7197

7298
## Configuration Reference
7399

README.zh-CN.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,36 @@ https://github.com/gameframex/com.gameframex.unity.xcode.git
6464

6565
## 快速开始
6666

67-
1. 将包内 `Editor/XCodeConfigDemo.json` 复制到项目任意目录
68-
2. 重命名为 `XCodeConfig.json`
69-
3. 按需修改配置项(参见下方配置说明)
70-
4. 构建 iOS 项目,工具将自动应用所有配置
67+
### 安装
68+
69+
编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
70+
71+
```json
72+
{
73+
"scopedRegistries": [
74+
{
75+
"name": "GameFrameX",
76+
"url": "https://gameframex.upm.alianblank.uk",
77+
"scopes": [
78+
"com.gameframex"
79+
]
80+
}
81+
]
82+
}
83+
```
84+
85+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
86+
87+
Then add the package to `dependencies`:
88+
89+
```json
90+
{
91+
"dependencies": {
92+
"com.gameframex.unity.xcode": "1.11.1"
93+
}
94+
}
95+
```
96+
7197

7298
## 配置文件结构
7399

README.zh-TW.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,36 @@ https://github.com/gameframex/com.gameframex.unity.xcode.git
6464

6565
## 快速開始
6666

67-
1. 將包內 `Editor/XCodeConfigDemo.json` 複製到專案任意目錄
68-
2. 重新命名為 `XCodeConfig.json`
69-
3. 按需修改配置項(參見下方配置說明)
70-
4. 建構 iOS 專案,工具將自動套用所有配置
67+
### 安裝
68+
69+
編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
70+
71+
```json
72+
{
73+
"scopedRegistries": [
74+
{
75+
"name": "GameFrameX",
76+
"url": "https://gameframex.upm.alianblank.uk",
77+
"scopes": [
78+
"com.gameframex"
79+
]
80+
}
81+
]
82+
}
83+
```
84+
85+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
86+
87+
Then add the package to `dependencies`:
88+
89+
```json
90+
{
91+
"dependencies": {
92+
"com.gameframex.unity.xcode": "1.11.1"
93+
}
94+
}
95+
```
96+
7197

7298
## 配置檔案結構
7399

0 commit comments

Comments
 (0)