v0.31:Macros and keymaps

2010-07-30T03:31:38Z

Prios: /* AutoHotKey */ Created link to 40d macros page

{{av}}
{{Quality|Fine}}
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 ==
The current version has the ability to create macros. The controls for doing so are as follows:

*{{k|Ctrl}}+{{k|r}} = record
*{{k|Ctrl}}+{{k|p}} = play
*{{k|Ctrl}}+{{k|s}} = save
*{{k|Ctrl}}+{{k|l}} = load

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

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

== External utilities ==

=== AutoHotKey ===
# Go to {{L|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.

:'''Please see also the [[40d:Macros and Keymaps|40d macros page]], as much of what is there works perfectly fine. If you can verify it works, please move it to this page.'''

==== 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 {{key|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]].

Dwarf Fortress Wiki - User contributions [en]

v0.31:Macros and keymaps