Skip to main content
Version: v3

BundleConfig

Important Attention Reminder

Coding Style wiki​

using OxGFrame.AssetLoader.Bundle;

Methods​

GetValueFromUrlCfg​

Gets the specified key-value pair from the burlconfig.conf deployment configuration file. Supports automatic detection of encryption status and decryption.

Params

  • string key: Key name in the configuration file (e.g., BUNDLE_IP)

Attention If the file header matches the encryption mark, it will be decrypted using the Cipher Key set in the project.

GetAppConfigFromStreamingAssets / HostServer​

Gets the application basic configuration (AppConfig).

  • StreamingAssets: Read from built-in resources included with the package.
  • HostServer: Read from a remote server (supports weak network handling; if it fails, it attempts to fall back to the last successfully cached version).

GetHostServerUrl / GetFallbackHostServerUrl​

Combines the complete remote resource download address based on the Package name.

  • Host: Main CDN address.
  • Fallback: Backup CDN address.

Params

  • string packageName: Resource package name

Reminder The path combination logic automatically determines the version folder format (e.g., v1.0 or v1.0.0) based on SEMANTIC_RULE (semantic rules).

GetDlcHostServerUrl / GetDlcFallbackHostServerUrl​

Gets the endpoint path for DLC packages located on the remote server.

Params

  • string packageName: DLC package name
  • string dlcVersion: DLC version number
  • bool withoutPlatform: Whether to ignore the platform path level (default is false)

GoToAppStore​

Gets the STORE_LINK setting and directly calls the system browser to open the main app store link (Google Play / App Store).

Local & Builtin Path Operations​

Provides resource path localization functions:

Method NameDescription
GetLocalSandboxRootPathGets the root directory path for local persistent resources (Sandbox).
GetLocalSandboxPackagePathGets the local storage path for a specific Package.
GetBuiltinRootPathGets the root directory path for built-in resources.
GetRequestStreamingAssetsPathGets the StreamingAssets path suitable for WebRequest (automatically handles file:// prefix for iOS/OSX).

GetHostServerAppConfigPath / PatchConfigPath​

Gets the complete URL path for configuration files (AppConfig / PatchConfig) on the remote server.

Important This method prioritizes reading the built-in AppConfig to determine the current product name and platform, then requests the configuration file under the corresponding path from the remote server.