/HaptiConVRC

Primary LanguagePythonMozilla Public License 2.0MPL-2.0

HaptiConVRC

VRChatでアバターの接触イベントを検知して、Joy-Conを振動させるシステム

必要なもの

  • Joy-Con L または R
  • PCVR環境(Windows10)
    • PCはBluetooth接続可能なこと
      • USBのBluetoothアダプタでも可

導入方法

アバター側の設定

  1. Unityで、アバターの接触を検出したい部位（Armature）に VRC Contact Receiver (Script) を設定する。 設定例
    • Shape : Sphereで任意の検出範囲
    • Filtering
      • Allow Self と Allow Others にチェックを入れることを推奨
      • Collision Tags : Hand と Finger を推奨
    • Receiver
      • Receiver Type :
        • 「なで」系の動作に使用する場合は Proximity
        • 「ツン」系の動作に使用する場合は On Enter
      • Parameter : わかりやすいパラメータ名を設定する。（例：左耳なら Contact_Left_Ear ）
  2. アバターをアップロードする。
  3. VRChat内で、円形メニュー → Options → OSC → Enabled にする。
  4. VRChat内で、円形メニュー → Options → Config → Avatar Overlay → Contacts を使い、鏡の前で自分でContactに触り、Contactが反応すること（色が変わること）を確認する。

ソフトのセットアップと実行

  1. PCに **Python3.9 または Python3.10 **をインストールする。（他のバージョンでは動作未確認、Python3.11ではライブラリインストール失敗の報告あり）
    • インストール時、 Add Python3.x to PATH にチェックを入れることを推奨
  2. HaptiConVRCのzipをダウンロードし、展開する。
  3. 展開したフォルダの setup.py を実行する。
    • 必須ライブラリが自動インストールされる。
  4. config.json をメモ帳などで開き、必要があれば以下の設定項目を更新して上書き保存する。
    • address
      • "/avatar/parameters/（ステップ1で作成した、Joy-Conと連携させるContact Receiverのパラメータ名）" に設定する。
      • 例 : "/avatar/parameters/Contact_Left_Ear"
      • Joy-Conの片方のみ使う場合、使わないほうのパラメータ名は空欄 "" にする
    • amp_max
      • 振動の強さを 0～12 の中から選ぶ。（作者推奨: 10）
    • mode
      • Receiver Typeに合わせる（Proximity または On Enter）
  5. Joy-ConをPCに接続する。
    • Joy-ConをSwitch本体から取り外し、ペアリングボタンを長押しし、WindowsのBluetooth接続設定からペアリングをする
    • Switch本体つなげると、Joy-ConとSwitch本体が再ペアリングされる。
    • PC側にペアリング情報が残っていると、再ペアリングできない。その場合はPCでペアリング解除を行う。
  6. main.py を実行する。

#HaptiConVRC でツイートしてね

動作しないとき

  • Avatar Overlay を使い、Contactが設定できていること・反応することを確認してください。
  • パラメータ名のタイプミスや大文字小文字に誤りがないか確認してください。
  • 一度VRChatを終了し、C:/Users/(ユーザー名)/AppData/LocalLow/VRChat/VRChat/OSC/(userID)/Avatars/ 内のjsonファイルを削除してから再起動するとうまくいくことがあるようです。

既知の不具合

  • 一定時間後、Joy-Conの接続が切れる
    • ときどきJoy-Conの適当なボタンを押すと途切れにくい
  • 稀に、OS Error と表示され、Joy-Conが接続エラーとなる