JoyPro2 Discord GitHub
Engine (CLI)

engine layout

Show:

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

#engine layout render

written
engine layout render [--path <export-folder>] [--device <name>] [--devices <csv>] [--layout-map <joystick>=<path.layout>] [--game <name>] [--games <csv>] [--plane <name>] [--planes <csv>] [--include-overview true|false] [--include-planes true|false] [--skip-missing-layouts true|false] [--draw-markers true|false] [--draw-legend-table true|false] [--marker-size <n>] [--legend-width <n>] [--legend-max-rows <n>] [--legend-font-size <n>] [--button-symbol circle|square|triangle|diamond|bar] [--axis-symbol circle|square|triangle|diamond|bar] [--pov-symbol circle|square|triangle|diamond|bar] [--slider-symbol circle|square|triangle|diamond|bar] [--sheet-style joypro|print|high-contrast|dark-sheet|<style.json>] [--font <family>] [--font-size <n>] [--font-weight normal|semibold|bold] [--text-color <#RRGGBB|#AARRGGBB>] [--outline-color <color|none>] [--label-background <color|none>] [--page-background <color>] [--table-background <color>] [--table-border <color>] [--header-background <color>] [--header-text <color>] [--table-text <color>] [--line-color <color>] [--marker-color-button <color>] [--marker-color-axis <color>] [--marker-color-hat <color>] [--marker-color-slider <color>] [--modifier-colors <modifier=#RRGGBB,...>] [--style dark|light] [--print-width <px>] [--combine true|false] [--drawing-style lines|cel] [--drawing-preset joypro|manual|blueprint|print|custom] [--drawing-ink <#RRGGBB>] [--drawing-paper <#RRGGBB>] [--drawing-accent <#RRGGBB>]

A --layout-map to a device layout .json with tables and lines draws JoyPro 1 style sheets; the sheet style options colour the page, tables, lines, markers and labels, a device's own style in its layout wins; the --drawing-* options paint JoyPro's own drawings, default: the GUI's settings

For beginners

Draws the cheat sheets: a picture of each device with every bind written at its button, as PNG files, one overview per device and one per aircraft. Create cheat sheets on the Layout page (Cheat sheets) runs it.

engine layout render --path "C:\Users\Pilot\Documents\JoyPro\Cheat sheets" --game DCS --plane F-16C_50 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • Each device needs a layout: the profile's layout file for it (engine layout image, engine layout suggest) or --layout-map <device>=<file>. A JoyPro 1 .layout, a device layout .json with tables and lines, or a page with several views. --skip-missing-layouts true (default) skips a device without one with a warning; false fails.
  • --device(s), --game(s), --plane(s) limit what is drawn.
  • --include-overview and --include-planes (both default true; not both false).
  • Look: --draw-markers, --draw-legend-table (default false), --marker-size (10), --legend-width (460), --legend-max-rows (20), --legend-font-size (11), symbols (default circle, diamond, triangle, bar), --sheet-style and the colour and font options, --style dark|light, --print-width (default 3508, at most 12000), --combine true (one All devices.png per folder), --drawing-* (default: the GUI's drawing settings).
  • Writes only pictures; the profile and the games are not touched.
Technical internals
  • Files: <path>\<device>.png (overview) and <path>\<game>\<plane>\<device>.png. --path default: the profile's cheat sheet folder, else LayoutExport.
  • Output: the render result (rendered devices, written files, warnings), or text; exit code 0, 1 on layout render failed: ... (for example layout render produced no images. Ensure joystick layout mappings exist ...).
  • Related: engine layout titles, engine layout multiview, engine layout callouts.

What it does Renders joystick layout images per game/plane (command descriptions) and overview images (relation names) from JoyPro .layout mappings.

OptionValuesMeaning
--path<export-folder>Optional explicit path override. Use when you prefer option form over positional path.
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--layout-map<joystick>Map joystick name to layout/image file path. Example: --layout-map 'VKB Gladiator NXT=C:\\JoyPro\\LayoutImages\\VKB.layout'.
--game<name>Game filter value. Example: DCS or IL2Game.
--games<csv>Game filter values as CSV. Example: DCS,IL2Game,StarCitizen.
--plane<name>Include one plane/module per flag. Example: --plane A-10C_2.
--planes<csv>Include planes/modules as CSV. Example: --planes A-10C_2,FA-18C_hornet.
--include-overviewtrue falseFor layout render: include overview image(s) in export root that show relation names on each input token (true/false).
--include-planestrue falseFor layout render: include per-game/per-plane output images showing command descriptions (true/false).
--skip-missing-layoutstrue falseFor layout render: skip unmapped/missing joystick layouts as warnings (true) or fail the command (false).
--draw-markerstrue false
--draw-legend-tabletrue false
--marker-size<n>
--legend-width<n>
--legend-max-rows<n>
--legend-font-size<n>
--button-symbolcircle square triangle diamond bar
--axis-symbolcircle square triangle diamond bar
--pov-symbolcircle square triangle diamond bar
--slider-symbolcircle square triangle diamond bar
--sheet-stylejoypro print high-contrast dark-sheet
--font<family>
--font-size<n>
--font-weightnormal semibold bold
--text-color<#RRGGBB|#AARRGGBB>
--outline-color<color|none>
--label-background<color|none>
--page-background<color>
--table-background<color>
--table-border<color>
--header-background<color>
--header-text<color>
--table-text<color>
--line-color<color>
--marker-color-button<color>
--marker-color-axis<color>
--marker-color-hat<color>
--marker-color-slider<color>
--modifier-colors<modifier=#RRGGBB,...>
--styledark light
--print-width<px>
--combinetrue false
--drawing-stylelines celJoyPro's drawings of the devices: lines (line art) or cel (shaded). Default: the GUI's setting.
--drawing-presetjoypro manual blueprint print customThe 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).
Every value as a command line
engine layout render --include-overview true
engine layout render --include-overview false
engine layout render --include-planes true
engine layout render --include-planes false
engine layout render --skip-missing-layouts true
engine layout render --skip-missing-layouts false
engine layout render --draw-markers true
engine layout render --draw-markers false
engine layout render --draw-legend-table true
engine layout render --draw-legend-table false
engine layout render --button-symbol circle
engine layout render --button-symbol square
engine layout render --button-symbol triangle
engine layout render --button-symbol diamond
engine layout render --button-symbol bar
engine layout render --axis-symbol circle
engine layout render --axis-symbol square
engine layout render --axis-symbol triangle
engine layout render --axis-symbol diamond
engine layout render --axis-symbol bar
engine layout render --pov-symbol circle
engine layout render --pov-symbol square
engine layout render --pov-symbol triangle
engine layout render --pov-symbol diamond
engine layout render --pov-symbol bar
engine layout render --slider-symbol circle
engine layout render --slider-symbol square
engine layout render --slider-symbol triangle
engine layout render --slider-symbol diamond
engine layout render --slider-symbol bar
engine layout render --sheet-style joypro
engine layout render --sheet-style print
engine layout render --sheet-style high-contrast
engine layout render --sheet-style dark-sheet
engine layout render --font-weight normal
engine layout render --font-weight semibold
engine layout render --font-weight bold
engine layout render --style dark
engine layout render --style light
engine layout render --combine true
engine layout render --combine false
engine layout render --drawing-style lines
engine layout render --drawing-style cel
engine layout render --drawing-preset joypro
engine layout render --drawing-preset manual
engine layout render --drawing-preset blueprint
engine layout render --drawing-preset print
engine layout render --drawing-preset custom

Used by the GUI Layout: Create cheat sheets

Example

engine layout render --text

#engine layout callouts

written
engine layout callouts (--model <catalog id> | --layout <device-layout.json>) [--picture <file>] [--schematic] [--drawing-style lines|cel] [--drawing-preset <p>] [--drawing-ink|--drawing-paper|--drawing-accent <#RRGGBB>] [--arrange] [--device <name>] [--game <name> --plane <name>] [--sample] [--png <file>] [--light] [--print-width <px>] [--save <file.json>] [--sheet-style joypro|print|high-contrast|dark-sheet|<style.json>] [--font <family>] [--font-size <n>] [--font-weight normal|semibold|bold] [--text-color <#RRGGBB|#AARRGGBB>] [--outline-color <color|none>] [--label-background <color|none>] [--page-background <color>] [--table-background <color>] [--table-border <color>] [--header-background <color>] [--header-text <color>] [--table-text <color>] [--line-color <color>] [--marker-color-button <color>] [--marker-color-axis <color>] [--marker-color-hat <color>] [--marker-color-slider <color>] [--modifier-colors <modifier=#RRGGBB,...>]

Tables around the device picture with orthogonal lines; exit code 1 when the sheet check finds problems, the picture and file are written all the same; --check-all [query] checks every model

For beginners

Arranges the tables around a device picture with right-angled leader lines, for a model of the device catalog or a saved device layout, checks the sheet, and can draw it as a PNG with your binds in the tables.

engine layout callouts --model thrustmaster-warthog-stick --device "Joystick - HOTAS Warthog" --game DCS --plane F-16C_50 --png "C:\Users\Pilot\Documents\JoyPro\Warthog.png" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • Source: --model <catalog id> (or the first word) takes JoyPro's line drawing of the model with its positions and its shipped sheet when there is one, else (or with --schematic) JoyPro's schematic drawing; --picture <file> puts your own picture behind it (without positions). --layout <device layout .json> takes a saved layout with its tables.
  • --arrange arranges the tables anew even when the layout has some.
  • Table text: --device <name> writes that device's binds (relation names; with --game and --plane, which go together, that aircraft's binds); --sample fills sample text; without either the tables stay empty.
  • --png <file> draws the sheet: --light, --print-width (default 3508, at most 12000), --sheet-style and the font and colour options as for engine layout render (a layout's own style wins), --drawing-style lines|cel, --drawing-preset, --drawing-ink, --drawing-paper, --drawing-accent (default: the GUI's drawing settings).
  • --save <file.json> writes the layout with the arranged sheet.
  • --check-all [words] arranges and checks the sheet of every catalog model with inputs.
  • Writes only the files you name; the profile and the games are not touched.
Technical internals
  • Output: JSON Model, Check, Warnings, Sheet, or text Layout Callouts: <model> | picture ... | sheet ..., Check: ..., Result: ok|problems, a line per table, problems and warnings. Exit code 0, or 1 when the check finds problems (the picture and the file are written all the same).
  • --check-all: exit code 1 when a sheet has overlapping tables, slanted lines, something outside the canvas, a line through a table or a placed part without a line.
  • Failures (exit 1): layout callouts needs --model <catalog id> or --layout <device layout .json>., layout callouts needs --game and --plane together., Unknown device model: ..., Device layout not found: ..., layout callouts failed: ...
  • Reference: device-reference. Related: engine layout render, engine devices reference.

What it does Tables around the device picture with orthogonal lines; exit code 1 when the sheet check finds problems, the picture and file are written all the same; --check-all [query] checks every model.

OptionValuesMeaning
--model<catalog id>
--layout<device-layout.json>
--picture<file>
--schematicswitch (no value)
--drawing-stylelines celJoyPro's drawings of the devices: lines (line art) or cel (shaded). Default: the GUI's setting.
--drawing-preset<p>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-inkswitch (no value)Line colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-paperswitch (no value)Paper colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-accent<#RRGGBB>Accent colour of JoyPro's drawings (#RRGGBB, preset custom).
--arrangeswitch (no value)
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--game<name>Game filter value. Example: DCS or IL2Game.
--plane<name>Include one plane/module per flag. Example: --plane A-10C_2.
--sampleswitch (no value)
--png<file>
--lightswitch (no value)
--print-width<px>
--save<file.json>
--sheet-stylejoypro print high-contrast dark-sheet
--font<family>
--font-size<n>
--font-weightnormal semibold bold
--text-color<#RRGGBB|#AARRGGBB>
--outline-color<color|none>
--label-background<color|none>
--page-background<color>
--table-background<color>
--table-border<color>
--header-background<color>
--header-text<color>
--table-text<color>
--line-color<color>
--marker-color-button<color>
--marker-color-axis<color>
--marker-color-hat<color>
--marker-color-slider<color>
--modifier-colors<modifier=#RRGGBB,...>
Every value as a command line
engine layout callouts --drawing-style lines
engine layout callouts --drawing-style cel
engine layout callouts --sheet-style joypro
engine layout callouts --sheet-style print
engine layout callouts --sheet-style high-contrast
engine layout callouts --sheet-style dark-sheet
engine layout callouts --font-weight normal
engine layout callouts --font-weight semibold
engine layout callouts --font-weight bold

Example

engine layout callouts (--model <catalog id> --text

#engine layout kneeboard

written
engine layout kneeboard [--target dcs|folder] [--saved-games <folder>] [--folder <folder>] [--game <name>] [--plane <name>] [--planes <csv>] [--include-easy] [--device <name>] [--devices <csv>] [--layout-map <joystick>=<layout file>] [--postfix <text>] [--size <px>] [--page list|portrait|original] [--picture top|none] [--combine true|false] [--style dark|light] [--remove-old] [--dry-run] [--sheet-style joypro|print|high-contrast|dark-sheet|<style.json>] [--font <family>] [--font-size <n>] [--font-weight normal|semibold|bold] [--text-color <#RRGGBB|#AARRGGBB>] [--outline-color <color|none>] [--label-background <color|none>] [--page-background <color>] [--table-background <color>] [--table-border <color>] [--header-background <color>] [--header-text <color>] [--table-text <color>] [--line-color <color>] [--marker-color-button <color>] [--marker-color-axis <color>] [--marker-color-hat <color>] [--marker-color-slider <color>] [--modifier-colors <modifier=#RRGGBB,...>] [--drawing-style lines|cel] [--drawing-preset <p>] [--drawing-ink|--drawing-paper|--drawing-accent <#RRGGBB>]

Kneeboard pages of each aircraft, by default a list of the bound controls in large text grouped by control (more pages when needed: _p2), with the device picture at the top; portrait|original: the cheat sheet picture. DCS <Saved Games>\DCS*\Kneeboard\<aircraft>\JoyPro_<aircraft>_<device>.png, also read by OpenKneeboard; --target folder: <folder>\<game>\<aircraft>\; default: every aircraft the devices have binds in; only JoyPro's own pictures are written or replaced, other files stay untouched

For beginners

Puts your binds of each aircraft on its kneeboard as an easy-to-read list (or the cheat sheet picture): in DCS you see them on the kneeboard of the aircraft you fly (also in OpenKneeboard's DCS Aircraft tab), or the pages go into a folder you choose. Put on the kneeboard on the Layout page (Kneeboard) runs it. JoyPro only adds or replaces its own pages; your other kneeboard pages stay as they are.

engine layout kneeboard --plane F-16C_50 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --target dcs (default): every DCS Saved Games folder (DCS, DCS.openbeta) gets Kneeboard\<aircraft folder>\JoyPro_<aircraft>_<device>.png; --saved-games <folder> (several allowed) names them instead of finding them. The aircraft folder is the name DCS uses (A-10C II -> A-10C_2, F-15E -> F-15ESE, the F-14's pilot and RIO -> F-14B and the F-14A folders). An aircraft JoyPro does not know gets its own name, with a note.
  • --target folder --folder <folder>: <folder>\<game>\<aircraft>\... (OpenKneeboard's Folder tab, other games); --game <game> for another game than DCS.
  • Which aircraft: --plane(s), else every aircraft the devices have binds in (menu layers left out; a game-mode copy such as F-16C_50_easy only with --include-easy or when its aircraft has no binds). Which devices: --device(s) and --layout-map <device>=<file> as in engine layout render.
  • The page: --page list (default): a 3:4 page with only the bound controls in large text, grouped by control, modifier binds tagged, the device picture with numbered controls at the top (--picture none leaves it out); more pages ..._p2.png when needed. --page portrait: the cheat sheet picture on a 3:4 page (the shape DCS stretches every page to); --page original: the cheat sheet in its own shape. --size <px> the page height or longest side (default 2048, 512 to 8192); --combine true the pages of an aircraft with all devices as sections; --postfix <text> added to the file names (a second set, e.g. _VR); --style dark|light, the sheet style and drawing options as in engine layout render.
  • --remove-old also removes JoyPro's own pages of the same postfix that this run did not write again (a device that left the profile). --dry-run lists what it would write.
Technical internals
  • Only files named JoyPro_* with JoyPro's mark inside the PNG (a text chunk Software: JoyPro kneeboard; postfix=...;) are written, replaced or removed. A file of someone else with that name is skipped and listed under Skipped.
  • Output: JSON Target, Game, Folders, Aircraft (plane, folders, known), PicturesWritten, PicturesReplaced, OldPicturesRemoved, WrittenFiles, Skipped, Warnings, or text; exit code 0.
  • Failures (exit 1): No DCS Saved Games folder found ..., Nothing to put on the kneeboard: ..., No kneeboard picture was written: ..., --target folder needs --folder <folder>., --size must be between 512 and 8192 pixels., invalid --target, --page, --picture, --style or --postfix.
  • The profile and the game's binds are not touched. Related: engine layout render, engine layout callouts.

What it does Puts the binds of each aircraft on its kneeboard (a large-text list of the bound controls, or the cheat sheet picture): DCS (Saved Games\\DCS and DCS.openbeta, Kneeboard\\<aircraft folder DCS uses>, also read by OpenKneeboard) or a folder of choice. Writes or replaces only JoyPro's own pages (JoyPro_*, with JoyPro's mark in the PNG); other kneeboard files are never changed.

OptionValuesMeaning
--targetdcs folderdcs (default): the DCS kneeboard (Saved Games\\DCS*\\Kneeboard\\<aircraft>); folder: the folder of --folder.
--saved-games<folder>A DCS Saved Games folder whose Kneeboard folder gets the pages; repeatable (default: every Saved Games\\DCS* folder with DCS's Config folder).
--folder<folder>With --target folder: the folder for the pages (<folder>\\<game>\\<aircraft>). Example: C:\\Kneeboard.
--game<name>With --target folder: the game whose aircraft get pages (default DCS).
--plane<name>Only this aircraft; repeatable (default: every aircraft the devices have binds in). Example: --plane F-16C_50.
--planes<csv>Only these aircraft as CSV. Example: --planes F-16C_50,FA-18C_hornet.
--include-easyswitch (no value)Also the game-mode copies (F-16C_50_easy) while their aircraft has binds (they share its kneeboard).
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--layout-map<joystick>Map joystick name to layout/image file path. Example: --layout-map 'VKB Gladiator NXT=C:\\JoyPro\\LayoutImages\\VKB.layout'.
--postfix<text>Text added to the file names, to keep a second set apart. Example: --postfix _VR.
--size<px>The page height (list, portrait) or longest side (original) in pixels, 512 to 8192 (default 2048). The list's font is at least 20 px per 1024 px of page height.
--pagelist portrait originallist (default): a 3:4 page with only the bound controls in large text, grouped by control, more pages (_p2, _p3) when needed; portrait: the cheat sheet picture on a 3:4 page (the shape DCS stretches every page to); original: the cheat sheet in its own shape.
--picturetop noneWith --page list: top (default) puts the device picture with numbered controls above the list, none leaves it out for more room.
--combinetrue falsetrue: the pages of an aircraft with all devices, each a section (default false: pages per device).
--styledark light
--remove-oldswitch (no value)Also remove JoyPro's own pages of the same postfix that this run did not write again (a device that left the profile). Nothing else is removed.
--dry-runswitch (no value)List the pages that would be written; nothing is written.
--sheet-stylejoypro print high-contrast dark-sheet
--font<family>
--font-size<n>
--font-weightnormal semibold bold
--text-color<#RRGGBB|#AARRGGBB>
--outline-color<color|none>
--label-background<color|none>
--page-background<color>
--table-background<color>
--table-border<color>
--header-background<color>
--header-text<color>
--table-text<color>
--line-color<color>
--marker-color-button<color>
--marker-color-axis<color>
--marker-color-hat<color>
--marker-color-slider<color>
--modifier-colors<modifier=#RRGGBB,...>
--drawing-stylelines celJoyPro's drawings of the devices: lines (line art) or cel (shaded). Default: the GUI's setting.
--drawing-preset<p>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-inkswitch (no value)Line colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-paperswitch (no value)Paper colour of JoyPro's drawings (#RRGGBB, preset custom).
--drawing-accent<#RRGGBB>Accent colour of JoyPro's drawings (#RRGGBB, preset custom).
Every value as a command line
engine layout kneeboard --target dcs
engine layout kneeboard --target folder
engine layout kneeboard --page list
engine layout kneeboard --page portrait
engine layout kneeboard --page original
engine layout kneeboard --picture top
engine layout kneeboard --picture none
engine layout kneeboard --combine true
engine layout kneeboard --combine false
engine layout kneeboard --style dark
engine layout kneeboard --style light
engine layout kneeboard --sheet-style joypro
engine layout kneeboard --sheet-style print
engine layout kneeboard --sheet-style high-contrast
engine layout kneeboard --sheet-style dark-sheet
engine layout kneeboard --font-weight normal
engine layout kneeboard --font-weight semibold
engine layout kneeboard --font-weight bold
engine layout kneeboard --drawing-style lines
engine layout kneeboard --drawing-style cel

Used by the GUI Layout: Put on the kneeboard

Example

engine layout kneeboard --text

#engine layout titles

written
engine layout titles --device <name>

The game's own menu titles of the device's binds, per game and aircraft

For beginners

Lists, for every game and aircraft a device's binds are active in, the game's own menu title of each bound input, and the device's main modifier. The Layout page reads it for the preview box of Tables (one game and aircraft with the game's menu titles).

engine layout titles --device "Joystick - HOTAS Warthog" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • --device (required): the device name as in the binds.
  • Inputs with a modifier are listed as Modifier+JOY_BTN5.
  • Read-only; needs the profile.
Technical internals
  • Output: JSON Device, Modifier, Targets (game, plane, titles), or text; exit code 0.
  • Failures (exit 1): layout titles needs --device <JoyPro device name>.

What it does The game's own menu titles of the device's binds, per game and aircraft.

OptionValuesMeaning
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.

Used by the GUI Layout: Edit this view · Layout: MapPendingPressCommand

Example

engine layout titles --device <name> --text

#engine layout image

written
engine layout image <device> [--set <layout file>|--clear]

The layout file the profile uses for a device; --clear: JoyPro's picture again, --set puts one back

For beginners

Shows or changes the layout file the profile uses for a device (your own layout, a JoyPro 1 layout, a picture you chose). Reset to JoyPro's default... on the Layout page clears it, Undo the reset puts it back.

engine layout image "Joystick - HOTAS Warthog" --clear --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • No option: prints the mapping. --clear: forgets it, JoyPro's picture shows again. --set <file>: sets it.
  • The device matches with or without its GUID.
  • Only the profile changes.
Technical internals
  • Output: Device, Previous, Current, or text <device>: <file> (was: ...); exit code 0.
  • Failures (exit 1): the usage layout image <device> [--set <layout file>|--clear].
  • One undo step with --profile when it changed something. Related: engine layout render.

What it does The layout file the profile uses for a device; --clear: JoyPro's picture again, --set puts one back.

OptionValuesMeaning
--set<layout file>
--clearswitch (no value)

Used by the GUI Layout: Reset to JoyPro's default... · Layout: UndoLayoutResetCommand · Settings: Reset all my layout changes... · Settings: UndoLayoutResetCommand

Example

engine layout image <device> --text

#engine layout multiview

written
engine layout multiview <file.json> [--views <folder>] [--png <file>] [--device <name>] [--game <g> --plane <p>] [--light] [--print-width <px>] [--sheet-style joypro|print|high-contrast|dark-sheet|<style.json>] [--font <family>] [--font-size <n>] [--font-weight normal|semibold|bold] [--text-color <#RRGGBB|#AARRGGBB>] [--outline-color <color|none>] [--label-background <color|none>] [--page-background <color>] [--table-background <color>] [--table-border <color>] [--header-background <color>] [--header-text <color>] [--table-text <color>] [--line-color <color>] [--marker-color-button <color>] [--marker-color-axis <color>] [--marker-color-hat <color>] [--marker-color-slider <color>] [--modifier-colors <modifier=#RRGGBB,...>]

A page with several views of a device: each view as view-<n>.png, the page as one picture; layout render draws it when --layout-map points to it

For beginners

Draws a page with several views of one device (front and side): each view as its own picture and the whole page as one picture. The Layout page runs it to draw the views of Several views.

engine layout multiview "C:\Users\Pilot\Documents\JoyPro\Warthog views.json" --png "C:\Users\Pilot\Documents\JoyPro\Warthog.png" --device "Joystick - HOTAS Warthog" --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
  • --views <folder>: each view as view-<n>.png. --png <file>: the page.
  • --device: whose binds are written; --game with --plane: one aircraft (else relation names).
  • --light, --print-width (default 3508), the sheet style options; a view's own style wins.
  • Writes only pictures.
Technical internals
  • Output: always JSON: Model, Page, Width, Height, Views (index, file, size), Png, Warnings; exit code 0.
  • Failures (exit 1): Not a page with several views: ..., the usage line.
  • Related: engine layout render (draws such a page as the device's cheat sheet).

What it does A page with several views of a device: each view as view-<n>.png, the page as one picture; layout render draws it when --layout-map points to it.

OptionValuesMeaning
--views<folder>
--png<file>
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--game<g>Game filter value. Example: DCS or IL2Game.
--plane<p>Include one plane/module per flag. Example: --plane A-10C_2.
--lightswitch (no value)
--print-width<px>
--sheet-stylejoypro print high-contrast dark-sheet
--font<family>
--font-size<n>
--font-weightnormal semibold bold
--text-color<#RRGGBB|#AARRGGBB>
--outline-color<color|none>
--label-background<color|none>
--page-background<color>
--table-background<color>
--table-border<color>
--header-background<color>
--header-text<color>
--table-text<color>
--line-color<color>
--marker-color-button<color>
--marker-color-axis<color>
--marker-color-hat<color>
--marker-color-slider<color>
--modifier-colors<modifier=#RRGGBB,...>
Every value as a command line
engine layout multiview --sheet-style joypro
engine layout multiview --sheet-style print
engine layout multiview --sheet-style high-contrast
engine layout multiview --sheet-style dark-sheet
engine layout multiview --font-weight normal
engine layout multiview --font-weight semibold
engine layout multiview --font-weight bold

Used by the GUI Layout: OpenMultiViewCommand

Example

engine layout multiview <file.json> --text

#engine layout suggest

written
engine layout suggest [--device <name>] [--devices <csv>] [--connected] [--profile-devices] [--legacy-layout-dir <path>] [--legacy-output-dir <path>] [--catalog <path.json>] [--apply true|false] [--apply-min-score <n>] [--backdrop <picture-file-or-image-url>]
For beginners

Finds a picture with button positions for each device: a fitting layout template, else JoyPro's drawing of the model, else a generated layout. With --apply true it stores the choice in the profile for the cheat sheets. Suggest and Find my devices on the Layout page run it, Use picture with your own picture (--backdrop).

engine layout suggest --connected --apply true --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • Devices: --device(s); else --connected (the connected game controllers); --profile-devices adds the profile's. None: it fails.
  • Templates: the device layout catalog (--catalog) and your layout folders (--legacy-layout-dir, --legacy-output-dir; found by themselves when not given). A template only fits the same product (VID:PID, a known alias or the same model words of the same vendor). Below a score of 45 it uses a picture of the product or a generated layout instead.
  • --backdrop <file or image URL>: your picture of the device with markers from its real inputs (one device only).
  • --apply true (default false) stores layouts with a score from --apply-min-score (default 55).
Technical internals
  • Output: the suggestions (device, layout file, score, vendor, model, VID:PID, search link), counts, warnings; exit code 0, 1 on layout suggest failed: ... (No devices available to suggest layouts for. ..., --backdrop needs exactly one device (--device <name>).).
  • Generated layouts go into JoyPro's AutoLayouts folder. One undo step with --profile when --apply stored one.
  • Related: engine layout identify, engine layout image, engine layout render.

What it does Suggests a layout picture with markers for devices (connected or in the profile) from the layout catalog and JoyPro 1 layouts; --apply true saves the ones scoring at least --apply-min-score into the profile; --backdrop uses a picture of your own.

OptionValuesMeaning
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--connectedswitch (no value)For devices list, show connected devices only.
--profile-devicesswitch (no value)For devices list, show profile-referenced devices only.
--legacy-layout-dir<path>
--legacy-output-dir<path>
--catalog<path.json>
--applytrue false
--apply-min-score<n>
--backdrop<picture-file-or-image-url>
Every value as a command line
engine layout suggest --apply true
engine layout suggest --apply false

Used by the GUI Start: OpenDeviceCardInLayoutCommand · Start: AnswerDeviceCardQuestionCommand · Binds: Edit markers · Layout: Find my devices · Layout: Use picture · Layout: Put on the kneeboard · Layout: Create cheat sheets · Settings: OpenDeviceCardInLayoutCommand

Example

engine layout suggest --text

#engine layout identify

written
engine layout identify [--device <name>] [--devices <csv>] [--connected]

Vendor/model from VID:PID and HID name, picture search link

For beginners

Says which product a device is (vendor, model, kind) from its USB VID:PID and HID name, with a picture search link. Search a picture on the Layout page runs it when the suggestion has no link yet.

engine layout identify --connected --text
Advanced
  • --device(s): these devices; without any, or with --connected, every connected game controller.
  • Read-only; no profile needed.
Technical internals

What it does Vendor/model from VID:PID and HID name, picture search link.

OptionValuesMeaning
--device<name>Include one device per flag. Example: --device LEFT VPC Throttle.
--devices<csv>Include devices as CSV. Example: --devices VKB Gladiator NXT,LEFT VPC Throttle.
--connectedswitch (no value)For devices list, show connected devices only.

Used by the GUI Layout: Search a picture

Example

engine layout identify --text

#engine layout template-inspect

written
engine layout template-inspect --source <path.layout-or-image> [--max-markers <n>]

--max-markers: how many markers are listed, default 2000, at most 20000; 0 or less = 5000

For beginners

Reads a layout file (JoyPro 1 .layout) or a picture for the layout-file editor: size, font, colour and every marker with its position, plus its tables and lines. The Layout page runs it when it opens a layout file in the editor.

engine layout template-inspect --source "C:\Users\Pilot\Documents\JoyPro\Layouts\Warthog.layout" --text
Advanced
  • --source (also --template, or the first word): the file.
  • --max-markers (default 2000; the GUI passes 10000; at most 20000, 0 or less means 5000) limits the marker list; more gives a warning.
  • Tables and lines come from <file>.tables.json and <file>.connectors.json beside it.
  • Does not change the profile.
Technical internals
  • Output: source, size, device name, font, text colour, preview picture path, Markers (token, type, modifier, x, y), Tables, Connectors; exit code 0.
  • Failures (exit 1): layout template-inspect requires --source <path.layout-or-image>., layout template-inspect failed: Layout source not found: ....
  • Related: engine layout template-save.

What it does Reads a .layout file or picture and lists its joystick name, font, colour, preview picture and marker positions (sorted top to bottom), at most --max-markers of them (default 2000).

OptionValuesMeaning
--source<path.layout-or-image>
--max-markers<n>

Used by the GUI Start: OpenDeviceCardInLayoutCommand · Binds: Edit markers · Layout: Use picture · Layout: Open + Load Selected · Layout: Reload Source Path · Layout: Create cheat sheets · Settings: OpenDeviceCardInLayoutCommand

Example

engine layout template-inspect --source <path.layout-or-image> --text

#engine layout template-save

written
engine layout template-save --source <path.layout-or-image> --out <path.layout> [--markers-json <file.json> | --markers <json-array-or-object>] [--tables-json <file.json> | --tables <json-array-or-object>] [--connectors-json <file.json> | --connectors <json-array-or-object>] [--replace-all true|false]
For beginners

Saves a layout file from a source layout or picture with the markers, tables and lines you give it. The layout-file editor on the Layout page runs it for Save, and before Create cheat sheets when the editor has a file open.

engine layout template-save --source "C:\Users\Pilot\Pictures\warthog.png" --out "C:\Users\Pilot\Documents\JoyPro\Layouts\Warthog.layout" --markers-json "C:\Users\Pilot\Documents\JoyPro\markers.json"
Advanced
  • --source (also --template, or the first word) and --out (also --output, --path, the global --out, or the second word); .layout is added when missing.
  • Markers, tables, lines: --markers-json <file> or --markers <json>, --tables-json / --tables, --connectors-json / --connectors.
  • --replace-all true (default): the file gets exactly the given markers; false: the source's markers stay, given ones are added or moved.
  • Writes the .layout plus <out>.tables.json and <out>.connectors.json; the profile is not touched.
Technical internals
  • Output: source, output path, marker, table and connector counts, warnings; exit code 0.
  • Failures (exit 1): layout template-save requires --source ..., ... requires --out <path.layout>., markers json file not found: ..., layout template-save invalid markers payload: ..., layout template-save failed: ....
  • Related: engine layout template-inspect, engine layout render.

What it does Writes a .layout file from a picture or .layout: the markers, tables and connectors from JSON (files or inline); --replace-all true replaces the existing ones instead of adding.

OptionValuesMeaning
--source<path.layout-or-image>
--out<path.layout>Global option: write result output to file path instead of terminal.
--markers-json<file.json>
--markers<json-array-or-object>
--tables-json<file.json>
--tables<json-array-or-object>
--connectors-json<file.json>
--connectors<json-array-or-object>
--replace-alltrue false
Every value as a command line
engine layout template-save --replace-all true
engine layout template-save --replace-all false

Used by the GUI Layout: Create cheat sheets

Example

engine layout template-save --source <path.layout-or-image> --out <path.layout> [--markers-json <file.json> --text