Skip to content
xadipsPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

df-hud

A HUD overlay for Dead Frontier on Windows and Linux (Wayland).

It sits on top of the game, fullscreen included, and clicks go through to the client. It talks to the game's API and DFProfiler's event map. No screen scraping, no OCR.

df-hud overlay on Dead Frontier

Features

  • Block info: region or outpost, and block support. Top right.
  • Bosses: what is on your block, or the nearest event. In Onslaught this is last / now / next
  • Keybinds: the overlay hotkeys, one per line. Starts shown.
  • Run clock: elapsed since the run started. It keeps ticking if you pause
  • XP/hr: last-change rate, scaled to an hour. Optional overflow percent (show_progress)
  • Challenge board: the whole board, filtered by category
  • Masteries: mastery levels and progress. Off by default
  • City map: the inner city. Press a key to show it

Each group sits where you put it. The map starts hidden. The keybinds list starts shown; hide it from the tray or with enabled = false. Masteries are the one group that is off until you set [widget.masteries] enabled = true.

Keys

These only work while Dead Frontier is focused.

Key Action
G City map
Z Challenge board
4 Masteries (only while that widget is enabled)
J Show or hide the overlay
K Restart the run clock
U Reset the XP/hr average

Change them in [hotkeys]. An empty value turns that one off. The keybinds group prints the live set on the overlay. See How to use.

Install

Windows, or a Wayland compositor with layer-shell: Hyprland, KDE, Sway, niri, COSMIC, and most others. GNOME, Cinnamon, and Weston do not have it. The install page lists the rest.

The overlay still draws without Hyprland. Built-in hotkeys and workspace follow need it; elsewhere bind keys to the loopback API. A one-line “no Hyprland IPC” log is expected on KDE and a Steam Deck. The tray can turn the FPS overlay on at launch, and skip the launcher dialog.

It is recommended to install DF HUD Bridge. That is how df-hud gets your session: the script keeps it in sync, and the challenge list needs it. If you skip the script, df.user_id still covers everything except the board. Details are on install.

Install, how to use, configuration.

GPL-3.0-or-later. Notes on the game feeds are in knowledge/.

Development

Building it, or sending a patch? Development has the checks CI runs, and where LLMs fit in.

Why was this made?

Inspired by SilverOverlays which I couldn't make work for Linux. At first I decided to build a Go application for Linux which I eventually ported to Windows as well, but it was a shitty first attempt and a pain to build, so here we are.

LLM use

I used LLMs to help write this, on purpose. Everything in the tree still got read and understood by a person. If nobody can explain a change, it doesn't go in.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages