SDK をプロジェクトに導入する

最終更新： 2024年9月5日

Cubism Editor から書き出した組み込み用モデルファイルを Unreal Engine のプロジェクトに導入して、モデルをビューポートに表示するまでのチュートリアルです。

前提

Cubism SDK for Unreal Engine を使用するには Unreal Engine の5.3系 と Cubism SDK for Unreal Engine のインストールが必要です。
UnrealEngine のインストールについては こちら をご覧ください。
Cubism SDK for Unreal Engine のダウンロードは こちら から可能です。
Cubism SDK for Unreal Engine は Unreal Engine のプラグインという形で配布されています。
プラグインの仕組みについては Unreal Engineの 公式ドキュメント をご覧ください。

SDKでLive2Dのモデルを扱う場合は、編集用の.cmo3や.can3ではなく、組み込み用モデルとして書き出す必要があります。
組み込み用のモデルの書き出し方については 「組み込み用データ」をご覧ください。
書き出されるデータは、.moc3ファイル、.model3.jsonファイル、テクスチャの入ったフォルダです。
これらを一つのフォルダにまとめておいてください。

プラグインをプロジェクトファイルに追加

以下では、CubismSDKForUEという名前のUEプロジェクトを作成したことを想定します。
プロジェクトを作成する際は、プロジェクト生成時の設定でC++を選択することを推奨します。
作成したプロジェクトのディレクトリは概ね以下のようになるので、ルートディレクトリにPluginsフォルダを作成し、その下にプラグインを配置します。

CubismSDKForUE
├── Binaries
├── Config
├── Content
│   └── ...
├── Plugins <- ディレクトリを追加
│   └── CubismUnrealEngineComponents <- プラグインをここに配置する
│       └── ...
├── Source
└── CubismSDKForUE.uproject

テキストエディタ等でCubismSDKForUE.uprojectファイルを開き、Plugins のプロパティに Live2DCubismSDK を追加し、 Enabled に true を設定します。
追加したらファイルを上書き保存します。

{
	"FileVersion": 3,
	"EngineAssociation": "5.2",
	"Category": "",
	"Description": "",
	"Modules": [
		{
			"Name": "CubismSDKForUE",
			"Type": "Runtime",
			"LoadingPhase": "Default"
		}
	],
	"Plugins": [
		{
			"Name": "ModelingToolsEditorMode",
			"Enabled": true,
			"TargetAllowList": [
				"Editor"
			]
		},
		{
			"Name": "Live2DCubismSDK",
			"Enabled": true
		}
	]
}

そして保存した.uproject ファイルをダブルクリックしてプロジェクトを起動し、ビルドが完了したらSDKの導入は完了です。

モデルをプロジェクトにインポート

Cubism Editor から書き出した組み込み用モデルデータ一式を、Unreal Editor のコンテンツブラウザ上にフォルダごとドラッグ&ドロップします。

正常にインポートが完了すると、組み込み用モデルファイルがすべてUnreal Engine 用のアセットファイルuassetに変換されています。
それぞれのアセットはダブルクリックすることでUnreal Editor上で内容を確認することが可能です。

変換されたアセットのうち model3.json に対応する CubismModelJson アセットをUnreal Editor のビューポート上にドラッグ&ドロップすると、CubismModelアクタがスポーンします。