Which supported games are installed and where; import/export/scan/refresh/restore are refused for the others
For beginners
Lists every game JoyPro supports: installed or not, where, how it was found, and where it keeps its controls. Import,
export, scan and refresh are refused for games that are not installed. The GUI builds the Settings > Games cards, the
Start page cards and the export cards from it; Detect again (Settings) and Look again (Start page) run it.
engine games installs --game DCS --text
Advanced
--game <id> (or --games, several) limits the list.
Per game: installed, installation folder, how it was found (Steam, a known place, the Windows apps list, your own
folder), your config location, whether you hid it, its config paths, and how many actions JoyPro knows for it with
the reason when there are none.
Read-only. Your folders and hidden games come from game-installs.json, game-configs.json and
games-disabled.json in %LOCALAPPDATA%\JoyPro2 (installs).
Technical internals
Output: JSON (Games, Warnings), or text with --text. Exit code 0; 1 on an unknown option.
engine games install set <game> <folder> | clear <game>
Your installation folder of a game, e.g. a portable install; it then counts as installed and detection never replaces it; unset = clear
For beginners
Tells JoyPro where a game is installed, for example a portable copy or a game on another drive that detection does not
find. The folder then counts as the game's installation. clear forgets it and detects the game again. Settings >
Games (Choose folder..., Choose .exe..., Use detected) and the first-start game setup run it.
engine games install set DCS "D:\DCS World"
Advanced
set <game> <folder>: the game is a game id or name (DCS, il2, bms, Falcon BMS, ...). The folder may also
be the game's .exe, its launcher or a folder inside it: JoyPro takes the folder that holds the game's executable
(also a game subfolder, or up to four levels up) and says so in a note.
Detection never replaces your folder. If the executable is not in it, the game still counts as installed, with the
note that the marker file is missing.
clear <game> (or unset): forgets your folder.
A game you hid ("I do not have it") stays hidden; show it with engine games install enable <game>
(engine games install disable).
Changes only game-installs.json in %LOCALAPPDATA%\JoyPro2; no game file is touched.
Technical internals
Output: the game's entry as in engine games installs (JSON Games, Warnings; text with --text, notes as
Note: ...). Exit code 0.
Exit code 1 with the usage line engine games install set <game> <folder> | clear <game> | disable <game> [<game> ...] | enable <game> [<game> ...], Unknown game: <x>. Known: ... or The folder does not exist: <folder>.
What it does Your installation folder of a game (e.g. a portable install): it then counts as installed and detection never replaces it; clear removes it.
Games you do not have: they count as not installed and the GUI hides them; enable undoes it
For beginners
Marks games as ones you do not have: they count as not installed and the GUI hides them; enable shows them again.
Your binds for them stay in the profile. The hide button on a Start page card, Hide / Show again in Settings >
Games and the first-start setup run it.
engine games install disable WarThunder X4
Advanced
One or more game ids (separated by spaces or commas); enable takes the same list.
A hidden game: import, export, scan and refresh are refused, it gets no export card and the watcher does not watch
it (engine sync status shows disabled).
Saved in games-disabled.json in %LOCALAPPDATA%\JoyPro2. No game file is touched.
Technical internals
Output: JSON (Games: the changed entries, Warnings), or text with --text. Exit code 0; 1 with
Unknown game: <name>. Known: ... or without a game (the usage line).
engine games config set <game> <file or folder> | clear <game>
Your config location of a game, e.g. Saved Games\DCS.openbeta; it comes first wherever JoyPro looks for the game's controls; not for games that keep them in the installation
For beginners
Tells JoyPro where a game keeps its controls, for example Saved Games\DCS.openbeta instead of Saved Games\DCS.
JoyPro then looks there first wherever it looks for the game's controls. clear goes back to what JoyPro finds. The
first-start game setup runs it.
engine games config set DCS "C:\Users\Pilot\Saved Games\DCS.openbeta"
Advanced
set <game> <file or folder>: the location must exist. It comes first wherever JoyPro looks for the game's
controls; the found locations follow.
Not for games that keep their controls inside the installation (IL-2 Great Battles, IL-2 Korea, IL-2 1946, Falcon
BMS, X-Plane 11 and 12, VTOL VR): set their installation with engine games install set instead.
clear <game> (or unset): forgets your location.
A location that no longer exists is ignored until it is there again.
Changes only game-configs.json in %LOCALAPPDATA%\JoyPro2; no game file is touched.
Technical internals
Output: the game's entry as in engine games installs (JSON Games, Warnings; text with --text, the line
Config location (yours): <path>). Exit code 0.
Exit code 1 with the usage line engine games config set <game> <file or folder> | clear <game>, Unknown game: ..., The file or folder does not exist: <path> or <game> keeps its controls in its installation folder; set that instead: engine games install set <id> <folder>.
What it does Your config location of a game (e.g. Saved Games\DCS.openbeta): it comes first wherever JoyPro looks for the game's controls; clear removes it. Not for games that keep their controls in the installation.
Example
engine games config set <game> <file or folder> --text
engine games paths [--game <name>] [--games <csv>]
For beginners
Shows where JoyPro finds each game's installation and config folders. Use it when an import or export says it has no
path. The GUI's Game Paths (Settings > Command lists (DB) and game paths) runs it.
engine games paths --game DCS --text
Advanced
--game <name> / --games <csv> limit the list.
Per game: the preferred installation and config folder (the ones import and export use when no path is given) and
every installation and config folder found.
Read-only. engine games without an action is this command.
Technical internals
Output: JSON of the catalog, or with --text per game Preferred Install, Preferred Config, Install Paths,
Config Paths and the warnings. Exit code 0.
Lists the other games JoyPro reads besides DCS, IL-2 Great Battles and Star Citizen, with their ids and aliases. The
GUI's Load Games in the Start page's expert import runs it, and the import wizard and the Export page use it.
engine games integrations --text
Advanced
No options. Read-only.
Per game: id, name, aliases (the names the CLI accepts, for example engine wt import), its command list folder,
whether it is experimental, notes, whether it has a command list refresh, named game profiles or an aircraft list,
and the actions it offers (paths, catalog, scan, import, export, refresh-db).
Technical internals
Output: JSON (Integrations), or with --text one line per game <id> | <name> | aliases=... | experimental=... | refresh-db=.... Exit code 0.
engine games support [--markdown | --html | --json] [--notes <file>]
How far JoyPro supports each game: the feature matrix from the code plus the verification notes, docs/games/support.md; exit 1 when the notes miss a game or claim more than the code
For beginners
Prints how far JoyPro supports each game: the feature matrix taken from the code plus the verification notes. The
GUI's Supported games on the Start page writes it as an HTML page and opens it in your browser.
engine games support --html --out "C:\Users\Pilot\Desktop\supported-games.html"
Advanced
One format: --markdown (the page of docs/games/support.md), --html (one HTML file), --json; without one JSON,
or text with --text.
--notes <file> reads the verification notes from that JSON file instead of the copy inside engine.exe.
A note may lower a cell, never claim more than the code does. Read-only.
Technical internals
Exit code 0; 1 when the notes miss a game or claim more than the code (each problem as games support: ... on
stderr; the page is still written). 1 also for two formats at once (Use one of --markdown, --html, --json.) or
--notes without a file.
What it does How far JoyPro supports each game (docs/games/support.md): one row per title with the feature marks taken from the code (import, export, keyboard, modifiers, list refresh, watcher, axis tuning, settings, force feedback, vJoy / Xbox modes, virtual functions, function tables, cockpits, cheat sheets) and the in-game test results, footnotes and per-title facts of docs/games/support-notes.json (built into engine.exe). JSON by default; --markdown writes the page (tools/game_support.ps1), --html the page the GUI opens. Exit 1 when the notes miss a registered game, name an unknown game or cell, claim more than the code or leave a partial mark without a reason.
Option
Values
Meaning
--markdown
switch (no value)
For games support: print the Markdown page (docs/games/support.md) instead of JSON.
--html
switch (no value)
For games support: print the page as one HTML file (what the GUI's Supported games opens).
--json
switch (no value)
--notes
<file>
For games support: read the verification notes from this JSON file instead of the copy built into engine.exe. Example: docs\games\support-notes.json.
engine games support --text
engine games support --markdown --notes docs\games\support-notes.json --out docs\games\support.md
engine games support --html --out 'C:\JoyPro\supported-games.html'
Connected devices with VID:PID, HID name and DirectInput axes/buttons/hats
For beginners
Lists the connected game devices with their VID:PID, HID name and the axes, buttons and hats DirectInput reports. The
GUI's Device Details (Settings > Devices) runs it, and Create Report puts its list into the report's
diagnostics.
engine games devices --text
Advanced
No options. Read-only.
Per device: the name JoyPro uses, its DirectInput index, VID:PID (? when unknown), the HID product string, the
axes (as tokens such as JOY_X), button and hat counts, and the HID path; capabilities unknown when DirectInput
did not report them.
Technical internals
Output: JSON (Devices, Warnings), or text with --text. Exit code 0; 1 on an extra argument.