Updated documentation

README.md

@@ -6,9 +6,29 @@ 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 https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/tools/hmd-simulator.git Plugins/HMDSimulator` in the root of 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 in your Action Mappings. For this go to `Edit->Project Settings->Engine->Input->Bindings->Action Mappings` and add the respective keys there. ![](Resources/InputBindings.png)
+- 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. ![](Resources/VRTemplateInputFiles.png)
+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. ![](Resources/VRTemplateInputMappingContext.png)
+For the Unreal VR template the following could be used
+
+**IMC_Default**
+- IA_Grab_Left <-> HMDSimulator (L) Grip Button
+- IA_Grab_Right <-> HMDSimulator (R) Grip Button
+- IA_Menu_Toggle_Left <-> HMDSimulator (L) Menu Button
+- IA_Menu_Toggle_Right <-> HMDSimulator (R) Menu Button
+
+**IMC_Hands**
+- IA_Hand_Grasp_Left <-> HMDSimulator (L) Grip Button
+- IA_Hand_Grasp_Right <-> HMDSimulator (R) Grip Button
+
+**IMC_Weapon_Left**
+- IA_Shoot_Left <-> HMDSimulator (L) Trigger Buttom
+
+**IMC_Weapon_Right**
+- IA_Shoot_Right <-> HMDSimulator (R) Trigger Buttom
 
 ## Configuration
 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. ![](Resources/Options.png)
@@ -16,7 +36,11 @@ The HMD Simulator uses the keyboard and mouse to grab the input that is needed t
 ## Usage
 {- Please note, that the keys mentioned in this section only refer to the default configuration -}
 
-Do a [VR Preview launch](Resources/VRLaunch.png) and you will see something similar to this: ![](Resources/StandardView.png)
+Do a VR Preview launch as shown in the following image
+![](Resources/VRLaunch.png)
+and you will see something similar to this: 
+![](Resources/StandardView.png)
+
 Currently, the HMD Simulator emulated the two controllers and the position of the HMD.
 
 If SteamVR is running and a real HMD is detected it is used instead. If you want to explicitly use the HMDSimulator, switch off your HMD or unplug it and close SteamVR. Then restart Unreal und do a [VR Preview launch](Resources/VRLaunch.png).