diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 15 insertions, 15 deletions
@@ -2,11 +2,13 @@ opentrack project home at <<http://github.com/opentrack/opentrack>>. -Downloads are at <<https://github.com/opentrack/opentrack/releases>>. +For the latest **downloads** visit <<https://github.com/opentrack/opentrack/releases>>. Currently installers and portable versions for Windows are available for each release. Create `portable.txt` in the software directory for a truly "portable" installation that can be carried on an USB stick. Please first refer to <<https://github.com/opentrack/opentrack/wiki>> -for new user guide, frequent questions, specific tracker/filter -documentation. +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. @@ -20,15 +22,12 @@ software. Don't be afraid to submit an **issue/feature request** if need arises. -# Downloads - -For the latest releases visit: <<https://github.com/opentrack/opentrack/releases>>. Currently installers and portable versions for Windows are available for each release. Create `portable.txt` in the software directory for a truly "portable" installation that can be carried on an USB stick. - -# Tracking input +## Tracking input - PointTracker by Patrick Ruoff, freetrack-like light sources - Oculus Rift DK1, DK2, CV, and legacy/knockoff versions (Windows only) -- Paper marker support via the ArUco library <<https://github.com/opentrack/aruco>> +- Paper [marker support](https://github.com/opentrack/opentrack/wiki/Aruco-tracker) + via the ArUco library <<https://github.com/opentrack/aruco>> - Razer Hydra - Relaying via UDP from a different computer - Relaying UDP via FreePIE-specific Android app @@ -39,7 +38,7 @@ For the latest releases visit: <<https://github.com/opentrack/opentrack/releases - BBC micro:bit, LEGO, sensortag support via [S2Bot](http://www.picaxe.com/Teaching/Other-Software/Scratch-Helper-Apps/) - Wiimote (Windows) -# Output protocols +## Output protocols - SimConnect for newer Microsoft Flight Simulator (Windows) - freetrack implementation (Windows) @@ -52,10 +51,10 @@ For the latest releases visit: <<https://github.com/opentrack/opentrack/releases - FSUIPC for Microsoft Flight Simulator 2002/2004 (Windows) - SteamVR through a bridge (Windows; see <<https://github.com/r57zone/OpenVR-OpenTrack>> by @r57zone) -# Credits, in chronological order +## 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`) +- 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. - Chris Thompson (aka mm0zct, Rift and Razer Hydra author and maintainer) - Patrick Ruoff (PT tracker author) - Xavier Hallade (Intel RealSense tracker author and maintainer) @@ -66,7 +65,7 @@ For the latest releases visit: <<https://github.com/opentrack/opentrack/releases - Eike "e4z9" (OSX joystick output driver) - Wei Shuai (Wiimote tracker) -# Thanks +## Thanks - uglyDwarf (high CON) - Andrzej Czarnowski (FreePIE tracker and Google Cardboard assistance, testing) @@ -75,8 +74,9 @@ For the latest releases visit: <<https://github.com/opentrack/opentrack/releases - 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) +- OpenCV authors and maintainers <<https://github.com/opencv/opencv/>>. -# License and warranty +## License and warranty Almost all code is licensed under the [ISC license](https://en.wikipedia.org/wiki/ISC_license). There are very few proprietary dependencies. There is no copyleft code. See individual files for licensing and authorship information. @@ -84,6 +84,6 @@ See [WARRANTY.txt](WARRANTY.txt) for applying warranty terms (that is, disclaimi The code is held to a high-quality standard and written with utmost care; consider this a promise without legal value. Despite doing the best we can not to injure users' equipment, software developers don't want to be dragged to courts for imagined or real issues. Disclaiming warranty is a standard practice in the field, even for expensive software like operating systems. -# Building opentrack from source +## Building opentrack from source On Windows, use either mingw-w64 or MS Visual Studio 2015 Update 3/newer. On other platforms use GNU or LLVM. Refer to [Visual C++ 2015 build instructions](https://github.com/opentrack/opentrack/wiki/Building-under-MS-Visual-C---2017-and-later). |