JoyPro2 Discord GitHub
GUI pages

HUD

Show:

The HUD shows your devices on screen while you play, like a streamer's controller overlay: the stick picture tilts with your stick, levers and axes move as bars, held buttons light up with their names, and a line says what the pressed button does in the running game ("Gear Toggle"). It can show over the game, in OBS, or both, each with its own widgets. This page is its designer.

The HUD designer with the live previewThe HUD designer with the live preview
The HUD designer with the live preview
flowchart LR
  D["Your devices"] --> P["The HUD"]
  O["Your binds in<br/>the game"] --> P
  P --> S["On my screen"]
  P --> B["Page for OBS"]
  P --> W["Stream window"]
The HUD reads your devices and your binds in the running game, and shows them in up to three places at once: on your screen over the game, on a page for OBS, and in a stream window.
For beginners

#Start the HUD in three clicks

  1. Open HUD in the bottom bar. The preview already moves when you move your stick.
  2. Leave On my screen (over the game) ticked.
  3. Press Start HUD (also on the Start page). Start your game: the HUD sits on top of it and never takes the mouse or the keyboard away from the game.

Stop HUD (the same button) closes it. Everything you set here is kept and is there again after a restart.

#What is on the screen

  • One widget per device: sticks, throttles and pedals are shown at the start, panels and keyboards are hidden (tick them in the Widgets list). Each widget can show the device's photo, the stick position, the axes as bars, the buttons and hats.
  • The aircraft widget: the stick and throttle of the aircraft you fly, as the game draws them, moving with yours.
  • The game header: the game or DCS aircraft with its picture.
  • What the button does: the last pressed buttons with their action in the running game.

Drag a widget in the preview to move it; click it to change it on the right. Arrange automatically puts them along the bottom: throttle and left-hand devices left, pedals in the middle, the right-hand stick right.

The aircraft widget: the aircraft's own stick and throttleThe aircraft widget: the aircraft's own stick and throttle
The aircraft widget: the aircraft's own stick and throttle
In the game: What you see in the game

The HUD window is transparent and stays on top of windowed and borderless games. Clicks go through it to the game. It is not in the task bar or Alt+Tab. Exclusive full screen hides it (a Windows limit): switch the game to borderless. The pressed button's line names the action of that game and aircraft, for example "Weapon Release" in the F-16C and "Fire guns" in IL-2.

Advanced

#Where the HUD shows

The three outputs are independent of each other:

Output For How
On my screen (over the game) you a transparent window on top of the game
Page for OBS (Browser Source, transparent) your stream (recommended) JoyPro serves a page on this PC only; Copy puts its address on the clipboard
Stream window (Window Capture) streams with Window Capture a normal window (may sit behind the game) with a transparent or chroma key background

Untick On my screen to play with a clean screen while the stream still shows the HUD, or show other widgets on each: every widget has two ticks, a monitor (your screen) and OBS (the stream). Preview: My screen / The stream switches what the designer shows. Updates per second at most (15, 30 or 60; 30 is smooth and light).

#Set up OBS (Browser Source)

  1. Tick Page for OBS (Browser Source, transparent) and press Start HUD.
  2. Press Copy next to the address (http://127.0.0.1:8765/hud).
  3. In OBS: Sources > + > Browser. Paste the address as URL, Width 1920, Height 1080. Nothing else is needed: the background is transparent, no custom CSS.
  4. Optional: tick Shutdown source when not visible so OBS stops the page in scenes without it.

The page draws the widgets ticked for the stream, in the same places and styles as the app, on a 1920 x 1080 stage scaled to the source. Port taken by another program? Pick another one under Port and copy the address again.

The stream page as OBS shows itThe stream page as OBS shows it
The stream page as OBS shows it

Window Capture instead: tick Stream window, pick the background (transparent, green, magenta, blue or your colour). In OBS add Window Capture with Capture Method: Windows 10 (1903 and up); with a colour add a Chroma Key filter in that colour. If a transparent background shows black in your OBS, use the Browser Source or a colour.

How the OBS Browser Source gets the HUD: one page, then only the changes.

# Who What happens
1 OBS The Browser Source opens http://127.0.0.1:8765/hud.
2 JoyPro Sends the page: layout, styles and pictures.
3 OBS Opens /hud/events. It stays open.
4 JoyPro Sends the state (axes, buttons, what the button does), at most 30 times a second and only when something changed.
5 JoyPro Sends the layout again when widgets, places or styles change.

#Widgets

Widgets lists every device plus the header, the binds ticker and the aircraft widget. Reload devices reads the connected devices again; Show all ticks every widget for your screen; Arrange automatically and Reset places put them in place.

Per widget (click it in the preview or the list):

  • Show on my screen, Show in the stream, Size, Style of this widget (the HUD's style or any other).
  • Show: name, kind (stick, throttle), picture, picture tilts with the stick, buttons light up, held buttons by name, axes and levers, axis names, axis values, stick position (gimbal), hats. The header widget: its picture.
  • Picture: Photo (the manufacturer's picture, background cut away), Layout (your JoyPro layout picture from the Layout page, with the pressed buttons lit at their place), Auto (the photo when there is one).
  • Grip on this base: for bases that take several grips (VPforce Rhino, Virpil WarBRD); the grip decides the picture and the button names.
  • Stick axes: where X, Y and Twist of the stick element come from. Automatic takes the device's own axes; a grip that is a device of its own without axes takes them from the base it sits on.
A device widget selected: what it shows, its picture and stick axesA device widget selected: what it shows, its picture and stick axes
A device widget selected: what it shows, its picture and stick axes

The aircraft widget: stick, throttle, throttle travel bar, stick position, controls light up, held controls by name; Aircraft (Automatic: the aircraft you fly, or any picture set on this PC) and Moves with (the stick and throttle that move it). Its pictures come from the game's own cockpit pictures (Cockpits > Build pictures from my games, or a picture pack), else JoyPro's line drawing of the real grip.

#The 40 styles

Style has 40 presets: Glass, Neon, Minimal, clean ones (Frosted light, Streamer clean, Streamer bold, Compact, Large text, Pastel, Outline only), cockpit displays (Military green HUD, Amber MFD, Airliner PFD, Glass cockpit, Night vision, Red cockpit lighting, Vector wireframe, Retro terminal, Warbird, Hologram), games and genres (Space sim orange, Holo cyan, Cyberpunk, Synthwave, Neon pink, Racing, Tactical tan, Navy and gold, Stealth, Ghost), colour themes (Arctic, Desert, Ocean, Sunset, Royal, Carbon) and readability (High contrast, High contrast light, Monochrome, Monochrome light). › steps to the next one.

A few of the 40 stylesA few of the 40 styles
A few of the 40 styles

Below: accent colours in one click, Accent, Pressed and Opacity, then the design options per element: Cards (background, border, corners, shadow), Text (font, size, letter spacing, colours, Bold names), Stick element (ring, square, crosshair, radar, dot; size, glow), Bars and levers (shapes, heights, the empty part) and Buttons and chips (shapes). A changed option makes the style "own design (changed)": Save style keeps it under your name, Undo changes goes back to the preset, Export style... / Import style... share it as a file, Delete removes your own style.

#What the button does and the DCS aircraft

What the button does: how many lines, how long they stay (seconds), the font size, Show device and button and Only while a game runs. Click-through lets mouse clicks pass through the HUD window (applies when the HUD starts).

JoyPro finds the running game by its process (DCS, IL-2, Star Citizen and every other game it handles) and shows only that game's binds. DCS also needs the aircraft: pick it under DCS aircraft, or Install DCS hook so DCS tells JoyPro the aircraft at every mission start (a small Lua file plus one guarded line in Export.lua, backed up first; Remove puts the file back byte for byte; close DCS first). Check says whether the hook is installed.

The HUD over a gameThe HUD over a game
The HUD over a game
Technical internals

#Behind the page

View model: MainWindowViewModel.Hud.cs (devices, widgets, layout), MainWindowViewModel.HudStyles.cs (presets, own styles, import/export), MainWindowViewModel.HudStream.cs (outputs, stream page, aircraft widget), MainWindowViewModel.HudAxes.cs (stick axes), MainWindowViewModel.Overlay.cs (start/stop, running game, button lines, DCS hook). Views: Views/HudWindow.axaml, Views/Controls/HudSurface.axaml, HudElements.cs, HudPanel.cs. Presets: Models/HudStylePresets.cs.

  • Devices: engine hud devices gives each connected device's model, kind, hand, product picture, axes with their role, buttons with their names and control ids (Controls, for the aircraft widget) and the layout picture with button positions.
  • Binds of the running game: engine overlay map (--game, --plane, --unit): the bound buttons with modifiers and titles. A bind with modifiers shows while its modifiers are held; the bind with the most matching modifiers wins.
  • DCS hook: engine overlay dcs-hook status / install / remove (--path, --dry-run): Scripts\JoyProOverlay.lua plus one pcall-wrapped line in Export.lua; DCS sends the unit type to 127.0.0.1:1992 (UDP). The hook calls the export functions of other scripts (SRS, Tacview) it replaces.
  • Stream server: Services/HudStreamServer.cs, HudStreamHub.cs, Resources/hud-stream.html; bound to 127.0.0.1 only, requests with another host name are refused. GET /hud (page), /hud/events (Server-Sent Events: layout, state), /hud/img/<id> (pictures as PNG), /hud/state (JSON). Without a connected page it only listens.
  • Cost while you play: Services/HudInputPump.cs keeps only the newest report per device and applies them at the chosen rate; elements redraw only on change; nothing is allocated per report; pictures are cut once (aircraft grips 480 px high). Measured by the HUD soak test against CPU, allocation and memory budgets.
  • Settings: %APPDATA%\JoyPro2\hud.json (places, sizes, per-widget ticks for screen and stream, the style with every option, own styles, outputs, port, background, update rate). Style files: *.joypro-hudstyle.json ("format": "joypro-hud-style").

Reference: hud.

#Reference

The feature documentation behind this page, generated from the repository:

#Every control on this page

42 controls, read from the program’s source: 42 written, 0 with the facts from the source (tooltip, code comment, engine call), 0 still to be expanded.

#Toggle overlay

Buttonwritten

Start HUD / Stop HUD: starts the HUD with the outputs ticked above (on screen, the OBS page, the stream window): reads the devices if needed, finds the running game and loads its binds (engine overlay map). Pressed again it closes every output. In the game: the HUD appears over the game (windowed or borderless) and in OBS.

Source MainWindow.axaml:6326 · ToggleOverlayCommand in MainWindowViewModel.Overlay.cs

#On my screen (over the game)

Check boxwritten

Tooltip The transparent HUD on top of the game. Untick it to keep your own screen clean while the stream still shows the HUD.

Shows the HUD as a transparent window on top of the game (on by default). Untick it to keep your own screen clean while the stream still shows the HUD. While the HUD runs the change applies at once. In the game: the HUD appears or goes away over a windowed or borderless game.

Source MainWindow.axaml:6331 · HudOnScreen in MainWindowViewModel.HudStream.cs · setting HudOnScreen

#Page for OBS (Browser Source, transparent)

Check boxwritten

Tooltip JoyPro serves the HUD as a web page on this PC only. In OBS add a Browser Source with this address: the background is transparent, no custom CSS needed.

While the HUD runs, JoyPro serves it as a web page on this PC only (http://127.0.0.1:<port>/hud) for an OBS Browser Source: transparent background, no custom CSS. Ticked, the address with Copy and the Port show below.

Source MainWindow.axaml:6333 · HudStreamBrowser in MainWindowViewModel.HudStream.cs · setting HudStreamBrowser

#Copy

Buttonwritten

Copies the address of the OBS page (http://127.0.0.1:<port>/hud) to the clipboard. In OBS: Sources > + > Browser, paste it as URL, width 1920, height 1080.

Source MainWindow.axaml:6337 · CopyHudStreamUrlCommand in MainWindowViewModel.HudStream.cs

#Stream window (Window Capture)

Check boxwritten

Tooltip A window of its own, not on top: it may sit behind the game. In OBS: Window Capture with the capture method Windows 10 (1903 and up); with a chroma key colour add a Chroma Key filter.

While the HUD runs, opens a window of its own for OBS's Window Capture (not on top, so it may sit behind the game), with a transparent background or a chroma key colour picked below. In OBS: capture method Windows 10 (1903 and up), and a Chroma Key filter for a colour.

Source MainWindow.axaml:6343 · HudStreamWindow in MainWindowViewModel.HudStream.cs · setting HudStreamWindow

#Show on your screen

Check boxwritten

The monitor tick of a widget in the list: shows it on your screen (the HUD over the game).

Source MainWindow.axaml:6368 · Visible in HudItems.cs · setting Visible

#Show in the stream

Check boxwritten

The OBS tick of a widget in the list: shows it in the stream (the OBS page and the stream window).

Source MainWindow.axaml:6369 · StreamVisible in HudItems.cs · setting StreamVisible

#Show all

Buttonwritten

Ticks every widget for your screen (also panels and keyboards that start hidden). Untick the ones you do not want in the list.

Source MainWindow.axaml:6383 · ShowAllHudDevicesCommand in MainWindowViewModel.Hud.cs

#Arrange automatically

Buttonwritten

Tooltip Throttle and left hand left, pedals in the middle, right-hand stick right, along the bottom

Places the device widgets shown on your screen along the bottom: throttle and left-hand devices left, pedals in the middle, the right-hand stick right; what does not fit goes a row up. The new places are kept.

Source MainWindow.axaml:6384 · ArrangeHudCommand in MainWindowViewModel.Hud.cs

#Reset places

Buttonwritten

Puts every widget back to its default place and size (the places you dragged are forgotten); what each widget shows stays.

Source MainWindow.axaml:6385 · ResetHudLayoutCommand in MainWindowViewModel.Hud.cs

#›

Buttonwritten

Tooltip Next style

Switches the HUD to the next entry of the Style list (presets, then your own styles; after the last it starts again).

From the code The › button: the next style of the list (after the last one the first again).

Source MainWindow.axaml:6395 · NextHudStyleCommand in MainWindowViewModel.HudStyles.cs

#Accent colour

Buttonwritten

Gives the style this accent colour. The HUD takes it at once; the style shows as "own design (changed)" until you save it.

Source MainWindow.axaml:6406 · SetHudAccentCommand in MainWindowViewModel.Hud.cs

#Bold names

Check boxwritten

Shows the widgets' names in bold. Part of the style: changes it to "own design (changed)" until saved.

Source MainWindow.axaml:6449 · setting HudLookEditor.BoldTitles

#Save style

Buttonwritten

Keeps the current design as your own style under the name typed next to it, and makes it the HUD's style. A preset's name is refused; your style of the same name is replaced.

From the code Save style: the current design as an own style under HudStyleName (an own style of that name is replaced).

Source MainWindow.axaml:6492 · SaveHudStyleCommand in MainWindowViewModel.HudStyles.cs

#Import style...

Buttonwritten

Reads a style file (*.joypro-hudstyle.json) and makes it one of your styles and the HUD's style. A name you already use gets a number.

#Export style...

Buttonwritten

Saves the current design as a style file (*.joypro-hudstyle.json) to share or keep; the HUD does not change.

#Undo changes

Buttonwritten

Tooltip Back to the style picked above

Puts the design back to the style you had before the changes made by hand: the style picked, saved or imported last (or the HUD's design when JoyPro started).

From the code Undo changes: back to the style before the changes made by hand (the one picked, saved or imported last, or the HUD's look at start).

Source MainWindow.axaml:6497 · ResetHudStyleCommand in MainWindowViewModel.HudStyles.cs

#Delete

Buttonwritten

Deletes the picked style of your own (presets cannot be deleted). Widgets that used it go back to the HUD's style; the HUD keeps its current look.

Source MainWindow.axaml:6498 · DeleteHudStyleCommand in MainWindowViewModel.HudStyles.cs

#Show device and button

Check boxwritten

Adds the device and button under each line of What the button does ("Throttle - HOTAS Warthog · BTN 22").

Source MainWindow.axaml:6512 · OverlayShowDevice in MainWindowViewModel.Overlay.cs · setting OverlayShowDevice

#Only while a game runs

Check boxwritten

Shows the What the button does lines only while a supported game runs (on by default); off, they also show on the desktop.

Source MainWindow.axaml:6513 · OverlayOnlyInGame in MainWindowViewModel.Overlay.cs · setting OverlayOnlyInGame

#Click-through (applies on start)

Check boxwritten

Mouse clicks pass through the HUD window to the game (on by default). Applied when the HUD starts: stop and start it after changing this.

Source MainWindow.axaml:6514 · OverlayClickThrough in MainWindowViewModel.Overlay.cs · setting OverlayClickThrough

#Install DCS hook

Buttonwritten

Installs the DCS hook (engine overlay dcs-hook install): Scripts\JoyProOverlay.lua and one guarded line in Export.lua (backed up first, other export scripts keep working). Close DCS first. In the game: from the next mission start DCS tells JoyPro the aircraft you fly, and the HUD shows its binds and its stick and throttle.

Engine engine overlay dcs-hook

Source MainWindow.axaml:6521 · InstallDcsHookCommand in MainWindowViewModel.Overlay.cs

#My screen

Optionwritten2 ×

My screen / The stream: what the designer's preview shows, the widgets ticked for your screen or those ticked for the stream. Only the preview changes; the choice is kept for the next start.

From the code The designer's preview shows the widgets ticked for the stream instead of those for the screen.

Source MainWindow.axaml:6534 · HudPreviewStream in MainWindowViewModel.HudStream.cs · setting HudPreviewStream

#Show on my screen

Check boxwritten

Shows the selected widget on your screen (the monitor tick in the list).

Source MainWindow.axaml:6552 · setting SelectedHudWidget.Visible

#Show in the stream

Check boxwritten

Shows the selected widget in the stream: the OBS page and the stream window (the OBS tick in the list).

Source MainWindow.axaml:6553 · setting SelectedHudWidget.StreamVisible

#Name

Check boxwritten

Shows the device's name on its widget.

Source MainWindow.axaml:6560 · setting SelectedHudWidget.ShowName

#Picture

Check boxwritten

Game header widget: shows the picture of the game or DCS aircraft next to its name.

Source MainWindow.axaml:6561 · setting SelectedHudWidget.ShowHeaderPicture

#Kind (stick, throttle)

Check boxwritten

Shows the device's kind under its name (stick, throttle, pedals, panel).

Source MainWindow.axaml:6563 · setting SelectedHudWidget.ShowKind

#Picture

Check boxwritten

Shows the device's picture (the photo or your layout picture, see Picture).

Source MainWindow.axaml:6564 · setting SelectedHudWidget.ShowPicture

#Picture tilts with the stick

Check boxwritten

Tilts and twists the device picture with the stick, as if the real stick moved.

Source MainWindow.axaml:6565 · setting SelectedHudWidget.Tilt

#Buttons light up

Check boxwritten2 ×

Device widget: held buttons light up (on the button grid, or on the layout picture at their place). Aircraft widget (Controls light up): the aircraft's control that your pressed button stands for lights up on its stick or throttle (the Warthog's TMS up lights the A-10C's TMS).

Source MainWindow.axaml:6566 · setting SelectedHudWidget.ShowButtons

#Held buttons by name

Check boxwritten2 ×

Device widget: held buttons show as chips with their names from the device catalog ("Trigger second detent"). Aircraft widget (Held controls by name): the aircraft's held controls by name under the grips.

Source MainWindow.axaml:6567 · setting SelectedHudWidget.ShowChips

#Axes and levers

Check boxwritten2 ×

Device widget: every axis and lever moves as a bar. Aircraft widget (Throttle travel bar): a bar next to the throttle with your lever's position.

Source MainWindow.axaml:6568 · setting SelectedHudWidget.ShowAxes

#Axis names

Check boxwritten

Writes each axis's name next to its bar (roll, pitch, twist, left lever).

Source MainWindow.axaml:6569 · setting SelectedHudWidget.ShowLabels

#Axis values

Check boxwritten

Writes each axis's value next to its bar.

Source MainWindow.axaml:6570 · setting SelectedHudWidget.ShowValues

#Stick position (gimbal)

Check boxwritten2 ×

Shows the stick element: a dot in a ring (or the style's shape) at the stick's position, with a tick for the twist.

Source MainWindow.axaml:6571 · setting SelectedHudWidget.ShowGimbal

#Hats

Check boxwritten

Shows the hats; the pressed direction lights up.

Source MainWindow.axaml:6572 · setting SelectedHudWidget.ShowHats

#Stick

Check boxwritten

Aircraft widget: shows the aircraft's own stick picture, tilting with your stick.

Source MainWindow.axaml:6599 · setting SelectedHudWidget.ShowStick

#Throttle

Check boxwritten

Aircraft widget: shows the aircraft's own throttle picture, sliding with your throttle's first lever.

Source MainWindow.axaml:6600 · setting SelectedHudWidget.ShowThrottle