diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md index 4dce3d30..ad2ccdd4 100644 --- a/.github/CHANGELOG.md +++ b/.github/CHANGELOG.md @@ -1,5 +1,9 @@ ## Changelog +Update _ August 2024 + +- feat: New .APModes command (08/08/2024) + Update _ July 2024 - fix: update takeoff calculator and flex temp command to highlight new improvements (01/07/2024) diff --git a/.github/command-docs.md b/.github/command-docs.md index f1b42df6..351ef4a8 100644 --- a/.github/command-docs.md +++ b/.github/command-docs.md @@ -51,48 +51,49 @@ ### Support -| Command | Description | Alias | -|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------| -| .abbreviations | Links to most commonly used abbreviations | .abb
.abrv | -| .airac | Provides information about free SimBrief account AIRAC limitations | --- | -| .brakecheck | Provides instructions to find the current brake pedal inputs | .brake | -| .build | Link to docs for build info | .build info
.buildinfo | -| .calibrate | Provides a help for throttle calibration | --- | -| .clean | Clean Install | .clean install
.cleaninstall
.order66 | -| .community | Help to identify community folder for support | .com | -| .content | Help to identify aircraft version for support | .contentmanager | -| .controls | Instructions on how to switch back to legacy controls and how to use new controls | .legacy | -| .ctd | Crash to Desktop | .crash | -| .cursor | Displays steps to help with EFB cursor focus issue | .efbfocus
.unfocus | -| .deadzones | Display help with controller deadzones | .deadzone
.dz | -| .dx12 | Explanation for the current state of MSFS DirectX12 support | --- | -| .discontinuity | Link to docs about discontinuities | .disco | -| .dlss | Explanation of the DLSS option in the MSFS graphics settings. | | -| .econnreset | Troubleshooting info for installer ECONNRESET error. | .econreset | -| .fdr | Information on how to provide fdr files | --- | -| .flypadabout | Help to identify the flyPadOS and aircraft version for support | .flypadversion
.efbabout
.efbversion | -| .hud | How to disable in-game HUD | .logs | -| .installerlogs | Provides an explanation on how to receive installer error logs for support | --- | -| .manualleg | Displays image and links to docs about manual waypoints | .manual | -| .market | Help with removing the marketplace version | .marketremove
.removemarket
.rm
.mr | -| .msfs | Provides links to MSFS support for sim issues | .msfsforum | -| .navdata | Explains the use of navdata by the FlyByWire A32NX and how to check its accuracy | --- | -| .navigraphdata | Provides help with Navigraph NavData reinstall | .navigraphnavdata | -| .reportedissues | Provides a link to the reported issues page within docs, either a general link, or a link for a specific search
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
.remoteflypad
.rflypad | -| .screenshot | Help to screenshot for support | .cockpit
.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 | -| .supportguide | Provides information on where to find solutions to issues and how to describe the problem to support | .sg | -| .tca | Provides a describtion of keybindings that have to be deleted with the Thrustmaster TCA without Add-ons. | --- | -| .trythis | Provide basic troubleshooting steps | --- | -| .tug | Provides a solution to an issue where the tug fails to disconnect | .stuck | -| .utf8 | Provides a link to resolve UTF-8 issues | --- | -| .wasm | Explains the long loading times after an install or update | .load | -| .where | Provides an image of which aircraft to select in the aircraft selector | --- | -| .winss | Explains how to screenshot on Windows | .sswin
.howtoss | +| Command | Description | Alias | +|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------| +| .apmodes | Provides information about the Managed and Selected autopilot modes | .APmodes | +| .abbreviations | Links to most commonly used abbreviations | .abb
.abrv | +| .airac | Provides information about free SimBrief account AIRAC limitations | --- | +| .brakecheck | Provides instructions to find the current brake pedal inputs | .brake | +| .build | Link to docs for build info | .build info
.buildinfo | +| .calibrate | Provides a help for throttle calibration | --- | +| .clean | Clean Install | .clean install
.cleaninstall
.order66 | +| .community | Help to identify community folder for support | .com | +| .content | Help to identify aircraft version for support | .contentmanager | +| .controls | Instructions on how to switch back to legacy controls and how to use new controls | .legacy | +| .ctd | Crash to Desktop | .crash | +| .cursor | Displays steps to help with EFB cursor focus issue | .efbfocus
.unfocus | +| .deadzones | Display help with controller deadzones | .deadzone
.dz | +| .dx12 | Explanation for the current state of MSFS DirectX12 support | --- | +| .discontinuity | Link to docs about discontinuities | .disco | +| .dlss | Explanation of the DLSS option in the MSFS graphics settings. | | +| .econnreset | Troubleshooting info for installer ECONNRESET error. | .econreset | +| .fdr | Information on how to provide fdr files | --- | +| .flypadabout | Help to identify the flyPadOS and aircraft version for support | .flypadversion
.efbabout
.efbversion | +| .hud | How to disable in-game HUD | .logs | +| .installerlogs | Provides an explanation on how to receive installer error logs for support | --- | +| .manualleg | Displays image and links to docs about manual waypoints | .manual | +| .market | Help with removing the marketplace version | .marketremove
.removemarket
.rm
.mr | +| .msfs | Provides links to MSFS support for sim issues | .msfsforum | +| .navdata | Explains the use of navdata by the FlyByWire A32NX and how to check its accuracy | --- | +| .navigraphdata | Provides help with Navigraph NavData reinstall | .navigraphnavdata | +| .reportedissues | Provides a link to the reported issues page within docs, either a general link, or a link for a specific search
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
.remoteflypad
.rflypad | +| .screenshot | Help to screenshot for support | .cockpit
.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 | +| .supportguide | Provides information on where to find solutions to issues and how to describe the problem to support | .sg | +| .tca | Provides a describtion of keybindings that have to be deleted with the Thrustmaster TCA without Add-ons. | --- | +| .trythis | Provide basic troubleshooting steps | --- | +| .tug | Provides a solution to an issue where the tug fails to disconnect | .stuck | +| .utf8 | Provides a link to resolve UTF-8 issues | --- | +| .wasm | Explains the long loading times after an install or update | .load | +| .where | Provides an image of which aircraft to select in the aircraft selector | --- | +| .winss | Explains how to screenshot on Windows | .sswin
.howtoss | ### General diff --git a/assets/images/support/apmodes.png b/assets/images/support/apmodes.png new file mode 100644 index 00000000..be218d59 Binary files /dev/null and b/assets/images/support/apmodes.png differ diff --git a/src/commands/index.ts b/src/commands/index.ts index b6fc85cc..34bd1f5e 100644 --- a/src/commands/index.ts +++ b/src/commands/index.ts @@ -138,6 +138,7 @@ import { spad } from './general/spad'; import { devLanguages } from './general/devLanguages'; import { simbridgeDebug } from './support/simbridgeDebug'; import { migratedCommand } from './general/migratedCommand'; +import { apmodes } from './support/apmodes'; //import { avatar } from './utils/avatar'; //import { ban } from './moderation/ban'; //import { birthday } from './utils/birthday'; @@ -310,6 +311,7 @@ const commands: BaseCommandDefinition[] = [ devLanguages, simbridgeDebug, migratedCommand, + apmodes, //avatar, //ban, //birthday, diff --git a/src/commands/support/apmodes.ts b/src/commands/support/apmodes.ts new file mode 100644 index 00000000..f5bf8261 --- /dev/null +++ b/src/commands/support/apmodes.ts @@ -0,0 +1,19 @@ +import { MessageCommandDefinition } from '../../lib/command'; +import { CommandCategory, imageBaseUrl } from '../../constants'; +import { makeEmbed } from '../../lib/embed'; + +const MANAGED_SELECTED_IMAGE = `${imageBaseUrl}/support/apmodes.png`; + +export const apModesEmbed = makeEmbed({ + title: 'Auto Pilot Modes', + description: 'For a detailed explanation of the different guidance modes visit our [documentation](https://docs.flybywiresim.com/pilots-corner/advanced-guides/flight-guidance/overview/#autopilot-and-flight-director-modes).', + image: { url: MANAGED_SELECTED_IMAGE }, + footer: { text: 'Tip: Click the image to view in full size' }, +}); + +export const apmodes: MessageCommandDefinition = { + name: ['apmodes', 'APmodes'], + description: 'Provides information about the Managed and Selected autopilot modes.', + category: CommandCategory.SUPPORT, + genericEmbed: apModesEmbed, +};