Skip to content

Commit 9ee4a15

Browse files
AlianBlankclaude
andcommitted
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 7bfb0ee commit 9ee4a15

5 files changed

Lines changed: 150 additions & 143 deletions

File tree

README.ja.md

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

4040
### インストール
4141

42-
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください:
43-
44-
```json
45-
{
46-
"scopedRegistries": [
47-
{
48-
"name": "GameFrameX",
49-
"url": "https://gameframex.upm.alianblank.uk",
50-
"scopes": [
51-
"com.gameframex"
52-
]
53-
}
54-
]
55-
}
56-
```
57-
58-
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
59-
60-
Then add the package to `dependencies`:
61-
62-
```json
63-
{
64-
"dependencies": {
65-
"com.gameframex.unity.network": "2.6.6"
66-
}
67-
}
68-
```
69-
70-
42+
以下のいずれかの方法を選択してください:
43+
44+
1. Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください:
45+
```json
46+
{
47+
"scopedRegistries": [
48+
{
49+
"name": "GameFrameX",
50+
"url": "https://gameframex.upm.alianblank.uk",
51+
"scopes": [
52+
"com.gameframex"
53+
]
54+
}
55+
],
56+
"dependencies": {
57+
"com.gameframex.unity.network": "2.6.6"
58+
}
59+
}
60+
```
61+
62+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
63+
64+
2. `manifest.json``dependencies` に直接追加:
65+
```json
66+
{
67+
"com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
68+
}
69+
```
70+
3. Unity の **Package Manager****Git URL** を使用して追加:`https://github.com/gameframex/com.gameframex.unity.network.git`
71+
4. リポジトリを Unity プロジェクトの `Packages` ディレクトリにクローンしてください。自動的に読み込まれます。
7172
## プラットフォーム対応
7273

7374
| プラットフォーム | 対応 |

README.ko.md

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

4040
### 설치
4141

42-
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
43-
44-
```json
45-
{
46-
"scopedRegistries": [
47-
{
48-
"name": "GameFrameX",
49-
"url": "https://gameframex.upm.alianblank.uk",
50-
"scopes": [
51-
"com.gameframex"
52-
]
53-
}
54-
]
55-
}
56-
```
57-
58-
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
59-
60-
Then add the package to `dependencies`:
61-
62-
```json
63-
{
64-
"dependencies": {
65-
"com.gameframex.unity.network": "2.6.6"
66-
}
67-
}
68-
```
69-
70-
42+
다음 방법 중 하나를 선택하세요:
43+
44+
1. Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
45+
```json
46+
{
47+
"scopedRegistries": [
48+
{
49+
"name": "GameFrameX",
50+
"url": "https://gameframex.upm.alianblank.uk",
51+
"scopes": [
52+
"com.gameframex"
53+
]
54+
}
55+
],
56+
"dependencies": {
57+
"com.gameframex.unity.network": "2.6.6"
58+
}
59+
}
60+
```
61+
62+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
63+
64+
2. `manifest.json``dependencies`에 직접 추가:
65+
```json
66+
{
67+
"com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
68+
}
69+
```
70+
3. Unity의 **Package Manager**에서 **Git URL**을 사용하여 추가: `https://github.com/gameframex/com.gameframex.unity.network.git`
71+
4. 리포지토리를 Unity 프로젝트의 `Packages` 디렉토리에 클론하세요. 자동으로 로드됩니다.
7172
## 플랫폼 지원
7273

7374
| 플랫폼 | 지원 |

README.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -39,34 +39,36 @@ All-in-One Solution for Indie Game Development · Empowering Indie Developers' D
3939

4040
### Installation
4141

42-
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
43-
44-
```json
45-
{
46-
"scopedRegistries": [
47-
{
48-
"name": "GameFrameX",
49-
"url": "https://gameframex.upm.alianblank.uk",
50-
"scopes": [
51-
"com.gameframex"
52-
]
53-
}
54-
]
55-
}
56-
```
57-
58-
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
59-
60-
Then add the package to `dependencies`:
61-
62-
```json
63-
{
64-
"dependencies": {
65-
"com.gameframex.unity.network": "2.6.6"
66-
}
67-
}
68-
```
69-
42+
Choose one of the following methods:
43+
44+
1. Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
45+
```json
46+
{
47+
"scopedRegistries": [
48+
{
49+
"name": "GameFrameX",
50+
"url": "https://gameframex.upm.alianblank.uk",
51+
"scopes": [
52+
"com.gameframex"
53+
]
54+
}
55+
],
56+
"dependencies": {
57+
"com.gameframex.unity.network": "2.6.6"
58+
}
59+
}
60+
```
61+
62+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
63+
64+
2. Add to `manifest.json` dependencies:
65+
```json
66+
{
67+
"com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
68+
}
69+
```
70+
3. Use **Package Manager** in Unity with **Git URL**: `https://github.com/gameframex/com.gameframex.unity.network.git`
71+
4. Clone the repository into your Unity project's `Packages` directory. It will be loaded automatically.
7072
## Platform Support
7173

7274
| Platform | Supported |

README.zh-CN.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -39,34 +39,36 @@
3939

4040
### 安装
4141

42-
编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
43-
44-
```json
45-
{
46-
"scopedRegistries": [
47-
{
48-
"name": "GameFrameX",
49-
"url": "https://gameframex.upm.alianblank.uk",
50-
"scopes": [
51-
"com.gameframex"
52-
]
53-
}
54-
]
55-
}
56-
```
57-
58-
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
59-
60-
Then add the package to `dependencies`:
61-
62-
```json
63-
{
64-
"dependencies": {
65-
"com.gameframex.unity.network": "2.6.6"
66-
}
67-
}
68-
```
69-
42+
选择以下任一方式:
43+
44+
1. 编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
45+
```json
46+
{
47+
"scopedRegistries": [
48+
{
49+
"name": "GameFrameX",
50+
"url": "https://gameframex.upm.alianblank.uk",
51+
"scopes": [
52+
"com.gameframex"
53+
]
54+
}
55+
],
56+
"dependencies": {
57+
"com.gameframex.unity.network": "2.6.6"
58+
}
59+
}
60+
```
61+
62+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
63+
64+
2. 直接在 `manifest.json``dependencies` 节点下添加以下内容:
65+
```json
66+
{
67+
"com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
68+
}
69+
```
70+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加库,地址为:`https://github.com/gameframex/com.gameframex.unity.network.git`
71+
4. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下,会自动加载识别。
7072
## 平台支持
7173

7274
| 平台 | 支持 |

README.zh-TW.md

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

4040
### 安裝
4141

42-
編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
43-
44-
```json
45-
{
46-
"scopedRegistries": [
47-
{
48-
"name": "GameFrameX",
49-
"url": "https://gameframex.upm.alianblank.uk",
50-
"scopes": [
51-
"com.gameframex"
52-
]
53-
}
54-
]
55-
}
56-
```
57-
58-
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
59-
60-
Then add the package to `dependencies`:
61-
62-
```json
63-
{
64-
"dependencies": {
65-
"com.gameframex.unity.network": "2.6.6"
66-
}
67-
}
68-
```
69-
70-
42+
選擇以下任一方式:
43+
44+
1. 編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
45+
```json
46+
{
47+
"scopedRegistries": [
48+
{
49+
"name": "GameFrameX",
50+
"url": "https://gameframex.upm.alianblank.uk",
51+
"scopes": [
52+
"com.gameframex"
53+
]
54+
}
55+
],
56+
"dependencies": {
57+
"com.gameframex.unity.network": "2.6.6"
58+
}
59+
}
60+
```
61+
62+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
63+
64+
2. 直接在 `manifest.json``dependencies` 節點下添加以下內容:
65+
```json
66+
{
67+
"com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
68+
}
69+
```
70+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加庫,地址為:`https://github.com/gameframex/com.gameframex.unity.network.git`
71+
4. 直接下載倉庫放置到 Unity 專案的 `Packages` 目錄下,會自動載入識別。
7172
## 平台支援
7273

7374
| 平台 | 支援 |

0 commit comments

Comments
 (0)