RPGツクールMV Ver.1.6.3以降
RPGツクールMZ Ver.1.3.2以降
Live2D Cubism 4.x/5.0

デプロイメント時に「未使用ファイルを含まない」を有効にすると、[img/live2d]フォルダは
出力対象外となります。デプロイメント後に手動でコピーしてください。
デプロイメント時に画像ファイル暗号化を有効にすると画像ファイルが読み込めなくなります。
暗号化していない画像ファイルをデプロイメント後に手動でコピーするか、
下記プラグインの導入をご検討ください。
[ イメージソース復号プラグイン ]

i) ダウンロードしたZipファイルを展開

ii) 同梱されている[live2dcubismcore.min.js]を[js/libs]フォルダに配置

iii) [img]フォルダに[live2d]フォルダを作成

i) Live2Dの組み込み用データを、書き出しバージョン4.0/4.2/5.0対応のいずれかで書き出し
　データ書き出しの詳細については [ Live2D Cubism / Editor マニュアル ] をご参照ください。
　（書き出し > 組み込み用データ）

ii) モデルにモーションを設定する
　モーション設定の詳細については [ Live2D Cubism / Editor マニュアル ] をご参照ください。
　（Cubism Viewer > Cubism Viewer (for OW)）

iii) 書き出したファイル（json/moc3/png）を[img/live2d]フォルダに置く
　live2dフォルダの中にサブフォルダを作り、その中に置いてもOK。

本プラグインにプラグインコマンドはありません。
説明文に記載されているコマンドはすべてスクリプトとなります。

i) [ピクチャの表示]でLive2Dを紐づけるピクチャを表示する
　画像はなくてもOK。

ii) ピクチャにLive2Dを紐づける 　[ ピクチャ5番に'Hiyori'を紐づける場合 ] 　　$gameScreen.live2d(5).setModel('Hiyori');

iii) アニメーションを表示する 　[ ピクチャ5番のLive2Dに'walk'という名前のアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, 'walk'); 　[ ピクチャ5番のLive2Dに'walk'->'run'->'jump'の順でアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump']);

以下のように記述することでコマンドを短縮することができます。

$gameScreen.live2d(5).setModel('Hiyori')

文字列の中では制御文字「\\v[n]」「\\V[n]」を使用することができます。
これらの制御文字を記述した箇所はツクールの変数n番の値に置き換わります。

[ 変数5番の値をアニメーション名として指定する場合 ] 　$gameScreen.live2d(5).setAnimation(0, '\\v[5]'); [ 変数10番の値をアニメーションの再生速度として指定する場合 ] 　$gameScreen.live2d(5).setAnimation(0, 'walk/timeScale=\\v[10]');

setAnimationコマンドで指定する「アニメーション名」は、Cubism Viewerで設定した
「グループ名」にそのグループの何番目かを示す番号を付加したものとなります。
[ Live2D Cubism / Editor マニュアル ]
　（Cubism Viewer > Cubism Viewer (for OW) > モーションの設定
グループ名が「Idle」で3つめに設定されているモーションのアニメーション名は
「Idle03」となります。（番号部分はゼロ埋めの2桁）
【任意のアニメーション名を付ける】 【モーションファイル名で指定する】

【トラック】 【ウェイト】
【タイムスケール】
【ミックス】

ピクチャにLive2Dを紐づけます。

setModel(<name>)

[ ピクチャ5番に'Hiyori'を紐づける場合 ] 　$gameScreen.live2d(5).setModel('Hiyori');

Live2Dにアニメーションを設定します。

setAnimation(<tack>, <animation>[, <continuance>, <interrupt>])
setAnimation(<tack>, <animations>[, <order>, <continuance>, <interrupt>])

a) トラック番号
　アニメーションを表示するトラックの番号を指定します。

　[ ピクチャ5番のLive2Dのトラック1番にアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(1, 'walk');
b) アニメーション名／アニメーション名リスト
　Live2Dに登録されているアニメーション名を指定します。
　複数のアニメーションを指定する場合は[]で括って記述します。

　[ ピクチャ5番のLive2Dに'walk'という名前のアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, 'walk');
　[ ピクチャ5番のLive2Dに'walk'->'run'->'jump'の順でアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump']);
c) 順序オプション
　複数アニメーション指定時の表示順序を指定します。
　

　[ 'walk'->'run'->'jump'の順でアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'sequential');
　[ 'walk'->'run'->'jump'のうちいずれか1つを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'random');
　[ 'walk'、run'、'jump'の順番を入れ替えて表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'shuffle');
d) 継続オプション
　指定したアニメーションの表示が終わったあとの動作を指定します。
　

　[ 'walk'->'run'->'jump'と表示したあと'jump'を繰り返し表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'sequential', 'continue');
　[ 'walk'->'run'->'jump'と表示したあと'walk'からもう一度表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'sequential', 'reset');
　[ 'walk'->'run'->'jump'と表示したあと'jump'の終わりの状態で停止させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, ['walk', 'run', 'jump'], 'sequential', 'none');
　 　
e) 割り込みフラグ
　現在表示しているアニメーションの終了を待つか、中断させて表示するかを指定します。
　

　[ 表示中のアニメーションを中断して指定したアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, 'walk', 'continue', true);
　[ 表示中のアニメーションの終了を待ってから指定したアニメーションを表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(0, 'walk', 'continue', false);
f) アニメーションオプション
　アニメーション名を指定する際、アニメーションごとに以下のオプションを指定できます。
　オプションは「アニメーション名/オプション名=値」の形で記述します。
　1つのアニメーションに複数のオプションを指定する場合はカンマ区切りで記述します。
　[ 'walk'を2回、'run'を3回、'jump'を1回の順で表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(1, ['walk/times=2', 'run/times=3', 'jump']);
　[ 'walk'を2倍速、'run'を1.5倍速で表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(1, ['walk/timeScale=2', 'run/timeScale=1.5', 'jump']);
　[ 'walk'のウェイト値を0.3、'run'のウェイト値を0.25で表示させる場合 ] 　　$gameScreen.live2d(5).setAnimation(1, ['walk/weight=0.3', 'run/weight=0.25', 'jump']);
　[ 表示回数、タイムスケール、ウェイト値をまとめて指定する場合 ] 　　$gameScreen.live2d(5).setAnimation(1, 'walk/times=2,timeScale=2.5,weight=0.5');
　

指定トラックのアニメーションをクリアします。

clearAnimation(<track>)
clearAnimation(<track>, <mixTime>)

[ ピクチャ5番のLive2Dのトラック1番のアニメーションをクリアする場合 ] 　$gameScreen.live2d(5).clearAnimation(1); [ ピクチャ5番のLive2Dのトラック1番のアニメーションを0.5秒かけてクリアする場合 ] 　$gameScreen.live2d(5).clearAnimation(1, 0.5);

Live2D全体のタイムスケールを設定します。

setTimeScale(<value>)

[ ピクチャ5番のLive2Dのタイムスケールを0.3に設定する場合 ] 　$gameScreen.live2d(5).setTimeScale(0.3);

トラックごとのウェイト値を設定します。

setWeight(<track>, <value>)

[ ピクチャ5番のLive2Dのトラック1番のウェイト値を0.3に設定する場合 ] 　$gameScreen.live2d(5).setWeight(1, 0.3);

アニメーション間のミックス値を設定します。

setMix(<duration>)
setMix(<animation1>, <animation2>, <duration>)

[ ピクチャ5番のLive2Dのミックス値を0.3秒に設定する場合 ] 　$gameScreen.live2d(5).setMix(0.3); [ ピクチャ5番のLive2Dの'idle'->'walk'に切り替わるときのミックス値を0.5秒に設定する場合 ] 　$gameScreen.live2d(5).setMix('idle', 'walk', 0.5);

自動まばたきを設定します。

setAutoEyeBlink(<enabled>)
setAutoEyeBlink(<enabled>, <options>)

自動まばたき詳細設定にはまばたきの各動作の時間を指定できます。

まばたき動作は以下の流れで実行されます。

[ ピクチャ5番のLive2Dの自動まばたきを有効にする場合 ] 　$gameScreen.live2d(5).setAutoEyeBlink(true); [ ピクチャ5番のLive2Dの自動まばたきを有効にする場合（詳細設定あり） ] 　$gameScreen.live2d(5).setAutoEyeBlink(true, { interval: 2 }); [ ピクチャ5番のLive2Dの自動まばたきを有効にする場合（詳細設定あり） ] 　$gameScreen.live2d(5).setAutoEyeBlink(true, { closing: 1, opening: 0.5 }); [ ピクチャ5番のLive2Dの自動まばたきを無効にする場合 ] 　$gameScreen.live2d(5).setAutoEyeBlink(false);

表情を設定します（名前指定）。

setExpression(<name>)

[ ピクチャ5番のLive2Dの表情を'smile'に設定する場合 ] 　$gameScreen.live2d(5).setExpression('smile');

表情を設定します（データ指定）。

setCustomExpression(<exp3>)

[ ピクチャ5番のLive2Dの表情を指定データの内容で設定する場合 ] 　$gameScreen.live2d(5).setCustomExpression({
　　FadeInTime: 1,
　　FadeOutTime: 1,
　　Parameters: [
　　　{
　　　　"Id": "ParamMouthOpenY",
　　　　"Value": 1,
　　　　"Blend": "Add"
　　　},
　　　{
　　　　"Id": "ParamEyeForm",
　　　　"Value": 0.54,
　　　　"Blend": "Add"
　　　}
　　]
　});

表情設定をクリアします。

clearExpression()

[ ピクチャ5番のLive2Dの表情設定をクリアする場合 ] 　$gameScreen.live2d(5).clearExpression();

アートメッシュごと、またはLive2Dモデル全体の色の割合を設定します。

setColor(<red>, <green>, <blue>, <alpha>)
setColor(<image>, <red>, <green>, <blue>, <alpha>)

[ ピクチャ5番のLive2Dモデル全体の色を赤に設定する場合 ] 　$gameScreen.live2d(5).setColor(1, 0, 0, 1); [ ピクチャ5番のLive2Dの'ArtMesh01'の色を青で半透明に設定する場合 ] 　$gameScreen.live2d(5).setColor('ArtMesh01', 0, 0, 1, 0.5);

アートメッシュごと、またはLive2Dモデル全体にモザイクを設定します。

setMosaic(<size>)
setMosaic(<image>, <size>)

[ ピクチャ5番のLive2Dモデル全体に10pxサイズのモザイクを設定する場合 ] 　$gameScreen.live2d(5).setMosaic(10); [ ピクチャ5番のLive2Dの'ArtMesh01'に15pxサイズのモザイクを設定する場合 ] 　$gameScreen.live2d(5).setMosaic('ArtMesh01', 15);

ピクチャ座標を基点とした相対座標を設定します。

setOffset(<x>, <y>)

[ ピクチャ5番のLive2D座標をピクチャのX座標+8pxに設定する場合 ] 　$gameScreen.live2d(5).setOffset(8, 0); [ ピクチャ5番のLive2D座標をピクチャのY座標-8pxに設定する場合 ] 　$gameScreen.live2d(5).setOffset(0, -8);

拡大率を設定します。

setScale(<x>, <y>)

[ ピクチャ5番のLive2Dを横方向に2.5倍に拡大する場合 ] 　$gameScreen.live2d(5).setScale(2.5, 0); [ ピクチャ5番のLive2Dを縦方向に反転する場合 ] 　$gameScreen.live2d(5).setScale(0, -1.0);

表示／非表示を設定します。

setVisible(<visible>)

[ ピクチャ5番のLive2Dを表示する場合 ] 　$gameScreen.live2d(5).setVisible(true); [ ピクチャ5番のLive2Dを非表示にする場合 ] 　$gameScreen.live2d(5).setVisible(false);

パラメータをデフォルト値にリセットします。

resetParameters()
resetParameters(<id>)
resetParameters(<id1>, <id2>, ...)

[ ピクチャ5番のLive2Dの全パラメータをリセットする場合 ] 　$gameScreen.live2d(5).resetParameters(); [ ピクチャ5番のLive2Dの'ParamAngleX'をリセットする場合 ] 　$gameScreen.live2d(5).resetParameters('ParamAngleX'); [ ピクチャ5番のLive2Dの'ParamAngleX'と'ParamAngleY'をリセットする場合 ] 　$gameScreen.live2d(5).resetParameters('ParamAngleX', 'ParamAngleY');

音声ファイルを再生し、リップシンクを開始します。

playVoice(<audio>)
playVoice(<audio>, <options>)
a) 音声ファイルのパス
　再生する音声ファイルのパスを指定します。
　audioフォルダおよびそのサブフォルダにある音声ファイルを指定できます。
　拡張子は書かないでください。

　[ ピクチャ5番のLive2Dで audio/voice/ohayou.ogg を再生する場合 ] 　　$gameScreen.live2d(5).playVoice('voice/ohayou');
　 b) オプション
　音声再生やリップシンクのオプションをJSON形式で指定します。
　各項目はいずれも省略可能です。

　


　i) 音声の音量
　　再生する音声の音量を指定します。
　　指定した値に音量オプションで設定した音量を反映したものが最終的な音量になります。
　ii) 音声のピッチ
　　再生する音声のピッチを指定します。
　　値が小さいほど低く遅く、大きいほど高く早く再生されます。
　iii) 音声の定位
　　再生する音声の定位を指定します。
　　値が小さいほど左側から聞こえ、大きいほど右側から聞こます。
　iv) リップシンクの補正倍率
　　リップシンクで口を開く際の補正倍率を指定します。
　　口の開きが小さい場合、倍率を増やすことで大きく開くようになります。

　[ 音声の音量50、ピッチ150で再生する場合 ] 　　$gameScreen.live2d(5).playVoice('voice/ohayou', { volume: 50, pitch: 150 });
　[ 音声の定位70、リップシンク補正倍率2倍で再生する場合 ] 　　$gameScreen.live2d(5).playVoice('voice/ohayou', { pan: 70, scale: 2 });

再生中の音声とリップシンクを停止します。

stopVoice()

[ ピクチャ5番のLive2Dで再生中の音声とリップシンクを停止する場合 ] 　$gameScreen.live2d(5).stopVoice();

本プラグインを通じてLive2Dを運用したい方は下記コードを参考にしてください。

let live2d = new Game_Live2D();
let sprite = new Sprite_Live2D(live2d);
this.addChild(sprite);
live2d.setModel('Hiyori').setAnimation(0, 'walk');