JoyPro2 Discord GitHub
Engine (CLI)

engine msfs2024 (Microsoft Flight Simulator 2024)

Show:

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

#engine msfs2024 paths

written
engine msfs2024 paths
For beginners

Lists where JoyPro finds the input profiles of MSFS 2024 on this PC. The first one is what engine msfs2024 scan, engine msfs2024 import and engine msfs2024 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 msfs2024 paths --text
Advanced
  • First JoyPro's own package <Community>\joypro-input-profiles (the Community folder the sim's UserCfg.opt names); an export writes there.
  • Then every Steam folder userdata\<id>\2537590\remote that holds input profiles, and the Microsoft Store save %LOCALAPPDATA%\Packages\Microsoft.Limitless_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 2024 Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine msfs2024 without an action runs paths.
  • The entries are folders, not single files: each holds one profile per device and category.
  • Related: engine msfs2024 scan, engine games paths, engine games install set; game page msfs2024.

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 msfs2024 paths --text

#engine msfs2024 catalog

written
engine msfs2024 catalog
For beginners

Lists the MSFS 2024 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 msfs2024 catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\MSFS2024\actions.tsv (when that folder does not exist, the DB\MSFS2024 folder next to the engine).
  • It is built from the sim's presets and your profiles by engine msfs2024 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 2024 Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning Microsoft Flight Simulator 2024 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 msfs2024 refresh-db, engine msfs2024 export, engine db games; game page msfs2024.

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 msfs2024 catalog --text

#engine msfs2024 scan

written
engine msfs2024 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 2024 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 msfs2024 scan --text
Advanced
  • It reads what the sim uses: your Steam and Microsoft Store profiles and JoyPro's preset package, 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.
  • A path inside JoyPro's package means the package. --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 2024 Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Microsoft Flight Simulator 2024 config file found. Pass the path explicitly.
  • Unknown options fail with Unknown MSFS2024 scan argument(s): ....
  • Binds of the vJoy device JoyPro forwards into (--vjoy-tunnel) are left out.
  • Related: engine msfs2024 import, engine msfs2024 paths, engine msfs2024 catalog; game page msfs2024.

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 2024'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 2024 details · what each mode changes

Example

engine msfs2024 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).

#engine msfs2024 import

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

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

For beginners

Reads the controls you set up in Microsoft Flight Simulator 2024 (your own profiles of the Steam and the Microsoft Store version) into your JoyPro profile, one relation per function and input. Nothing in the sim changes. Use it once at the start, or after you changed binds in the sim. The GUI runs it with Import on the MSFS 2024 card of the Start page (Look first runs engine msfs2024 scan instead).

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

It reads the profiles the sim uses per device and category (Airplanes and General): Steam userdata\<id>\2537590\remote\inputprofile_<n>, the Microsoft Store save under %LOCALAPPDATA%\Packages\Microsoft.Limitless_8wekyb3d8bbwe\SystemAppData\wgs\, and JoyPro's preset package only for devices without a profile of their own. Flight and General binds come in, with the axis values of the Sensitivity page.

Option What it does
(none) adds to the open profile (merge); --merge is accepted and means the same
--replace starts over: every relation of the profile is replaced by what the sim has (GUI: Start over from this game)
--include-disconnected also the profiles of devices that are not connected (the sim keeps every device it ever saw)
--include-sim-defaults also the default presets the sim ships for devices whose use the sim's records do not show
--limit-to-profile-aircraft a bind the sim has only in the profiles of some aircraft is limited to those aircraft at once
--game-profile <name> takes that profile when a device has several (else the one the sim's records name, else the newest)
  • Without --limit-to-profile-aircraft such binds come in for all aircraft and are listed under "Only In Some Aircraft" with the command that limits each one. A relation you had limited, or one JoyPro exported, keeps its aircraft.
  • Keyboard binds are not read in MSFS, so --include-keyboard changes nothing here.
  • Names, groups, modifiers and tuning of binds JoyPro exported come back from its .joypro-meta.json.
  • Safety: reads only, and it is not refused while the sim runs. With --profile the profile is kept as the version "Before import from Microsoft Flight Simulator 2024" 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 (Bindings, RelationsImported, NodesAddedToExisting, OnlyInAircraft, Steps, Warnings, Errors), or a text report with --text; exit code 0, 1 when the result has errors (for example No Microsoft Flight Simulator 2024 config file found. Pass the path explicitly.).
  • Without a path it reads what the sim uses (the locations engine msfs2024 paths lists). A first import on a fresh install builds the command list from the sim first (a step line says so).
  • Refused: --aircraft (export only), unknown options (Unknown MSFS2024 import argument(s): ...), and the import when the game is not installed or switched off in Settings > Games.
  • With --profile the profile is saved afterwards. The imported inputs are recorded as JoyPro's (in %LOCALAPPDATA%\JoyPro2\Ownership\MSFS), and a sim JoyPro never exported to is watched from now on (engine sync status).
  • Related: engine msfs2024 scan, engine msfs2024 export, engine relations aircraft set, engine sync pending; game page msfs2024.

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.
--limit-to-profile-aircraftswitch (no value)Binds the sim has only in some aircraft's profiles are limited to those aircraft at once (default: imported for all aircraft and listed).

In the game Reads Microsoft Flight Simulator 2024'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 2024 details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2024 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).

#engine msfs2024 export

written
engine msfs2024 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>] [--user-profiles true|false] [--import-files]

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 Microsoft Flight Simulator 2024: into the profile the sim uses for each device and category (Steam or Microsoft Store), into JoyPro's preset package for aircraft the sim has not set up yet, and into import files where a profile cannot be written. Close the sim first. The GUI's Export now on the MSFS 2024 card runs it.

engine msfs2024 export --mode clean --nuke-untouched-devices --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

The modes work per profile of yours and only in the managed contexts.

--mode In your MSFS 2024 profiles
add a bind goes in only where no other action of that profile uses the 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, also in the profiles of other connected devices
clean (GUI default) the profiles of the connected devices JoyPro writes keep only your binds
  • --nuke-untouched-devices never clears one of your own MSFS 2024 profiles. With add it is not used (warning).
  • --user-profiles false leaves your own profiles alone (GUI tick write into my MSFS profiles, on by default). --import-files writes an import file for every device and category, not only where a profile could not be written.
  • --aircraft <key> also writes the relations limited to that aircraft. Without it, a relation limited to aircraft goes only into profiles whose aircraft are all ticked, never into the preset package or the import files.
  • --game-profile <name> picks one profile when a device has several.
  • Never touched: menu, world map and developer contexts, keyboard, mouse and gamepad profiles, profile_00, the presets Asobo ships, other containers of the Store save, devices that are not connected, --ignore-device(s) and the --vjoy-tunnel device. Keyboard binds are not written, --include-keyboard changes nothing.
  • Safety: refused while FlightSimulator2024 runs (the Store version's launch helper counts too); the Steam file or the whole Store save folder is backed up first (undo: engine backups list); the profile is kept as the version "Before export to Microsoft Flight Simulator 2024". --dry-run writes nothing and is allowed while the sim runs.
Technical internals
  • Output: JSON of the export result (BindingsWritten, BindingsSkipped, FilesWritten, ProfileUpdates per device and category with status updated, unchanged, dry-run or import-file, SkippedTakenInputs), or a text report with --text (section "Profiles"); exit code 1 on an error.
  • Errors: Microsoft Flight Simulator 2024 is running (...). Close the game first; it overwrites its config on exit., Invalid export mode '<x>'. Use clean, add, merge or merge-overwrite., and a refusal when the path is the Store save folder.
  • Without a path it uses the first location of engine msfs2024 paths (JoyPro's package in Community2024). Import files go to Documents\JoyPro2\MSFS 2024 import files (step line "MSFS 2024 import files written ...").
  • A bind whose action is not in the command list is skipped with a warning. A profile without MSFS 2024 binds writes nothing ("Nothing was written.", exit 0).
  • After a real run: JoyPro's .joypro-meta.json for the next import, the watcher's fingerprint and the export marks (engine export-marks list); the profile is saved only when those marks changed.
  • Related: engine msfs2024 import, engine msfs2024 refresh-db, engine sync pending; game page msfs2024.

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.
--user-profilestrue falseMSFS 2024 export only: write your own profiles the sim uses for each device and category (Steam remote folder or Microsoft Store save, backed up first); default true, false writes only JoyPro's package presets and the import files.
--import-filesswitch (no value)MSFS 2024 export only: write an import file (Documents\JoyPro2\MSFS 2024 import files) for every device and category, not only where your own profile could not be written.
Every value as a command line
engine msfs2024 export --mode clean
engine msfs2024 export --mode add
engine msfs2024 export --mode merge
engine msfs2024 export --mode merge-overwrite
engine msfs2024 export --user-profiles true
engine msfs2024 export --user-profiles false

In the game Writes into Microsoft Flight Simulator 2024'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: your own profile the sim uses per device and category (Steam remote\inputprofile_* XML or the Microsoft Store save, --user-profiles) + JoyPro's Community package (joypro-input-profiles, one preset XML per device); import files in Documents\JoyPro2\MSFS 2024 import files where your profile cannot be written. Microsoft Flight Simulator 2024 details · what each mode changes

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2024 export --dry-run --text engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' msfs2024 export --mode merge-overwrite --text

#engine msfs2024 refresh-db

written
engine msfs2024 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 2024 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 msfs2024 refresh-db --dry-run --text
Advanced
  • Without a path it reads the sim's input presets (Steam <install>\Packages\fs-input-profiles, Microsoft Store <drive>\XboxGames\Microsoft Flight Simulator 2024\Content\Packages), your own profiles (Steam and Microsoft Store) and JoyPro's own package: 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 2024 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\MSFS2024\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 msfs2024 catalog, engine msfs2024 scan, engine db check-updates; game page msfs2024.

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 msfs2024 refresh-db --text