Skip to content

Commit 8f6c5de

Browse files
AlianBlankclaude
AlianBlank
and
claude
committed
docs: 统一 Installation 章节为标准 4 种安装方式
依据 GameFrameX Installation 规范，所有 README 的 Installation 章节 必须包含 4 种安装方式：scopedRegistries / manifest.json / Git URL / Manual。 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 5ca406f commit 8f6c5de

5 files changed

Lines changed: 150 additions & 87 deletions

File tree

‎README.ja.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,36 @@
3333

3434
### インストール
3535

36+
以下のいずれかの方法を選択してください：
37+
38+
1. Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
39+
```json
40+
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
50+
"dependencies": {
51+
"com.gameframex.unity.ui.ugui": "2.5.1"
52+
}
53+
}
54+
```
55+
56+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
57+
58+
2. `manifest.json` の `dependencies` に直接追加：
59+
```json
60+
{
61+
"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
62+
}
63+
```
64+
3. Unity の **Package Manager** で **Git URL** を使用して追加：`https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
65+
4. リポジトリを Unity プロジェクトの `Packages` ディレクトリにクローンしてください。自動的に読み込まれます。
3666
### インストール
3767

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

‎README.ko.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,36 @@
3333

3434
### 설치
3535

36+
다음 방법 중 하나를 선택하세요:
37+
38+
1. Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
39+
```json
40+
{
41+
"scopedRegistries": [
42+
{
43+
"name": "GameFrameX",
44+
"url": "https://gameframex.upm.alianblank.uk",
45+
"scopes": [
46+
"com.gameframex"
47+
]
48+
}
49+
],
50+
"dependencies": {
51+
"com.gameframex.unity.ui.ugui": "2.5.1"
52+
}
53+
}
54+
```
55+
56+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
57+
58+
2. `manifest.json`의 `dependencies`에 직접 추가:
59+
```json
60+
{
61+
"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
62+
}
63+
```
64+
3. Unity의 **Package Manager**에서 **Git URL**을 사용하여 추가: `https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
65+
4. 리포지토리를 Unity 프로젝트의 `Packages` 디렉토리에 클론하세요. 자동으로 로드됩니다.
3666
### 설치
3767

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

‎README.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,35 +53,36 @@ All-in-One Solution for Indie Game Development · Empowering Indie Developers' D
5353

5454
### Installation
5555

56-
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
57-
58-
```json
59-
{
60-
"scopedRegistries": [
61-
{
62-
"name": "GameFrameX",
63-
"url": "https://gameframex.upm.alianblank.uk",
64-
"scopes": [
65-
"com.gameframex"
66-
]
67-
}
68-
]
69-
}
70-
```
71-
72-
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
73-
74-
Then add the package to `dependencies`:
75-
76-
```json
77-
{
78-
"dependencies": {
79-
"com.gameframex.unity.ui.ugui": "2.5.1"
80-
}
81-
}
82-
```
83-
84-
56+
Choose one of the following methods:
57+
58+
1. Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
59+
```json
60+
{
61+
"scopedRegistries": [
62+
{
63+
"name": "GameFrameX",
64+
"url": "https://gameframex.upm.alianblank.uk",
65+
"scopes": [
66+
"com.gameframex"
67+
]
68+
}
69+
],
70+
"dependencies": {
71+
"com.gameframex.unity.ui.ugui": "2.5.1"
72+
}
73+
}
74+
```
75+
76+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
77+
78+
2. Add to `manifest.json` dependencies:
79+
```json
80+
{
81+
"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
82+
}
83+
```
84+
3. Use **Package Manager** in Unity with **Git URL**: `https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
85+
4. Clone the repository into your Unity project's `Packages` directory. It will be loaded automatically.
8586
## Dependencies
8687

8788
| Package | Description |

‎README.zh-CN.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,35 +53,36 @@
5353

5454
### 安装
5555

56-
编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
57-
58-
```json
59-
{
60-
"scopedRegistries": [
61-
{
62-
"name": "GameFrameX",
63-
"url": "https://gameframex.upm.alianblank.uk",
64-
"scopes": [
65-
"com.gameframex"
66-
]
67-
}
68-
]
69-
}
70-
```
71-
72-
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
73-
74-
Then add the package to `dependencies`:
75-
76-
```json
77-
{
78-
"dependencies": {
79-
"com.gameframex.unity.ui.ugui": "2.5.1"
80-
}
81-
}
82-
```
83-
84-
56+
选择以下任一方式：
57+
58+
1. 编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
59+
```json
60+
{
61+
"scopedRegistries": [
62+
{
63+
"name": "GameFrameX",
64+
"url": "https://gameframex.upm.alianblank.uk",
65+
"scopes": [
66+
"com.gameframex"
67+
]
68+
}
69+
],
70+
"dependencies": {
71+
"com.gameframex.unity.ui.ugui": "2.5.1"
72+
}
73+
}
74+
```
75+
76+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
77+
78+
2. 直接在 `manifest.json` 的 `dependencies` 节点下添加以下内容：
79+
```json
80+
{
81+
"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
82+
}
83+
```
84+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加库，地址为：`https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
85+
4. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下，会自动加载识别。
8586
## 依赖
8687

8788
| 包 | 说明 |

‎README.zh-TW.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,35 +53,36 @@
5353

5454
### 安裝
5555

56-
編輯 Unity 專案的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
57-
58-
```json
59-
{
60-
"scopedRegistries": [
61-
{
62-
"name": "GameFrameX",
63-
"url": "https://gameframex.upm.alianblank.uk",
64-
"scopes": [
65-
"com.gameframex"
66-
]
67-
}
68-
]
69-
}
70-
```
71-
72-
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
73-
74-
Then add the package to `dependencies`:
75-
76-
```json
77-
{
78-
"dependencies": {
79-
"com.gameframex.unity.ui.ugui": "2.5.1"
80-
}
81-
}
82-
```
83-
84-
56+
選擇以下任一方式：
57+
58+
1. 編輯 Unity 專案的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
59+
```json
60+
{
61+
"scopedRegistries": [
62+
{
63+
"name": "GameFrameX",
64+
"url": "https://gameframex.upm.alianblank.uk",
65+
"scopes": [
66+
"com.gameframex"
67+
]
68+
}
69+
],
70+
"dependencies": {
71+
"com.gameframex.unity.ui.ugui": "2.5.1"
72+
}
73+
}
74+
```
75+
76+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
77+
78+
2. 直接在 `manifest.json` 的 `dependencies` 節點下添加以下內容：
79+
```json
80+
{
81+
"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"
82+
}
83+
```
84+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加庫，地址為：`https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
85+
4. 直接下載倉庫放置到 Unity 專案的 `Packages` 目錄下，會自動載入識別。
8586
## 依賴
8687

8788
| 套件 | 說明 |

0 commit comments

Comments
 (0)