Skip to content

Commit

Permalink
Added Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
matzman666 committed Sep 11, 2016
1 parent 13552f2 commit 2f9473b
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

![language](https://img.shields.io/badge/Language-C%2B%2B11-green.svg) ![dependencies](https://img.shields.io/badge/Dependencies-OpenVR%2C%20Qt5-green.svg) ![license_gpl3](https://img.shields.io/badge/License-GPL%203.0-green.svg)

# OpenVR Advanced Settings Overlay

Adds an overlay to the OpenVR dashboard that allows access to advanced settings.

# Features
## - Chaperone Settings Tab:
- **Center Marker**: Displays a marker that represents the center of the playspace.
- **Play Space Maker**: Displays the outlines of the rectangle representing the playspace.
- **Force Bounds**: Force chaperone bounds always on.
- **Fade Distance**: Allows to configure the distance at which the chaperone bounds are shown. When set to 0 chaperone bounds are completely invisible.
- **Chaperone Bounds Visibility**: Allows to configure the visibility of the chaperone bounds. Unlike the slider in the chaperone settings, this one is not capped at 30%. When set to 0 chaperone bounds are completely invisible.

## - Move Center Tab:
Allows to temporarily move the center of the playspace. This allows to reach interaction elements that are just inside our real-world walls or otherwise inaccessible (e.g. when your playspace is smaller than the recommended one). Can also be used to discover the terrors that lie outside of the intended playspace (ever wondered what's behind the door in The Lab?).

## - Fix Floor Tab:

Allows you to fix the height of your floor. Just place one controller on your floor and press the button.

## - Settings Tab:

- **Auto Start Toggle:** Allows you to enable/disable auto start.

# 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.

# Usage

Just start the executable once. It will register with OpenVR and automatically start whenever OpenVR starts (Can be disabled in the settings).

# Known Bugs

- Center Marker and Playspace Marker are sometimes not working in the SteamVR room. My observation is that you have to start an application first before they are shown in the SteamVR room.

# License

This software is released under GPL 3.0.

0 comments on commit 2f9473b

Please sign in to comment.