Go to file
wada 0bcbf342eb Update to Cubism 4 SDK for Web R5 beta3 2022-06-16 11:49:01 +09:00
.vscode Update to Cubism SDK for Web R4 2021-12-09 14:13:06 +09:00
Core Update to Cubism 4 SDK for Web R5 beta2 2022-06-02 16:30:39 +09:00
Framework@55b7a9233e Update to Cubism 4 SDK for Web R5 beta3 2022-06-16 11:49:01 +09:00
Samples Update to Cubism 4 SDK for Web R5 beta3 2022-06-16 11:49:01 +09:00
.editorconfig Update to Cubism 4 SDK for Web R1 2020-01-30 18:34:38 +09:00
.gitattributes Update to Cubism 4 SDK for Web beta2 2019-11-14 21:43:08 +09:00
.gitignore Update to Cubism 4 SDK for Web R2 2021-03-09 11:36:43 +09:00
.gitmodules Update to Cubism 4 SDK for Web R1 2020-01-30 18:34:38 +09:00
CHANGELOG.md Update to Cubism 4 SDK for Web R5 beta3 2022-06-16 11:49:01 +09:00
LICENSE.md [Beta version] Update to Cubism 4 SDK for Web R3 Beta1 2021-05-13 12:08:19 +09:00
NOTICE.md Update to Cubism 4 SDK for Web R1 2020-01-30 18:34:38 +09:00
README.md Update to Cubism 4 SDK for Web R5 beta3 2022-06-16 11:49:01 +09:00

README.md

Cubism Web Samples

Live2D Cubism 4 Editor で出力したモデルを表示するアプリケーションのサンプル実装です。

Cubism Web Framework および Live2D Cubism Core と組み合わせて使用します。

ライセンス

本 SDK を使用する前に、ライセンスをご確認ください。

注意事項

本 SDK を使用する前に、注意事項をご確認ください。

ディレクトリ構成

.
├─ .vscode          # Visual Studio Code 用プロジェクト設定ディレクトリ
├─ Core             # Live2D Cubism Core が含まれるディレクトリ
├─ Framework        # レンダリングやアニメーション機能などのソースコードが含まれるディレクトリ
└─ Samples
   ├─ Resources     # モデルのファイルや画像などのリソースが含まれるディレクトリ
   └─ TypeScript    # TypeScript のサンプルプロジェクトが含まれるディレクトリ

Live2D Cubism Core for Web

モデルをロードするためのライブラリです。

当リポジトリではCubism Coreを管理していません。 こちらからCubism SDK for Webをダウンロードして、 Coreディレクトリのファイルをコピーしてください。

開発環境構築

  1. [Node.js] と [Visual Studio Code] をインストールします
  2. Visual Studio Code で 本 SDK のトップディレクトリ を開き、推奨拡張機能をインストールします
    • ポップアップ通知の他、拡張機能タブから @recommended を入力することで確認できます

サンプルデモの動作確認

コマンドパレット(View > Command Palette...)で >Tasks: Run Task を入力することで、タスク一覧が表示されます。

  1. タスク一覧から npm: install - Samples/TypeScript/Demo を選択して依存パッケージのダウンロードを行います
  2. タスク一覧から npm: build - Samples/TypeScript/Demo を選択してサンプルデモのビルドを行います
  3. タスク一覧から npm: serve - Samples/TypeScript/Demo を選択して動作確認用の簡易サーバを起動します
  4. ブラウザの URL 欄に http://localhost:5000/Samples/TypeScript/Demo/ と入力してアクセスします
  5. コマンドパレットから >Tasks: Terminate Task を入力して npm: serve を選択すると簡易サーバが終了します

その他のタスクに関してはサンプルプロジェクトの README.md を参照ください。

NOTE: デバック用の設定は、.vscode/tasks.json に記述しています。

プロジェクトのデバック

Visual Studio Code で 本 SDK のトップディレクトリ を開き、 F5 キーを入力すると Debugger for Chrome が起動します。

Visual Studio Code 上でブレイクポイントを貼って Chrome ブラウザと連動してデバックを行うことができます。

NOTE: デバック用の設定は、.vscode/launch.json に記述しています。

SDKマニュアル

Cubism SDK Manual

変更履歴

当リポジトリの変更履歴については CHANGELOG.md を参照ください。

開発環境

Node.js

  • 18.1.0
  • 17.9.0
  • 16.15.0
  • 14.19.2

動作確認環境

プラットフォーム ブラウザ バージョン
Android Google Chrome 102.0.5005.115
Android Microsoft Edge 101.0.1210.47
Android Mozilla Firefox 100.1.2
iOS / iPadOS Google Chrome 101.0.4951.58
iOS / iPadOS Microsoft Edge 101.1210.47
iOS / iPadOS Mozilla Firefox 100.1
iOS / iPadOS Safari 604.1
macOS Google Chrome 101.0.4951.64
macOS Microsoft Edge 101.0.1210.47
macOS Mozilla Firefox 100.0.1
macOS Safari 15.5
Windows Google Chrome 102.0.5005.115
Windows Microsoft Edge 101.0.1210.47
Windows Mozilla Firefox 100.0

Note: 動作確認時のサーバの起動は ./Samples/TypeScript/Demo/package.jsonserve スクリプトを使用して行っています。

コミュニティ

ユーザー同士でCubism SDKの活用方法の提案や質問をしたい場合は、是非コミュニティをご活用ください。