EliteDangerous/bindED
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases 10 Activity Actions

updated docs

Browse source
This commit is contained in:
alterNERDtive 2020-11-09 12:25:55 +01:00
parent 1196c8e618
commit bf19c77deb
2 changed files with 26 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -1,6 +1,6 @@
# devel
I did a copmlete refactoring of everything to prepare for some juicy new
I did a complete refactoring of everything to prepare for some juicy new
features! Sadly that also meant breaking backwards compatibility. On the plus
side, the things that no longer work like they did in Gary’s initial release
should basically never be used anyway.
@ -28,6 +28,10 @@ should basically never be used anyway.
* The `listbinds` context will set the text variable `~bindED.bindsList` to a
list of bindings present in the current bindings file. See README for details.
(#1).
* The `missingbinds` context will create a report of missing binds (anything
that doesn’t have keyboard binds) and save it to `~bindED.missingBinds`.
* The included `bindED-reports` profile runs a missing binds report and a binds
list report when you load it and save them to your Desktop.
-----

47
README.md
View file

@ -11,9 +11,16 @@ I have taken the original source code and added automatic detection of the
correct bindings file and support for non-US keyboard layouts (see below for
details).
## Usage
## Migrating from the Old Plugin
### Reading Bindings into VoiceAttack
If you use this as a drop-in replacement for the initial version all commands
invoking the plugin will throw an error message. Gary has asked me to change the
plugin’s GUID, and the plugin with the old one will no longer be found.
_That is irrelevant in basically all cases and can safely be ignored_. Binds
will be read automatically when VoiceAttack starts, and when they change.
## Usage
You don’t have to do anything! When VoiceAttack loads, bindED will automatically
detect your bindings. It will also keep a watchful eye on Elite’s bindings
@ -24,29 +31,6 @@ context to force a refresh.
If you are not using a US QWERTY keyboard layout, see below.
### Saving the List of Variables
Invoke the `listbinds` plugin context (make sure to tick “Wait for the plugin
function to finish before continuing”!). That will set a variable
`~bindED.bindsList` containing all the variable names that you can e.g. write to
a file.
By default the list is separated by `\r\n`, you can override that behaviour by
setting `bindED.separator` before invoking the plugin.
## Automatic Bindings Detection
Elite creates a file `StartPreset.start` in the Bindings directory that contains
the name of the currently active profile. The plugin now reads that file and
loads the correct profile automatically.
Should the file for some reason a) not exist, b) be empty or c) contain an
invalid preset name the old default is used: the most recently changed `.binds`
file.
You can still manually provide a bindings file to use instead by setting it as
the plugin context, as before.
## Support for non-US Keyboard Layouts
If you are using any non-US layout you might have noticed that some binds don’t
@ -75,4 +59,15 @@ and set `bindED.layout#` to
“en-us-dvorak”. You can see where this is going.
For more information on [creating new supported keyboard layouts see the
Wiki](https://github.com/alterNERDtive/bindED/wiki/Keyboard-Layouts).
Wiki](https://github.com/alterNERDtive/bindED/wiki/Keyboard-Layouts).
## Troubleshooting
If you run into any kinds of trouble with missing bindings the first step should
be to import and load the included `bindED-reports` profile. It will generate
both a list of bind names used by Elite and a report of binds that do not have a
keyboard shortcut assigned, and put them on your Desktop.
Need help beyond that? Please [file an
issue](https://github.com/alterNERDtive/bindED/issues/new) or [hop into
Discord](https://discord.gg/kXtXm54).