JoyPro2 Discord GitHub
Engine (CLI)

engine bms (Falcon BMS)

Show:

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

#engine bms paths

written
engine bms paths
For beginners

Lists where JoyPro finds the config folder of Falcon BMS on this PC. The first one is what engine bms scan, engine bms import and engine bms 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 bms paths --text
Advanced
  • <BMS>\User\Config of every installation found: the registry entries under HKLM\SOFTWARE\Benchmark Sims (baseDir) and Falcon BMS* folders at the root of the fixed drives, sorted by folder name (highest first). 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 ("Falcon BMS Config Paths", "Paths: " and one line per location). Exit code 0, also when nothing was found (empty list).
  • engine bms without an action runs paths.
  • The entries are folders: BMS keeps one Setup.v100.<device> {<GUID>}.xml per device there.
  • Related: engine bms scan, engine games paths, engine games install set; game page falcon-bms.

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

#engine bms catalog

written
engine bms catalog
For beginners

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

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

#engine bms scan

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

Shows the joystick binds Falcon BMS 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 bms scan --text
Advanced
  • It reads one Setup.v100.<device> {<GUID>}.xml per device: press slots, shifted slots as the modifier BMS Shift, hats, axes and throttle detents.
  • Path (positional or --path): another User\Config folder.
  • --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 ("Falcon BMS Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Falcon BMS config file found. Pass the path explicitly.
  • Unknown options fail with Unknown FalconBMS 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 bms import, engine bms paths, engine bms catalog; game page falcon-bms.

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

Example

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

written
engine bms 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 your Falcon BMS controls from the launcher's device files into your JoyPro profile: buttons, hats and axes, with the shift layer as a modifier and each axis's invert, dead zone and saturation step. Nothing in BMS changes. The GUI runs it with Import on the Falcon BMS card of the Start page.

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

It reads the folder <BMS>\User\Config: one Setup.v100.<device> {<GUID>}.xml per device (press slots, shifted slots as the modifier BMS Shift, hats, axes, throttle detents).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what BMS has.
  • Game settings: the values JoyPro manages in Falcon BMS User.cfg, Feedback.ini and the pilot file's Enable Force Feedback byte become the profile's BMS settings (step line "Game settings imported: ...").
  • Keyboard keys stay in BMS's key file and are not read; --include-keyboard changes nothing. Release slots are never imported.
  • Safety: reads only, not refused while BMS runs; the profile is kept as "Before import from Falcon BMS" 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 Falcon BMS config file found. Pass the path explicitly.).
  • Without a path it reads the first folder of engine bms paths (BMS is found through its registry entry or a Falcon BMS* folder); a fresh install builds the command list from BMS - Full.key first.
  • With --profile the profile is saved afterwards. The imported inputs are recorded as JoyPro's in JoyPro.joypro.json, and a game JoyPro never exported to is watched from now on.
  • Related: engine bms scan, engine bms export, engine ffb set; game page falcon-bms.

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 Falcon BMS'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. Falcon BMS details · what each mode changes

Example

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

written
engine bms 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 Falcon BMS launcher's device files. On your next Launch the launcher builds the key file and the axis setup from them. Close BMS and its launcher first. The GUI's Export now on the Falcon BMS card runs it.

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

It writes <BMS>\User\Config\Setup.v100.<device> {<GUID>}.xml per device, and the settings you stored into Falcon BMS User.cfg (above the launcher's marker line), Feedback.ini and the pilot file <callsign>.pop.

--mode In BMS
add free slots only; a bind on a slot with another callback is listed; a function BMS has on another axis stays there (warning)
merge replaces the callback on your slot and keeps everything else; an axis function moves to your axis
merge-overwrite (engine default) also releases the other press slots, hats and axes of connected devices that hold an action you bind
clean (GUI default) releases everything else of the connected devices you write
  • --nuke-untouched-devices: connected devices without binds in the export are cleared (not with add). BMS is a flight-only game, so this covers every slot of those devices.
  • A connected device without a device file gets one (the launcher's stock file of that model, else an empty one). Binds with the shift button's modifier go into the shifted slot; other modifiers are skipped with a warning.
  • A profile without BMS binds still writes your stored settings and throttle detents.
  • Never touched: device files of devices that are not connected, --ignore-device(s), the --vjoy-tunnel device, keyboard keys and the key file, the files the launcher generates (axismapping.dat, joystick.cal, DeviceSorting.txt), the launcher's block in User.cfg. Keyboard binds are not written.
  • Safety: refused while Falcon BMS or FalconBMS_Alternative_Launcher runs; backed up first (.jpbak and the backup store, undo: engine backups list); the read-only attribute is restored; the profile is kept as "Before export to Falcon BMS". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result (BindingsWritten, BindingsSkipped, FilesWritten, SkippedTakenInputs) or a text report with --text; exit code 1 on an error (Falcon BMS is running (...). Close the game first; it overwrites its config on exit., an invalid --mode, no folder found).
  • Without a path it writes the first folder of engine bms paths. Only changed device files are written.
  • A bind whose callback is not in the command list is skipped with a warning.
  • After a real run: JoyPro.joypro.json and JoyPro's .joypro-meta.json, the watcher's fingerprint, the export marks (engine export-marks list).
  • Related: engine bms import, engine ffb set (settings, detents), engine binds tuning preview; game page falcon-bms.

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

In the game Writes into Falcon BMS's control files while the game is closed (refused while it runs), after a backup. Combat flight sims and combat flight games that read several joysticks. Bind file: <BMS>\User\Config\Setup.v100.<device> {GUID}.xml (launcher XML) + User.cfg, Feedback.ini, .pop. Falcon BMS details · what each mode changes

Example

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

#engine bms refresh-db

written
engine bms 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 Falcon BMS command list from the installed BMS - Full.key, 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 bms refresh-db --dry-run --text
Advanced
  • It reads <BMS>\User\Config\BMS - Full.key (path: that folder or the key file): the visible callbacks of the cockpit and flight sections (2.xx to 5.xx, 6.01 to 6.05 and 6.09) with the description as title and the section as category. UI, views, radio menus and development sections stay out.
  • JoyPro's list of the launcher's axis functions (axis/..., category Axes) is added.
  • The list is rebuilt from the key file; a callback it no longer has leaves the list.
  • --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: 'BMS - Full.key' was not found. Pass the BMS User\Config folder or the key file.; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\FalconBMS\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 bms catalog, engine bms scan, engine db check-updates; game page falcon-bms.

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