Skip to content

Latest commit

 

History

History
65 lines (54 loc) · 3.19 KB

Configuration.md

File metadata and controls

65 lines (54 loc) · 3.19 KB

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 mode1 meters 0.0
hmd_offset_y Y-axis tracker offset for HMD mode1 meters 0.0
hmd_offset_z Z-axis tracker offset for HMD mode1 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 trackers2 true/false true
external_input_only Disable driver input (for external input)3 true/false false
extended_hand_profile Extended hand-profile support (for external input) true/false false

Example

A simplified example of the steamvr.vrsettings would look like the following:

{
  "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 before saving.

Footnotes

  1. HMD offsets follow the OpenXR View space convention. ↩ ↩2 ↩3

  2. Enabling this feature adds two completely separate trackers in addition to the hand trackers purely for the elbow positions (one for each arm). ↩

  3. This setting blocks all inputs from the internal implementation of the driver. This is particularly useful if you want to use the DebugRequest API to drive inputs and prevent them from getting overridden. ↩