All engines

Regardless of the development engine (Unity, Unreal, ...) and platform (Android, iOS, ...), the SDK settings must be defined in the hive_config.xml file at the point before building the app. Therefore, to use the SDK, you must create a new hive_config.xml file, enter the content, and include it in your app project. The settings in this file apply at the point of initializing the SDK. It is recommended to pre-define all static items that do not change at runtime in this file. The file should be located at the path below.

• Unity
  • Android
    • Unity 2021 and above: /Assets/HiveSDK/hive.androidlib/src/main/res/raw/hive_config.xml
    • Unity below 2021: /Assets/Plugins/Android/res/raw/hive_config.xml
  • iOS
    • /Assets/Plugins/iOS/hive_config.xml
  • Windows
    • /Assets/Plugins/Windows/res/hive_config.xml
• Unreal Engine
  • Android
    • /HIVESDK/Source/HIVESDK/ThirdParty/android/resource/res/raw/hive_config.xml
  • iOS
    • /HIVESDK/Source/HIVESDK/ThirdParty/iOS/resource/hive_config.xml
  • Windows
    • /HIVESDK/Source/HIVESDK/ThirdParty/Windows/config/hive_config.xml
• Android Native
  • /app/res/raw/hive_config.xml
• iOS Native
  • Create the hive_config.xml file in the desired location and link it directly to the Xcode project

SDK common settings¶

Regardless of which SDK feature you use, it is fundamentally an item that must be entered in hive_config.xml. Required items must be entered, while optional items are entered as needed. If optional items are not entered, the SDK will operate with the default values.

SDK feature settings¶

Settings for the SDK features you want to use, such as Authentication, Billing, and Marketing Attribution. Enter only the items corresponding to the SDK features you will use in hive_config.xml. For more details, please refer to the preparation page of each SDK feature developer guide as shown below.

• Authentication
• Marketing Attribution
• Analytics

Unsupported configuration¶

hive_config.xml The items in the file are as follows, which are no longer supported.

hive_config.xml example¶

Below is an example of the hive_config.xml file when using Authentication (Google authentication) and Billing (Google Play Store). Please change, add, or delete values according to the SDK features you want to use and the app environment. The iOS platform only supports Apple App Store Billing, so in the Unity iOS environment, set the market to AP.

<properties>

    <!-- SDK Common Settings: START -->
    <!-- Set unique game build identifier -->
    <appId>com.sample.your</appId>

    <!-- Select Hive Platform server. sandbox for development, real for production
        (sandbox, real) -->
    <zone>real</zone>

    <!-- Set whether to use SDK internal operation logs
        (true, false) -->
    <useLog>false</useLog>

    <!-- Set whether to apply ageGateU13
        (true, false) -->
    <ageGateU13>false</ageGateU13>

    <!-- hiveOrientation setting -->
    <hiveOrientation>landscape</hiveOrientation>

    <!-- Channel setting (login and in-app support service platform)
        (C2S: Hive Platform) -->
    <channel>C2S</channel>

    <!-- Billing market setting (GO: Google Play, LE: Com2uS Lebi, AP: Apple App Store) -->
    <market>GO</market>

    <!-- Set criteria for receiving agreement to terms
        (device, account) -->
    <agreementDetermineBase>false</agreementDetermineBase>

    <!-- Set terms exposure design (not set for SDK v4)
        (true, false) -->
    <!-- <authV1Agreement>device</authV1Agreement> -->

    <!-- Set sharing apps not to be displayed for Promotion UA Share (Android Only) -->
    <unsupportedUAShareType>
        <value>SMS</value>
        <value>URL</value>
    </unsupportedUAShareType>

    <!-- Set HTTP Connect Timeout used internally by SDK in seconds
        (Do not change unless in special cases) -->
    <httpConnectTimeout>8</httpConnectTimeout>

    <!-- Set HTTP Read Timeout used internally by SDK in seconds
        (Do not change unless in special cases) -->
    <httpReadTimeout>8</httpReadTimeout>
    <!-- SDK Common Settings: END -->

    <!-- SDK Analytics Settings: START -->
        <!-- Analytics settings, refer to Analytics pre-configuration guide -->
    <!-- SDK Analytics Settings: END -->

    <!-- SDK Feature Settings: START -->
    <providers>             
        <!-- Set authentication product, refer to Authentication pre-configuration guide -->
        <!-- Set billing product, refer to Billing pre-configuration guide -->
        <!-- Set marketing attribution product, refer to Marketing Attribution pre-configuration guide -->
    </providers>
    <!-- SDK Feature Settings: END -->

</properties>