docs: READMEを更新

Author: shun-shobon

README.md

@@ -1,36 +1,21 @@
 # UnityJoyCon
 
-UnityJoyCon は Nintendo Switch の Joy-Con を Unity から扱うためのライブラリです。ボタン入力、スティック座標、加速度・ジャイロセンサーの生データを取得でき、ゲームロジックやデバッグ表示に組み込めます。
+UnityJoyCon は Nintendo Switch の Joy-Con を Unity Input System に直接統合するライブラリです。Joy-Con を HID デバイスとして自動認識し、ボタン入力・スティック座標・加速度 / ジャイロの生データをそのまま InputDevice から取得できます。外部の hidapi や `System.Threading.Channels` への依存はありません。
 
-## 導入方法
-
-### UnityNuGet レジストリを設定する
-本パッケージは `System.Threading.Channels` を UnityNuGet (`org.nuget.system.threading.channels`) から取得します。レジストリが設定されていないと依存関係が解決できないため、導入先プロジェクトで以下のいずれかの方法で UnityNuGet を追加してください。
+## 特徴
+- Unity Input System へのレイアウトを自動登録し、左右 Joy-Con を `SwitchJoyConLeftHID` / `SwitchJoyConRightHID` として認識
+- ボタン / スティック / 加速度 / ジャイロを標準の InputControl として取得可能
+- ネイティブプラグイン不要。OS にペアリングされている Joy-Con をそのまま利用
 
-- **manifest.json を直接編集する**
-  ```json
-  "scopedRegistries": [
-    {
-      "name": "Unity NuGet",
-      "url": "https://unitynuget-registry.openupm.com",
-      "scopes": [
-        "org.nuget"
-      ]
-    }
-  ]
-  ```
-  既存の `scopedRegistries` 配列がある場合は、`Unity NuGet` のエントリをマージし `org.nuget` スコープが含まれるように調整します。
+## 前提条件
+- Unity 2022.3.62f3 以降（推奨）
+- `com.unity.inputsystem` 1.14.2（本パッケージの依存として自動導入されます）
+- Joy-Con を事前に OS と Bluetooth ペアリングしておくこと
 
-- **GUI から追加する**
-  1. `Edit > Project Settings...` を開きます。
-  2. `Package Manager` セクションの `Scoped Registries` で `+` を押し、下記を入力します。
-     - Name: `Unity NuGet`
-     - URL: `https://unitynuget-registry.openupm.com`
-     - Scope(s): `org.nuget`
-  3. 保存すると manifest.json に反映されます。
+## 導入方法
 
 ### パッケージを Git から追加する
-レジストリ設定後、`com.tuatmcc.unityjoycon` を Git パッケージとして導入します。
+Package Manager で Git パッケージとして追加します。
 
 - **manifest.json を直接編集する**
   ```json
@@ -42,7 +27,10 @@ UnityJoyCon は Nintendo Switch の Joy-Con を Unity から扱うためのラ
   2. 左上の `+` ボタンから `Add package from git URL...` を選択します。
   3. `https://github.com/tuatmcc/UnityJoyCon.git?path=Packages/com.tuatmcc.unityjoycon` を入力して `Add` します。
 
-Unity の Package Manager を再読み込みすると `UnityJoyCon` がインストールされ、`UnityJoycon` 名前空間の API を参照できるようになります。
+### Input System を有効化する
+パッケージ導入時に「新しい Input System を有効にしますか？」と促される場合があります。`Project Settings > Player > Active Input Handling` を `Input System Package (New)` または `Both` に設定し、Unity を再起動してください。
+
+Unity の Package Manager を再読み込みすると `UnityJoyCon` がインストールされ、`UnityJoyCon` 名前空間の API を参照できるようになります。
 
 ### サンプルを試す場合
 リポジトリ全体を取得すると、サンプルシーンで動作確認が行えます。
@@ -55,57 +43,61 @@ cd UnityJoyCon
 `Assets/SampleJoyCon.unity` を開き、Joy-Con をペアリングした状態で Play モードに入ると、ボタン・スティック・IMU の値をリアルタイムで確認できます。
 
 ## クイックスタート
-最初に見つかった Joy-Con に接続し、ボタン / スティック / IMU を取得するサンプルです。
+最初に見つかった Joy-Con から入力を読み取るシンプルなサンプルです。Input System によって Joy-Con が認識されると、`SwitchJoyConLeftHID.all` / `SwitchJoyConRightHID.all` に追加されます。実運用では InputAction（Input Actions アセットまたは `InputAction` クラス）にバインドして扱うのが基本です。
 
 ```csharp
 using System.Linq;
 using UnityEngine;
-using UnityJoycon;
-using UnityJoycon.Hidapi;
+using UnityEngine.InputSystem;
+using UnityJoyCon;
 
-public class JoyConBootstrap : MonoBehaviour
+public class JoyConReader : MonoBehaviour
 {
-    private Hidapi? _hidapi;
-    private JoyCon? _joycon;
+    private SwitchJoyConLeftHID _left;
+    private SwitchJoyConRightHID _right;
 
-    private async void Awake()
+    private void Update()
     {
-        _hidapi = new Hidapi();
-        var info = _hidapi.GetDevices(0x057e) // Nintendo Vendor ID
-            .FirstOrDefault(d => d.ProductId is 0x2006 or 0x2007);
-        if (info == null)
+        // シーン再生中にペアリングされた場合も追従できるよう、毎フレーム取得しています
+        _left ??= SwitchJoyConLeftHID.all.FirstOrDefault();
+        _right ??= SwitchJoyConRightHID.all.FirstOrDefault();
+
+        if (_left != null && _left.leftTrigger.wasPressedThisFrame)
+            Debug.Log("ZL が押されました");
+
+        if (_right != null)
         {
-            Debug.LogError("Joy-Con が見つかりません");
-            return;
+            var stick = _right.rightStick.ReadValue(); // -1.0f ~ 1.0f
+            var accel = _right.accelerometer.ReadValue();
+            var gyro = _right.gyroscope.ReadValue();
+            // stick / accel / gyro をゲーム内ロジックへ反映
         }
-
-        var device = _hidapi.OpenDevice(info);
-        _joycon = await JoyCon.CreateAsync(device);
     }
+}
+```
 
-    private void Update()
-    {
-        if (_joycon?.TryGetState(out var state) != true) return;
+### InputAction で使う例（抜粋）
+入力アクションアセットで、デバイスを `SwitchJoyConLeftHID` / `SwitchJoyConRightHID` に限定したり、左スティックやボタンをバインドできます。スクリプトで生成する場合の最小例:
 
-        if (state.IsButtonPressed(Button.A))
-        {
-            Debug.Log("A ボタンが押されています");
-        }
+```csharp
+using UnityEngine;
+using UnityEngine.InputSystem;
+using UnityJoyCon;
 
-        var stick = state.Stick;             // -1.0f ~ 1.0f に正規化済み
-        var imu = state.ImuSamples[^1];      // 最新サンプル
-        // stick / imu をゲーム内ロジックに反映
-    }
+public class JoyConActions : MonoBehaviour
+{
+    private InputAction _stick;
 
-    private async void OnDestroy()
+    private void OnEnable()
     {
-        if (_joycon != null)
-        {
-            await _joycon.DisposeAsync();
-            _joycon = null;
-        }
+        _stick = new InputAction(type: InputActionType.Value, binding: "<SwitchJoyConRightHID>/rightStick");
+        _stick.Enable();
+        _stick.performed += ctx => Debug.Log($"Right stick: {ctx.ReadValue<Vector2>()}");
+    }
 
-        _hidapi?.Dispose();
+    private void OnDisable()
+    {
+        _stick.Dispose();
     }
 }
 ```
@@ -114,9 +106,5 @@ public class JoyConBootstrap : MonoBehaviour
 - `Assets/JoyConRight.cs` は Joy-Con のステートを UI に反映する参考スクリプトです。
 - `Assets/SampleJoyCon.unity` を Play すると、ボタンが点灯し IMU が TextMeshPro で表示されます。
 
-## hidapi バイナリの更新
-ネイティブライブラリを更新する場合は、GitHub Actions の `Build hidapi binaries` ワークフローを Workflow Dispatch で起動してください。macOS / Windows / Linux 向けの hidapi をビルドし、`Packages/com.tuatmcc.unityjoycon/Runtime/Hidapi/Plugins/` 下へ自動コミットします。
-
 ## ライセンス
 - パッケージ本体: MIT License
-- hidapi: 各プラットフォーム向けバイナリは hidapi のライセンスに従います