サブキャラ

サブキャラ はVMagicMirror v4.0.0で追加された機能です。

この機能では通常表示している3Dモデルのアバターとは別のキャラクターを表示できます。

以下ではサブキャラとの区別がしやすいように、通常表示する3Dモデルのアバターを メインアバター と呼んでいます。

サブキャラ機能のおもな特徴は以下の通りです。

NOTE

v4.0.0の時点では未対応ですが、今後のアップデートで3Dデータ(VRM, glb)の表示サポートを予定しています。

無償で配布している基本エディションでは、サブキャラがメインアバターやユーザー動作に反応するための機能である インタラクションAPI をオンにすると専用のエフェクトが適用されます。この機能をオフにしていてもサブキャラは起動できますが、サブキャラの動作が制限されます。以下は制限される動作の例です。

上記の制限を外して利用するにはフルエディションをお求め下さい。フルエディションの詳細はダウンロードのページで詳しく紹介しています。

サブキャラを使用するには、サブキャラ タブで起動したいサブキャラのチェックをオンにします。 v4.0.0以降でインストール時から表示されているサブキャラは、アプリケーションにデフォルトとして組み込まれているサブキャラです。

サブキャラの配置は フリーレイアウト をオンにして編集できます。ただし、最前面に表示したサブキャラの位置が画面端や画面外になっている場合、フリーレイアウト機能では配置を変更できないことがあります。

この場合はサブキャラの詳細設定を開き、サブキャラの位置の(x や y の値)を直接編集します。

画像ベースで最前面に表示されるサブキャラの位置は、アバターウィンドウのサイズをおおよそ 1280 x 720 としたときの座標で指定します。画面の左下が (x, y) = (0, 0)として扱われます。

サブキャラ全般に対して適用できる設定や機能は以下の通りです。

インタラクションAPIを使用: オンにすることで、サブキャラがメインアバターの動作やユーザー入力に反応できるようになります。このチェックはフルエディションでは既定でオン、基本エディションではオフになっています。
フォルダを開く: 後述の 配布されているサブキャラを使用する を行うときの配置先となるフォルダを開きます。
全て再読み込み: 全てのサブキャラを再読み込みします。VMagicMirrorの実行中に 配布されているサブキャラを使用する の操作を行った場合、その結果を適用するときに使用します。
開発者モード: サブキャラの自作時にオンにします。詳細は開発者向けドキュメントのページを参照して下さい。

そのほかの設定は基本的にはサブキャラごとに固有に定義された設定項目です。それぞれのサブキャラの説明がある場合はそれを適宜確認してください。

サブキャラがzipファイル等で配布されている場合、以下の手順で使用できます。

フォルダを配置するときは、フォルダ構造が以下の形になるようにします。とくに、zipファイルの解凍時にフォルダが二重になっている場合は二重のフォルダをそのまま配置しないように注意してください。

(マイドキュメント)\VMagicMirror_Files\Buddy\{フォルダ}\
- main.csx
- manifest.json
- …

また、サブキャラを導入した後はサブキャラのフォルダ名はそのままにするようにしてください。フォルダ名を変更した場合、そのサブキャラの設定はリセットされます。

サブキャラの自作や配布を検討している場合、VMagicMirrorのサブキャラ開発に関するドキュメントページを参照して下さい。

上記のページではほぼ空のサブキャラのテンプレートやスクリプトAPIの一覧などを紹介しています。

NOTE

v4.0.0の公開時点で、サブキャラのスクリプトを自作するには高度なプログラミングの知識や調査が必要になる想定です。

スクリプトの自作を必要としない高度なテンプレートの追加については、本ページ、上記のドキュメントのページ、BOOTH等での配布を予定しています。

サブキャラがテンプレートの形式で配布されている場合、スクリプト等はとくに編集せず、画像ファイルを準備するだけでサブキャラをセットアップすることもできます。

下記のテンプレートを用いると、VMagicMirror v4.0.0のデフォルトのサブキャラとほぼ同じ仕草になるようなサブキャラが制作できます。