DOCSEARCHbyAlgolia
Submit Docs

OxGFrame Documentation

website·Indexed 29 days ago

https://oxgframe.ouhiyo.com/

Documentation for OxGFrame, including API references for components such as assetloader, coreframe, netframe, centerframe, gsiframe, mediaframe, and hotfixer. Includes details on the GSIManagerBase<T> abstract base class, singleton patterns, and stage registration. Note that v2 is deprecated and no longer actively maintained; v3 is the latest version.

Tokens
108.4K
Snippets
539
Records
773
Agent score
47%

What's inside OxGFrame

  1. Overview of INetProvider Interface

    The INetProvider interface serves as the transport driver layer for NetFrame. It abstracts different communication libraries into a consistent interface used by NetNode. Developers can use the built-in implementations or create a custom implementation to support additional transport protocols.
    using OxGFrame.NetFrame;

public interface INetProvider

  2. Overview of YooAssetBridge

    The YooAssetBridge is a public static class in the OxGFrame.AssetLoader.Bundle namespace. It uses reflection to access internal members of the YooAsset package, allowing the framework to retrieve necessary information without modifying the original YooAsset source code. It is divided into three nested static classes: YooAssetSettingsData, DownloadSystemHelper, and DefaultBuildinFileSystemDefine.
    using OxGFrame.AssetLoader.Bundle;

  3. Overview of NetFrame Network Module

    NetFrame is a network module that supports multi-node (NetNode) architecture. It handles standard network events including OnOpen, OnBinary, OnMessage, OnError, and OnClose. The module provides built-in support for heartbeat detection, timeout handling, and disconnection reconnection callbacks, and implements the INetTips network message interface.

  4. Overview of OxGFrame AI Agent Skills

    OxGFrame provides an 'AI Agent Skills' sample designed to assist AI coding agents (such as Claude Code, OpenAI Codex CLI, Cursor, and Copilot) in using the framework correctly. The skill consists of a SKILL.md entry and several source-verified documents in a references/ folder. It covers modules including AssetLoader, CoreFrame (UI/SR/US/CP), MediaFrame (audio/video), GSIFrame, NetFrame, CenterFrame, and Hotfixer, as well as production architecture and coding style guidance. The skill uses a 'progressive disclosure' approach: the agent reads SKILL.md first and loads specific references only as needed to optimize context window usage.

  5. Overview of CoreFrames Facade

    CoreFrames is the unified entry point (Facade) for the CoreFrame module in the OxGFrame framework. It manages the preloading, showing, closing, hiding, loading, and unloading of interface objects and scenes, integrating directly with AssetLoader's reference counting. It exposes four primary API groups via nested static classes:

    • UIFrame: Manages UI windows.
    • SRFrame: Manages scene resources.
    • USFrame: Manages Unity scenes.
    • CPFrame: Manages clone prefabs.

    Subsystem managers (e.g., UIManager, SRManager) are created automatically on first use and persist across scenes via DontDestroyOnLoad.

    using OxGFrame.CoreFrame;

  6. Overview of BundleHelper for AssetLoader

    BundleHelper is a public static class used within the Unity Editor environment to manage the export of AppConfig, PatchConfig, asset bundles, and CDN deployment configurations (CdnConfig). It also provides utility methods to parse and convert group and DLC argument strings, facilitating CI/CD integration.
    using OxGFrame.AssetLoader.Editor;

  7. Overview of NetFrames Facade

    NetFrames is a public static class in the OxGFrame.NetFrame namespace that serves as a facade for managing multiple network connections. It organizes connections into units called NetNode, each of which can have its own transport implementation (INetProvider) and connection options (NetOption). It handles node registration, connection, data transmission, and closing, while providing control over the updater that drives network polling.

  8. Overview of PatchSettings in OxGFrame AssetLoader

    PatchSettings is a ScriptableObject used by the AssetLoader to centrally define global settings for hot-updates and asset bundles, including configuration file names, extensions, encryption keys, and output folder names. It is accessed at runtime via the static settings property.
    using OxGFrame.AssetLoader;

  9. Overview of NetFrames Facade

    NetFrames is a public static class in the OxGFrame.NetFrame namespace that acts as the unified entry point for the NetFrame module. It manages multiple network connections as NetNode objects. Each node pairs a transport implementation (INetProvider) with connection options (NetOption). NetFrames handles node registration, connecting, sending data, and closing connections, and controls the updater that drives network polling.

  10. Overview of OxGFrame Core Module Frame Types

    v2
    The core module integrates with AssetLoader for automatic unloading and provides four primary frame types for managing game objects, each with specific naming conventions for object binding:

  11. Overview of HotfixHelper for Unity Editor

    The HotfixHelper class (namespace OxGFrame.Hotfixer.Editor) is a public static utility used in the Unity Editor to compile and collect AOT and Hotfix DLLs into the HotfixCollector directory. It also exports the HotfixManifest.dat configuration file used by the runtime auto-config mode of Hotfixers.CheckHotfix.
    using OxGFrame.Hotfixer.Editor;

  12. Overview of NetFrame Networking Module

    NetFrame is a networking module that implements multi-node management via NetNode. It supports standard network events (OnOpen, OnBinary, OnMessage, OnError, OnClose) and provides built-in support for heartbeat detection, timeout handling, and disconnection reconnection callbacks. It also implements the INetTips interface for network status notifications.