Skip to content

Commit f602ffb

Browse files
AlianBlankclaude
AlianBlank
and
claude
committed
docs: 补全 Quick Start 中的 UPM scopedRegistries 安装说明
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 1fe1602 commit f602ffb

5 files changed

Lines changed: 82 additions & 297 deletions

File tree

‎README.ja.md‎

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

7070
### インストール
7171

72-
以下のいずれかの方法を選択してください：
73-
74-
**方法 1: manifest.json**
75-
76-
プロジェクトの `Packages/manifest.json` の `dependencies` に追加：
72+
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
7773

7874
```json
7975
{
80-
"com.gameframex.unity.ui.fairygui": "https://github.com/AlianBlank/com.gameframex.unity.ui.fairygui.git"
76+
"scopedRegistries": [
77+
{
78+
"name": "GameFrameX",
79+
"url": "https://gameframex.upm.alianblank.uk",
80+
"scopes": [
81+
"com.gameframex"
82+
]
83+
}
84+
]
8185
}
8286
```
8387

84-
**方法 2: Unity Package Manager（Git URL）**
85-
86-
Unity Package Manager を開き、Git URL から追加：
87-
88-
```
89-
https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git
90-
```
91-
92-
**方法 3: 手動インストール**
93-
94-
リポジトリをダウンロードして Unity プロジェクトの `Packages/` ディレクトリに配置します。Unity が自動的に認識します。
95-
96-
### 依存関係
97-
98-
| パッケージ | バージョン | 説明 |
99-
|-----------|-----------|------|
100-
| `com.gameframex.unity` | ≥ 1.1.1 | コアフレームワークランタイム |
101-
| `com.gameframex.unity.ui` | ≥ 1.0.0 | 基本 UI 抽象レイヤー |
102-
| `com.gameframex.unity.asset` | ≥ 1.0.6 | アセットローディングシステム |
103-
| `com.gameframex.unity.event` | ≥ 1.0.0 | イベントシステム |
104-
| FairyGUI Runtime | — | FairyGUI ライブラリ |
105-
| YooAsset | — | アセット管理 |
106-
| UniTask | — | 非同期/await サポート |
107-
108-
### 基本的な使い方
109-
110-
1. **`FairyGUIPackageComponent` をシーンに追加**（`GameFrameX → FairyGUIPackage` メニューから）
88+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
11189

112-
2. **`FUI` を継承して UI パネルを作成**：
90+
Then add the package to `dependencies`:
11391

114-
```csharp
115-
using GameFrameX.UI.FairyGUI.Runtime;
116-
117-
[OptionUIGroup("Default")]
118-
public class MyPanel : FUI
92+
```json
11993
{
120-
protected override void OnInit()
121-
{
122-
// UI 要素の初期化
123-
}
124-
125-
protected override void OnOpen(object userData)
126-
{
127-
// オープン時の処理
128-
}
129-
130-
protected override void OnClose()
131-
{
132-
// クローズ時の処理
133-
}
94+
"dependencies": {
95+
"com.gameframex.unity.ui.fairygui": "3.3.2"
96+
}
13497
}
13598
```
13699

137-
3. **フレームワークの UI コンポーネントからパネルを開く**：
138-
139-
```csharp
140-
// UI パネルを非同期でオープン
141-
await GameEntry.GetComponent<UIComponent>().OpenUIFormAsync("MyPackage", "MyPanel");
142-
```
143100

144101
## 使用例
145102

‎README.ko.md‎

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

6969
### 설치
7070

71-
다음 방법 중 하나를 선택하세요:
72-
73-
**방법 1: manifest.json**
74-
75-
프로젝트의 `Packages/manifest.json`의 `dependencies`에 추가:
71+
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
7672

7773
```json
7874
{
79-
"com.gameframex.unity.ui.fairygui": "https://github.com/AlianBlank/com.gameframex.unity.ui.fairygui.git"
75+
"scopedRegistries": [
76+
{
77+
"name": "GameFrameX",
78+
"url": "https://gameframex.upm.alianblank.uk",
79+
"scopes": [
80+
"com.gameframex"
81+
]
82+
}
83+
]
8084
}
8185
```
8286

83-
**방법 2: Unity Package Manager (Git URL)**
84-
85-
Unity Package Manager를 열고 Git URL에서 추가:
86-
87-
```
88-
https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git
89-
```
90-
91-
**방법 3: 수동 설치**
92-
93-
리포지토리를 다운로드하여 Unity 프로젝트의 `Packages/` 디렉토리에 배치합니다. Unity가 자동으로 인식합니다.
94-
95-
### 의존성
96-
97-
| 패키지 | 버전 | 설명 |
98-
|--------|------|------|
99-
| `com.gameframex.unity` | ≥ 1.1.1 | 코어 프레임워크 런타임 |
100-
| `com.gameframex.unity.ui` | ≥ 1.0.0 | 기본 UI 추상화 레이어 |
101-
| `com.gameframex.unity.asset` | ≥ 1.0.6 | 에셋 로딩 시스템 |
102-
| `com.gameframex.unity.event` | ≥ 1.0.0 | 이벤트 시스템 |
103-
| FairyGUI Runtime | — | FairyGUI 라이브러리 |
104-
| YooAsset | — | 에셋 관리 |
105-
| UniTask | — | 비동기/await 지원 |
106-
107-
### 기본 사용법
108-
109-
1. **`FairyGUIPackageComponent`를 씬에 추가** (`GameFrameX → FairyGUIPackage` 메뉴에서)
87+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
11088

111-
2. **`FUI`를 상속하여 UI 패널 생성**:
89+
Then add the package to `dependencies`:
11290

113-
```csharp
114-
using GameFrameX.UI.FairyGUI.Runtime;
115-
116-
[OptionUIGroup("Default")]
117-
public class MyPanel : FUI
91+
```json
11892
{
119-
protected override void OnInit()
120-
{
121-
// UI 요소 초기화
122-
}
123-
124-
protected override void OnOpen(object userData)
125-
{
126-
// 열기 로직 처리
127-
}
128-
129-
protected override void OnClose()
130-
{
131-
// 닫기 로직 처리
132-
}
93+
"dependencies": {
94+
"com.gameframex.unity.ui.fairygui": "3.3.2"
95+
}
13396
}
13497
```
13598

136-
3. **프레임워크 UI 컴포넌트로 패널 열기**:
137-
138-
```csharp
139-
// UI 패널 비동기 열기
140-
await GameEntry.GetComponent<UIComponent>().OpenUIFormAsync("MyPackage", "MyPanel");
141-
```
14299

143100
## 사용 예시
144101

‎README.md‎

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

6969
### Installation
7070

71-
Choose one of the following methods:
72-
73-
**Method 1: manifest.json**
74-
75-
Add the following to your project's `Packages/manifest.json` under `dependencies`:
71+
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
7672

7773
```json
7874
{
79-
"com.gameframex.unity.ui.fairygui": "https://github.com/AlianBlank/com.gameframex.unity.ui.fairygui.git"
75+
"scopedRegistries": [
76+
{
77+
"name": "GameFrameX",
78+
"url": "https://gameframex.upm.alianblank.uk",
79+
"scopes": [
80+
"com.gameframex"
81+
]
82+
}
83+
]
8084
}
8185
```
8286

83-
**Method 2: Unity Package Manager (Git URL)**
84-
85-
Open Unity Package Manager → Add package from git URL:
86-
87-
```
88-
https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git
89-
```
90-
91-
**Method 3: Manual**
92-
93-
Download the repository and place it in your Unity project's `Packages/` directory. Unity will auto-detect it.
94-
95-
### Dependencies
96-
97-
| Package | Version | Description |
98-
|---------|---------|-------------|
99-
| `com.gameframex.unity` | ≥ 1.1.1 | Core framework runtime |
100-
| `com.gameframex.unity.ui` | ≥ 1.0.0 | Base UI abstraction layer |
101-
| `com.gameframex.unity.asset` | ≥ 1.0.6 | Asset loading system |
102-
| `com.gameframex.unity.event` | ≥ 1.0.0 | Event system |
103-
| FairyGUI Runtime | — | FairyGUI library |
104-
| YooAsset | — | Asset management |
105-
| UniTask | — | Async/await support |
106-
107-
### Basic Usage
108-
109-
1. **Add `FairyGUIPackageComponent`** to your scene (via `GameFrameX → FairyGUIPackage` menu)
87+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
11088

111-
2. **Create a UI panel** by inheriting from `FUI`:
89+
Then add the package to `dependencies`:
11290

113-
```csharp
114-
using GameFrameX.UI.FairyGUI.Runtime;
115-
116-
[OptionUIGroup("Default")]
117-
public class MyPanel : FUI
91+
```json
11892
{
119-
protected override void OnInit()
120-
{
121-
// Initialize UI elements
122-
}
123-
124-
protected override void OnOpen(object userData)
125-
{
126-
// Handle open logic
127-
}
128-
129-
protected override void OnClose()
130-
{
131-
// Handle close logic
132-
}
93+
"dependencies": {
94+
"com.gameframex.unity.ui.fairygui": "3.3.2"
95+
}
13396
}
13497
```
13598

136-
3. **Open the panel** through the framework's UI component:
137-
138-
```csharp
139-
// Open a UI panel asynchronously
140-
await GameEntry.GetComponent<UIComponent>().OpenUIFormAsync("MyPackage", "MyPanel");
141-
```
14299

143100
## Usage Examples
144101

‎README.zh-CN.md‎

Lines changed: 17 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -66,79 +66,36 @@ GameFrameX UI FairyGUI 是一个 Unity UI 适配器，将 [FairyGUI](https://www
6666

6767
## 快速开始
6868

69-
### 安装方式
69+
### 安装
7070

71-
选择以下任一方式安装：
72-
73-
**方式一：manifest.json**
74-
75-
在项目的 `Packages/manifest.json` 的 `dependencies` 节点下添加：
71+
编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
7672

7773
```json
7874
{
79-
"com.gameframex.unity.ui.fairygui": "https://github.com/AlianBlank/com.gameframex.unity.ui.fairygui.git"
75+
"scopedRegistries": [
76+
{
77+
"name": "GameFrameX",
78+
"url": "https://gameframex.upm.alianblank.uk",
79+
"scopes": [
80+
"com.gameframex"
81+
]
82+
}
83+
]
8084
}
8185
```
8286

83-
**方式二：Unity Package Manager（Git URL）**
84-
85-
打开 Unity Package Manager → 通过 Git URL 添加：
86-
87-
```
88-
https://github.com/gameframex/com.gameframex.unity.ui.fairygui.git
89-
```
90-
91-
**方式三：手动安装**
92-
93-
下载仓库并放置到 Unity 项目的 `Packages/` 目录下，Unity 会自动识别。
94-
95-
### 依赖项
96-
97-
| 包名 | 版本 | 说明 |
98-
|------|------|------|
99-
| `com.gameframex.unity` | ≥ 1.1.1 | 核心框架运行时 |
100-
| `com.gameframex.unity.ui` | ≥ 1.0.0 | 基础 UI 抽象层 |
101-
| `com.gameframex.unity.asset` | ≥ 1.0.6 | 资源加载系统 |
102-
| `com.gameframex.unity.event` | ≥ 1.0.0 | 事件系统 |
103-
| FairyGUI Runtime | — | FairyGUI 库 |
104-
| YooAsset | — | 资源管理 |
105-
| UniTask | — | 异步等待支持 |
106-
107-
### 基本使用
108-
109-
1. **添加 `FairyGUIPackageComponent`** 到场景中（通过 `GameFrameX → FairyGUIPackage` 菜单）
87+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
11088

111-
2. **继承 `FUI` 创建 UI 面板**：
89+
Then add the package to `dependencies`:
11290

113-
```csharp
114-
using GameFrameX.UI.FairyGUI.Runtime;
115-
116-
[OptionUIGroup("Default")]
117-
public class MyPanel : FUI
91+
```json
11892
{
119-
protected override void OnInit()
120-
{
121-
// 初始化 UI 元素
122-
}
123-
124-
protected override void OnOpen(object userData)
125-
{
126-
// 处理打开逻辑
127-
}
128-
129-
protected override void OnClose()
130-
{
131-
// 处理关闭逻辑
132-
}
93+
"dependencies": {
94+
"com.gameframex.unity.ui.fairygui": "3.3.2"
95+
}
13396
}
13497
```
13598

136-
3. **通过框架 UI 组件打开面板**：
137-
138-
```csharp
139-
// 异步打开 UI 面板
140-
await GameEntry.GetComponent<UIComponent>().OpenUIFormAsync("MyPackage", "MyPanel");
141-
```
14299

143100
## 使用示例
144101

0 commit comments

Comments
 (0)