summaryrefslogtreecommitdiffhomepage
path: root/proto-iokit-foohid/README.md
diff options
context:
space:
mode:
authorEike Ziller <git@eikeziller.de>2017-11-19 21:18:26 +0100
committerEike Ziller <git@eikeziller.de>2017-11-23 20:23:28 +0100
commit7bacbdf10b97040c9ed282a22485759bd082fa63 (patch)
tree2a02884f633ddbc7ede387a5bf2aa8d7b0396e5f /proto-iokit-foohid/README.md
parentf548847ea43006b2dc540e84d11d3c3662a94148 (diff)
Add virtual joystick output for macOS
Based of the foohid IOKit driver for implementing virtual HID devices. Issue: #236
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.