JoyPro2 Discord GitHub
Engine (CLI)

engine msfs2020 (Microsoft Flight Simulator 2020)

Show:

6 commands of engine msfs2020. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.

#engine msfs2020 paths

written
engine msfs2020 paths
For beginners

Lists where JoyPro finds the input profiles of MSFS 2020 on this PC. The first one is what engine msfs2020 scan, engine msfs2020 import and engine msfs2020 export use when you give no path. Detect in the Other Games panel (Start page, Expert import) runs it and puts the first one into File / Folder.

engine msfs2020 paths --text
Advanced
  • Every Steam folder userdata\<id>\1250410\remote that holds input profiles, and the Microsoft Store save %LOCALAPPDATA%\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\SystemAppData\wgs when it exists.
  • A config location you set yourself (engine games config set, Settings > Games) comes first.
  • No options. Reads only; it also works while the game runs or when it is not installed.
Technical internals
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or text with --text ("Microsoft Flight Simulator 2020 Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine msfs2020 without an action runs paths.
  • The entries are folders, not single files: each holds one profile per device and category.
  • Related: engine msfs2020 scan, engine games paths, engine games install set; game page msfs2020.

What it does Lists where JoyPro looks for this game's controls on this machine: files, folders or registry keys (your config location from games config set first). A file the game has not written yet can be listed (e.g. Arma Reforger's JoyPro.conf, Project Wingman's Input.ini).

Example

engine msfs2020 paths --text

#engine msfs2020 catalog

written
engine msfs2020 catalog
For beginners

Lists the MSFS 2020 actions JoyPro manages (its command list): id, axis or button, category and title. An export writes only these actions, and the relation editor and the search list them.

engine msfs2020 catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\MSFS2020\actions.tsv (when that folder does not exist, the DB\MSFS2020 folder next to the engine).
  • It is built from the sim's presets and your profiles by engine msfs2020 refresh-db, or by the first scan, import or export.
  • catalog only shows the list; it never builds it. Titles that look like ids are shown readable.
  • No options. Reads only; works without the game installed.
Technical internals
  • Output: JSON (Game, Source, Actions with Id, Title, IsAxis, Category, Warnings), or text with --text ("Microsoft Flight Simulator 2020 Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning Microsoft Flight Simulator 2020 action catalog not found: <path> and an empty list, exit code 0.
  • Add-on actions that belong to one aircraft are limited to it in the file; catalog does not show that column.
  • Related: engine msfs2020 refresh-db, engine msfs2020 export, engine db games; game page msfs2020.

What it does Lists every action of JoyPro's command list of this game with its kind and category: <data>\GameData\DB\<Game>\actions.tsv, else the program folder's DB\<Game>.

Example

engine msfs2020 catalog --text

#engine msfs2020 scan

written
engine msfs2020 scan [<config-path>] [--path <config-path>] [--ignore-device <name>] [--ignore-devices <csv>] [--game-profile <name>] [--include-disconnected] [--include-sim-defaults]
For beginners

Shows the joystick binds MSFS 2020 has now, without changing your profile or the game. Use it to look before an import. Look first on the game's card of the Start page and Scan in the Other Games panel run it.

engine msfs2020 scan --text
Advanced
  • It reads what the sim uses: your Steam and Microsoft Store profiles, the devices that are connected, with the axis values of the Sensitivity page.
  • Path (positional or --path): a profile file or a folder of profiles.
  • --ignore-device <name> / --ignore-devices <a;b> (separated by | or ;, --ignore-devices also by commas) leave the binds of those devices out (a name without {GUID} means every device of that name); a step line names them and counts the binds.
  • Keyboard binds are not read in this game.
  • --game-profile <name> reads that profile when a device has several; --include-disconnected also reads devices that are not connected; --include-sim-defaults also the sim's default presets whose use its records do not show.
  • --user-profiles and --import-files are MSFS 2024 options: accepted here, a warning says they were ignored. --limit-to-profile-aircraft (import only) and --aircraft (export only) are refused.
  • Safety: reads only and is not refused while the game runs. It is refused when the game is not installed (set its folder: engine games install set) or switched off in Settings > Games.
  • A fresh install has no command list yet: the first scan builds it from the installed game and saves it (a step line says so).
Technical internals
  • Output: JSON (ConfigPath, BindingsRead, Bindings with ActionId, Device, Input, IsAxis, Reformers, Inverted, then Steps, Warnings, Errors), or text with --text ("Microsoft Flight Simulator 2020 Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Microsoft Flight Simulator 2020 config file found. Pass the path explicitly.
  • Unknown options fail with Unknown MSFS2020 scan argument(s): ....
  • Binds of the vJoy device JoyPro forwards into (--vjoy-tunnel) are left out.
  • Related: engine msfs2020 import, engine msfs2020 paths, engine msfs2020 catalog; game page msfs2020.

What it does Reads the game's controls (its control file or folder, or registry values for Nuclear Option and Tiny Combat Arena; Ace Combat 8 stores none) and shows the joystick binds, without changing the profile. Without a command list yet (fresh install) it first builds the list from the game and saves it.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--ignore-device<name>Leave the binds of this device out (one per flag; a name without {GUID} means every device of that name). Example: --ignore-device 'vJoy Device'.
--ignore-devices<csv>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.
--game-profile<name>
--include-disconnectedswitch (no value)MSFS: also the devices the sim has profiles for that are not connected now (default: connected devices only).
--include-sim-defaultsswitch (no value)MSFS import/scan: also the sim's default presets of devices for which the sim's records (profile_00) do not show whether it uses them.

In the game Reads Microsoft Flight Simulator 2020's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. Microsoft Flight Simulator 2020 details · what each mode changes

Example

engine msfs2020 scan --text
How the options interact
  • --ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).
  • --limit-to-profile-aircraft, --user-profiles and --import-files are MSFS 2024 options: given to MSFS 2020 they change nothing and the result says so.

#engine msfs2020 import

written
engine msfs2020 import [<config-path>] [--path <config-path>] [--replace] [--include-keyboard] [--ignore-device <name>] [--ignore-devices <csv>] [--game-profile <name>] [--include-disconnected] [--include-sim-defaults]

--ignore-device(s): the binds of these devices are left out; devices that are not connected only with --include-disconnected

For beginners

Reads the device profiles of Microsoft Flight Simulator 2020 (Steam or Microsoft Store) into your JoyPro profile, one relation per function and input. Nothing in the sim changes. The GUI runs it with Import on the MSFS 2020 card of the Start page.

engine msfs2020 import --include-disconnected --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

It reads one profile per device: Steam userdata\<id>\1250410\remote\inputprofile_<n>, or the Microsoft Store save under %LOCALAPPDATA%\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\SystemAppData\wgs\, with the axis values of the device's Sensitivity page.

Option What it does
(none) adds to the open profile (merge); --merge means the same
--replace starts over: every relation of the profile is replaced by what the sim has
--include-disconnected also the profiles of devices that are not connected
--include-sim-defaults also shipped presets whose use the sim's records do not show
--game-profile <name> takes that profile when a device has several
  • --limit-to-profile-aircraft is an MSFS 2024 option: MSFS 2020 keeps one profile per device for every aircraft, so binds come in for all aircraft. Given here it does not fail; a warning says that it applies to MSFS 2024 only.
  • Keyboard binds are not read in MSFS; --include-keyboard changes nothing.
  • Safety: reads only, not refused while the sim runs; with --profile the profile is kept as the version "Before import from Microsoft Flight Simulator 2020" first.
  • --ignore-device <name> / --ignore-devices <a;b> leave the binds of those devices out (a name without {GUID} means every device of that name); a step line says how many binds were left out.
Technical internals
  • Output: JSON of the import result or a text report with --text; exit code 1 on an error (No Microsoft Flight Simulator 2020 config file found. Pass the path explicitly.).
  • Without a path it reads the locations of engine msfs2020 paths; a fresh install builds the command list first.
  • --aircraft is refused here (export only); unknown options fail with Unknown MSFS2020 import argument(s): ....
  • With --profile the profile is saved afterwards. The imported inputs are recorded as JoyPro's, and a sim JoyPro never exported to is watched from now on.
  • Related: engine msfs2020 scan, engine msfs2020 export, engine sync pending; game page msfs2020.

What it does Imports the game's joystick binds into the loaded profile (merged by default; --replace starts from an empty relation list). Without a command list yet it first builds the list from the game.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--replaceswitch (no value)For game import: start from an empty relation list instead of merging into the loaded profile.
--include-keyboardswitch (no value)
--ignore-device<name>Leave the binds of this device out (one per flag; a name without {GUID} means every device of that name). Example: --ignore-device 'vJoy Device'.
--ignore-devices<csv>Leave the binds of these devices out (separated by commas, | or ;). Example: --ignore-devices 'vJoy Device,Old Pedals'.
--game-profile<name>
--include-disconnectedswitch (no value)MSFS: also the devices the sim has profiles for that are not connected now (default: connected devices only).
--include-sim-defaultsswitch (no value)MSFS import/scan: also the sim's default presets of devices for which the sim's records (profile_00) do not show whether it uses them.

In the game Reads Microsoft Flight Simulator 2020's files only; nothing changes in the game. The binds come into the profile as relations; JoyPro's own data next to the game file brings back names, groups, modifiers and curves. Microsoft Flight Simulator 2020 details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2020 import --text
How the options interact
  • --ignore-device / --ignore-devices leave the binds of those devices out of the scan or import (the result names how many).
  • --limit-to-profile-aircraft, --user-profiles and --import-files are MSFS 2024 options: given to MSFS 2020 they change nothing and the result says so.

#engine msfs2020 export

written
engine msfs2020 export [<config-path>] [--path <config-path>] [--mode clean|add|merge|merge-overwrite] [--dry-run] [--include-keyboard] [--nuke-untouched-devices] [--ignore-device <name>] [--ignore-devices <csv>] [--game-profile <name>] [--aircraft <aircraft-key>]

Flight only: clean takes over the devices it writes, nuke clears unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared

For beginners

Writes your binds into the Steam version's device profiles of Microsoft Flight Simulator 2020 (the inputprofile_* files the sim already has). Close the sim first. The GUI's Export now on the MSFS 2020 card runs it.

engine msfs2020 export --mode clean --nuke-untouched-devices --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--mode In the device profiles
add a bind is written only where no other action has that input combination; nothing is removed
merge the other action on your combination loses it; an action keeps its old combination
merge-overwrite (engine default) as merge, and every action you bind loses its other combinations in the profiles of connected devices
clean (GUI default) the profiles of the connected devices JoyPro binds keep only your binds
  • --nuke-untouched-devices: the profiles of connected devices without a bind in your profile are cleared (not with add).
  • --aircraft <key> also writes the relations limited to that aircraft (for all aircraft: MSFS 2020 has one profile per device); without it those relations are skipped with a warning. --game-profile <name> picks one profile.
  • Only existing inputprofile_* files are edited; a device needs a profile made in the sim. The Microsoft Store profiles are read only: the Store save folder as the path is refused.
  • --user-profiles and --import-files are MSFS 2024 options: given here they change nothing, and a warning says that they apply to MSFS 2024 only.
  • Never touched: menu, world map and developer contexts, keyboard, mouse and gamepad profiles, profile_00, devices that are not connected, --ignore-device(s) and the --vjoy-tunnel device. Keyboard binds are not written.
  • Safety: refused while FlightSimulator runs; backed up first (undo: engine backups list); the profile is kept as "Before export to Microsoft Flight Simulator 2020". --dry-run writes nothing and is allowed while the sim runs.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (the sim runs, an invalid --mode, no config file found).
  • Without a path it uses the first location of engine msfs2020 paths.
  • A bind whose action is not in the command list is skipped with a warning; a profile without MSFS 2020 binds writes nothing (exit 0).
  • After a real run: JoyPro's .joypro-meta.json, the watcher's fingerprint and the export marks (engine export-marks list).
  • Related: engine msfs2020 import, engine msfs2020 refresh-db; game page msfs2020.

What it does Writes the profile's binds for this game. Only the flight actions JoyPro manages are changed, the game must be closed, and the game's files are backed up first (engine backups). Without a command list yet it first builds the list from the game.

OptionValuesMeaning
--path<config-path>Optional explicit path override. Use when you prefer option form over positional path.
--modeclean add merge merge-overwriteExport mode for DCS/IL2 export commands: clean, add, merge, merge-overwrite.
--dry-runswitch (no value)Report what the export would write; the game's files are not changed.
--include-keyboardswitch (no value)
--nuke-untouched-devicesswitch (no value)DCS export only: delete untouched device .diff.lua/.jp files under Config\\Input (true/false).
--ignore-device<name>Exclude one device per flag. Example: --ignore-device Keyboard.
--ignore-devices<csv>Exclude devices, separated by commas, | or ;. Example: --ignore-devices Keyboard,Mouse.
--game-profile<name>
--aircraft<aircraft-key>MSFS export only: also write the relations limited to this aircraft (key from DB\\MSFS\\aircraft.tsv); the sim's presets apply to every aircraft.
Every value as a command line
engine msfs2020 export --mode clean
engine msfs2020 export --mode add
engine msfs2020 export --mode merge
engine msfs2020 export --mode merge-overwrite

In the game Writes into Microsoft Flight Simulator 2020's control files while the game is closed (refused while it runs), after a backup. Civil and general flight simulators. JoyPro takes over the devices it writes (clean and nuke clear every other bind of those devices). Bind file: Steam userdata\<id>\1250410\remote\inputprofile_* (XML fragment per device). Microsoft Flight Simulator 2020 details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2020 export --dry-run --text engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2020 export --mode merge-overwrite --text
How the options interact
  • --limit-to-profile-aircraft, --user-profiles and --import-files are MSFS 2024 options: given to MSFS 2020 they change nothing and the result says so.

#engine msfs2020 refresh-db

written
engine msfs2020 refresh-db [<source-path>] [--path <source-path>] [--dry-run]

Reads the installed game or <source-path> and adds its new actions to the catalog, the known ones stay; writes it only when it changes

For beginners

Builds JoyPro's MSFS 2020 command list from the sim's own input presets and your profiles, or adds the actions that are new. Run it after a game update, or when JoyPro says the list is missing. Refresh DB in the Other Games panel (its DB Source box is the path) and the Start page's notice "Command lists to build or update" run it.

engine msfs2020 refresh-db --dry-run --text
Advanced
  • Without a path it reads the sim's input presets (Steam <install>\Packages\fs-input-profiles or <install>\Input, Microsoft Store <drive>\XboxGames\Microsoft Flight Simulator\Content\Packages), your own profiles (Steam and Microsoft Store): every action of the managed contexts (flight and general; menus, world map and developer tools stay out), each with its context.
  • Also: the flight events the sim's en-US.locPak names but no preset binds, the input presets of add-on packages in Community and Marketplace (their new actions are limited to that aircraft; packed packages are skipped), and contexts corrected to the ones your profiles list.
  • New actions and raw event names get the name the sim's Controls menu shows; other known titles stay.
  • The list of installed aircraft (aircraft.tsv, for --aircraft and the GUI's Export Aircraft box) is updated in the same run.
  • Path: a profile file or a folder of exported profiles instead of the sim.
  • --dry-run reads everything and writes nothing (step "Dry run: nothing was written."). Without it the list is written only when it changed.
  • Safety: only JoyPro's list changes, never a game file; it is refused when the game is not installed or switched off in Settings > Games. The GUI can cancel it while the game's files are read; nothing is written then.
Technical internals
  • Output: JSON of the refresh (DryRun, FilesWritten, Steps with Actions: <old> -> <new>, Warnings, Errors), or text with --text.
  • Exit code 0; 1 when nothing could be read: No Microsoft Flight Simulator 2020 input presets found: neither the sim's own (...) nor your own profiles (...). Set the install folder or pass --path with exported profiles.; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\MSFS2020\actions.tsv (with a header line that has the date), and aircraft.tsv next to it. After a real run the game's build is recorded for engine db check-updates.
  • Related: engine msfs2020 catalog, engine msfs2020 scan, engine db check-updates; game page msfs2020.

What it does Reads the installed game or <source-path> and adds its new actions to the catalog, the known ones stay; writes it only when it changes.

OptionValuesMeaning
--path<source-path>Same as <source-path>: the game's installation or a file of the game to read the actions from.
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Example

engine msfs2020 refresh-db --text