summaryrefslogtreecommitdiffhomepage
path: root/proto-iokit-foohid/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'proto-iokit-foohid/README.md')
-rw-r--r--proto-iokit-foohid/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/proto-iokit-foohid/README.md b/proto-iokit-foohid/README.md
new file mode 100644
index 00000000..a9d7a34e
--- /dev/null
+++ b/proto-iokit-foohid/README.md
@@ -0,0 +1,17 @@
+# Virtual Joystick Support for macOS
+
+Adds support for a virtual joystick output, based on the foohid driver for virtual HID devices.
+
+## Usage
+
+Install the latest [foohid HID driver](https://github.com/unbit/foohid/releases/).
+
+Select "Virtual Joystick" as the output in OpenTrack.
+
+The X, Y, Z, Yaw, Pitch, and Roll tracking axes are mapped to the joystick's X, Y, Z, RX, RY,
+and RZ axes respectively.
+
+# Building
+
+The implementation only uses standard libraries that are pre-installed on macOS. There are no
+special requirements for building.