docs: added actual usage instructions

fixes #24
This commit is contained in:
alterNERDtive 2021-06-14 11:57:05 +02:00
parent 9d2c5355d8
commit f46f40abb1
2 changed files with 13 additions and 1 deletions

BIN
docs/images/keypress.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View file

@ -1,4 +1,4 @@
# bindED # bindED
This VoiceAttack plugin reads keybindings in Elite:Dangerous and stores them as This VoiceAttack plugin reads keybindings in Elite:Dangerous and stores them as
VoiceAttack variables. It was originally written by Gary (the developer of VoiceAttack variables. It was originally written by Gary (the developer of
@ -26,6 +26,18 @@ preset for all 4 sections (general, ship, SRV, foot). Sadly its not apparent
from the files which of these sections a bind belongs to, so there is no simple from the files which of these sections a bind belongs to, so there is no simple
way to read multiple files properly. way to read multiple files properly.
## Using Binds In Commands
Each bind in Elite Dangerous has a name assigned in the binds file. The plugin
takes this name, prepends `ed` and turns it into a VoiceAttack variable.
To press the corresponding key in the game, you will have to create a new
`Key Press` action in a VoiceAttack command and use the desired variable named
after the ingame bind. In order to toggle your landing gear for example you will
have to create a `Key Press` action and use the `edLandingGearToggle` variable.
![[keypress.png]]
## Supported Keyboard Layouts ## Supported Keyboard Layouts
If you are using any non-US layout you might have noticed that some binds dont If you are using any non-US layout you might have noticed that some binds dont