v0.34:Macros and keymaps

v50.14 · v0.47 · v0.34.11 · v0.31 · v0.28 · v0.23

This article is about an older version of DF.

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

Playing Dwarf Fortress means lots of typing. The game has an internal macro/keymap system. Using it or any external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

DF macros

Creating macros

The controls for creating macros within DF are as follows:

Ctrl+r = record
Ctrl+p = play
Ctrl+s = save
Ctrl+l = load

To create a macro press Ctrl+r to begin recording your actions. When you have recorded all the action you want stop recording by hitting Ctrl+r again and save (Ctrl+s) the macro. The macro is then added to your macro list. To load a macro from the list just press Ctrl+l. You can then play the macro using Ctrl+p.

There is a directory data/init/macros for them. The macros are saved in .mak format. Even a recorded file for a simple macro - for example to create a 3 tiles wide ramp - may already consist of up to 50 commands listed. This is because every possible binding of the key pressed is included in the macro and put in a block (and r for ramp has many by default).

pressing_enter_recorded
		SELECT
		CLOSE_MEGA_ANNOUNCEMENT
		WORLD_PARAM_ENTER_VALUE
		SETUPGAME_SAVE_PROFILE_GO
		D_BURROWS_DEFINE
		D_MILITARY_ALERTS_SET
	End of group
		CUSTOM_CTRL_R
	End of group
End of macro

For this example the recording was started, enter was pressed and the recording was stopped. When using this macro every underlying command in the file will be called, if possible. If you are in the designation menu, it will react as a select, the other commands will be ignored. If you are in the burrow menu, it will work like pressing enter there. The macro alway ends with a block containing the end of it's recording. But executing macros seems to ignore this command. If you have changed your key bindings you'll get another result, because the underlying commands are recorded, not the keys pressed.
When creating or editing your own macros it is a good idea to use only those commands you really want.

ramping_created
		DESIGNATE_RAMP
	End of group
		CURSOR_DOWN_Z
	End of group
		SELECT
	End of group
		CURSOR_RIGHT
	End of group
		CURSOR_RIGHT
	End of group
		SELECT
	End of group
		CURSOR_LEFT
	End of group
		CURSOR_LEFT
	End of group
		CURSOR_UP
	End of group
End of macro

This selfmade example will designate a 3 tiles wide ramp one z-level below and place the cursor to make the next execution of the macro continue the way down. The first line has to be the name of the file. You can see that there are grouping tags for every single keypress. These are important for a working macro.
It is unknown if there is the possibility of creationg loops/iterations, other programming features or comments.
There seem to be problems with changing removing and adding macros while the game is running. Save, quit and restart the game when you want to change something.

Tuning macros

The fewer commands a macro consists of, the faster it runs. This means you should avoid unnecessary steps by optimizing the "path" of your designations.

The second and most effective way to increase speed is to remove all unnecessary commands DF recorded with an external texteditor. The extra commands are ignored by the game but they still take time to be processed. To move a cursor 3 (up/down) or 4 (right/left) commands are recorded, most other keys are bound to more commands. Pressing d for example records more than 30 commands. Depending on what you do, you can increase the speed by 4 or more by reducing the number of commands in every group to the one you need. If you edit a macro, you'll have to restart DF afterwards.

The third way is to change settings in the init-files. In the base init file (data/init/init.txt) you will find the follow lines:

If you set KEY_REPEAT_ACCEL_LIMIT above one, then after KEY_REPEAT_ACCEL_START repetitions 
the repetition delay will smoothly decrease until repetition is this number of times faster 
than at the start.

[KEY_REPEAT_ACCEL_LIMIT:8]
[KEY_REPEAT_ACCEL_START:10]

This controls the number of milliseconds between macro instructions.

[MACRO_MS:15]

This means that the speed between macro commands will gradually increase until it hits the limit. The secondary command is when the gradual increase in speed increases.

External utilities

QuickFort

A spreadsheet-driven construction tool for Dwarf Fortress. Converts CSV files containing a "graphical" (or at least two-dimensional) representation of what you want to build into efficient DF macros. Comes with a number of scripts to get you started, some of them quite complex.

AutoHotKey

Go to Utilities#AutoHotKey and download AutoHotKey. Installation is simple and the program uses few system resources.
Write macro scripts (file type .ahk), which may contain any number of commands. You activate scripts by double-clicking .ahk files and deactivate them by right-clicking the AutoHotKey icon on the task bar. Both of these can be done at any time - even right in the middle of a game. AutoHotKey also allows for automated activation of scripts.

Fluxbox + xvkbd

For linux, it's a quite cool solution. It's possible to create macros with outside tools, like fluxbox (linux window manager) + xvkbd (linux virtual keyboard for kiosks, with some macro capabilities). See the documentation here.

Pros

**Faster executations
**Easier script writing
**Portable code

Cons

**Sometime needs timing
**Need xvkbd (Linux at least)
**Need some special key reservation

Please see also the 40d macros page, as much of what is there works perfectly fine. If you can verify it works, please move it to this page.

Some macros

Large bedroom's bed placing

Ok, so you can record some macro, to build a large repeating bedroom. So you setup the build menu (select the bed, and go the position you want to place). Just start a new macro, and place a bed, select the first bed from the list, and move about 3-4 tiles right. Repeat this until you reach the limit, or you are satisfied. Turn off macro recording (don't exit the build menu). You can save your macro (not necessary). Go to 3-4 tile under the place, you first placed a bed (most left of the bed row). Make sure, the bed are selected from the build menu, and you are selecting position to build it. Press the play macro (Ctrl + p), and you have just another row. Repeat, until you have enough bedrooms, or out of beds.

Large bedroom's placing cabinets

You can reuse the above macro, for placing cabinets / coffers / bags / tables / chairs. Select the cabinet from build menu, and go above the first bed position, and press the play macro (Ctrl + p), and fill your bedrooms with cabinets.

Large bedroom's placing coffers

If you want to place coffers, but not bags, it's a bit trickier, but you will see how can done. Pause the game (will save you from a lot of spam from the dworfs). Go to stock, inventory, and bags and bins. Forbid all bags, regardless, what's in it /used for (this is temporary). Exit, to main screen. Build, coffers and bags, and go to where you wish to place the first coffer (maybe left of first bed). Press the play macro (Ctrl + p). Because all the items disabled what we don't want to build from that build category, only coffers will be build. Repeat until bedroom is filled with coffers / you're out of coffers. Don't forget to unforbid all the bags, so the dwarfs can carry on, as nothing has happened. You can unpause the game, and watch, as your working dwarfs hauls the big bedroom together. You can invert the forbidding to place only bags.

Large bedroom's resizing all beds

If the bedroom is finished (at least all the beds are hauled to place), you may want to create a new macro, to create the exact bedrooms. Use the info of a building (q), and select the first bed. Start a new macro (Ctrl + s), and press r and the + for a few times (resize the bedroom). If you are fine with the size of the bedroom, you can press enter, and go on for the next bed, and repeat this for the whole row. Remember, because this will be a macro, and if you want bedrooms that fill all the room, you may have to press + a bit more or less for the edge beds. If you finished the first row, stop the recording (Ctrl +r), and you can save this macro too. Repeat this for the rest of the rows.

Mass selector

With this macro, you can select a lot of things at once. Most helpful, if you want to sell a lot of junk to the caravans. So, basically, you just record: enter down in a row about 10-25 times. (can make an alternate with enter +.) So, the caravan arrives, your dwarfs haul all the bins for selling. At trade menu, you select for trade all the stuff, the trader have, and you would like to buy. go to your items, and load the macro, and play it as many times, as you want. Because if a bin is selected it will be sold with all the items inside. But if after any of the content is selected, the bin will not be sold. After you selected all the stuff for selling, it's a good idea to just brows what you exactly selling, just for sure (not to sell any wood to elfs).

Mass trap builder

It's basically just the same as the bed building, only with 1 tile moving. (It will build a bunch of traps next to each other).

Troubleshooting Scripts

Users may experience some issues in getting scripts to work, particularly when using looping scripts when experiencing low frame-rates.

If experiencing low frame-rates, try adding delays ("Sleep 100" to pause for 100 milliseconds for example) within loops to allow the interface to keep up. If there are nested loops, sometimes adding a pause at the end of an inner loop is all that is needed to flush the keyboard buffer
Another way to add delay during and after each simulated key press is to put SetKeyDelay, 40, 40 at the start of the macro.
Make sure that Dwarf Fortress maintains focus. IM windows are the enemy! Who needs friends anyhow? You've got Dwarf Fortress.
This may go without saying, but most macros assume standard key-mappings. If you're using non-standard ones, you may have to edit the macro to get it to work.
Visiting liaisons can bring up screens that eat keystrokes, throwing a long-looping script out-of-phase with where it expects the game to be. Wait for the farewell screen before running a long script.
The SendPlay function supports keys that the Send function does not, for example Shift-Enter. According to the AutoHotKey documentation, SendPlay may also be better at preventing dropped keystrokes.

General Fortress Mode Hotkeys Script

An attempt at speeding up various designations. Includes an up/down stair builder, a fast move up/down, and some select-and-advance keys. Please see user:DDR#Dwarf_Fortress_General_AHK_Script.