engine db summary [filter] [--keyboard] [--no-keyboard] [--strict-names]
Compares each DCS aircraft command list with its clean profile; filter = text in the aircraft name or file to count only those
For beginners
Checks JoyPro's DCS command list against its DCS clean profiles and prints the counts: aircraft lists, missing clean
profiles, name matches by alias. The GUI's DB Summary (Settings > Command lists (DB) and game paths) runs it.
engine db summary --text
Advanced
For every aircraft list DB\DCS\<aircraft>.html it looks for CleanProfile\DCS\<aircraft>.cf; a name that only
matches after normalizing counts as an alias match. A few aircraft are not checked.
--keyboard also checks KeyboardCleanProfile\DCS (off by default); --no-keyboard turns it off again.
--strict-names is accepted (it changes the result of engine db check only).
A filter word (for example F-16) limits the check to aircraft whose name or files contain it.
Read-only. The lists are read from the game-data folder, else the program folder (engine db paths).
Technical internals
Output: JSON of the whole check, or with --text the counts (Modules, Missing Clean, Missing Keyboard Clean,
Alias-Matched Clean, ...) and errors.
Errors in the result: no DCS command list yet (hint: engine dcs refresh id--headless-lua true), no clean
profiles yet (hint: engine dcs refresh clean--headless-lua true). Exit code 0 anyway.
What it does Compares each DCS aircraft command list (DB\DCS\*.html) with its clean profile (CleanProfile; with the keyboard check, --keyboard / --no-keyboard, also KeyboardCleanProfile) and counts the matches, alias matches and missing ones; an optional filter word limits it to aircraft whose name or file contains it.
Option
Values
Meaning
--keyboard
switch (no value)
Include keyboard clean-profile checks for supported DB commands.
--no-keyboard
switch (no value)
Disable keyboard clean-profile checks for supported DB commands.
--strict-names
switch (no value)
For DB summary/list/check: require exact clean filename match (no alias fallback accepted).
engine db list [filter] [--missing] [--keyboard] [--no-keyboard] [--strict-names]
For beginners
Lists every DCS aircraft list with its clean profile state, one line per aircraft. The GUI's DB List (Settings >
Command lists (DB) and game paths) runs it with the Plane Filter.
engine db list F-16 --missing --text
Advanced
Text line per aircraft: <name> | clean=ok|missing|skip|alias:<file> | keyboard_clean=... | db=<file>;
keyboard_clean is n/a without --keyboard.
--missing shows only aircraft with something missing (text output only).
--keyboard, --no-keyboard, --strict-names and the filter as in engine db summary. Read-only.
Technical internals
Output: JSON (the whole check, every row), or the list with --text. Exit code 0.
engine db check [filter] [--keyboard] [--no-keyboard] [--strict-names]
Like db summary, plus the aircraft without a clean profile; exit 1 when one is missing
For beginners
The same check as engine db summary, but it fails when a DCS aircraft has no clean profile. Use it in scripts. The
GUI's DB Check (Settings > Command lists (DB) and game paths) runs it.
engine db check --strict-names --text
Advanced
Fails on errors of the check (no command list, no clean profiles) and on missing clean (and, with --keyboard,
keyboard clean) profiles.
--strict-names also fails when a clean profile was only found by alias.
Filter, --keyboard and --no-keyboard as in engine db summary. Read-only.
Technical internals
Output: JSON, or with --text the summary plus the list of missing entries; then db check ok on success.
Exit code 0; 1 with db check failed: <errors>, db check failed: missing clean profile files = <n> or db check failed: clean file name mismatches = <n> (alias-matched).
What it does The same comparison as db summary plus the list of DCS aircraft without a clean profile; fails (exit 1) when one is missing (with --strict-names also on alias matches). An optional filter word limits it.
Option
Values
Meaning
--keyboard
switch (no value)
Include keyboard clean-profile checks for supported DB commands.
--no-keyboard
switch (no value)
Disable keyboard clean-profile checks for supported DB commands.
--strict-names
switch (no value)
For DB summary/list/check: require exact clean filename match (no alias fallback accepted).
Lists the games JoyPro has command lists for on this PC, with how many aircraft each has and where the list is. The
GUI's DB Games (Settings) and List DB Games (Start page) run it; the GUI also fills its game choices from it.
engine db games --text
Advanced
One row per game folder of DB (data folders such as Functions or Devices are left out); each folder is read
from the game-data folder, else the program folder.
A filter word keeps the games whose name or folder contains it.
Read-only. The GUI leaves out games you hid.
Technical internals
Output: JSON (Games with Game, SourceFolder, DbPath, Planes; Errors), or text lines
<game> | planes=<n> | folder=<folder> | db=<path> with --text. Exit code 0.
engine db check-updates [--accept <game>] [--accept-all] [--no-record]
Games updated since their DB was built
For beginners
Checks which installed games were updated since JoyPro built their command list, and which have no list yet. The Start
page shows the result as a notice with Update / Keep DB per game; Check Again and the notice's buttons run
it.
engine db check-updates --text
Advanced
Per game it compares the installed build (DCS version and module folders, Star Citizen's build, Steam build ids,
...) with source-version.txt in the game's command list folder, which every refresh writes.
States: up-to-date, game-updated (with the changes and the refresh command), no-catalog (installed, no list
yet), baseline-recorded (first check: the build is recorded), no-baseline, not-installed.
--accept <game> (repeatable or comma-separated) marks that game's list as current (Keep DB); --accept-all
marks all (Keep All DBs, Hide Notice).
--no-record only reports: no build is recorded, not even a first one (then no-baseline).
Writes only source-version.txt in the game-data folder; the command lists themselves do not change.
Technical internals
Output: JSON (Games with Game, DisplayName, Installed, InstalledVersion, DbVersion, State, Message,
RefreshCommand, Details; Outdated; Warnings), or text with --text. Exit code 0.
Lists the aircraft (or ships, vehicles) of each game's command list. The GUI's DB Planes (Settings) and List DB
Planes (Start page) run it, and the DCS import uses db planes --game DCS for its aircraft list when Saved Games
has none.
engine db planes Hornet --game DCS --text
Advanced
--game <name> keeps the games whose name or folder contains it (only valid with db planes).
A filter word keeps the aircraft that contain it; games without a match are left out.
Read-only.
Technical internals
Output: JSON as engine db games with the aircraft lists, or with --textDB Planes: <n> (Games: <n>) and one
block per game. Exit code 0; 1 when --game is used with another db action.
Prints one fingerprint of JoyPro's command lists of DCS, IL-2 Great Battles and Star Citizen. Two PCs (or two
versions) with the same fingerprint have the same lists. The GUI's DB Fingerprint (Settings) runs it.
engine db fingerprint --text
Advanced
SHA-256 over the files of those three lists (each read where JoyPro reads it, the game-data folder first), with
paths relative to their folder, plus the version of the load correction's rules. These are exactly the inputs of
the load correction.
source-version.txt is not counted.
File hashes are cached by size and time in <data>\Cache\db-file-hashes.tsv, so only new or changed files are read.
Read-only.
Technical internals
Output: JSON (fingerprint, fileCount, totalBytes, includedRoots, warnings), or with --textDB Fingerprint:, Files:, Bytes:, Roots: and Warnings:. Exit code 0.
What it does Prints the fingerprint of the game lists JoyPro reads (DB): a load of a profile compares it to decide whether the DB correction pass must run.
Where the lists are read from: the game-data folder for everything built from your games, the program folder for JoyPro's own data: DB\Functions, DB\Devices, DB\Llm, DB\DevicePhotos, DB\DeviceLayouts, DB\DeviceDrawings, DB\Cockpits, DB\Detents
For beginners
Shows where JoyPro reads its lists from: the program folder for JoyPro's own data, and the game-data folder for
everything built from your games (command lists, aircraft lists, clean profiles), with the game version each list was
built from.
engine db paths --text
Advanced
No options. Read-only.
The program folder's own data: DB\Functions, DB\Devices, DB\Llm, DB\DevicePhotos, DB\DeviceLayouts,
DB\DeviceDrawings, DB\Cockpits, DB\Detents and TOOLS.
Per game folder (DB\<game>, CleanProfile\<game>, KeyboardCleanProfile\<game>): whether it is read from the
game-data folder or the program folder, and its recorded build (version or steam-build from
source-version.txt).
The game-data folder's copy wins whenever it exists. Refreshes write only there, so an update of JoyPro never
replaces your lists.
Technical internals
Output: JSON (ProgramFolder, GameDataFolder, Folders with Folder, Source (game-data or program),
Path, Build), or text with --text (DB Paths, the two folders, one line per game folder). Exit code 0; 1
with Unknown db paths argument(s): ....
What it does Shows the program folder (JoyPro's own data), the game-data folder <data>\GameData (lists built from your games) and, per game folder, where it is read from (game-data or program) and its recorded game build (docs/installs.md, Game data).
engine db refresh-il2 [<install, data\input folder or .actions file>] [--path <path>] [--db-path <folder>] [--dry-run]
Adds new actions of the game's key mapping files to DB\IL2\IL2.actions; also: engine il2 refresh-db
For beginners
Adds the actions of IL-2 Great Battles' key mapping files that JoyPro's IL-2 command list lacks. Use it after an IL-2
update. Update on the IL-2 card of the Start page and Refresh IL-2 DB (Settings > Command lists of DCS, Star
Citizen and IL-2) run it.
engine db refresh-il2 "D:\Games\IL-2 Sturmovik Battle of Stalingrad" --dry-run
Advanced
Source: the IL-2 folder, its data\input folder or one .actions file (positional or --path); without one the
installed game is used.
It reads global.actions and the other *.actions (not JoyPro's jp.actions) and appends each missing action to
DB\IL2\IL2.actions with the game's English description. Existing lines stay byte for byte, except a title the game
left as an internal key, which gets JoyPro's own name (listed as renamed titles).
--dry-run (bare, or true|false) reads and reports, writes nothing.
--db-path <folder> writes the list into another folder instead of the game-data folder.
Without a source path it is refused when IL-2 is not installed. engine il2 refresh-db is the same command.
Technical internals
Output: JSON of the refresh (list file, actions added, renamed titles, warnings), or text with --text.
Exit code 0; 1 with db refresh-il2 failed: <reason>.
After a real run into JoyPro's own list the IL-2 build is recorded for engine db check-updates.
Builds JoyPro's Star Citizen command list from the game's action maps; --install-path / --path: the Star Citizen installation (else found); --dry-run true reads and reports only, nothing is written
For beginners
Builds JoyPro's Star Citizen command list from the installed game: the ship actions, their option groups, the joystick
option tree and the game's default joystick binds. Update on the Star Citizen card of the Start page and Refresh
Star Citizen DB (Settings > Command lists of DCS, Star Citizen and IL-2) run it.
engine db refresh-starcitizen --install-path "D:\Games\StarCitizen" --branch LIVE --dry-run true
Advanced
Sources, best first: --source <file or folder> (for example an extracted defaultProfile.xml), the installation
(--install-path, --path or the positional path; a positional file counts as the source), else every detected
installation. --include-user-profiles true|false (default true) also takes the players' actionmaps.xml as
candidates when no installation is named.
--branch <name> (LIVE, PTU, ...) reads only that branch.
--dry-run true|false (default false; a bare flag is true) reports without writing.
--db-path <folder> writes elsewhere instead of DB\StarCitizen in the game-data folder.
Refused when Star Citizen is not installed.
Technical internals
Output: JSON of the refresh (source, branch, action count, files), or text with --text.
Exit code 0; 1 with db refresh-starcitizen failed: <reason>, for example No Star Citizen action map source file found. Try --source <actionmaps.xml> or --install-path <StarCitizen root>.
Writes AllBinds.xml and actionmaps.xml. After a real run the build is recorded for engine db check-updates and
the English names of the controls are refreshed (engine starcitizen labels; problems as Note: ... on stderr).
What it does Builds JoyPro's Star Citizen command list (DB\StarCitizen) from the game's action maps (a given source, the named installation, else every detected installation and, with --include-user-profiles, the players' actionmaps.xml); writes it only at the end, a dry run writes nothing.
Option
Values
Meaning
--install-path
<path>
The Star Citizen installation folder (e.g. C:\Program Files\Roberts Space Industries\StarCitizen); default: the one JoyPro finds.
--path
<path>
Same as --install-path (used when --install-path is not given).
--source
<path-to-source>
A file or folder with the game's action map (e.g. an extracted defaultProfile.xml), read first.
--branch
<name>
Read only this game branch (e.g. LIVE or PTU).
--db-path
<path>
Write the command list into this folder instead of JoyPro's game-data folder.
--include-user-profiles
truefalse
When no installation is named, also take the players' actionmaps.xml as sources (true/false, default true).
--dry-run
truefalse
true (a bare flag is true): report what the list would hold; nothing is written (default false).
Every value as a command line
engine db refresh-starcitizen --include-user-profiles true
engine db refresh-starcitizen --include-user-profiles false
engine db refresh-starcitizen --dry-run true
engine db refresh-starcitizen --dry-run false