Getting started

Android¶

Set up Hercules module¶

Refer to the build.gradle settings in SDK Set up → Android.
Android Studio → Setting Dependency for Hive SDK and External Library to add dependencies for Hercules.
```
// Hercules
implementation "com.com2us.android.hive:hercules:$HIVE_SDK_VERSION"
```

Remove Hercules module¶

Remove the following dependencies in the build.gradle file described in SDK Set up → Android.
Android Studio → Setting Dependency for Hive SDK and External Library.
```
// Hercules
// implementation "com.com2us.android.hive:hercules:$HIVE_SDK_VERSION" // Remove this when it is not used
```

iOS¶

Set up Hercules module¶

See the Podfile example codes in SDK Set up → iOS.
Xcode → Applying Framework to add the dependency settings for the Hercules.
```
...
target 'HIVE_GAME_COOL' do
    pod 'Hercules', '${SDK_VERSION}'
end
...
```

Remove Hercules module¶

See the Podfile example codes in SDK Set up → iOS.
Xcode → Applying Framework to remove the dependency settings for the Hercules.
```
...
target 'HIVE_GAME_COOL' do
end
...
```

Cocos¶

Android¶

Same as Android native

iOS¶

Same as iOS native

Unity¶

Mobile¶

The following settings are required to use the Hercules module in the Unity environment.
- Click Hive → ExternalDependency.
- When the ExternalDependencyEditor window appears, enable Hercules.
- Uncheck to not use Hercules in your app.

Windows¶

Set up Hercules module¶

Hive SDK Unity Plugin includes Hercules by default.

Uninstall the Hercules module¶

Delete the files below.
- /Assets/Hive_SDK_v4/Plugins/Windows/additional/Hercules.dll
- /Assets/Hive_SDK_v4/Plugins/Windows/additional/HIVE_UI_IMPL_C_PORT.dll

Unreal¶

Android¶

Select Unreal Editor → Edit → Project Settings.
In the left panel of Project Settings, select Hive SDK → Dependency → Android.
Check Module → Enable Hercules.
Uncheck to not use Hercules in your app.

iOS¶

Select Unreal Editor → Edit → Project Settings.
In the left panel of Project Settings, select Hive SDK → Dependency → iOS.
Check Module → Enable Hercules.
Uncheck to not use Hercules in your app.

Windows¶

Set up Hercules module¶

The Hive SDK Unreal Plugin includes Hercules by default.

Uninstall the Hercules module¶

Remove the /Plugins/HIVESDK/Source/HIVESDK/ThirdParty/windows/additional/hivePlugins/hercules folder.

Calling API to enable/disable the Hercules module¶

Warning

If you do not want to use the Hercules module, you must explicitly inform the Hive SDK that you will not use the Hercules module through the setUseHercules API before initializing AuthV1 and AuthV4, after removing the Android dependencies and removing the iOS framework. Refer to the example code below. If the API is not called after the Android dependencies and the iOS framework were removed, it is regarded as a malicious falsification and the app is forced to crash at the completion stage of AuthV1 and AuthV4 initialization.

Note

Hive SDK automatically initializes the Hercules module when AuthV1 and AuthV4 initialization is completed.

Example code¶

UnityC++KotlinJavaSwiftObj-C

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
Configuraiton.setUseHercules(false);

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
hive::Configuration::setUseHercules(false);

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
Configuration.useHercules = false

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
com.hive.Configuration.INSTANCE.setUseHercules(false);

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
ConfigurationInterface.setUseHercules(false)

// Set it to false if you do not want to use the Hercules module
// You should call this API before AuthV1, AuthV4 initialization
[HIVEConfiguration setUseHercules:NO];