diff --git a/Readme.md b/Readme.md
index c76019e..6cb1dd4 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,47 +1,52 @@
-
- 
+
+
[](https://ci.appveyor.com/project/icewind1991/openvr-advancedsettings/branch/master)
[](https://travis-ci.org/OpenVR-Advanced-Settings/OpenVR-AdvancedSettings)
- > * [Features](#features)
- > * [Usage](#usage)
- > * [Installer](#installer)
- > * [Standalone](#standalone)
- > * [Bindings](#bindings)
- > * [Default Bindings](#default_bindings)
- > * [SteamVR Input Guide](#steamvr_input_guide)
- > * [Command Line Arguments](#command_line_arguments)
- > * [Preview Builds](#preview_builds)
- > * [Documentation](#documentation)
- > * [Top Page](#top_page)
- > * [SteamVR Page](#steamvr_page)
- > * [Chaperone Page](#chaperone_page)
- > * [Chaperone Proximity Warning Settings Page](#chaperone_proximity_page)
- > * [Space Offset](#space_offset_page)
- > * [Motion Page](#motion_page)
- > * [Space Fix Page](#space_fix_page)
- > * [Audio Page](#audio_page)
- > * [Video Page](#video_page)
- > * [Utilities Page](#utilities_page)
- > * [Desktop Overlay Page](#desktop_overlay_page)
- > * [Statistics Page](#statistics_page)
- > * [Settings Page](#settings_page)
- > * [How To Compile](#how_to_compile)
- > * [Building on Windows](#building_on_windows)
- > * [Building on Linux](#building_on_linux)
- > * [Notes](#notes)
- > * [License](#license)
-
-
# OpenVR Advanced Settings Overlay
+- [Features](#features)
+- [Usage](#usage)
+ * [Installer](#installer)
+ * [Standalone](#standalone)
+ * [Bindings](#bindings)
+ + [Music](#music)
+ + [Motion](#motion)
+ + [Misc.](#misc)
+ + [Haptics.](#haptics)
+ * [Default Bindings](#default-bindings)
+ + [Vive Wands](#vive-wands)
+ + [Knuckles](#knuckles)
+ + [Other Controllers](#other-controllers)
+ * [SteamVR Input Guide](#steamvr-input-guide)
+ * [Command Line Arguments](#command-line-arguments)
+ * [Preview builds](#preview-builds)
+- [Documentation](#documentation)
+ * [Top Page:](#top-page-)
+ * [- SteamVR Page:](#--steamvr-page-)
+ * [- Chaperone Page:](#--chaperone-page-)
+ * [- Chaperone Proximity Warning Settings Page:](#--chaperone-proximity-warning-settings-page-)
+ * [- Space Offset Page:](#--space-offset-page-)
+ * [- Motion Page:](#--motion-page-)
+ * [- Space Fix Page:](#--space-fix-page-)
+ * [- Audio Page:](#--audio-page-)
+ * [- Video Page:](#--video-page-)
+ * [- Utilities Page:](#--utilities-page-)
+ * [- Desktop Overlay Page](#--desktop-overlay-page)
+ * [- Statistics Page:](#--statistics-page-)
+ * [- Settings Page:](#--settings-page-)
+- [How to Compile](#how-to-compile)
+ * [Building on Windows](#building-on-windows)
+ * [Building on Linux](#building-on-linux)
+- [Notes:](#notes-)
+- [License](#license)
+
Adds an overlay to the OpenVR dashboard that allows access to advanced settings.
-
# Features
- Set supersampling values.
@@ -69,17 +74,14 @@ Adds an overlay to the OpenVR dashboard that allows access to advanced settings.
- Removed forced on Die-in-Game Die-in-Life setting.
- Bind VR controller buttons to send keyboard inputs (for example to mute VOIP applications while in VR). [Tutorial](docs/keyboard_input_guide.md).
-
# Usage
-
## Installer
Download the newest installer from the [release section](https://github.com/OpenVR-Advanced-Settings/OpenVR-AdvancedSettings/releases) and execute it.
If you have an older standalone version installed, the installer will automatically uninstall the old version and install the new version.
-
## Standalone
Download the newest standalone archive from the [release section](https://github.com/OpenVR-Advanced-Settings/OpenVR-AdvancedSettings/releases) and unpack the archive.
@@ -88,7 +90,6 @@ To install for the first time simply start AdvancedSettings.exe once while Steam
To upgrade an existing installation first stop SteamVR and delete the old application folder (or override it). Then start SteamVR and run AdvancedSettings.exe once.
-
## Bindings
The following actions currently exist:
@@ -153,7 +154,6 @@ Actions to be handled by the system.
| Haptics Right | Vibration | Handle for haptic events on the Right Controller. |
-
## Default Bindings
### Vive Wands
@@ -181,14 +181,12 @@ Actions to be handled by the system.
No current default bindings you will have to make your own.
-
## SteamVR Input Guide
A Guide to the SteamVR Input System can be found [here](docs/SteamVRInputGuide.md)
**Or** a Video guide by Kung can be found [here](https://youtu.be/2ZHdjOfnqOU)
-
## Command Line Arguments
The application (`AdvancedSettings.exe`) can be run with the following optional arguments:
@@ -203,17 +201,14 @@ The application (`AdvancedSettings.exe`) can be run with the following optional
`"--force-remove-manifest"`: Force uninstalls the `.vrmanifest`. This should be done every time the application is uninstalled. On Windows it is automatically done by the uninstaller. The program will exit early when this flag is set.
-
## Preview builds
If you want to try latest and greatest unreleased features, you can download the latest from the CI (Continuous Integration) server for [Windows](https://ci.appveyor.com/project/icewind1991/openvr-advancedsettings/branch/master). The Linux CI does not provide binary artifacts.
These version are not stable and this should be considered for advanced users only.
-
# Documentation
-
## Top Page:
@@ -223,7 +218,6 @@ These version are not stable and this should be considered for advanced users on
- **Microphone**: Allows to set the microphone volume and to mute/unmute it.
- **Push-to-Talk**: Enable/disable push-to-talk.
-
## - SteamVR Page:
@@ -234,7 +228,6 @@ These version are not stable and this should be considered for advanced users on
- **Enable Manual Supersampling Override**: Enables user control of Supersampling, instead of SteamVR auto profiles.
- **Enable Motion Smoothing**: Enables Motion Smoothing, and disables asynchronous reprojection.
- **Restart SteamVR**: Restart SteamVR (May crash the Steam overlay when SteamVR Home is running when you restart. Therefore I advice that you close SteamVR Home before restarting).
-
## - Chaperone Page:
@@ -251,7 +244,6 @@ These version are not stable and this should be considered for advanced users on
- **Flip Orientation**: Flips the orientation of the play space.
- **Reload from Disk**: Reloads the chaperone bounds geometry from disk.
-
## - Chaperone Proximity Warning Settings Page:
@@ -264,7 +256,6 @@ These version are not stable and this should be considered for advanced users on
- **Open dashboard**: Opens the dashboard when the user's distance to the chaperone falls below the configured activation distance. The idea is to pause the game (most single-player games auto-pause when the dashboard is shown) to give the user time for reorientation.
- **Velocity Dependent Fade/Activation Distance**: Dynamically modifies the chaperone's fade distance and the proximity warning's activation distance as a function of the player's speed. The used formula is: *distance = old_distance * ( 1 + distance_modifier * max(left_controller_speed, right_controller_speed, hmd_speed) )*
-
## - Space Offset Page:
@@ -274,7 +265,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Adjust Chaperone**: When enabled, the chaperone bounds stay accurate even when the playspace is moved or rotated (so noone gets hurt). Depending on chaperone mode this may or may not adjust with height.
- **Seated Recenter**: When clicked, applies the current location and angle of the headset to the offsets such that the user is brought to a centered position. Also applies the current headset height to the default seated height (not visible in offsets). This action will also be activated automatically when a seated application sends a reset center command. *Note: This button is only visible when running seated applications.*
-
## - Motion Page:
@@ -296,7 +286,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **fling Strength**: adjusts the strength at which you "throw" yourself with space drag feature.
- **Snap Turn**: Allows snap (instant) turning by the specified angle. Can type in values or use the preset buttons for angles that neatly divide 360 degrees. Must bind actions via SteamVR Input interface.
-
## - Space Fix Page:
@@ -306,7 +295,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Undo Fix** Removes last "fix" **(Temporarily disabled pending integration into new motion system.)**
- **Apply Space Settings Offsets as Center** Takes current values from Offsets page and re-caliberates center/rotation. **Caution** The reset function will then refer to this location as the new zero location, overriding the old zero location.
-
## - Audio Page:
@@ -320,7 +308,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **NOTE**: The Push-to-talk box must be enabled for this feature to work.
- **Audio Profile**: Allows you to apply/define/delete audio profiles that save playback devices, mute state, and volume.
-
## - Video Page:
@@ -330,7 +317,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Brightness**: The amount of dimming.
- **Note**: Does not necessarily reduce light output of HMD will vary based on panel type etc.
-
## - Utilities Page:
@@ -341,7 +327,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Media Control Keys:** Allows controlling a media player through the media keys. This is the same as having a keyboard with media keys and then pressing them. Should support most common media players.
-
## - Desktop Overlay Page
@@ -354,7 +339,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Left/Right Translation:** Moves the overlay left or right.
-
## - Statistics Page:
@@ -369,7 +353,6 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Timed Out**: Number of times the currently running application timed out.
- **Reprojection Ratio**: Ratio of presented frames to reprojected frames.
-
## - Settings Page:
@@ -379,20 +362,16 @@ Allows users to temporarily move and rotate the center of the playspace. This al
- **Allow External App Chaperone Edits:** Incorporates changes to the chaperone and universe center made by other applications. These changes could come from anywhere, including apps with unpredictable interactions with Advanced Settings. Therefore, this option opens the potential for chaperone misalignment or corruption. However it also allows other chaperone tweaking tools to function in tandem with Advanced Settings. **This option should only be checked if required for compatibility with other apps.** *Note: Changes will only take effect when offsets and rotation are all zero.*
- **Old-Style Motion:** Uses the old system of writing the chaperone universe center and bounds to disk every frame. Use this option only if you experience issues with playspace motion such as snapping back to reset position after releasing a space-drag. This old mode is smooth on most systems but is in theory less performant than the normal method.
-
# How to Compile
-
## Building on Windows
Full build instructions can be found [here](docs/building_for_windows.md).
-
## Building on Linux
Full build instructions can be found [here](docs/building_for_linux.md).
-
# Notes:
- The center marker and the play space marker are provided by the chaperone subsystem, and therefore they will have the same color and visibility settings as the chaperone bounds.
@@ -401,7 +380,6 @@ Full build instructions can be found [here](docs/building_for_linux.md).
- You can modify the shutdown wait time when restarting SteamVR by opening restartvrserver.bat and changing the number behind "timeout /t" (unit is seconds).
-
# License
This software is released under GPL 3.0.