Dwarf Fortress Wiki - User contributions [en]

40d:Macros and keymaps

2008-02-14T11:19:10Z

Dukederek: /* Dumping */

Playing Dwarf Fortress means lots of typing. Although the game (as of version v0.27.169.33) has no internal macro/keymap system, using an external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

# 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.

== AutoHotKey Examples ==

===Dumping===
Taken from an old version of [[User:Jackard|Jackard's user page]].

To use, first have your bookeeper do enough desk work so you can view individual items in the stocks listing. Then bring it up and press del to quickly mark stuff. To adjust the key repeat rate, edit the KEY_HOLD_MS value in \data\init\init.txt.

<pre>
del::
IfWinActive Dwarf Fortress
{
send d{down}
return
}
else
{
send {del}
return
}
</pre>

A dumping script by [[User:Dukederek|Dukederek]]:

This script uses a system similar the commands in the designations menu to mark most of the contents of a large area for dumping. [[User:Dukederek|My talk page]] has more detailed instruction.

Essentially you need to create two text files with the following titles and content. When playing DF it is safe to have blockdumpinit running constantly as long as you dont plan on using the ctrl-d combination for something else.

'''blockdumpinit.ahk'''
<pre>
^d::
RunWait, "blockdumpmain.ahk"
Return
</pre>

'''blockdumpmain.ahk'''
<pre>
SetKeyDelay 25
return::
Send k
return
up::
Send w
return
left::
Send a
return
down::
Send s
return
right::
Send d
return
q::
ExitApp
return
shift::
x := 0
y := 1
Loop{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}else if keypress = s
{
y := ++y
Send {down}
continue
}else if keypress = a
{
x := --x
Send {left}
continue
}else if keypress = d
{
x := ++x
Send {right}
continue
}else if keypress = k
{
break
}else if keypress = q
{
ExitApp
}
}
y := y / 2
z := y
z := Floor(z)
z := y/z
Send d{NumpadAdd}d
If z = 0
{
If x = 0
ExitApp
Else{
Loop %x%{
Send {left}d
}ExitApp
}
}If z <> 1
{
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Loop %x%{
Send {left}d{NumpadAdd}d
}
}Else If z = 1
{
y := y + 0.5
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Send d{NumpadSub}d
}ExitApp
</pre>

===Rewalling ===
Taken from [[User:Valdemar|Valdemar's user page]].

This is a macro to aid with rewalling. To use, copy-paste the script into a new .ahk file and run the script with AutoHotkey. Then, in Dwarf Fortress, press b-C-w, move the cursor to where you want to start the wall, and hold Ctrl-Shift-Arrowkey, using the direction you want to rewall in. To build floors, press b-C-f instead, and use Ctrl-Alt-Arrowkey. To stop, just release the keys.

The script will use the first material in the list. I suggest you create a stockpile near the construction site that only accepts the item you wish to build with and temporarily forbid any nearby materials you don't want to build with.

<pre>
$^+Left:: ProcessEvent("Left","w")
$^+Right:: ProcessEvent("Right","w")
$^+Up:: ProcessEvent("Up","w")
$^+Down:: ProcessEvent("Down","w")

$^!Left:: ProcessEvent("Left","f")
$^!Right:: ProcessEvent("Right","f")
$^!Up:: ProcessEvent("Up","f")
$^!Down:: ProcessEvent("Down","f")

ProcessEvent(direction, type)
{
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
Loop
{
if not GetKeyState(direction, "P")
break
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
}
}
</pre>

===Grid-by-grid designation===
For easier diagonal and fancy mining. Assumes that DF is active. "^!" means ctrl-alt-direction.

<pre>
^!NumpadEnd::
send {Enter}{Enter}{NumpadEnd}
return
^!NumpadDown::
send {Enter}{Enter}{NumpadDown}
return
^!NumpadPgDn::
send {Enter}{Enter}{NumpadPgDn}
return
^!NumpadLeft::
send {Enter}{Enter}{NumpadLeft}
return
^!NumpadRight::
send {Enter}{Enter}{NumpadRight}
return
^!NumpadHome::
send {Enter}{Enter}{NumpadHome}
return
^!NumpadUp::
send {Enter}{Enter}{NumpadUp}
return
^!NumpadPgUp::
send {Enter}{Enter}{NumpadPgUp}
return
</pre>

===Room-designation macros===

====Valdemar's Designator Macro====
This macro can read a spreadsheet and designate rooms according to it. [http://www.bay12games.com/cgi-local/ultimatebb.cgi?ubb=get_topic&f=2&t=001507 Forum Thread/Download]

====Fedor's chambered circle====
A circular room with eight equal-sized chambers, suitable for everything from housing to workshops to a mausoleum. 
[http://mkv25.net/dfma/movie-216-room-designationmacro01 See this macro in action] 
[[Macros_and_Keymaps_Examples#Room-designation Macro 01|Macro text]]

====Valdemar's bedroom complex====
A large fractal bedroom/dining complex, with 56 bedrooms and room for 24 tables.

You can press Alt-B to create a bedroom block, or Alt-C to create a full complex with 4 bedroom blocks and a dining block in the center.

Note - the macro is much faster than the demo movie shows, it is done in under a minute.

[http://mkv25.net/dfma/movie-252 Demo Movie]

[http://www.pindi.us/files/fractalbr.zip Download]

{{Game_Interface FAQ}}
[[Category:ahk scripts]]

40d:Macros and keymaps

2008-02-14T11:15:30Z

Dukederek: /* Dumping */

Playing Dwarf Fortress means lots of typing. Although the game (as of version v0.27.169.33) has no internal macro/keymap system, using an external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

# 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.

== AutoHotKey Examples ==

===Dumping===
Taken from an old version of [[User:Jackard|Jackard's user page]].

To use, first have your bookeeper do enough desk work so you can view individual items in the stocks listing. Then bring it up and press del to quickly mark stuff. To adjust the key repeat rate, edit the KEY_HOLD_MS value in \data\init\init.txt.

<pre>
del::
IfWinActive Dwarf Fortress
{
send d{down}
return
}
else
{
send {del}
return
}
</pre>

A dumping script by [[User:Dukederek|Dukederek]]:

This script uses a system similar the commands in the designations menu to mark the contents of a large area for dumping. [[User:Dukederek|My talk page]] has instruction on how to use this if it is not evident from the code below

'''blockdumpinit.ahk'''
<pre>
^d::
RunWait, "blockdumpmain.ahk"
Return
</pre>

'''blockdumpmain.ahk'''
<pre>
SetKeyDelay 25
return::
Send k
return
up::
Send w
return
left::
Send a
return
down::
Send s
return
right::
Send d
return
q::
ExitApp
return
shift::
x := 0
y := 1
Loop{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}else if keypress = s
{
y := ++y
Send {down}
continue
}else if keypress = a
{
x := --x
Send {left}
continue
}else if keypress = d
{
x := ++x
Send {right}
continue
}else if keypress = k
{
break
}else if keypress = q
{
ExitApp
}
}
y := y / 2
z := y
z := Floor(z)
z := y/z
Send d{NumpadAdd}d
If z = 0
{
If x = 0
ExitApp
Else{
Loop %x%{
Send {left}d
}ExitApp
}
}If z <> 1
{
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Loop %x%{
Send {left}d{NumpadAdd}d
}
}Else If z = 1
{
y := y + 0.5
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Send d{NumpadSub}d
}ExitApp
</pre>

===Rewalling ===
Taken from [[User:Valdemar|Valdemar's user page]].

This is a macro to aid with rewalling. To use, copy-paste the script into a new .ahk file and run the script with AutoHotkey. Then, in Dwarf Fortress, press b-C-w, move the cursor to where you want to start the wall, and hold Ctrl-Shift-Arrowkey, using the direction you want to rewall in. To build floors, press b-C-f instead, and use Ctrl-Alt-Arrowkey. To stop, just release the keys.

The script will use the first material in the list. I suggest you create a stockpile near the construction site that only accepts the item you wish to build with and temporarily forbid any nearby materials you don't want to build with.

<pre>
$^+Left:: ProcessEvent("Left","w")
$^+Right:: ProcessEvent("Right","w")
$^+Up:: ProcessEvent("Up","w")
$^+Down:: ProcessEvent("Down","w")

$^!Left:: ProcessEvent("Left","f")
$^!Right:: ProcessEvent("Right","f")
$^!Up:: ProcessEvent("Up","f")
$^!Down:: ProcessEvent("Down","f")

ProcessEvent(direction, type)
{
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
Loop
{
if not GetKeyState(direction, "P")
break
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
}
}
</pre>

===Grid-by-grid designation===
For easier diagonal and fancy mining. Assumes that DF is active. "^!" means ctrl-alt-direction.

<pre>
^!NumpadEnd::
send {Enter}{Enter}{NumpadEnd}
return
^!NumpadDown::
send {Enter}{Enter}{NumpadDown}
return
^!NumpadPgDn::
send {Enter}{Enter}{NumpadPgDn}
return
^!NumpadLeft::
send {Enter}{Enter}{NumpadLeft}
return
^!NumpadRight::
send {Enter}{Enter}{NumpadRight}
return
^!NumpadHome::
send {Enter}{Enter}{NumpadHome}
return
^!NumpadUp::
send {Enter}{Enter}{NumpadUp}
return
^!NumpadPgUp::
send {Enter}{Enter}{NumpadPgUp}
return
</pre>

===Room-designation macros===

====Valdemar's Designator Macro====
This macro can read a spreadsheet and designate rooms according to it. [http://www.bay12games.com/cgi-local/ultimatebb.cgi?ubb=get_topic&f=2&t=001507 Forum Thread/Download]

====Fedor's chambered circle====
A circular room with eight equal-sized chambers, suitable for everything from housing to workshops to a mausoleum. 
[http://mkv25.net/dfma/movie-216-room-designationmacro01 See this macro in action] 
[[Macros_and_Keymaps_Examples#Room-designation Macro 01|Macro text]]

====Valdemar's bedroom complex====
A large fractal bedroom/dining complex, with 56 bedrooms and room for 24 tables.

You can press Alt-B to create a bedroom block, or Alt-C to create a full complex with 4 bedroom blocks and a dining block in the center.

Note - the macro is much faster than the demo movie shows, it is done in under a minute.

[http://mkv25.net/dfma/movie-252 Demo Movie]

[http://www.pindi.us/files/fractalbr.zip Download]

{{Game_Interface FAQ}}
[[Category:ahk scripts]]

User:Dukederek

2008-01-22T17:12:03Z

Dukederek: /* Dump Macro */

== Dump Macro ==

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-d" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost tile you want to dump from using the k "look around" button
* Press "ctrl-d" (press q here to quit if you pressed it accidentally)
* Press shift
* Using the arrow keys move to the bottomrightmost tile. To cancel press q
* press return and watch the yellow cross fly about designatin'

The limitation is that only the first two items on each tile's list are set to be dumped but that's not so bad it it?

Anyway, here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

'''Call this one blockdumpinit.ahk'''
<pre>
^d::
RunWait, "blockdumpmain.ahk"
Return
</pre>

'''Call this one blockdumpmain.ahk'''
<pre>
SetKeyDelay 25
return::
Send k
return
up::
Send w
return
left::
Send a
return
down::
Send s
return
right::
Send d
return
q::
ExitApp
return
shift::
x := 0
y := 1
Loop{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}else if keypress = s
{
y := ++y
Send {down}
continue
}else if keypress = a
{
x := --x
Send {left}
continue
}else if keypress = d
{
x := ++x
Send {right}
continue
}else if keypress = k
{
break
}else if keypress = q
{
ExitApp
}
}
y := y / 2
z := y
z := Floor(z)
z := y/z
Send d{NumpadAdd}d
If z = 0
{
If x = 0
ExitApp
Else{
Loop %x%{
Send {left}d
}ExitApp
}
}If z <> 1
{
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Loop %x%{
Send {left}d{NumpadAdd}d
}
}Else If z = 1
{
y := y + 0.5
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Send d{NumpadSub}d
}ExitApp
</pre>

User:Dukederek

2008-01-22T17:10:09Z

Dukederek: /* Dump Macro */

== Dump Macro ==

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-d" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost tile you want to dump from using the k "look around" button
* Press "ctrl-d" (press q here to quit if you pressed it accidentally)
* Press shift
* Using the arrow keys move to the bottomrightmost tile. To cancel press q
* press return and watch the yellow cross fly about designatin'

The limitation is that only the first two items on each tile's list are set to be dumped but that's not so bad it it?

Anyway, here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

'''Call this one blockdumpinit.ahk'''
<pre>
^d::
RunWait, "blockdumpmain.ahk"
Return
</pre>

'''Call this one blockdumpmain.ahk'''
<pre>
SetKeyDelay 25
+up::
Send {up 10}
return
+left::
Send {left 10}
return
+down::
Send {down 10}
+right::
Send {right 10}
return
return::
Send k
return
up::
Send w
return
left::
Send a
return
down::
Send s
return
right::
Send d
return
q::
ExitApp
return
shift::
x := 0
y := 1
Loop{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}else if keypress = s
{
y := ++y
Send {down}
continue
}else if keypress = a
{
x := --x
Send {left}
continue
}else if keypress = d
{
x := ++x
Send {right}
continue
}else if keypress = k
{
break
}else if keypress = q
{
ExitApp
}
}
y := y / 2
z := y
z := Floor(z)
z := y/z
Send d{NumpadAdd}d
If z = 0
{
If x = 0
ExitApp
Else{
Loop %x%{
Send {left}d
}ExitApp
}
}If z <> 1
{
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Loop %x%{
Send {left}d{NumpadAdd}d
}
}Else If z = 1
{
y := y + 0.5
Loop %y%{
Loop %x%{
Send {left}d{NumpadAdd}d
}Send {up}d
Loop %x%{
Send {right}d{NumpadAdd}d
}Send {up}d{NumpadAdd}d
}Send d{NumpadSub}d
}ExitApp
</pre>

User:Dukederek

2008-01-22T17:05:20Z

Dukederek: /* Dump Macro */

== Dump Macro ==

40d Talk:Macros and keymaps

2008-01-21T20:46:49Z

Dukederek: /* dump macro */

Is 'Playing Dungeon Fortress' (first few words of the article) supposed to be a joke? --[[User:Valdemar|Valdemar]] 21:36, 25 December 2007 (EST)
:Probably meant to say "fortress mode"... Must be a typo which got overlooked. --[[User:Eagle of Fire|Eagle of Fire]] 21:41, 25 December 2007 (EST)

== dump macro ==

I have written a dump macro that works a bit like the actual designation commands (with a few limitations). Is it okay just to add it to this page?

I have put it on my userpage now. someone with more authority can now place it where they wish

[[User:Dukederek|Dukederek]] 12:44, 21 January 2008 (EST)
:Feel free to put it here.[[User:Fedor|Fedor]] 15:30, 21 January 2008 (EST)

::After a few botched attempts, i think it's up in a satisfactory way :) [[User:Dukederek|Dukederek]] 15:46, 21 January 2008 (EST)

User:Dukederek

2008-01-21T20:45:39Z

Dukederek: /* Dump Macro */

User:Dukederek

2008-01-21T20:45:24Z

Dukederek: /* Code Below: */

40d:Macros and keymaps

2008-01-21T20:45:03Z

Dukederek: /* Dumping */

Playing Dwarf Fortress means lots of typing. Although the game (as of version v0.27.169.33) has no internal macro/keymap system, using an external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

# 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.

== AutoHotKey Examples ==

===Dumping===
Taken from an old version of [[User:Jackard|Jackard's user page]].

To use, first have your bookeeper do enough desk work so you can view individual items in the stocks listing. Then bring it up and press del to quickly mark stuff. To adjust the key repeat rate, edit the KEY_HOLD_MS value in \data\init\init.txt.

<pre>
del::
IfWinActive Dwarf Fortress
{
send d{down}
return
}
else
{
send {del}
return
}
</pre>

A dumping script by [[User:Dukederek|Dukederek]]:

This script uses a system similar the commands in the designations menu to mark the contents of a large area for dumping. [[User:Dukederek|My talk page]] has instruction on how to use this if it is not evident from the code below

<pre>
^return::
x = 0
y = 0
IfWinActive Dwarf Fortress
{
Loop
{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}
else if keypress = s
{
y := ++y
Send {down}
continue
}
else if keypress = a
{
x := --x
Send {left}
continue
}
else if keypress = d
{
x := ++x
Send {right}
continue
}
else if keypress = k
{
break
}
else if keypress = q
{
Return
}
}
SetKeyDelay 1
Send {left %x%}
Send {up %y%}
x := x + 1
y := y + 1
Loop %y%
{
Loop %x%
{
Send d
Send {NumpadAdd}
Send d
Send {right}
}
Send {left %x%}
Send {down}
}
Loop %y%
{
Send {up}
}
}
else
return
</pre>

===Rewalling ===
Taken from [[User:Valdemar|Valdemar's user page]].

This is a macro to aid with rewalling. To use, copy-paste the script into a new .ahk file and run the script with AutoHotkey. Then, in Dwarf Fortress, press b-C-w, move the cursor to where you want to start the wall, and hold Ctrl-Shift-Arrowkey, using the direction you want to rewall in. To build floors, press b-C-f instead, and use Ctrl-Alt-Arrowkey. To stop, just release the keys.

The script will use the first material in the list. I suggest you create a stockpile near the construction site that only accepts the item you wish to build with and temporarily forbid any nearby materials you don't want to build with.

<pre>
$^+Left:: ProcessEvent("Left","w")
$^+Right:: ProcessEvent("Right","w")
$^+Up:: ProcessEvent("Up","w")
$^+Down:: ProcessEvent("Down","w")

$^!Left:: ProcessEvent("Left","f")
$^!Right:: ProcessEvent("Right","f")
$^!Up:: ProcessEvent("Up","f")
$^!Down:: ProcessEvent("Down","f")

ProcessEvent(direction, type)
{
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
Loop
{
if not GetKeyState(direction, "P")
break
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
}
}
</pre>

===Grid-by-grid designation===
For easier diagonal and fancy mining. Assumes that DF is active. "^!" means ctrl-alt-direction.

<pre>
^!NumpadEnd::
send {Enter}{Enter}{NumpadEnd}
return
^!NumpadDown::
send {Enter}{Enter}{NumpadDown}
return
^!NumpadPgDn::
send {Enter}{Enter}{NumpadPgDn}
return
^!NumpadLeft::
send {Enter}{Enter}{NumpadLeft}
return
^!NumpadRight::
send {Enter}{Enter}{NumpadRight}
return
^!NumpadHome::
send {Enter}{Enter}{NumpadHome}
return
^!NumpadUp::
send {Enter}{Enter}{NumpadUp}
return
^!NumpadPgUp::
send {Enter}{Enter}{NumpadPgUp}
return
</pre>

===Room-designation macros===

====Valdemar's Designator Macro====
This macro can read a spreadsheet and designate rooms according to it. [http://www.bay12games.com/cgi-local/ultimatebb.cgi?ubb=get_topic&f=2&t=001507 Forum Thread/Download]

====Fedor's chambered circle====
A circular room with eight equal-sized chambers, suitable for everything from housing to workshops to a mausoleum. 
[http://mkv25.net/dfma/movie-216-room-designationmacro01 See this macro in action] 
[[Macros_and_Keymaps_Examples#Room-designation Macro 01|Macro text]]

====Valdemar's bedroom complex====
A large fractal bedroom/dining complex, with 56 bedrooms and room for 24 tables.

You can press Alt-B to create a bedroom block, or Alt-C to create a full complex with 4 bedroom blocks and a dining block in the center.

Note - the macro is much faster than the demo movie shows, it is done in under a minute.

[http://mkv25.net/dfma/movie-252 Demo Movie]

[http://www.pindi.us/files/fractalbr.zip Download]

{{Game_Interface FAQ}}

User:Dukederek

2008-01-21T20:42:24Z

Dukederek: /* Dump Macro */

40d:Macros and keymaps

2008-01-21T20:41:53Z

Dukederek: /* Dumping */

Playing Dwarf Fortress means lots of typing. Although the game (as of version v0.27.169.33) has no internal macro/keymap system, using an external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

# 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.

== AutoHotKey Examples ==

===Dumping===
Taken from an old version of [[User:Jackard|Jackard's user page]].

To use, first have your bookeeper do enough desk work so you can view individual items in the stocks listing. Then bring it up and press del to quickly mark stuff. To adjust the key repeat rate, edit the KEY_HOLD_MS value in \data\init\init.txt.

<pre>
del::
IfWinActive Dwarf Fortress
{
send d{down}
return
}
else
{
send {del}
return
}
</pre>

A dumping script by [[User:Dukederek|Dukederek]]:

This script uses a system similar the commands in the designations menu to mark the contents of a large area for dumping. [[User:Dukederek|My talk page]] has instruction on how to use this if it is not evident from the code below

<pre>
^return::
x = 0
y = 0
IfWinActive Dwarf Fortress
{
Loop
{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}
else if keypress = s
{
y := ++y
Send {down}
continue
}
else if keypress = a
{
x := --x
Send {left}
continue
}
else if keypress = d
{
x := ++x
Send {right}
continue
}
else if keypress = k
{
break
}
else if keypress = q
{
Return
}
}
SetKeyDelay 1
Send {left %x%}
Send {up %y%}
x := x + 1
y := y + 1
Loop %y%
{
Loop %x%
{
Send d
Send {NumpadAdd}
Send d
Send {NumpadAdd}
Send d
Send {right}
}
Send {left %x%}
Send {down}
}
Loop %y%
{
Send {up}
}
}
else
return
</pre>

===Rewalling ===
Taken from [[User:Valdemar|Valdemar's user page]].

This is a macro to aid with rewalling. To use, copy-paste the script into a new .ahk file and run the script with AutoHotkey. Then, in Dwarf Fortress, press b-C-w, move the cursor to where you want to start the wall, and hold Ctrl-Shift-Arrowkey, using the direction you want to rewall in. To build floors, press b-C-f instead, and use Ctrl-Alt-Arrowkey. To stop, just release the keys.

The script will use the first material in the list. I suggest you create a stockpile near the construction site that only accepts the item you wish to build with and temporarily forbid any nearby materials you don't want to build with.

<pre>
$^+Left:: ProcessEvent("Left","w")
$^+Right:: ProcessEvent("Right","w")
$^+Up:: ProcessEvent("Up","w")
$^+Down:: ProcessEvent("Down","w")

$^!Left:: ProcessEvent("Left","f")
$^!Right:: ProcessEvent("Right","f")
$^!Up:: ProcessEvent("Up","f")
$^!Down:: ProcessEvent("Down","f")

ProcessEvent(direction, type)
{
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
Loop
{
if not GetKeyState(direction, "P")
break
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
}
}
</pre>

===Grid-by-grid designation===
For easier diagonal and fancy mining. Assumes that DF is active. "^!" means ctrl-alt-direction.

<pre>
^!NumpadEnd::
send {Enter}{Enter}{NumpadEnd}
return
^!NumpadDown::
send {Enter}{Enter}{NumpadDown}
return
^!NumpadPgDn::
send {Enter}{Enter}{NumpadPgDn}
return
^!NumpadLeft::
send {Enter}{Enter}{NumpadLeft}
return
^!NumpadRight::
send {Enter}{Enter}{NumpadRight}
return
^!NumpadHome::
send {Enter}{Enter}{NumpadHome}
return
^!NumpadUp::
send {Enter}{Enter}{NumpadUp}
return
^!NumpadPgUp::
send {Enter}{Enter}{NumpadPgUp}
return
</pre>

===Room-designation macros===

====Valdemar's Designator Macro====
This macro can read a spreadsheet and designate rooms according to it. [http://www.bay12games.com/cgi-local/ultimatebb.cgi?ubb=get_topic&f=2&t=001507 Forum Thread/Download]

====Fedor's chambered circle====
A circular room with eight equal-sized chambers, suitable for everything from housing to workshops to a mausoleum. 
[http://mkv25.net/dfma/movie-216-room-designationmacro01 See this macro in action] 
[[Macros_and_Keymaps_Examples#Room-designation Macro 01|Macro text]]

====Valdemar's bedroom complex====
A large fractal bedroom/dining complex, with 56 bedrooms and room for 24 tables.

You can press Alt-B to create a bedroom block, or Alt-C to create a full complex with 4 bedroom blocks and a dining block in the center.

Note - the macro is much faster than the demo movie shows, it is done in under a minute.

[http://mkv25.net/dfma/movie-252 Demo Movie]

[http://www.pindi.us/files/fractalbr.zip Download]

{{Game_Interface FAQ}}

User:Dukederek

2008-01-21T20:41:13Z

Dukederek: /* Code Below: */

40d:Macros and keymaps

2008-01-21T20:39:32Z

Dukederek:

Playing Dwarf Fortress means lots of typing. Although the game (as of version v0.27.169.33) has no internal macro/keymap system, using an external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

# 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.

== AutoHotKey Examples ==

===Dumping===
Taken from an old version of [[User:Jackard|Jackard's user page]].

To use, first have your bookeeper do enough desk work so you can view individual items in the stocks listing. Then bring it up and press del to quickly mark stuff. To adjust the key repeat rate, edit the KEY_HOLD_MS value in \data\init\init.txt.

<pre>
del::
IfWinActive Dwarf Fortress
{
send d{down}
return
}
else
{
send {del}
return
}
</pre>

A dumping script by [[User:Dukederek|Dukederek]]:

This script uses a system similar the commands in the designations menu to mark the contents of a large area for dumping. [[User:Dukederek|My talk page]] has instruction on how to use this if it is not evident from the code below

<pre>
^return::
x = 0
y = 0
IfWinActive Dwarf Fortress
{
Loop
{
Input, keypress, B, {esc} , w,a,s,d,k,q
if keypress = w
{
y := --y
Send {up}
continue
}
else if keypress = s
{
y := ++y
Send {down}
continue
}
else if keypress = a
{
x := --x
Send {left}
continue
}
else if keypress = d
{
x := ++x
Send {right}
continue
}
else if keypress = k
{
break
}
else if keypress = q
{
Return
}
}
SetKeyDelay 1
Send {left %x%}
Send {up %y%}
x := x + 1
y := y + 1
Loop %y%
{
Loop %x%
{
Send d
Send {NumpadAdd}
Send d
Send {right}
}
Send {left %x%}
Send {down}
}
Loop %y%
{
Send {up}
}
}
else
return
</pre>

===Rewalling ===
Taken from [[User:Valdemar|Valdemar's user page]].

This is a macro to aid with rewalling. To use, copy-paste the script into a new .ahk file and run the script with AutoHotkey. Then, in Dwarf Fortress, press b-C-w, move the cursor to where you want to start the wall, and hold Ctrl-Shift-Arrowkey, using the direction you want to rewall in. To build floors, press b-C-f instead, and use Ctrl-Alt-Arrowkey. To stop, just release the keys.

The script will use the first material in the list. I suggest you create a stockpile near the construction site that only accepts the item you wish to build with and temporarily forbid any nearby materials you don't want to build with.

<pre>
$^+Left:: ProcessEvent("Left","w")
$^+Right:: ProcessEvent("Right","w")
$^+Up:: ProcessEvent("Up","w")
$^+Down:: ProcessEvent("Down","w")

$^!Left:: ProcessEvent("Left","f")
$^!Right:: ProcessEvent("Right","f")
$^!Up:: ProcessEvent("Up","f")
$^!Down:: ProcessEvent("Down","f")

ProcessEvent(direction, type)
{
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
Loop
{
if not GetKeyState(direction, "P")
break
Send {Enter}
Sleep 100
Send {Enter}
Sleep 100
Send %type%
Sleep 100
Send {%direction%}
}
}
</pre>

===Grid-by-grid designation===
For easier diagonal and fancy mining. Assumes that DF is active. "^!" means ctrl-alt-direction.

<pre>
^!NumpadEnd::
send {Enter}{Enter}{NumpadEnd}
return
^!NumpadDown::
send {Enter}{Enter}{NumpadDown}
return
^!NumpadPgDn::
send {Enter}{Enter}{NumpadPgDn}
return
^!NumpadLeft::
send {Enter}{Enter}{NumpadLeft}
return
^!NumpadRight::
send {Enter}{Enter}{NumpadRight}
return
^!NumpadHome::
send {Enter}{Enter}{NumpadHome}
return
^!NumpadUp::
send {Enter}{Enter}{NumpadUp}
return
^!NumpadPgUp::
send {Enter}{Enter}{NumpadPgUp}
return
</pre>

===Room-designation macros===

====Valdemar's Designator Macro====
This macro can read a spreadsheet and designate rooms according to it. [http://www.bay12games.com/cgi-local/ultimatebb.cgi?ubb=get_topic&f=2&t=001507 Forum Thread/Download]

====Fedor's chambered circle====
A circular room with eight equal-sized chambers, suitable for everything from housing to workshops to a mausoleum. 
[http://mkv25.net/dfma/movie-216-room-designationmacro01 See this macro in action] 
[[Macros_and_Keymaps_Examples#Room-designation Macro 01|Macro text]]

====Valdemar's bedroom complex====
A large fractal bedroom/dining complex, with 56 bedrooms and room for 24 tables.

You can press Alt-B to create a bedroom block, or Alt-C to create a full complex with 4 bedroom blocks and a dining block in the center.

Note - the macro is much faster than the demo movie shows, it is done in under a minute.

[http://mkv25.net/dfma/movie-252 Demo Movie]

[http://www.pindi.us/files/fractalbr.zip Download]

{{Game_Interface FAQ}}

User:Dukederek

2008-01-21T19:35:19Z

Dukederek: /* Dump Macro */

40d Talk:Macros and keymaps

2008-01-21T17:44:03Z

Dukederek: /* dump macro */

User:Dukederek

2008-01-21T17:42:44Z

Dukederek:

User:Dukederek

2008-01-21T17:42:24Z

Dukederek:

== Dump Macro

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-return" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost square you want to dump using the k "look around" button
* Press "ctrl-return"
* Using w a s d, move the yellow cross to the bottom rightmost square of things you wish to dump. To cancel press q
* press k

The limitations are that only the first two items on each tile's list are set to be dumped. Also, it seems non-trivial to map this to the arrow keys rather than w a s d but that's not so bad right?

Here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

<blockquote>
^return:: 
x = 0 
y = 0 
IfWinActive Dwarf Fortress 
{ 
Loop 
{ 
Input, keypress, B, {esc} , w,a,s,d,k,q 
if keypress = w 
{ 
y := --y 
Send {up} 
continue 
} 
else if keypress = s 
{ 
y := ++y 
Send {down} 
continue 
} 
else if keypress = a 
{ 
x := --x 
Send {left} 
continue 
} 
else if keypress = d 
{ 
x := ++x 
Send {right} 
continue 
} 
else if keypress = k 
{ 
break 
} 
else if keypress = q 
{ 
Return 
} 
} 
SetKeyDelay 1 
Send {left %x%} 
Send {up %y%} 
x := x + 1 
y := y + 1 

Loop %y% 
{ 
Loop %x% 
{ 
Send d 
Send {NumpadAdd} 
Send d 
Send {right} 
} 
Send {left %x%} 
Send {down} 
} 
Loop %y% 
{ 
Send {up} 
} 
} 
else 
return 
</blockquote>

User:Dukederek

2008-01-21T17:41:06Z

Dukederek:

== Dump Macro

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-return" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost square you want to dump using the k "look around" button
* Press "ctrl-return"
* Using w a s d, move the yellow cross to the bottom rightmost square of things you wish to dump. To cancel press q
* press k

The limitations are that only the first two items on each tile's list are set to be dumped. Also, it seems non-trivial to map this to the arrow keys rather than w a s d but that's not so bad right?

Here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

<blockquote>
^return::
x = 0
y = 0
IfWinActive Dwarf Fortress
{
Loop
{
Input, keypress, B, {esc} , w,a,s,d,k,q

if keypress = w
{
y := --y
Send {up}
continue
}
else if keypress = s
{
y := ++y
Send {down}
continue
}
else if keypress = a
{
x := --x
Send {left}
continue
}
else if keypress = d
{
x := ++x
Send {right}
continue
}
else if keypress = k
{
break
}
else if keypress = q
{
Return
}
}
SetKeyDelay 1
Send {left %x%}
Send {up %y%}
x := x + 1
y := y + 1

Loop %y%
{
Loop %x%
{
Send d
Send {NumpadAdd}
Send d
Send {right}
}
Send {left %x%}
Send {down}
}
Loop %y%
{
Send {up}
}
}
else
return
</blockquote>

User:Dukederek

2008-01-21T17:37:55Z

Dukederek:

== Dump Macro

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-return" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost square you want to dump using the k "look around" button
* Press "ctrl-return"
* Using w a s d, move the yellow cross to the bottom rightmost square of things you wish to dump. To cancel press q
* press k

The limitations are that only the first two items on each tile's list are set to be dumped. Also, it seems non-trivial to map this to the arrow keys rather than w a s d but that's not so bad right?

Here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

<blockquote>
^return:: 
x = 0 
y = 0 
Loop 
{ 
Input, keypress, B, {esc} , w,a,s,d,k,q 
 
if keypress = w 
{ 
y := --y 
Send {up} 
continue 
} 
else if keypress = s 
{ 
y := ++y 
Send {down} 
continue 
} 
else if keypress = a 
{ 
x := --x 
Send {left} 
continue 
} 
else if keypress = d 
{ 
x := ++x 
Send {right} 
continue 
} 
else if keypress = k 
{ 
break 
} 
else if keypress = q 
{ 
Return 
} 
} 
SetKeyDelay 1 
Send {left %x%} 
Send {up %y%} 
x := x + 1 
y := y + 1 
 
Loop %y% 
{ 
Loop %x% 
{ 
Send d 
Send {NumpadAdd} 
Send d 
Send {right} 
} 
Send {left %x%} 
Send {down} 
} 
Loop %y% 
{ 
Send {up} 
} 
return 
</blockquote>

User:Dukederek

2008-01-21T17:37:20Z

Dukederek: New page: == Dump Macro I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you s...

== Dump Macro

I have written a dump macro for AutoHotKey which works something like the designation tools in the actual DF interface. The current limitation is that it only works if you start at the top left of the group of tiles you wish to dump and finish at the bottom right.

I have mapped it to "ctrl-return" so that it can be left running when not needed and not interfere with any other commands in DF.

To use.
* Go to the top leftmost square you want to dump using the k "look around" button
* Press "ctrl-return"
* Using w a s d, move the yellow cross to the bottom rightmost square of things you wish to dump. To cancel press q
* press k

The limitations are that only the first two items on each tile's list are set to be dumped. Also, it seems non-trivial to map this to the arrow keys rather than w a s d but that's not so bad right?

Here is the code, for those not in the know [http://www.autohotkey.com install autohotkey], paste the text below into a file named "blockdump.ahk" or something, double click the file so there is a green and white "H" icon in your system tray.

{| class="wikitable"
|-
! ^return:: 
x = 0 
y = 0 
Loop 
{ 
Input, keypress, B, {esc} , w,a,s,d,k,q 
 
if keypress = w 
{ 
y := --y 
Send {up} 
continue 
} 
else if keypress = s 
{ 
y := ++y 
Send {down} 
continue 
} 
else if keypress = a 
{ 
x := --x 
Send {left} 
continue 
} 
else if keypress = d 
{ 
x := ++x 
Send {right} 
continue 
} 
else if keypress = k 
{ 
break 
} 
else if keypress = q 
{ 
Return 
} 
} 
SetKeyDelay 1 
Send {left %x%} 
Send {up %y%} 
x := x + 1 
y := y + 1 
 
Loop %y% 
{ 
Loop %x% 
{ 
Send d 
Send {NumpadAdd} 
Send d 
Send {right} 
} 
Send {left %x%} 
Send {down} 
} 
Loop %y% 
{ 
Send {up} 
} 
return 
|}

40d Talk:Macros and keymaps

2008-01-21T16:58:57Z

Dukederek: dump macro