In-game DFHack command launcher with integrated help.
Keybinding: CtrlShiftP ->
This tool is the primary GUI interface for running DFHack commands. You can open it from any screen with the ` hotkey. Tap ` again (or hit Esc) to close. Users with keyboard layouts that make the ` key difficult (or impossible) to press can use the alternate hotkey of CtrlShiftD.
gui/launcher [initial commandline]
gui/launcher -m|--minimal [initial commandline]
Open the launcher dialog with a blank initial commandline.
Open the launcher dialog in minimal mode with a blank initial commandline.
gui/launcher prospect --show ores,veins
Open the launcher dialog with the edit area pre-populated with the given command, ready for modification or running. Tools related to
prospectwill appear in the autocomplete list, and help text for
prospectwill be displayed in the lower panel.
Editing and running commands¶
Enter the command you want to run by typing its name. If you want to start over,
CtrlC will clear the line. When you are happy with the command,
hit Enter or click on the
run button to run it. Any output from the
command will appear in the lower panel after you run it. If you want to run the
command but close the dialog immediately so you can get back to the game, hold
down the Shift key and click on the
run button instead. The dialog
also closes automatically if you run a command that brings up a new GUI screen.
In any case, the command output will also be written to the DFHack terminal
console (the separate window that comes up when you start DF) if you need to
find it later.
To pause or unpause the game while gui/launcher is open, hit the spacebar once or twice. If you are typing a command, the first space will go into the edit box for your commandline. If the commandline is empty or if it already ends in a space, space key will be passed through to the game to affect the pause button.
If your keyboard layout makes any key impossible to type (such as [ and ] on German QWERTZ keyboards), use CtrlShiftK to bring up the on-screen keyboard. You can “type” the text you need by clicking on the characters with the mouse.
As you type, autocomplete options for DFHack commands appear in the right column. If the first word of what you’ve typed matches a valid command, then the autocomplete options will also include commands that have similar functionality to the one that you’ve named. Click on an autocomplete list option to select it or cycle through them with ShiftLeft and ShiftRight. You can run a command quickly without parameters by double-clicking on the tool name in the list. Holding down shift while you double-click allows you to run the command and close gui/launcher at the same time.
Context-sensitive help and command output¶
When you start
gui/launcher without parameters, it shows some useful
information in the lower panel about how to get started with browsing DFHack
tools by their category tags.
Once you have typed (or autocompleted) a word that matches a valid command, the lower panel shows the help for that command, including usage instructions and examples. You can scroll the help text with the mouse or with PgUp and PgDn. You can also scroll line by line with ShiftUp and ShiftDown.
Once you run a command, the lower panel will switch to command output mode, where you can see any text the command printed to the screen. If you want to see more help text as you run further commands, you can switch the lower panel back to help mode with CtrlT. The output text is kept for all the commands you run while the launcher window is open, but is cleared if you dismiss the launcher window and bring it back up.
gui/launcher keeps a history of commands you have run to let you quickly run
those commands again. You can scroll through your command history with the
Up and Down arrow keys, or you can search your history for
something specific with the AltS hotkey. When you hit
AltS, start typing to search your history for a match. To find the
next match for what you’ve already typed, hit AltS again. You can
run the matched command immediately with Enter, or hit Esc to edit
the command before running it.
By default, commands intended for developers and modders are filtered out of the
autocomplete list. This includes any tools tagged with
unavailable. You can
toggle this filtering by hitting CtrlD at any time.