added diagnostics context and profile

Should help with troubleshooting.

CHANGELOG.md

@@ -1,3 +1,12 @@
+# devel
+
+## Added
+
+* `diagnostics` plugin context: writes current plugin state to the log for
+  troubleshooting.
+* `bindED-diagnostics` profile: runs the `diagnostics` plugin context on load.
+  Should be the first troubleshooting step.
+
 # 4.1 (2021-05-22)
 
 ## Added
@@ -119,4 +128,4 @@ should basically never be used anyway.
 
 * Support for non-US keyboard layouts. `de-neo2` is included (because that’s
   what I’m using), others can be added ([see the wiki for
-  instructions](https://github.com/alterNERDtive/bindED/wiki/Keyboard-Layouts)).
+  instructions](https://github.com/alterNERDtive/bindED/wiki/Keyboard-Layouts)).

README.md

@@ -116,10 +116,17 @@ 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
+be to import and load the included `bindED-diagnostics` profile. It will output
+the current plugin state (keyboard layout, preset and binds file used) to the
+VoiceAttack log.
+
+If that seems correct, there’s the `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.
+keyboard shortcut assigned, and put them on your Desktop. Note that those lists
+are currently not filtered in any way and will contain _all_ binds regardless if
+they are used in any profiles nor if they can even have a keyboard key assigned
+(e.g. axes).
 
 Need help beyond that? Please [file an
 issue](https://github.com/alterNERDtive/bindED/issues/new) or [hop into
-Discord](https://discord.gg/YeXh2s5UC6).
+Discord](https://discord.gg/YeXh2s5UC6).

bindED.cs

@@ -127,8 +127,15 @@ namespace bindEDplugin
             _VA = vaProxy;
             try
             {
-                string context = _VA.Context.ToLower();
-                if (context == "listbinds")
+                string context = _VA.Context.ToLower();
+                if (context == "diagnostics")
+                {
+                    LogInfo($"current keybord layout: {Layout}");
+                    LogInfo($"current preset: {Preset}");
+                    LogInfo($"detected binds file: {(new FileInfo(DetectBindsFile(Preset))).Name}");
+                    LogInfo($"detected binds file (full path): {DetectBindsFile(Preset)}");
+                }
+                else if (context == "listbinds")
                 {
                     ListBinds(Binds, _VA.GetText("bindED.separator") ?? "\r\n");
                 }

bindEDplugin.csproj

@@ -69,6 +69,7 @@
   </ItemGroup>
   <ItemGroup>
     <None Include=".editorconfig" />
+    <None Include="bindED-diagnostics-Profile.vap" />
     <None Include="bindED-reports-Profile.vap">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>