ValveSoftware · NoeTardy · Apr 23, 2016 · Apr 23, 2016 · Apr 23, 2016 · Apr 23, 2016
diff --git a/Paths.props b/Paths.props
@@ -2,10 +2,10 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <ImportGroup Label="PropertySheets" />
   <PropertyGroup Label="UserMacros">
-    <SteamVRRuntimeDir>C:\Program Files (x86)\steam\steamapps\common\SteamVR</SteamVRRuntimeDir>
-    <OpenVRDir>d:\dev\openvr_hydra\sdk_20160123</OpenVRDir>
-    <SixenseSDKDir>C:\Program Files (x86)\steam\steamapps\common\Sixense SDK\SixenseSDK</SixenseSDKDir>
-    <InstallDir>D:\dev\hydra</InstallDir>
+    <SteamVRRuntimeDir>D:\Steam\steamapps\common\SteamVR</SteamVRRuntimeDir>
+    <OpenVRDir>C:\Users\Christian Buchner\Documents\Visual Studio 2015\Projects\Leap\openvr-1.0.0</OpenVRDir>
+    <LeapSDKDir>C:\Users\Christian Buchner\Documents\Visual Studio 2015\Projects\Leap\LeapSDK</LeapSDKDir>
+    <InstallDir>D:\Steam\steamapps\common\SteamVR\drivers\leap</InstallDir>
   </PropertyGroup>
   <PropertyGroup />
   <ItemDefinitionGroup />
@@ -16,8 +16,8 @@
     <BuildMacro Include="OpenVRDir">
       <Value>$(OpenVRDir)</Value>
     </BuildMacro>
-    <BuildMacro Include="SixenseSDKDir">
-      <Value>$(SixenseSDKDir)</Value>
+    <BuildMacro Include="LeapSDKDir">
+      <Value>$(LeapSDKDir)</Value>
     </BuildMacro>
     <BuildMacro Include="InstallDir">
       <Value>$(InstallDir)</Value>

diff --git a/README.md b/README.md
@@ -1,12 +1,119 @@
-# Razer Hydra Driver for SteamVR
+# Leap Motion Driver for SteamVR
 
-## Building
+## Installation of this driver.
+
+- Get the Leap Motion Orion Beta runtimes https://developer.leapmotion.com/get-started
+- Install the Visual C++ 2015 Update 2 redistributables (32 and 64 bits) https://www.microsoft.com/en-us/download/details.aspx?id=51682
+- Download the most recent zip file from the Releases section of this project and run the contained exe setup program https://github.com/cbuchner1/driver_leap/releases
+
+Start SteamVR to see if two additional controllers show up (they should be blinking if your hands are
+not in the field of view of the Leap Motion, solid otherwise).
+
+### Troubleshooting
+
+If you experience frequent crashes of SteamVR on exit and this bothers you, uninstall my driver. I will try to fix this ASAP, but at the moment I have no clue why SteamVR is crashing.
+
+
+## Note about WORK IN PROGRESS
+
+You're seeing an early version of this software. I've got positional tracking established now as well as hand pose tracking. Some experimental mappings of hand gestures to triggers and buttons were added:
+
+Trigger:
+- bending of the index finger maps to the trigger button, like you would fire a gun.
+
+Grip:
+- clenching the middle, ring, pinky finger to a fist maps to the grabbing buttons
+
+Trackpad:
+- the thumbpress gesture (just point the thumb in the direction of your palm) touches and clicks the trackpad, depending on the intensity of your gesture.
+- pointing the index finger towards the are of the other hand's palm will emulate the touchpad. To press the touchpad in the desired position use the tumbpress gesture simultaneously while pointing.
+
+Menu buttons:
+- Flat hand held in front of you, palm towards face is used for application menu button
+- the Timeout pose (as used in sports), registers as the system menu button
+
+
+Swapped hands?
+
+when SteamVR confuses the left and right controller hands (which will be indicated by little hand icons shown near the bottom of the displayed Wand controllers), simply cross your hands the first time you bring them into view after starting SteamVR. This reverses the hand assignment and can improve the gaming experience for example in Audioshield.
+
+
+
+
+I am working on allowing to freely map gestures to buttons in the steamvr.vrsettings config file in your Steam\config folder. However note that the "leap_gestures" section is currently not parsed yet. It's merely a sign of things to come.
+
+## Supported gestures
+
+There are other gestures detected currently, but not mapped to buttons. If you want to try these out, click on the application "gesture_checker.exe" in the directory C:\Program Files (x86)\SteamVR Leap Motion driver\leap\bin\Win32
+
+Then I also recommend that you simultaneously bring up your Leap Motion's settings and from there start the diagnostic visualizer (the windowed version, not the VR one). Press "v" once to switch it to headmount optimized mode.
+
+Now pull both windows side by side and bring a hand into view. The command prompt running the gesture_checker program should output a series of numbers next to the names of the gestures. A "1.0" means confidential detection, a "0.0" means no detection.
+
+You can practise some gestures this way and also cross-check your pose in the Leap Motion diagnostic visualizer against the detection confidence.
+
+        // Finger gestures (these would not throw your hand's orientation off much)
+        TriggerFinger,           // bend your index finger as if pulling a trigger
+        LowerFist,               // grab with your middle, ring, pinky fingers
+        Pinch,                   // pinch with your thumb and index fingers
+        Thumbpress,              // point the thumb towards the direction of your pinky
+
+        // Hand gestures (these would significantly change the orientation of your hand)
+        FlippingTheBird,         // flip someone off with your middle finger
+        ILY,                     // pinky and index finger extended, middle and ring bent
+        Victory,                 // V shape with your index, middle fingers, other fingers curled
+        FlatHandPalmUp,          // flat hand, palm points upwards (relative to alignment of Leap!)
+        FlatHandPalmDown,        // flat hand, palm points downwards (relative to alignment of Leap!)
+        FlatHandPalmAway,        // flat hand, palm points away from self (relative to alignment of Leap!)
+        FlatHandPalmTowards,     // flat hand, palm points towards self (relative to alignment of Leap!)
+        ThumbUp,                 // thumb points up, remaining fingers form a fist
+        ThumbInward,             // thumb points towards the left for the right hand and vice versa
+
+        // Two handed gestures
+        Timeout,                 // both Hands form a T shape, signals a Timeout in sports
+        TouchpadAxisX,           // Touchpad emulation: index finger of other hand points towards palm 
+        TouchpadAxisY,           // Touchpad emulation: index finger of other hand points towards palm 
+
+
+### Games/Experiences that work mostly
+
+- the Blu (all three stages)
+- Irrational Exuberance: Prologue
+- the Rose and I
+- The Lab (some experiences work, others are tricky)
+- Final Approach
+- Audioshield: somehow the controllers are swapped? Control is tricky and not very precise. Semi-playable though.
+
+### Games/Experiences that are starting but not quite playable yet.
+
+- Tilt Brush: starts and you can start doing things, but there is lack of complete trackpad support in my driver.
+- Brookhaven Experiment: tracking only works while SteamVR window is in focus. Why? Gun in right hand needs a 60 degree uptilt angle (define this in steamvr.vrsettings config file in Steam config folder). Trigger gesture detection is way to imprecise, you won't even survive the first wave of Zombies.
+
+
+### Demos that won't work at all
+- n/a
+
+
+## Known Issues
+
+I am seeing SteamVR Server crash on shutdown a lot. This could be related to my driver, but I have not yet found the root cause for the crash.
+
+The Brookhaven experiment seems to steal focus from StreamVR, so that Steam does not get any position tracking. Clicking on the SteamVR window restores tracking, but mutes the audio on Brookhaven. Meh.
+
+Some games work better when no grip angle is added to the controller pose, other games actually require a steep angle to be playable (Brookhaven, Audioshield). We may have to add a feature to chose the preferred default pose at runtime.
+
+Tracking is not quite reliable to always detect my trigger gestures. I think we will have to integrate small handheld controllers like the Wiimote or the Playstation Move Navigation controller in the future.
+
+I do not think I will be able to get animated hands into the 3D view, as the render model you can assign to each controller is mostly a static object. There are some JSON files to map joystick axes and triggers to animated parts of the displayed controller. But the fingers do not directly map to joystick axes directly and hence cannot be shown. Also not all games make use of SteamVR's internal controller visualization.
+
+
+## Building from Sourcecode (Developers only)
 
 ### Install Dependencies
 
 1. Install SteamVR.  It is under "Tools" in everyone's Steam Library.  steam://install/250820
-2. Install "Sixense SDK for the Razer Hydra".  It is also under "Tools".  steam://install/42300
-3. Fetch the OpenVR SDK 0.9.19 from https://github.com/ValveSoftware/openvr .  That version SHA is f1ffbf4e92f383bdb453d58f9583c51a5ec350d9.  Newer version should also work with minor changes.
+2. Install "Leap Motion Orion SDK V3.1.2".  https://developer.leapmotion.com/get-started
+3. Fetch the OpenVR SDK 1.0.0 from https://github.com/ValveSoftware/openvr .
 
 The solution and project files are for Visual Studio 2015.
 
@@ -18,7 +125,7 @@ Under "Property Manager" in Visual Studio, expand any of the configurations and
 
 You will probably want to build Release x86.  You can also build x64.  The post-build step will install the binaries and copy the resources to the configured InstallDir and register that path with SteamVR.
 
-## Using The Hydra Driver 
+## Preapring The Leap Motion Driver for use (Developers only)
 
 After building, the InstallDir should be a complete binary distribution.  To use it:
 
@@ -32,25 +139,23 @@ After building, the InstallDir should be a complete binary distribution.  To use
 }```
 3. If you are trying to use the Hydra driver without an HMD, you might want to enable driver_null (no HMD) or set "requireHmd": false.
 
-After starting SteamVR, you should see controllers blinking in the status window.  Inside the HMD you will see instructions to get the Hydra coordinates aligned with your HMD.  Once you do, the controllers will turn solid green.
+After starting SteamVR, you should see controllers blinking in the status window until you move your hands into the field of view.
 
 You can use "vrcmd" (with no arguments) to see a list of devices to verify things are working.
 use "vrcmd" to verify things are loading:
 
 ```...
-Driver hydra : 2 displays
-        Hydra (Serial number hydra0_controller0)
-        Hydra (Serial number hydra0_controller1)
+Driver leap : 2 displays
+        leap (Serial number leap0_lefthand)
+        leap (Serial number leap0_righthand)
 ...
 ```
 
-You can also use "vrcmd --pollposes" (followed by an index number to limit the output) to see things are working.
+You can also use "vrcmd --pollposes" (followed by an index number to limit the output) to see if things are working.
 
 ## Licenses
 
 The code in this distribution is distributed under the terms of the LICENSE file in the root directory.
 
-The render models are based on work by Zoltan Erdokovy <[email protected]> with permission.
-
-The compiled driver and the install directory use the Sixense SDK.  That development kit has a license which requires copyright acknowledgement for distribution.  See the EULA that is displayed when installing the Sixense SDK.
-
+The compiled driver and the install directory use the Leap Motion Orion SDK.  Use subject to the terms of the Leap Motion SDK Agreement available at
+https://developer.leapmotion.com/sdk_agreement.
diff --git a/driver_hydra.sln b/driver_hydra.sln
diff --git a/driver_leap.sln b/driver_leap.sln
@@ -0,0 +1,68 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 14
+VisualStudioVersion = 14.0.25123.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "driver_leap", "drivers\driver_leap\driver_leap.vcxproj", "{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "leap_monitor", "tools\leap_monitor\leap_monitor.vcxproj", "{BC06AF9C-36D6-455A-B421-00A9635684AD}"
+EndProject
+Project("{54435603-DBB4-11D2-8724-00A0C9A8B90C}") = "leap_installer", "tools\leap_installer\leap_installer.vdproj", "{60517323-2772-4341-9161-56C776DC1840}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "gesture_checker", "tools\gesture_checker\gesture_checker.vcxproj", "{9C28E205-C4CD-43D4-91BC-4852D7A588EC}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "config_tool", "tools\config_tool\config_tool.vcxproj", "{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Debug|x64.ActiveCfg = Debug|x64
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Debug|x64.Build.0 = Debug|x64
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Debug|x86.ActiveCfg = Debug|Win32
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Debug|x86.Build.0 = Debug|Win32
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Release|x64.ActiveCfg = Release|x64
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Release|x64.Build.0 = Release|x64
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Release|x86.ActiveCfg = Release|Win32
+		{52D3F16D-A7A5-4D6F-8F17-5E4B459A1440}.Release|x86.Build.0 = Release|Win32
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Debug|x64.ActiveCfg = Debug|x64
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Debug|x64.Build.0 = Debug|x64
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Debug|x86.ActiveCfg = Debug|Win32
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Debug|x86.Build.0 = Debug|Win32
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Release|x64.ActiveCfg = Release|x64
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Release|x64.Build.0 = Release|x64
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Release|x86.ActiveCfg = Release|Win32
+		{BC06AF9C-36D6-455A-B421-00A9635684AD}.Release|x86.Build.0 = Release|Win32
+		{60517323-2772-4341-9161-56C776DC1840}.Debug|x64.ActiveCfg = Debug
+		{60517323-2772-4341-9161-56C776DC1840}.Debug|x64.Build.0 = Debug
+		{60517323-2772-4341-9161-56C776DC1840}.Debug|x86.ActiveCfg = Debug
+		{60517323-2772-4341-9161-56C776DC1840}.Debug|x86.Build.0 = Debug
+		{60517323-2772-4341-9161-56C776DC1840}.Release|x64.ActiveCfg = Release
+		{60517323-2772-4341-9161-56C776DC1840}.Release|x64.Build.0 = Release
+		{60517323-2772-4341-9161-56C776DC1840}.Release|x86.ActiveCfg = Release
+		{60517323-2772-4341-9161-56C776DC1840}.Release|x86.Build.0 = Release
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Debug|x64.ActiveCfg = Debug|x64
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Debug|x64.Build.0 = Debug|x64
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Debug|x86.ActiveCfg = Debug|Win32
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Debug|x86.Build.0 = Debug|Win32
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Release|x64.ActiveCfg = Release|x64
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Release|x64.Build.0 = Release|x64
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Release|x86.ActiveCfg = Release|Win32
+		{9C28E205-C4CD-43D4-91BC-4852D7A588EC}.Release|x86.Build.0 = Release|Win32
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Debug|x64.ActiveCfg = Debug|x64
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Debug|x64.Build.0 = Debug|x64
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Debug|x86.ActiveCfg = Debug|Win32
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Debug|x86.Build.0 = Debug|Win32
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Release|x64.ActiveCfg = Release|x64
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Release|x64.Build.0 = Release|x64
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Release|x86.ActiveCfg = Release|Win32
+		{FD2D3DBF-C82D-4333-9710-7DD2C51FA8E1}.Release|x86.Build.0 = Release|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal