JoyPro2 Discord GitHub
Engine (CLI)

engine hud

Show:

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

#engine hud devices

written
engine hud devices [--grip <device>=<catalog id>]... [--no-device-photos]

Connected devices for the HUD: product picture address, axes with their role, buttons, hats, layout picture with button positions; --no-device-photos leaves the makers' photo addresses out; the engine downloads no device photo, the GUI does per device after the user's yes

For beginners

Lists the connected devices with everything the HUD draws: the product picture address, axes with their role, buttons, hats and the layout picture with the button positions. Reload devices on the HUD page and Look again in Settings > Devices run it.

engine hud devices --grip "VPforce Rhino FFB {B4280440-0000-0000-0000-504944564944}=vkb-gunfighter-mcg" --text
Advanced
  • Per device: what DirectInput reports, the catalog model (picture address, kind, hand, the meaning of each axis and button) and the layout picture: the one the profile assigned to the device, else the best template JoyPro has.
  • --grip <device>=<catalog id> (repeatable) names the grip on a base that takes several; such a base lists its grip choices. The GUI passes the grips set in the HUD designer or on the Layout page.
  • --no-device-photos leaves the makers' photo addresses out (the GUI passes it when Settings > Privacy says Never).
  • Read-only. The engine downloads no picture; the GUI does, per device, after your yes.
Technical internals

What it does Connected devices for the HUD: product picture address, axes with their role, buttons, hats, layout picture with button positions; --no-device-photos leaves the makers' photo addresses out; the engine downloads no device photo, the GUI does per device after the user's yes.

OptionValuesMeaning
--grip<device>
--no-device-photosswitch (no value)

Used by the GUI Profile bar: Undo · Start: Refresh · Layout: Find my devices · HUD: Reload devices · Settings: Look again · Settings: Remove

Example

engine hud devices --text