docs: 补全 Quick Start 中的 UPM scopedRegistries 安装说明

AlianBlank · claude · AlianBlank · commit 8d3dc1ebd7b5 · 2026-06-07T16:08:05.000+08:00
Co-Authored-By: Claude Opus 4.7 &lt;noreply@anthropic.com&gt;
diff --git a/README.ja.md b/README.ja.md
@@ -31,33 +31,36 @@
 
 ## インストール
 
-### 依存関係
+### インストール
+
+Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください：
 
 ```json
 {
-  "com.gameframex.unity": "1.1.1",
-  "com.gameframex.unity.ui": "1.0.0",
-  "com.gameframex.unity.asset": "1.0.6",
-  "com.gameframex.unity.event": "1.0.0"
+  "scopedRegistries": [
+    {
+      "name": "GameFrameX",
+      "url": "https://gameframex.upm.alianblank.uk",
+      "scopes": [
+        "com.gameframex"
+      ]
+    }
+  ]
 }
 ```
 
-### インストール方法（いずれかを選択）
+`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
 
-1. **Package Manager (推奨)**
-   - Unity エディタを開く
-   - Package Manager ウィンドウを開く
-   - "+" ボタンをクリックし、「Add package from git URL」を選択
-   - 入力: `https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
+Then add the package to `dependencies`:
 
-2. **manifest.json**
-   - `manifest.json` ファイルの `dependencies` セクションに追加
-   ```json
-   {"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"}
-   ```
+```json
+{
+  "dependencies": {
+    "com.gameframex.unity.ui.ugui": "2.5.1"
+  }
+}
+```
 
-3. **ローカルインストール**
-   - リポジトリをダウンロードして Unity プロジェクトの `Packages` ディレクトリに配置。自動検出されます。
 
 ## ライセンス
 
diff --git a/README.ko.md b/README.ko.md
@@ -31,33 +31,36 @@
 
 ## 설치
 
-### 종속성
+### 설치
+
+Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
 
 ```json
 {
-  "com.gameframex.unity": "1.1.1",
-  "com.gameframex.unity.ui": "1.0.0",
-  "com.gameframex.unity.asset": "1.0.6",
-  "com.gameframex.unity.event": "1.0.0"
+  "scopedRegistries": [
+    {
+      "name": "GameFrameX",
+      "url": "https://gameframex.upm.alianblank.uk",
+      "scopes": [
+        "com.gameframex"
+      ]
+    }
+  ]
 }
 ```
 
-### 설치 방법 (택 1)
+`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
 
-1. **Package Manager (권장)**
-   - Unity 에디터 열기
-   - Package Manager 창 열기
-   - "+" 버튼을 클릭하고 "Add package from git URL" 선택
-   - 입력: `https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
+Then add the package to `dependencies`:
 
-2. **manifest.json**
-   - `manifest.json` 파일의 `dependencies` 섹션에 추가
-   ```json
-   {"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"}
-   ```
+```json
+{
+  "dependencies": {
+    "com.gameframex.unity.ui.ugui": "2.5.1"
+  }
+}
+```
 
-3. **로컬 설치**
-   - 저장소를 다운로드하여 Unity 프로젝트의 `Packages` 디렉토리에 배치. 자동 감지됩니다.
 
 ## 라이선스
 
diff --git a/README.md b/README.md
@@ -81,87 +81,36 @@ All-in-One Solution for Indie Game Development · Empowering Indie Developers' D
 
 ## Quick Start
 
-### 1. Basic UI Class Creation
+### Installation
 
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-using UnityEngine;
+Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
 
-public class MainMenuUI : UGUI
+```json
 {
-    protected override void OnInit(object userData)
-    {
-        base.OnInit(userData);
-        // Initialize UI logic
-    }
-
-    protected override void OnOpen(object userData)
-    {
-        base.OnOpen(userData);
-        // Logic when UI opens
-    }
-
-    protected override void OnClose(bool isShutdown, object userData)
+  "scopedRegistries": [
     {
-        base.OnClose(isShutdown, userData);
-        // Logic when UI closes
+      "name": "GameFrameX",
+      "url": "https://gameframex.upm.alianblank.uk",
+      "scopes": [
+        "com.gameframex"
+      ]
     }
+  ]
 }
 ```
 
-### 2. Using Extension Methods
+`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
 
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-using UnityEngine.UI;
+Then add the package to `dependencies`:
 
-public class UIController : MonoBehaviour
+```json
 {
-    [SerializeField] private Button startButton;
-    [SerializeField] private Image iconImage;
-    [SerializeField] private RectTransform panel;
-
-    void Start()
-    {
-        // Button extension method
-        startButton.onClick.Add(OnStartButtonClick);
-
-        // Image extension method
-        iconImage.SetIcon("UI/Icons/StartIcon");
-
-        // RectTransform extension method
-        panel.MakeFullScreen();
-    }
-
-    private void OnStartButtonClick()
-    {
-        Debug.Log("Start button clicked!");
-    }
+  "dependencies": {
+    "com.gameframex.unity.ui.ugui": "2.5.1"
+  }
 }
 ```
 
-### 3. Using the Code Generator
-
-1. Select a UGUI prefab in the Hierarchy
-2. Right-click and select `GameObject/UI/Generate UGUI Code`
-3. Code will be auto-generated in the `Assets/Hotfix/UI/UGUI/` directory
-
-### 4. Using UIImage Component
-
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-
-public class IconDisplay : MonoBehaviour
-{
-    [SerializeField] private UIImage iconImage;
-
-    void Start()
-    {
-        // Set icon with async loading support
-        iconImage.icon = "UI/Icons/PlayerAvatar";
-    }
-}
-```
 
 ## License
 
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -81,87 +81,36 @@
 
 ## 快速开始
 
-### 1. 基本UI类创建
+### 安装
 
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-using UnityEngine;
+编辑 Unity 项目的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
 
-public class MainMenuUI : UGUI
+```json
 {
-    protected override void OnInit(object userData)
-    {
-        base.OnInit(userData);
-        // 初始化UI逻辑
-    }
-
-    protected override void OnOpen(object userData)
-    {
-        base.OnOpen(userData);
-        // UI打开时的逻辑
-    }
-
-    protected override void OnClose(bool isShutdown, object userData)
+  "scopedRegistries": [
     {
-        base.OnClose(isShutdown, userData);
-        // UI关闭时的逻辑
+      "name": "GameFrameX",
+      "url": "https://gameframex.upm.alianblank.uk",
+      "scopes": [
+        "com.gameframex"
+      ]
     }
+  ]
 }
 ```
 
-### 2. 使用扩展方法
+`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
 
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-using UnityEngine.UI;
+Then add the package to `dependencies`:
 
-public class UIController : MonoBehaviour
+```json
 {
-    [SerializeField] private Button startButton;
-    [SerializeField] private Image iconImage;
-    [SerializeField] private RectTransform panel;
-
-    void Start()
-    {
-        // 按钮扩展方法
-        startButton.onClick.Add(OnStartButtonClick);
-
-        // 图片扩展方法
-        iconImage.SetIcon("UI/Icons/StartIcon");
-
-        // RectTransform扩展方法
-        panel.MakeFullScreen();
-    }
-
-    private void OnStartButtonClick()
-    {
-        Debug.Log("Start button clicked!");
-    }
+  "dependencies": {
+    "com.gameframex.unity.ui.ugui": "2.5.1"
+  }
 }
 ```
 
-### 3. 使用代码生成器
-
-1. 在Hierarchy中选择一个UGUI预制体
-2. 右键选择 `GameObject/UI/Generate UGUI Code(生成UGUI代码)`
-3. 代码将自动生成到 `Assets/Hotfix/UI/UGUI/` 目录下
-
-### 4. 使用UIImage组件
-
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-
-public class IconDisplay : MonoBehaviour
-{
-    [SerializeField] private UIImage iconImage;
-
-    void Start()
-    {
-        // 设置图标，支持异步加载
-        iconImage.icon = "UI/Icons/PlayerAvatar";
-    }
-}
-```
 
 ## 开源协议
 
diff --git a/README.zh-TW.md b/README.zh-TW.md
@@ -81,34 +81,37 @@
 
 ## 快速開始
 
-### 1. 基本 UI 類創建
+### 安裝
 
-```csharp
-using GameFrameX.UI.UGUI.Runtime;
-using UnityEngine;
+編輯 Unity 專案的 `Packages/manifest.json`，添加 `scopedRegistries` 部分：
 
-public class MainMenuUI : UGUI
+```json
 {
-    protected override void OnInit(object userData)
+  "scopedRegistries": [
     {
-        base.OnInit(userData);
-        // 初始化 UI 邏輯
+      "name": "GameFrameX",
+      "url": "https://gameframex.upm.alianblank.uk",
+      "scopes": [
+        "com.gameframex"
+      ]
     }
+  ]
+}
+```
 
-    protected override void OnOpen(object userData)
-    {
-        base.OnOpen(userData);
-        // UI 打開時的邏輯
-    }
+`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
 
-    protected override void OnClose(bool isShutdown, object userData)
-    {
-        base.OnClose(isShutdown, userData);
-        // UI 關閉時的邏輯
-    }
+Then add the package to `dependencies`:
+
+```json
+{
+  "dependencies": {
+    "com.gameframex.unity.ui.ugui": "2.5.1"
+  }
 }
 ```
 
+
 ## 開源協議
 
 詳見 [LICENSE.md](LICENSE.md) 檔案。
