Android Unity Local AI VOICEVOX Kit VRM

Unityで作成したAndroidアプリに、ローカルLLM推論、VOICEVOX COREによる音声合成、VRMアバター表示を組み込むための開発用キットです。

Android端末内で処理を行うため、対応するGGUFモデルおよびVVM音声モデルを配置すれば、ローカルLLM推論と音声合成はネット接続なしでも動作できます。

## 主な機能

* Android端末上でのローカルLLM推論

* VOICEVOX COREを用いたローカル音声合成

* Unity C# と Android Native Runtime の連携

* VRMアバター表示

* 感情タグによる表情切り替え

* VOICEVOX音声再生に合わせた簡易口パク

* Android向けサンプルシーン

* GGUFモデル配置用フォルダ

* VVM音声モデル配置用フォルダ

* GGUF転送補助ツール

## 対応環境

* Unity 2022.3系

* Android

* arm64-v8a

* Android実機

## ご注意

本商品は完成済みアプリではありません。

Unityプロジェクトを開き、利用者自身でAndroid向けAPKをビルドして使用する開発用キットです。

本商品はAndroid向けNative Runtimeを使用するため、Unity Editor上だけでは完全な動作確認はできません。

Android実機へAPKをインストールして確認してください。

すべてのGGUFモデルでの動作を保証するものではありません。

以下のファイルは同梱されていません。

* ローカルLLM用GGUFモデル

* VOICEVOX音声モデル（VVM）

GGUFモデルとVVM音声モデルは、利用者自身で取得して配置してください。

各モデル、音声ライブラリ、第三者OSSの利用条件については、配布元の規約をご確認ください。

## 自作部分の利用条件

本商品の自作部分には、BOOTH正規購入者本人のみを対象とする購入者限定ライセンスが適用されます。

購入者本人が制作する完成アプリケーションへの組込み、改変、公開および販売は可能です。

本商品そのもの、ソースコード、Nativeライブラリ、Unityプロジェクト、SDK、UnityPackage、テンプレート、サンプルプロジェクト、開発キットまたは素材集としての再配布、共有、転売は禁止されています。

法人、団体、開発チーム、共同開発者、外部委託先など、複数人でファイルを共有して利用する場合は、別途ライセンスが必要です。

## 第三者コンポーネントについて

本商品には、第三者OSSおよび関連データが含まれます。

主な第三者コンポーネント:

* llama.cpp

* ggml

* VOICEVOX CORE

* ONNX Runtime

* Open JTalk Dictionary

* Android NDK libc++ Shared Runtime

* UniVRM / UniGLTF

各第三者コンポーネントには、それぞれのライセンスが適用されます。

GGUFモデルとVVM音声モデルは同梱されていません。

利用者自身で取得し、それぞれの配布元および利用規約を確認してください。

VOICEVOX音声モデルおよび生成音声の利用条件については、VOICEVOX公式および各音声ライブラリの規約をご確認ください。

## 商品種別

ダウンロード商品

Unity向け開発用キット

Android専用

## 初期セットアップ

本商品は、Unity Hubから開いて使用するサンプルプロジェクト方式です。

### 1. ZIPファイルを展開する

ダウンロードしたZIPファイルを任意の場所へ展開してください。

フォルダ名に日本語や特殊文字を含めない場所を推奨します。

例:

`C:/UnityProjects/Android_Unity_Local_AI_VOICEVOX_Kit_VRM/`

### 2. Unity Hubからプロジェクトを開く

Unity Hubの「Add」または「ディスクから加える」から、展開したプロジェクトフォルダを選択してください。

本サンプルはUnity 2022.3系を基準に作成しています。

### 3. GGUFモデルを配置する

ローカルLLM用のGGUFモデルは同梱されていません。

利用者自身で、使用するモデルのライセンスを確認したうえで取得してください。

取得した `.gguf` ファイルは、以下のフォルダへ配置します。

`Assets/StreamingAssets/models/`

ZIP内には、配置場所を示す案内ファイルがあります。

`Assets/StreamingAssets/models/PLACE_GGUF_HERE.txt`

同梱の `GGUF転送ツール.zip` には、Android実機へのGGUF転送を補助するバッチファイルが含まれています。

### 4. VOICEVOX音声モデルを配置する

VOICEVOX音声モデル `.vvm` は同梱されていません。

利用者自身で、公式配布元および各音声モデルの利用規約を確認したうえで取得してください。

取得した `.vvm` ファイルは、以下のフォルダへ配置します。

`Assets/StreamingAssets/VoiceVox/models/`

ZIP内には、配置場所を示す案内ファイルがあります。

`Assets/StreamingAssets/VoiceVox/models/PLACE_VVM_HERE.txt`

Open JTalk辞書は、あらかじめ以下の場所へ同梱されています。

`Assets/StreamingAssets/VoiceVox/open_jtalk_dic_utf_8-1.11/`

## サンプルシーン

動作確認用のサンプルシーンは、以下にあります。

`Assets/Scenes/LocalAIVoiceSample.unity`

このシーンを開き、Android向けにビルドしてください。

サンプルシーンでは、以下の流れを確認できます。

`テキスト入力`

↓

`Android端末上でローカルLLM推論`

↓

`生成された応答を表示`

↓

`感情タグに応じてVRMアバターの表情・モーションを切り替え`

↓

`VOICEVOX COREで音声合成`

↓

`Android端末で音声再生`

## Android向けビルド

### 1. Build Settingsを開く

Unityメニューから以下を開きます。

`File`

↓

`Build Settings`

### 2. Androidへ切り替える

Platformで `Android` を選択し、必要に応じて `Switch Platform` を実行してください。

### 3. サンプルシーンを登録する

`Assets/Scenes/LocalAIVoiceSample.unity` を開いた状態で、Build Settingsの `Add Open Scenes` を押してください。

### 4. Android実機向けにビルドする

Android実機を接続し、`Build And Run` を実行してください。

本商品はAndroid向けNative Runtimeを使用するため、Unity Editor上だけでは完全な動作確認はできません。

Android実機へAPKをインストールして確認してください。

## 初回起動時の注意

ローカルLLMとVOICEVOX音声モデルの読み込みには、端末性能やモデルサイズに応じて時間がかかる場合があります。

動作速度は、使用するAndroid端末、GGUFモデル、VVMファイル、生成設定によって変わります。

すべてのGGUFモデルでの動作を保証するものではありません。

最初は、小容量の量子化済みGGUFモデルを使用して動作確認することを推奨します。

## 既存のUnityプロジェクトへ組み込む場合

本商品は、初回導入を分かりやすくするため、サンプルプロジェクト一式として提供しています。

既存のUnityプロジェクトへ組み込む場合は、サンプルプロジェクトの構成を参考に、必要なAssets、Android向けNativeライブラリ、AndroidManifest、StreamingAssetsを移植してください。

単純なC#スクリプトだけでなく、Android向けNativeライブラリと設定ファイルも必要です。

## トラブル時に確認する項目

動作しない場合は、最初に以下を確認してください。

* UnityのPlatformがAndroidになっているか

* Android実機がarm64-v8aに対応しているか

* `.gguf` ファイルが `Assets/StreamingAssets/models/` に配置されているか

* `.vvm` ファイルが `Assets/StreamingAssets/VoiceVox/models/` に配置されているか

* Android実機へAPKをビルドして確認しているか

* 使用しているGGUFモデルおよびVVMの利用規約を確認しているか

* 端末のストレージ容量が不足していないか

* Unity Editor上だけで動作確認しようとしていないか

## 免責事項

本商品を使用したことによって発生した損害、データ消失、端末やプロジェクトへの影響、第三者コンポーネントや各モデルの利用規約違反等について、販売者は責任を負いません。

利用者自身の責任において、各ライセンス、利用規約、配布条件を確認したうえで使用してください。