Editing v0.34:Utilities

{{Quality|Masterwork|13:28, 28 September 2013 (UTC)}}
{{av}}

'''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, though they really aren't, and have been included.

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.

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.  

== [[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://www.bay12forums.com/smf/index.php?topic=126076 PeridexisErrant Lazy Newb Pack] (windows)
*[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 ==

=== [[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://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.

=== [http://www.bay12forums.com/smf/index.php?topic=70700.0 Isoworld] ===
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 [[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.

== Music and Sounds ==

=== [[Utility:SoundSense|SoundSense]] ===

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].

== Game manipulation tools ==

===[[Utility:DFHack|DFHack]]===

[[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].

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 ====

===== [http://www.bay12forums.com/smf/index.php?topic=119575.0 Falconne's Plugins] =====
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.

===== [http://www.bay12forums.com/smf/index.php?topic=124708 Autobutcher GUI] =====

==== 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]

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

*[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.

==== 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.

==== Interaction plugins ====
[http://www.bay12forums.com/smf/index.php?topic=135597.0 DFHack scripts designed for use in interactions as "spells"]

==== Miscellaneous plugins ====
[http://www.bay12forums.com/smf/index.php?topic=135506.0 DFHack script collection]

==Dwarf Therapist==

===[http://www.bay12forums.com/smf/index.php?topic=122968 Dwarf Therapist]===

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 [https://github.com/splintermind/Dwarf-Therapist GitHub project page].

====[[Dwarf Therapist Addons Repository]]====

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 ==
=== [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 uses 'typewriter style' playback, and is thus very slow for large projects.  

=== [http://www.joelpt.net/quickfort/ 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.

===[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 ==

===[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 ==
=== [http://dffd.wimbli.com/file.php?id=2354 Perfect World DF] ===
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]

=== [http://redd.it/yk6o9Dwarf Fortress World Generator] ===
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] ===
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 ==

=== [[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] ===
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=72702 Legends Viewer] ===
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, [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

===[http://www.bay12forums.com/smf/index.php?topic=130590.0 DFMon]===
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://www.bay12forums.com/smf/index.php?topic=132153.0 DwarfFamily]===
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 dwarfs.