v0.31:Utilities

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼

Please only list utilities that are known to work with the newest version here.

Here are third party applications useful for Dwarf Fortress.

Dwarf Fortress File Depot

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.

3D Visualizers

Stonesense

Stonesense Screenshot

by Jonask, Solifuge, Kaypy and Japa

Stonesense is a third party real-time visualizer that lets you view your Dwarf Fortress world in a classic isometric perspective.

More information is available in this forum thread.

Stonesense Slate now supports v0.31.04 - get it here

Obsidian

by Skeggox

Please note this tool is not complete and cannot render dwarf fortress. It is in development.

Obsidian is a toolset for converting DF maps into a renderable scene, manipulating the result, and displaying it directly in 3D or exporting to 3rd party renderers and raytracers.

Its a modular Lua framework, using Open Scene Graph for rendering and DFHack for talking with Dwarf Fortress.

This forum thread has more detail.

Reveal

Reveal (or Reveal.exe as it is commonly referred to) is a program that runs alongside Dwarf Fortress and shows all "unexplored" or "undug" tiles of the map (in fortress mode). To reveal entire map designate the entire bottom level to be mined and then remove designation before running reveal (Not required in the latest version using the parameters below, simply start the .exe file.). Playing on revealed map might (read "will") cause some bugs (like not being able to build magma buildings or a tower-cap farm, losing all plants/trees on the map, and a lot more). Using Reveal has been known to corrupt saved game folders. and, as such, it is highly recommended to only use Reveal to preview a biome's layout and then restart without running Reveal.

There are two versions of Reveal, one for Vista and newer, one for XP and older.

The new version of Reveal.exe (Reveal2) is in public beta, you can find it here Reveal2. Please report problems in 0x517A5D's Talk page.

Pasting the following code into reveal2.ini makes it work for the newest (DF2010) version of Dwarf Fortress:

;; DF2010 31.02
[4BBDF378]
map_data=0x016ad718
map_x_count=0x016ad738
map_y_count=0x016ad73c
map_z_count=0x016ad740

[4BB45F99] can be substituted in for 31.01.

For 31.04, the following works:

; .31.04
[4BF014FA]
dwarf_fortress=0x00A551C0
map_data=0x016BAAC4
map_x_count=0x016BAAE4
map_y_count=0x016BAAE8
map_z_count=0x016BAAEC
map_data_designation_offset=0x29C

However, do not save your game, it can mess up many things including civilizations (Giant Toad and Cave Crocodile civilizations, you will also embark with those if it should occur.)

Dwarf Therapist

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 etc.) and generally manage the Dwarven Resources of your fortress in a very convenient way.

Version 5.2 is out (5/18/10). This version supports DF build 3.01.04.

New dedicated support forum: http://code.google.com/p/dwarftherapist/

Version 5.2 does currently contain some known issues.

==================================================================

KNOWN ISSUES

==================================================================

* - Setting Mining and Woodcutting -
  Setting these labors rely on the dwarf already having the proper equipment
  (pick or axe). These labors should be manually set in game for now.

* - Migration Waves Incorrect -
  The group-by "Migration Wave" is based on some shady guesswork
  based on dwarf ids. It is in no way 100% accurate, but can sometimes amaze 
  me that it works :)
  
* - Dwarf and Squad Names -
  This is brute force word-list searching. Verb conjugation, plurality and 
  case are a crapshoot. But it's generally pretty close.

Dfterm

Dfterm is a tool to run dwarf fortress via terminals remotely. multiple people can connect and watch or join in.

Main article here: Dfterm.

DFHack

DFHack is a Dwarf Fortress memory access library and a set of basic tools using this library. The library is a work in progress, so things might change as more tools are written for it. The current (0.3.1.4) release only supports the new DF 0.31.01, 0.31.02 and 0.31.03 versions. It consists of some of the more useful DFHack tools.

Code and binary releases are available from the Github site.

DFhack tools for DF 2010

dfcleanmap

Cleans all the bloodsmears that get scattered all over the map.

dfliquids

Allows creating liquids (water and magma), making them flow or preventing them from flowing. Newly also allows making obsidian walls. It's a command-prompt style utility where you type in very simple commands. Replaces the older magma_create tool.

dfprospector

Lists all available minerals on the map and how much of them there is.

dfreveal

Reveals the whole map. Newly can also hide what it revealed. Use with caution, releases HFS! Same warnings as to the original Reveal tool apply.

dfvdig

Designates a whole vein for digging. When using the '-x' option, it will dig stairs into other z-levels. Point the cursor at a vein and run this thing :)

DF Map Compressor / DF Map Archive

• SL's DF Map Compressor - Website
• Dwarf Fortress Map Archive

The DF Map Compressor encodes multiple bitmaps exported from Dwarf Fortress into a single, very compressed, .fdf-map file. The fdf-map file can then be shared with your friends by uploading to the DF Map Archive that features an online viewer (written in Flash).

The map compressor was created by Shadowlord in May 2007. Extract from the website :

"The DF Map Compressor is a program I made to encode Dwarf Fortress fortress or world map images into a much smaller format than is possible with normal image formats. Here's a quick summary of how it works: It determines the size of your tiles from your DF font file (or asks you), splits the map up into tiles, identifies duplicate tiles, writes out every unique tile image, and then writes out a list of ID#s for each tile position which points to the tile image for that tile. What it outputs is piped through the LZMA compressor (the one used in 7-zip), to compress it further. The .df-map file which it writes out is usually less than 100 KB in size. (By comparison, a PNG of the same map can exceed 2 megabytes, depending on how well you compress it, whether you change the color depth, and whether you are using a graphical tileset or detailed font)."

Read more about the DF Map Archive on Markavian's User page.

DF Designer

DF Designer, by soundnfury is a fort layout planning tool. It enables you to work out your designs before you start to build, and even see how they look in 3-D. It's written in C with SDL, and both Linux and Windows builds are available. The source code is freely available under the GPL. Since DF Designer does not 'talk to' Dwarf Fortress, it is version-independent.

Modding tools

Custom Workshop Workshop

WYSIWYG editor for designing the raws for a custom workshop. (Not all raws, just the tiles and colors) Lets you see how it will look at each stage of construction. Comes with the default 16x16 CURSES font built in, but you can load any .BMP formatted DF font you like, keeping in mind that if its bigger than 16x16 it won't fit.

Accommodates up to 32x32 workshops, not that there's any reason for such a large workshop, right?

Raw tile tools

Raw tile selector

Provides an easy to use graphical interface to select which tiles and colors should be displayed for plants, stones and small creatures.

Made to ease the job of creators of tilesets with edited raws. It will also be useful for users that dislike decisions made by tileset creators or users that could not find the edited raws for a tileset.

Currently for windows only.

Raw tile merger

Provides an easy to use interface to change the tile and color data of raws to match the data of another set of raw files.

Made to ease the job of creators of tilesets with edited raws when new versions of df are released. The edited raws for your tileset for a new df version can now be created with a few clicks.

WinMerge

Winmerge allows you to compare the contents of folders or files. It highlights any differences between files and allows you to merge them. It is most useful for modders or users of mods. If you compare modified raw files with unmodified ones you can quickly see any differences.

World Map / World Gen Tools

PerfectWorldDF

Very detailed Windows program to help create customize world gens.
Bay 12 forum link
Dwarf Fortress File Depot link (may be old version)
Dwarf Fortress File Depot listing for the author