feat(cmd): .simbridgedebug command (#478)

Co-authored-by: NUT <[email protected]>

.github/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+Update <small>_ August 2023</small>
+
+- feat: added .simbridgedebug command which explains debugging steps, if SimBridge crashes right after starting (07/08/2023)
+
 Update <small>_ July 2023</small>
 
 - fix: change the checklist image in the checklist command to the correct one (27/07/2023)

.github/command-docs.md

@@ -83,6 +83,7 @@
 | .reportedissues | Provides a link to the reported issues page within docs, either a general link, or a link for a specific search <br> Search terms can be terminated by a line break or one of the symbols . - > / \                                                                         | .issues                                            |
 | .remoteefb      | Provides information about to the viewing the EFB remotely                                                                                                                                                                                                                  | .refb <br> .remoteflypad <br> .rflypad             |
 | .screenshot     | Help to screenshot for support                                                                                                                                                                                                                                              | .cockpit <br> .ss                                  |
+| .simbridgedebug | Provides reason for SimBridge crashing, and steps to get a screenshot for debugging the crashing.                                                                                                                                                                           | .sbdebug                                           |
 | .simbridgelog   | Information on how to provide SimBridge Log                                                                                                                                                                                                                                 | .slog                                              |
 | .simulationrate | Explanation of the limitation of the Simulation Rate based on frame rate                                                                                                                                                                                                    | .simrate                                           |
 | .simversion     | Help to identify MSFS version for support                                                                                                                                                                                                                                   | .msfsversion                                       |

src/commands/index.ts

@@ -171,6 +171,7 @@ import { remoteEfb } from './support/remoteEfb';
 import { brakeCheck } from './support/brakeCheck';
 import { spad } from './general/spad';
 import { devLanguages } from './general/devLanguages';
+import { simbridgeDebug } from './support/simbridgeDebug'
 
 const commands: BaseCommandDefinition[] = [
     typeCommand,
@@ -344,6 +345,7 @@ const commands: BaseCommandDefinition[] = [
     brakeCheck,
     spad,
     devLanguages,
+    simbridgeDebug,
 ];
 
 const commandsObject: { [k: string]: BaseCommandDefinition } = {};

src/commands/support/simbridgeDebug.ts

@@ -0,0 +1,26 @@
+import { MessageCommandDefinition } from '../../lib/command';
+import { makeEmbed, makeLines } from '../../lib/embed';
+import { CommandCategory, imageBaseUrl } from '../../constants';
+
+const SIMBRIDGE_HELP_URL = `${imageBaseUrl}/support/simbridgeDebug.png`;
+
+const simbridgeDebugEmbed = makeEmbed({
+    title: 'FlyByWire Support | Why does SimBridge crash?',
+    description: makeLines([
+        'If SimBridge crashes moments after start, it could be due to bad installation of SimBridge, missing modules or another issue. In order to assist you further we will need to see your SimBridge logs.',
+        '',
+        '1. Open the folder where SimBridge is installed.',
+        '2. Open a terminal window in that location (Hold `SHIFT` and right click on the empty space of the folder, then select "Open Windows Terminal", "Open Command Prompt", or "Open Powershell Window".',
+        '3. Type `fbw-simbridge.exe` and press enter.',
+        '4. Screenshot the output of the console and send it to us.',
+    ]),
+    image: { url: SIMBRIDGE_HELP_URL },
+    footer: { text: 'Tip: Click the image to view in full size' },
+});
+
+export const simbridgeDebug: MessageCommandDefinition = {
+    name: ['simbridgedebug', 'sbdebug'],
+    description: 'Provides instructions to debug SimBridge',
+    category: CommandCategory.SUPPORT,
+    genericEmbed: simbridgeDebugEmbed,
+};