JoyPro2 Discord GitHub
Engine (CLI)

engine elite (Elite Dangerous)

Show:

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

#engine elite paths

written
engine elite paths
For beginners

Lists where JoyPro finds the Ship controls preset of Elite Dangerous on this PC. The first one is what engine elite scan, engine elite import and engine elite 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 elite paths --text
Advanced
  • The Ship preset <preset>.4.<minor>.binds (the highest minor version) in %LOCALAPPDATA%\Frontier Developments\Elite Dangerous\Options\Bindings\; StartPreset.4.start names the preset (else Custom).
  • A stock preset has no file: nothing is listed and a warning says to change one control in Elite (Options > Controls, Ship) and save, so the game creates Custom.4.x.binds.
  • 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

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

#engine elite catalog

written
engine elite catalog
For beginners

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

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

#engine elite scan

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

Shows the joystick binds Elite Dangerous 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 elite scan --text
Advanced
  • It reads the preset's ship flight binds with up to three modifiers per place and the throttle's axis range.
  • Path (positional or --path): another .binds file.
  • --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 JoyPro reads in this game are listed too; engine elite import takes them only with --include-keyboard.
  • 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 ("Elite Dangerous (experimental) Scan", "Config:", "Bindings Read:" and the list).
  • Exit code 0; 1 when the result has errors, for example No Elite Dangerous (experimental) config file found. Pass the path explicitly.
  • Unknown options fail with Unknown EliteDangerous 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 elite import, engine elite paths, engine elite catalog; game page elite-dangerous.

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

Example

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

written
engine elite 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 ship flight binds of your Elite Dangerous preset into your JoyPro profile, with invert, dead zone and the throttle range. Nothing in the game changes. The GUI runs it with Import on the Elite Dangerous card of the Start page.

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

It reads the Ship preset's <preset>.4.<minor>.binds in %LOCALAPPDATA%\Frontier Developments\Elite Dangerous\Options\Bindings\ (StartPreset.4.start says which preset each category uses).

  • Default: adds to the open profile (--merge means the same); --replace replaces every relation of the profile by what the preset has.
  • --include-keyboard also reads the keyboard keys of the flight actions. Up to three modifiers per place (keys or buttons of any device) become JoyPro modifiers.
  • The throttle's Throttle Axis Range comes back as the relation's Slider (forward only) or no Slider (full range). Invert keeps DCS's direction: for pitch, throttle and the vertical thrusters the file's Inverted is turned over.
  • A bind that uses half an axis as a button or modifier is skipped with a warning (the export leaves it in the game).
  • Safety: reads only, not refused while the game runs; the profile is kept as "Before import from Elite Dangerous (experimental)" 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 Elite Dangerous (experimental) config file found. Pass the path explicitly.).
  • Without a path it reads the file engine elite paths lists first; a fresh install builds the command list from the game's presets first.
  • With --profile the profile is saved afterwards; a game JoyPro never exported to is watched from now on.
  • Related: engine elite scan, engine elite export, engine starcitizen import; game page elite-dangerous.

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

Example

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

written
engine elite 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 ship flight actions: clean and nuke release those on the written / unused devices; --ignore-device(s) and --vjoy-tunnel devices are never cleared

For beginners

Writes your ship flight binds into your Elite Dangerous Ship preset (Custom.4.x.binds) in place; everything else in the file stays. Close the game first, and save your controls once in the game so the preset exists. The GUI's Export now on the Elite Dangerous card runs it.

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

Elite keeps two places (Primary, Secondary) per action. Every mode works on ship flight actions and on the places of connected joysticks only.

--mode In the preset
add a bind goes only into a free place; a bind whose input another flight action uses gets a mark "Not written to the game"
merge the place of another flight action on your input is released; your bind takes a free place first
merge-overwrite (engine default) as merge, and every action you bind loses its other places on your joysticks (keyboard only with --include-keyboard)
clean (GUI default) on the devices you write, every flight place not in your profile is emptied ({NoDevice})
  • --nuke-untouched-devices: the same for the flight places of connected joysticks the export does not use (not with add).
  • A place holding a keyboard key, a mouse or pad input or a device JoyPro does not write is never overwritten; with no place left the bind is listed under "Binds Not Written, No Free Place In The Game" (every mode).
  • --include-keyboard writes your flight keys; the keyboard is never cleared. Galaxy map actions are written only when General and Ship use the same file. Game settings you stored (yaw into roll, head look ...) change only keys the file has; a profile without Elite binds writes only those.
  • Never touched: SRV, on-foot, camera, UI and mouse actions, half-axis binds, <Hold> and <ToggleOn>, StartPreset.4.start, the install folder, devices that are not connected, --ignore-device(s), the --vjoy-tunnel device. Two identical sticks are both skipped.
  • Safety: refused while EliteDangerous64 runs; backed up first (.jpbak and the backup store, undo: engine backups list); the profile is kept as "Before export to Elite Dangerous (experimental)". --dry-run writes nothing.
Technical internals
  • Output: JSON of the export result (SkippedTakenInputs with the reason per bind) or a text report with --text; exit code 1 on an error (Elite Dangerous (experimental) is running (...). Close the game first; it overwrites its config on exit., an invalid --mode, no preset found).
  • Without a path it writes the preset engine elite paths lists first. Line endings, tabs and unknown elements stay byte for byte.
  • After a real run: <preset>.binds.joypro-meta.json, the watcher's fingerprint, the export marks (engine export-marks list).
  • The help note says "only ship flight actions": clean and nuke release only the ship flight actions of the command list on the written and unused devices.
  • Related: engine elite import, engine ffb set, engine export-marks dismiss; game page elite-dangerous.

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

In the game Writes into Elite Dangerous's control files while the game is closed (refused while it runs), after a backup. Space sims: clean and nuke touch only the cataloged ship actions, on-foot and vehicle binds stay. Bind file: %LOCALAPPDATA%\Frontier Developments\Elite Dangerous\Options\Bindings\<preset>.4.x.binds (XML). Elite Dangerous details · what each mode changes

Example

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

#engine elite refresh-db

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

Builds JoyPro's Elite Dangerous command list from the game's control presets, 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 elite refresh-db --dry-run --text
Advanced
  • Without a path it reads every .binds file of your Options\Bindings folder and of the game folder (ControlSchemes, Products\*\ControlSchemes). Path: one .binds file or a folder.
  • Kept: the ship flight elements (an element with <Binding> is an axis, with <Primary>/<Secondary> a button); SRV, on-foot, camera and UI elements are counted and left out.
  • Known actions keep their entry.
  • --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: No Elite Dangerous .binds files were found. Pass the game folder, its ControlSchemes folder or a .binds file (engine elite refresh-db <path>), or set the game folder (engine games install set EliteDangerous <folder>).; the list stays unchanged.
  • Writes %LOCALAPPDATA%\JoyPro2\GameData\DB\EliteDangerous\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 elite catalog, engine elite scan, engine db check-updates; game page elite-dangerous.

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