Live2D Cubism 4 Editor で出力したモデルをアプリケーションで利用するためのフレームワークです。
モデルを表示、操作するための各種機能を提供します。 モデルをロードするには Live2D Cubism Core ライブラリと組み合わせて使用します。
ビルドを行うことで、ブラウザで利用可能な JavaScript ライブラリとして利用することができます。
本 SDK を使用する前に、ライセンスをご確認ください。
- 17.2.0
- 16.13.1
- 14.18.2
- 12.22.7
4.5.2
- [Node.js] と [Visual Studio Code] をインストールします
- Visual Studio Code で本プロジェクトを開き、推奨拡張機能をインストールします
- 拡張機能タブから
@recommended
と入力することで確認できます
- 拡張機能タブから
- コマンドパレット(View > Command Palette...)で
>Tasks: Run Task
を入力してタスク一覧を表示します npm: install
を選択して依存パッケージのダウンロードを行います
コマンドパレットのタスク一覧から各種コマンドを実行することができます。
NOTE: デバック用の設定は、.vscode/tasks.json
に記述しています。
ソースファイルのビルドを行い、dist
ディレクトリに出力します。
tsconfig.json
を編集することで設定内容を変更できます。
TypeScript の型チェックテストを行います。
tsconfig.json
を編集することで設定内容を変更できます。
src
ディレクトリ内の TypeScript ファイルの静的解析を行います。
.eslintrc.yml
を編集することで設定内容を変更できます。
src
ディレクトリ内の TypeScript ファイルの静的解析及び自動修正を行います。
.eslintrc.yml
を編集することで設定内容を変更できます。
ビルド成果物ディレクトリ(dist
)を削除します。
自動まばたきやリップシンクなど、モデルに対してモーション情報をエフェクト的に付加する機能を提供します。
モデルに設定されたパラメータ名・パーツ名・Drawable名を独自の型で管理する機能を提供します。
行列計算やベクトル計算など、モデルの操作や描画に必要な算術演算の機能を提供します。
モデルを取り扱うための各種機能(生成、更新、破棄)を提供します。
モデルにモーションデータを適用するための各種機能(モーション再生、パラメータブレンド)を提供します。
モデルに物理演算による変形操作を適用するための機能を提供します。
モデルを描画するためのグラフィックス命令を実装したレンダラを提供します。
フレームワーク内で使用する型定義を提供します。
JSONパーサーやログ出力などのユーティリティ機能を提供します。
当リポジトリには Cubism Core for Web は同梱されていません。
Cubism SDK for Web からダウンロードしてください。
標準的なアプリケーションの実装例は CubismWebSamples を参照ください。
当リポジトリの変更履歴については CHANGELOG.md を参照ください。
ユーザー同士でCubism SDKの活用方法の提案や質問をしたい場合は、是非コミュニティをご活用ください。