旧バージョンのプロジェクトをCubism 5 SDKへ移行
最終更新： 2023年8月17日
このページにはベータ版に関する記述が含まれます。
概要
このページでは Cubism 5 SDK 公開にあたり、旧バージョンから移行する際のメリットやデメリット、簡単なフローイメージをご案内します。
説明に先んじて、Cubism 5 SDK 公開以降のCubism 4.2 SDK や Cubism 4 SDK 、 Cubism 3 SDK 、 Cubism 2.1 SDK の取扱は以下の通りとなります。
- 新規ダウンロードが停止され今後更新は行われない
- 今後新機能対応はなし
- 不具合は個別を対象として、不具合報告があった場合のみ修正が行われる
3 SDK、4 SDK、4.2 SDK から 5 SDKに移行する
Cubism 3 SDK 、 Cubism 4 SDK 、 Cubism 4.2 SDK をご利用のユーザーが Cubism 5 SDKに移行する際、以下のようなメリット、デメリットが挙げられます。
メリット
- 新機能が使える(マスクの反転) ※コマ打ち機能、拡張補間についてはCubism 3 、Cubism 4 、Cubism 4.2 相当で書き出した組み込み用データでもご利用できます。
- Cubism 3 Editor 、 Cubism 4 Editor 、 Cubism 4.2 Editor で作ったモデルがそのまま使えます。(後方互換)
デメリット
- ブレンドシェイプ機能の拡張にともない、Cubism Coreによる処理速度がCubism 4.2よりごくわずかに低下します。
- FrameworkのRenderingは大規模なリファクタリングを行ったため、Cubism SDKをカスタマイズして使用している場合は注意が必要です。
フローイメージ
Cubism 5 SDKの構造は基本的にCubism 3 SDKから変更がありません。SDK移行時は差し替えの後、必要な場合は再ビルドでご利用できます。
SDK移行時サンプルコードをそのまま使用して動作を確認する場合、サンプルコードで使用しているサードパーティ製ライブラリの更新やディレクトリ構造が変更されていることがあります。
詳細は、Cubism 5 SDK 各プラットフォームのREADMEとCHANGELOGを参照してください。
2.1 SDK から 5 SDK に移行する
Cubism 2.1 SDK をご利用のユーザーが Cubism 5 SDKに移行する際、以下のようなメリット、デメリットが挙げられます。
メリット
- SDKソースの公開範囲の拡大によるメンテナンス性の向上。
- 2.1に実装されていない機能が多数実装されているため、更にリッチな表現が可能になります。
- Core以外の部分がオープンソースとなっているため、レンダラ部分を含むほぼ全てのカスタマイズが自由に行えます。
※この場合、Live2D Opensoftware Licenseへの承諾が必要となりますのでご注意ください。
デメリット
- 移行のコストが高くなります。
- SDK一式を取り替える必要があります。
- モデルの組込み用データを最新の形式に書き出し直す必要があります。
モデルによっては、組込み用データを書き出し直す前に修正する作業が発生する場合があります。内容についてはフローイメージにて列挙いたします。
フローイメージ
Cubism 2.1 SDK から Cubism 5 SDK に移行する際は、必ずCubism 5 Editorで.cmoxや.canxを読み込み、Cubism 5 SDK 組込み用データに書き出してください。
また、SDKやモデルデータの差し替え以外にも形状や動作を互換させる作業が発生する場合があります。
以下は考えられる作業内容と対応方法についてご説明します。
移行したモデルの変形・描画結果が異なる場合
モデルの調整が必要となります。
Cubism 5 Editorで移行予定の.cmoxを読み込み、変形結果を調整してください。
調整が完了しましたら、.moc3ファイルを書き出し、Cubism 5 SDKを搭載した実機にて表示の確認をお願いします。
Cubism 2.1 SDKでご利用になられたmtnファイル(モーションファイル)について
Cubism 5 SDKは.mtnには対応しておりません。 しかし、Cubism 5 Editorは.canxファイルを読み込むことができるため、読み込ませた.canxをmotion3.jsonに書き出すことで対応が可能です。
但し、モーションのカーブは完全に再現できずタイムライン上の値の変化は近似値でカーブを作るような処理をおこなっております。
物理演算の対応について
Cubism 2.1 でご利用になられた物理演算をCubism 5 SDKでそのまま使用することはできません。
Cubism 2.1 作成物理演算を使用しているモデルについては、Editor上で再度物理演算の設定をお願いします。
パラメータのIDについて
Cubism SDKで指定する呼吸や視線追従などで指定するパラメータのIDは、Cubism 5の仕様に変更されております。
Cubism 2.1でご利用になられたモデルを移行する際、書き出し時にCubism 5の仕様にあわせて変換してください。