VR169 Companion

アセット連動アプリケーション『VR169 Companion』の導入、設定、および使用方法について解説します。

概要

『VR169 Companion』は、通常のアバターギミック単体では制御できないVRChatのシステム機能との連携を実現する、Windows専用の連動アプリケーションです。インストーラーによるシステムへの書き込みやレジストリの変更、管理者権限を要求しない設計となっており、VRChatとOSCプロトコルを介してローカル通信を行い、公式のカメラパラメーターやアセット専用の制御シグナルを同期します。

主な機能

VR169とVRChat標準カメラの連携起動・終了VRChat標準カメラの起動を検知してアバター側のアセットを自動的に展開し、VRChat標準カメラの終了を検知してアセットを自動的に終了させます。※アセット側の操作からVRChat標準カメラを直接起動または終了させることはできません。VR169からのカメラシャッター制御アバター側のハンドジェスチャー操作またはExpressionメニューの操作を検知し、VRChat標準カメラに撮影させます。他のOSC通信アプリケーションとの共存送信アドレスなどをカスタマイズできるため、OSC通信を行う他の外部アプリケーションと干渉することなく並行して運用が可能です。

動作仕様と制限

本アプリケーションはVRChatとの間でローカルネットワーク通信を行います。PC環境によっては、正常に連動機能が動作しない場合があります。

初期化プロセスによるカメラ自動終了本アプリケーションがアバター側のVR169を認識した際、VRChat標準カメラが開いている場合は自動的に閉じます。
起動直後のガード時間アセットが起動した直後の約２秒間は、誤動作や多重送信を防止するため、シャッター入力を受け付けません。
撮影連続送信の制限VRChatの仕様に基づき、連続した撮影指示の送信には約1秒の間隔が必要です。
通信環境による影響PCの通信高負荷やパケット損失が発生した場合、極稀に連動データの遅延や瞬断が発生することがあります。
ログ履歴の上限アプリケーション内のログ表示領域に保持される履歴は、最大1000件に制限されています。
タイマー撮影極稀にタイマーがキャンセルされる場合があります。現在の仕様です。

導入方法

配置手順

アセットパッケージに同梱されている VR169_Companion_x.x.x フォルダを、フォルダごと任意のローカルフォルダへ配置してください。フォルダ内にある VR169 Companion.exe がアプリケーション本体となります。※管理者権限による保護が有効なフォルダ（例：C:\Program Files）に配置した場合、設定ファイルの書き込みに失敗することがあります。ユーザーフォルダなどの権限が開放されたディレクトリへの配置を推奨します。

セキュリティプロテクトの解除

インターネットからダウンロードした実行可能プログラムは、Windowsの保護機能やセキュリティ対策ソフトウェアによって起動を制限されたり、隔離・消去されたりする場合があります。必要に応じて以下の解除手順を実施してください。

プロパティにおけるブロック解除

アプリケーションファイル（VR169 Companion.exe）を右クリックし、『プロパティ』を選択します。
『全般』タブの最下部にあるセキュリティ項目を確認します。
『許可する』（または『ブロックの解除』）にチェックを入れます。
『適用』をクリックした後、『OK』を選択してウィンドウを閉じます。

Windows SmartScreenの警告が表示された場合『Windows によって PC が保護されました』という青色の警告画面が表示された場合は、以下の操作を行います。

警告文内の『詳細情報』と書かれたテキストリンクをクリックします。
新たに表示される『実行』ボタンをクリックします。これによって起動保護が解除されます。この操作は初回起動時のみ必要です。

セキュリティ対策ソフトウェアによる自動削除が発生した場合プログラムが誤認により自動隔離または削除された場合は、以下の手順でファイルを復旧してください。

Windows Defender（標準セキュリティ機能）の場合 1. タスクバーのセキュリティアイコンから『Windows セキュリティ』を起動します。2. 『ウイルスと脅威の防止』 ➜ 『保護の履歴』の順に選択します。3. 隔離された項目から本アプリを選択し、復元処理を実行します。4. 今後の誤検知を防ぐため、ファイルを配置したフォルダをスキャンの除外対象に設定してください。
サードパーティ製セキュリティソフトの場合各ソフトウェアの検知履歴から該当ファイルを隔離対象から除外し、信頼されたアプリケーションとして登録を行ってください。

設定と操作

本アプリケーションの各種設定は、Windowsがユーザーごとに用意しているファイル保存領域『AppDataフォルダ』の中に、config.json という設定ファイルとして自動的に作成・保存されます。これにより、PCの大切なシステム情報に不要な変更を加えたり、セキュリティ上のトラブルを引き起こしたりすることなく設定を維持することができます。

設定

複数のOSCアプリを使う場合はOSCルーターの使用を推奨します。『停止』中のみ変更可能です。

受信設定

受信ポート: VRChatやアセット側から送信されるデータを受け取るためのポート番号（初期値: 9001）を設定します。

送信設定

送信先IP / 送信先ポート: VRChatへパケットを送り出す宛先（初期値: 127.0.0.1 / 9000）を設定します。通常は変更する必要はありません。

転送設定

同一のPC上でポート『9001』を利用する他のOSCアプリケーションと並行稼働させる際に、データを本アプリケーション経由でバックグラウンド中継するための機能です。※中継データの整合性を担保するため、転送先IPは同一PCのローカルホスト（127.0.0.1）または十分に信頼できる家庭内ネットワークなどの閉じた接続環境でのみ運用してください。

転送設定の実行手順

本アプリと同時に動作させる外部ソフトウェアの受信ポート設定を、標準の9001から別の中継用番号（例: 9002）に変更します。
本アプリケーションの『他のアプリに転送する』のチェックを有効にします。
本アプリケーションの『転送先ポート』に、他ソフトウェア側で設定した中継ポート番号（例: 9002）を入力します。
『設定保存』を実行して設定を記録し、アプリケーションが『開始』されている状態にします。
本アプリケーションの稼働を確認した後、もう一方の外部ソフトウェアを起動します。

運用手順

基本的に起動するだけで準備は完了し、特別な操作を必要としません。

開始処理

VR169 Companion.exe を起動します。
VRChatを起動し、VR169アセットがセットアップされているアバターをロードします。
バックグラウンドで接続の確認が行われ、接続完了を示すログが記録されればシステム接続は完了です。接続の確認には約２秒かかります。

終了処理

監視動作を完全に終了してアプリケーションを閉じる場合は、ウィンドウ右上にある『×』ボタンをクリックしてください。内部の通信やスレッド処理をクリーンアップしたうえで自動的に終了します。
アプリケーションを起動したまま、一時的に通信の監視のみを中断させたい場合は、画面内の『停止』ボタンをクリックしてください。

設定の保存と初期化

手動保存『設定保存』をクリックすると、現在の画面入力値が設定ファイルに記録されます。書き込み権限の制限などで保存に失敗した場合は、ログ領域に赤文字で失敗した原因とエラー内容が出力されます。
初期化『設定初期化』を実行すると、確認ダイアログの承認を経てすべての設定値が規定の初期パラメータへと書き換えられます。

二重起動防止

本アプリケーションがすでにシステム内部で稼働している状況下で、誤って新たにアプリケーションファイルを起動した場合、二重起動防止システムがこれを検知します。警告画面を表示した上で、重複したプロセスを自動的に終了します。

【画面上にアプリアクティブウインドウがないにもかかわらず二重起動の警告が表示される場合】前回の終了処理プロセスが完全にクローズされず、OSのタスク上に残留している可能性があります。数秒待ってから再起動を行うか、以下の手順でプロセスをクリアしてください。

Ctrl + Shift + Esc キーを押下して、Windowsの『タスクマネージャー』を開きます。
プロセス一覧から VR169 Companion.exe を探索して選択します。
『タスクの終了』を実行してプロセスを強制クローズさせた後、改めてアプリケーションを起動します。

シャッターの操作

カメラハンドの操作と機能に従い、アバターでシャッターを切る操作を行ってください。
ログにシャッターの入力を検知した旨が表示され、VRChatのカメラが撮影を行います。

【注意】極稀にシャッターが切れないことがあります。さらなる安定化に向けて更新を続ける予定です。VR169とアプリの接続開始から約２秒間、および約１秒以内の連続した入力はシャッターの入力を破棄します。安定した動作、VRChatの仕様に対する処置です。ご了承ください。