Everything JoyPro does happens in its engine, engine.exe. The window you click in (the GUI) runs the engine for
every action. You can run the same commands yourself in a console, in a script or from another tool.
#Do I need this?
No. Everything here is also in the GUI. The command line is for people who like scripts, for automating things (for example exporting every evening), and for understanding exactly what a button does: each GUI page on this site lists the engine command behind every button.
To try it: open a console (Windows Terminal or PowerShell) in JoyPro's folder and type
engine\engine.exe summary --text.
#How a command looks
engine <area> <command> [arguments] [--option value] [global options]
--profile <file.pr0file>loads that profile and saves it after a command that changes it.--textprints readable text; without it most commands print JSON (for scripts).--out <file>writes the output to a file.
Examples:
engine devices list --connected --text
engine dcs import "C:\Users\Pilot\Saved Games\DCS" --merge --include-defaults --profile "My Sticks.pr0file"
engine relations search "gear" --button --text
engine dcs export --mode clean --nuke-untouched-devices true --planes "F-16C_50|FA-18C_hornet" --profile "My Sticks.pr0file"
engine backups restore latest --game DCS
Exit codes: 0 success, 1 failure (the reason on stderr), 2 an option without its value (engine error: Missing value for option --on. ..., no crash report; vJoy's administrator steps also use 2 for a declined prompt), 3
cancelled.
#How the GUI uses the engine
flowchart LR
B["A button in the GUI"] --> VM["View model command"]
VM --> R["RunEngineAsync<br/>(one gate,<br/>one command at a time)"]
R --> S["quick reads:<br/>engine serve<br/>(long-running, cached lists)"]
R --> P["import, export, refresh:<br/>an engine.exe process<br/>--status true<br/>(progress, Cancel)"]
S --> F[("profile, game data")]
P --> F
P --> G[("game files<br/>(backup first)")]
- Every GUI action goes through
MainWindowViewModel.RunEngineAsync: it adds--profile,--status, the correction options and--textwhere needed, and serializes calls so two commands never write at once. - Quick interactive commands run in one long-running
engine serve, which keeps the game lists, the function map and indexes in memory and checks their files before every command; each command still behaves as in its own process.JOYPRO_ENGINE_SERVER=offruns every call in a process. - Long commands report
[engine-progress] <current>/<total> <phase>: <item>lines on stderr (--progress true), which feed the busy area; Cancel writes the file named byJOYPRO_CANCEL_FILEand the engine stops cooperatively (exit code 3). - Before a command that changes game files the engine makes a backup set; after a command that changes the profile it
saves it atomically as a new history version (
--history-notenames it). - The command list below is read from the engine's own help (
engine --help), so it always matches the program.
#Command areas
451 commands in 60 areas, read from the engine's own command list (engine --help, ENGINE_CLI_WIKI.md).
| Area | Commands | Verbs |
|---|---|---|
engine ac7 | 6 | catalog, export, import, paths, refresh-db, scan |
engine ac8 | 6 | catalog, export, import, paths, refresh-db, scan |
engine arma2 | 6 | catalog, export, import, paths, refresh-db, scan |
engine arma2oa | 6 | catalog, export, import, paths, refresh-db, scan |
engine arma3 | 6 | catalog, export, import, paths, refresh-db, scan |
engine arrange | 3 | apply, ask, prefs |
engine backups | 1 | list |
engine bf2042 | 6 | catalog, export, import, paths, refresh-db, scan |
engine bf6 | 6 | catalog, export, import, paths, refresh-db, scan |
engine binds | 28 | clear, detent, edit, export, extra, import, list, modifier, set, show, tuning, unbind |
engine bms | 6 | catalog, export, import, paths, refresh-db, scan |
engine cockpits | 1 | cockpits |
engine db | 10 | check, check-updates, fingerprint, games, list, paths, planes, refresh-il2, refresh-starcitizen, summary |
engine dcs | 14 | defaults, device-luas, export, ffb, import, refresh, scan, strip-defaults, verify-clean |
engine devices | 10 | alias, auto-remap, copy-to, exchange, inputs, kb, list, reference, remove, replace |
engine elite | 6 | catalog, export, import, paths, refresh-db, scan |
engine export-marks | 2 | dismiss, list |
engine ffb | 10 | clear, models, set, show, telemetry |
engine fsx | 6 | catalog, export, import, paths, refresh-db, scan |
engine fsxse | 6 | catalog, export, import, paths, refresh-db, scan |
engine games | 8 | config, devices, install, installs, integrations, paths, support |
engine grebels | 6 | catalog, export, import, paths, refresh-db, scan |
engine hllv | 7 | catalog, export, import, oodle, paths, refresh-db, scan |
engine hud | 1 | devices |
engine il2 | 3 | export, import, scan |
engine il21946 | 6 | catalog, export, import, paths, refresh-db, scan |
engine il2cod | 6 | catalog, export, import, paths, refresh-db, scan |
engine il2codblitz | 6 | catalog, export, import, paths, refresh-db, scan |
engine il2korea | 6 | catalog, export, import, paths, refresh-db, scan |
engine layout | 10 | callouts, identify, image, kneeboard, multiview, render, suggest, template-inspect, template-save, titles |
engine llm | 10 | cancel, download, enable, fake-server, find-local, llm, remove, server, start, use-local |
engine media | 1 | media |
engine msfs2020 | 6 | catalog, export, import, paths, refresh-db, scan |
engine msfs2024 | 6 | catalog, export, import, paths, refresh-db, scan |
engine nuclearoption | 6 | catalog, export, import, paths, refresh-db, scan |
engine overlay | 2 | dcs-hook, map |
engine p3d4 | 6 | catalog, export, import, paths, refresh-db, scan |
engine p3d5 | 6 | catalog, export, import, paths, refresh-db, scan |
engine p3d6 | 6 | catalog, export, import, paths, refresh-db, scan |
engine profile | 16 | auto-added, game-state, games, head-tracking, history, load, merge, new, save, save-last, summary, validate |
engine pw | 6 | catalog, export, import, paths, refresh-db, scan |
engine reforger | 6 | catalog, export, import, paths, refresh-db, scan |
engine relations | 60 | action-info, add, ai-matrix, aircraft, assistant, auto-assign, auto-group, browse, chat, check-aircraft, conflicts, duplicates, edit, export, from-text, function, functions, group, import, item, join- |
engine setup | 10 | aircraft, apply, check, devices, eval, eval-pad, games, plan, preview, render |
engine starcitizen | 5 | export, import, labels, list-devices, scan |
engine summary | 1 | summary |
engine support | 2 | bundle, unpack |
engine sync | 5 | accept, apply, diff, pending, status |
engine telemetry | 10 | config, delete, export, games, preview, record, recover, sessions, show |
engine tinycombatarena | 6 | catalog, export, import, paths, refresh-db, scan |
engine usage | 6 | backups, harvest, ranking, sources, stats, usage |
engine version | 1 | version |
engine vjoy | 21 | apply-hidhide, configure-vjoy, exe, forwarder-config, functions, import-gremlin, limits, map, mode, modes, pad-check, plan, recover, restore-hidhide, settings, status |
engine vtolvr | 7 | catalog, export, import, mod, paths, refresh-db, scan |
engine vtolvr-native | 6 | catalog, export, import, paths, refresh-db, scan |
engine wardogs | 6 | catalog, export, import, paths, refresh-db, scan |
engine warthunder | 6 | catalog, export, import, paths, refresh-db, scan |
engine x4 | 6 | catalog, export, import, paths, refresh-db, scan |
engine xplane11 | 6 | catalog, export, import, paths, refresh-db, scan |
engine xplane12 | 6 | catalog, export, import, paths, refresh-db, scan |
Global options
These work with every command.
| Option | What it does |
|---|---|
--profile <path> | Load/create this .pr0file and auto-save after mutating commands |
--out <path> | Write command output to file |
--editor <command> | Editor command for relations edit / binds edit (use {file} placeholder) |
--text | Text output instead of JSON for list/export/show/add |
--status true|false | Emit live status/progress updates to stderr (default: false) |
--progress true|false | Emit only the machine-readable progress lines to stderr: [engine-progress] <current>/<total> <phase>: <item> (default: false; --status true includes them) |
--benchmark true|false | Emit per-command timing summary to stderr (default: false) |
--load-corrections true|false | Apply load-time correction mechanics (default: true) |
--auto-add-db-items true|false | Auto-add corrected DB nodes during profile load (default: true) |
--remap-missing-devices true|false | Remap missing profile device names during load (default: true) |
--confirm-device-remap true|false | Ask before each load-time device remap (default: true) |
--correction-mode strict|balanced|aggressive | Confidence model for relation-item remaps (default: balanced) |
--correction-auto-threshold <0..200> | Minimum score to auto-apply relation-item remaps (default: mode-based) |
--confirm-corrections true|false | Ask for confirmation on medium-confidence item remaps (default: true) |
--correction-report <path> | Write load correction report (json, or text with .txt/.log) |
--history-note <text> | Name of this change in the profile history (default: the command's name) |
--vjoy-tunnel <1-16>|none | The vJoy device JoyPro tunnels into: virtual mode writes there (the first vJoy device of the table, function outputs, forwarder, Gremlin import); imports and scans (dcs, il2, starcitizen, the other games) of games in native mode leave only that vJoy device out; every other vJoy device is read like any device (default: none) |
--usage-style on|off | Auto Assign, Auto Group, Setup wizard, Lay out with AI: new aircraft follow your most used one (usage ranking; default on) |
--multi-bind on|off | A relation can have several inputs (binds extra); exports, checks and pages use them (default on; off: only the main binds for this call, extra binds stay in the profile; JOYPRO_MULTI_BIND=0 also switches it off) |