跳至主要内容

快速上手

重要 注意 提醒

Coding Style wiki​

開始安裝 OxGKit

注意 OxGKit 皆為獨立工具系統，沒有一次安裝全部的必要，需要什麼裝什麼，依照各模組需求安裝對應的依賴即可。

步驟 1. (安裝依賴)​

依照你要安裝的模組，先安裝其依賴的第三方庫 (各模組依賴請參考步驟 2 的依賴標註)。

  • 1 UniTask (InfiniteScrollView、ActionSystem、TimeSystem、PoolSystem、Utilities 依賴)

透過 Package Manager 安裝 (Install via git)

https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask
  • 2 LWMyBox (LoggingSystem、TweenSystem、PoolSystem、Utilities 依賴)

透過 Package Manager 安裝 (Install via git)

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

透過 Package Manager 安裝 (Install by name)

com.unity.inputsystem

  • 4 DoTween Pro (TweenSystem 依賴，需自行購買安裝)

  • 提醒 OxGKit.LoggingSystem 為多數模組的共同依賴 (InfiniteScrollView、ActionSystem、NoticeSystem、InputSystem、TimeSystem、PoolSystem、Utilities)，建議最先安裝。

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

步驟 2. (安裝模組)​

方法一​

依需求透過 Package Manager 逐一安裝 (Install via git)。

重要 Package Manager 不會自動安裝套件內宣告的 git 依賴，安裝任一模組前，請先安裝其依賴 (依賴標註如下)。

https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LoggingSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/InfiniteScrollView/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/ActionSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/NoticeSystem/Scripts
  • InputSystem (依賴 Unity New InputSystem, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/InputSystem/Scripts
  • TweenSystem (依賴 DoTween Pro, LWMyBox, OxGKit.TimeSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/TweenSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/ButtonSystem/Scripts
  • TimeSystem (依賴 UniTask, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/TimeSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/CursorSystem/Scripts
  • PoolSystem (依賴 UniTask, LWMyBox, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/PoolSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/SingletonSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/SaverSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/LocalizationSystem/Scripts
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/VirtualJoystick/Scripts
  • Utilities (依賴 UniTask, LWMyBox, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/Utilities/Scripts

方法二​

直接下載原碼 (Code Download ZIP)

複製所需模組的文件夾 (Assets/OxGKit/[模組名]) 到 Unity 專案的 Assets 底下。

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

管理組件匯入 (Samples)​

各模組皆附有 Example 範例與 AI Agent Skills，可透過 Package Manager -> 選擇模組 -> Samples 進行匯入。

提醒 有很多調用的方式，都可以參考各模組的 Samples，裡面都有完整的範例。

Build 激活宏​

  • OXGKIT_LOGGER_ON (LoggingSystem 日誌輸出開關，發布時需在 Player Settings -> Scripting Define Symbols 加入才會輸出日誌)

AI 輔助開發 (AI Agent Skills)​

OxGKit 各系統模組皆支援使用 AI 編碼代理 (Claude Code、OpenAI Codex CLI、Cursor、Copilot 等) 輔助開發，各模組的 Samples 內建「AI Agent Skills」(SKILL.md)，教導 AI 代理正確使用該模組 API。

注意 完整的匯入與使用說明，請參考 AI Agent Skills。

工具組 API​

重要 建議詳看各模塊的 Example 與 API 章節。