快速上手

重要 注意 提醒

Coding Style wiki

---

開始安裝 OxGFrame with YooAsset + HybridCLR

步驟 1. (安裝依賴)

• 1 UniTask

透過 Package Manager 安裝 (Install via git)

https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask

• 2 LWMyBox

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/LWMyBox.git

• 3 OxGKit.LoggingSystem

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts

• 4 OxGKit.SaverSystem

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/SaverSystem/Scripts

• 5 OxGKit.TimeSystem

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/TimeSystem/Scripts

• 6 OxGKit.Utilities

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/Utilities/Scripts

• 7 HybirdCLR

透過 Package Manager 安裝 (Install via git)

https://github.com/focus-creative-games/hybridclr_unity.git

• 8 YooAsset - v3.6.0 以上需要

透過 Package Manager 安裝 (Install via git)

https://github.com/tuyoogame/YooAsset.git?path=Assets/YooAsset

• New Project TextMeshPro

透過 Package Manager 安裝 (Install by name)

com.unity.textmeshpro

• New Project Newtonsoft

透過 Package Manager 安裝 (Install by name)

com.unity.nuget.newtonsoft-json

---

步驟 2. (安裝框架)

方法一

OxGFrame

透過 Package Manager 安裝 (Install via git)

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame

管理組件匯入 (Samples)

方法二

直接下載原碼 (Code Download ZIP)

複製 OxGFrame 文件夾到 Unity 新專案的 Assets 底下。

提醒 如果沒有要自行更改框架的需求，建議直接使用 Package Manager 方式安裝。

方法三

如果只有特定模塊使用需求，可以單獨安裝該模塊。

重要 自 v3.7.0 起，各模塊皆依賴 Common 模塊（Package Manager 不會自動安裝套件內宣告的 git 依賴），單獨安裝任一模塊前，請先安裝 Common。

• Common (框架共用基礎模塊)

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/Common

• AssetLoader

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/AssetLoader

• CoreFrame (依賴 AssetLoader)

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/CoreFrame

• MediaFrame (依賴 AssetLoader)

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/MediaFrame

• Hotfixer (依賴 AssetLoader)

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/Hotfixer

• GSIFrame

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/GSIFrame

• CenterFrame

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/CenterFrame

• NetFrame

https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame/NetFrame

---

AI 輔助開發 (AI Agent Skills)

OxGFrame 支援使用 AI 編碼代理（Claude Code、OpenAI Codex CLI、Cursor、Copilot 等）輔助開發，框架內建對應的 Agent Skill——匯入與安裝方式詳見 AI Agent Skills。

---

內置第三方依賴庫

• 使用 UniFramework (UniEvent, UniMachine, UniReference)。
• 使用 UnityWebSocket (最佳 WebSocket 解決方案) 特別推薦。
• 使用 MirrorNetworking - Telepathy TCP (TCP 解決方案)。
• 使用 MirrorNetworking - KCP2K (KCP 解決方案)。
• 使用 DiskUtils by keerthik (DiskUtils 解決方案)。

---

宏定義

• Macro Definitions

框架 API

• Hotfixers (using OxGFrame.Hotfixer)
• AssetLoaders (using OxGFrame.AssetLoader)
• AssetPatcher (using OxGFrame.AssetLoader)
• CoreFrames (using OxGFrame.CoreFrame)
• MediaFrames (using OxGFrame.MediaFrame)
• NetFrames (using OxGFrame.NetFrame)

※備註 : 建議詳看各模塊的 Example (注意 "res#" 跟 "build#" 的使用規則)。

額外有需要編寫 BuildTool 的可以調用

• Editor

  • HotfixHelper (using OxGFrame.Hotfix.Editor)
  • BundleHelper (using OxGFrame.AssetLoader.Editor)
  • MediaHelper (using OxGFrame.MediaFrame.Editor)

• Runtime

  • BundleConfig (using OxGFrame.AssetLoader.Bundle)
  • PatchSettings (using OxGFrame.AssetLoader)
    • PatchSettings.settings (Singleton instance)
  • YooAssetBridge (using OxGFrame.AssetLoader.Bundle)

框架配置

可以透過 Right-Click 建立配置文件，進行部分設定客製化。

PatchSettings

HotfixSettings

CodeBindingSettings

CryptogramSettings