コンテンツにスキップ
Hapbeat devtools
JA

インストール要件

Hapbeat Unity SDK は Unity Package Manager (UPM) 経由で Git URL から直接インストール できます。.unitypackage のダウンロードや手動コピーは不要です。

動作環境

Section titled “動作環境”
  • Unity 6 (6000.0) 以上（動作確認済み: Unity 6000.3.12f1）
  • Git が PC にインストール済み・PATH 通り済み (Unity が裏で git clone するため必須)
  • デバイスと同一ネットワーク（同一サブネット）に接続できる環境
  • Active Input Handling は “Both” / “Old” / “Input System Package” いずれでも動作します

インストール

Section titled “インストール”

1. Package Manager から Git URL で追加

Section titled “1. Package Manager から Git URL で追加”
  1. Unity Editor で Window → Package Manager
  2. 左上の + → Install package from git URL...
  3. 次の URL を貼り付けて Add:
https://github.com/Hapbeat/hapbeat-unity-sdk.git

特定バージョンを固定する場合は末尾にタグを付けます。指定できるタグは Releases を参照してください:

https://github.com/Hapbeat/hapbeat-unity-sdk.git#v0.3.0

2. 更新

Section titled “2. 更新”
  • Package Manager → Hapbeat SDK を選択 → 右ペインに Update が出ていればクリック
  • Tag 固定 URL の場合は Packages/manifest.json の #vX.Y.Z を書き換えて保存 → Unity が自動 reimport

新しい版が出ると、Editor 起動時に Console へ 1 行だけお知らせが出ます。表示は Editor セッションごとに 1 回で、スクリプト再コンパイル（domain reload）では重複しません。

  • いま最新かどうかを確かめる: Hapbeat → Diagnostics → Check for SDK Updates
  • 自動確認を止める: Hapbeat → Diagnostics → Check for SDK Updates on Startup

タグ固定の URL は Package Manager が更新を検出できないため、この自動確認が実質的な唯一の気付き手段になります。

3. SDK フォルダを作成 (任意・初回のみ便利)

Section titled “3. SDK フォルダを作成 (任意・初回のみ便利)”

Hapbeat → Setup → Create HapbeatSDK Folder を実行すると以下が生成されます:

Assets/HapbeatSDK/
  Kits/        ← 触覚波形と manifest.json (Studio 連携先)
  Scenes/      ← 生成シーン
  EventMaps/   ← EventMap.asset

サンプルの Build メニューを使う場合は自動で生成されるので、明示的に呼ぶ必要はありません。

サンプル

Section titled “サンプル”

Package Manager で Hapbeat SDK を選択 → 右パネル Samples タブから Import:

サンプル内容動作要件
Basic ExampleTrigger × 3 + Helper + Dispatcher + StatusOverlay の最小組合せ。Space/R/F/S/C キーで動作確認デバイス + Studio または Helper 起動
Showcase5 ゾーン構成の SDK 全機能ショーケース (Bowling / Door / Fishing / Stream Console / Target Range)。キーマウスで完結、XR 不要同上
XR HelpersXR Interaction Toolkit 連携フィルター (XRGrabFilter / XRSocketFilter)XRI パッケージが入っているプロジェクトのみ
XRI Hand Demo (haptics add-on)XRI の Hands Interaction Demo に haptics を追加する EventMap + Kit。シーンは非同梱で、Editor コマンドで配線を適用 → XRI Hand Demo に haptics を追加XRI + XR Helpers + ハンドトラッキング HMD
VR Config ExampleVR 実機での確認用の最小シーン。override の設定とテスト発火のみ。XRI 非依存 → ターゲティングQuest 等の VR 実機

Sample は Assets/Samples/Hapbeat SDK/<version>/<sample>/ に展開されます。Import 直後にシーン (Scenes/*.unity) を開いて Play すれば動作確認できます — 追加のビルド手順は不要です。

動作確認

Section titled “動作確認”
  1. Hapbeat Studio または Hapbeat Helper を起動し、デバイスがオンライン表示になることを確認
  2. Unity で Assets/HapbeatSDK/Scenes/BasicExample.unity を開く
  3. Play モード突入
  4. Space キーで Stream 1-shot, F キーで Command (Fire) が再生され、デバイスから振動が出れば成功（R = Stream loop, S = Stop all, C = Ping）

UI に Pong: RTT=...ms が表示されれば SDK ↔ デバイスの通信は確立しています。

ビルド時の注意

Section titled “ビルド時の注意”
  • iOS / Android: 標準で動作 (UDP socket 利用可)
  • Quest (Android): マニフェストに INTERNET 権限が自動付与される
  • WebGL: UDP socket 不可。WebGL ビルドでは Hapbeat 通信は動作しません

トラブルシューティング

Section titled “トラブルシューティング”
症状対処
Package Manager で URL を貼っても進まないGit が PATH に通っているか確認 (git --version がコマンドラインで通る必要あり)
サンプルのシーンが見つからないPackage Manager → Hapbeat SDK → Samples タブから該当サンプルを Import 済みか確認。古い Sample を再 Import すると最新のシーン・Editor スクリプトが反映される
Play しても触覚が来ないStudio/Helper が起動・デバイスがオンラインか / EventMap のターゲット、または Override Addressing の設定がデバイス側のアドレスと一致するか（ターゲティング）
Space / R / F キーに反応しないEdit → Project Settings → Player → Active Input Handling が Input Manager (Old) のみになっていないか確認。Both または Input System Package に変更（Unity 6 のデフォルトは Both）
'InputSystem' does not exist 等のコンパイルエラー古い import が残っている可能性。Assets/Samples/Hapbeat SDK/ 配下の該当 Sample を削除して再 Import

次のステップ

Section titled “次のステップ”