michael811125/OxGFrame

安裝 OxGFrame with YooAsset + HybridCLR

以上各模組的日誌打印可以自由控制開關，皆依賴 OxGKit.LoggingSystem，安裝後需要 Import LoggingLauncher from Samples，再拖曳至場景上並且加載 LoggerSetting 才能成功激活日誌系統的配置 (Build 激活標籤 OXGKIT_LOGGER_ON)。

OxGKit.Utilities 遇到 UniTask 引用問題請無視，因為最後完成 OxGFrame 的安裝後，就會自動引用內建的 UniTask 了

Unity 如果新專案有遇到 Newtonsoft 引用問題

• 請自行安裝 Add package by name com.unity.nuget.newtonsoft-json

1. 透過 Package Manager 安裝 (Install via git)

Add https://github.com/michael811125/OxGFrame.git?path=Assets/OxGFrame to Package Manager.

Import Prefabs from Samples

2. 透過 Github 下載 (Code Download ZIP)

Copy Assets/OxGFrame to Unity New Project.

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

額外可搭配 OxGKit 提供遊戲開發常用的系統工具組

使用 OxGFrame 實現的 Demo 小遊戲

Github - FlappyBird_OxGFrame

• Resources
• AssetBundle
• AssetBundle + HybridCLR

基本介紹

OxGFrame 是基於 Unity 用於加快遊戲開發的框架，並且使用 UniTask 進行異步處理，從資源加載 (AssetLoader)、遊戲介面 (UIFrame)、場景資源 (SRFrame)、Unity 場景 (USFrame)、模板物件 (CPFrame)、音樂音效 (AudioFrame)、影片 (VideoFrame)、遊戲階段整合 (GSIFrame)、網路 (NetFrame)、事件中心 (CenterFrame)，能夠簡單入手與有效的加快開發效率，並且支持多平台 Win、OSX、Android、iOS，WebGL。

平台測試

• Windows (Passed)
• MacOSX (Passed)
• Android (Passed)
• iOS (Passed)
• WebGL (Passed)

相關模板建立的選單 (Create menu items)

Roadmap wiki

Coding Style wiki

第三方庫 (內建)

Main-ThirdParty

• 使用 UnitTask v2.5.0 (最佳異步處理方案)
• 使用部分 UniFramework (輕量級框架) 特別推薦

Sub-ThirdParty

• 使用 UnityWebSocket v2.7.0 (最佳 WebSocket 解決方案) 特別推薦
• 使用 YooAsset v2.1.0 (強大的資源熱更新方案) 特別推薦

※備註 : 會持續更新內建第三方庫。

框架 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 的可以調用

• HotfixHelper (using OxGFrame.Hotfix.Editor)
• BundleConfig (using OxGFrame.AssetLoader.Bundle)
• PatchSetting (using OxGFrame.AssetLoader)
  • PatchSetting.setting (Singleton instance)
  • PatchSetting.yooSetting (Singleton instance)
• BundleHelper (using OxGFrame.AssetLoader.Editor)
• MediaHelper (using OxGFrame.MediaFrame.Editor)

模塊框架介紹

• Hotfixer
• AssetLoader
• CoreFrame
• MediaFrame
• GSIFrame
• NetFrame
• CenterFrame

Hotfixer (dependence HybridCLR, AssetLoader)

代碼熱修復模塊，使用 HybridCLR (前身 Huatuo) 革命性的熱更新方案進行整合，相關建置請前往官方文檔進行熟悉。

• 如果相關建置完畢，前往點選 HybridCLR/OxGFrame With HybirdCLR/Complie And Copy To HotfixCollector，將會幫忙拷貝至 HotfixCollector 文件夾，再使用 YooAsset Collector 進行收集打包。

使用流程詳看 HotfixerDemo (Import frome Package Manager)

※備註 : 運行打包 HotfixerDemo 需要 Import PatchLauncher from PackageManager

如果沒有要使用 Hotfixer 熱修復模塊，可以直接刪除整個 Hotfixer。

AssetLoader (dependence YooAsset)

資源加載器模塊，支援動態 Async 或 Sync 加載 (Dynamic Loading)，採用計數管理方式進行資源管控 (支援 Resources 與 AssetBundle)，如果直接使用 AssetLoaders API 進行 Load 跟 Instantiate，則在 Destroy 物件時，需要連帶調用 Unload (成對呼叫 Load & Unload)。 其中 AssetBundle 集成 YooAsset 實現資源熱更新方案，並且實現 YooAsset 提供的加密介面，其中實現加解密方式有 Offset (偏移量方式)、XOR、HT2XOR (Head-Tail 2 XOR)、AES 實現檔案加密。

※備註 : Use "res#" will load from Resources else load from Bundle

※提醒 : 如果要使用同步加載，資源一定要是事先下載完成的 (主要是資源不在本地時，請求下載部分是異步處理)，也提醒同步加載只適合小資源 (當然強烈建議全部都使用異步處理)。

選擇使用 Bundle 開發時，需要先將 PatchLauncher 拖曳至場景中，才能驅動相關配置。【如果使用 PakcageManager 安裝的，透過 Samples Import PatchLauncher Prefab】

• FileCryptogram (檔案加解密)
  • 運算效率 OFFSET > HT2XOR > XOR > AES
  • 內存占用 OFFSET > AES > HT2XOR = XOR
  • AB 包體積增加 OFFSET > AES > HT2XOR = XOR
  • 破解難度 AES > HT2XOR > XOR > OFFSET

資源熱更新方案

使用 YooAsset Collector 進行資源收集 (可以使用 ActiveRule 決定哪些群組需要打包，進行 Built-in 跟 Patch 資源的區分)，再使用 YooAsset Builder 進行打包 (不需要手動更改資源日期版號)，如有 Bundle 加密需求需先配置加密設定 YooAsset/OxGFrame Cryptogram Setting With YooAsset。

YooAsset Build 完成之後開啟 OxGFrame/AssetLoader/Export Bundle And Config Generator 視窗進行 Bundle 上傳檔輸出 + 配置檔建立 (步驟如下)。

1. 選擇 Export App Config To StreamingAssets 頁籤，建立 appconfig.json 至 StreamingAssets 中 (主要用於 App Version 比對)。

2. 再開啟 OxGFrame/AssetLoader/Bundle Url Generator (burlconfig.conf) 視窗，建立 burlconfig.conf 至 StreamgingAssets 中 (主要用於定位 CDN Server Domain 與 Store Link)。

3. 最後返回 OxGFrame/AssetLoader/Export Bundle And Config Generator 視窗，選擇 Export Configs And App Bundles for CDN 頁籤，輸出上傳資源，Source Folder 選擇剛剛使用 YooAsset 輸出的 Bundles 資料夾，依照自己需求是否有想要使用 Tags 進行預設包的群組分包，輸出後將 CDN 資料夾直接上傳至 Server。

群組分包舉例

• 最小運行包
• 標準運行包
• 全部運行包 (預設 #all)

資源更新過程 (支援下載途中直接進行修復功能)

將 PatchLauncher 拖曳至場景中後，可以設置 PlayMode

• Editor Simulate Mode (模擬模式 [加快開發])，需先配置 YooAsset Collector。
• Offline Mode (單機模式)，需將 AB 打包至 Built-in，並且產出相關配置，需注意 PatchLauncher 的解密設定。
• Host Mode (聯機模式)，需將 AB 打包區分 Built-in 跟 Patch，並且產出相關配置，需注意 PatchLauncher 的解密設定。
  • 允許選擇 Semantic Version 版號檢查規則 (比對完整版號 X.Y.Z 或比對大小版號 X.Y)。
  • 允許跳過 Preset App Packages 主下載階段 (強制邊玩邊下載)。
• WebGL Mode (僅支援 WebGL 平台)，需將 AB 全部打包至 Built-in (StreamingAssets)。
  • 不支援事先下載，主要是因為 WebGL 是邊玩邊下載。

檢查 PlayMode 是否初始完成

• 判斷檢查 AssetPatcher.IsInitialized() 是否完成 Preset Packages 的初始，因為初始完成後，才能開始進行 Built-in Bundle 的加載與 AssetPatcher.Check() 檢查更新，又或者邊玩邊下載。
  • 備註 : 區分 Built-in 跟 Patch (視情況自行訂定運作流程)
    1. 需自己拆分 Patch 更新前所用到的資源 (例如 : LogoUI 等...)，需要先打包至 Built-in 作為內置資源。
    2. 後續執行 AssetPatcher.Check() 檢查 Patch 更新完成後，就可以讀取更新資源了。
    • 執行 AssetPatcher.Check() 檢查流程時，會將 Preset App Packages 與 Preset DLC Packages 進行 Main Download 的合併。

備註：通過 Preset 設置的 DLC Packages 必須是固定版號 (ex: "latest")。

檢查 Patch 是否更新完成

• 判斷檢查 AssetPatcher.IsDone() 是否更新完成。

Patch 執行順序流程

• 判斷 AssetPathcer.IsInitialized() => 執行 AssetPatcher.Check() => 判斷 AssetPatcher.IsDone() => 完成

指定特定的 Package 進行資源加載

分別區分 App Packages 跟 DLC Packages，注意路徑不同。

• App Packages (.../CDN/<ProductName>/<Platform>/<Version>/Packages)
  • 手動進行 AssetPatcher.InitAppPackage 的初始 (如果 autoUpdate = false，則需要自行另外調用 AssetPatcher.UpdatePackage 進行 Manifest 的更新)。
• DLC Packages
  • 路徑包含平台 (.../CDN/<ProductName>/<Platform>/DLC/Packages)
  • 路徑不管平台 (.../CDN/<ProductName>/DLC/Packages)
  • 支援特定版本 DLC package 的下載與 DLC package 卸載功能，需手動進行 AssetPatcher.InitDlcPackage，並且指定特定 dlcVersion，對於 dlcVersion 也可以單一固定 dlcVersion (ex: "latest")，變成只要 DLC 有更新就可以使用固定路徑進行更新。

使用 PackageOperation 進行 DLC 資源包的操作 (方便控管資源包)

    // Use Example
    var packageOperations = new PackageOperation[]
    {
        new PackageOperation
        (
            "DLC Package 1",
            new DlcPackageInfoWithBuild()
            {
                buildMode = BuildMode.ScriptableBuildPipeline,
                packageName = "Dlc1Package",
                dlcVersion = "latest"
            },
            false
        ),
        new PackageOperation
        (
            "DLC Pacakge 2",
            new DlcPackageInfoWithBuild()
            {
                buildMode = BuildMode.ScriptableBuildPipeline,
                packageName = "Dlc2Package",
                dlcVersion = "latest"
            },
            false
        )
    };

App Package

// [Load asset and download from specific package (Export App Bundles for CDN)]

AppPackageInfoWithBuild packageInfo = new AppPackageInfoWithBuild()
{
    buildMode = BundleConfig.BuildMode.ScriptableBuildPipeline,
    packageName = "OtherPackage"
};

bool isInitialized = await AssetPatcher.InitAppPackage(packageInfo, true);
if (isInitialized)
{
    var package = AssetPatcher.GetPackage(packageName);
    var downloader = AssetPatcher.GetPackageDownloader(package);
    Debug.Log($"Has In Local: {downloader.TotalDownloadCount == 0}, Patch Count: {downloader.TotalDownloadCount}, Patch Size: {BundleUtility.GetBytesToString((ulong)downloader.TotalDownloadBytes)}");
    await AssetLoaders.LoadAssetAsync<GameObject>(packageName, assetName);
}

DLC Package

// [Load asset and download from specific package (Export Individual DLC Bundles for CDN)]

DlcPackageInfoWithBuild packageInfo = new DlcPackageInfoWithBuild()
{
    buildMode = BundleConfig.BuildMode.ScriptableBuildPipeline,
    packageName = "DlcPackage",
    dlcVersion = "dlcVersion",
    withoutPlatform = false
};

bool isInitialized = await AssetPatcher.InitDlcPackage(packageInfo, true);
if (isInitialized)
{
    var package = AssetPatcher.GetPackage(packageName);
    var downloader = AssetPatcher.GetPackageDownloader(package);
    Debug.Log($"Has In Local: {downloader.TotalDownloadCount == 0}, Patch Count: {downloader.TotalDownloadCount}, Patch Size: {BundleUtility.GetBytesToString((ulong)downloader.TotalDownloadBytes)}");
    await AssetLoaders.LoadAssetAsync<GameObject>(packageName, assetName);
}

Bundle [burlconfig] (Bundle URL Config) 格式

格式如下 (store_link 針對非 Android, iOS 平台的，可以設置主程式下載的 link)

# bundle_ip = First CDN Server IP or Domain (Plan A)
# bundle_fallback_ip = Second CDN Server IP or Domain (Plan B)
# store_link = GooglePlay Store Link (https://play.google.com/store/apps/details?id=YOUR_ID)
# store_link = Apple Store Link (https://apps.apple.com/app/idYOUR_ID)

bundle_ip 127.0.0.1
bundle_fallback_ip 127.0.0.1
store_link http://

Build 防呆標籤 (避免再打包時，忘記將 EditorSimulateMode 調成 OfflineMode, HostMode, WebGLMode)

• OXGFRAME_OFFLINE_MODE
• OXGFRAME_HOST_MODE
• OXGFRAME_WEBGL_MODE

>> 建立 burlconfig.conf 方式 <<

• 使用 OxGFrame/AssetLoader/Bundle Url Config Generator 創建 burlconfig.conf (StreamingAssets/burlconfig.conf)。

如果沒有要使用 AssetLoader 資源加載模塊，可以直接刪除整個 AssetLoader (注意有模塊依賴引用)。

CoreFrame (dependence AssetLoader)

核心模塊 (連動 AssetLoader 實現自動卸載)，包含用於製作 UI, Scene Resource, Clone Prefab, Unity Scene，針對製作對應使用 UI Prefab => UIFrame、Scene Resource Prefab => SRFrame、Other Prefab => CPFrame、Unity Scene => USFrame。支援 Resources 與 AssetBundle 加載方式，並且實現物件命名綁定功能 (UIBase and SRBase = _Node@XXX, CPBase = ~Node@XXX, 類型均為 GameObject)。

UIFrame (User Interface)

用於調度 UI Prefab，僅支援 UGUI，使用 UIManager 管理掛載 UIBase 的 Prefab，支援 UI 反切 (Reverse Changes)，基本上 UI 有隱藏凍結功能，避免 UI 動畫尚未完成期間，能夠被點擊觸發事件。另外如需要製作 UI 動畫，可以在 ShowAnime 跟 HideAnime 覆寫執行相關過渡動畫 (DoTween, Animation...)，並且一定要在完成 UI 動畫後正確呼叫 animeEndCb() 回調。額外還有 UI 的 MaskEvent 也可以 override 自定義事件 (使用 _Node@XXX 進行物件綁定)。

SRFrame (Scene Resource)

用於調度場景或資源物件 Prefab，使用 SRManager 管理掛載 SRBase 的 Prefab (使用 _Node@XXX 進行物件綁定)。

USFrame (Unity Scene)

用於調度 Unity Scene，使用 USManager 管理 Unity 場景 (支援 AssetBundle)。

• ※備註 : Use "build#" will load scene from Build else load scene from Bundle

CPFrame (Clone Prefab)

用於實例 Prefab 模板物件，使用 CPManager 管理掛載 CPBase 的 Prefab (使用 ~Node@XXX 進行綁定)，可以用於加載模板物件，並且直接進行 GameObject.Destroy 就好，將會自動卸載。

常用方法說明

• OnCreate : 初始 Member Params (建構式概念)，另外如果採用拖曳式指定組件，也可以直接在此初始 (不過不建議，建議還是在 OnBind 執行)。
• OnBind : 初始綁定組件與事件 (After Bind)。
• OnPreShow : 當有異步處理或者附屬物件控制時，可以在此處理。例如 : TopUI 附屬連動開啟 LeftUI & RightUI，那麼就可以在 TopUI 中的 OnPreShow 方法實現 Show LeftUI & RightUI。
  • 不建議在 OnPreClose 時進行相關 Show 的處理，如果有進行的話也沒關係，因為針對 CloseAll 的 API 有提供 disabledPreClose 的開關。
• OnShow : 調用 Show 時，此方法會被激活，並且可以透過帶入的 object 進行數據傳送。
• OnClose : 調用 Close 時，此方法會被激活。
• OnRelease : 當物件被 Destroy 時，此方法會被激活。

初始順序說明

Init Order : OnCreate (Once) > OnAutoBind (Once) > OnBind (Once) > OnPreShow (EveryOpen) > OnShow (EveryOpen)

物件綁定說明 (OnBind)

• 透過 collector.GetNode("BindName") 返回取得綁定 GameObject (單一名綁定)
  • UIBase & SRBase 使用 _Node@XXX
  • CPBase 使用 ~Node@XXX
• 透過 collector.GetNodes("BindName") 返回取得綁定 GameObject[] (同名多綁定，物件順序由上至下)
  • UIBase & SRBase 使用 _Node@XXX
  • CPBase 使用 ~Node@XXX
• 透過 collector.GetNodeComponent<TComponent>("BindName") 返回取得綁定 TComponent (單一名綁定)
  • UIBase & SRBase 使用 _Node@XXX
  • CPBase 使用 ~Node@XXX
• 透過 collector.GetNodeComponents<TComponent>("BindName") 返回取得綁定 TComponent[] (同名多綁定，物件順序由上至下)
  • UIBase & SRBase 使用 _Node@XXX
  • CPBase 使用 ~Node@XXX

建議使用 Hotkey，不然使用 Right-Click 會執行多次 (實際上不影響自動生成)，但這是 Unity Bug 官方不修復了

自動生成停止綁定標籤 (Hotkey: Shift+E, E: End)

能夠縮短 Runtime 在綁定的向下查找次數，時間複雜度為 O(N)，N = StopEndIdx (如有大量節點物件建議使用)。

• 如果有特殊使用 Transform.Find 查找子物件時，剛好子物件名稱有 # 標籤，可以無視 (在 Runtime 時，會 Replace 標籤，還原字串)。

自動生成物件綁定代碼 (Hotkey: Shift+B, B: Bind)

命名規範使用 * 指向 TailName

• UIBase & SRBase
  • _Node@XXX*Btn (以此類推)
• CPBase
  • ~Node@XXX*Btn (以此類推)

預設組件綁定表 (可從 BindCodeSetting 中自行新增或修改 TailName 對應綁定組件類型)

自動綁定產生器的功能有方法類型的區分，如下

• 自動 (Auto) [預設]，只需要將區塊貼上至代碼中，將會自動 override OnAutoBind() 與調用。
• 手動 (Manual) [自選]，可自定義方法名稱，將區塊貼上至代碼中後，需要手動在 OnBind() 方法中進行調用。

如果沒有要使用 CoreFrame 核心製作模塊，可以直接刪除整個 CoreFrame。

※備註 : Right-Click Create/OxGFrame/Core Frame... (Template cs and prefab)

MediaFrame (dependence AssetLoader)

影音模塊 (連動 AssetLoader 實現自動卸載)，包含用於製作 Audio (2D/3D), Video 遊戲影音，支援多平台加載方式 (Local, StreamingAssets, URL)，主要也對於 WebGL 有進行細節校正，因為 WebGL 對於 Audio 請求部分是無法取得正確長度 (官方放棄修正)，導致音訊控制會有部分缺陷，所以支援預置體製作時，可進行 Preload 請求 Clip 長度進行預設置。

AudioFrame

用於播放 Audio，使用 AudioManager 管理掛載 AudioBase 的 Prefab，且採用 Unity Mixer 進行各音軌控制。

(需先將 AudioManager 預置體拖至場景)【如果使用 PakcageManager 安裝的，透過 Samples Import AudioManager Prefab】

• Audio Sound Type 說明
  • Sole : 唯一性 (不能重複播放)，建議種類為 BGM (背景音樂), Voice (配音) 等。
  • SoundEffect : 多實例 (可以重複播放)，建議種類為 Fight Sound (戰鬥音效), General Sound (一般音效) 等。

VideoFrame

用於播放 Video，使用 VideoManager 管理掛載 VideoBase 的 Prefab，且支援 RenderTexture, Camera。

• Video Render Mode 說明
  • RenderTexture : 將 Video 映射至 RenderTexture 再透過 UGUI 的 RawImage 進行渲染 (VideoBase 使用 RenderTexture.GetTemporary 跟 RenderTexture.ReleaseTemporary 創建與釋放，確保內存正確釋放 RenderTexture)。
  • Camera : 直接透過 Camera 進行渲染。

Media [murlconfig] (Media URL Config) 格式

如果音訊跟影片來源存放於 Server，可以使用 URL 的方式進行檔案請求，格式如下 (如果不透過 murlconfig.txt 指定 URL 的話，也可以輸入完整資源 URL 至 Prefab 中，不過缺點就是對於未來更動 URL，要進行更改維護就會非常麻煩)

# audio_urlset = Audio Source Url Path
# video_urlset = Video Source Url Path

audio_urlset 127.0.0.1/audio/
video_urlset 127.0.0.1/video/

>> 建立 murlconfig.txt 方式 <<

• 使用 OxGFrame/MediaFrame/Media Url Config Generator 創建 murlconfig.txt (StreamingAssets/murlconfig.txt)。

>> 加載 murlconfig.txt 方式 <<

1. 如果選擇 Url Cfg Request Type = Assign 的方式指定 murlconfig.txt 至 prefab 中。
2. 如果選擇 Url Cfg Request Type = Streaming Assets 的方式請求 murlconfig.txt，將 murlconfig.txt 放至 StreamingAssets 根目錄中 (StreamingAssets/murlconfig.txt)。

額外說明：如果透過 URL 方式請求音訊或影片資源，建議於 WebGL 平台上使用，因為 WebGL 不支援 AssetBundle 事先指定 AudioClip 或 VideoClip (Assign 方式) 至 Prefab 中，所以提供 URL 的方式進行影音檔請求。

如果沒有要使用 MediaFrame 影音模塊，可以直接刪除整個 MediaFrame。

※備註 : Right-Click Create/OxGFrame/Media Frame... (Template prefab)

GSIFrame

遊戲階段整合模塊 (FSM 概念)，而 GSI 為 Game Stage Integration 的縮寫，對於遊戲製作的時候缺乏整合系統，導致遊戲系統運作之間過於零散，基本上遊戲階段區分為 StartupStage (啟動階段), LogoStage (商標階段), HotfixStage (熱修復階段), PatchStage (資源熱更階段), LoginStage (登入階段), ReloginStage (重登階段), EnterStage (進入階段), LobbyStage (大廳階段), FightStage (戰鬥階段) 等，以上只是舉例大致上遊戲階段之間的劃分，基本上還是依照自己規劃創建為主，這些遊戲階段規劃好後，都可以使用 GSIFrame 進行整合與切換 (階段劃分後就可以自行實現每階段的運作)。

• GSIBase，遊戲階段基類，在透過 Update 切換當前階段自定義的狀態流程 (Enum) 時，可透過 StopUpdate & RunUpdate 方法進行開關設置，即可停止或繼續 Update 的每幀調用，需建立實作 => 右鍵創建
• GSIManagerBase，用於繼承實現管理層與註冊階段，需建立實作 => 右鍵創建

Default API

    public static int GetCurrentId()
    
    public static U GetStage<U>() where U : GSIBase
    
    public static U GetStage<U>(int id) where U : GSIBase
    
    public static void AddStage<U>() where U : GSIBase, new()
    
    public static void AddStage<U>(int id) where U : GSIBase, new()
    
    public static void AddStage(int id, GSIBase gameStage)
    
    public static void DeleteStage<U>() where U : GSIBase
    
    public static void DeleteStage(int id)
    
    public static void ChangeStage<U>(bool force = false) where U : GSIBase
    
    public static void ChangeStage(int id, bool force = false)
    
    public static void Start()
    
    public static void Update(float dt = 0.0f)

如果沒有要使用 GSIFrame 遊戲整合模塊，可以直接刪除整個 GSIFrame。

※備註 : Right-Click Create/OxGFrame/GSI Frame... (Template cs)

NetFrame (dependence OxGKit.Utilities)

網路模塊，實現 WebSocket 跟 TCP/IP 統一接口，依照 WebSocket 狀態概念進行接口設計 (ISocket)，狀態分為 OnOpen, OnMessage, OnError, OnClose，進行事件註冊後就可以針對網路狀態進行監控，也實現多網路節點 (NetNode)，可以自行建立 WebSocket NetNode 或是 TCP/IP NetNode，再由 NetManager 進行網路節點註冊進行管理操作，另外可以設置心跳檢測回調、超時處理回調、重新連接回調的各處理，並且也能實現 INetTips 接口網路訊息介面的實作。

• NetManager (網路節點管理器)
• NetNode (網路節點)
• TcpSock (TCP/IP)
• WebSock (WebSocket)
• INetTips (網路狀態提示接口)

如果沒有要使用 NetFrame 網路模塊，可以直接刪除整個 NetFrame。

CenterFrame

事件委派中心，可以自行實現 TClass 註冊類型，再由自定義管理類統一繼承 CenterBase<TCenter, TClass>，實現簡易事件派送，預設提供以下。

Default API

    public static void Add<UClass>() where UClass : TClass, new()
    
    public static void Add<UClass>(int id) where UClass : TClass, new()
    
    public static void Add(int id, TClass @class)
    
    public static void Delete<UClass>() where UClass : TClass
    		
    public static void Delete(int id)
    	
    public static void DeleteAll()
    	
    public static UClass Find<UClass>() where UClass : TClass
    
    public static UClass Find<UClass>(int id) where UClass : TClass

EventCenter

集中式 Event 整合模塊，可以自定義每個 Event 的格式進行派送 (也可列出事件 ID 交由企劃填表填入已註冊的 ID，就能讀表取出事件 ID 進行派送)。

• TClass: EventBase，單個 Event 基類，需建立實作 => 右鍵創建
• TCenter: EventCenter，用於繼承管理層，主要用於註冊階段，需建立實作 => 右鍵創建
  • 使用 Default API 進行調用 (Add, Find)

APICenter

集中式 API 整合模塊，可以自定義每個 API 的格式進行 Http API 短連接請求，能夠有效的集中管理各型式的 API 格式，使用 Acax (類似 Ajax 方式，請求 API)。

• TClass: APIBase，單個 API 基類，需建立實作 => 右鍵創建
• TCenter: APICenter，用於繼承管理層，主要用於註冊階段，需建立實作 => 右鍵創建
  • 使用 Default API 進行調用 (Add, Find)

如果沒有要使用 CenterFrame 事件模塊，可以直接刪除整個 CenterFrame。

※備註 : Right-Click Create/OxGFrame/Center Frame... (Template cs)

Unity 版本

建議使用 Unity 2021.3.32f1(LTS) or higher 版本 - Unity Download

特別感謝

killop - anything_about_game

UWA 開源庫

License

This library is under the MIT License.