JoyPro2 Discord GitHub
Engine (CLI)

engine xplane11 (X-Plane 11)

Show:

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

#engine xplane11 paths

written
engine xplane11 paths
For beginners

Lists where JoyPro finds the joystick settings of X-Plane 11 on this PC. The first one is what engine xplane11 scan, engine xplane11 import and engine xplane11 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 xplane11 paths --text
Advanced
  • Per installation: <install>\Output\preferences\X-Plane Joystick Settings.prf, then the saved control profiles ...\control profiles\<Name> - Joysticks.prf (newest first).
  • The installations come from %LOCALAPPDATA%\x-plane_install_11.txt and Steam (app 269950); a folder set with engine games install set is used instead.
  • 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 ("X-Plane 11 Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine xplane11 without an action runs paths.
  • Related: engine xplane11 scan, engine games paths, engine games install set; game page xplane.

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

#engine xplane11 catalog

written
engine xplane11 catalog
For beginners

Lists the X-Plane 11 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 xplane11 catalog --text
Advanced
  • The list is %LOCALAPPDATA%\JoyPro2\GameData\DB\XPlane11\actions.tsv (when that folder does not exist, the DB\XPlane11 folder next to the engine).
  • It is built from the installed Commands.txt by engine xplane11 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 ("X-Plane 11 Action Catalog", "Source:", "Actions: ", then <id> | axis|button | <category> | <title> per action).
  • Without a list: the warning X-Plane 11 action catalog not found: <path> and an empty list, exit code 0.
  • Related: engine xplane11 refresh-db, engine xplane11 export, engine db games; game page xplane.

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

#engine xplane11 scan

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

Shows the joystick binds X-Plane 11 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 xplane11 scan --text
Advanced
  • It reads the axis uses, button commands, reverse flags and response curves of the joystick settings file. X-Plane 11 writes the file once it was started with your devices connected.
  • Path (positional or --path): another .prf file, for example a saved control profile.
  • --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.
  • 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 ("X-Plane 11 Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No X-Plane 11 config file found. Pass the path explicitly.
  • Unknown options fail with Unknown XPlane11 scan argument(s): ...; MSFS options (--game-profile, --include-disconnected, --include-sim-defaults) are refused.
  • Binds of the vJoy device JoyPro forwards into (--vjoy-tunnel) are left out.
  • Related: engine xplane11 import, engine xplane11 paths, engine xplane11 catalog; game page xplane.

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 X-Plane 11's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. X-Plane 11 details · what each mode changes

Example

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

written
engine xplane11 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 joystick assignments of X-Plane 11 into your JoyPro profile: axis uses, button commands, reverse flags and response curves. Nothing in X-Plane changes. The GUI runs it with Import on the X-Plane 11 card of the Start page.

engine xplane11 import "D:\Games\X-Plane 11\Output\preferences\X-Plane Joystick Settings.prf" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced

It reads X-Plane 11's <install>\Output\preferences\X-Plane Joystick Settings.prf, or a control profile <Name> - Joysticks.prf given as the path. The version must have been started once with your devices connected.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what X-Plane 11 has.
  • No keyboard binds in this file; --include-keyboard changes nothing.
  • Curves come in as the relation's X-Plane 11 tuning; JoyPro's own data comes back from <file>.joypro-meta.json.
  • Safety: reads only, not refused while X-Plane runs; the profile is kept as "Before import from X-Plane 11" 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 X-Plane 11 config file found. Pass the path explicitly.).
  • Without a path it reads the first file of engine xplane11 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 xplane11 scan, engine xplane11 export, engine xplane12 import; game page xplane.

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 X-Plane 11'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. X-Plane 11 details · what each mode changes

Example

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

written
engine xplane11 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 X-Plane 11's joystick preferences, so Settings > Joystick shows them. Close X-Plane first. The GUI's Export now on the X-Plane 11 card runs it.

engine xplane11 export --mode merge --dry-run --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

It edits X-Plane 11's X-Plane Joystick Settings.prf (or the control profile you pass) line by line.

--mode In X-Plane 11
add free inputs only; a bind on an input with another use or command is listed, not written
merge replaces the other use or command on your input, keeps everything else; an axis use moves
merge-overwrite (engine default) also releases other axes and buttons of connected devices that hold a use or command you bind
clean (GUI default) also releases every other flight axis and command on the devices you write
  • --nuke-untouched-devices: connected devices you do not write lose their flight uses and commands (not with add).
  • Curves: kept in add and merge when JoyPro's tuning is linear; written by merge-overwrite and clean. X-Plane 11's game settings (control response, stability augmentation, flap detents) change only existing lines.
  • Never touched: devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, view, camera and custom-command axes, plugin and aircraft commands, calibration lines, the keyboard file.
  • Safety: refused while X-Plane runs (X-Plane 12 too, same process name); backed up first (undo: engine backups list); the profile is kept as "Before export to X-Plane 11". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result or a text report with --text; exit code 1 on an error (X-Plane runs, an invalid --mode, no file found).
  • Without a path it writes the first file of engine xplane11 paths.
  • After a real run: <file>.joypro.json and <file>.joypro-meta.json, the watcher's fingerprint, the export marks.
  • Related: engine xplane11 import, engine xplane12 export; game page xplane.

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 xplane11 export --mode clean
engine xplane11 export --mode add
engine xplane11 export --mode merge
engine xplane11 export --mode merge-overwrite

In the game Writes into X-Plane 11'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: as X-Plane 12. X-Plane 11 details · what each mode changes

Example

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

#engine xplane11 refresh-db

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

Rebuilds the catalog from the installed game or <source-path>: actions the game no longer has are dropped; writes it only when it changes

For beginners

Builds JoyPro's X-Plane 11 command list from the installed Commands.txt, 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 xplane11 refresh-db --dry-run --text
Advanced
  • It reads <install>\Resources\plugins\Commands.txt (path: the X-Plane folder, a folder that holds Commands.txt, or the file).
  • Kept: every sim/... command of the flight groups (flight controls, engines, autopilot, fuel, electrical, lights, systems, radios, instruments, GPS, FMS, magnetos, starters, ice ...) with the file's description as title and its group as category, plus JoyPro's own axis list (category Axis).
  • The list is rebuilt from the file; a command it no longer has leaves the list. X-Plane 12 has its own list (engine xplane12 refresh-db).
  • --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: Commands.txt was not found. Pass --path with the X-Plane folder or <X-Plane>\Resources\plugins\Commands.txt.; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\XPlane11\actions.tsv (with a header line that has the date). After a real run the game's build is recorded for engine db check-updates.
  • Related: engine xplane11 catalog, engine xplane11 scan, engine db check-updates; game page xplane.

What it does Rebuilds the catalog from the installed game or <source-path>: actions the game no longer has are dropped; 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 xplane11 refresh-db --text