Logo: by @otama_jacksy
v3.9.0
- 作成: 獏星(ばくすたー)
- 2024/11/30
WindowsでVRMを表示し、追加のデバイスなしで動かせるアプリケーションです。
- できること
- ダウンロード
- 質問など
- (開発者向け)ビルド手順
- OSS等のライセンス
- ローカリゼーションについて
- VRMを読み込み、キャラクターの上半身を表示します。
- キーボードとマウス操作をモーションとして反映します。
- 可変のクロマキーが適用できます。
キーボードとマウス操作のみでキャラクターが動く特徴から、以下のシチュエーションで活躍します。
- 機材の準備が面倒な時の配信
- ライブコーディング中の賑やかし
- デスクトップマスコット
Boothから取得可能です。
Windows 10/11環境でお使いいただけます。
操作方法についてはマニュアルをご覧下さい。
適当なフォルダに本レポジトリを配置します。配置先について、空白文字を含むようなフォルダパスは避けて下さい。
Unity 2022.3系でUnityプロジェクト(本レポジトリのVMagicMirrorフォルダ)を開き、Visual Studio 2022でWPFプロジェクトを開きます。
メンテナの開発環境は以下の通りです。
- Unity 2022.3.7f1 Personal
- Visual Studio Community 2022 (17.4.4)
- 「.NET Desktop」コンポーネントがインストール済みであること
- 「C++によるデスクトップ開発」コンポーネントがインストール済みであること
- UnityのBurstコンパイラ向けに必要なセットアップです。
- FinalIK
- Dlib FaceLandmark Detector
- OpenCV for Unity
- Oculus LipSync Unity Integration v29
- VRMLoaderUI v0.3
- Zenject (アセットストアから)
- SharpDX.DirectInput 4.2.0
- RawInput.Sharp 0.0.3
- uWindowCapture v1.0.2
- DOTween (アセットストアから)
- Fly,Baby. ver1.2
- LaserLightShader
- VMagicMirror_MotionExporter
- NuGetForUnity
FinalIK, Dlib FaceLandmark Detector, OpenCV for Unityの3つは有償アセットであることに注意してください。
NuGetForUnityはNAudioを導入するために使用しています。
"Fly,Baby." および "LaserLightShader"はBOOTHで販売されているアセットで、ビルドに必須ではありませんが、もし導入しない場合、タイピング演出が一部動かなくなります。
Dlib FaceLandmark Detectorについては、アセットに含まれるデータセットをStreamingAssetsフォルダ以下に移動します。導入にあたっては、Dlib FaceLandmark Detector本体のサンプルプロジェクト(WebCamTextureExample)を動かすなどして、ファイルが正しく置けているか確認します。
SharpDXは次の手順で導入します。
- 2つのNuGetギャラリーの
Download packageから.nupkgファイルを取得し、それぞれ.zipファイルとして展開します。 - 展開したzip内の
lib/netstandard1.3/フォルダにそれぞれSharpDX.dllおよびSharpDX.DirectInput.dllがあるので、これらをUnityプロジェクト上の適当な場所に追加します。
RawInput.Sharpもほぼ同様の導入手順です。
- NuGetギャラリーから取得した
.nupkgを展開し、中のlib/netstandard1.1/RawInput.Sharp.dllを取得します。 - 取得したDLLを、Unityプロジェクト上でAssets以下に
RawInputSharpというフォルダを作り、その下に追加します。
OpenCVforUnityについては導入後、DisposableOpenCVObject.csを次のように書き換えます。
abstract public class DisposableOpenCVObject : DisposableObject
{
// internal IntPtr nativeObj;
//Change to public member
public IntPtr nativeObj;
以上のほか、手作業での導入は不要ですが、Unity Package Managerで下記を参照しています。
特に初回にプロジェクトを開くとコンパイルエラーになります。これを解決するにはNuGetForUnityの導入後にNAudioLipSyncContext.cs冒頭の#defineのコメントアウトを解除し、一時的にコンパイルエラーを抑制します。
するとNAudioがNuGetから取得できます。取得後、#defineの行をコメントアウトすることで、リップシンクが有効な状態になります。
//下記を一旦コメントアウト解除したのち、ふたたびコメントアウトする
#define TEMP_SUPPRESS_ERROR
Batchesフォルダ内のコマンドからビルドが可能です。
バッチファイル等の引数の指定方法については、ファイル内のコメントを参照して下さい。
Unityについては諸々のアセットを導入済みであることが必要なこと、およびビルドに用いるUnityバージョンがbuild_unity.cmdで指定されていることに注意して下さい。
事情があって異なるバージョンのUnityエディタをビルドに用いる場合、build_unity.cmd内のUnityのパスを修正します。
また、create_installer.cmdを使用するにはInno Setupのインストールが必要です。
# WPFプロジェクトをビルド
build_wpf.cmd standard dev
# Unityプロジェクトをビルド
build_unity.cmd standard dev
# WPF/Unityプロジェクトをビルド後に呼ぶことでインストーラを作成
create_installer.cmd standard dev v1.2.3
# version.txtに書いてあるバージョン値を用いて、ビルドおよびインストーラの作成までを実行
job_release_instraller.cmd
Binなど、出力先フォルダを準備します。以下はフォルダ名がBinである想定での説明ですが、他のフォルダ名でも構いません。
- Unityでのビルド時には
Binフォルダを指定します。 - WPFでのビルドでは、
VMagicMirrorConfigプロジェクトを右クリックし、発行を指定してフォルダ上にアプリケーションを配置します。- プロファイル設定は次のようにします。
- 構成:
Release | x86 - ターゲットフレームワーク:
netcoreapp3.0 - 配置モード:
自己完結 - ターゲットランタイム:
win10-x86 - ターゲットの場所: PC上の適当なフォルダ
- 構成:
- 上記の設定で発行すると、ターゲットのフォルダ上に
VMagicMirror.exeを含むファイル群が出力されます。これらのファイルをBin/ConfigApp/以下にコピーします。
- プロファイル設定は次のようにします。
フォルダ構成を確認したい場合、実際に配布されているVMagicMirrorも参考にしてください。
GUI中でOSSライセンスを掲載しており、その文面は下記ファイルで管理しています。
過去に使用したものも含むライセンス情報は以下に記載しています。
https://malaybaku.github.io/VMagicMirror/credit_license
また、本レポジトリに含む画像の一部は Otomanopee フォントを使って作成しています。フォント自体を再配布するものではないため、あくまで補足情報として記載しています。
このレポジトリに含まれる下記モデルはCreative Commons Attributionライセンスに基づいて使用し、レポジトリに含まれます。
Gamepad.fbx(作成者: Negyek)CarSteering.glb(作成者: CaskeThis)
VMagicMirrorでは元モデルに対し、他のデバイスとの一貫性を保つためにマテリアルを適用しているほか、カスタマイズのためにテクスチャを変更可能にしています。
日本語、英語以外のローカリゼーションでのContributionに興味がある場合、about_localization.mdを参照して下さい。