Dwarf Fortress Herald
A DFHack Dwarf Fortress lua mod
Dwarf Fortress Herald
is a first of it’s kind mod (at least as far as I’m aware) that allows you to explore the history of your world’s inhabitants WHILST playing the game! No more mucking about with saves
Requires DFHack!
- An in-built graphical user interface for you to explore historical figures, civilisations and artifacts
- Event history view to see the entire history of a given historical figure, civilisation or artifact
- Quick access to DFHack’s inbuilt journal, so you never have to leave Dwarf Fortress to take notes
- Pin individuals or civilisations to be notified of in-game events in near real-time, including:
—
Individuals:
– Death
– Combat kills
– Position appointments & vacations
– Relationship changes (marriage, divorce, apprenticeship, worship, intrigue)
– Legendary skill achievements
– Artifact creation & written works
– Migrations & relocationsCivilisations:
– Leadership changes
– Diplomacy (peace, agreements, tribute, wars)
– Battles & raids
– Beast rampages
– Espionage (theft & abduction)
All these options are toggleable via the UI!—
Compatible with:
- Fort Mode: Yes
- Adventurer Mode: Yes
Controls:
- Alt+H or click the Herald button – Open the Herald GUI
- Ctrl+T – Cycle through tabs (Recent, Pinned, Historical Figures, Civilisations, Artifacts)
- Ctrl+E – Open Event History for the selected entry
- Ctrl+P – Toggle "Pinned only" filter
- Ctrl+D – Toggle "Show dead" filter (Historical Figures tab)
- Ctrl+I – Switch between Individuals and Civilisations (Pinned tab)
- Ctrl+J – Open DFHack Journal
- Ctrl+C – Refresh cache
- Ctrl+Z – Clear all recent announcements
- Enter – Pin/Unpin the selected entry
- Type to search and filter lists in real-time
Q: Will this impact performance?
A: The mod should not significantly impact performance unless you pin a significant number of civilisations and historical figures to track. I’ve been able to pin 40+ civilisations/individuals with no problems, though, the game can micro freeze when an announcement fires as the mod tries to gather the details of what happened
Worst case, you can try edit the tick rate of Herald by running ‘herald interval’ in the DFHack console, which will allow you to adjust how often Herald fires (can lead to worse freezes if it tries to process more events in one go – particularly happens in adventurer mode)
Q: How are pins saved?
A: Pins are split by save. Your pins can diverge depending on what save they’re associated to, even if it’s the same fort
Q: I can’t use the search feature!
A: Sometimes the search box bugs out, and you can’t type anything to filter records. To fix this, try closing the Herald GUI and ALT+TAB to minimise Dwarf Fortress, and then ALT+TAB back into the game. If that doesn’t work, press ‘~’ to open DFHack’s window and try typing in the console there
If it works in DFHack, it should work in the Herald window
Q: Some information is missing compared to Legends viewing tools!
A: Some information is, unfortunately, unavailable due to the fact that Herald attempts to access it’s records via the in-game memory
Tools such as Kromtec’s LegendViewerNext[github.com] still have value as they use DFHack’s detailed Legends view exports, which can shed more light on your world!
Q: I found a bug. What do I do?
A: Please post in the discussions tab with a description of the issue
Changelog:
Check your DF mods, and unsub resub if the mod isn’t updating to latest
If you enjoy this mod, please rate it up – it helps others find it!
Please ask for permission before modifying or distributing the mod!
