Live2D Cubism Editor 5.1 alpha2

外部アプリケーション連携

開発者向けマニュアル

バージョン

改訂日

改訂内容

r2

2024/04/11

alpha2向けに更新しました。

・「データ形式」の表を一部修正しました。

・「外部連携API一覧」内の「命令」の項目にて、アニメーションファイルのモデルの連携について追記しました。

・制限事項のアニメーションに関して連携可能になったため、該当箇所を削除しました。

r1

2024/03/28

初版作成

通信規格

WebSocket

フォーマット

JSON（UTF-8 テキスト）

ポート

22033 ※デフォルトのポート番号。 任意に変更可能。

Token ?: String,

{

    "Version": "1.0.0",

    "Timestamp": 1696233943287,

    "RequestId": "13",

    "Type": "Request",

    "Method": "GetCurrentModelUID",

    "Data": {}

}

要素

タイプ

要求

説明

Version

String

任意

API、命令のバージョンを指定します。

やりとりするバージョンを固定でき、互換性を維持することができます。未対応バージョンを設定した場合はエラーとなります。省略可能※1。

Timestamp

Number

任意

エポックミリ秒。省略可能。

RequestId

String

任意

サーバーからのレスポンス時に送信で送ったIDを返します。省略した場合、サーバーレスポンスでも省略されます。

Type

String

必須

APIタイプ。

Method

String

必須

命令。

Data

Any

必須

操作に応じた追加データ。
Data{}（引数に相当）の中身は命令により異なります。

タイプ

説明

Request

要求：

主にクライアント（外部アプリケーション）からサーバー（Editor）に命令を送る際に設定されます。

Response

応答： 

主にサーバーがクライアントからの命令に答える際に設定されます。

Event

イベント： 

主にサーバーが任意のタイミング（クライアントからRequestが無い状態）で、自発的にクライアントへ応答する際に設定されます。

Error

エラー：

Requestに不正があった場合、この値が設定されたAPIをクライアントへ返します。

{

    (省略)

    "Type": "Error",

    "Method": "SetParameterValues",

    "Data": {

        "ErrorType" : "InvalidParameter"

    }

}

{

    "Data": {

        "ModelUID" : "8456858123561231456" // UID

    }

}

{

    "Data": {

        "Parameters" : [{"Id":"ParamAngleY","Value":"0.0"}] // ParameterID

    }

}

Version

Request

Response

ErrorType

0.9.0

Name:String,

Token?:String,

Icon?:String,

Path?:String

Token:String

InvalidData

Name:String

アプリケーション名。（任意）

ユニークな名前を付けてください。

他のアプリと名前が被っても動作に影響はありません。

Token?:String

トークン。
省略、または未登録のトークンの場合は、RegisterPluginは新しいトークンを返します。

指定されたトークンが登録済みの場合は、そのトークンをそのまま返します。

Icon?:String

アイコンPNG画像のBASE64文字列。

現在は指定してもエディタに表示されません。

Path?:String

アプリケーションのパス情報。

注意事項

RegisterPluginを最初に行い、ユーザーから許可を貰わない限り、以下のほぼすべての命令はPluginNotRegisteredのエラーを返し、APIによる操作を受け付けません。

Version

Request

Response

ErrorType

0.9.0

Result:Boolean

InvalidData

Version

Request

Response

ErrorType

0.9.0

ModelUID:string,

Ids?:Array<string>

Parameters:Array<{

  Id:String,

  Value:Number

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.1

ModelUID:string,

Ids?:Array<string>

Parameters:Array<{

  Id:String,

  Value:Number

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.0

ModelUID:String,

Parameters:Array<{

  Id:String,

  Value:Number

}>

InvalidData

InvalidModel

InvalidParameter

Version

Request

Response

ErrorType

0.9.1

ModelUID:String,

Parameters:Array<{

  Id:String,

  Value:Number

}>

InvalidData

InvalidModel

InvalidParameter

Id:String

パラメータID。

Name:String

パラメータ名。

GroupUID:String

所属するパラメータグループのUID。

Default:Number

デフォルト値。

Max,Max:Number

最大値、最小値。

Repeat:boolean

リピート。

Type:Number

パラメータタイプ。
0 : 通常

1 : ブレンドシェイプ

Version

Request

Response

ErrorType

0.9.0

ModelUID?:String, DocumentUID?:String

Parameters:Array<{

  Id:String,

  Name:String,

  GroupUID:String,

  Default:Number,

  Max:Number,

  Min:Number,

  Repeat:boolean

  Type:Number

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.1

ModelUID?:String, DocumentUID?:String

Parameters:Array<{

  Id:String,

  Name:String,

  GroupUID:String,

  Default:Number,

  Max:Number,

  Min:Number,

  Repeat:boolean

  Type:Number

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.0

ModelUID?:String, DocumentUID?:String

Groups:Array<{

  GroupUID:String,

  GroupName:String,

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.1

ModelUID?:String, DocumentUID?:String

Groups:Array<{

  GroupUID:String,

  GroupName:String,

}>

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.0

PhysicsDocuments:Array<{

  DocumentUID:String,

  DocumentFilePath:String,

  ModelUID:String

}>,

ModelingDocuments:Array<{

  DocumentUID:String,

  DocumentFilePath:String,

  Views:Array<{

    ModelUID:String

   }>

}>

InvalidData

InvalidDocument

Version

Request

Response

ErrorType

0.9.1

PhysicsDocuments : Array<{

  DocumentUID : String,

  DocumentFilePath : String

  ModelUID : String,

}>

ModelingDocuments : Array<{

  DocumentUID : String,

  DocumentFilePath : String

  Views : Array<{

    ModelUID : String

  }>

}>

AnimationDocuments : Array<{

  DocumentUID : String,

  DocumentFilePath : String

  Views : Array<{

    ModelUID : String,

    ModelFilePath : String

  }>

}>

InvalidData

InvalidDocument

Version

Request

Response

ErrorType

0.9.0

ModelUID:String

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.1

ModelUID:String

InvalidData

InvalidModel

Version

Request

Response

ErrorType

0.9.0

EditMode:String

InvalidData

EditMode:String

編集モード。
“Physics” : 物理演算設定エディタ
“Modeling” : モデル編集

“Animation” : アニメーション編集

“ModelingMeshEdit” : メッシュ編集

Version

Request

Response

ErrorType

0.9.1

Version ?: String

InvalidData

Version

Request

Response

ErrorType

0.9.1

ModelUID : String

InvalidData

{

    (省略)

    "Type": "Request",

    "Method": "NotifyMocFileExported",

    "Data": {

        "Enable" : true

    }

}

{

    (省略)

    "Type": "Response",

    "Method": "NotifyMocFileExported",

    "Data": {

        "Path" : "c:\\temp\\export.moc3",

        "ModelFilePath" : "c:\\models\\hoge03.cmo3"

    }

}

Version

Request

Response

Event

ErrorType

0.9.0

Enabled:Boolean

Accepted:Boolean

Path:String,

ModelFilePath:String

InvalidData

Version

Request

Response

Event

ErrorType

0.9.0

Enabled:Boolean

Accepted:Boolean

Path:String,

ModelFilePath:String

InvalidData

Version

Request

Response

Event

ErrorType

0.9.0

Enabled:Boolean

Accepted:Boolean

Path:String,

ModelFilePath:String

InvalidData

Version

Request

Response

Event

ErrorType

0.9.0

Enabled:Boolean

Accepted:Boolean

Path:String,

ModelFilePath:String

InvalidData

Version

Request

Response

Event

ErrorType

0.9.0

Enabled:Boolean

Accepted:Boolean

EditMode:String

InvalidData

名前

説明

Since

InvalidJson

JSON構造が正しくありません。

0.9.0

UnsupportedVersion

互換性のないバージョンです。

0.9.0

MethodNotFound

指定された命令が見つかりません。

0.9.0

InvalidType

Typeの設定が不正です。

0.9.0

InvalidData

命令の引数が正しくありません。
引数が足りなかったり、引数に異なる型を指定した場合にこのエラーを返します。

0.9.0

PluginNotRegistered

プラグインの登録が完了していません。
プラグインの登録（RegisterPlugin）、ユーザーによる許可が完了していない状態で、命令をリクエストするとこのエラーを返します。

0.9.0

InvalidParameter

指定されたLive2Dパラメータが存在しません。

0.9.0

InvalidModel

指定されたLive2Dモデルが存在しません。

0.9.0

InvalidDocument

指定されたドキュメントがエディタに存在しません。

0.9.0

InvalidView

指定されたビューが存在しません。

0.9.0