JoyPro2 Discord GitHub
Engine (CLI)

engine bf6 (Battlefield 6)

Show:

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

#engine bf6 paths

written
engine bf6 paths
For beginners

Shows where JoyPro finds Battlefield 6's binds on this PC: the settings profiles under %USERPROFILE%\Documents\Battlefield 6\settings\, for example steam\PROFSAVEbf6mp_profile. Detect in the import wizard's Expert import section runs it and takes the first file.

engine bf6 paths --text
Advanced
  • No options. Listed: your own config location of engine games config set first, then every *_profile file in the settings folder and its subfolders that has key bind lines (GstKeyBinding.), the multiplayer profile first, then the newest.
  • Read-only; also works when the game is not installed or switched off.
Technical internals
  • Output: JSON (Game, DisplayName, ConfigPaths, Warnings), or with --text Battlefield 6 Config Paths, Paths: <n> and the files; a folder that cannot be listed gives a warning. Exit code 0; an unknown option fails with Unknown Battlefield6 paths argument(s): ....
  • Related: engine bf6 scan, engine bf2042 paths, engine games paths; game page battlefield.

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

#engine bf6 catalog

written
engine bf6 catalog
For beginners

Lists the Battlefield 6 actions JoyPro knows: the jet and helicopter controls (jet.ConceptPitch, helicopter.ConceptFire ...), each with axis or button.

engine bf6 catalog --text
Advanced
  • No options; read-only, also when the game is not installed.
  • Before a list was built from your settings profile, JoyPro lists its own table: per category the throttle, pitch, roll, yaw and look axes (the helicopter also brake) and six buttons (fire, zoom, camera, seat and the two gadgets). engine bf6 refresh-db, or the first scan, import or export, replaces it with the controls of your profile.
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> (categories Jet and Helicopter). Exit code 0.
  • File: %LOCALAPPDATA%\JoyPro2\GameData\DB\Battlefield6\actions.tsv (Source names it also while the built-in table is shown).
  • Related: engine bf6 refresh-db, engine bf2042 catalog; game page battlefield.

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

#engine bf6 scan

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

Shows the jet and helicopter binds of Battlefield 6's settings profile, joystick binds and keyboard keys, without changing your profile or the game. Look first in the import wizard runs it.

engine bf6 scan --text
Advanced
  • Reads the GstKeyBinding.<category>.<Concept>.<slot> lines of the jet and helicopter categories of the file engine bf6 paths lists first, or of the file given (positional or --path).
  • Keyboard keys of button actions are listed without --include-keyboard (the import takes them only with it).
  • The game stores no device in its binds: joystick binds are shown on the vJoy device in virtual mode, else on the first connected game controller (a warning when several are connected). JoyPro's joystick numbering for the game is provisional, so joystick binds come with a warning; a code JoyPro's table does not know is skipped.
  • --ignore-device <name> / --ignore-devices <a;b> leave the binds of those devices out.
  • Safety: reads only, also while the game runs; a fresh install first builds and saves the command list from your profile. Refused when the game 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 Battlefield 6 config file found. Pass the path explicitly.). Unknown options fail with Unknown Battlefield6 scan argument(s): ....
  • Related: engine bf6 import, engine vjoy mode; game page battlefield.

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

Example

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

written
engine bf6 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 jet and helicopter binds of Battlefield 6 from its settings profile into your JoyPro profile: keyboard keys when you ask for them, and joystick binds (with a warning). Nothing in the game changes. Start the game once before, so the profile exists. The GUI runs it with Import on the Battlefield 6 card of the Start page.

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

It reads %USERPROFILE%\Documents\Battlefield 6\settings\steam\PROFSAVEbf6mp_profile (the EA app version has no steam folder): the GstKeyBinding.<category>.<Concept>.<slot> lines of the jet and helicopter categories.

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the file has.
  • --include-keyboard also reads the keys of the jet and helicopter button actions.
  • Joystick binds are read with a warning: the game's joystick numbering is not confirmed yet.
  • Before the first import JoyPro lists its own table of the jet and helicopter actions; the import builds the list from your profile.
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Battlefield 6" 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

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

Example

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

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

Only aircraft/helicopter actions: clean and nuke release those on the written / unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared

For beginners

Writes the keyboard keys of your jet and helicopter relations into Battlefield 6's settings profiles, with --include-keyboard. Joystick binds are listed as not written until the game's numbering is confirmed; bind the vJoy device on the game's joystick page yourself. Close the game first. The GUI's Export now on the Battlefield 6 card runs it.

engine bf6 export --mode clean --include-keyboard --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

It writes every *_profile of Documents\Battlefield 6\settings\steam\ that holds binds (campaign and multiplayer match). Only jet and helicopter slots change.

--mode In the profiles
add a bind whose input another action of the same vehicle uses gets a mark "Not written to the game"; no slot is freed
merge the other action's slot on the profile's input is freed; the action's bound slots stay
merge-overwrite (engine default) as merge, and the action's other slots (keys with --include-keyboard) are freed
clean (GUI default) the flight slots of what the export writes are freed: the keyboard keys when keys are exported
  • --nuke-untouched-devices: no other device to clear, the game reads one joystick.
  • Joystick binds: the device with the most binds is kept, the others are skipped ("use the virtual joystick"); those binds are then not written either, with a warning, while the numbering is unconfirmed.
  • Never touched: infantry, ground vehicle, transport and gunner binds, mouse and pad slots, keys on axis actions, keys without --include-keyboard, joystick slots, the binary PROFSAVE files.
  • Safety: refused while bf6 runs; backed up first (.jpbak and the backup store, undo: engine backups list); the profile is kept as "Before export to Battlefield 6". --dry-run writes nothing.
Technical internals

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

In the game Writes into Battlefield 6's control files while the game is closed (refused while it runs), after a backup. Arcade flight games and shooters that read one joystick, only Xbox pads, or a fixed layout (docs: one-device-games.md). Bind file: Documents\Battlefield 6\settings\steam\PROFSAVEbf6mp_profile + PROFSAVE_profile (text, GstKeyBinding). Battlefield 6 details · what each mode changes

Example

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

#engine bf6 refresh-db

written
engine bf6 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 Battlefield 6 command list from your own settings profile: every jet and helicopter control it has. Start the game once first, so the profile exists. Update on the Battlefield 6 card of the Start page runs it.

engine bf6 refresh-db --dry-run --text
Advanced
  • Reads the jet and helicopter concepts of the file engine bf6 paths lists first, or of a PROFSAVE..._profile file given as path (positional or --path). A folder given as path is searched (with its subfolders) for the profile with binds, the multiplayer one first.
  • A control counts as an axis when one of its slots holds the second half of an axis or a mouse axis.
  • The list is rebuilt from the profile. --dry-run writes nothing; otherwise the list is written only when it changed.
  • Refused when Battlefield 6 is not installed or switched off in Settings > Games; the game may run.
Technical internals
  • Output: JSON of the refresh (DryRun, FilesWritten, Steps such as Read the jet and helicopter controls from <file> (<n> action(s)). and Actions: <old> -> <new>, Warnings, Errors), or a text report with --text.
  • Exit code 0; 1 when no profile is found (No Battlefield 6 settings profile found (start the game once, or pass the PROFSAVE..._profile file).); the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\Battlefield6\actions.tsv.
  • Related: engine bf6 catalog, engine bf2042 refresh-db; game page battlefield.

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