diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 25 insertions, 18 deletions
@@ -1,6 +1,10 @@ +[<img src="https://github.com/opentrack/opentrack/actions/workflows/cmake.yml/badge.svg">](https://github.com/opentrack/opentrack/actions/workflows/cmake.yml) + ## Intro -opentrack project home at <<http://github.com/opentrack/opentrack>>. +opentrack is a program for tracking user's head rotation and transmitting it to flight simulation software and military-themed video games. Project home is located at <<https://github.com/opentrack/opentrack>>. + +Looking for **railway planning software**? <<https://opentrack.ch>> had the name `opentrack` first. Apologies for the long-standing naming conflict. For the latest **downloads** visit <<https://github.com/opentrack/opentrack/releases>> Download an `.exe` installer or a `.7z` archive. Currently installers and portable versions for Windows are available for each release. It supports [USB stick truly "portable" installations](https://github.com/opentrack/opentrack/wiki/portable-mode-for-USB-sticks) @@ -8,10 +12,6 @@ Please first refer to <<https://github.com/opentrack/opentrack/wiki>> for [new user guide](https://github.com/opentrack/opentrack/wiki/Quick-Start-Guide-(WIP)), [frequent answers](https://github.com/opentrack/opentrack/wiki/common-issues), specific tracker/filter documentation. See also the [gameplay video](https://www.youtube.com/watch?v=XI73ul_FnBI) with opentrack set up. -## Looking for railway planning software? - -**Railway planning software** <<http://opentrack.ch>> had the name `opentrack` first. Apologies for the long-standing naming conflict. - ## Usage `opentrack` is an application dedicated to tracking user's head @@ -24,20 +24,22 @@ Don't be afraid to submit an **issue/feature request** if you have any problems! ## Tracking input -- PointTracker by Patrick Ruoff, freetrack-like light sources -- Oculus Rift DK1, DK2, CV, and legacy/knockoff versions (Windows only) -- Paper [marker support](https://github.com/opentrack/opentrack/wiki/Aruco-tracker) - via the ArUco library <<https://github.com/opentrack/aruco>> +- PointTracker by Patrick Ruoff, FreeTrack-like light points +- Oculus Rift (Windows only) +- Paper [marker](https://github.com/opentrack/opentrack/wiki/Aruco-tracker) via the Aruco<sup>[[1](https://github.com/opentrack/aruco)]</sup> library - Razer Hydra - Relaying via UDP from a different computer -- Relaying UDP via FreePIE-specific Android app +- Relaying UDP via the FreePIE<sup>[[1](https://andersmalmgren.github.io/FreePIE/)]</sup> Android [apps](https://github.com/opentrack/opentrack/tree/master/contrib/freepie-udp) - Joystick analog axes (Windows) - Windows Phone [tracker](https://github.com/ZanderAdam/OpenTrack.WindowsPhone/wiki) over opentrack UDP protocol -- Arduino with custom firmware -- Intel RealSense 3D cameras (Windows) +- Arduino with custom Hatire firmware +- Intel RealSense 3D camera (Windows) - BBC micro:bit, LEGO, sensortag support via Smalltalk<sup>[(1)](https://en.wikipedia.org/wiki/Smalltalk)[(2)](https://en.wikipedia.org/wiki/Alan_Kay)</sup> - [S2Bot](http://www.picaxe.com/Teaching/Other-Software/Scratch-Helper-Apps/) + [S2Bot](https://www.picaxe.com/Teaching/Other-Software/Scratch-Helper-Apps/) - Wiimote (Windows) +- NeuralNet face tracker +- Eyeware Beam<sup>[[1](https://beam.eyeware.tech/)]</sup> +- Tobii eye tracker ## Output protocols @@ -46,7 +48,7 @@ Don't be afraid to submit an **issue/feature request** if you have any problems! - Relaying UDP to another computer - Virtual joystick output (Windows, Linux, OSX) - Wine freetrack glue protocol (Linux, OSX) -- X-Plane plugin (Linux) +- X-Plane plugin (Linux; uses the Wine output option) - Tablet-like mouse output (Windows) - FlightGear - FSUIPC for Microsoft Flight Simulator 2002/2004 (Windows) @@ -55,7 +57,7 @@ Don't be afraid to submit an **issue/feature request** if you have any problems! ## Credits, in chronological order - Stanisław Halik (maintainer) -- Wim Vriend -- author of [FaceTrackNoIR](http://facetracknoir.sourceforge.net/) that served as the initial codebase for `opentrack`. While the code was almost entirely rewritten, we still hold on to many of `FaceTrackNoIR`'s ideas. +- Wim Vriend -- author of [FaceTrackNoIR](https://facetracknoir.sourceforge.net/) that served as the initial codebase for `opentrack`. While the code was almost entirely rewritten, we still hold on to many of `FaceTrackNoIR`'s ideas. - Chris Thompson (aka mm0zct, Rift and Razer Hydra author and maintainer) - Patrick Ruoff (PT tracker author) - Xavier Hallade (Intel RealSense tracker author and maintainer) @@ -65,15 +67,20 @@ Don't be afraid to submit an **issue/feature request** if you have any problems! - Attila Csipa (Micro:Bit author) - Eike "e4z9" (OSX joystick output driver) - Wei Shuai (Wiimote tracker) +- Stéphane Lenclud (Kinect Face Tracker, Easy Tracker) +- GO63-samara (Hamilton Filter, Pose-widget improvement) +- Davide Mameli (Eyeware Beam tracker) +- Khoa Nguyen (Tobii eye tracker) ## Thanks -- uglyDwarf (high CON) +- uglyDwarf (of [linuxtrack](https://github.com/uglyDwarf/linuxtrack/)) - Andrzej Czarnowski (FreePIE tracker and [Google Cardboard](https://github.com/opentrack/opentrack/wiki/VR-HMD-goggles-setup-----google-cardboard,-colorcross,-opendive) assistance, testing) - Wim Vriend (original codebase author and maintainer) - Ryan Spicer (OSX tester, contributor) +- Ries van Twisk (OSX tester, OSX Build Fixes, contributor) - Donovan Baarda (filtering/control theory expert) - Mathijs Groothuis (@MathijsG, dozens of bugs and other issues reported; NL translation) - The Russian community from the [IL-2 Sturmovik forums](https://forum.il2sturmovik.ru/) (reporting bugs, requesting important features) @@ -81,9 +88,9 @@ Don't be afraid to submit an **issue/feature request** if you have any problems! ## Contributing -Code, translations, +See guides for writing new modules\[[1](https://github.com/opentrack/opentrack/blob/master/api/plugin-api.hpp)\]\[[2](https://github.com/opentrack/opentrack/blob/master/tracker-test/test.h)\], and for [working with core code](https://github.com/opentrack/opentrack/wiki/Hacking-opentrack). -Please see [basic rules for contributing](https://github.com/opentrack/opentrack/blob/unstable/CONTRIBUTING.md). There's also a guide for [working with core code](https://github.com/opentrack/opentrack/wiki/Hacking-opentrack). For writing input and output modules you don't need this guide except for +To edit the wiki, send pull requests to the [opentrack/wiki](https://github.com/opentrack/wiki) repository. The [user-facing wiki](https://github.com/opentrack/opentrack/wiki) will automatically update itself once the commit is merged. ## License and warranty |