JoyPro2 Discord GitHub
Engine (CLI)

engine fsx (Microsoft Flight Simulator X)

Show:

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

#engine fsx paths

written
engine fsx paths
For beginners

Shows where JoyPro finds the control files of Microsoft Flight Simulator X (boxed) on this PC, in %APPDATA%\Microsoft\FSX\Controls\, the active one first. Detect in the import wizard's Expert import section runs it and takes the first.

engine fsx paths --text
Advanced
  • No options. Listed: your own config location of engine games config set first, then the active file (the name fsx.cfg gives under [CONTROLS] Controls_Current, else Standard.xml), then every other .xml file of the folder.
  • Read-only; also works when the sim is not installed or switched off.
Technical internals
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or with --text Microsoft Flight Simulator X Config Paths, Paths: <n> and the files. Exit code 0; an unknown option fails with Unknown FSX paths argument(s): ....
  • Related: engine fsx scan, engine fsxse paths, engine games paths; game page fsx-p3d.

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

#engine fsx catalog

written
engine fsx catalog
For beginners

Lists the Microsoft Flight Simulator X events JoyPro knows: the sim's event names (GEAR_TOGGLE, AXIS_AILERONS_SET ...) with axis or button and category.

engine fsx catalog --text
Advanced
  • No options; read-only, also when the sim is not installed.
  • The list is JoyPro's own FSX/Prepar3D event list plus the events found in the sim's control files (engine fsx refresh-db). A fresh install has no list yet; the first scan, import, export or refresh builds it. Until then the command lists no action and warns Microsoft Flight Simulator X action catalog not found: <path>.
Technical internals
  • Output: JSON (Game, Source, Actions with Id, Title, IsAxis, Category, Warnings), or with --text one line per action <id> | axis|button | <category> | <title>. Exit code 0.
  • File: %LOCALAPPDATA%\JoyPro2\GameData\DB\FSX\actions.tsv.
  • Related: engine fsx refresh-db, engine p3d4 catalog; game page fsx-p3d.

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

#engine fsx scan

written
engine fsx scan [<config-path>] [--path <config-path>] [--ignore-device <name>] [--ignore-devices <csv>]
For beginners

Shows the binds of the active FSX control file, axes, buttons, hats and keyboard keys, without changing your profile or the sim. Look first in the import wizard runs it.

engine fsx scan --text
Advanced
  • Reads the device maps (<device name>{<GUID>}) and the keyboard map of the file engine fsx paths lists first, or of the file given (positional or --path).
  • A device is found by the GUID in its map name, else by its name when exactly one connected device has it. A hat is shown on its up direction (the sim assigns the whole hat).
  • Keys with Ctrl, Shift and Alt are listed without --include-keyboard (the import takes them only with it). Sensitivity and null zone are read but not listed. An event that is not in the list yet gets a warning naming engine fsx refresh-db.
  • --ignore-device <name> / --ignore-devices <a;b> leave the binds of those devices out.
  • Safety: reads only, also while the sim runs; a fresh install first builds and saves the command list. Refused when the sim is not installed or switched off in Settings > Games.
Technical internals
  • Output: JSON (Game, Action scan, ConfigPath, BindingsRead, Bindings, Steps, Warnings, Errors), or a text report with --text.
  • Exit code 0; 1 on an error (No Microsoft Flight Simulator X config file found. Pass the path explicitly.). Unknown options fail with Unknown FSX scan argument(s): ....
  • Related: engine fsx import, engine fsx catalog; game page fsx-p3d.

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'.

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

Example

engine fsx 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 fsx import

written
engine fsx import [<config-path>] [--path <config-path>] [--replace] [--include-keyboard] [--ignore-device <name>] [--ignore-devices <csv>]

--ignore-device(s): the binds of these devices are left out

For beginners

Reads the active controls file of Microsoft Flight Simulator X (boxed) into your JoyPro profile: axes, buttons and hats of your devices with each axis's sensitivity and null zone. Nothing in the sim changes. The GUI runs it with Import on the FSX card of the Start page.

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

It reads %APPDATA%\Microsoft\FSX\Controls\Standard.XML, or the file fsx.cfg names under [CONTROLS] Controls_Current. Commands are the sim's event names (GEAR_TOGGLE, AXIS_AILERONS_SET ...).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what FSX has.
  • --include-keyboard also reads the keyboard map (keys with Ctrl, Shift and Alt as modifiers).
  • A device is found by the GUID in its map name, else by its name when exactly one connected device has it (warning).
  • Safety: reads only, not refused while the sim runs; the profile is kept as "Before import from Microsoft Flight Simulator X" 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 (keyboard binds left out are counted in a step: "add --include-keyboard to include them"); exit code 1 on an error (No Microsoft Flight Simulator X config file found. Pass the path explicitly.).
  • Without a path it reads the first file of engine fsx paths (the active file); a fresh install builds the command list first.
  • With --profile the profile is saved afterwards. The imported inputs are recorded as JoyPro's in <file>.joypro.json (so merge-overwrite can later replace them), and a game JoyPro never exported to is watched from now on.
  • Related: engine fsx scan, engine fsx export, engine fsxse import; game page fsx-p3d.

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'.

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

Example

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

written
engine fsx 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>]

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 active controls file of Microsoft Flight Simulator X (boxed). Close the sim first. The GUI's Export now on the FSX card runs it.

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

It edits the device maps of %APPDATA%\Microsoft\FSX\Controls\Standard.XML (or the active file) block by block; comments and formatting stay.

--mode In the controls file
add never removes or replaces a block; a bind on an input that has another event is listed, not written
merge replaces the event on your input and keeps everything else
merge-overwrite (engine default) also removes the other inputs of the events you bind (connected devices)
clean (GUI default) the main maps of the devices you write keep only your binds
  • --nuke-untouched-devices: the main maps of the other connected devices are emptied, the maps stay (not with add).
  • --include-keyboard also writes the keyboard map; only then can merge-overwrite take keys off an event.
  • Axes get sensitivity and null zone (0 to 127); a hat is written as a whole. A device the file does not have gets a new map. Joystick buttons cannot carry modifiers.
  • Never touched: maps of devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, the slew maps, Mouse Yoke, Mouse Look, key chords of two plain keys.
  • Safety: refused while fsx runs; backed up first (undo: engine backups list); the profile is kept as "Before export to Microsoft Flight Simulator X". --dry-run writes nothing.
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 file found).
  • Without a path it writes the first file of engine fsx paths (the active one).
  • After a real run: <file>.joypro.json and <file>.joypro-meta.json, the watcher's fingerprint, the export marks (engine export-marks list).
  • Related: engine fsx import, engine fsx refresh-db; game page fsx-p3d.

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.
Every value as a command line
engine fsx export --mode clean
engine fsx export --mode add
engine fsx export --mode merge
engine fsx export --mode merge-overwrite

In the game Writes into Microsoft Flight Simulator X'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: %APPDATA%\Microsoft\FSX\Controls\Standard.XML (XML). Microsoft Flight Simulator X details · what each mode changes

Example

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

#engine fsx refresh-db

written
engine fsx 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

Adds new events to JoyPro's FSX command list: JoyPro's own FSX/Prepar3D event list, then every event used in the sim's control files. Update on the FSX card of the Start page runs it.

engine fsx refresh-db --dry-run --text
Advanced
  • Rows the list already has stay; nothing is removed. Read without a path: the files of engine fsx paths, the sim's Standard.xml in its installation folder and Controls\Standard.xmlx.
  • A path (positional or --path): a folder reads every *.xml* file in it, a file only that file.
  • Only events of device maps and the keyboard map count. --dry-run writes nothing; otherwise the list is written only when it changed.
  • Refused when the sim is not installed or switched off in Settings > Games; the sim may run.
Technical internals
  • Output: JSON of the refresh (DryRun, FilesWritten, Steps such as JoyPro's own FSX/Prepar3D event list: <n> new event(s)., Read <file>: <n> new event(s). and Actions: <old> -> <new>, Warnings), or a text report with --text. A file that cannot be read gives a warning.
  • Exit code 0; 1 only for a refusal or an unknown option.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\FSX\actions.tsv.
  • Related: engine fsx catalog, engine fsxse refresh-db; game page fsx-p3d.

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