summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorStanislaw Halik <sthalik@misaki.pl>2013-09-17 19:42:39 +0200
committerStanislaw Halik <sthalik@misaki.pl>2013-09-17 19:42:39 +0200
commit334eb6a4f25240441ec4e2cd5c31dec0f9fa0453 (patch)
tree0c29228cba32e3cb7e19b1dbd6e4b429f5cb9bf0 /README.md
parent9ada3fad5dcd0885aa9a0f27d71b0ce01c017bcd (diff)
New README
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..0ca24ef0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+Windows binary builds are available at <http://ananke.laggy.pk/opentrack/>
+
+Source code access available at <http://github.com/opentrack/opentrack/>
+
+--
+
+**opentrack** is an application dedicated to tracking user's head
+movements and relaying them to games and flight simulation software.
+
+** Tracking sources
+
+- SeeingMachines FaceAPI <http://seeingmachines.com/>
+- PointTracker by Patrick Ruoff, freetrack-like light sources
+- Oculus Rift (Linux testers welcome!)
+- AR marker support via the ArUco library <https://github.com/rmsalinas/aruco>
+- HT tracker <https://github.com/sthalik/headtracker>>
+- Razer Hydra (Windows only)
+- Relaying via UDP from a different computer
+
+** Protocols
+
+- FlightGear Nasal script
+- FSUIPC for Microsoft FSX (Windows)
+- freetrack emulation (Windows)
+- Relaying udp to another computer
+- Joystick support via freedesktop.org libevdev (Linux)
+- Joystick support via VJoy (Windows)
+- Wine freetrack glue protocol (Linux)
+- Tablet-like coordinate output (Windows)
+
+** Configuration
+
+**opentrack** offers output shaping, filtering, is buildable on
+both MS Windows and GNU/Linux.
+
+Don't be afraid to submit an issue/feature request if the need arises.
+
+** Credits
+
+- mm0zct
+- Stanisław Halik
+- Donovan Baarda
+- Patrick Ruoff (merging)
+- Wim Vriend (historically)
+- Ron Hendriks (historically)
+
+** Licensing information
+
+The code originally licensed under GPLv3, new code is required to be
+compatible with it unless resides in separate address space.
+
+It's recommended to submit new code under ISC license, it's a shorter
+boilerplate header than MIT/X11 or new BSD.