Live2D Cubism Editor で出力したモデルをアプリケーションで利用するためのオープンコンポーネントです。
モデルを表示、操作するための各種機能を提供します。 モデルをロードするには Cubism Core ライブラリと組み合わせて使用します。
SDKパッケージのダウンロードページをお探しの場合は、ダウンロードページにアクセスしてください。
ご使用前にライセンスをお読みください。
ご使用前にお知らせをお読みください。
本 SDK はCubism 5に対応した製品です。
Cubism 5 Editorに搭載された新機能のSDK対応については こちらをご確認ください。
過去バージョンのCubism SDKとの互換性については こちらをご確認ください。
コンポーネントは役割ごとにグループ化されており、このグループ化はフォルダー構造と名前空間の両方に反映されます。
このグループのコンポーネントとクラスは、CubismコアライブラリをTypeScriptとCocos Creatorにラップするためのレイヤーであり、./static/assets/Core
にあります。
このグループのコンポーネントとクラスは、リップシンクやCubismの組み込み用ファイルとCocos Creatorの統合などの追加機能を提供します。すべてのフレームワークコードは./static/assets/Framework
にあります。
このグループのコンポーネントとクラスは、Cocos Creatorの機能を使用してCubismモデルをレンダリングする機能を提供します。コードは、./static/assets/Rendering
にあります。
Cocos Creator Editor拡張機能は、./src
にあります。
CubismファイルをプレハブとAnimationClipに変換するのはここで行われます。
シェーダー等のアセットのリソースは、./static/assets/resources
にあります。
Cocos Creator | バージョン |
---|---|
latest | v3.7.3 |
ツール | バージョン |
---|---|
Node.js | v20.7.0 |
-
Node.js / npm を インストール します。(インストール済みの場合は不要です。)
-
Cocos Dashboard を起動し、 [Project] - [New] - [Empty(3D)] で プロジェクト を作成します。
-
Cocos Creator プロジェクトが作成できたら、Cocos Creatorからメニューバーの [Extension] - [Extension Manager] を選択してExtension Managerウィンドウを開きます。
-
Extension Manager の上部 [Project] タブを押したあとに、右の [+] ボタンをクリックして、ダウンロードしたCubism SDK for Cocos Creatorのzipファイルを選択します。
-
Extensionの項目が表示されたら、フォルダアイコンをクリックしてエクスプローラを表示します。
-
表示されたエクスプローラにある[live2d_cubismsdk_cocoscreator]フォルダを開きます。
-
本 Extension プロジェクトをビルドします。(CMD 等の console で [live2d_cubismsdk_cocoscreator]フォルダをカレントにし、下記コマンドを実行)
- npm install
- npm run build
-
Cocos Creatorを再起動し、プロジェクトを開きます。
-
Cubism モデルをインポートします。
- *.moc3
- *.physics3.json
- *.cdi3.json
- *.pose3.json
- [texture]
- [motions]
- *.model3.json
*1 現状インポート順を指定制御できず、初回インポート時にエラーが発生することがありますので、その際はCubismモデルフォルダを Reimport するか、*.model3.json を最後にインポートして下さい。
-
インポートにより *.prefab が生成されます。
-
インポートにより生成された Prefab をシーンに配置します。
詳しくは、チュートリアルの[SDK をインポート]をご確認ください。
CocosCreatorProject # Cocos Creator で作成したプロジェクト
├─ assets
├─ library
├─ settings
├─ extensions
│ ├─ live2d_cubismsdk_cocoscreator # プロジェクトの extensions ディレクトリ
│ │ ├─ src
│ │ ├─ dist # ビルド後の成果ファイル出力先
│ │ ├─ static
etc...
ご意見ご要望がございましたら、CubismCocosCreatorComponentsリポジトリのissueやPRにお寄せください。