JoyPro2 Discord GitHub
Engine (CLI)

engine cockpits

Show:

1 commands of engine cockpits. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.

#engine cockpits

written
engine cockpits [list [query] [--game G] [--era E] [--role R] [--nation N] [--category fixed-wing|helicopter|space|fiction|real] | search <text> [--limit n] | get <aircraft> [<variant>] [--json] | check [--structure] | render <aircraft> [<variant>] --png <file> [--device <d>] [--style dark|light] [--print-width <px>] [--drawing-only] | render <aircraft> [<variant>] --page all|overview|stick|throttle|<device>|panels|panel:<id>|photos|photo [--png <file>] [--pdf <file>] [--style dark|light] [--scale <s>] [--highlight <words>] [--pictures picture|drawing|none] [--photos <folder>|none] | compare <aircraft> [<variant>] [--game G] | photos [query] [--coverage] [--verified] | photos --needed [--game G] | coverage | drawings | guide <aircraft> [<variant>] [--lang <code>] [--search <words>] [--no-pictures] | guide --coverage [--game G] [--no-pictures] | pictures build [--game DCS|XPlane12|MSFS2020|IL2Game|NuclearOption|WarThunder|StarCitizen|all] [--aircraft <name>,...] [--force] [--out <folder>] | pictures status | pictures check [--game G] [--aircraft <name>,...] [--write] [--drop]]
For beginners

JoyPro's cockpit database: real and fictional cockpits with their stick and throttle controls, what each does per mode, the panels and the sources. Use it to see how the real aircraft uses each button. The Cockpits page runs get --json for Use this layout, compare for Compare with my setup and pictures build --game all for Build pictures from my games; the Setup wizard reads get --json of your priority aircraft.

engine cockpits get f-16 f-16c-block-50 --text
Advanced
Verb What it does
list [query] (default) aircraft and variants; filters --game, --era, --role, --nation, `--category fixed-wing
search <text> [--limit n] aircraft and controls by words (default 50 each)
get <aircraft> [<variant>] one variant: devices, controls, functions per mode, panels, sources; the JSON is the joypro-cockpit-layout format
compare <aircraft> [<variant>] [--game G] with --profile: which functions of the variant your relations hold, with relation and input
render <aircraft> [<variant>] --png <file> the grip sheets as PNG (--device, `--style dark
render <aircraft> [<variant>] --page <page> [--png <file>] [--pdf <file>] the Cockpits page's manual pages (all, overview, stick, throttle, a device, panels, panel:<id>, photos, photo); several pages with --png become <file>.<page>.png; --style (default light), --scale 0.1..4, --highlight <words>, `--pictures picture
photos [query] [--coverage] [--verified], photos --needed [--game G], coverage, drawings photo links, the variants that still need photos, what the database covers, the drawings
guide <aircraft> [<variant>] [--lang <code>] [--search <words>] [--no-pictures], guide --coverage [--game G] the cockpit guide as a tree (areas, panels, controls with what each does and the game's commands); per variant what it explains
check [--structure] checks the database, drawings and guide; --structure lists only what is wrong, not what is still missing
`pictures build status
  • Aircraft and variants are found by id, name or alias; a game's own aircraft name (F-16C_50) works too.
  • pictures build [--game <id>|all] [--aircraft <a,b>] [--force] renders the cockpits of the installed games (DCS, X-Plane 12, MSFS 2020, IL-2 Great Battles, Nuclear Option, War Thunder, Star Citizen) into JoyPro's data folder, never into a game folder; DCS needs luae.exe in its folder. A game that is not installed is skipped with a note.
  • Nothing here changes the profile or a game.
Technical internals
  • Output: JSON, or --text; --json is accepted and ignored (JSON is the default).
  • Exit code 1 with No aircraft '...' in the cockpit database (cockpits list)., No variant '...' of ..., cockpits search needs a text ..., cockpits render needs --png <file>., --style is dark or light. or cockpits pictures build --game takes ...; check ends with 1 when it finds problems. pictures build shows progress and can be cancelled (exit code 3).
  • Data: DB\Cockpits\*.json with drawings, guide and photo-labels; pictures in %LOCALAPPDATA%\JoyPro2\GameData\CockpitPictures\<game>.
  • Reference: cockpits. Related: engine setup plan (--cockpit-file).

What it does The cockpit database (DB/Cockpits): stick and throttle of real and fictional aircraft per variant with their functions; list, search, get, check, render (sheets or the Cockpits page's manual pages), compare with the profile, photos, coverage, drawings, the cockpit guide and the pictures built from your installed games.

OptionValuesMeaning
--gameswitch (no value)list / compare / guide --coverage / pictures check: only this game. pictures build: DCS, XPlane12, MSFS2020, IL2Game, NuclearOption, WarThunder, StarCitizen or all.
--eraswitch (no value)
--roleswitch (no value)
--nationswitch (no value)
--categoryswitch (no value)
--limitswitch (no value)
--jsonswitch (no value)
--structureswitch (no value)check: list only what is wrong, not what is still missing.
--png<file>
--device<d>Include one device per flag. Example: --device LEFT VPC Throttle.
--styledark light
--print-width<px>
--drawing-onlyswitch (no value)
--pageall overview stick throttlerender: the Cockpits page's manual pages: all, overview, stick, throttle, <device>, panels, panel:<id>, photos, photo.
--pdf<file>render --page: also write the pages as one PDF.
--scale<s>render --page: scale of the pages (0.1..4, default 1).
--highlight<words>render --page: mark the controls these words name.
--picturespicture drawing nonerender --page: picture (default, the pictures from your games), drawing or none.
--photos<folder>render --page: folder of the verified cockpit photos (default: the GUI's downloads), or none.
--coverageswitch (no value)
--verifiedswitch (no value)
--neededswitch (no value)
--lang<code>
--search<words>
--no-picturesswitch (no value)
--aircraft<name>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.
--forceswitch (no value)
--out<folder>Global option: write result output to file path instead of terminal.
--writeswitch (no value)
--dropswitch (no value)
Every value as a command line
engine cockpits --style dark
engine cockpits --style light
engine cockpits --page all
engine cockpits --page overview
engine cockpits --page stick
engine cockpits --page throttle
engine cockpits --pictures picture
engine cockpits --pictures drawing
engine cockpits --pictures none

Used by the GUI Cockpits: Use this layout · Setup wizard: Make the plan again · Setup wizard: NextCommand

Example

engine cockpits [list --text