Commit Graph
31 Commits
Author SHA1 Message Date
Vasily 80a28bf744 Update readme information
The Known Bugs section was removed because that's literally why the
issue tracker exists.
2019-01-23 19:57:22 +01:00
Vasily 583a62fb9c Update readme badges to reflect C++17 and Python dependency
The badge had not been updated for C++14 when we made the change. It had
also not been updated to reflect the dependency on Python during the
creation of the build script.
2019-01-23 19:39:29 +01:00
Vasily 7531fc61ea Add browser bindings viewer to readme
Collecting information in the readme prevents users from having to
Google it.
2019-01-22 20:36:42 +01:00
Vasily 1ae434e987 Swap recommended ways of getting bindings to show up
Running with "-bindingsinterface" does not allow for continually
updating the bindings or playing around with them. While changing the
unix time in the vrappconfig is slightly harder for casual users, it
will also give them a way better user experience.
2019-01-22 18:35:50 +01:00
Vasily 667711246e Add media key bindings, update docs
All bindings are disabled by default. This is to prevent confusing
behaviour from users who do not know about the new bindings. Forcing
users to manually set up their bindings will also enable them to play
around with the SteamVR bindings interface, which allows for much more
versatile binding options that our current offerings.

All actions are curently in main action set. If the selection of
bindings was greatly expanded it could be beneficial to encapsulate the
options more. The current code is more intended as a proof of concept
until our full binding needs have been uncovered.

The processInputBindings function should probably also be split into
several functions of related bindings, as the amount of bindings grows.
2019-01-21 21:19:28 +01:00
Vasily 4152333f20 Update documentation to reflect new bindings interface 2019-01-20 22:34:20 +01:00
username223 edbecb089e Merge branch 'master' into media-keys 2019-01-12 21:56:38 +01:00
ykeara 95b7eaa664 SteamVRTab SSOverride update (#40)
* Added Manual Override Checkbox

* added profile logic/synch fixed bug with profile

* Added Function definitions + re-arranged code into more logical blocks

* formatting and fixed reset function in steamvrtabcontroler

* updated documentation

* removed some comments(for later standardization), params as const (where applicable), changed SS minimum value to .2 to match with steamVR minimum

* changed c style cast to c++

* re-applied formatting

* removed un-used lines in steamvrtabcontroller.h
2019-01-12 14:49:07 -06:00
Vasily 566165da39 Update readme with new feature 2019-01-12 19:22:27 +01:00
ykeara ed8587703e updated documentation minor formatting change in QML 2019-01-09 20:50:50 -06:00
username223 9c7022f802 Fix QML error spam from MyStackViewPage and PlayspacePage (#24)
* Move logging set up into own function

This does not affect the ability to log, the logging macros are
available globally.

* Clean up logging logic and add comments

The logic to find the logging location was broken, in that it always
placed the logs in the directory of the executable.
It was supposed to place the logs in
AppData/Roaming/matzman666/OpenVRAdvancedSettings/AdvancedSettings.log,
but it hasn't done this since at least git tag "v2.7". Since the change
hasn't been documented anywhere it is assumed to be an unintentional
regression.
The settings file is also currently placed in
AppData/Roaming/matzman666/OpenVRAdvancedSettings.ini, so this commit
undoes the probable regression until a strategy can be developed for
changing all paths at once.

* Move command line arg logging calls and add to manifest calls

The LOG_IF macros are cleaner than if blocks, and they do not need to be
in the middle of the Qt logic inside a giant try block.

* Remove unused QCoreApplication constructor in manifest logic

The object is not used in any of the manifest logic functions and
running without the remove/install manifest calls does not use it
either.

* Unindent logic in installManifest

The error checking was unnecessarily done in an else block. Moving it
into an if block and negating the result does the same but leaves the
rest of the logic at a much smaller indentation level.

* Change array in installManifest to be 0 intialized

Not zero initializing could lead to strange bugs if the terminating null
isn't there.

* Move manifest install/removal to separate function

The manifest handling is tangential to the actual main operation of the
program, hence moving it to a separate function improves readability of
the actual program.

The enum ReturnErrorCode has also been moved to the top in order to be
available to all functions. On introspection it is revealed that it
should always have been placed at the top.

* Unindent logic in removeManifest

The logic is unnecessarily indented, leading to harder to follow logic.

While the current logic isn't that hard to understand, it's better if it
follows the same rhythm as installManifest, which errors checks the same
way with a !QFile::exists( manifestQPath ).

* Move manifestPath out of install/removeManifest

Moving the variable outside of the functions reduces code duplication
and increases the versatility of the functions.

Variable was renamed from manifestQPath to manifestPath, because the Q
does not add anything to the name except (maybe wrongfully in the
future) typing a variable that has been typed with 'auto'.

The default variable has been removed, as it did not improve readability
at all.

* Rename installManifest to handleManifestInstallLogic

The new name better reflects the overall purpose. installManifest should
be a function that only installs the manifest.

* Move manifest related things into manifest namespace

* Move manifestInstallation logic into functions

The logic becomes clearer when replaced by function names instead of
just blocks of error checking.

* Refactor installManifest into separate functions

The uses for the removeManifest and installManifest functions could be
boiled down to three separate use cases:
    * If the application was passed the "-installmanifest" arg:
        Reinstall the manifest and enable application autostart.
    * If the application was passed thed "-removemanifest" arg:
        Remove the manifest.
    * If the application was not passed "-desktop" and also not passed
    "-nomanifest" (basically every start):
        Install the manifest.

Where reinstalling means to remove the manifest if installed and then
install it.

The relatively complex logic in installManifest hid this logic behind
several if statements and changing what the "alreadyInstalled" bool
signified.

The refactored functions should make everything easier to understand.

* Add variable for manifest name

* Rename variables in main to camelCase

This appears to be the style chosen for the majority of the project.

* Change cerr to be LOG(ERROR) and add logging for manifest completion

The cerr calls are not likely to be seen by anybody. Logging them as
ERROR will make sure they are available for diagnostics.

* Add comments for new manifest functions

* Reorder namespaces and functions in main

Namespaces and functions are now ordered as they appear in main.

* Add static_cast to height and width in func call in main

width and height are "qreal" (typedef for double). Having them
implicitly cast to int leads to warnings on some compilers, and can lead
to doubt whether they're supposed to be converted.

* Move organizationName and applicationName into overlaycontroller.h

The string have been moved to static constexpr autos inside the
overlaycontroller.

Them remaining static means that they are included in the final binary,
even if they don't need to be included as static.

They should probably also not be directly gotten, instead being offered
up as static getters, but it's better to do them all at the same time in
a specific commit for that.

* Add comment to installApplicationManifest

Describing that OpenVR must be initialized before the function is
called.

* Change QApplication var name and add comments

The previous QApplication was named "a". This is obviously not
sufficient for such a large part of the application, even if the class
is rather boilerplate heavy.

* Add comments to Qt portions of main

Some things have been left uncommented. That's because I don't know what
it does.

* Change documentation for command line arguments, logging config

The information under the Desktop Mode header could be rolled under the
"-desktop" command line arg.

Support for the command line args of Easylogging++ and custom logging
files have not been supported for the original developer. Both should
probably be dropped in favor of having the same logging behavior for all
users.

* Remove error causing property from QML MyStackViewPage and PlayspacePage

The properties were causing an error message to be spammed in the log
QML QQuickText: Detected anchors on an item that is managed by a layout.
This is undefined behavior; use Layout.alignment instead.

and

QML RowLayout: Detected anchors on an item that is managed by a layout.
This is undefined behavior; use Layout.alignment instead.

Removing them fixed the spam and didn't noticeably change the appearance
of the pages.
2019-01-07 19:24:20 -06:00
Vasily 4e05e66154 Update readme and building_for_windows
Adds links to programs needed in the windows file and links to
CONTRIBUTING.md for both Windows and Linux.
2018-12-28 15:53:49 +01:00
Vasily e0de89092e Add Travis CI badge to readme
Individual badges moved to own lines for readability.
2018-12-28 03:35:07 +01:00
Vasily 4438f4cd28 Add table of contents, docs on command line args and building for windows
The current readme lacks a table of contents, which makes finding what
you're looking for difficult because of the large amount of images and
text.

The current documentation on building for windows doesn't mention the
fact that package.cmd also has to be run to create a full build. It is
also lacking in other areas, such as the packaging programs required.

The current documentation doesn't reflect the fact that you can pass
command line arguments to the program.
2018-12-25 21:44:26 +01:00
Robin Appelman 011e2ad1d2 update readme 2018-12-16 20:50:49 +01:00
Robin Appelman 99fc1848e8 update readme 2018-05-12 02:30:07 +02:00
Robin Appelman 890edf070d update readme 2018-04-03 17:27:26 +02:00
Robin Appelman 8c92892072 update readme 2018-04-02 17:34:07 +02:00
matzman 6da9e724c0 Updated Readme, project file and installer. 2017-08-15 21:55:47 +02:00
matzman 0960394335 Fixed Restart SteamVR functionality (May crash the Steam overlay when SteamVR Home is running when you restart. Therefore I advice that you close SteamVR Home before restarting).
Completely disabled sounds to see whether this fixes crashes some people are still experiencing.
Added "Enable Advanced Supersample Filtering" toggle.
2017-05-21 14:24:24 +02:00
matzman 5f7fb405ca Updated readme and version to 2.4. 2017-05-19 19:18:15 +02:00
Jules Blok 24cf4e09bc Update Readme.md 2017-02-22 22:58:27 +01:00
matzman 2baee40630 Updated readme.
Updated version to 2.3.
Some bug-fixes and improvements.
2017-02-16 22:45:36 +01:00
matzman ae23563723 Update Readme.md 2017-01-07 22:34:58 +01:00
matzman e930a63546 Updated Readme. 2017-01-07 16:42:42 +01:00
matzman 3a2472db2e Updated Readme.
Changed default logging settings.
2017-01-07 16:32:18 +01:00
matzman 072d39b771 Updated Readme and some other fixes. 2016-12-09 23:24:59 +01:00
matzman 4e6e610648 Updated readme 2016-10-28 20:06:02 +02:00
matzman 439a46ec82 Updated Readme. 2016-09-17 13:49:39 +02:00
matzman af956a8702 Updated Readme and added files missing from last commit. 2016-09-16 21:52:34 +02:00
matzman 2f9473b78f Added Readme. 2016-09-11 22:21:47 +02:00