v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "v0.34:Utilities"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
 
(66 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{{quality|Fine|10:37, 8 May 2012 (UTC)}}{{av}}
+
{{Quality|Masterwork|13:28, 28 September 2013 (UTC)}}
 +
{{av}}
  
:''You may also like to see the [[Main:Tileset repository|Tileset repository]] or [[DF2012:Graphics set repository|Graphics set repository]].''
+
'''Utilities''' are third party applications useful for ''Dwarf Fortress'' players and modders, and this page serves as a list of them. ''Dwarf Fortress'' is a difficult game to play, and any help that can be had in the task is welcome help. This page lists utilities useful for modders and player alike. If you would like to add an article on a ''specific'' game utility to the wiki, please do so under the <span class="plainlinks">[http://dwarffortresswiki.org/index.php?title=Special%3AAllPages&from=&to=&namespace=102 Utility]</span> namespace. Not included on this page: [[Main:Tileset repository|tileset repositories]] and [[DF2012:Graphics set repository|graphics set repositories]] have been given their own, separate page. [[Modding|Mods]] have also been listed under their own <span class="plainlinks">[http://dwarffortresswiki.org/index.php?title=Special%3AAllPages&from=&to=&namespace=104 Modification] namespace. To avoid namespace clutter websites ''are'' considered utilities and have been included.
  
Here are third party applications useful for Dwarf Fortress players and modders.
+
A [http://www.bay12forums.com/smf/index.php?board=29.0 subsection of the Bay12 forums] is devoted to such third party programs, and contains development threads for most of them.
  
__TOC__
+
The [[Utilities#Lazy Newb Pack|Lazy Newb Pack]] is an effort to make ''Dwarf Fortress'' more accessible for new players by bundling and configuring utilities, graphics and tilesets, and extras such as reference material or more intuitive controls. 
  
==Dwarf Fortress filesharing services==
+
== [[Utility:Lazy_Newb_Pack|Lazy Newb Pack]] ==
 +
A commonly-used software bundle with a nice launcher. Allows to start playing DF really quickly on a new machine - no need to download and integrate [[Graphics set repository|tilesets]] and tools like Dwarf Therapist, SoundSense, etc. - or even know what you need to get.  The newer packs also include many third-party fixes for common bugs, which work automatically, and a large number of significant user interface improvements.  The launcher makes changing settings or graphics options much easier (press button, instead of editing files) and can even remember to launch selected utilities whenever you open a game of Dwarf Fortress.  See the [[Utility:Lazy_Newb_Pack|Lazy Newb Pack]] page for more information, or the forum thread for your platform.
  
=== [http://dffd.wimbli.com/ Dwarf Fortress File Depot] ===
+
*[http://www.bay12forums.com/smf/index.php?topic=126076 PeridexisErrant Lazy Newb Pack] (windows)
The Dwarf Fortress File Upload Service - an excellent place to store mods, community games, tilesets and other files. Courtesy of [[User:Janus|Janus]]; for files related to Dwarf Fortress only.
+
*[http://www.bay12forums.com/smf/index.php?topic=128960 MacNewbie Pack ReBorn] (OS X)
 +
*[http://www.bay12forums.com/smf/index.php?topic=130792  Lazy Newb Pack Installer for Linux]
 +
 
 +
== 3D Visualizers ==
  
=== [http://mkv25.net/dfma/ DF Map Archive] ===
+
=== [[Utility:Stonesense|Stonesense]] ===
 +
Stonesense is a third party visualizer, implemented as a [[Utility:DFHack|DFHack]] plugin, that lets you view your fortress in a classic isometric perspective. It runs alongside Dwarf Fortress, and can follow the main game's view, updating in real time. It is included in DFHack, and can be opened by typing <code>stonesense</code> or <code>ssense</code> into the console window. 
  
* http://mkv25.net/dfma/
+
=== [http://www.bay12forums.com/smf/index.php?topic=63484 Fortress Overseer] ===
 +
Fortress Overseer is the only 3D visualizer supporting v0.31. It has been completely rewritten and is currently updated to support v0.34.11 and v0.31.25). Overseer works indirectly, by using [[Utility:DFHack|DFHack]]'s <code>mapexport</code> to export a file which can then be rendered in 3D.  DirectX 9 must be installed, though this requirement is not documented.
  
The Dwarf Fortress Map Archive is a large collection of user-submitted maps and a nice flash viewer for perusing them.   
+
=== [http://www.bay12forums.com/smf/index.php?topic=70700.0 Isoworld] ===
Maps are uploaded, stored, and downloaded in a special compressed format created by the DF Map Compressor (see below).
+
Isoworld is an isometric world map viewer, which can display each of the detailed maps exported from Legends Mode. It also has a pictographic view which makes finding waterfalls easy.   
  
Read more about the [[User:Markavian/DF_Map_Archive|DF Map Archive]] on [[User:Markavian|Markavian]]'s User page.
+
Isoworld can link with [[Utility:DFHack|DFHack]] to display a game view at full spatial resolution in wider context, including tracking the game view.  This is particularly useful for adventure mode.
  
== 3D Visualizers ==
+
== Music and Sounds ==
  
=== [http://dffd.wimbli.com/file.php?id=3882/ Fortress Overseer] ===
+
=== [[Utility:SoundSense|SoundSense]] ===
Fortress Overseer has been the only 3d visualizer since DF 2010, It has been completely rewritten and is currently updated to support DF 2012 (currently supporting versions 34.07 and 31.25).
 
  
Read more on the [http://www.bay12forums.com/smf/index.php?topic=63484.0/ bay 12 forum post]
+
SoundSense is a tool that parses game logs and reacts to game events with sound effects, incidental music and dwarfy comments.  You can look it up on the [http://www.bay12forums.com/smf/index.php?topic=60287 forum thread], or directly download it at [http://df.zweistein.cz/soundsense/ the SoundSense homepage].
  
=== [http://www.bay12forums.com/smf/index.php?topic=70700.0 Isoworld 2.0] ===
+
== Game manipulation tools ==
Isoworld is an isometric world map viewer, which can display each of the detailed maps exported from Legends Mode.  It also has a pictographic view which makes finding waterfalls easy. 
 
  
Isoworld can link with DFhack to display a game view at full spatial resolution in wider context, including tracking the game view.  This is particularly useful for adventure mode.
+
===[[Utility:DFHack|DFHack]]===
  
== Music and Sounds ==
+
[[Utility:DFHack|DFHack]] is an advanced Dwarf Fortress memory access library and a set of tools and scripts using this library, providing direct object-oriented access to Dwarf Fortress's internals as if it were compiled into the game itself. Releases support versions up through 0.34.11 (as of June 22nd, 2012). Runs on Windows, Linux, and MacOS X.
 +
 
 +
DFHack has an [http://www.bay12forums.com/smf/index.php?topic=139553.0 official forum thread].  Code and binary releases are available from the [https://github.com/DFHack/dfhack/downloads Github site].
  
=== [[Utility:SoundSense|SoundSense]] ===
+
As of June 2014, the current version is r5; however there still may exist some compatiblity issues with plugins and scripts who have not been yet updated to r5 (because of development that has been halted for instance).
  
SoundSense is a tool that parses game logs and reacts to game events with sound effects, incidental music and dwarfy comments.
+
Falconne's UI plugins work through DFHack, as do automation tools such as Autolabor, Workflow, Autobutcher, and many others.
  
[http://www.bay12forums.com/smf/index.php?topic=60287 forum thread], download at [http://df.zweistein.cz/soundsense/ homepage].
+
==== DFHack User Interface Plugins ====
  
== Interface tools ==
+
===== [http://www.bay12forums.com/smf/index.php?topic=119575.0 Falconne's Plugins] =====
=== [http://www.bay12forums.com/smf/index.php?topic=119575.0 DFHack Utility Plugins] ===
 
 
A collection of DFHack plugins that improve the in-game interface with features such as:
 
A collection of DFHack plugins that improve the in-game interface with features such as:
 
* Search function in screens with big lists.
 
* Search function in screens with big lists.
Line 49: Line 55:
 
* Easier pasturing, live happiness monitor, mouse support, stocks dashboard.
 
* Easier pasturing, live happiness monitor, mouse support, stocks dashboard.
  
== Game manipulation tools ==
+
===== [http://www.bay12forums.com/smf/index.php?topic=124708 Autobutcher GUI] =====
  
===[http://code.google.com/p/dwarftherapist/ Dwarf Therapist]===
+
==== DFHack Bugfixing Plugins ====
 +
*[http://dffd.wimbli.com/file.php?id=7849 Plugin] that fixes the [http://www.bay12forums.com/smf/index.php?topic=126558.msg4278098#msg4278098 growth bug]
  
Dwarf Therapist gives you an advanced GUI to manage and check dwarf job allocations, military assignments (40d), statistics (such as attributes, personality traits and happiness), plus sort dwarves by various criteria (eg. profession, migration wave, happiness, number of assigned jobs etc.) and generally manage the Dwarven Resources of your fortress in a very convenient way.  
+
==== Binary patches ====
 +
Binary patches are utilities made by users to fix known bugs that haven't been addressed by the development team yet.  
  
Version 0.6.12 is out. This version supports DF builds up to 0.34.02 by default, but with the auto-update it supports up to 0.34.10.
+
*[http://dffd.wimbli.com/file.php?id=7207 This executable] contains many bugfixes, including the long-standing armory bug that prevent racks and armor stands from ever being used.
  
Read the full changelog here: http://code.google.com/p/dwarftherapist/source/browse/CHANGELOG.txt
+
==== Feature plugins ====
 +
These plugins add features to the game.
 +
* [http://www.bay12forums.com/smf/index.php?topic=127116.0 Digging invaders], a plugin that allows hostiles to dig and deconstruct walls to path to one's fortress.
 +
* [http://www.bay12forums.com/smf/index.php?topic=128487.0 Rendermax], a plugin that implements a lighting system at the graphics level.
 +
* [http://www.bay12forums.com/smf/index.php?topic=136155.0 Dwarven Emigration], a plugin that allows unhappy dwarves to emigrate with their families.
  
Discussion on Bay 12 Games forums: http://www.bay12forums.com/smf/index.php?topic=66525
+
==== Interaction plugins ====
 +
[http://www.bay12forums.com/smf/index.php?topic=135597.0 DFHack scripts designed for use in interactions as "spells"]
  
====For Mac users====
+
==== Miscellaneous plugins ====
A DT version for natively running it on OSX is in the works by DwarfEngineeer and beta versions compatible with 34.03+ are now available on [http://code.google.com/p/dwarftherapist/downloads/list the dwarftherapist downloads page]. A mac version of this utility (built by ghalidrim) is outdated and is compatible with DF version 31.25. It is free for download at [http://dffd.wimbli.com/file.php?id=4463 the DF file depot]. It is also possible to use DT with the latest version of DF by using
+
[http://www.bay12forums.com/smf/index.php?topic=135506.0 DFHack script collection]
=====Dwarf Therapist and Dwarf Fortress on Mac using Wine=====
 
# Download latest windows versions [http://www.bay12games.com/dwarves/ DF] and [http://code.google.com/p/dwarftherapist/downloads/list DT].
 
# Download winebottler http://winebottler.kronenberg.org/. It should also download wine. Launch them both.
 
# Click the Wine icon on your taskbar and find Change Prefix.
 
# From there, create a prefix (it may auto-detect some other games and create prefixes for them, don't bother with that) in a convenient directory, call it 'generic' or something.
 
# Click Change Prefix again after it's done configuring and make sure Wine is using that one.
 
# Move DF and DT to the Program Files associated with the *general* prefix. DT won't find any running versions of DF otherwise. Mine was located in *username*/documents/generic/drive_c/program files.
 
# When launching DF and DT a small window pops up asking which prefix you want to use, choose general.
 
# Strike the earth.
 
  
If Dwarf Therapist in Wine starts running slow or gets really laggy, find it's preference file, "Dwarf Therapist.ini," and trash it.
+
==Dwarf Therapist==
It is located in *username*/documents/generic/drive_c/users/*usernameagain*/application data/UDP Software/.
 
If you are using MacNewbie, it is located in "~/.config/UDP Software/".
 
==== Splinterz Fork ====
 
  
This is a fork from the original DwarfTherapist made by user Splinterz:
+
===[http://www.bay12forums.com/smf/index.php?topic=122968 Dwarf Therapist]===
http://code.google.com/r/splintermind-attributes/
 
  
This version contains the "labor optimizer" semi-automatic labor management system. As of 2013-04-21 has only been released for Windows and Linux, with no builds for OS X
+
Dwarf Therapist gives you an advanced GUI to manage and check dwarf job allocations, military assignments, statistics (such as attributes, personality traits and happiness), sort dwarves by various criteria (e.g. profession, migration wave, happiness, number of assigned jobs etc.) and generally manage the Dwarven Resources of your fortress in a very convenient way. This version contains the "labor optimizer" semi-automatic labor management system.  
  
====Dwarf Builder (OSX) ====
+
Splinterz' fork of Dwarf Therapist is the currently updated version, and available for Windows, Mac and GNU + Linux.  Besides the Bay12 forum thread, there's more information on the [https://github.com/splintermind/Dwarf-Therapist GitHub project page].
[http://www.bay12forums.com/smf/index.php?topic=106974.0|"Dwarf Builder"] for OS X is also available. It contains a working version of Dwarf Therapist, which can be created using "Build Dwarf Therapist" (or DT).
 
  
===[[Utility:DFHack|DFHack]]===
+
====[[Dwarf Therapist Addons Repository]]====
  
DFHack is an advanced Dwarf Fortress memory access library and a set of tools and scripts using this library, providing direct object-oriented access to Dwarf Fortress's internals as if it were compiled into the game itself. Releases support versions up through 0.34.11 (as of June 22nd, 2012). Runs on Windows, Linux, and MacOS X.
+
A collection of customizations for Dwarf Therapist submitted by the community.
  
DFHack has an [http://www.bay12forums.com/smf/index.php?topic=91166.0 official forum thread].
+
Addons include:
  
Code and binary releases are available from the [https://github.com/peterix/dfhack/downloads Github site].
+
* custom professions
 +
* custom roles
 +
* optimization plans
 +
* filter scripts
 +
* new grid views
  
 
== Fortress layout tools ==
 
== Fortress layout tools ==
 
=== [http://www.bay12forums.com/smf/index.php?topic=87731 DF Designator] ===
 
=== [http://www.bay12forums.com/smf/index.php?topic=87731 DF Designator] ===
DF Designator helps you build fortresses from either image files or Quickfort .CSV files. It also has a user interface that allows you to assign hotkeys to blueprints and to combine blueprints in multi z-level designs. Windows, Mac and Linux versions are available.
+
DF Designator helps you build fortresses from either image files or Quickfort .CSV files. It also has a user interface that allows you to assign hotkeys to blueprints and to combine blueprints in multi z-level designs. Windows, Mac and Linux versions are available. DF Designator uses 'typewriter style' playback, and is thus very slow for large projects. 
  
 
=== [http://www.joelpt.net/quickfort/ Quickfort] ===
 
=== [http://www.joelpt.net/quickfort/ Quickfort] ===
 +
https://github.com/joelpt/quickfort
 +
 +
Quickfort is a utility for Dwarf Fortress that helps you build fortresses from "blueprint" .CSV files (comma separated values). These files are easily created and edited in an app like Excel. Most building-oriented DF commands are supported through the use of multiple .CSV files to describe the different phases of DF construction (designation, building, stockpiles, and making adjustments. Recent versions of Quickfort work by converting the blueprint into a native macro for Dwarf Fortress, then executing the macro.  This allows for enormously faster playback compared to early versions or DF Designator. 
 +
 +
====[https://www.mediafire.com/folder/u38qsqr1bq6wu/Community_Quickfort_Blueprints_v2 Quickfort Community Blueprints]====
 +
 +
A large collection of blueprints, published to remove the last hint of hassle in creating a fortress.  You can download the lot without a paid account [http://www.mediafire.com/download/n6im1ok6z02n8nc/Community_Quickfort_Blueprints_v2.zip here].
 +
 +
===[http://www.bay12forums.com/smf/index.php?topic=55025 ChromaFort]===
 +
Chromafort is a tool designed to complement [[Utilities#Quickfort|Quickfort]], by converting images into quickfort-compatible .csv files.  It works with 24-bit bitmap (.bmp) files.  There are a number of known issues that can affect any image that is not square, and the size must be an exponent of two (8, 16, 32, 64...); other images may show nonexistent colours and/or come out highly distorted.
  
Quickfort is an AutoHotkey-based utility for Dwarf Fortress that helps you build fortresses from "blueprint" .CSV files (comma separated values). These files are easily created and edited in an app like Excel. Most building-oriented DF commands are supported through the use of multiple .CSV files to describe the different phases of DF construction (designation, building, stockpiles, and making adjustments. Also see [[Main:Quickfort Community Blueprints|Quickfort Community Blueprints]].
+
===[http://www.bay12forums.com/smf/index.php?topic=138590 Picturefort]===
 +
Picturefort is an attempt to make "Chromafort, but ''better''" - it performs the same function of converting an image to a [[Utilities#Quickfort|Quickfort]]-compatible .csv file.  Unlike Chromafort, Picturefort can handle a large number of image formats (though .bmp or .png are recommended); images can be of any shape and within reason size; and while as of May 2014 it is only available on Windows there are plans for a Linux version.
  
 
== Modding tools ==
 
== Modding tools ==
  
== Raw tile tools ==
+
===[http://www.bay12forums.com/smf/index.php?topic=125997.0 Blast]===
 +
 
 +
A raw compiler and assembler that helps with compatibility. It also has a more minimalistic, lighter (but less hand-holding) fork called [http://www.bay12forums.com/smf/index.php?topic=128013.0 Rubble].
 +
 
 +
=== [http://www.bay12forums.com/smf/index.php?topic=103360 Raw Explorer] ===
 +
Raw files manager.
  
 
== World Map / World Gen Tools ==
 
== World Map / World Gen Tools ==
 
=== [http://dffd.wimbli.com/file.php?id=2354 Perfect World DF] ===
 
=== [http://dffd.wimbli.com/file.php?id=2354 Perfect World DF] ===
requires an additional (tiny) download to be funtional for current versions (34.#): http://dffd.wimbli.com/file.php?id=5491 .  generate worlds to your liking easier or faster than df's ingame map maker.  easy access to world settings too to modify. [http://www.bay12forums.com/smf/index.php?topic=57428.0 forum thread]
+
requires an additional (tiny) download to be functional for current versions (34.#): http://dffd.wimbli.com/file.php?id=5491 .  generate worlds to your liking easier or faster than df's ingame map maker.  easy access to world settings too to modify. [http://www.bay12forums.com/smf/index.php?topic=57428.0 forum thread]
  
=== Dwarf Fortress World Generator ===
+
=== [http://redd.it/yk6o9Dwarf Fortress World Generator] ===
A small bash script for automating world generation of large numbers of worlds on GNU/Linux. [http://pastebin.com/jdVKPzpt pastbin],[http://redd.it/yk6o9 reddit thread]
+
A bash script for automating world generation of large numbers of worlds on GNU/Linux. Available on [http://pastebin.com/jdVKPzpt pastebin].
  
 
=== [http://www.bay12forums.com/smf/index.php?topic=73095 Dwarf Map Maker] ===
 
=== [http://www.bay12forums.com/smf/index.php?topic=73095 Dwarf Map Maker] ===
 
A photoshop action script which turns legends mode exported maps into a much prettier fantasy map.  There is also a version available [http://www.bay12forums.com/smf/index.php?topic=73095.msg2261106#msg2261106 for GIMP].
 
A photoshop action script which turns legends mode exported maps into a much prettier fantasy map.  There is also a version available [http://www.bay12forums.com/smf/index.php?topic=73095.msg2261106#msg2261106 for GIMP].
 +
 +
==Filesharing websites==
 +
 +
=== [http://dffd.wimbli.com/ Dwarf Fortress File Depot] ===
 +
The Dwarf Fortress File Upload Service - an excellent place to store mods, community games, tilesets and other files. Courtesy of [[User:Janus|Janus]]; for files related to Dwarf Fortress only.
 +
 +
=== [http://mkv25.net/dfma/ Dwarf Fortress Map Archive] ===
 +
{{main|Utility:Dwarf Fortress Map Archive}}
 +
 +
The Dwarf Fortress Map Archive is a large collection of user-submitted maps and videos and a nice flash viewer for perusing them. Maps are uploaded, stored, and downloaded in a special compressed format created by the DF Map Compressor; videos are stored in a compressed version of Toady One's own video-recording format.
  
 
== Other/miscellaneous ==
 
== Other/miscellaneous ==
 +
 +
=== [[Utility:Dfterm3|dfterm]]===
 +
 +
[[Utility:Dfterm3|Dfterm3]] is a remote Dwarf Fortress playing software for multiple users through a web interface. DFterm3 enables play through a web interface, and games can also be viewed on modern - or even played if a bluetooth keyboard is attached.  The web interface should work with Chrome or Firefox browsers, and there are known problems using Internet Explorer. 
 +
 +
It is a successor to [[Utility:dfterm2|dfterm2]], which functions similarly using telnet instead of a web browser.
  
 
=== [http://www.mindwerks.net/projects/exita/ Exita] ===
 
=== [http://www.mindwerks.net/projects/exita/ Exita] ===
 
Exita is a python program that takes your DF world map exports and dump them into several different text outputs.
 
Exita is a python program that takes your DF world map exports and dump them into several different text outputs.
  
=== [http://www.bay12forums.com/smf/index.php?topic=103360 Raw Explorer] ===
+
=== [http://www.bay12forums.com/smf/index.php?topic=72702 Legends Viewer] ===
Raw files manager.
+
Legends Viewer loads up the legends you can export in a much more usable format than the legends mode of DF itself. Legends viewer can open pages in new tabs, filter information on a wide range of criteria, and displays information on the map as well. 
  
=== [http://www.bay12forums.com/smf/index.php?topic=72702.0 Legends Viewer] ===
+
It takes four files as input: the legends xml file, the sites and pops text, world history text, and a map image. It can load these separately, but it is recommended to load them as a single compressed archive (folder) - the xml can be multiple GB uncompressed for long histories, and reduce to less than 5% of its size.
Allows browsing legends easily.
 
  
=== Lazy Newb Pack ===
+
If you have played a fortress and then exported legends, you may get an error about unreadable HEX characters.  This is caused by Workflow, which saves it's settings as unreadable historical figures. There are several ways to fix this:
A commonly-used software bundle with a nice launcher. Allows to start playing DF really quickly on a new machine - no need to download and integrate common [[Graphics set repository|tilesets]] and tools like Dwarf Therapist, SoundSense, etc - or even know what you need to get. 
+
* Clear the workflow settings in fortress mode before exporting legends
 +
* Edit the xml by hand, [http://www.bay12forums.com/smf/index.php?topic=72702.msg4629392#msg4629392 as described here] (any platform)
 +
* Use the [http://www.bay12forums.com/smf/index.php?topic=131307 Legends Processing script] (windows only), which fixes the xml and also creates a compressed folder as described above
  
There are multiple versions available, including:
+
===[http://www.bay12forums.com/smf/index.php?topic=130590.0 DFMon]===
*[http://www.bay12forums.com/smf/index.php?topic=59026.0 Traditional Lazy Newb Pack] (windows
+
An announcement monitoring/filtering program, useful to hide some types of job cancellation spam or other more advanced filtering. Note that you can set the game to announce no job cancellations ''without'' any utilities or mods from the {{k|o}}rders menu, with {{k|x}}.
*[http://dffd.wimbli.com/file.php?id=7622 Expanded and Updated Lazy Newb Pack] (windows)
 
*[http://dffd.wimbli.com/file.php?id=7692 Experimental Mac Lazy Newb Pack] (OS X, incomplete alpha release)
 
  
= Tools under development =
+
===[http://www.bay12forums.com/smf/index.php?topic=132153.0 DwarfFamily]===
'''The tools listed below are under development for DF 2012, but cannot perform the task they are intended for at this time.'''
+
A tool that lets you import your legends XML file and converts all dwarf entries to a .GED file, which you can use in Family Tree programs like MyHeritage to display a family tree for the dwarves.
  
 
[[Category:Utilities|*]]
 
[[Category:Utilities|*]]
 
[http://main.tribenine.org/comparison.gif DFMAP](''Title subject to change'') Is a tool currently under development by the Authors [http://facepunch.com/member.php?u=10197 Kabookie](Art Direction) and [http://facepunch.com/member.php?u=185724 Neo Kabuto](Programming) That will take the RAW files of your currently generated map and turn them into beautiful renditions of ancient maps. The project should be completed the first quarter of 2013. For any information contact us at: kaleb@tribenine.org/
 

Latest revision as of 18:51, 15 February 2023

This article is about an older version of DF.

Utilities are third party applications useful for Dwarf Fortress players and modders, and this page serves as a list of them. Dwarf Fortress is a difficult game to play, and any help that can be had in the task is welcome help. This page lists utilities useful for modders and player alike. If you would like to add an article on a specific game utility to the wiki, please do so under the Utility namespace. Not included on this page: tileset repositories and graphics set repositories have been given their own, separate page. Mods have also been listed under their own Modification namespace. To avoid namespace clutter websites are considered utilities and have been included.

A subsection of the Bay12 forums is devoted to such third party programs, and contains development threads for most of them.

The Lazy Newb Pack is an effort to make Dwarf Fortress more accessible for new players by bundling and configuring utilities, graphics and tilesets, and extras such as reference material or more intuitive controls.

Lazy Newb Pack[edit]

A commonly-used software bundle with a nice launcher. Allows to start playing DF really quickly on a new machine - no need to download and integrate tilesets and tools like Dwarf Therapist, SoundSense, etc. - or even know what you need to get. The newer packs also include many third-party fixes for common bugs, which work automatically, and a large number of significant user interface improvements. The launcher makes changing settings or graphics options much easier (press button, instead of editing files) and can even remember to launch selected utilities whenever you open a game of Dwarf Fortress. See the Lazy Newb Pack page for more information, or the forum thread for your platform.

3D Visualizers[edit]

Stonesense[edit]

Stonesense is a third party visualizer, implemented as a DFHack plugin, that lets you view your fortress in a classic isometric perspective. It runs alongside Dwarf Fortress, and can follow the main game's view, updating in real time. It is included in DFHack, and can be opened by typing stonesense or ssense into the console window.

Fortress Overseer[edit]

Fortress Overseer is the only 3D visualizer supporting v0.31. It has been completely rewritten and is currently updated to support v0.34.11 and v0.31.25). Overseer works indirectly, by using DFHack's mapexport to export a file which can then be rendered in 3D. DirectX 9 must be installed, though this requirement is not documented.

Isoworld[edit]

Isoworld is an isometric world map viewer, which can display each of the detailed maps exported from Legends Mode. It also has a pictographic view which makes finding waterfalls easy.

Isoworld can link with DFHack to display a game view at full spatial resolution in wider context, including tracking the game view. This is particularly useful for adventure mode.

Music and Sounds[edit]

SoundSense[edit]

SoundSense is a tool that parses game logs and reacts to game events with sound effects, incidental music and dwarfy comments. You can look it up on the forum thread, or directly download it at the SoundSense homepage.

Game manipulation tools[edit]

DFHack[edit]

DFHack is an advanced Dwarf Fortress memory access library and a set of tools and scripts using this library, providing direct object-oriented access to Dwarf Fortress's internals as if it were compiled into the game itself. Releases support versions up through 0.34.11 (as of June 22nd, 2012). Runs on Windows, Linux, and MacOS X.

DFHack has an official forum thread. Code and binary releases are available from the Github site.

As of June 2014, the current version is r5; however there still may exist some compatiblity issues with plugins and scripts who have not been yet updated to r5 (because of development that has been halted for instance).

Falconne's UI plugins work through DFHack, as do automation tools such as Autolabor, Workflow, Autobutcher, and many others.

DFHack User Interface Plugins[edit]

Falconne's Plugins[edit]

A collection of DFHack plugins that improve the in-game interface with features such as:

  • Search function in screens with big lists.
  • Ability to place furniture before it's built and have it automatically allocated when available.
  • Ability to place constructions with box select (like laying designations), including easier material selection and open space placement (without having to wait till adjacent constructions are built).
  • Easier pasturing, live happiness monitor, mouse support, stocks dashboard.
Autobutcher GUI[edit]

DFHack Bugfixing Plugins[edit]

Binary patches[edit]

Binary patches are utilities made by users to fix known bugs that haven't been addressed by the development team yet.

  • This executable contains many bugfixes, including the long-standing armory bug that prevent racks and armor stands from ever being used.

Feature plugins[edit]

These plugins add features to the game.

  • Digging invaders, a plugin that allows hostiles to dig and deconstruct walls to path to one's fortress.
  • Rendermax, a plugin that implements a lighting system at the graphics level.
  • Dwarven Emigration, a plugin that allows unhappy dwarves to emigrate with their families.

Interaction plugins[edit]

DFHack scripts designed for use in interactions as "spells"

Miscellaneous plugins[edit]

DFHack script collection

Dwarf Therapist[edit]

Dwarf Therapist[edit]

Dwarf Therapist gives you an advanced GUI to manage and check dwarf job allocations, military assignments, statistics (such as attributes, personality traits and happiness), sort dwarves by various criteria (e.g. profession, migration wave, happiness, number of assigned jobs etc.) and generally manage the Dwarven Resources of your fortress in a very convenient way. This version contains the "labor optimizer" semi-automatic labor management system.

Splinterz' fork of Dwarf Therapist is the currently updated version, and available for Windows, Mac and GNU + Linux. Besides the Bay12 forum thread, there's more information on the GitHub project page.

Dwarf Therapist Addons Repository[edit]

A collection of customizations for Dwarf Therapist submitted by the community.

Addons include:

  • custom professions
  • custom roles
  • optimization plans
  • filter scripts
  • new grid views

Fortress layout tools[edit]

DF Designator[edit]

DF Designator helps you build fortresses from either image files or Quickfort .CSV files. It also has a user interface that allows you to assign hotkeys to blueprints and to combine blueprints in multi z-level designs. Windows, Mac and Linux versions are available. DF Designator uses 'typewriter style' playback, and is thus very slow for large projects.

Quickfort[edit]

https://github.com/joelpt/quickfort

Quickfort is a utility for Dwarf Fortress that helps you build fortresses from "blueprint" .CSV files (comma separated values). These files are easily created and edited in an app like Excel. Most building-oriented DF commands are supported through the use of multiple .CSV files to describe the different phases of DF construction (designation, building, stockpiles, and making adjustments. Recent versions of Quickfort work by converting the blueprint into a native macro for Dwarf Fortress, then executing the macro. This allows for enormously faster playback compared to early versions or DF Designator.

Quickfort Community Blueprints[edit]

A large collection of blueprints, published to remove the last hint of hassle in creating a fortress. You can download the lot without a paid account here.

ChromaFort[edit]

Chromafort is a tool designed to complement Quickfort, by converting images into quickfort-compatible .csv files. It works with 24-bit bitmap (.bmp) files. There are a number of known issues that can affect any image that is not square, and the size must be an exponent of two (8, 16, 32, 64...); other images may show nonexistent colours and/or come out highly distorted.

Picturefort[edit]

Picturefort is an attempt to make "Chromafort, but better" - it performs the same function of converting an image to a Quickfort-compatible .csv file. Unlike Chromafort, Picturefort can handle a large number of image formats (though .bmp or .png are recommended); images can be of any shape and within reason size; and while as of May 2014 it is only available on Windows there are plans for a Linux version.

Modding tools[edit]

Blast[edit]

A raw compiler and assembler that helps with compatibility. It also has a more minimalistic, lighter (but less hand-holding) fork called Rubble.

Raw Explorer[edit]

Raw files manager.

World Map / World Gen Tools[edit]

Perfect World DF[edit]

requires an additional (tiny) download to be functional for current versions (34.#): http://dffd.wimbli.com/file.php?id=5491 . generate worlds to your liking easier or faster than df's ingame map maker. easy access to world settings too to modify. forum thread

Fortress World Generator[edit]

A bash script for automating world generation of large numbers of worlds on GNU/Linux. Available on pastebin.

Dwarf Map Maker[edit]

A photoshop action script which turns legends mode exported maps into a much prettier fantasy map. There is also a version available for GIMP.

Filesharing websites[edit]

Dwarf Fortress File Depot[edit]

The Dwarf Fortress File Upload Service - an excellent place to store mods, community games, tilesets and other files. Courtesy of Janus; for files related to Dwarf Fortress only.

Dwarf Fortress Map Archive[edit]

The Dwarf Fortress Map Archive is a large collection of user-submitted maps and videos and a nice flash viewer for perusing them. Maps are uploaded, stored, and downloaded in a special compressed format created by the DF Map Compressor; videos are stored in a compressed version of Toady One's own video-recording format.

Other/miscellaneous[edit]

dfterm[edit]

Dfterm3 is a remote Dwarf Fortress playing software for multiple users through a web interface. DFterm3 enables play through a web interface, and games can also be viewed on modern - or even played if a bluetooth keyboard is attached. The web interface should work with Chrome or Firefox browsers, and there are known problems using Internet Explorer.

It is a successor to dfterm2, which functions similarly using telnet instead of a web browser.

Exita[edit]

Exita is a python program that takes your DF world map exports and dump them into several different text outputs.

Legends Viewer[edit]

Legends Viewer loads up the legends you can export in a much more usable format than the legends mode of DF itself. Legends viewer can open pages in new tabs, filter information on a wide range of criteria, and displays information on the map as well.

It takes four files as input: the legends xml file, the sites and pops text, world history text, and a map image. It can load these separately, but it is recommended to load them as a single compressed archive (folder) - the xml can be multiple GB uncompressed for long histories, and reduce to less than 5% of its size.

If you have played a fortress and then exported legends, you may get an error about unreadable HEX characters. This is caused by Workflow, which saves it's settings as unreadable historical figures. There are several ways to fix this:

  • Clear the workflow settings in fortress mode before exporting legends
  • Edit the xml by hand, as described here (any platform)
  • Use the Legends Processing script (windows only), which fixes the xml and also creates a compressed folder as described above

DFMon[edit]

An announcement monitoring/filtering program, useful to hide some types of job cancellation spam or other more advanced filtering. Note that you can set the game to announce no job cancellations without any utilities or mods from the orders menu, with x.

DwarfFamily[edit]

A tool that lets you import your legends XML file and converts all dwarf entries to a .GED file, which you can use in Family Tree programs like MyHeritage to display a family tree for the dwarves.