JoyPro2 Discord GitHub
Engine (CLI)

engine fsxse (Microsoft Flight Simulator X: Steam Edition)

Show:

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

#engine fsxse paths

written
engine fsxse paths
For beginners

Shows where JoyPro finds the control files of Microsoft Flight Simulator X: Steam Edition on this PC, the active one first. Detect in the import wizard's Expert import section runs it.

engine fsxse paths --text
Advanced
  • No options. Listed: your own config location of engine games config set first, then the files of %APPDATA%\Microsoft\FSX-SE\Controls\; when that folder has none, those of %APPDATA%\Microsoft\FSX\Controls\ (the Steam Edition installed alone uses that folder).
  • The active file is the one fsx_se.cfg (else fsx.cfg) names under [CONTROLS] Controls_Current, else Standard.xml; every other .xml file follows.
  • 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: Steam Edition Config Paths, Paths: <n> and the files. Exit code 0; an unknown option fails with Unknown FSXSE paths argument(s): ....
  • Related: engine fsxse scan, engine fsx 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 fsxse paths --text

#engine fsxse catalog

written
engine fsxse catalog
For beginners

Lists the events of Microsoft Flight Simulator X: Steam Edition JoyPro knows: the sim's event names with axis or button and category.

engine fsxse catalog --text
Advanced
  • No options; read-only, also when the sim is not installed.
  • JoyPro's own FSX/Prepar3D event list plus the events found in the sim's control files, in a list of its own. A fresh install has no list yet; the first scan, import, export or engine fsxse refresh-db builds it (until then: a warning and no action).
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\FSXSE\actions.tsv.
  • Related: engine fsxse refresh-db, engine fsx 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 fsxse catalog --text

#engine fsxse scan

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

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

engine fsxse scan --text
Advanced
  • Reads the device maps and the keyboard map of the file engine fsxse paths lists first, or of the file given (positional or --path); devices are matched by the GUID in the map name, else by a unique name.
  • Keys are listed without --include-keyboard; sensitivity and null zone are read but not listed; an event that is not in the list yet gets a warning naming engine fsxse 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 config file found). Unknown options fail with Unknown FSXSE scan argument(s): ....
  • Related: engine fsxse import, engine fsx scan; 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: Steam Edition'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: Steam Edition details · what each mode changes

Example

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

written
engine fsxse 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: Steam Edition into your JoyPro profile: axes, buttons and hats with each axis's sensitivity and null zone. Nothing in the sim changes. The GUI runs it with Import on the FSX: Steam Edition card.

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

It reads the controls file in %APPDATA%\Microsoft\FSX-SE\Controls\ when boxed FSX is installed too, else in %APPDATA%\Microsoft\FSX\Controls\.

  • Default: adds to the open profile; --replace replaces every relation of the profile by what the sim has.
  • --include-keyboard also reads the keyboard map.
  • A device is found by the GUID in its map name, else by its name when exactly one connected device has it.
  • Safety: reads only, not refused while the sim runs; the profile is kept as "Before import from Microsoft Flight Simulator X: Steam Edition" 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 config file found).
  • Without a path it reads the first file of engine fsxse paths; 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 fsxse scan, engine fsxse export, engine fsx 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: Steam Edition'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: Steam Edition details · what each mode changes

Example

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

written
engine fsxse 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: Steam Edition. Close the sim first. The GUI's Export now on the FSX: Steam Edition card runs it.

engine fsxse export --mode merge-overwrite --include-keyboard --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced

It edits the device maps of the Steam Edition's controls file (%APPDATA%\Microsoft\FSX-SE\Controls\ next to boxed FSX, else %APPDATA%\Microsoft\FSX\Controls\).

--mode In the controls file
add never removes or replaces a block; a bind on a taken input is listed, not written
merge replaces the event on your input, keeps everything else
merge-overwrite (engine default) also removes the other inputs of the events you bind
clean (GUI default) the main maps of the devices you write keep only your binds
  • --nuke-untouched-devices empties the main maps of the other connected devices (not with add); --include-keyboard also writes the keyboard map.
  • Never touched: devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, slew and mouse maps.
  • Safety: refused while fsx runs; backed up first (undo: engine backups list); the profile is kept as "Before export to Microsoft Flight Simulator X: Steam Edition". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error.
  • Without a path it writes the first file of engine fsxse paths. The Steam Edition's file name is inferred, not yet checked on a real install.
  • After a real run: <file>.joypro.json and <file>.joypro-meta.json, the watcher's fingerprint, the export marks.
  • Related: engine fsxse import, engine fsx export; 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 fsxse export --mode clean
engine fsxse export --mode add
engine fsxse export --mode merge
engine fsxse export --mode merge-overwrite

In the game Writes into Microsoft Flight Simulator X: Steam Edition'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-SE\Controls\ (or the FSX folder), XML. Microsoft Flight Simulator X: Steam Edition details · what each mode changes

Example

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

#engine fsxse refresh-db

written
engine fsxse 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 command list of FSX: Steam Edition: JoyPro's own event list, then every event used in the sim's control files. Update on the FSX: Steam Edition card of the Start page runs it.

engine fsxse refresh-db --text
Advanced
  • Rows the list already has stay; nothing is removed. Read without a path: the files of engine fsxse paths, the sim's Standard.xml in its installation folder and Controls\Standard.xmlx. A path: a folder reads every *.xml* file in it, a file only that file.
  • --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 with the new events per file and Actions: <old> -> <new>, Warnings), or a text report with --text.
  • Exit code 0; 1 only for a refusal or an unknown option.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\FSXSE\actions.tsv and records the sim's Steam build for engine db check-updates.
  • Related: engine fsxse catalog, engine fsx 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 fsxse refresh-db --text