Utility:Dwarf Companion

This is a preliminary screenshot of the prototype.

What?

This project is about having a helper utility for dwarf fortress, hopefully filling gaps in the user interface. It will also allow some cool cheating, so that it would be possible to play with the engine. For example, you can now mark your nobles as butcherable! Ain't that cool?

For now, a PROTOTYPE utility is available, for testings. It uses python and requires many dependencies. It will end up as a standard .exe tool once features are ironed out.

It supports versions 33d, 33f, 33g, 38* and hopefully 39*. The latest screenshot is at this place.

Important warning

When fiddling with DF memory, you might get crashes. Here are two important advices:

• when writing into memory (like updating a creature's data), pause the game, load the data, update it, save it and then unpause the game
• do not teleport creatures that are hauling

How

You need to install several things first.

• Python (works with any version, 2.5 is prefered)
• from this page, the latest "Gtk+/Win32 Runtime Environment Installer"

• For python 2.5 users, just grab the utility at this place, and unzip it (warning, this is an old version).
• For users of the -any versions, or python 2.4 users, you must:
  • Install the three modules from this page (PyCairo, PyGObject, PyGTK)
  • Grab the software at this place.

• Double click on "dfcompanion_prototype.py"!

An installer that contains all needed modules can be found here: http://aruiz.typepad.com/siliconisland/2006/12/allinone_win32_.html

Problems?

Please run the tool from the command line if you experience problems, and copy/paste errors in the discussion page.

The unit list often gets desynchronised (multiple dwarves appearing). To solve this, just press "refresh".

Usage - what can you do?

First run Dwarf Fortress, and load your game. It won't work otherwise.

The general idea is to have the main window open next to your DF windows. It should help you play the game by providing useful hints while playing. Order dwarves using the column "alerts" so that most important stuff is on top : hungry, unhappy, moody, hurt dwarves. You can play with creatures and view detailled views of their attributes by double clicking them. Right now, you can interact by:

• clicking "heal", heals creature
• clicking "hurt", hurts creature
• clicking "apply", saves the following changes:
  • position X,Y,Z
  • strength, agility, toughness
  • all flags (the checkbox stuff), most being unknown, please let us know about their use if you get it!
  • pain, exhaustion, hunger, thirst, drowsiness
  • race (still needs to be tested!)
  • mood type (fey, macabre, ...), and mood skill increased

Interesting effects are butcherable dwarves and Corbine's crazy dogs. Oh, and skeletal legendary miners that turn against your fortress.

dwarfdbg scripts

Here is a collection of scripts that wouldn't fit in DC but might be useful. Copy them in the DC folder and run them.

• butchercats.py : marks all "unintersted" cats and kitten as ready for slaughter.
• Soon, the "designator", with a list of cool stuff : User:Bartavelle/DesignatorTiles

Changelog

• utils.zip : initial test, some bugs with accents
• utils.0.1.zip : corrected problem with bad characters
• utils.0.2.zip : corrected problem with long strings
• utils.0.3.zip : corrected problem with creatures not in legends
• utils.0.4.zip : quick (untested) upgrade to v0.27.169.33g
• companion.0.5-any.zip - 07/01/2008
  • Skill edition
  • Removed the dependency on pydbg, should now work with python 2.x
  • Incomplete linux support, for those people who go on holiday with only their linux laptops ...
  • More details in the flags names
  • Disabled the regular refreshes for now
  • Body part name is resolved when showing damages
  • Right-click popup with quick features : heal, hurt, tame, make war animal, rest and restore
  • Civilization altering (steal that merchant swordsman!)
• companion.0.6-any.zip - 22/01/2008
  • Better error handling for Window users, should help debugging ...
  • Firstname and nickname editor (finally)
  • Money warnings, and money cheat
  • Combat reports in DF mode
  • Bleeding/Paralysis/ ... can be tweaked
  • "Opinion poll"
  • More details
  • Instamood!
• companion.0.7-any.zip - 07/02/2008
  • Couples list
  • Name editor
  • Right click / zoom now works
  • Support for 38a
• companion.0.8-any.zip - 13/02/2008
  • Removal of the couple list, should hopefully fix bugs
  • Several scripts for more fun
  • Better support for stuff
  • Should be "final" of the prototype, next step will probably involve working on a standalone .exe, and the occasionnal fun script
• companion.0.9-any.zip - 18/02/2008
  • Quick update to fix for the new DF version.
• companion.0.9-any.zip - 26/02/2008
  • Another quick fix for 38b
• companion.0.12-any.zip - 18/07/2008
  • tons of changes, this specific version just keeps up with DF

thanks

• the memory hackers!
• Phil, for the clever python tricks
• Corbine, for early testings, bug discovery, and flags discovery
• sinoth, for early testings, bug discovery