-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move configuration to a seperate documentation file
- Loading branch information
1 parent
e013f74
commit c6d7420
Showing
5 changed files
with
91 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,33 @@ | ||
| # Ultraleap SteamVR Driver | ||
| <p align="center"> | ||
| <a href="https://ultraleap.com#gh-light-mode-only"><img height="33%" width="33%" style="margin-bottom: -60px" alt="Ultraleap" src="doc/UltraleapLogoColor.png" /></a> | ||
| <a href="https://ultraleap.com#gh-dark-mode-only"><img height="33%" width="33%" style="margin-bottom: -60px" alt="Ultraleap" src="doc/UltraleapLogoDarkMode.png" /></a> | ||
| </p> | ||
|
|
||
| This is the official Ultraleap driver for SteamVR, supporting using your hands as a first class input system. | ||
| <span align="center"> | ||
|
|
||
| # SteamVR Driver | ||
|
|
||
| </span> | ||
|
|
||
| [](https://github.com/rblenkinsopp/driver_ultraleap/actions/workflows/build.yml) | ||
| <p align="center"> | ||
| <img height="32px" width="32px" alt="LMC" src="ultraleap/resources/icons/[email protected]" /> | ||
| <img height="32px" width="32px" alt="SIR170" src="ultraleap/resources/icons/[email protected]" /> | ||
| <img height="32px" width="32px" alt="3di" src="ultraleap/resources/icons/[email protected]" /> | ||
| <img height="32px" width="32px" alt="LMC2" src="ultraleap/resources/icons/[email protected]" /> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| This is the official Ultraleap driver for SteamVR, supporting using your hands as a first class input system. | ||
| </p> | ||
|
|
||
| ## Supported devices | ||
|
|
||
| This driver supports the follow Ultraleap/Leap Motion devices | ||
|
|
||
| | Device Name | Icon | | ||
| |:-------------------------|-------------------------------------------------------------------------------------| | ||
| | Leap Motion Controller |  | | ||
| | Leap Motion Controller 2 |  | | ||
| | Ultraleap 3di |  | | ||
| | Ultraleap StereoIR 170 |  | | ||
| * Leap Motion Controller | ||
| * Leap Motion Controller 2 | ||
| * Ultraleap 3di | ||
| * Ultraleap StereoIR 170 | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -27,63 +41,8 @@ This driver supports the follow Ultraleap/Leap Motion devices | |
|
|
||
| ## Configuration | ||
|
|
||
| The driver comes with some configurable options and predefined defaults which the user can change if desired. | ||
| To overwrite the defaults navigate to `${SteamInstallFolder}/config` and edit the `steamvr.vrsettings` file | ||
| whilst SteamVR **isn't** open. | ||
|
|
||
| When adding the following key value pair configurations, ensure that they are only added under the | ||
| `driver_ultraleap` section. Any values that aren't defined in `steamvr.vrsettings` will fallback to defaults, | ||
| so you should only redefine the ones you actively want changed. | ||
|
|
||
| ### Valid Configuration Keys | ||
|
|
||
| | Key | Description | Type/Values | Default | | ||
| |-------------------------|----------------------------------------------------|------------------|---------| | ||
| | `tracker_mode` | Sets the requested tracking mode | `hmd`, `desktop` | `hmd` | | ||
| | `hmd_offset_x` | X-axis tracker offset for HMD mode | _meters_ | `0.0` | | ||
| | `hmd_offset_y` | Y-axis tracker offset for HMD mode | _meters_ | `0.0` | | ||
| | `hmd_offset_z` | Z-axis tracker offset for HMD mode | _meters_ | `-0.08` | | ||
| | `desktop_offset_x` | X-axis tracker offset for desktop mode | _meters_ | `0.0` | | ||
| | `desktop_offset_y` | Y-axis tracker offset for desktop mode | _meters_ | `-0.2` | | ||
| | `desktop_offset_z` | Z-axis tracker offset for desktop mode | _meters_ | `-0.35` | | ||
| | `enable_elbow_trackers` | Enable elbow trackers | `true`/`false` | `true` | | ||
| | `external_input_only` | Disable driver input (for external input) | `true`/`false` | `false` | | ||
| | `extended_hand_profile` | Extended hand-profile support (for external input) | `true`/`false` | `false` | | ||
|
|
||
| > **NOTE:** HMD offsets follow | ||
| > the [OpenXR View space convention](https://openxr-tutorial.com/windows/opengl/_images/ViewSpace.png). | ||
| ### Example | ||
|
|
||
| A simplified example of the `steamvr.vrsettings` would look like the following: | ||
|
|
||
| ```json | ||
| { | ||
| "DesktopUI": { | ||
| "controllerbinding_desktop": "151,39,1920,1073,0" | ||
| }, | ||
| "GpuSpeed": { | ||
| "gpuSpeedRenderTargetScale": 1.5, | ||
| "gpuSpeedVendor": "NVIDIA GeForce RTX 3080 Ti Laptop GPU" | ||
| }, | ||
| "LastKnown": { | ||
| "ActualHMDDriver": "holographic", | ||
| "HMDManufacturer": "WindowsMR", | ||
| "HMDModel": "Perception Simulation Headset0" | ||
| }, | ||
| "driver_ultraleap": { | ||
| "blocked_by_safe_mode": false, | ||
| "orientation": "Desktop" | ||
| }, | ||
| "steamvr": { | ||
| "showAdvancedSettings": true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| > **NOTE**: This settings file _must_ be valid JSON. Errors like additional trailing commas will cause issues | ||
| > when loading settings, resulting in default values being used instead. Ensure you check your JSON with a suitable | ||
| > [JSON validator](https://jsonlint.com/) before saving. | ||
| The SteamVR driver supports a number of configuration options which are details in | ||
| the [configuration guide](doc/Configuration.md). | ||
|
|
||
| ## Uninstallation | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Configuration | ||
|
|
||
| The driver comes with some configurable options and predefined defaults which the user can change if desired. | ||
| To overwrite the defaults navigate to `${SteamInstallFolder}/config` and edit the `steamvr.vrsettings` file | ||
| whilst SteamVR **isn't** open. | ||
|
|
||
| When adding the following key value pair configurations, ensure that they are only added under the | ||
| `driver_ultraleap` section. Any values that aren't defined in `steamvr.vrsettings` will fallback to defaults, | ||
| so you should only redefine the ones you actively want changed. | ||
|
|
||
| ## Valid Configuration Keys | ||
|
|
||
| | Key | Description | Type/Values | Default | | ||
| |-------------------------|----------------------------------------------------|------------------|---------| | ||
| | `tracker_mode` | Sets the requested tracking mode | `hmd`, `desktop` | `hmd` | | ||
| | `hmd_offset_x` | X-axis tracker offset for HMD mode | _meters_ | `0.0` | | ||
| | `hmd_offset_y` | Y-axis tracker offset for HMD mode | _meters_ | `0.0` | | ||
| | `hmd_offset_z` | Z-axis tracker offset for HMD mode | _meters_ | `-0.08` | | ||
| | `desktop_offset_x` | X-axis tracker offset for desktop mode | _meters_ | `0.0` | | ||
| | `desktop_offset_y` | Y-axis tracker offset for desktop mode | _meters_ | `-0.2` | | ||
| | `desktop_offset_z` | Z-axis tracker offset for desktop mode | _meters_ | `-0.35` | | ||
| | `enable_elbow_trackers` | Enable elbow trackers | `true`/`false` | `true` | | ||
| | `external_input_only` | Disable driver input (for external input) | `true`/`false` | `false` | | ||
| | `extended_hand_profile` | Extended hand-profile support (for external input) | `true`/`false` | `false` | | ||
|
|
||
| > **NOTE:** HMD offsets follow | ||
| > the [OpenXR View space convention](https://openxr-tutorial.com/windows/opengl/_images/ViewSpace.png). | ||
| ## Example | ||
|
|
||
| A simplified example of the `steamvr.vrsettings` would look like the following: | ||
|
|
||
| ```json | ||
| { | ||
| "DesktopUI": { | ||
| "controllerbinding_desktop": "151,39,1920,1073,0" | ||
| }, | ||
| "GpuSpeed": { | ||
| "gpuSpeedRenderTargetScale": 1.5, | ||
| "gpuSpeedVendor": "NVIDIA GeForce RTX 3080 Ti Laptop GPU" | ||
| }, | ||
| "LastKnown": { | ||
| "ActualHMDDriver": "holographic", | ||
| "HMDManufacturer": "WindowsMR", | ||
| "HMDModel": "Perception Simulation Headset0" | ||
| }, | ||
| "driver_ultraleap": { | ||
| "blocked_by_safe_mode": false, | ||
| "orientation": "Desktop" | ||
| }, | ||
| "steamvr": { | ||
| "showAdvancedSettings": true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| > **NOTE**: This settings file _must_ be valid JSON. Errors like additional trailing commas will cause issues | ||
| > when loading settings, resulting in default values being used instead. Ensure you check your JSON with a suitable | ||
| > [JSON validator](https://jsonlint.com/) before saving. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters