Skip to main content

Getting Started

Important Attention Reminder

Coding Style wiki​

Installing OxGKit

Attention OxGKit systems are all standalone tools — there is no need to install everything at once. Install only what you need, along with the dependencies required by those modules.

Step 1. (Install Dependencies)​

Based on the modules you plan to install, install their third-party dependencies first (see the dependency notes in Step 2).

  • 1 UniTask (required by InfiniteScrollView, ActionSystem, TimeSystem, PoolSystem, Utilities)

Install via Package Manager (Install via git)

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

Install via Package Manager (Install via git)

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

Install via Package Manager (Install by name)

com.unity.inputsystem

  • 4 DoTween Pro (required by TweenSystem, must be purchased separately)

  • Reminder OxGKit.LoggingSystem is a shared dependency of most modules (InfiniteScrollView, ActionSystem, NoticeSystem, InputSystem, TimeSystem, PoolSystem, Utilities) — it is recommended to install it first.

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

Step 2. (Install Modules)​

Method 1​

Install the modules you need one by one via Package Manager (Install via git).

Important Package Manager does NOT automatically install git dependencies declared inside a package — before installing any module, install its dependencies first (noted below).

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 (depends on Unity New InputSystem, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/InputSystem/Scripts
  • TweenSystem (depends on 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 (depends on 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 (depends on 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 (depends on UniTask, LWMyBox, OxGKit.LoggingSystem)
https://github.com/michael811125/OxGKit.git?path=Assets/OxGKit/Utilities/Scripts

Method 2​

Download the source directly (Code Download ZIP)

Copy the folders of the modules you need (Assets/OxGKit/[ModuleName]) into your Unity project's Assets folder.

Reminder If you don't need to modify the toolkit yourself, installing via Package Manager is recommended.

Importing Samples​

Every module ships with Examples and AI Agent Skills — import them via Package Manager -> select the module -> Samples.

Reminder There are many ways to call the APIs — check each module's Samples for complete examples.

Build Activation Symbol​

  • OXGKIT_LOGGER_ON (the LoggingSystem output switch — for builds, add it to Player Settings -> Scripting Define Symbols or no logs will be output)

AI-Assisted Development (AI Agent Skills)​

Every OxGKit system module supports development assisted by AI coding agents (Claude Code, OpenAI Codex CLI, Cursor, Copilot, etc.). Each module's Samples include built-in AI Agent Skills (SKILL.md) that teach the agent how to use that module's API correctly.

Attention For the full import and usage guide, see AI Agent Skills.

Toolkit API​

Important It is recommended to study each module's Examples and API chapters.