14 commands of engine dcs. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.
engine dcs scan [<saved-games-path>] [--path <saved-games-path>] [--plane <name>] [--planes <csv>] [--device <name>] [--devices <csv>] [--ignore-device <name>] [--ignore-devices <csv>] [--include-keyboard true|false] [--ignore-easy-planes true|false] [--include-defaults] [--import-inverted] [--import-slider] [--import-curvature] [--import-deadzone] [--import-saturation-x] [--import-saturation-y] [--only-connected true|false] [--merge-same-name true|false] [--confirm true|false]
For beginners
Shows what an import from DCS would bring, without changing your profile or DCS. Use it to look before you import,
for example to see which aircraft and devices JoyPro finds. The Start page's Look first / Scan runs it.
engine dcs scan "C:\Users\Pilot\Saved Games\DCS" --only-connected true --text
Advanced
Takes the same filters and settings as engine dcs import (--plane(s), --device(s), --ignore-device(s),
--include-defaults, --include-keyboard, --ignore-easy-planes, the --import-* axis settings, --only-connected,
--merge-same-name, --confirm) and reports what they would match. Nothing is written: no profile change, no file in
DCS, no backup.
Technical internals
- Output: the same result as the import (JSON, or a text report with
--text); exit code 0, 1 on an error
(dcs scan failed: ...).
--save-profile and --save-last are import options and refused here, as are the export options (--mode ...).
- Related:
engine dcs import, engine games paths.
What it does Parses DCS input files and previews what would be imported, without applying changes.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--device | <name> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--devices | <csv> | Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle. |
--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. |
--include-keyboard | true false | |
--ignore-easy-planes | true false | |
--include-defaults | switch (no value) | Include defaults in DCS import/scan. |
--import-inverted | switch (no value) | Include axis inversion settings. |
--import-slider | switch (no value) | Include DCS slider axis setting. |
--import-curvature | switch (no value) | Include axis curvature settings. |
--import-deadzone | switch (no value) | Include axis deadzone settings. |
--import-saturation-x | switch (no value) | Include DCS saturation X setting. |
--import-saturation-y | switch (no value) | Include DCS saturation Y setting. |
--only-connected | true false | |
--merge-same-name | true false | |
--confirm | true false | Controls suggestion confirmation (true) vs auto-accept (false). |
Every value as a command line
engine dcs scan --include-keyboard true
engine dcs scan --include-keyboard false
engine dcs scan --ignore-easy-planes true
engine dcs scan --ignore-easy-planes false
engine dcs scan --only-connected true
engine dcs scan --only-connected false
engine dcs scan --merge-same-name true
engine dcs scan --merge-same-name false
engine dcs scan --confirm true
engine dcs scan --confirm false
In the game Reads DCS World's files only; nothing changes in the game. A scan only shows what an import would bring and does not change the profile. DCS World details · what each mode changes
Used by the GUI Start: Look first · Start: Scan
Example
engine dcs scan 'C:\Users\Pilot\Saved Games\DCS.openbeta' --plane 'A-10C_2' --confirm false --text
How the options interact
- If no device include filter is given, all devices are considered.
- Ignore filters (--ignore-device, --ignore-devices) remove matches even if included.
- --confirm false auto-accepts closest suggested device names.
#engine dcs import
writtenengine dcs import [<saved-games-path>] [--path <saved-games-path>] [--merge] [--save-profile <path.pr0file>] [--save-last] [--plane <name>] [--planes <csv>] [--device <name>] [--devices <csv>] [--ignore-device <name>] [--ignore-devices <csv>] [--include-keyboard true|false] [--ignore-easy-planes true|false] [--include-defaults] [--import-inverted] [--import-slider] [--import-curvature] [--import-deadzone] [--import-saturation-x] [--import-saturation-y] [--only-connected true|false] [--merge-same-name true|false] [--confirm true|false]
For beginners
Reads the binds you already have in DCS into your JoyPro profile, one relation per function and button. Use it once
at the start, or after you changed binds inside DCS; nothing in DCS changes. The GUI's Import on the Start page
runs it.
engine dcs import "C:\Users\Pilot\Saved Games\DCS" --merge --include-defaults --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
Reads Saved Games\DCS\Config\Input (or --path) into the profile: one relation per function and input, modifiers
from modifiers.lua, tuning from the files, names and groups from JoyPro's .jp files.
--merge adds to the open profile instead of replacing it.
--include-defaults brings every default bind DCS has active for an imported device (so a clean + nuke export
afterwards leaves DCS as it was).
--plane(s), --device(s) limit what is read; --ignore-device(s) leaves devices out (the --vjoy-tunnel device
is always left out). A device name that does not match exactly is resolved to the closest one; --confirm false
takes the suggestion without asking.
--include-keyboard (default true) reads the keyboard too; --ignore-easy-planes true skips the _easy
variants.
--import-inverted, --import-slider, --import-curvature, --import-deadzone, --import-saturation-x,
--import-saturation-y bring that axis setting into the profile.
--only-connected true skips devices that are not plugged in; --merge-same-name (default true) reads one
device under several Windows IDs as one.
- Safety: reads only; the profile is kept as the version "Before import from DCS" first.
Technical internals
- Output: JSON of the import result, or a text report with
--text (paths, matched aircraft and devices, files and
entries parsed); exit code 0, 1 on an error (dcs import failed: ...).
--save-profile <file> saves the result to that profile file, --save-last to the last used one; with --profile
the profile is saved after the import.
- Export options (
--mode, --nuke-untouched-devices ...) are refused here. A successful import marks DCS as
imported for engine profile game-state.
- Files read:
Config\Input\<aircraft>\joystick|keyboard\*.diff.lua, the .jp files beside them, modifiers.lua.
- Related:
engine dcs scan (the same without changing the profile), engine dcs export, engine sync pending.
What it does Parses DCS input files and applies results to the in-memory profile.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--merge | switch (no value) | Merge import results into existing in-memory profile. |
--save-profile | <path.pr0file> | After import, save profile to this .pr0file path. |
--save-last | switch (no value) | After import, save to last profile path. |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--device | <name> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--devices | <csv> | Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle. |
--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. |
--include-keyboard | true false | |
--ignore-easy-planes | true false | |
--include-defaults | switch (no value) | Include defaults in DCS import/scan. |
--import-inverted | switch (no value) | Include axis inversion settings. |
--import-slider | switch (no value) | Include DCS slider axis setting. |
--import-curvature | switch (no value) | Include axis curvature settings. |
--import-deadzone | switch (no value) | Include axis deadzone settings. |
--import-saturation-x | switch (no value) | Include DCS saturation X setting. |
--import-saturation-y | switch (no value) | Include DCS saturation Y setting. |
--only-connected | true false | |
--merge-same-name | true false | |
--confirm | true false | Controls suggestion confirmation (true) vs auto-accept (false). |
Every value as a command line
engine dcs import --include-keyboard true
engine dcs import --include-keyboard false
engine dcs import --ignore-easy-planes true
engine dcs import --ignore-easy-planes false
engine dcs import --only-connected true
engine dcs import --only-connected false
engine dcs import --merge-same-name true
engine dcs import --merge-same-name false
engine dcs import --confirm true
engine dcs import --confirm false
In the game Reads DCS World'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. DCS World details · what each mode changes
Used by the GUI Start: Import now · Start: Import
Example
engine dcs import 'C:\Users\Pilot\Saved Games\DCS.openbeta' --device 'VKB Gladiator NXT' --merge --save-profile 'C:\JoyPro\profiles\dcs_import.pr0file' --text
How the options interact
- If no device include filter is given, all devices are considered.
- Ignore filters (--ignore-device, --ignore-devices) remove matches even if included.
- --confirm false auto-accepts closest suggested device names.
- --save-profile and --save-last are valid on import commands only.
#engine dcs export
writtenengine dcs export [<saved-games-path>] [--path <saved-games-path>] [--mode clean|add|merge|merge-overwrite] [--keep-keyboard-defaults true|false] [--clear-keyboard-defaults true|false] [--nuke-untouched-devices true|false] [--clean-all-aircraft true|false] [--plane <name>] [--planes <csv>] [--ignore-device <name>] [--ignore-devices <csv>]
Only these aircraft; writes .diff.lua + .jp backup + modifiers.lua named as DCS names the device; the .diff.lua holds only differences from DCS's defaults (added non-default binds, removed defaults, defaults with other tuning as changed); add never deletes and lists binds whose button the game uses for another function (SkippedTakenInputs); merge removes a game bind on a button the profile puts another function on; merge-overwrite also takes the profile's actions off their other buttons in that aircraft; clean replaces the written devices in the exported aircraft, with --clean-all-aircraft true (default false) also in every other aircraft; nuke: connected devices without binds in an exported plane lose all binds there, DCS defaults included (--ignore-device(s) and --vjoy-tunnel devices are never cleared); the keyboard is never cleared or nuked: --keep-keyboard-defaults false writes the profile's keyboard binds and removes only the DCS default keys they take, --clear-keyboard-defaults true also removes every other DCS keyboard default of those aircraft
For beginners
Writes your profile's binds into DCS, so the game's controls menu shows them. Use it after you changed binds in JoyPro
and want to fly with them; the GUI's Export now on the DCS card runs it. Close DCS first.
engine dcs export --mode clean --nuke-untouched-devices true --planes "F-16C_50|FA-18C_hornet" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
For each device and aircraft it computes the binds DCS has active (the device's defaults minus the file's removals,
plus its additions and changes), decides which shall be active by the mode, and writes only real differences from
DCS's defaults into <aircraft>\joystick\<device>.diff.lua, with JoyPro's .jp beside it and the aircraft's
modifiers.lua.
--mode |
--nuke-untouched-devices |
In DCS, in the exported aircraft |
clean |
true (GUI default) |
your devices hold exactly your binds; connected devices without binds are emptied (defaults too) |
clean |
false |
your devices hold exactly your binds; other devices unchanged |
merge-overwrite (engine default) |
true / false |
your binds win on their inputs, each bound action loses its other inputs; other binds stay; nuke as above |
merge |
true / false |
your binds win on their inputs; the game's other binds and defaults stay (a moved action keeps its old input) |
add |
(not used) |
nothing removed; a bind on an input DCS uses for another function is not written and reported (SkippedTakenInputs) |
--clean-all-aircraft true (default false) also clears the written devices in every other installed aircraft (not
UiLayer or Camera).
- Keyboard: never cleared or nuked.
--keep-keyboard-defaults false writes the profile's keyboard binds and removes
only the DCS default keys they take; --clear-keyboard-defaults true removes every DCS keyboard default of those
aircraft.
--plane / --planes limit the export to these aircraft (several names separated by |, , or ;).
- Never touched: devices passed with
--ignore-device(s) and the --vjoy-tunnel device are never cleared.
- Safety: refused while DCS runs; every file is backed up first (undo:
engine backups restore) and the profile is kept
as the version "Before export to DCS".
Technical internals
- Output: JSON of the export result, or a text report with
--text (written to --out when given); exit code 0, 1
when the export reports an error (dcs export failed: ... on stderr) or DCS runs.
- Without a path it uses the detected Saved Games folder (
Auto-detected DCS Saved Games path: ... on stderr); none
found fails with a hint to engine games paths.
- Import options (
--device, --include-defaults, --confirm ...) are refused here.
- After a successful run it records the export for
engine sync pending and stores the binds an "Only add" run could not
write as export marks (engine export-marks list); the profile is saved quietly when those marks changed.
- Related:
engine dcs import, engine dcs verify-clean, engine profile game-state, engine backups list.
What it does Writes current profile mappings back to DCS-compatible files.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--mode | clean add merge merge-overwrite | Export mode for DCS/IL2 export commands: clean, add, merge, merge-overwrite. |
--keep-keyboard-defaults | true false | DCS export only: keep existing keyboard defaults/keyboard diff files untouched (true/false). |
--clear-keyboard-defaults | true false | |
--nuke-untouched-devices | true false | DCS export only: delete untouched device .diff.lua/.jp files under Config\\Input (true/false). |
--clean-all-aircraft | true false | |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--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 dcs export --mode clean
engine dcs export --mode add
engine dcs export --mode merge
engine dcs export --mode merge-overwrite
engine dcs export --keep-keyboard-defaults true
engine dcs export --keep-keyboard-defaults false
engine dcs export --clear-keyboard-defaults true
engine dcs export --clear-keyboard-defaults false
engine dcs export --nuke-untouched-devices true
engine dcs export --nuke-untouched-devices false
engine dcs export --clean-all-aircraft true
engine dcs export --clean-all-aircraft false
In the game Writes into DCS World'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: Saved Games\DCS\Config\Input\<aircraft>\joystick\<device>.diff.lua (Lua diff), keyboard and modifiers.lua; .jp sidecar. DCS World details · what each mode changes
Used by the GUI Start: Export · Export: Preview · Export: Export now · Export: Export DCS
Example
engine dcs export 'C:\Users\Pilot\Saved Games\DCS.openbeta' --text
How the options interact
- Import-only filters/settings are not valid for export commands.
- --mode is valid for DCS export and IL2 export.
- --keep-keyboard-defaults controls whether keyboard files are preserved untouched.
- --nuke-untouched-devices deletes non-exported device files (except keyboard when keep-keyboard-defaults is true).
#engine dcs defaults cut
writtenengine dcs defaults cut [<saved-games-path>] [<dcs-install-path>] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--backup-path <path>] [--dry-run]
Older way, the GUI uses dcs device-luas remove: in every <install>\Mods\aircraft\<module>\Input\<input>\joystick folder every file except default.lua is moved into BACKUP_JOYSTICK_DEFAULTS, default.lua is copied there; refused while DCS or DCS_updater runs; --dry-run only counts
For beginners
The older way to move DCS's device-specific default files out of the DCS installation: into
Saved Games\DCS\BACKUP_JOYSTICK_DEFAULTS. The GUI no longer runs it; its switch Remove DCS's device-specific
default files from the install uses engine dcs device-luas, which keeps the files in JoyPro's own folder and moves
them again after a DCS update. Close DCS first.
engine dcs defaults cut --path "C:\Users\Pilot\Saved Games\DCS" --install-path "D:\DCS World" --text
Advanced
- Paths: the Saved Games folder (first positional,
--path or --saved-games) and the DCS installation (second
positional or --install-path); missing ones are detected (Auto-detected DCS ... path: ... on stderr). The
installation may also be given as its Mods or Mods\aircraft folder.
--backup-path <folder> moves the files into another folder (default <Saved Games>\BACKUP_JOYSTICK_DEFAULTS).
- In every
Mods\aircraft\<aircraft>\Input\<input>\joystick folder, default.lua is copied into the backup folder
(it stays in DCS) and every other file of the folder is moved there, under <aircraft>\Input\<input>\joystick.
A file of the same name in the backup folder is replaced.
- Safety: every moved file and every file it creates or replaces in the backup folder goes into a game backup set
first (undo:
engine backups restore, or engine dcs defaults restore for the backup folder). --dry-run counts
the files it would move and copy and changes nothing (also while DCS runs). Refused while DCS or DCS_updater
runs, and when DCS is not installed or switched off in Settings > Games.
Technical internals
- Output: JSON of the result (
Action cut, the paths, AircraftRoot, AircraftScanned, JoystickFoldersScanned,
DefaultFilesCopied, StickSpecificFilesMoved, DryRun, Warnings, Errors), or text with --text ("DCS Stick
Defaults", Dry Run: true ... on a dry run).
- Exit code
0; 1 with dcs defaults cut failed: ... (for example Couldn't find DCS install aircraft path under: <path> or a file that could not be moved; the result is printed first), DCS is running (...). Close DCS and its updater before dcs defaults cut., when a path is missing (... requires a DCS Saved Games path. Try: engine games paths --game DCS --text) or with Unknown dcs defaults argument(s): ....
- Only
Mods\aircraft of the installation is looked at, not Saved Games\DCS\Mods.
- Related:
engine dcs defaults restore, engine dcs device-luas, engine dcs strip-defaults; game page dcs.
What it does The older way to take DCS's device default files out of the installation (the GUI uses dcs device-luas remove): in every <install>\Mods\aircraft\<module>\Input\<input>\joystick folder every file except default.lua is moved into BACKUP_JOYSTICK_DEFAULTS, and default.lua is copied there. Refused while DCS or DCS_updater runs; --dry-run only counts.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--backup-path | <path> | Override backup folder path for dcs defaults cut/restore. Default: <saved-games>\\BACKUP_JOYSTICK_DEFAULTS. |
--dry-run | switch (no value) | Count the files that would be moved or copied; nothing is changed (also while DCS runs). |
Example
engine dcs defaults cut 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --dry-run --text
engine dcs defaults cut 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --text
How the options interact
- If paths are omitted, the command tries to auto-detect DCS Saved Games and install locations.
- Only the joystick folders under Mods\aircraft of the installation: every file except default.lua is moved into the backup, default.lua is copied.
- Refused while DCS or DCS_updater runs; --dry-run counts the files and changes nothing.
- The GUI uses dcs device-luas remove instead (it keeps files other Lua files refer to and the UI layer).
- Default backup location is \BACKUP_JOYSTICK_DEFAULTS unless --backup-path is provided.
#engine dcs defaults restore
writtenengine dcs defaults restore [<saved-games-path>] [<dcs-install-path>] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--backup-path <path>] [--dry-run]
Copies the files of BACKUP_JOYSTICK_DEFAULTS back into Mods\aircraft; refused while DCS or DCS_updater runs; --dry-run only counts
For beginners
Puts back the device default files an older JoyPro moved out of the DCS installation into
Saved Games\DCS\BACKUP_JOYSTICK_DEFAULTS. Use it once if an older JoyPro version moved them. The GUI's Put back
files an older JoyPro moved (Settings > DCS: default binds, "Folders and older JoyPro backups") runs it after asking.
Close DCS first.
engine dcs defaults restore --path "C:\Users\Pilot\Saved Games\DCS" --install-path "D:\Games\DCS World"
Advanced
- Paths: the Saved Games folder (first positional or
--path) and the DCS installation (second positional or
--install-path); missing ones are detected (Auto-detected DCS ... path: ... on stderr).
--backup-path <folder> reads another backup folder (default <Saved Games>\BACKUP_JOYSTICK_DEFAULTS).
- Every aircraft folder of the backup is copied back into
<install>\Mods\aircraft\<aircraft>, with its subfolders;
existing files are replaced. Each replaced file goes into a game backup set first (undo:
engine backups restore).
- Refused when DCS is not installed, and while
DCS or DCS_updater runs. --dry-run counts the files and folders
it would copy and changes nothing (also while DCS runs). Today's way to move these files is engine dcs device-luas.
Technical internals
- Output: JSON of the result (paths, aircraft scanned, folders touched, files restored,
DryRun, warnings, errors), or
text with --text (Dry Run: true ... on a dry run).
- Exit code
0; 1 with dcs defaults restore failed: ... (no Mods\aircraft in the installation, no backup
folder) or when a path is missing (... requires a DCS Saved Games path. Try: engine games paths --game DCS --text).
- Related:
engine dcs defaults cut, engine dcs strip-defaults, engine dcs device-luas.
What it does Copies the files of BACKUP_JOYSTICK_DEFAULTS back into the DCS installation's Mods\aircraft folders. Refused while DCS or DCS_updater runs; --dry-run only counts.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--backup-path | <path> | Override backup folder path for dcs defaults cut/restore. Default: <saved-games>\\BACKUP_JOYSTICK_DEFAULTS. |
--dry-run | switch (no value) | Count the files that would be copied back; nothing is changed (also while DCS runs). |
Used by the GUI Settings: Put back files an older JoyPro moved
Example
engine dcs defaults restore 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --text
How the options interact
- If paths are omitted, the command tries to auto-detect DCS Saved Games and install locations.
- Restores files by copying backup aircraft input folders back into Mods\aircraft.
- Refused while DCS or DCS_updater runs; --dry-run counts the files and changes nothing.
- Default backup location is \BACKUP_JOYSTICK_DEFAULTS unless --backup-path is provided.
#engine dcs strip-defaults
writtenengine dcs strip-defaults [apply|restore|status|auto] [--dry-run] [--restore] [--skip-ui-layer true|false] [--remember true|false] [--install-path <dcs-install-path>] [--saved-games <saved-games-path>] [--luae <luae.exe>] [--no-load-check] [--status]
Switches DCS's default joystick binds off in the DCS install: wraps every joystick profile lua, combos = nil, backup <file>.nocombo.bak; restore (--restore) puts the originals back; status (--status) shows the state; auto re-applies after a DCS update; patched files fail server integrity checks
For beginners
Switches DCS's own default joystick binds off inside the DCS installation, for every device, also the ones JoyPro
does not write. JoyPro's exports already remove the default binds of the devices they write, so this is an extra
option, off by default. The GUI's Strip DCS default binds in the DCS install (Settings > DCS: default binds)
runs it after asking; Preview files, Apply now, Restore DCS files and Check again use it too. Close
DCS first.
engine dcs strip-defaults apply --dry-run --text
Advanced
| Action |
What it does |
apply (default) |
patches every joystick input file of DCS that is not patched yet and remembers the switch |
restore (or --restore) |
puts every patched file back from its backup, the UI layer too, and switches it off |
status (or --status, also before the action word) |
counts the files: patched, not patched, device files in DCS and kept by JoyPro; changes nothing |
auto |
does again what is switched on (this option and engine dcs device-luas); nothing to do when both are off |
- The files: each
*.lua in a folder named joystick below <DCS>\Mods, <DCS>\Config and
Saved Games\DCS*\Mods (not below a keyboard folder, not *.diff.lua) that has keyCommands, axisCommands
or external_profile. Saved Games\DCS\Config\Input, where your own binds are, is never touched.
- Patching wraps the original file in a function and sets
combos = nil on every entry of what it returns, so DCS
loads the same commands without default binds. The first line is the marker -- [[DCS_STRIP_JOYSTICK_DEFAULTS v1]]
and the original is kept as <file>.nocombo.bak: the same marker and backup name as the community strip script,
so either one restores the other's files.
- After patching, DCS's own Lua (
bin\luae.exe, or --luae <file>) loads every patched file next to its original;
a file it cannot load is put back at once. --no-load-check skips this check (meant for tests).
--skip-ui-layer [true|false] leaves the files of the UI layer (UiLayer\joystick: menus and VR controllers)
unpatched; without it the last choice is used (GUI: Keep the UI layer's default binds (menus, VR)).
--remember false patches or restores without changing the stored switch (default true).
--install-path <folder> and --saved-games <folder> (also --path) pick the folders; without them the detected
DCS installation and every Saved Games\DCS* folder are used.
- After a DCS update or repair the original files are back: with the switch on, JoyPro runs
auto at its start and
before every headless DCS list refresh (engine dcs refresh clean and engine dcs refresh id; the click flow with
--headless-lua false does not).
--remove is refused here (dcs strip-defaults has no --remove: --restore ...); it belongs to
engine dcs device-luas.
- Safety:
apply and restore are refused while DCS or DCS_updater runs; --dry-run lists the files and
writes nothing (also while DCS runs). Patched files fail the integrity check of multiplayer servers that enforce it
(pure scripts / IC); restore puts DCS's files back. A missing write access to the DCS folder stops the run.
Technical internals
- Output: JSON of the result (
Action, DryRun, InstallPath, SavedGamesPaths, DcsVersion, StripEnabled,
SkipUiLayer, RemoveDeviceLuas, CleanProfilesStale, ProfileFiles, Patched, AlreadyPatched, NotPatched,
Restored, LoadChecked, LoadCompared, DefaultBindsSwitchedOff, the device file counts, NeedsReapply,
IntegrityNote, Files, Warnings, Errors), or text with --text ("DCS default binds in the install").
- Exit code
0; 1 with dcs strip-defaults <action> failed: ... (the result is printed first), for example DCS World was not found. Set its folder in Settings > Games or pass --install-path., DCS is running (...). Close DCS and its updater first., DCS's Lua cannot load the patched <file> (...); the original was put back. or No backup <file>.nocombo.bak for the patched <file>: repair DCS (DCS_updater.exe repair) to get the original back. Also
Unknown dcs strip-defaults action: <x> (use apply, restore, status or auto). and Unknown dcs strip-defaults argument(s): .... Without an action word the message names apply.
- The switches are kept in
%LOCALAPPDATA%\JoyPro2\DcsDefaults\state.json.
- Related:
engine dcs device-luas, engine dcs verify-clean, engine dcs export; game page dcs.
What it does Switches DCS's default joystick binds off in the DCS installation (every joystick profile lua wrapped, combos = nil, original kept as <file>.nocombo.bak), or restores the originals; status and auto (re-apply after a DCS update).
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | List the files that would be patched or restored; nothing is changed. |
--restore | switch (no value) | dcs strip-defaults / device-luas: put the original DCS files back (same as the restore action). |
--skip-ui-layer | true false | dcs strip-defaults: leave Config\\Input\\UiLayer unpatched (true/false; the flag alone means true). |
--remember | true false | dcs strip-defaults / device-luas: keep the switch for automatic re-apply after DCS updates (default true). |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--saved-games | <saved-games-path> | Saved Games\\DCS folder whose Mods are included (default: every Saved Games\\DCS* folder found). |
--luae | <luae.exe> | Path to DCS's luae.exe for the load check (default: the install's bin\\luae.exe). |
--no-load-check | switch (no value) | dcs strip-defaults: skip the check with DCS's own Lua loader after patching (tests only). |
--status | switch (no value) | Show the state (the same as the action status). |
Every value as a command line
engine dcs strip-defaults --skip-ui-layer true
engine dcs strip-defaults --skip-ui-layer false
engine dcs strip-defaults --remember true
engine dcs strip-defaults --remember false
Example
engine dcs strip-defaults apply --dry-run --text
engine dcs strip-defaults apply --skip-ui-layer --text
engine dcs strip-defaults status --text
engine dcs strip-defaults --restore --text
How the options interact
- Off by default. Patched DCS files fail the integrity check of multiplayer servers that enforce it.
- Same marker (-- [[DCS_STRIP_JOYSTICK_DEFAULTS v1]]) and backup name as the community strip script; either one restores the other's files.
- apply remembers the switch; JoyPro re-applies it at its start (auto) and before every headless DCS list refresh (dcs refresh clean and dcs refresh id; the click flow does not). restore switches it off.
- --status shows the state (as status); --remove is refused here (use --restore, or dcs device-luas remove).
- Never touches Saved Games\DCS\Config\Input. Refused while DCS or DCS_updater runs.
#engine dcs device-luas
writtenengine dcs device-luas [list|remove|restore] [--dry-run] [--remove] [--restore] [--status] [--remember true|false] [--install-path <dcs-install-path>] [--saved-games <saved-games-path>]
Moves the device-specific default files of the DCS install (<device type>.lua, template diffs) into JoyPro's backup folder so default.lua applies; restore puts them back; list (also --status) shows them
For beginners
Moves DCS's default files for single devices ("Joystick - HOTAS Warthog.lua" and similar) out of the DCS installation
into JoyPro's backup folder, so DCS uses its general default.lua for every device; restore puts them back. Off by
default. The GUI's Remove DCS's device-specific default files from the install (Settings > DCS: default binds)
runs it after asking, then rebuilds the DCS list once; Preview device files runs list. Close DCS first.
engine dcs device-luas list --text
Advanced
| Action |
What it does |
list (default; also status or --status) |
the device files DCS has now; changes nothing |
remove (or --remove) |
moves them into JoyPro's backup folder and remembers the switch |
restore (or --restore) |
puts every kept file back and switches it off |
- The files:
<device type>.lua (not default.lua) and template diffs <device type>.diff.lua in the joystick
folders below <DCS>\Mods, <DCS>\Config and Saved Games\DCS*\Mods. A file another Lua file of the module's
Input folder names (a shared part) stays, and so does the UI layer (the VR controllers' defaults).
- A file patched by
engine dcs strip-defaults takes its .nocombo.bak along, and gets it back on restore.
- After a DCS update brought files back,
remove (or auto of engine dcs strip-defaults) moves them again; the
newer file replaces JoyPro's older copy. On restore a file DCS already brought back stays (warning "Kept the file
DCS brought back").
--remember false moves or restores without changing the stored switch (default true).
--install-path <folder> and --saved-games <folder> (also --path) pick the folders.
- After
remove or restore JoyPro's DCS clean profiles no longer match what DCS loads: rebuild them with
engine dcs refresh clean (the GUI does it); until then engine dcs export warns.
- Safety:
remove and restore are refused while DCS or DCS_updater runs; --dry-run lists the files and moves
nothing. A missing write access to the DCS folder stops the run.
Technical internals
- Output: the same result as
engine dcs strip-defaults (DeviceFilesInInstall, DeviceFilesMoved,
DeviceFilesRestored, DeviceFilesBackedUp, CleanProfilesStale, Files, Warnings, Errors), or text with
--text.
- Exit code
0; 1 with dcs device-luas <action> failed: ..., for example JoyPro's copy of <file> is missing (...): repair DCS to get it back., or Unknown dcs device-luas action: <x> (use list, remove or restore).
- The files are kept in
%LOCALAPPDATA%\JoyPro2\DcsDefaults\DeviceLuas\<folder hash>\ with manifest.json
(original path, SHA-256, time moved). restore also names a BACKUP_JOYSTICK_DEFAULTS folder an older JoyPro left
(engine dcs defaults restore).
- Related:
engine dcs strip-defaults, engine dcs defaults restore, engine dcs verify-clean; game page
dcs.
What it does Moves the device-specific default files of the DCS installation into JoyPro's backup folder so DCS uses default.lua for every device, or puts them back.
| Option | Values | Meaning |
|---|
--dry-run | switch (no value) | List the files that would be moved or put back; nothing is changed. |
--remove | switch (no value) | Move the device files away (the same as the action remove). |
--restore | switch (no value) | dcs strip-defaults / device-luas: put the original DCS files back (same as the restore action). |
--status | switch (no value) | List the device files and where they are (the same as the action list). |
--remember | true false | dcs strip-defaults / device-luas: keep the switch for automatic re-apply after DCS updates (default true). |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--saved-games | <saved-games-path> | Saved Games\\DCS folder whose Mods are included (default: every Saved Games\\DCS* folder found). |
Every value as a command line
engine dcs device-luas --remember true
engine dcs device-luas --remember false
Example
engine dcs device-luas list --text
engine dcs device-luas remove --text
engine dcs device-luas restore --text
How the options interact
- Files another Lua file of the module refers to stay; so does the UI layer (VR controllers).
- The moved files and manifest.json are in \DcsDefaults\DeviceLuas. Rebuild the DCS clean profiles afterwards (the GUI does it).
#engine dcs verify-clean
writtenengine dcs verify-clean [<saved-games-path>] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--plane <name>] [--planes <csv>] [--device <name>] [--devices <csv>] [--include-disconnected true|false] [--max-listed <n>] [--dump-active <file>]
DCS's own Lua lists the default binds still active on the joysticks with the files of that Saved Games folder; --dump-active writes every active bind, one sorted line each, to compare before and after an export; read only
For beginners
Checks which of DCS's default binds are still active on your joysticks with the binds of a Saved Games folder, using
DCS's own input code without starting the game. After a clean export it should find none on the devices JoyPro wrote.
It only reads.
engine dcs verify-clean "C:\Users\Pilot\Saved Games\DCS" --text
Advanced
- Path: the Saved Games folder (positional,
--path or --saved-games) and --install-path; missing ones are
detected.
--plane <name> / --planes <a|b> checks only those aircraft (an unknown name fails: Plane filter was provided, but no DCS headless profile candidates matched.).
--device <name> / --devices <a|b> checks only those devices: the DCS device name, its template name, or a part
of the name. Lists take |, , or ;.
- Checked are the joysticks connected now;
--include-disconnected true also the devices that only have files, each
through a fake stick of its type.
--max-listed <n> limits the listed defaults (default 200); the counts are always complete.
--dump-active <file> writes every bind DCS has active on the checked joysticks (not only defaults), one sorted line
profile|device|kind|command hash|key|modifiers|filter each: run it before and after an export and compare.
- Safety: works on a temporary copy of
Config\Input (wizard.lua, disabled.lua, each aircraft's modifiers.lua
and joystick\*.diff.lua); the Saved Games folder is not changed. Not refused while DCS runs.
Technical internals
- Output: JSON (
SavedGamesPath, InstallPath, ProfilesChecked, ProfileNames, Devices, DefaultsLeft,
DefaultsLeftOnJoyProDevices, Left with profile, device, kind, command, key and whether JoyPro wrote the file,
ActiveDumpFile, ActiveBinds, Steps, Warnings, Errors), or text with --text ("DCS default-bind check",
the defaults left per device).
- "Defaults Left On JoyPro Devices" counts the defaults on devices whose file JoyPro wrote (a
.jp next to the
.diff.lua).
- Exit code
0; 1 with dcs verify-clean failed: ..., for example luae.exe was not found under the DCS install's bin folder., The DCS default-bind check timed out. (15 minutes), DCS Saved Games path does not exist: <path>,
Invalid --max-listed value: '<x>'. or Unknown dcs verify-clean argument(s): .... The dump file is written only
without errors.
- Related:
engine dcs export, engine dcs strip-defaults, engine dcs device-luas, engine dcs refresh clean; game
page dcs.
What it does Runs DCS's own input code (luae.exe) on a copy of a Saved Games input folder and lists every DCS default bind still active on the joysticks.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--device | <name> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--devices | <csv> | Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle. |
--include-disconnected | true false | dcs verify-clean: also check devices that only have files, through a fake stick of their type (true/false). |
--max-listed | <n> | dcs verify-clean: how many remaining default binds are listed (counts are always complete). |
--dump-active | <file> | |
Every value as a command line
engine dcs verify-clean --include-disconnected true
engine dcs verify-clean --include-disconnected false
Example
engine dcs verify-clean 'C:\Users\Pilot\Saved Games\DCS' --text
engine dcs verify-clean --planes 'FA-18C_hornet' --include-disconnected true --text
How the options interact
- Read only: works on a temporary copy of Config\Input. Needs the DCS installation (luae.exe and Scripts).
- Defaults Left On JoyPro Devices counts remaining defaults on files JoyPro wrote (.jp next to them); after an export it should be 0.
#engine dcs refresh clean
writtenengine dcs refresh clean [<saved-games-path>] [<dcs-install-path>] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--ocr true|false] [--launch true|false] [--keep-running true|false] [--headless-lua true|false] [--plane <name>] [--planes <csv>] [--input-commands auto|on|off] [--dry-run] [--confirm true|false] [--menu-wait-seconds <n>] [--ocr-menu-timeout-seconds <n>] [--settle-seconds <n>] [--default-stick <name>] [--clicks-xml <path>] [--clicks-dir <path>] [--dcs-exe <path>] [--preview-clicks] [--preview-image <path>] [--gui-scale <value>] [--window-left <n> --window-top <n> --window-width <n> --window-height <n>]
Default --headless-lua true: DCS's own Lua builds the clean profiles without starting DCS; only --headless-lua false starts DCS and clicks through its menus
For beginners
Builds JoyPro's DCS "clean profiles": the default binds DCS puts on every device type in every aircraft. The DCS export
removes exactly these from the devices it writes. Use it after a DCS update; it needs DCS installed. The GUI runs it in
headless mode after the first DCS command list was built, after Apply now / Restore DCS files when needed, and
with Refresh Clean DB (Settings > Command lists of DCS, Star Citizen and IL-2).
engine dcs refresh clean --path "C:\Users\Pilot\Saved Games\DCS" --install-path "D:\Games\DCS World" --headless-lua true
Advanced
Two ways, chosen by --headless-lua (default true, in the engine and in the GUI):
- Headless (
--headless-lua true or no --headless-lua): DCS is not started and no window opens. Several copies of DCS's own
bin\luae.exe run in the background, each in a temporary Saved Games folder, load every input profile with a
generic stick and one stand-in stick per device type, clear them and save; those files become the clean profiles.
Your Config\Input is never changed. Before it, JoyPro applies the DCS install options you switched on. The run can
be cancelled until the clean profiles are written.
- Legacy click mode (only with an explicit
--headless-lua false): DCS starts in a window (or a running DCS is used) and JoyPro clicks
through its menus: gear icon, Controls, Clear All, Check All, Yes. Before, Config\Input is copied to
Config\CLInput\Input and removed, and options.lua is set to windowed and GUI scale 1.0; afterwards both come
back, also after an error. Leave mouse and keyboard alone: a moved mouse or another active window stops the run.
| Option |
Meaning |
--plane / --planes |
only these aircraft (headless only) |
--dry-run |
headless: lists the aircraft, writes nothing; legacy: plans the clicks without starting DCS |
--launch true|false |
legacy: start DCS (default true); false needs a running DCS; in headless mode only an explicit --launch warns that it is ignored |
--keep-running |
legacy: leave DCS open afterwards (default false) |
--ocr true|false |
legacy: find the menu entries by picture instead of Clicks.xml positions |
--settle-seconds <n> |
legacy: wait after the clicks (default 60) |
--menu-wait-seconds, --ocr-menu-timeout-seconds |
legacy: waits for the main menu (defaults 45, 600) |
--default-stick, --clicks-xml, --clicks-dir, --dcs-exe, --gui-scale, --window-*, --preview-clicks, --preview-image |
legacy click details; ignored in headless mode (with a warning) |
--confirm (default true) asks "Type 'yes'" in an interactive console; without one the run goes on with a warning.
- Refused when DCS is not installed.
Technical internals
- Output: JSON of the refresh (paths, steps, aircraft, clicks, warnings, errors), or text with
--text; progress lines
with --progress.
- Exit code
0; 1 with dcs refresh clean failed: ..., a missing path (dcs refresh clean requires a DCS Saved Games path. / ... install path.) or an invalid number; 3 when cancelled.
- Writes
CleanProfile\DCS and KeyboardCleanProfile\DCS in the game-data folder (%LOCALAPPDATA%\JoyPro2\GameData).
An aircraft whose Lua run keeps failing keeps its previous clean profiles (a warning names it).
- Related:
engine dcs refresh id, engine dcs verify-clean, engine dcs export, engine db check.
What it does Rebuilds JoyPro's DCS clean profiles (the default binds DCS gives every device type). By default DCS's own Lua (luae.exe) does it without starting DCS; only --headless-lua false starts DCS and clicks Controls -> Clear All.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--ocr | true false | Use OCR image matching click flow instead of fixed XML anchor click offsets (true/false). |
--launch | true false | Click flow only (--headless-lua false): start DCS (true, default) or use a running DCS (false). |
--keep-running | true false | Leave DCS running after refresh command completes (true/false). |
--headless-lua | true false | true (default): DCS's own Lua (luae.exe) builds the clean profiles in temporary folders, DCS is not started and Config\Input is not changed. false: DCS starts in a window and JoyPro clicks through its menus (the legacy click flow). |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--input-commands | auto on off | |
--dry-run | switch (no value) | Headless: list the aircraft, write nothing. Click flow: plan the clicks without starting DCS. |
--confirm | true false | Ask 'Type yes' before the run in an interactive console (true, default); false runs without asking. |
--menu-wait-seconds | <n> | Non-OCR wait time before click automation starts. Example: --menu-wait-seconds 45. |
--ocr-menu-timeout-seconds | <n> | OCR max wait for DCS main menu template detection. Example: --ocr-menu-timeout-seconds 600. |
--settle-seconds | <n> | Post-click settle wait for DCS file writes. Example: --settle-seconds 60. |
--default-stick | <name> | Preferred joystick name for clean profile extraction if that .diff.lua exists. |
--clicks-xml | <path> | Path to Clicks.xml anchor file for non-OCR refresh clicks. |
--clicks-dir | <path> | Folder containing OCR template images (cog1.0.png, controls1.0.png, etc.). |
--dcs-exe | <path> | Explicit DCS executable path override. Example: --dcs-exe 'D:\\Games\\DCS World\\bin\\DCS_updater.exe'. |
--preview-clicks | switch (no value) | Generate click preview data/image while running refresh commands. |
--preview-image | <path> | Output .png path for click preview image overlay. |
--gui-scale | <value> | Override GUI scale multiplier used for high-resolution XML click anchor offsets. |
--window-left | <n> | Manual DCS window left coordinate override (integer). |
--window-top | <n> | Manual DCS window top coordinate override (integer). |
--window-width | <n> | Manual DCS window width override (integer > 0). |
--window-height | <n> | Manual DCS window height override (integer > 0). |
Every value as a command line
engine dcs refresh clean --ocr true
engine dcs refresh clean --ocr false
engine dcs refresh clean --launch true
engine dcs refresh clean --launch false
engine dcs refresh clean --keep-running true
engine dcs refresh clean --keep-running false
engine dcs refresh clean --headless-lua true
engine dcs refresh clean --headless-lua false
engine dcs refresh clean --input-commands auto
engine dcs refresh clean --input-commands on
engine dcs refresh clean --input-commands off
engine dcs refresh clean --confirm true
engine dcs refresh clean --confirm false
Used by the GUI Start: RefreshDbUpdateCommand · Start: Build All Missing Lists · Start: Update · Settings: Apply now · Settings: Restore DCS files · Settings: Refresh Clean DB
Example
engine dcs refresh clean 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --confirm false --text
engine dcs refresh clean 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --plane F-16C_50 --dry-run --text
engine dcs refresh clean 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --headless-lua false --ocr false --preview-clicks --preview-image 'C:\JoyPro\logs\dcs_refresh_clean_preview.png' --confirm false --text
How the options interact
- Requires DCS Saved Games and install paths (auto-detect is attempted when omitted).
- Default (--headless-lua true): DCS is not started; --plane/--planes limit the aircraft; the click options below are ignored with a warning.
- Only with --headless-lua false: DCS starts (--launch) and JoyPro clicks through its menus. Without --ocr, XML click anchors from Clicks.xml are used; with --ocr, template image matching is used.
- --dry-run skips launch/click/file changes and reports planned steps only.
- --default-stick prefers .diff.lua when rebuilding CleanProfile output (click flow).
- --window-left/top/width/height and --gui-scale control non-OCR click coordinate resolution (click flow).
#engine dcs refresh id
writtenengine dcs refresh id [<saved-games-path>] [<dcs-install-path>] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--ocr true|false] [--launch true|false] [--keep-running true|false] [--headless-lua true|false] [--plane <name>] [--planes <csv>] [--input-commands auto|on|off] [--dry-run] [--confirm true|false] [--menu-wait-seconds <n>] [--ocr-menu-timeout-seconds <n>] [--modules-to-scan <n>] [--clicks-xml <path>] [--clicks-dir <path>] [--dcs-exe <path>] [--preview-clicks] [--preview-image <path>] [--gui-scale <value>] [--window-left <n> --window-top <n> --window-width <n> --window-height <n>]
Default --headless-lua true: DCS's own Lua writes the command lists without starting DCS; only --headless-lua false starts DCS and clicks Make HTML per aircraft; the Saved Games folder of the install's DCS variant is read, e.g. DCS.openbeta; --input-commands auto merges the Input Command Injector's Saved Games InputCommands like DCS when the injector is installed, on always, off never
For beginners
Builds JoyPro's DCS command list: every aircraft's actions with their ids and names, from your DCS installation. Use it
after a DCS update or a new module; it needs DCS installed. Update on the DCS card of the Start page and Build All
Missing Lists run it headless; Refresh ID DB (Settings > Command lists of DCS, Star Citizen and IL-2) runs it with
the options set there.
engine dcs refresh id --path "C:\Users\Pilot\Saved Games\DCS" --install-path "D:\Games\DCS World" --headless-lua true --plane F-16C_50
Advanced
- Headless (the default,
--headless-lua true, also the GUI's way): DCS is not started. Several luae.exe runs of DCS's own Lua
read the input profiles (and your Config\Input, read only) and write DCS's per-aircraft HTML lists into a temporary
folder; JoyPro copies them into its command list. Cancelable until the files are copied.
- Legacy click mode (only with an explicit
--headless-lua false): DCS starts in a window and JoyPro clicks gear
icon, Controls, the aircraft list, then Make HTML for one aircraft after the other (arrow down to the next). As in
engine dcs refresh clean, options.lua is set to windowed and GUI scale 1.0 for the run and restored, and a moved
mouse or another active window stops it. --modules-to-scan <n> adds loop rounds on top of the aircraft found.
--plane / --planes, --dry-run, --launch, --keep-running, --ocr, --confirm and the click details work as
in engine dcs refresh clean.
- Refused when DCS is not installed.
What it does Rebuilds JoyPro's DCS command lists (DB HTML per aircraft). By default DCS's own Lua (luae.exe) writes them without starting DCS; only --headless-lua false starts DCS and clicks Controls -> Make HTML per aircraft.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--ocr | true false | Use OCR image matching click flow instead of fixed XML anchor click offsets (true/false). |
--launch | true false | Click flow only (--headless-lua false): start DCS (true, default) or use a running DCS (false). |
--keep-running | true false | Leave DCS running after refresh command completes (true/false). |
--headless-lua | true false | true (default): DCS's own Lua (luae.exe) writes the per-aircraft command lists, DCS is not started. false: DCS starts in a window and JoyPro clicks Make HTML per aircraft (the legacy click flow). |
--plane | <name> | Include one plane/module per flag. Example: --plane A-10C_2. |
--planes | <csv> | Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet. |
--input-commands | auto on off | |
--dry-run | switch (no value) | Headless: list the aircraft, write nothing. Click flow: plan the clicks without starting DCS. |
--confirm | true false | Ask 'Type yes' before the run in an interactive console (true, default); false runs without asking. |
--menu-wait-seconds | <n> | Non-OCR wait time before click automation starts. Example: --menu-wait-seconds 45. |
--ocr-menu-timeout-seconds | <n> | OCR max wait for DCS main menu template detection. Example: --ocr-menu-timeout-seconds 600. |
--modules-to-scan | <n> | Additional module loop count for dcs refresh id export cycle. Example: --modules-to-scan 5. |
--clicks-xml | <path> | Path to Clicks.xml anchor file for non-OCR refresh clicks. |
--clicks-dir | <path> | Folder containing OCR template images (cog1.0.png, controls1.0.png, etc.). |
--dcs-exe | <path> | Explicit DCS executable path override. Example: --dcs-exe 'D:\\Games\\DCS World\\bin\\DCS_updater.exe'. |
--preview-clicks | switch (no value) | Generate click preview data/image while running refresh commands. |
--preview-image | <path> | Output .png path for click preview image overlay. |
--gui-scale | <value> | Override GUI scale multiplier used for high-resolution XML click anchor offsets. |
--window-left | <n> | Manual DCS window left coordinate override (integer). |
--window-top | <n> | Manual DCS window top coordinate override (integer). |
--window-width | <n> | Manual DCS window width override (integer > 0). |
--window-height | <n> | Manual DCS window height override (integer > 0). |
Every value as a command line
engine dcs refresh id --ocr true
engine dcs refresh id --ocr false
engine dcs refresh id --launch true
engine dcs refresh id --launch false
engine dcs refresh id --keep-running true
engine dcs refresh id --keep-running false
engine dcs refresh id --headless-lua true
engine dcs refresh id --headless-lua false
engine dcs refresh id --input-commands auto
engine dcs refresh id --input-commands on
engine dcs refresh id --input-commands off
engine dcs refresh id --confirm true
engine dcs refresh id --confirm false
Used by the GUI Start: RefreshDbUpdateCommand · Start: Keep DB · Start: Build All Missing Lists · Start: Check Again · Start: Keep All DBs, Hide Notice · Start: Update · Settings: Refresh ID DB
Example
engine dcs refresh id 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --plane F-16C_50 --confirm false --text
engine dcs refresh id 'C:\Users\Pilot\Saved Games\DCS.openbeta' 'D:\Games\Eagle Dynamics\DCS World OpenBeta' --headless-lua false --ocr true --modules-to-scan 0 --confirm false --text
How the options interact
- Requires DCS Saved Games and install paths (auto-detect is attempted when omitted).
- Default (--headless-lua true): DCS is not started; DCS's Lua writes the per-aircraft HTML lists, JoyPro copies them into DB\DCS.
- Only with --headless-lua false: DCS starts, exports per-module HTML and JoyPro copies the largest non-keyboard/mouse/trackir HTML per plane into DB\DCS; --modules-to-scan adds extra loop count on top of detected install/instance module counts.
- --dry-run skips launch/click/file changes and reports planned steps only.
#engine dcs refresh preview-clicks
writtenengine dcs refresh preview-clicks [--ocr true|false] [--path <saved-games-path>] [--install-path <dcs-install-path>] [--clicks-xml <path>] [--clicks-dir <path>] [--preview-image <path>] [--gui-scale <value>] [--window-left <n> --window-top <n> --window-width <n> --window-height <n>]
For beginners
Shows where the legacy click mode of the DCS refreshes would click, as a picture with the click points, without
clicking anything. Use it before a legacy refresh on an unusual screen. The GUI's Preview Clicks (Settings >
Command lists of DCS, Star Citizen and IL-2, legacy mode) runs it. It needs DCS installed.
engine dcs refresh preview-clicks --ocr false --window-left 0 --window-top 0 --window-width 2560 --window-height 1440 --preview-image "C:\Users\Pilot\Pictures\dcs-clicks.png"
Advanced
--ocr false (default): the click points come from Clicks.xml (--clicks-xml, default <program folder>\Clicks)
in the DCS window (a running DCS, or --window-left/-top/-width/-height, all four together), scaled by the GUI scale
of DCS's options or --gui-scale.
--ocr true: looks for the menu pictures (--clicks-dir) on the screen and reports which were found.
--preview-image <file.png>: where the picture goes (default %TEMP%\joypro_dcs_click_preview_<date-time>.png).
- Nothing in DCS or JoyPro's lists changes.
dcs refresh without a verb is this command.
Technical internals
- Output: JSON (window, GUI scale, each click with its name and position, picture path, warnings), or text with
--text.
- Exit code
0; 1 with dcs refresh preview-clicks failed: ..., an incomplete window override (Window override requires --window-left, --window-top, --window-width, and --window-height.) or --plane / --headless-lua (only
for id and clean).
- Related:
engine dcs refresh clean, engine dcs refresh id.
What it does Shows where DCS XML/OCR click anchors resolve on your current screen and writes an annotated preview image.
| Option | Values | Meaning |
|---|
--ocr | true false | Use OCR image matching click flow instead of fixed XML anchor click offsets (true/false). |
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--install-path | <dcs-install-path> | DCS install path override (root folder that contains Mods\\aircraft). |
--clicks-xml | <path> | Path to Clicks.xml anchor file for non-OCR refresh clicks. |
--clicks-dir | <path> | Folder containing OCR template images (cog1.0.png, controls1.0.png, etc.). |
--preview-image | <path> | Output .png path for click preview image overlay. |
--gui-scale | <value> | Override GUI scale multiplier used for high-resolution XML click anchor offsets. |
--window-left | <n> | Manual DCS window left coordinate override (integer). |
--window-top | <n> | Manual DCS window top coordinate override (integer). |
--window-width | <n> | Manual DCS window width override (integer > 0). |
--window-height | <n> | Manual DCS window height override (integer > 0). |
Every value as a command line
engine dcs refresh preview-clicks --ocr true
engine dcs refresh preview-clicks --ocr false
Used by the GUI Settings: Preview Clicks
Example
engine dcs refresh preview-clicks --ocr false --window-left 0 --window-top 0 --window-width 2560 --window-height 1440 --preview-image 'C:\JoyPro\logs\dcs_click_preview.png' --text
How the options interact
- When --ocr false, outputs XML-anchor click landing points for the active/overridden window.
- When --ocr true, attempts live template detection and reports found/missing click targets.
- Writes an annotated preview image (--preview-image or temp path).
#engine dcs ffb list
writtenengine dcs ffb list [--path <saved-games-path>] [--device <name>] [--devices <csv>] [--connected] [--profile-devices] [--confirm true|false]
For beginners
Lists the DCS force feedback direction settings of your devices: swap axes, invert X, invert Y. The GUI's Refresh
Devices in Settings > DCS force feedback runs it to fill the table, and runs it again after every Apply or Clear.
engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" dcs ffb list --connected --text
Advanced
- The list holds the devices of the profile, the connected devices and every device with a stored setting.
--connected shows only connected devices, --profile-devices only the profile's (both together: no filter).
--device <name> / --devices <csv> (or a name as the first argument) limit the list; a name that does not match
exactly is resolved to the closest DCS device name (--confirm false takes it without asking; --path names the
Saved Games folder used for that).
- Read-only. The settings live in the profile, so pass
--profile.
What it does Lists DCS force-feedback inversion/swap settings per device from your profile/device context.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--device | <name> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--devices | <csv> | Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle. |
--connected | switch (no value) | For devices list, show connected devices only. |
--profile-devices | switch (no value) | For devices list, show profile-referenced devices only. |
--confirm | true false | Controls suggestion confirmation (true) vs auto-accept (false). |
Every value as a command line
engine dcs ffb list --confirm true
engine dcs ffb list --confirm false
Used by the GUI Settings: Refresh Devices · Settings: Apply Selected · Settings: Clear Selected · Settings: Clear All · Settings: Apply · Settings: Clear · Settings: Set FFB · Settings: Clear FFB
Example
engine dcs ffb list --text
engine dcs ffb list --device 'VKB Gladiator NXT' --confirm false --text
How the options interact
- Without --device/--devices, lists all discovered profile/connected/FFB devices.
- --connected and --profile-devices mirror the device list filtering behavior.
- --confirm false auto-accepts closest device suggestion when a requested name is fuzzy.
#engine dcs ffb set
writtenengine dcs ffb set <device-name> [--path <saved-games-path>] [--invert-x true|false] [--invert-y true|false] [--swap-axis true|false] [--confirm true|false]
For beginners
Stores swap axes, invert X and invert Y for one device in the profile. The next DCS export writes them into that
device's force feedback settings of every exported aircraft. The GUI's Apply, Apply Selected and Set FFB
in Settings > DCS force feedback run it.
engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" dcs ffb set "VPforce Rhino FFB" --swap-axis true --invert-x false --invert-y false
Advanced
- Exactly one device (first argument,
--device or --devices); its name is resolved like in engine dcs ffb list.
- At least one of
--invert-x, --invert-y, --swap-axis (each true|false; a bare flag means true). Flags you
leave out keep their stored value; a device without a setting gets one.
- Nothing in DCS changes now:
engine dcs export writes the values as the device's force feedback block of each
exported aircraft, adjusted per aircraft where JoyPro knows a correction.
- With
--profile the profile is saved afterwards (one undo step).
Technical internals
- Output: JSON (
Action, Devices, Updated, the three values, Warnings), or text with --text.
- Exit code
0; 1 with dcs ffb set requires at least one setting: --invert-x, --invert-y, or --swap-axis.,
dcs ffb set requires a device name., dcs ffb set accepts exactly one device target. or No DCS device matched for dcs ffb set.
- Related:
engine dcs ffb clear, engine dcs ffb list.
What it does Creates or updates DCS force-feedback settings (invert X/Y, swap axis) for one device.
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--invert-x | true false | Set DCS FFB invert X flag (true/false). |
--invert-y | true false | Set DCS FFB invert Y flag (true/false). |
--swap-axis | true false | Set DCS FFB swap-axis flag (true/false). |
--confirm | true false | Controls suggestion confirmation (true) vs auto-accept (false). |
Every value as a command line
engine dcs ffb set --invert-x true
engine dcs ffb set --invert-x false
engine dcs ffb set --invert-y true
engine dcs ffb set --invert-y false
engine dcs ffb set --swap-axis true
engine dcs ffb set --swap-axis false
engine dcs ffb set --confirm true
engine dcs ffb set --confirm false
Used by the GUI Settings: Apply Selected · Settings: Apply · Settings: Set FFB
Example
engine dcs ffb set 'VKB Gladiator NXT' --invert-x true --invert-y false --swap-axis false --text
How the options interact
- At least one setting flag is required: --invert-x, --invert-y, or --swap-axis.
- If the target device setting does not exist yet, it is created.
#engine dcs ffb clear
writtenengine dcs ffb clear [<device-name>] [--path <saved-games-path>] [--device <name>] [--devices <csv>] [--all] [--confirm true|false]
For beginners
Removes the stored DCS force feedback direction settings of one or more devices, or of all with --all. The device
then gets DCS's default direction again at the next export. The GUI's Clear, Clear Selected, Clear All and
Clear FFB in Settings > DCS force feedback run it.
engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" dcs ffb clear "VPforce Rhino FFB" --confirm false
Advanced
- Devices: first argument,
--device, --devices; names are resolved like in engine dcs ffb list.
--all without names removes every stored setting.
- Only the profile changes; with
--profile it is saved afterwards (one undo step).
Technical internals
- Output: JSON (
Action, All, Devices, Removed, Warnings), or text with --text.
- Exit code
0; 1 with dcs ffb clear requires a device name or --all. or No DCS FFB settings matched the requested device(s).
- Related:
engine dcs ffb set, engine dcs export.
What it does Clears DCS force-feedback settings for one or more devices (or all).
| Option | Values | Meaning |
|---|
--path | <saved-games-path> | Optional explicit path override. Use when you prefer option form over positional path. |
--device | <name> | Include one device per flag. Example: --device LEFT VPC Throttle. |
--devices | <csv> | Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle. |
--all | switch (no value) | Apply operation to all matches (or select all relations/devices where supported). |
--confirm | true false | Controls suggestion confirmation (true) vs auto-accept (false). |
Every value as a command line
engine dcs ffb clear --confirm true
engine dcs ffb clear --confirm false
Used by the GUI Settings: Clear Selected · Settings: Clear All · Settings: Clear · Settings: Clear FFB
Example
engine dcs ffb clear 'VKB Gladiator NXT' --text
engine dcs ffb clear --all --text
How the options interact
- Use --all to remove every stored DCS FFB device setting.
- You can clear a single device by positional name or --device/--devices.