OxGKit icon indicating copy to clipboard operation
OxGKit copied to clipboard

Published 20 hours ago • verified publisher icon michael811125
→

Metadata

The OxGKit is a system tool kit commonly used in game development based on Unity design (all are independent tools).

License

基本介紹

OxGKit 是基於 Unity 設計於遊戲開發常用的系統工具組 (皆為獨立工具)。

Coding Style wiki

目前包含以下

[會持續擴充工具系統組]

工具系統介紹

InfiniteScrollView (dependence UniTask, OxGKit.LoggingSystem)

無限列表 (魔改版)，基於原生 UGUI 能夠簡單的繼承或使用現有的 Infinite ScrollView，以物件池的概念進行物件有效循環利用。

Reference: howtungtung - InfiniteScrollView

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/InfiniteScrollView/Scripts to Package Manager

第三方庫 (需自行安裝)

  • 使用 UnitTask v2.5.0 or higher
  • 使用 OxGKit.LoggingSystem, Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts to Package Manager

如果沒有要使用 InfiniteScrollView，可以直接刪除整個 InfiniteScrollView。

※備註 : Right-Click Create/OxGKit/Infinite ScrollView... (Template cs)

ActionSystem (dependence UniTask, OxGKit.LoggingSystem)

動作序列系統，能夠自行定義 Action 並且自行組合運行組，預設 Actions 有 SequenceAction, ParallelAction, ParallelDelayAction, DelayAction, DelegateAction，另外如果針對動畫需要進行拼湊處理，也可以使用 ActionSystem 作為運行。

  • 透過 Right-Click Create/OxGKit/Action System/Template Action.cs 實作自定義 Action。

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/ActionSystem/Scripts to Package Manager

第三方庫 (需自行安裝)

  • 使用 UnitTask v2.5.0 or higher
  • 使用 OxGKit.LoggingSystem, Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts to Package Manager

ActionSystem Demo

https://github.com/michael811125/OxGKit/assets/30960759/169d91ea-3709-420c-8751-f50119e97d35

如果沒有要使用 ActionSystem，可以直接刪除整個 ActionSystem。

※備註 : Right-Click Create/OxGKit/Action System... (Template cs)

NoticeSystem or RedDotSystem (dependence OxGKit.LoggingSystem)

通知系統 (也稱紅點系統)，支援動態新增刪除通知條件，可以自行定義通知條件，再針對 NoticeItem 進行條件持有註冊，當 NoticeItem 身上其中持有任一符合條件則通知顯示圖示 (紅點)。

  • 透過 Right-Click Create/OxGKit/Notice System/Template Notice Condition.cs 實作通知條件。
  • 將 NoticeItem prefab 拖曳至 UI 上，自行指定 ICON，再取得 NoticeItem 身上的組件進行條件註冊 (當 OnDestroy 時，會自動 Deregister)。
  • 當有數據狀態變更時，必須通知特定條件 ID 進行 Notify，將會透過條件 ID 進行查找持有的 NoticeItems，並且進行刷新顯示。

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/NoticeSystem/Scripts to Package Manager

第三方庫 (需自行安裝)

  • 使用 OxGKit.LoggingSystem, Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts to Package Manager

NoticeSystem Demo

https://github.com/michael811125/OxGKit/assets/30960759/c6966327-3ede-432e-b8fe-bee53f629f25

如果沒有要使用 NoticeSystem，可以直接刪除整個 NoticeSystem。

※備註 : Right-Click Create/OxGKit/Notice System... (Template cs)

InputSystem (dependence Unity New InputSystem, OxGKit.LoggingSystem)

輸入控制系統，支援 Unity New InputSystem，如果使用 Unity New InputSystem 需自行建立 Unity New InpuptSystem 的控制表 (Control Maps)，並且還有提供使用於 Unity New InputSystem 的 Binding Composite 腳本模板，最後再由 Input Action 派送輸入訊號控制由訂閱者訂閱，進而做到遊戲中的控制邏輯不需要知道平台裝置區分，皆由 Input Action 進行整合，當然 Input Action 也支援其他輸入控制插件，作為單純的輸入控制派送者。

  • 透過 Right-Click Create/OxGKit/Input System/Template Input Action.cs 實作 InputAction 介面。
  • 調用 Inputs API (using.OxGkit.InputSystem)

主要層級驅動區分為以下

  • For Unity New InputSystem
    • Control Maps (Input Action Asset)
    • Binding Composites
  • For Any Inputs
    • Input Actions (此為獨立作為通用訊號派送者，不依賴任何輸入控制插件，皆可自由實現)

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/InputSystem/Scripts to Package Manager

第三方庫 (需自行安裝)

InputSystem Demo

https://github.com/michael811125/OxGKit/assets/30960759/20548ee4-b77b-4cda-8d49-c82b16deddb7

如果沒有要使用 InputSystem，可以直接刪除整個 InputSystem。

※備註 : Right-Click Create/OxGKit/Input System... (Template cs)

LoggingSystem (dependence LWMyBox)

日誌系統，透過拖曳 LoggingLauncher 至場景上激活環境配置 (僅需激活一次)，並且需加載 LoggerSetting 進行日誌開關控制。

  • 透過 Right-Click Create/OxGKit/Logging System/Create Logger Setting 建立配置檔。
  • 透過菜單選項 OxGKit/Logging System/Logger Setting 開啟將會自動生成配置檔。

Build 激活標籤

  • OXGKIT_LOGGER_ON

新增 Logger 或移除 Logger 皆需手動執行 Reload Loggers 重載 (建議定義一個 default constructor，避免搭配 HybridCLR + Activator.CreateInstance(type) 出現錯誤)。

using OxGKit.LoggingSystem;

[LoggerName("YourLoggerName")]
public class YourLogger : Logging 
{
    // If use HybridCLR must create a default constructor
    public YourLogger() { }
}

如果搭配 HybridCLR 有主工程跟熱更工程的區分，建議自行手動拆分調用 AOT 跟 Hotfix 的 Loggers 初始流程，可以參考以下。

// Init by yourself
Logging.CreateLogger<YourLogger>();
LoggingLauncher.ReloadLoggerSetting();

以下是在 AOT 工程中初始 AOT 工程的 Loggers (如果 Hotfix 工程的 Loggers 需要再 Hotfix 工程中初始)。

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts to Package Manager

第三方庫 (需自行安裝)

LoggingSystem Demo

https://github.com/michael811125/OxGKit/assets/30960759/51ecddd7-5241-43e9-9104-de45cbc5f68d

LoggingSystem Build Test

https://github.com/michael811125/OxGKit/assets/30960759/cef1a484-d617-466d-bf3e-6104032d7c3f

如果沒有要使用 LoggingSystem，可以直接刪除整個 LoggingSystem，注意其他庫引用關係。

TweenSystem (dependence DoTween Pro, LWMyBox, OxGKit.Utilities)

補間動畫 (僅支持 DoTween Pro)。

  • Add Component/OxGKit/TweenSystem/DoTweenAnim
  • Add Component/OxGKit/TweenSystem/DoTweenAnimEvent

Highly Recommended brunomikoski - Animation Sequencer

Preview Mode (Only DoTweenAnim component is supported)

※Note: The DoTweenAnimEvent only plays at runtime.

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/TweenSystem/Scripts to Package Manager

第三方庫 (需自行購買安裝)

第三方庫 (需自行安裝)

  • 使用 LWMyBox v1.1.4 or higher, Add https://github.com/michael811125/LWMyBox.git to Package Manager
  • 使用 OxGKit.Utilities, Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/Utilities/Scripts to Package Manager

Create DoTween Assemblies

TweenSystem Demo

https://github.com/michael811125/OxGKit/assets/30960759/6bf690b6-c4d0-40f6-b3c9-b50ab62562e8

如果沒有要使用 TweenSystem，可以直接刪除整個 TweenSystem。

Utilities (dependence UniTask)

各通用組件 (Essential)。

  • Utilities
    • Timer: DeltaTimer, RealTimer, DTUpdater, RTUpdater, IntervalTimer, IntervalSetter, NtpTime (clock sync with NTP server).
    • Adapter: UISafeAreaAdapter.
    • Pool: NodePool (GameObject Pool).
    • ButtonPlus: Inherited by Unity Button. extend Long Click and Transition Scale.
    • Unity Main Thread: UMT.
    • Singleton: MonoSingleton (MonoBehaviour), NewSingleton (class).
    • Requester: RequestAudio, RequestTexture2D, RequestSprite, RequestBytes, RequestText.
    • Cacher: ARCCache<TKey, TValue>, LRUCache<TKey, TValue>, LRUKCache<TKey, TValue>.
    • TextureAnimation.
  • Editor
    • RectTransform: RectTransformAdjuster (Hotkey: Shift+R, R: RectTransform).
    • MissingScriptsFinder.
    • SymlinkUtility.

[參考 Example]

Installation

Install via git URL
Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/Utilities/Scripts to Package Manager

第三方庫 (獨立安裝時，需自行安裝; 如果搭配 OxGFrame 則不需要額外安裝 UniTask)

  • 使用 UnitTask v2.5.0 or higher
  • 使用 LWMyBox v1.1.4 or higher, Add https://github.com/michael811125/LWMyBox.git to Package Manager
  • 使用 OxGKit.LoggingSystem, Add https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts to Package Manager

Utilities Demo (RectTransformAdjuster)

https://github.com/michael811125/OxGKit/assets/30960759/cd43fc8b-c6f7-4878-990b-99dcacb8ed1f

Utilities Demo (ButtonPlus)

https://github.com/michael811125/OxGKit/assets/30960759/891291af-1bb4-4515-bec6-a9877f4ca254

Utilities Demo (Timer)

https://github.com/michael811125/OxGKit/assets/30960759/ee085eb4-f803-45e5-9593-b481a4b5a821

如果沒有要使用 Utilities，可以直接刪除整個 Utilities，注意其他庫引用關係。

Unity 版本

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

Donate

paypal_logo_x128

buymeacoffee_qrcode_x128

License

This library is under the MIT License.

← Metadata

33
Stars
5
Forks
Watchers

Owner

verified publisher icon michael811125

Metadata

The OxGKit is a system tool kit commonly used in game development based on Unity design (all are independent tools).

Back