Step 2 of the Setup wizard: recognises your connected devices with JoyPro's device catalog and proposes a role for
each one (main stick, throttle, pedals, panel ...), with the rules the plan will follow in words. The wizard runs it
when it reaches the devices step and on Detect again. It changes nothing.
Step 3 of the Setup wizard: lists the aircraft of the chosen games for the priority list (DCS: the modules of your
DCS database; other games count as one entry). The wizard runs it when it reaches the priorities step. It changes
nothing.
Step 4 of the Setup wizard: makes the whole plan for your games and devices: which relations to make, which input each
gets, which modifiers, and a quality score per aircraft. It runs without AI; the same choices always give the same
plan. The wizard runs it at step 4 and on Make the plan again. It changes nothing; engine setup apply writes it.
--priorities "A>B|C>D": > separates rows, | (or =) aircraft of one row; --priority "B|C" (repeatable) adds
one row. Aircraft not listed count least.
--modifiers 0..8 (default 0) with --prefer-fewer (default: a modifier only when the essential functions do not
fit) or --use-all-modifiers.
--realism 0..1 or 0..100% (default 0.5): from 50 % aircraft whose real HOTAS has a function elsewhere get their
own relation; --cockpit-file <json> (repeatable) adds cockpit layouts from engine cockpitsget --json.
--phase-layers auto|on|off, --seed <n> (default 1), --replace-existing (lays your bound relations out again).
Your profile first: commands in your relations stay there, bound relations keep their inputs. Read-only.
Technical internals
Output: the plan as JSON, or --text (a summary); the plan file is written indented.
Exit code 1 with setup plan needs --games <game ids> ..., No device to plan with: connect your devices (or give them a role with --role)., --modifiers takes 0 to 8., --prefer-fewer and --use-all-modifiers exclude each other., --realism takes 0..1 (or 0..100 %). or --phase-layers takes on, off or auto.
What it does Setup wizard: plans relations and binds for the important functions of the chosen games' aircraft on your devices (priorities, modifier budget, realism, phase layers); deterministic for a --seed. Writes nothing to the profile; --out-plan saves the plan for setup check, apply and render.
Option
Values
Meaning
--games
<g1,g2>
The games to set up (needed), comma-separated. Example: --games DCS,IL2Game.
--priorities
switch (no value)
Aircraft in order of importance: '>' starts the next row, '|' (or '=') joins aircraft of one row. Example: --priorities 'F-16C_50>FA-18C_hornet|A-10C_2'.
--priority
switch (no value)
One more row of equally important aircraft (repeatable). Example: --priority 'AV8BNA|F-14B'.
--modifiers
switch (no value)
How many modifier buttons the plan may use, 0..8 (default 0).
--prefer-fewer
switch (no value)
Use a modifier only when the essential functions do not fit (default).
--use-all-modifiers
switch (no value)
Use the whole modifier budget.
--placement
switch (no value)
--realism
switch (no value)
0 = group by function, 1 = like the real aircraft's HOTAS (cockpit database or knowledge map); 0..1 or 0..100 %.
--head-tracking
yesno
--seed
switch (no value)
The seed of the plan's local search (default 1): the same seed gives the same plan.
--only-aircraft
<a1,a2>
Only these DCS aircraft (the modules you own), comma-separated; the DCS input layers and the other games stay. Example: --only-aircraft F-16C_50,FA-18C_hornet.
--replace-existing
switch (no value)
Lay out your bound relations again; without it they keep their binds.
--phase-layers
onoffauto
Two combat phases on a latched mode switch: on, off or auto (default: when the inputs are too few for one phase).
--role
<device|VID:PID>
The role of a device (device or VID:PID = role), as for setup devices.
--grip
<device>
The grip on a base (device = grip id), as for setup devices.
--add-device
<catalog id>
A catalog device to plan with although it is not connected.
--cockpit-file
<json>
A cockpit entry (JSON, e.g. from engine cockpits get --json) used besides DB/Cockpits; repeatable.
--out-plan
<plan.json>
Save the plan (JSON) here for setup check, apply and render; --plan-file is another name.
--plan-file
<plan.json>
Another name for --out-plan.
Every value as a command line
engine setup plan --head-tracking yes
engine setup plan --head-tracking no
engine setup plan --phase-layers on
engine setup plan --phase-layers off
engine setup plan --phase-layers auto
The rules every plan keeps: conflicts, modifiers, trigger/pinky, MFD OSB order, panel labels, slew vs TMS, CMS, one device per hand, phase layers; exit code 1 when a rule fails
For beginners
Checks a saved Setup wizard plan against the rules every plan keeps: no input does two things in one aircraft, few
modifiers, trigger and pinky only for their own functions, MFD keys in order, slew not on the TMS hat, and more. It
changes nothing.
--modifiers N (default 2): how many shift modifiers are allowed; a plan that asked for more allows its own number.
The rules, C1 to C11: no input serves two relations of one aircraft (also across phase layers); at most the allowed
modifiers and two phase layers; trigger, weapon release and pinky only take their own functions; MFD keys only MFD
functions, in OSB order; printed panel labels only the functions they name; slew on slew controls and TMS on its
hat; CMS forward dispenses and left / right change the program; one device per hand; phase layers only functions of
their phase; modifier layers only for games that handle them; directional sets together on one hat.
Also measured: relations placed and not placed, essential functions of the top aircraft placed, time-critical
functions on the grips.
Read-only.
Technical internals
Output: JSON (Checks with Id, Title, Passed, Problems, the counts, Passed), or --text (Checks: all passed or <n> failed, PASS / FAIL per rule with up to 8 problems, a Placed: line).
Exit code 0 when every rule passes, 1 when a rule fails (the report is printed first), or with setup check needs --plan <plan.json> (from engine setup plan --out-plan)., The plan could not be read: ... or Unknown setup check argument(s): ...; a non-number for --modifiers ends with engine error: Invalid value for option --modifiers ... (no crash report).
What it does Checks a saved plan against the rules every plan keeps (conflicts, modifiers, trigger/pinky, MFD OSB order, panel labels, slew vs TMS, CMS, one device per hand, phase layers); exit code 1 when a rule fails.
Writes the plan's relations, binds and modifiers in one step
For beginners
Writes a plan of the Setup wizard into the profile in one step: it creates or extends the relations, sets their binds
and adds the modifiers. The wizard's Apply to my profile runs it with the plan as you edited it in the review. In
the game: the binds arrive with the next export.
New relations get the group Setup. A command another relation got in the meantime stays there and is listed as
skipped.
Refused when two relations with an aircraft in common share an input, unless --force.
--dry-run counts without changing the profile.
One profile version "Setup wizard: N relations, M binds" (Undo takes all of it back).
Technical internals
Output: JSON (DryRun, Created, Extended, NodesAdded, Bound, ModifiersAdded, Skipped, Problems), or
--text. The profile is saved with --profile unless --dry-run.
Exit code 1 with setup apply needs --plan <plan.json> (from engine setup plan --out-plan)., The plan could not be read: ... or The plan puts functions of the same aircraft on one input: ... Fix them in the review (or apply with --force).
A callout sheet per device; --aircraft: only the binds of that aircraft, labelled with its function names; --width: picture width, default 1800; the --drawing-* options paint JoyPro's drawings of the devices, default: the GUI's settings
For beginners
Draws a callout sheet per device of a saved Setup wizard plan: the device picture with every planned bind labelled.
With --aircraft only that aircraft's binds, labelled with its own function names. The wizard's review draws its
sheets with it.
--plan <file> and --out-dir <folder> are needed; the folder is created, and files of the same name are
overwritten.
--aircraft <name>: only binds that cover that aircraft. --width <px>: picture width (default 1800, at most
6000; the wizard uses 1600). --light: light sheets instead of dark.
The drawing options of the device pictures work here too: --drawing-style lines|cel, --drawing-preset,
--drawing-ink, --drawing-paper, --drawing-accent (colours as #RRGGBB); otherwise the drawing style of
Settings.
Devices with a role that takes binds are drawn; a device that is not in the device catalog gets no sheet and a
warning. With several modifiers each label names its modifier.
The profile is not touched.
Technical internals
Files: <out-dir>\<nn>-<device>.png, or <nn>-<device>-<aircraft>.png with --aircraft.
Output: JSON (Sheets with Device and File, Warnings), or --text (Setup Sheets: <n> with <device> => <file> lines and Warning: lines).
Exit code 1 with setup render needs --plan <plan.json> and --out-dir <folder>., The plan could not be read: ..., Unknown setup render argument(s): ...; a non-number for --width ends with engine error: Invalid value for option --width ... (no crash report). A sheet that cannot be drawn is a warning, not an error.
What it does Draws a callout sheet per device of a saved plan into --out-dir; with --aircraft only the binds that cover that aircraft, labelled with its function names. The --drawing-* options paint JoyPro's drawings of the devices (default: the GUI's settings).
Option
Values
Meaning
--plan
<plan.json>
--out-dir
<folder>
--aircraft
<name>
Only the binds that cover this aircraft, labelled with its function names (default: every bind with the relation names).
--light
switch (no value)
--width
<px>
Width of each sheet in pixels (default 1800).
--drawing-style
linescel
JoyPro's drawings of the devices: lines (line art) or cel (shaded). Default: the GUI's setting.
--drawing-preset
joypromanualblueprintprintcustom
The colours of JoyPro's drawings: joypro, manual, blueprint, print or custom (then --drawing-ink / --drawing-paper / --drawing-accent). Default: the GUI's setting.
--drawing-ink
<#RRGGBB>
Line colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-paper
<#RRGGBB>
Paper colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-accent
<#RRGGBB>
Accent colour of JoyPro's drawings (#RRGGBB, preset custom).
engine setup games [--games <ids>] [--path <game>=<config folder>]... [--status-only]
Per game: empty = nothing assigned, game = binds of your own in the game (import first, then fill the gaps), profile = already in the profile; the Start page's auto setup; only reads the game's control files
For beginners
For the Start page's auto setup: per game, does the user already have binds there? empty = nothing assigned (the
Start page offers to set up the devices for it), game = binds of the user's own in the game's control files (import
them first, then the setup only fills the gaps), profile = the profile already has binds for it. It only reads the
game's control files; nothing changes.
engine setup games --games DCS,WarThunder,StarCitizen --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
--games <ids>: the games to look at (default: every game the Setup wizard knows).
--path <game>=<folder> (repeatable): read the game's controls from this folder (a copy, a second install).
Keyboard and mouse binds do not count: GameBinds counts binds on game devices, GameKeyboardBinds the rest.
Wizard: whether the Setup wizard can set this game up.
Technical internals
Output: JSON Games with Game, Status, Wizard, ConfigFound, GameBinds, GameKeyboardBinds,
ProfileBinds, Imported, Exported, Warnings; or --text (one line per game).
The game's state comes from engine profile game-state (the same reading as the "Import first?" question before an
export). Exit code 1 only with --path expects "<game>=<config folder>". or an unknown argument.
What it does Per game whether you already have binds there: empty (nothing assigned: the Start page offers the setup), game (binds of your own in the game: import them first, then the setup fills the gaps), profile (already in the profile). Only reads the game's control files; --path gives a game's config folder; --status-only leaves the files of a game the profile already has binds for unread (the Start page's quick look).
Option
Values
Meaning
--games
<ids>
Game filter values as CSV. Example: DCS,IL2Game,StarCitizen.
--path
<game>
Optional explicit path override. Use when you prefer option form over positional path.
--status-only
switch (no value)
Only the status: a game the profile already has binds for (or imported from / exported to) keeps its control files unread (GameBindsRead false, GameBinds 0). What the Start page asks.
Example
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' setup games --games DCS,WarThunder,StarCitizen --text
The layout window: the games and aircraft with binds; with --aircraft and --out-dir one sheet per device, or with --live-data each device's drawing, callout sheet and row texts
For beginners
The data of the Where is what? window: which games and aircraft have binds, and for one aircraft every device with
the function on each control. From a saved Setup wizard plan (before it is applied) or from the profile's binds on the
connected devices. It changes nothing.
--plan <file> or --from-profile (one of them is needed).
Without --aircraft: only the games and their aircraft (DCS input layers are left out).
--aircraft <key> and --out-dir <folder>: one sheet per device (as engine setup render draws them), or with
--live-data each device's drawing (.picture.png), its callout sheet (.sheet.json) and what each row shows, so the
GUI can draw the sheet itself and light up the pressed control.
--game <id> limits the list to that game; --light, --width and the --drawing-* options as for setup render.
Exit code 1 with setup preview needs --plan <plan.json> or --from-profile., The plan was not found: ..., The plan could not be read: ... or an unknown argument.
What it does The layout window's data: the games and aircraft of a saved plan (--plan) or of the profile's binds on the connected devices (--from-profile); with --aircraft and --out-dir one sheet per device (PNG), or with --live-data each device's drawing, callout sheet (JSON) and row texts. Read-only.
Option
Values
Meaning
--plan
<plan.json>
--from-profile
switch (no value)
--game
<id>
Game filter value. Example: DCS or IL2Game.
--aircraft
<key>
MSFS export only: also write the relations limited to this aircraft (key from DB\\MSFS\\aircraft.tsv); the sim's presets apply to every aircraft.
A test bench for the Setup wizard: it plans 20 popular device setups (Warthog, T.16000M, VKB, Virpil, WinWing, X56,
X52 Pro, Honeycomb, a gamepad alone, two sticks for space ...) and random ones from the device catalog for every game
the wizard knows and the main DCS aircraft, and scores each plan: can every major operation be done (flight axes,
throttle, weapons, gear, flaps, brakes, trim, view, comms, countermeasures, sensor slew, master modes; space: strafe,
boost, shields, jump), and are the hand rules kept. It writes a report; nothing else changes.
--random N (default 20) random setups, --seed N (default 2026): the same seed gives the same setups.
--setups popular|random|<ids>, --games <ids>|none, --families <aircraft>|none and --no-stress (without the
"every DCS module at once" row) choose the rows.
--baseline <results.json>: an earlier run; the report shows before and after.
Thresholds (exit code 1 when one fails): --min-coverage, --min-ergonomics, --min-popular-coverage,
--min-row-coverage, --min-flight (pitch, roll and throttle of the popular setups). The engine smoke test runs a
part of it with thresholds.
After the plans, per setup one profile goes through Auto Group and Fill all (Suggest missing, every
suggestion of medium confidence and up taken) and is scored again, with one more rule: no wrong-kind matches (a
brightness knob in a slew relation, a wheel brake in a throttle relation). --no-pipeline skips it;
--min-pipeline-coverage and --max-wrong N are its thresholds.
The novice case (IL-2 Great Battles only, a WinWing URSA MINOR stick and throttle, also as devices JoyPro does not
know) runs on its own and is reported in persona.md; it fails the run when pitch, roll, throttle or fire is missing
or the unknown devices are not set up and named. --no-persona skips it.
Technical internals
Files in --out-dir: report.md (method, summaries, every row with its gaps and rule problems; the Auto Group /
Fill all rows with every wrong suggestion and wrong-kind command), results.json (Rows, PipelineRows,
WrongSuggestions, OtherSuggestions, SubstituteSuggestions), rows.csv, setups/<setup>.md (per target what is
bound where), devices-<setup>.tsv (the fake device files), persona.md / persona.json (the novice case).
The planner runs in the engine process with the wizard's defaults; the devices are fake (as Windows would report the
catalog devices). Read-only: the Auto Group / Fill all profiles live in memory and are never saved.
What it does Scores the Setup wizard's planner on 20 popular and --random N random device setups against every wizard game and the main DCS families (docs/auto-setup-eval.md): can every major operation be done, are the hand rules kept. Then per setup one profile through Auto Group and Fill all (Suggest missing, every suggestion taken), scored again with the rule 'no wrong-kind matches' (--no-pipeline skips it), and the novice case IL-2 + WinWing URSA MINOR on its own (persona.md, --no-persona skips it). Writes report.md, results.json, rows.csv and setups/*.md to --out-dir; exit 1 when a --min-* / --max-wrong threshold fails. Read-only (the profiles live in memory).
Option
Values
Meaning
--random
switch (no value)
--seed
switch (no value)
--setups
popularrandomregression
--regression-file
<file>
--no-regression
switch (no value)
--games
<ids>
Game filter values as CSV. Example: DCS,IL2Game,StarCitizen.
--families
<aircraft>
--no-stress
switch (no value)
--out-dir
<folder>
--baseline
<results.json>
--min-coverage
<pct>
--min-ergonomics
<pct>
--min-popular-coverage
<pct>
--min-row-coverage
<pct>
--min-flight
<pct>
--no-pipeline
switch (no value)
--min-pipeline-coverage
<pct>
--max-wrong
switch (no value)
--no-persona
switch (no value)
--no-typical
switch (no value)
--no-pad-alone
switch (no value)
--head-tracking
yesno
--placement
switch (no value)
--placement-sweep
<positions>
--min-hard-pass
<pct>
--min-popular-hard-pass
<pct>
--max-destructive
switch (no value)
--popular-zero-gates
<gates>
--min-typical-hard-pass
<pct>
--min-pad-hard-pass
<pct>
--min-regression-hard-pass
<pct>
--min-pipeline-hard-pass
<pct>
--max-pipeline-destructive
switch (no value)
--max-pipeline-lost
switch (no value)
--max-all-games-lost
switch (no value)
--pipeline-zero-gates
<gates>
--min-all-games-hard-pass
<pct>
--gate-baseline
<json>
--write-gate-baseline
<json>
Every value as a command line
engine setup eval --setups popular
engine setup eval --setups random
engine setup eval --setups regression
engine setup eval --head-tracking yes
engine setup eval --head-tracking no
ACE COMBAT 8 player: the Setup wizard alone must put every flight control on the virtual Xbox pad; exit 1 when a pad gate fails
For beginners
The ACE COMBAT 8 player as a test: a T.Flight HOTAS 4, and a VKB Gunfighter with a Virpil throttle and MFG pedals, each
set up by the Setup wizard alone for ACE COMBAT 8. Every flight control must reach the virtual Xbox pad: pitch and roll,
the throttle on both triggers, yaw, gun, missile, target, flares, High-G and the wingman D-pad. It writes a report;
nothing else changes.
Exit code 1 when one pad gate fails (no thresholds). pad-persona.md lists per setup the gates and where each pad
action landed; pad-persona.json the same as data.
The devices are fake (as Windows would report the catalog devices), the profile lives in memory. The engine smoke
test runs it (autosetup part).