More project restructuring

Author: terminal29

.gitignore

@@ -1 +1,2 @@
-/build
+/build
+/CMakeFiles

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION "3.7.1")
 
 # Solution
-project("driver_example")
+project("Simple_SteamVR_Driver_Tutorial")
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
 # Deps
@@ -25,33 +25,34 @@ endif()
 find_library(OPENVR_LIB openvr_api HINTS "${CMAKE_CURRENT_SOURCE_DIR}/libraries/openvr/lib/${PLATFORM_NAME}${PROCESSOR_ARCH}/" NO_DEFAULT_PATH )
 
 # Example Driver
-set(EXAMPLE_PROJECT "driver_example")
-file(GLOB_RECURSE HEADERS "${EXAMPLE_PROJECT}/src/*.hpp")
-file(GLOB_RECURSE SOURCES "${EXAMPLE_PROJECT}/src/*.cpp")
+set(DRIVER_NAME "example")
+set(EXAMPLE_PROJECT "driver_${DRIVER_NAME}")
+file(GLOB_RECURSE HEADERS "${CMAKE_CURRENT_SOURCE_DIR}/driver_files/src/*.hpp")
+file(GLOB_RECURSE SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/driver_files/src/*.cpp")
 add_library("${EXAMPLE_PROJECT}" SHARED "${HEADERS}" "${SOURCES}")
 
 target_include_directories("${EXAMPLE_PROJECT}" PUBLIC "${OPENVR_INCLUDE_DIR}")
 target_include_directories("${EXAMPLE_PROJECT}" PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/libraries/linalg")
-target_include_directories("${EXAMPLE_PROJECT}" PUBLIC "${EXAMPLE_PROJECT}/src/")
+target_include_directories("${EXAMPLE_PROJECT}" PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/driver_files/src/")
 target_link_libraries("${EXAMPLE_PROJECT}" PUBLIC "${OPENVR_LIB}")
-source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}/${EXAMPLE_PROJECT}/src" PREFIX "Header Files" FILES ${HEADERS})
-source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}/${EXAMPLE_PROJECT}/src" PREFIX "Source Files" FILES ${SOURCES})
+source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}/driver_files/src" PREFIX "Header Files" FILES ${HEADERS})
+source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}/driver_files/src" PREFIX "Source Files" FILES ${SOURCES})
 set_property(TARGET "${EXAMPLE_PROJECT}" PROPERTY CXX_STANDARD 17)
 
 # Copy driver assets to output folder
 add_custom_command(
     TARGET ${EXAMPLE_PROJECT}
     PRE_BUILD 
     COMMAND ${CMAKE_COMMAND} -E copy_directory 
-    ${CMAKE_SOURCE_DIR}/${EXAMPLE_PROJECT}/driver/ 
+    ${CMAKE_SOURCE_DIR}/driver_files/driver/ 
     $<TARGET_FILE_DIR:${EXAMPLE_PROJECT}>
 )
 
 # Copy dll to output folder
 add_custom_command(
     TARGET ${EXAMPLE_PROJECT} 
-    POST_BUILD 
+    POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy 
     $<TARGET_FILE:${EXAMPLE_PROJECT}>
-    $<TARGET_FILE_DIR:${EXAMPLE_PROJECT}>/${EXAMPLE_PROJECT}/bin/${PLATFORM_NAME}${PROCESSOR_ARCH}/$<TARGET_FILE_NAME:${EXAMPLE_PROJECT}>
+    $<TARGET_FILE_DIR:${EXAMPLE_PROJECT}>/${DRIVER_NAME}/bin/${PLATFORM_NAME}${PROCESSOR_ARCH}/$<TARGET_FILE_NAME:${EXAMPLE_PROJECT}>
 )

README.md

@@ -0,0 +1,92 @@
+# Simple OpenVR Driver Tutorial
+I created this driver as a demonstration for how to write some of the most common things a SteamVR/OpenVR driver would want to do. You will need to understand C++11 and some C++17 features at least to make the most use of this repo. It features:
+
+- [Reading and writing configuration files]()
+- [Tracked HMD]()
+- [Tracked Controllers]() (todo)
+- [Tracked Trackers]() (todo)
+- [Tracking References (base stations)]() (todo)
+
+## Building
+- Clone the project and submodules
+	- `git clone --recursive https://github.com/terminal29/Simple-OpenVR-Driver-Tutorial.git`
+- Build project with CMake
+	- `cd Simple-OpenVR-Driver-Tutorial && cmake .`
+- Open project with Visual Studio and hit build
+	- Driver folder structure and files will be copied to the output folder as `example`.
+	
+## Installation
+
+There are two ways to "install" this plugin:
+
+- Find your SteamVR driver directory, which should be at:
+  `C:\Program Files (x86)\Steam\steamapps\common\SteamVR\drivers`
+  and copy the `example` directory from the project's build directory into the SteamVR drivers directory. Your folder structure should look something like this:
+
+![Drivers folder structure](https://i.imgur.com/hOsDk1H.png)
+or
+
+- Navigate to `C:\Users\<Username>\AppData\Local\openvr` and find the `openvrpaths.vrpath` file. Open this file with your text editor of choice, and under `"external_drivers"`, add another entry with the location of the `example` folder. For example mine looks like this after adding the entry:
+
+```json
+{
+	"config" : 
+	[
+		"C:\\Program Files (x86)\\Steam\\config",
+		"c:\\program files (x86)\\steam\\config"
+	],
+	"external_drivers" : 
+	[
+		"C:\\Users\\<Username>\\Documents\\Programming\\c++\\Simple-OpenVR-Driver-Tutorial\\build\\Debug\\example"
+	],
+	"jsonid" : "vrpathreg",
+	"log" : 
+	[
+		"C:\\Program Files (x86)\\Steam\\logs",
+		"c:\\program files (x86)\\steam\\logs"
+	],
+	"runtime" : 
+	[
+		"C:\\Program Files (x86)\\Steam\\steamapps\\common\\SteamVR"
+	],
+	"version" : 1
+}
+```
+
+## Debugging
+Debugging SteamVR is not as simple as it seems because of the startup procedure it uses. The SteamVR ecosystem consists of a couple programs:
+
+ - **vrserver**: the driver host
+ - **vrcompositor**: the render engine
+ - **vrmonitor**: the popup that displays status information
+ - **vrdashboard**: the VR menu/overlay
+ - **vrstartup**: a program to start everything up
+ 
+ To debug effectively in Visual Studio, you can use an extension called [Microsoft Child Process Debugging Power Tool](https://marketplace.visualstudio.com/items?itemName=vsdbgplat.MicrosoftChildProcessDebuggingPowerTool) and enable debugging child processes, disable debugging for all other child processes, and add `vrserver.exe` as a child process to debug as below: 
+![Child process debugging settings](https://i.imgur.com/yDNvLMm.png)
+
+Set the program the project should run in debug mode to **vrstartup** (Usually located `C:\Program Files (x86)\Steam\steamapps\common\SteamVR\bin\win64\vrstartup.exe`). Now we can start up SteamVR without needing to go through Steam, and can properly startup all the other programs vrserver needs. 
+
+
+## License
+MIT License
+
+Copyright (c) 2020 Jacob Hilton (Terminal29)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

driver_example/driver/driver_tutorial_hmd/bin/win64/.gitkeep renamed to driver_files/driver/example/bin/win64/.gitkeep

@@ -1,5 +1,8 @@
 #include "DriverFactory.hpp"
+#include <thread>
 #include <Driver/VRDriver.hpp>
+#include <Windows.h>
+#include <sstream>
 
 static std::shared_ptr<ExampleDriver::IVRDriver> driver;
 
@@ -21,4 +24,4 @@ void* HmdDriverFactory(const char* interface_name, int* return_code) {
 
 std::shared_ptr<ExampleDriver::IVRDriver> ExampleDriver::getDriver() {
 	return driver;
-}
+}

driver_example/driver/driver_tutorial_hmd/driver.vrdrivermanifest renamed to driver_files/driver/example/driver.vrdrivermanifest

@@ -10,5 +10,7 @@
 extern "C" __declspec(dllexport) void* HmdDriverFactory(const char* interface_name, int* return_code);
 
 namespace ExampleDriver {
-    extern std::shared_ptr<ExampleDriver::IVRDriver> getDriver();
+    std::shared_ptr<ExampleDriver::IVRDriver> getDriver();
+
+    void launchDebugger(bool blocking = true);
 }