はじめに

はじめまして、kei-1111です。

Androidアプリ開発においてネイティブアプリに3Dを組み込みたいと思うことはありませんか？
実際にAndroidに3Dを実装する際に考えられる選択肢として、以下のものなどが挙げられます。

今回はこの中の一つ、Unity as a Library（以下、UaaL）を用いて、AndroidアプリにUnity 2022を組み込み相互通信するところまで紹介します！

今回は、UaaLを導入し3Dアプリを作成する方法を紹介しますが、3Dモデルを少し表示させたいといった場合はSceneViewのほうが適しているなど向き不向きがあります。プロジェクトによって何が最適か考えてから導入を行ってください。

この記事で学べること

✅ UnityプロジェクトをAndroidアプリに組み込む方法（モジュール/AAR両対応）
✅ ComposeでUnityコンテンツを表示する方法
✅ Android ↔ Unity間の双方向通信の実装

UaaLとは

UaaLは、UnityのARや3D/2Dのリアルタイムレンダリング機能をネイティブアプリに組み込むことができる技術です。Unity 2019.3から正式サポートとなりました。

公式サイトでは以下のように説明されています。

拡張現実(AR)、3D/2D リアルタイムレンダリング、2D ミニゲームなど、Unity で開発した機能を、ネイティブモバイルアプリケーションに直接挿入。

開発環境

OS: macOS Sequioia 15.5
Android Studio: Narwhal Feature Drop 2025.1.2
Unity: 2022.3.62f2

Unity 6以降だと今回紹介する方法は使用できません、UnityPlayerというAndroidでUnityを扱えるようにするクラスが変わってしまう影響です。Unity 6以降で実装する方法は、別の記事を書くのでそちらをご覧ください。

導入

1. Unityプロジェクトの作成

Androidに組み込むUnityプロジェクトを作成します。今回はUnityプロジェクト作成方法の解説は省略します。
説明のために、簡単なUnityプロジェクトを作成したので、UaaLの導入だけ試してみたい方は、使用してみてください。

簡単にプロジェクトの説明をすると、実行するとランダムな箇所から球を落とすというスクリプトを用意したプロジェクトです。

2. Unityプロジェクトのエクスポート

今回作成しているUnityバージョンが2022.3.62f2のため画像のUIになっていますが、Unity6以降だとUIが変わっています。Unity 6の記事は別で上げる予定なのでそちらをご覧ください。

ここでは、作成したプロジェクトをエクスポートし、実際にAndroidに組み込むunityLibraryを作成します。

まず、UnityプロジェクトのツールバーからFile ▶ Build Settingsを選択しBuild Settingsを開きます。このとき画像のようにPlatformをAndroidへスイッチし、Export Projectのチェック追加も忘れずにしておきましょう！これを行わないと、Androidに組み込むunityLibraryが作成されなくなります。


▲Build Settings

次に、Build Setting左下の「Player Settings...」からPlayer Settingsを表示させます。Player Settingsでは、エクスポートするUnityプロジェクトの詳細設定をすることができます。最初に行うべき設定を行っていきます。まず、Other Settings ▶ Configuration ▶ Scription BackendをIL2CPPへと変更してください。次に、Other Settings ▶ Configuration ▶ Target ArchitecturesでARMv7とARM64にチェックをつけてください。これで必須の設定は完了です。


▲Player Settings

Player SettingsではエクスポートするunityLibraryの設定をすることができます。以下に主観で選んだ使いそうな設定を載せておくので、自分のプロジェクトにあった設定をしてみてください。他にもまだまだあるので、色々触ってみてください。

Resolution and Presentaiton

Fullscreen Mode
Navigation Bar　表示/非表示
画面回転

Splash Image

Splash　表示/非表示（Proプランならば非表示にすることができます！学生なら無料でProプランになれるのでぜひしてみよう）
Splash時に表示する画像

Player Settingsでエクスポート設定が終わったら、Player Settingsを閉じてBuild Settings右下の「Export」からエクスポートします。エクスポートするフォルダを選択する必要があるので、任意のフォルダを作成し、エクスポートしましょう！
選択したフォルダの中にunityLibraryがあれば成功です！！

3. Unityプロジェクトの組み込み

作成したunityLibraryをAndroidに組み込む方法は主に2つあります。

モジュールとして組み込む
AARとして取り込む（おすすめ）

どちらも紹介するので、気に入った方法を試してみてください！

AARはunityLibraryモジュールより大きくないためGitで管理することができます（プロジェクトによるとは思います）。またAndroidで一度AARを読み込むように設定すれば、AARを切り替えるだけでUnityの変更を反映することができるようになります。これらの理由からAARとして取り込む方法がおすすめです

モジュールとして組み込む

まず、Unityを組み込みたいAndroidプロジェクトの配下にエクスポートしたunityLibraryを配置します。

unityLibraryはサイズが大きくGit管理できないので、.gitignoreでGit管理しないようにするのがおすすめです
管理しないようにする場合は、プロジェクト直下の.gitignoreに/unityLibraryを追加します。

次に、unityLibraryのbuild.gradleを変更します。
主な変更点は以下のようになっています。

unityLibrary/build.gradle

// 前略

android {
    // 中略
    
-    aaptOptions {
-        noCompress = ['.unity3d', '.ress', '.resource', '.obb', '.bundle', '.unityexp'] + unityStreamingAssets.tokenize(', ')
-        ignoreAssetsPattern = "!.svn:!.git:!.ds_store:!*.scc:!CVS:!thumbs.db:!picasa.ini:!*~"
-    }

// 中略

def BuildIl2Cpp(String workingDir, String configuration, String architecture, String abi, String[] staticLibraries) {

    // 中略
-    commandLineArgs.add("--tool-chain-path=" + android.ndkDirectory)
+    commandLineArgs.add("--tool-chain-path=" + android.ndkPath)

}

// 後略

aaptOptionsがあると、存在しないunityStreamingAssetsにアクセスしようとしてSyncできませんでした。また、デフォルトだとndkDirectoryという宣言をandroidブロックでしていないにもかかわらず、使用しようとしておりSyncできないのでndkPathへと変更する必要があります。

次に、Android側でモジュールとして認識するようにsettings.gradle.ktsとapp/build.gradle.ktsの編集を行います。

settings.gradle.kts

// 前略

rootProject.name = "uaal-sample-unity2022-android"
include(":app")
+include(":unityLibrary")

app/build.gradle.kts

// 前略

val unityLibraryLibsDir = project(":unityLibrary").projectDir.resolve("libs")

dependencies {

    implementation(project(":unityLibrary"))
    implementation(fileTree(mapOf("dir" to unityLibraryLibsDir, "include" to listOf("*.jar"))))

    // 中略
}

ここまで設定してSync Nowすれば、モジュールとしてUnityプロジェクトを組み込む方法は終わりです！！
次の「4.Unityの表示」に進んでください。

AARとして組み込む

AARとして組み込む方法を試すには、gradleコマンドを使えるようにしてください。gradleを使えるようにする方法の解説は省略させていただきます。gradleが使えるかの確認は、gradle -vした際に、バージョンが出てくるようになればgradleを使えます。

次に、unityLibrary配下に移動して、gradle assembleReleaseコマンドを実行してください。これは、AARを作成するためのコマンドです。BUILD SUCCESSFULと出れば成功です！unityLibrary/build/outputs/aar/unityLibrary-release.aarがあるはずです

ここまでできたら、あとはAndroidにAARを入れるだけです。Unityを組み込みたいAndroidプロジェクトにAARを入れるためのフォルダを作成します。今回はlibs/unityフォルダを作成し移動させました！（root配下においても大丈夫ですその場合は、appモジュールのbuild.gradle.ktsで指定するパスを変更しておいてください）

Unityを使用したいモジュールのbuild.gradle.ktsのdependenciesにAARを使用できるようにするための依存関係を追加します。
今回は、appモジュールのbuild.gradle.ktsに以下のように記述しAARを使用できるようにしました！
AARの配置場所を変更した際は、build.gradle.ktsのAARのパスも変更を行ってください。

build.gralde.kts

// 前略

val unityLibraryAar = File(rootDir, "libs/unity/unityLibrary-release.aar")

dependencies {
    implementation(files(unityLibraryAar))

    // 中略
}

ここまで設定してSync Nowすれば、AARとしてUnityプロジェクトを組み込む方法は終わりです！！
次の「4. Unityの表示」に進んでください。

4. Unityの表示

実際にUnityを表示させる前に、app/src/main/res/values/strings.xmlにUnityが使用するための文字列を追加します。Unityが内部でgame_view_content_descriptionを使用しているらしく、この文字列設定がないと、アプリがクラッシュします。肝心の文字列はGame viewとしていますが、何でも大丈夫です。

strings.xml

<resources>
    <string name="app_name">uaal-sample-unity2022-android</string>
+    <string name="game_view_content_description">Game view</string>
</resources>

ここからは、実際にUnityを表示させます！
以下は、実装例です。

MainActivity

class MainActivity : ComponentActivity() {

    private var unityPlayer: UnityPlayer? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        unityPlayer = UnityPlayer(this)

        setContent {
            UaalsampleTheme {
                AndroidView(
                    factory = { unityPlayer!! },
                    modifier = Modifier.fillMaxSize()
                )
            }
        }
    }

    override fun onWindowFocusChanged(hasFocus: Boolean) {
        super.onWindowFocusChanged(hasFocus)
        unityPlayer?.windowFocusChanged(hasFocus)
    }

    override fun onResume() {
        super.onResume()
        unityPlayer?.resume()
    }

    override fun onPause() {
        super.onPause()
        unityPlayer?.pause()
    }
}

UaaLはComposeに対応しておらず、そのまま表示させることはできないため、AndroidViewを使用して表示させています。

ここで重要なポイントは2つあります。

onResume()とonPause()で適切にライフサイクルの管理を行わないといけない
onWindowFocusChanged(hasFocus: Boolean)でwindowFocusChangedを呼ばないといけない

これらを適切に行わないと、Unityの画面がフリーズするといった問題が起きるため、ライフサイクル管理と、アクティビティでのフォーカス管理は忘れないようにしてください。

ComposeのNavigationを行う際は、DisposableEffectを利用したライフサイクル管理で、適切にunityPlayer.resume()とunityPlayer.pause()を行ってください。それができれば、フリーズすることなく動くはずです...！

ここまでの実装を行うと、以下のように組み込んだUnityが表示されるようになります。
（サンプルとして作成したUnityはなんの設定も行っていないので初期背景のままです...）

5. UnityとAndroidの相互通信

ここからは、AndroidからUnity、UnityからAndroidといった相互での通信ができるようにしていきます。

AndroidからUnity

まず、Androidから呼び出すスクリプトを作成します。

ObjectSpawner.cs

using UnityEngine;

public class ObjectSpawner : MonoBehaviour
{
    [SerializeField] private float spawnHeight = 10f;
    [SerializeField] private float spawnRangeX = 5f;
    [SerializeField] private float spawnRangeZ = 5f;

    private int objectCount = 0;

    public void SpawnObject()
    {
        // ランダムな位置を計算
        float randomX = Random.Range(-spawnRangeX, spawnRangeX);
        float randomZ = Random.Range(-spawnRangeZ, spawnRangeZ);
        Vector3 spawnPosition = new Vector3(randomX, spawnHeight, randomZ);

        // Sphereを生成
        GameObject sphere = GameObject.CreatePrimitive(PrimitiveType.Sphere);
        sphere.transform.position = spawnPosition;

        // Rigidbodyを追加
        Rigidbody rb = sphere.AddComponent<Rigidbody>();
        rb.collisionDetectionMode = CollisionDetectionMode.Continuous;

        // カウントを増やす
        objectCount++;

        // 5の倍数チェック
        if (objectCount % 5 == 0)
        {
            OnMultipleOfFive();
        }

        // 10秒後に削除
        Destroy(sphere, 10f);
    }

    /// <summary>
    /// カウントが5の倍数になった時の処理
    /// </summary>
    private void OnMultipleOfFive()
    {
        /// TODO: Androidへメッセージを送る処理を作成
    }

    /// <summary>
    /// 現在のカウントを取得
    /// </summary>
    public int GetCount()
    {
        return objectCount;
    }

    /// <summary>
    /// カウントをリセット
    /// </summary>
    public void ResetCount()
    {
        objectCount = 0;
    }

    // テスト用: Spaceキーで落下テスト
    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            SpawnObject();
        }
    }
}

このスクリプトでは、呼び出されると球を落とすSpawnObject()定義しています。今回はSampleManagerUnityオブジェクトに、このスクリプトをアタッチして球を落とすようにしました。

次に、AndroidからUnityへとメッセージを送れるようにします。AndroidからUnityへとメッセージを送るためには、UnitySendMessage関数を呼び出します。
UnitySendMessage関数は、文字列を3つ受け取ります。それぞれ意味があり、以下のようになっています。

1つ目の文字列は、呼び出す対象となるオブジェクト名
2つ目の文字列は、呼び出す関数
3つ目の文字列は、Unityに渡したい文字列

今回は、オブジェクト名と呼び出す関数をそれぞれ列挙するenumクラスを作成し、タイポが起こらないようします。

UnityObject.kt

enum class UnityObject(val objectName: String) {
    SAMPLE_MANAGER("SampleManager")
}

UnityMethod.kt

enum class UnityMethod(val methodName: String) {
    SPAWN_OBJECT("SpawnObject")
}

これらを組み合わせてUnitySendMessageをこのようにしました。この関数を呼び出すだけで、最初に紹介したように球が落ちてくるようになります。（今回は文字列を渡さないので、第3引数は""となっています。）

UnitySendMessage(UnityObject.SAMPLE_MANAGER.objectName, UnityMethod.SPAWN_OBJECT.methodName, "")

UnitySendMessageを呼び出すボタンも配置したMainActivityの全体像はこのようになりました。

MainActivity.kt

class MainActivity : ComponentActivity() {

    private var unityPlayer: UnityPlayer? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        unityPlayer = UnityPlayer(this)

        setContent {
            UaalsampleTheme {
                Box(
                    modifier = Modifier.fillMaxSize()
                ) {
                    AndroidView(
                        factory = { unityPlayer!! },
                        modifier = Modifier.fillMaxSize()
                    )
                    Box(
                        modifier = Modifier
                            .fillMaxSize()
                            .safeGesturesPadding()
                    ) {
                        Button(
                            onClick = {
                                // onClickのタイミングでUnityへメッセージを送る                            
                                UnitySendMessage(UnityObject.SAMPLE_MANAGER.objectName, UnityMethod.SPAWN_OBJECT.methodName, "")
                            },
                            modifier = Modifier.align(Alignment.BottomCenter)
                        ) {
                            Text(
                                text = "Send Message to Unity"
                            )
                        }
                    }
                }
            }
        }
    }

    override fun onWindowFocusChanged(hasFocus: Boolean) {
        super.onWindowFocusChanged(hasFocus)
        unityPlayer?.windowFocusChanged(hasFocus)
    }

    override fun onResume() {
        super.onResume()
        unityPlayer?.resume()
    }

    override fun onPause() {
        super.onPause()
        unityPlayer?.pause()
    }
}

これを実行すると以下のようになります。
（Unity側でのマテリアル設定がうまくできておらずピンク色の球が落ちてきています...
Unity詳しくないので許してください）

これで、Android側のコンポーネントからUnityメソッドを呼び出せるようになりました

UnityからAndroid

UnityからAndroidへメッセージを送るようにします。Androidでは、Unityが呼ぶオブジェクトを作成します。Unityでは、作成したオブジェクトのメソッドを呼び出すという形でUnityからAndroidへのメッセージ送信ができるようになります。

Unityが呼び出すオブジェクトはこのようにしました。UnityからはsendMessage関数を呼び出すことでメッセージを送ります。Androidでは、ListenerインターフェースをオーバーライドしたクラスでUnityから送られてきたメッセージを処理します。

UnityMessageReceiver.kt

object UnityMessageReceiver {
    interface Listener {
        fun onMessageReceived(message: String)
    }

    var listener: WeakReference<Listener>? = null

    fun sendMessage(message: String) {
        listener?.get()?.onMessageReceived(message)
    }
}

今回はMainActivityでListenerをオーバーライドし処理を行うようにしました。

MainActivity

// UnityMessageReceiver.Listenerをオーバーライドし、Unityからのメッセージを受け取れるように
+ class MainActivity : ComponentActivity(), UnityMessageReceiver.Listener {

    private var unityPlayer: UnityPlayer? = null

    // listenerの初期化は忘れずに！！
+    init {
+        UnityMessageReceiver.listener = WeakReference(this)
+    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        unityPlayer = UnityPlayer(this)

        setContent {
            // UIは変わらないので省略
        }
    }

    // Unityからのメッセージを受け取る関数（今回はToastを表示）
+    override fun onMessageReceived(message: String) {
+        Toast.makeText(this, message + "個落としました", Toast.LENGTH_SHORT).show()
+    }

    // onWindowFocusChanged()やonPause()なので後略
}

今回はMainActivityでUnityからのメッセージを受け取るようにしましたが、本来であればViewModelなどでUnityMessageReceiver.Listenerをオーバーライドし、値を更新などを行うようにしてください。

これで、AndroidでUnityメッセージを受け取る準備ができました。次にUnityでAndroidへメッセージを送る処理を書いていきましょう。

ObjectSpawner.cs

using UnityEngine;

public class ObjectSpawner : MonoBehaviour
{
    /// 前略

    /// <summary>
    /// カウントが5の倍数になった時の処理
    /// </summary>
    private void OnMultipleOfFive()
    {
+        AndroidJavaObject androidMessenger = new AndroidJavaObject("io.github.kei_1111.uaal_sample_unity2022_android.UnityMessageReceiver");
+        androidMessenger.Call("sendMessage", objectCount.ToString());
    }

    /// 後略
}

今回は落ちた球の数が5の倍数になったとき、Androidへトータルいくつ球が落ちたかの数を送るようにしました。
AndroidJavaObjectに渡した文字列io.github.kei_1111.uaal_sample_unity2022_android.UnityMessageReceiverは、UnityMessageReceiverへのパスとなっています。UnityMessageReceiverの命名を変えたり、フォルダ位置を変えたりした場合は、ここも変更するようにしてください。パッケージ名.オブジェクト名にすれば問題ないと思います。
Call関数は、文字列を2つ受け取ります。それぞれ意味があり、以下のようになっています。

1つ目の文字列は、呼び出す対象となる関数
2つ目の文字列は、Androidに渡したい文字列

今回はsendMessageに球が落とした数を渡すようにしました。

これを実行すると以下のようになります。落とした球の数を反映したToastが表示されています！！UnityからAndroidへメッセージを送ることができました

終わりに

今回はUaaLを用いて、AndroidプロジェクトにUnityを組み込む方法を解説しました！合わせて、UnityとAndroidで相互通信もできるようにしました。これで、一通りUaaLを使えるようになったと思います
今回UaaLを試したリポジトリ載せておくので、気になった方はぜひ試してみてください。Android側はブランチを切っており、モジュールでUaaLを使えるようにした方法はunitylibrary-module、AARで組み込んだ方法はmainとなっています。確認したい場合は、ブランチを切り替えて確認してみてください。（unityLibraryをgitで管理することができなかったため、unitylibrary-moduleは単体では動きません。）

普段withmoというUaaLを使用したAndroidアプリを開発しています。このアプリでは、壁紙にUnityを表示したりと更にUaaLを発展させたプロジェクトとなっています。Playストアで公開中ですので、ぜひ使用してみてください。近々、大きなアップデートが入る予定です

参考記事