diff options
| -rw-r--r-- | README.md | 44 |
1 files changed, 20 insertions, 24 deletions
@@ -1,3 +1,5 @@ +## Intro + opentrack project home at <<http://github.com/opentrack/opentrack>>. Downloads are at <<https://github.com/opentrack/opentrack/releases>>. @@ -6,21 +8,23 @@ Please first refer to <<https://github.com/opentrack/opentrack/wiki>> for new user guide, frequent questions, specific tracker/filter documentation. -*** +**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 +`opentrack` is an application dedicated to tracking user's head movements and relaying the information to games and flight simulation software. -Not to be confused with railway planning software <<http://opentrack.ch>> +`opentrack` allows for output shaping, filtering, and operating with many input and output devices and protocols; the codebase runs Microsoft Windows, Apple OSX (currently unmaintained), and GNU/Linux. -*** +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. +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 sources +# Tracking input - PointTracker by Patrick Ruoff, freetrack-like light sources - Oculus Rift DK1, DK2, CV, and legacy/knockoff versions (Windows only) @@ -35,7 +39,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 +# Output protocols - SimConnect for newer Microsoft Flight Simulator (Windows) - freetrack implementation (Windows) @@ -48,27 +52,18 @@ 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) -*** - -# Configuration - -**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. - -*** - # 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`) - Chris Thompson (aka mm0zct, Rift and Razer Hydra author and maintainer) - Patrick Ruoff (PT tracker author) - Xavier Hallade (Intel RealSense tracker author and maintainer) - furax49 (hatire tracker author) - Michael Welter (contributor) +- Alexander Orokhovatskiy (Russian translation; profile repository maintenance; providing hardware; translating reports from the Russian community) - Attila Csipa (Micro:Bit author) -- Eike @e4z9 (OSX joystick output driver) +- Eike "e4z9" (OSX joystick output driver) - Wei Shuai (Wiimote tracker) # Thanks @@ -78,16 +73,17 @@ Don't be afraid to submit an issue/feature request if need arises. - Wim Vriend (original codebase author and maintainer) - Ryan Spicer (OSX tester, contributor) - Donovan Baarda (filtering/control theory expert) -- Mathijs Groothuis (@MathijsG, dozens of bugs and other issues reported) +- 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) -# Licensing information +# 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. -# Warranty terms +See [WARRANTY.txt](WARRANTY.txt) for applying warranty terms (that is, disclaiming possible pre-existing warranty) that are in force unless the software author specifies their own warranty terms. In short, we disclaim all possible warranty and aren't responsible for any possible damage or losses. -See [WARRANTY.TXT](WARRANTY.txt) for applying warranty terms (that is, disclaiming possible pre-existing warranty) that are in force unless the software author specifies their own warranty terms. +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 -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------2015). +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). |