Getting Started

Important Attention Reminder

Coding Style wiki

---

Start installing OxGFrame with YooAsset + HybridCLR

Step 1. (Install Dependencies)

• 1 UniTask

Install via Package Manager (Install via git)

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

• 2 LWMyBox

Install via Package Manager (Install via git)

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

• 3 OxGKit.LoggingSystem

Install via Package Manager (Install via git)

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

• 4 OxGKit.SaverSystem

Install via Package Manager (Install via git)

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

• 5 OxGKit.TimeSystem

Install via Package Manager (Install via git)

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

• 6 OxGKit.Utilities

Install via Package Manager (Install via git)

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

• 7 HybridCLR

Install via Package Manager (Install via git)

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

• New Project TextMeshPro

Install via Package Manager (Install by name)

com.unity.textmeshpro

• New Project Newtonsoft

Install via Package Manager (Install by name)

com.unity.nuget.newtonsoft-json

---

Step 2. (Install Framework)

Method 1

OxGFrame

Install via Package Manager (Install via git)

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

Import Management Components (Samples)

Method 2

Direct Download Source Code (Code Download ZIP)

Copy the OxGFrame folder to the Assets folder of a new Unity project.

Reminder If you don't need to modify the framework yourself, it is recommended to install directly using the Package Manager method.

Method 3

If you only need specific modules, you can install them individually.

• AssetLoader

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

• CoreFrame (depends on AssetLoader)

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

• MediaFrame (depends on AssetLoader)

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

• Hotfixer (depends on 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

---

Built-in Third-Party Dependencies

• Using YooAsset (powerful resource hot-update solution) Highly recommended.
• Using UniFramework (UniEvent, UniMachine, UniReference).
• Using UnityWebSocket (best WebSocket solution) Highly recommended.
• Using MirrorNetworking - Telepathy TCP (TCP solution).
• Using MirrorNetworking - KCP2K (KCP solution).
• Using DiskUtils by keerthik (DiskUtils solution).

---

Macro Definitions

• Macro Definitions

Framework 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)

※Note: It is recommended to check the Examples of each module (pay attention to the usage rules of "res#" and "build#").

Additional BuildTool writing can call

• 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)

Framework Configuration

You can create configuration files through Right-Click to customize some settings.

PatchSettings

HotfixSettings

CodeBindingSettings

CryptogramSettings