Skip to content

Commit 9d31cef

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 1b8afce commit 9d31cef

5 files changed

Lines changed: 150 additions & 145 deletions

File tree

‎README.ja.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -69,35 +69,36 @@ GameFrameX UI FairyGUI は、[FairyGUI](https://www.fairygui.com/) フレーム
6969

7070
### インストール
7171

72-
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
73-
74-
```json
75-
{
76-
"scopedRegistries": [
77-
{
78-
"name": "GameFrameX",
79-
"url": "https://gameframex.upm.alianblank.uk",
80-
"scopes": [
81-
"com.gameframex"
82-
]
83-
}
84-
]
85-
}
86-
```
87-
88-
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
89-
90-
Then add the package to `dependencies`:
91-
92-
```json
93-
{
94-
"dependencies": {
95-
"com.gameframex.unity.ui.fairygui": "3.3.2"
96-
}
97-
}
98-
```
99-
100-
72+
以下のいずれかの方法を選択してください：
73+
74+
1. Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
75+
```json
76+
{
77+
"scopedRegistries": [
78+
{
79+
"name": "GameFrameX",
80+
"url": "https://gameframex.upm.alianblank.uk",
81+
"scopes": [
82+
"com.gameframex"
83+
]
84+
}
85+
],
86+
"dependencies": {
87+
"com.gameframex.unity.ui.fairygui": "3.3.2"
88+
}
89+
}
90+
```
91+
92+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
93+
94+
2. `manifest.json` の `dependencies` に直接追加：
95+
```json
96+
{
97+
"com.gameframex.unity.ui.fairygui": "https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git"
98+
}
99+
```
100+
3. Unity の **Package Manager** で **Git URL** を使用して追加：`https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git`
101+
4. リポジトリを Unity プロジェクトの `Packages` ディレクトリにクローンしてください。自動的に読み込まれます。
101102
## 使用例
102103

103104
### 表示/非表示アニメーション

‎README.ko.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,35 +68,36 @@ GameFrameX UI FairyGUI는 [FairyGUI](https://www.fairygui.com/) 프레임워크
6868

6969
### 설치
7070

71-
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
72-
73-
```json
74-
{
75-
"scopedRegistries": [
76-
{
77-
"name": "GameFrameX",
78-
"url": "https://gameframex.upm.alianblank.uk",
79-
"scopes": [
80-
"com.gameframex"
81-
]
82-
}
83-
]
84-
}
85-
```
86-
87-
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
88-
89-
Then add the package to `dependencies`:
90-
91-
```json
92-
{
93-
"dependencies": {
94-
"com.gameframex.unity.ui.fairygui": "3.3.2"
95-
}
96-
}
97-
```
98-
99-
71+
다음 방법 중 하나를 선택하세요:
72+
73+
1. Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
74+
```json
75+
{
76+
"scopedRegistries": [
77+
{
78+
"name": "GameFrameX",
79+
"url": "https://gameframex.upm.alianblank.uk",
80+
"scopes": [
81+
"com.gameframex"
82+
]
83+
}
84+
],
85+
"dependencies": {
86+
"com.gameframex.unity.ui.fairygui": "3.3.2"
87+
}
88+
}
89+
```
90+
91+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
92+
93+
2. `manifest.json`의 `dependencies`에 직접 추가:
94+
```json
95+
{
96+
"com.gameframex.unity.ui.fairygui": "https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git"
97+
}
98+
```
99+
3. Unity의 **Package Manager**에서 **Git URL**을 사용하여 추가: `https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git`
100+
4. 리포지토리를 Unity 프로젝트의 `Packages` 디렉토리에 클론하세요. 자동으로 로드됩니다.
100101
## 사용 예시
101102

102103
### 표시/숨기기 애니메이션

‎README.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,35 +68,36 @@ GameFrameX UI FairyGUI is a Unity UI adapter that wraps the [FairyGUI](https://w
6868

6969
### Installation
7070

71-
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
72-
73-
```json
74-
{
75-
"scopedRegistries": [
76-
{
77-
"name": "GameFrameX",
78-
"url": "https://gameframex.upm.alianblank.uk",
79-
"scopes": [
80-
"com.gameframex"
81-
]
82-
}
83-
]
84-
}
85-
```
86-
87-
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
88-
89-
Then add the package to `dependencies`:
90-
91-
```json
92-
{
93-
"dependencies": {
94-
"com.gameframex.unity.ui.fairygui": "3.3.2"
95-
}
96-
}
97-
```
98-
99-
71+
Choose one of the following methods:
72+
73+
1. Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
74+
```json
75+
{
76+
"scopedRegistries": [
77+
{
78+
"name": "GameFrameX",
79+
"url": "https://gameframex.upm.alianblank.uk",
80+
"scopes": [
81+
"com.gameframex"
82+
]
83+
}
84+
],
85+
"dependencies": {
86+
"com.gameframex.unity.ui.fairygui": "3.3.2"
87+
}
88+
}
89+
```
90+
91+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
92+
93+
2. Add to `manifest.json` dependencies:
94+
```json
95+
{
96+
"com.gameframex.unity.ui.fairygui": "https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git"
97+
}
98+
```
99+
3. Use **Package Manager** in Unity with **Git URL**: `https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git`
100+
4. Clone the repository into your Unity project's `Packages` directory. It will be loaded automatically.
100101
## Usage Examples
101102

102103
### Show/Hide Animations

‎README.zh-CN.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,35 +68,36 @@ GameFrameX UI FairyGUI 是一个 Unity UI 适配器，将 [FairyGUI](https://www
6868

6969
### 安装
7070

71-
编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
72-
73-
```json
74-
{
75-
"scopedRegistries": [
76-
{
77-
"name": "GameFrameX",
78-
"url": "https://gameframex.upm.alianblank.uk",
79-
"scopes": [
80-
"com.gameframex"
81-
]
82-
}
83-
]
84-
}
85-
```
86-
87-
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
88-
89-
Then add the package to `dependencies`:
90-
91-
```json
92-
{
93-
"dependencies": {
94-
"com.gameframex.unity.ui.fairygui": "3.3.2"
95-
}
96-
}
97-
```
98-
99-
71+
选择以下任一方式：
72+
73+
1. 编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
74+
```json
75+
{
76+
"scopedRegistries": [
77+
{
78+
"name": "GameFrameX",
79+
"url": "https://gameframex.upm.alianblank.uk",
80+
"scopes": [
81+
"com.gameframex"
82+
]
83+
}
84+
],
85+
"dependencies": {
86+
"com.gameframex.unity.ui.fairygui": "3.3.2"
87+
}
88+
}
89+
```
90+
91+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
92+
93+
2. 直接在 `manifest.json` 的 `dependencies` 节点下添加以下内容：
94+
```json
95+
{
96+
"com.gameframex.unity.ui.fairygui": "https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git"
97+
}
98+
```
99+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加库，地址为：`https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git`
100+
4. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下，会自动加载识别。
100101
## 使用示例
101102

102103
### 显示/隐藏动画

‎README.zh-TW.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,35 +68,36 @@ GameFrameX UI FairyGUI 是一個 Unity UI 適配器，將 [FairyGUI](https://www
6868

6969
### 安裝
7070

71-
編輯 Unity 專案的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
72-
73-
```json
74-
{
75-
"scopedRegistries": [
76-
{
77-
"name": "GameFrameX",
78-
"url": "https://gameframex.upm.alianblank.uk",
79-
"scopes": [
80-
"com.gameframex"
81-
]
82-
}
83-
]
84-
}
85-
```
86-
87-
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
88-
89-
Then add the package to `dependencies`:
90-
91-
```json
92-
{
93-
"dependencies": {
94-
"com.gameframex.unity.ui.fairygui": "3.3.2"
95-
}
96-
}
97-
```
98-
99-
71+
選擇以下任一方式：
72+
73+
1. 編輯 Unity 專案的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
74+
```json
75+
{
76+
"scopedRegistries": [
77+
{
78+
"name": "GameFrameX",
79+
"url": "https://gameframex.upm.alianblank.uk",
80+
"scopes": [
81+
"com.gameframex"
82+
]
83+
}
84+
],
85+
"dependencies": {
86+
"com.gameframex.unity.ui.fairygui": "3.3.2"
87+
}
88+
}
89+
```
90+
91+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
92+
93+
2. 直接在 `manifest.json` 的 `dependencies` 節點下添加以下內容：
94+
```json
95+
{
96+
"com.gameframex.unity.ui.fairygui": "https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git"
97+
}
98+
```
99+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加庫，地址為：`https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git`
100+
4. 直接下載倉庫放置到 Unity 專案的 `Packages` 目錄下，會自動載入識別。
100101
## 使用範例
101102

102103
### 顯示/隱藏動畫

0 commit comments

Comments
 (0)