English Readme

Logo: by @otama_jacksy

v1.8.2

• 作成: 獏星(ばくすたー)
• 2021/08/28

WindowsでVRMを表示し、追加のデバイスなしで動かせるアプリケーションです。

1. できること
2. ダウンロード
3. 質問など
4. (開発者向け)ビルド手順
5. OSS等のライセンス
6. ローカリゼーションについて

1. できること

• VRMを読み込み、キャラクターの上半身を表示します。
• キーボードとマウス操作をモーションとして反映します。
• 可変のクロマキーが適用できます。

キーボードとマウス操作のみでキャラクターが動く特徴から、以下のシチュエーションで活躍します。

• 機材の準備が面倒な時の配信
• ライブコーディング中の賑やかし
• デスクトップマスコット

2. ダウンロード

Boothから取得可能です。

Windows 10環境でお使いいただけます。

操作方法についてはマニュアルをご覧下さい。

3. 質問など

• Twitter
• Blog

4. (開発者向け)ビルド手順

4.1. フォルダ配置

適当なフォルダ以下に、次の構成で配置します。

• Bin

  • (空のディレクトリ)

• Unity

  • このレポジトリ

• WPF

  • WPFのレポジトリ

Unity 2019.4系でUnityプロジェクトを開き、Visual Studio 2019でWPFプロジェクトを開きます。

メンテナの開発環境は以下の通りです。

• Unity 2020.3.8f1 Personal
• Visual Studio Community 2019 16.10.3
  • .NET Core 3.1 SDKがインストール済みであること
  • Visual Studioのコンポーネントで「C++によるデスクトップ開発」をインストール済みであること
    • UnityのBurstコンパイラ向けに必要なセットアップです。

4.2. アセットの導入

• FinalIK
• Dlib FaceLandmark Detector
• OpenCV for Unity
• OVRLipSync v1.28.0
• VRMLoaderUI v0.3
• Zenject (アセットストアから)
• SharpDX.DirectInput 4.2.0
  • SharpDX
  • SharpDX.DirectInput
• RawInput.Sharp 0.0.3
• DOTween (アセットストアから)
• Fly,Baby. ver1.2
• LaserLightShader
• VMagicMirror_MotionExporter

FinalIK, Dlib FaceLandmark Detector, OpenCV for Unityの3つは有償アセットであることに注意してください。

"Fly,Baby." および "LaserLightShader"はBOOTHで販売されているアセットで、ビルドに必須ではありませんが、もし導入しない場合、タイピング演出が一部動かなくなります。

Dlib FaceLandmark Detectorについては、アセットに含まれるデータセットを

StreamingAssets

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で下記を参照しています。

• UniVRM v0.66.0
• UniRx
• MidiJack
  • オリジナルのMidiJackではなく、Forkレポジトリです。

4.3. ビルド

• Unityでのビルド時には

  Bin

  フォルダを指定します。
• WPFでのビルドでは、

  VMagicMirrorConfig

  プロジェクトを右クリックし、

  発行

  を指定してフォルダ上にアプリケーションを配置します。
  • プロファイル設定は次のようにします。
    • 構成:

      Release | x86

    • ターゲットフレームワーク:

      netcoreapp3.0

    • 配置モード:

      自己完結

    • ターゲットランタイム:

      win10-x86

    • ターゲットの場所: PC上の適当なフォルダ
  • 上記の設定で発行すると、ターゲットのフォルダ上に

    VMagicMirror.exe

    を含むファイル群が出力されます。これらのファイルを

    Bin/ConfigApp/

    以下にコピーします。

フォルダ構成については配布されているVMagicMirrorも参考にしてください。

5. OSS等のライセンス

5.1. OSSライセンス

設定UIであるWPFプロジェクト内でOSSライセンスを掲載しています。

https://github.com/malaybaku/VMagicMirrorConfig

プレーンテキストとしては下記を参照下さい。

https://github.com/malaybaku/VMagicMirrorConfig/blob/master/VMagicMirrorConfig/VMagicMirrorConfig/Resources/LicenseTextResource.xaml

5.2. ゲームパッドモデルについて

このレポジトリに含まれる

Gamepad.fbx

作成者: Negyek

VMagicMirrorでは元モデルに対し、他のデバイスとの一貫性を保つためにマテリアルを適用しているほか、カスタマイズのためにテクスチャを変更可能にしています。

6. ローカリゼーションについて

日本語、英語以外のローカリゼーションでのContributionに興味がある場合、about_localization.mdを参照して下さい。