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.31:Utilities"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (Link)
Line 74: Line 74:
 
Dfterm2 is a tool to run Dwarf Fortress via terminals remotely. Multiple people can connect and watch or join in.
 
Dfterm2 is a tool to run Dwarf Fortress via terminals remotely. Multiple people can connect and watch or join in.
  
Main article here: [[Dfterm2]].
+
Main article here: [[Utility:Dfterm2]].
  
 
== Game manipulation tools ==
 
== Game manipulation tools ==
Line 205: Line 205:
 
== Raw tile tools ==
 
== Raw tile tools ==
  
=== [[Raw tile selector]] ===
+
=== [[Utility: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.
 
Provides an easy to use graphical interface to select which tiles and colors should be displayed for plants, stones and small creatures.

Revision as of 19:56, 4 January 2011

This article is about an older version of DF.
Please only list utilities that are known to work with the newest version here.
You may also be like to see the Tileset repository or Graphics set repository.

Here are third party applications useful for Dwarf Fortress players and modders.

Dwarf Fortress filesharing services

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.

DF Map Archive

The Dwarf Fortress Map Archive is a large collection of user-submitted maps 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 (see below).

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

DF Map Compressor

The DF Map Compressor encodes multiple bitmaps exported from Dwarf Fortress into a single, very compressed, .fdf-map file, and functions as a viewer for this format. It can also export the maps to PNG format.

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. The web site is currently not accessible. 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)."

There is a little bit of information at the DF File Depot page, where the compressor can be downloaded:

"It requires either .NET 2.0 or newer (If you have Windows Vista, you already have this, if not, you might need to get it), or if you're on Linux or a Mac or other non-Windows OS, requires Mono.

To get it working on OSX, according to this forum post:

1. download the Mono Framework and install it. If you're on a modern Mac, you want the latest Intel version, which requires OSX 10.5 or 10.6. Older versions are available but no longer supported.
2. export your map from Dwarf Fortress (Esc -> Export Local Image)
3. download the DF Map Compressor from the DF File Depot.
4. open the terminal, navigate to the DF Map Compressor folder and type:
mono DwarfFortressMapCompressor.3.3.4.exe
5. WAIT a bit for the DF Map Compressor windows to appear (I almost thought it had crashed, it's rather slow)
6. follow the on screen instructions

3D Visualizers

Stonesense (outdated! works with v0.31.16)

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 is now in version 2.2 Slate, supports v0.31.16 - Download

Fortress Overseer

by thewonderidiot and sexymustard

Overseer is a full 3D visualizer for DF2010 using the DFHack library. Its appearance is highly customizable and will be even more so in the near future. Check out its forum thread for more details or download it from here.

Interface tools

Dfterm2

Dfterm2 is a tool to run Dwarf Fortress via terminals remotely. Multiple people can connect and watch or join in.

Main article here: Utility:Dfterm2.

Game manipulation tools

Reveal

The standalone Reveal utility is obsolete due to missing source code. DFHack's dfreveal module works like Reveal did, and has built-in undo capability.

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.

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

Version 0.6.7 is out (November 30, 2010). This version supports DF builds up to 0.31.18.

NOTE: This project is currently seeking a new maintainer.

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

Read the full changelog here: http://code.google.com/p/dwarftherapist/source/browse/CHANGELOG.txt


Instruction for making it work with new versions here: http://code.google.com/p/dwarftherapist/wiki/MappingNewVersions This page also tends to have the new addresses within an hour or two of new releases of Dwarf Fortress.

Runesmith

Runesmith is a Dwarf information viewing and editing tool inspired by the original Dwarf Companion. It uses the DFHack library to interface with Dwarf Fortress and Qt to provide a robust and professional looking cross-platform GUI. http://www.bay12forums.com/smf/index.php?topic=59056.0

Version 0.1.7 is out for Windows, currently supporting 0.31.16. Since it uses DFHack, all versions of DF that DFHack supports, Runesmith supports!

   * Windows: http://dffd.wimbli.com/file.php?id=2538
   * Linux: to follow (the windows one is reported to work fine under wine though)

"A tool that allows smithing (editing) of the digits and runes (letters) that control all life in DF. By smithing these runes, the metagods (players) can meddle with DF mortals to suit their games, be it recasting a soul into a new species body, blessing and cursing indiviudals or just to make predictions of when a mortal will attain the next degree of competence to guide them on how they should spend their limited time." - Psieye - (http://www.bay12forums.com/smf/index.php?topic=57003.msg1324765#msg1324765)

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. Releases support versions up through 0.31.18 (as of Dec, 2010).

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.

Use like this:

game: place 'k' cursor on the tile or on the upper left corner of the area to manipulate.

tool: enter 'range' in the tool and specify width and height of the rectangle.


- remove water

'w' '0' 's-' <ENTER>

- create obsidian wall (only works for a single tile, even if a range is specified)

'o' '1' 's.' <ENTER>

note that previously existing water or magma still stays at this spot.

- create magma

'm' '7' 's+' <ENTER>

dfprospector

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

dfreveal

Pauses the game and reveals the whole map, then unreveals it afterwards (unless you press Ctrl+C). 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 :)

Dwarf Foreman

Dwarf Foreman is a third party program to automatically dispatch jobs to your workers.

Dwarf Script

Dwarf Script is a program and allows you to manipulate DF's memory using a script.


Fortress layout tools

Quickfort

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.

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. Supports exporting to Quickfort-compatible CSV files.

ChromaFort

Chromafort allows you to convert 24-bit bitmap (.bmp) images into Quickfort-compatible CSV files.

DF Architect

DF Architect is a short cut to using Chromafort in conjunction with DF Designer. It uses 24-bit bitmap files and directly designates them into Dwarf Fortress. It is an early release program and currently only supports digging, stairs (up, down, and both), and ramps. Its defining feature is the use of an 'index' which allows for the designer to visually connect the cursor to the image. Be careful when using this program as it had no abort or terminating ability while designating, nor will it check to see if you've uploaded correct formats.

Quickfort Mapping Tool

Quickfort Mapping Tool is a simple to use web app for creating Quickfort blueprints graphically.

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?

Uristmod

A program which uses text files to automatically change/update raw files. Makes installation of mods easier. However at this time, the documentation is a little confusing and makes creating mods harder for beginners. Forum Thread

Accent replacement tool

A small application to remove accented characters from a file. A quick solution if you need the language files for a tileset that has images in place of special characters. Alternatively, you can use this 20-line perl script: http://github.com/rofl0r/df-mayday/blob/master/charfix.pl

Raw tile tools

Utility: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.

Download

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.

Download

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


Other/miscellaneous

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.


Tools under development

The tools listed below are under development for DF 2010, but cannot perform the task they are intended for at this time.


Obsidian

by Skeggox


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.