diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 57 |
1 files changed, 34 insertions, 23 deletions
@@ -1,45 +1,55 @@ -======= -Windows binary builds are available at <https://www.dropbox.com/sh/544fbhsokdpy3n7/AAAKwl6BluqwT9Xn2slyp0dCa> +opentrack project home at <<http://github.com/opentrack/opentrack>>. -Source code access available at <http://github.com/opentrack/opentrack/> +Binary releases at <<https://github.com/opentrack/opentrack/releases>>. --- +Please first refer to <<https://github.com/opentrack/opentrack/wiki>> +for new user guide, frequent questions, specific tracker/filter +documentation. + +*** **opentrack** is an application dedicated to tracking user's head -movements and relaying them to games and flight simulation software. +movements and relaying the information to games and flight simulation +software. Not to be confused with railway planning software <<http://opentrack.ch>> -See our wiki at <<https://github.com/opentrack/opentrack/wiki>> +*** # Tracking sources - PointTracker by Patrick Ruoff, freetrack-like light sources - Oculus Rift -- AR marker support via the ArUco library <https://github.com/rmsalinas/aruco> -- HT tracker <https://github.com/sthalik/headtracker> +- Paper marker support via the ArUco library <<https://github.com/rmsalinas/aruco>> +- Human face tracker <<https://github.com/sthalik/headtracker>> - Razer Hydra - Relaying via UDP from a different computer -- Joystick analog axes (Windows only) +- Relaying UDP via FreePIE-specific Android app +- Joystick analog axes (Windows, Linux) +- Windows Phone [tracker](http://www.windowsphone.com/en-us/store/app/opentrack-head-tracking/1c604f32-6d68-40ef-aa44-3163e30f547f) over opentrack UDP protocol # Output -- FlightGear Nasal script -- FSUIPC for Microsoft Flight Simulator (Windows) - SimConnect for newer Microsoft Flight Simulator (Windows) -- freetrack emulation (Windows) -- Relaying udp to another computer -- Joystick support via freedesktop.org libevdev (Linux) -- Joystick support via VJoy (Windows) +- freetrack implementation (Windows) +- Relaying UDP to another computer +- Virtual joystick output (Linux, Windows) - Wine freetrack glue protocol (Linux, OSX) -- Tablet-like coordinate output (Windows) +- X-Plane plugin (Linux) +- Tablet-like mouse output (Windows) +- FlightGear Nasal script +- FSUIPC for Microsoft Flight Simulator 2002/2004 (Windows) + +*** # Configuration -**opentrack** offers output shaping, filtering, is buildable on -MS Windows, MacOSX and GNU/Linux. +**opentrack** allows for output shaping, filtering, the codebase builds +on on Microsoft Windows, Apple OSX, and GNU/Linux. + +Don't be afraid to submit an issue/feature request if need arises. -Don't be afraid to submit an issue/feature request if the need arises. +*** # Credits @@ -49,13 +59,14 @@ Don't be afraid to submit an issue/feature request if the need arises. - Ryan Spicer (OSX tester, contributor) - Patrick Ruoff (PT tracker) - Ulf Schreiber (PT tracker) +- Andrzej Czarnowski (quality assurance) - uglyDwarf (high CON) - Wim Vriend (historically) # Licensing information -The code originally licensed under GPLv3, new code is required to be -compatible with it unless resides in separate address space. +The code originally licensed under GPLv3, new code required legally +compatible 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. +Recommended to submit new code under ISC license, shorter boilerplate +header than MIT/X11 or new BSD. |