@kelnishi/satmouse 0.9.4 → 0.9.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @kelnishi/satmouse
|
|
2
|
+
|
|
3
|
+
Run [SatMouse](https://kelnishi.github.io/SatMouse/) — a 6DOF spatial input bridge that streams SpaceMouse, gamepad, and HID device data to web apps.
|
|
4
|
+
|
|
5
|
+
## Install & Run
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @kelnishi/satmouse
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Downloads the correct platform binary from [GitHub Releases](https://github.com/kelnishi/SatMouse/releases/latest) on first run.
|
|
12
|
+
|
|
13
|
+
## What It Does
|
|
14
|
+
|
|
15
|
+
SatMouse bridges spatial input devices to web apps over WebSocket and WebTransport:
|
|
16
|
+
|
|
17
|
+
1. Detects connected devices (SpaceMouse, gamepads, HID)
|
|
18
|
+
2. Broadcasts `_wot._tcp` via mDNS for zero-config discovery
|
|
19
|
+
3. Streams 6DOF data at device rate (~60-120 Hz)
|
|
20
|
+
4. Legacy compatibility on port 18944 (spacemouse-proxy protocol)
|
|
21
|
+
|
|
22
|
+
## Ports
|
|
23
|
+
|
|
24
|
+
| Port | Protocol | Purpose |
|
|
25
|
+
|---|---|---|
|
|
26
|
+
| 18944 | WebSocket | Legacy spacemouse-proxy compat |
|
|
27
|
+
| 18945 | HTTP + WebSocket | Thing Description, reference client, spatial stream |
|
|
28
|
+
| 18946 | WebTransport | Low-latency HTTP/3 QUIC datagrams |
|
|
29
|
+
|
|
30
|
+
## Platforms
|
|
31
|
+
|
|
32
|
+
| Platform | Status |
|
|
33
|
+
|---|---|
|
|
34
|
+
| macOS (Apple Silicon) | .app bundle with menu bar icon |
|
|
35
|
+
| Linux (x64) | Standalone binary |
|
|
36
|
+
| Windows (x64) | Standalone binary |
|
|
37
|
+
|
|
38
|
+
## For Client Apps
|
|
39
|
+
|
|
40
|
+
Install the SDK to integrate spatial input into your app:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install @kelnishi/satmouse-client
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
See [@kelnishi/satmouse-client](https://www.npmjs.com/package/@kelnishi/satmouse-client) for API docs.
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
MIT — [GitHub](https://github.com/kelnishi/SatMouse)
|