From 4118885821974ef4fd2597cec1425e812fe94fa0 Mon Sep 17 00:00:00 2001 From: Vasily Date: Sun, 9 Jun 2019 08:42:44 +0200 Subject: [PATCH] Update documentation on keyboard input --- docs/keyboard_input_guide.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/keyboard_input_guide.md b/docs/keyboard_input_guide.md index 731997d..590939b 100644 --- a/docs/keyboard_input_guide.md +++ b/docs/keyboard_input_guide.md @@ -3,7 +3,8 @@ The `Keyboard Shortcut One`, `Keyboard Shortcut Two` and `Keyboard Shortcut Three` actions under the `misc` tab will send the currently configured key sequence to the operating system. The default keybinding for all three actions is `Ctrl+Shift+M`, which mutes your microphone in Discord (unless you've changed it). -This sequence can be changed to anything you want, as described in the [spec](specs/Keyboard_Manager-Parser_Spec.md). An easier to read version of the spec can be found below. +This sequence can be changed to anything you want, as described in the [spec](specs/Keyboard_Manager-Parser_Spec.md). +An easier to read version of the spec can be found below. The hotkeys can for example be configured to run an AutoHotKey script or mute VOIP applications. @@ -13,7 +14,7 @@ Currently, the only way to change which sequences are run when the bindings are On Windows the settings file can be found in `%APPDATA%\AdvancedSettings-Team` (copy paste this into Explorer or the Run command). -On Linux the settings file can be found in `/home/myname/.local/share/AdvancedSettings-Team/OpenVRAdvancedSettings/`. +On Linux the settings file can be found in `~/.local/share/AdvancedSettings-Team/OpenVRAdvancedSettings/`. The `OpenVRAdvancedSettings.ini` file will contain a heading like ``` @@ -22,7 +23,8 @@ keyboardOne=^>m keyboardTwo=^>m keyboardThree=^>m ``` -The character the _after_ the `=` will be run when the related binding is activated. The above key sequence for all bindings is `^>m` (`Ctrl+Shift+M`). +The character _after_ the `=` will be run when the related binding is activated. +The above key sequence for all bindings is `^>m` (`Ctrl+Shift+M`). An empty binding (no input will be run) would be `keyboardOne=`. ### Simple Configuration @@ -44,9 +46,10 @@ It is not possible to hold down keys. Look at the key table [spec](specs/Keyboard_Manager-Parser_Spec.txt) and find the keys that you want to press. Notice that single characters (a, b, c, etc.) are lower case, while buttons are uppercase (ENTER, END, ESC, etc.). -If you enter single letters as lower case it will not work. +If you enter single letters as upper case it will not work. +Buttons are pressed and released immediately, modifiers are held until there's a space in the sequence or the sequence ends. -The modifier keys should come before the "real" (letters, numbers, ENTER, etc.). +The modifier keys should come before the "real" button inputs. `^m` (`Ctrl+M` (Ctrl is held down, M is pressed and released, Ctrl is released)) is _not_ the same as `m^` (`M+Ctrl` (M is pressed and released, Ctrl is pressed and released)). -Spaces will mean that all currently held modifier keys are released and that a new sequence is ready to be parsed. For example `^a ^a` would press `Ctrl+A` two times. +Spaces mean that all currently held modifier keys are released and that a new sequence is ready to be parsed. For example `^a ^a` would press `Ctrl+A` two times.