@@ -6,13 +6,23 @@ Please note, that this cannot replace real testing on an HMD, but allows simple
[[_TOC_]]
## Adding to your project
- Ideally you should add this plugin as a submodule to your project by executing `git submodule add -b 5.3 https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/tools/hmd-simulator.git Plugins/HMDSimulator` in the root of your project.
- After starting the editor you should check in `Edit->Plugins` if the plugin is enabled.
- As this plugin emulates an HMD like any other, you have to add the buttons of this HMD to the InputMappingContext files in your project.
In the case you are using the VR template that comes with Unreal itself, you have to extend the InputMappingContext files that are stored in the folder `Content\VRTemplate\Input\` as shown in the following image. 
Each InputMappingContext maps a device input such as a button press to an input action such as for example the action to grap something.
As shown in the following images, if you want to control an action inside the HMDSimulator, you have to add to the acction a mapping that uses a button of the HMDSimulator. 
For the Unreal VR template the following could be used
Ideally you should add this plugin as a submodule to your project by executing
After starting the editor, you should check in `Edit->Plugins` if the plugin is enabled.
As this plugin emulates an HMD like any other, you have to add the buttons of the HMD Simulator to the Input Mapping Context files in your project.
If you are using the VR template that comes with Unreal itself, you have to modify the Input Mapping Context files shown in the following image that you can find in the folder `Content\VRTemplate\Input\`.
Each Input Mapping Context maps a set of device inputs (e.g. button press) to a set of input actions (e.g. the action to grab an object).
As shown in the following image, if you want to control an action with the HMD Simulator, you have to add to the action a mapping that uses a button of the HMD Simulator.
For the Unreal VR template, the following mappings could be used:
**IMC_Default**
- IA_Grab_Left <-> HMDSimulator (L) Grip Button
...
...
@@ -31,14 +41,19 @@ For the Unreal VR template the following could be used
The HMD Simulator uses the keyboard and mouse to grab the input that is needed to emulate the controllers. As the simulator grabs these on a very high level, it catches key presses before your application can. Thus, the keys it uses can be reconfigured to fit your application. This can be done in the options of the Plugin. For this head to `Edit->Project Settings->Plugins->HMD Simulator` and configure everything to your liking. You can also change the displayed default controller model and some movement speeds there. Note that the controller model is only displayed if your project does not provide its own. 
The HMD Simulator uses the keyboard and mouse to grab the input that is needed to emulate the controllers. As the simulator grabs these on a very high level, it catches key presses before your application can. Thus, the keys it uses can be reconfigured to fit your application. This can be done in the options of the Plugin. For this head to `Edit->Project Settings->Plugins->HMD Simulator` and configure everything to your liking. You can also change the displayed default controller model and some movement speeds there. Note that the controller model is only displayed if your project does not provide its own.
## Usage
{- Please note, that the keys mentioned in this section only refer to the default configuration -}
Do a VR Preview launch as shown in the following image
and you will see something similar to this:
Currently, the HMD Simulator emulated the two controllers and the position of the HMD.
