JoyPro2 Discord GitHub
Engine (CLI)

engine overlay

Show:

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

#engine overlay map

written
engine overlay map [--game <id>] [--plane <name>] [--unit <DCS unit type>]

Bound buttons with modifiers and titles, for the overlay; warnings also in the --text output

For beginners

Lists the bound buttons of your profile with their modifiers and the game's titles, for the overlay that shows what a pressed button does. The HUD runs it when it starts, when the running game changes, when the DCS hook reports an aircraft and when you pick an aircraft in its list.

engine overlay map --game DCS --plane F-16C_50 --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • Only button relations with a bind (device and button) are listed; axes are not.
  • --game <id>: only relations with an action of that game (DCS, IL2Game or il2, StarCitizen or sc, or a game of engine games integrations); an unknown game gives a warning. Without it every bound button is listed, without titles.
  • --plane <name>: DCS only, the relations active for that aircraft, with the titles of its command list; it implies --game DCS.
  • --unit <DCS unit type>: the unit type the DCS hook reports (A-10C_2), turned into the profile's aircraft name: the same name, else an aircraft of the same module (front seat first), else a name that starts alike. Used only without --plane.
  • Titles come from DCS's command list of the aircraft, or the command list of a registry game; IL-2 and Star Citizen show the relation names only. A title equal to the relation name is left out.
  • Reads the profile only; nothing is written.
Technical internals
  • Output: JSON (Game, Plane, DcsPlanes = the profile's DCS aircraft, ProcessNames per game, which the HUD uses to see the running game, Entries with Relation, Title, Device, Input, Modifiers with name, device, input and switch, Warnings), or text with --text (<device> <input> + <modifiers>: <relation> (<title>), then Warning: ... lines).
  • Exit code 0; 1 with Unknown overlay map argument(s): ... or engine overlay map|dcs-hook for another verb.
  • Related: engine overlay dcs-hook, engine hud devices; reference hud.

What it does The bound buttons with modifiers and titles of a game (and aircraft or DCS unit type), for the overlay; an unknown --game is warned about. Warnings show in the JSON and the --text output.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--plane<name>Include one plane/module per flag. Example: --plane A-10C_2.
--unit<DCS unit type>

Example

engine overlay map --text

#engine overlay dcs-hook

written
engine overlay dcs-hook status|install|remove [--path <Saved Games\DCS>] [--dry-run]

Export.lua addition that tells JoyPro the aircraft; backed up

For beginners

Installs, removes or checks the DCS hook: a small script that tells JoyPro which aircraft you fly, for the HUD and overlay. On the HUD page Install DCS hook, Remove and Check run it. Close DCS before installing or removing.

engine overlay dcs-hook install --path "C:\Users\Pilot\Saved Games\DCS"
Advanced
  • status (default): installed when Scripts\JoyProOverlay.lua exists and Scripts\Export.lua has JoyPro's line.
  • install: writes Scripts\JoyProOverlay.lua and adds one line to Export.lua (creates it when missing). The line is wrapped in pcall, so a missing hook never breaks Export.lua; the hook keeps and calls the export functions of other scripts. In a mission DCS sends the aircraft over UDP to 127.0.0.1:1992 (again every 5 s) and exit at the end.
  • remove: takes JoyPro's line out of Export.lua and deletes the hook file.
  • --path <Saved Games\DCS>; without it the Saved Games folder is detected. --dry-run lists the changes only.
  • Safety: install and remove are refused while DCS runs; both files go into a game backup set first (undo: engine backups restore).
Technical internals
  • Output: JSON (Action, DryRun, ExportLua, HookFile, Installed, Changes, Warnings, Errors), or text with --text.
  • Exit code 0; 1 with No DCS Saved Games folder found; use --path <Saved Games\DCS>., Close DCS first: it reads Export.lua when a mission starts., DCS Saved Games folder not found: <path> or an unknown verb.
  • Related: engine overlay map, engine hud devices.

What it does Export.lua addition that tells JoyPro the aircraft; backed up.

OptionValuesMeaning
--path<Saved Games\DCS>Optional explicit path override. Use when you prefer option form over positional path.
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Used by the GUI HUD: Install DCS hook · HUD: Remove · HUD: Check

Example

engine overlay dcs-hook status|install|remove --text