JoyPro2 Discord GitHub
Engine (CLI)

Engine command line

Show:

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.

For beginners

#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.

Advanced

#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.
  • --text prints 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.

Technical internals

#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 button runs an engine command through one gate. Quick reads go to the long-running server, long jobs to their own process.
  • Every GUI action goes through MainWindowViewModel.RunEngineAsync: it adds --profile, --status, the correction options and --text where 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=off runs 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 by JOYPRO_CANCEL_FILE and 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-note names 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).

AreaCommandsVerbs
engine ac76catalog, export, import, paths, refresh-db, scan
engine ac86catalog, export, import, paths, refresh-db, scan
engine arma26catalog, export, import, paths, refresh-db, scan
engine arma2oa6catalog, export, import, paths, refresh-db, scan
engine arma36catalog, export, import, paths, refresh-db, scan
engine arrange3apply, ask, prefs
engine backups1list
engine bf20426catalog, export, import, paths, refresh-db, scan
engine bf66catalog, export, import, paths, refresh-db, scan
engine binds28clear, detent, edit, export, extra, import, list, modifier, set, show, tuning, unbind
engine bms6catalog, export, import, paths, refresh-db, scan
engine cockpits1cockpits
engine db10check, check-updates, fingerprint, games, list, paths, planes, refresh-il2, refresh-starcitizen, summary
engine dcs14defaults, device-luas, export, ffb, import, refresh, scan, strip-defaults, verify-clean
engine devices10alias, auto-remap, copy-to, exchange, inputs, kb, list, reference, remove, replace
engine elite6catalog, export, import, paths, refresh-db, scan
engine export-marks2dismiss, list
engine ffb10clear, models, set, show, telemetry
engine fsx6catalog, export, import, paths, refresh-db, scan
engine fsxse6catalog, export, import, paths, refresh-db, scan
engine games8config, devices, install, installs, integrations, paths, support
engine grebels6catalog, export, import, paths, refresh-db, scan
engine hllv7catalog, export, import, oodle, paths, refresh-db, scan
engine hud1devices
engine il23export, import, scan
engine il219466catalog, export, import, paths, refresh-db, scan
engine il2cod6catalog, export, import, paths, refresh-db, scan
engine il2codblitz6catalog, export, import, paths, refresh-db, scan
engine il2korea6catalog, export, import, paths, refresh-db, scan
engine layout10callouts, identify, image, kneeboard, multiview, render, suggest, template-inspect, template-save, titles
engine llm10cancel, download, enable, fake-server, find-local, llm, remove, server, start, use-local
engine media1media
engine msfs20206catalog, export, import, paths, refresh-db, scan
engine msfs20246catalog, export, import, paths, refresh-db, scan
engine nuclearoption6catalog, export, import, paths, refresh-db, scan
engine overlay2dcs-hook, map
engine p3d46catalog, export, import, paths, refresh-db, scan
engine p3d56catalog, export, import, paths, refresh-db, scan
engine p3d66catalog, export, import, paths, refresh-db, scan
engine profile16auto-added, game-state, games, head-tracking, history, load, merge, new, save, save-last, summary, validate
engine pw6catalog, export, import, paths, refresh-db, scan
engine reforger6catalog, export, import, paths, refresh-db, scan
engine relations60action-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 setup10aircraft, apply, check, devices, eval, eval-pad, games, plan, preview, render
engine starcitizen5export, import, labels, list-devices, scan
engine summary1summary
engine support2bundle, unpack
engine sync5accept, apply, diff, pending, status
engine telemetry10config, delete, export, games, preview, record, recover, sessions, show
engine tinycombatarena6catalog, export, import, paths, refresh-db, scan
engine usage6backups, harvest, ranking, sources, stats, usage
engine version1version
engine vjoy21apply-hidhide, configure-vjoy, exe, forwarder-config, functions, import-gremlin, limits, map, mode, modes, pad-check, plan, recover, restore-hidhide, settings, status
engine vtolvr7catalog, export, import, mod, paths, refresh-db, scan
engine vtolvr-native6catalog, export, import, paths, refresh-db, scan
engine wardogs6catalog, export, import, paths, refresh-db, scan
engine warthunder6catalog, export, import, paths, refresh-db, scan
engine x46catalog, export, import, paths, refresh-db, scan
engine xplane116catalog, export, import, paths, refresh-db, scan
engine xplane126catalog, export, import, paths, refresh-db, scan

Global options

These work with every command.

OptionWhat 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)
--textText output instead of JSON for list/export/show/add
--status true|falseEmit live status/progress updates to stderr (default: false)
--progress true|falseEmit only the machine-readable progress lines to stderr: [engine-progress] <current>/<total> <phase>: <item> (default: false; --status true includes them)
--benchmark true|falseEmit per-command timing summary to stderr (default: false)
--load-corrections true|falseApply load-time correction mechanics (default: true)
--auto-add-db-items true|falseAuto-add corrected DB nodes during profile load (default: true)
--remap-missing-devices true|falseRemap missing profile device names during load (default: true)
--confirm-device-remap true|falseAsk before each load-time device remap (default: true)
--correction-mode strict|balanced|aggressiveConfidence 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|falseAsk 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>|noneThe 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|offAuto Assign, Auto Group, Setup wizard, Lay out with AI: new aircraft follow your most used one (usage ranking; default on)
--multi-bind on|offA 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)