コンテンツにスキップ

Android Native

Android Native インストールガイド

Hercules Android Native Libraryは、Maven Centralからインストールできます。


1. Maven Centralリポジトリの設定

プロジェクトのsettings.gradleまたはsettings.gradle.ktsに、Maven Centralリポジトリが登録されていることを確認します。

dependencyResolutionManagementのrepositoriesにmavenCentral()がすでに含まれている場合、追加の設定は不要です。

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}

既存のdependencyResolutionManagementにmavenCentral()が含まれていない場合は、既存のrepositoriesにmavenCentral()を追加します。

settings.gradleまたはsettings.gradle.ktsでリポジトリを管理していないプロジェクトの場合は、Herculesを使用するモジュールのbuild.gradleまたはbuild.gradle.ktsに、次の内容を追加します。

repositories {
    mavenCentral()
}
Warning

既存のrepositoriesがある場合は、削除や上書きをせず、mavenCentral()のみを追加します。


2. Herculesの依存関係の追加

Herculesを使用するAndroidモジュールのbuild.gradleまたはbuild.gradle.ktsに、Herculesの依存関係を追加します。

Gradle (Groovy DSL)

dependencies {
    implementation 'com.com2us.android.gamesec:hercules:26.8.31'
}

Kotlin DSL

dependencies {
    implementation("com.com2us.android.gamesec:hercules:26.8.31")
}

Gradle Syncを実行すると、Maven CentralからHercules AARが自動的にダウンロードされます。


3. C/C++でのHerculesの使用

HerculesがサポートするABIは次のとおりです。

arm64-v8a, armeabi-v7a, x86, x86_64

C/C++でAPIを使用する場合は、AndroidモジュールでPrefabを有効にします。

Gradle (Groovy DSL)

android {
    buildFeatures {
        prefab true
    }
}

Kotlin DSL

android {
    buildFeatures {
        prefab = true
    }
}

続いて、使用するネイティブビルドシステムに応じて、CMakeまたはndk-buildの設定を追加します。


4. CMakeの設定

ndk-buildを使用する場合、またはC/C++でHerculesを使用しない場合は、CMakeの設定をスキップします。

4.1 GradleへのCMakeの接続

Herculesを使用するモジュールのGradle設定で、CMakeLists.txtを指定します。

Gradle (Groovy DSL)
android {
    externalNativeBuild {
        cmake {
            path file('src/main/cpp/CMakeLists.txt')
        }
    }
}
Kotlin DSL
android {
    externalNativeBuild {
        cmake {
            path = file("src/main/cpp/CMakeLists.txt")
        }
    }
}

すでにCMakeを使用しているプロジェクトの場合は、既存のexternalNativeBuild設定をそのまま使用します。

4.2 CMakeLists.txtでのHerculesのリンク

find_packageでHercules Prefabパッケージをインポートし、Herculesを使用するネイティブターゲットにリンクします。

たとえば、プロジェクトのネイティブライブラリ名がnative-libの場合:

cmake_minimum_required(VERSION 3.22.1)

project("sample")

add_library(native-lib SHARED
    native-lib.cpp
)

find_package(Hercules REQUIRED CONFIG)

target_link_libraries(native-lib
    Hercules::Hercules
)

5. ndk-buildの設定

CMakeを使用する場合、またはC/C++でHerculesを使用しない場合は、ndk-buildの設定をスキップします。

5.1 Gradleへのndk-buildの接続

Herculesを使用するモジュールのGradle設定で、Android.mkを指定します。

Gradle (Groovy DSL)
android {
    externalNativeBuild {
        ndkBuild {
            path file('src/main/cpp/Android.mk')
        }
    }
}
Kotlin DSL
android {
    externalNativeBuild {
        ndkBuild {
            path = file("src/main/cpp/Android.mk")
        }
    }
}

すでにndk-buildを使用しているプロジェクトの場合は、既存のexternalNativeBuild設定をそのまま使用します。

5.2 Android.mkでのHerculesのリンク

Herculesを使用するネイティブモジュールのLOCAL_SHARED_LIBRARIESにHerculesを追加し、Prefabモジュールをインポートします。

たとえば、プロジェクトのネイティブライブラリ名がnative-libの場合:

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE := native-lib
LOCAL_SRC_FILES := native-lib.cpp
LOCAL_SHARED_LIBRARIES := Hercules
include $(BUILD_SHARED_LIBRARY)

$(call import-module,prefab/Hercules)

NDK r21より前のバージョンもサポートする必要がある場合は、Prefabをインポートする前に次の設定を追加します。

ifneq ($(call ndk-major-at-least,21),true)
    $(call import-add-path,$(NDK_GRADLE_INJECTED_IMPORT_PATH))
endif

6. APIの使用

例:

#include <Hercules.h>
...
unsigned int version = HerculesGetVersion();
__android_log_print(ANDROID_LOG_INFO, "Hercules", "version: %u", version);

Herculesの初期化は、Hive SDKの初期化時に同時に行われます。

InitializeHerculesを呼び出す必要はありません。


7. バージョンの変更

インストールするHerculesのバージョンを変更するには、dependenciesに指定されたバージョンを変更します。

Gradle (Groovy DSL)

implementation 'com.com2us.android.gamesec:hercules:26.8.31'

Kotlin DSL

implementation("com.com2us.android.gamesec:hercules:26.8.31")

8. Herculesの削除

Herculesを削除するには、対象モジュールのdependenciesからHerculesの依存関係を削除します。

com.com2us.android.gamesec:hercules:26.8.31

C/C++でHerculesを使用していた場合は、CMakeまたはndk-buildに追加したHerculesのリンク設定も削除します。

CMake:

find_package(Hercules REQUIRED CONFIG)
Hercules::Hercules

ndk-build:

LOCAL_SHARED_LIBRARIES := Hercules
$(call import-module,prefab/Hercules)

Hercules以外にPrefabパッケージを使用する依存関係がない場合は、GradleのbuildFeatures.prefab設定も削除できます。