|
|
@ -353,7 +353,8 @@ This plugin adds an option to the :kbd:`q` menu when `enabled <enable>`.
|
|
|
|
command-prompt
|
|
|
|
command-prompt
|
|
|
|
==============
|
|
|
|
==============
|
|
|
|
An in-game DFHack terminal, where you can enter other commands.
|
|
|
|
An in-game DFHack terminal, where you can enter other commands.
|
|
|
|
Best used from a keybinding; by default :kbd:`Ctrl`:kbd:`Shift`:kbd:`P`.
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`command-prompt`
|
|
|
|
|
|
|
|
|
|
|
|
Usage: ``command-prompt [entry]``
|
|
|
|
Usage: ``command-prompt [entry]``
|
|
|
|
|
|
|
|
|
|
|
@ -372,13 +373,11 @@ Otherwise somewhat similar to `gui/quickcmd`.
|
|
|
|
hotkeys
|
|
|
|
hotkeys
|
|
|
|
=======
|
|
|
|
=======
|
|
|
|
Opens an in-game screen showing which DFHack keybindings are
|
|
|
|
Opens an in-game screen showing which DFHack keybindings are
|
|
|
|
active in the current context.
|
|
|
|
active in the current context. See also `hotkey-notes`.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: images/hotkeys.png
|
|
|
|
.. image:: images/hotkeys.png
|
|
|
|
|
|
|
|
|
|
|
|
Type ``hotkeys`` into the DFHack console to open the screen,
|
|
|
|
:dfhack-keybind:`hotkeys`
|
|
|
|
or bind the command to a globally active hotkey. The default
|
|
|
|
|
|
|
|
keybinding is :kbd:`Ctrl`:kbd:`F1`. See also `hotkey-notes`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _rb:
|
|
|
|
.. _rb:
|
|
|
|
|
|
|
|
|
|
|
@ -407,7 +406,7 @@ military and social skills.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: images/manipulator2.png
|
|
|
|
.. image:: images/manipulator2.png
|
|
|
|
|
|
|
|
|
|
|
|
Press :kbd:`t` to toggle between Profession and Squad view.
|
|
|
|
Press :kbd:`t` to toggle between Profession, Squad, and Job views.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: images/manipulator3.png
|
|
|
|
.. image:: images/manipulator3.png
|
|
|
|
|
|
|
|
|
|
|
@ -442,6 +441,20 @@ The following mouse shortcuts are also available:
|
|
|
|
Pressing :kbd:`Esc` normally returns to the unit screen, but :kbd:`Shift`:kbd:`Esc` would exit
|
|
|
|
Pressing :kbd:`Esc` normally returns to the unit screen, but :kbd:`Shift`:kbd:`Esc` would exit
|
|
|
|
directly to the main dwarf mode screen.
|
|
|
|
directly to the main dwarf mode screen.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Professions
|
|
|
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The manipulator plugin supports saving Professions: a named set of Labors labors that can be
|
|
|
|
|
|
|
|
quickly applied to one or multiple Dwarves.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To save a Profession highlight a Dwarf and press :kbd:`P`. The Profession will be saved using
|
|
|
|
|
|
|
|
the Custom Profession Name of the Dwarf, or the default for that Dwarf if no Custom Profession
|
|
|
|
|
|
|
|
Name has been set.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To apply a Profession either highlight a single Dwarf, or select multiple with :kbd:`x`, and press
|
|
|
|
|
|
|
|
:kbd:`p` to select the Profession to apply. All labors for the selected Dwarves will be reset to
|
|
|
|
|
|
|
|
the labors of the chosen Profession.
|
|
|
|
|
|
|
|
|
|
|
|
.. comment - the link target "search" is reserved for the Sphinx search page
|
|
|
|
.. comment - the link target "search" is reserved for the Sphinx search page
|
|
|
|
.. _search-plugin:
|
|
|
|
.. _search-plugin:
|
|
|
|
|
|
|
|
|
|
|
@ -659,12 +672,16 @@ Unit order examples::
|
|
|
|
|
|
|
|
|
|
|
|
The orderings are defined in ``hack/lua/plugins/sort/*.lua``
|
|
|
|
The orderings are defined in ``hack/lua/plugins/sort/*.lua``
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`sort-units`
|
|
|
|
|
|
|
|
|
|
|
|
.. _stocks:
|
|
|
|
.. _stocks:
|
|
|
|
|
|
|
|
|
|
|
|
stocks
|
|
|
|
stocks
|
|
|
|
======
|
|
|
|
======
|
|
|
|
Replaces the DF stocks screen with an improved version.
|
|
|
|
Replaces the DF stocks screen with an improved version.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`stocks`
|
|
|
|
|
|
|
|
|
|
|
|
.. _stocksettings:
|
|
|
|
.. _stocksettings:
|
|
|
|
.. _stockpiles:
|
|
|
|
.. _stockpiles:
|
|
|
|
|
|
|
|
|
|
|
@ -676,6 +693,7 @@ See `gui/stockpiles` for an in-game interface.
|
|
|
|
:copystock: Copies the parameters of the currently highlighted stockpile to the custom
|
|
|
|
:copystock: Copies the parameters of the currently highlighted stockpile to the custom
|
|
|
|
stockpile settings and switches to custom stockpile placement mode, effectively
|
|
|
|
stockpile settings and switches to custom stockpile placement mode, effectively
|
|
|
|
allowing you to copy/paste stockpiles easily.
|
|
|
|
allowing you to copy/paste stockpiles easily.
|
|
|
|
|
|
|
|
:dfhack-keybind:`copystock`
|
|
|
|
|
|
|
|
|
|
|
|
:savestock: Saves the currently highlighted stockpile's settings to a file in your Dwarf
|
|
|
|
:savestock: Saves the currently highlighted stockpile's settings to a file in your Dwarf
|
|
|
|
Fortress folder. This file can be used to copy settings between game saves or
|
|
|
|
Fortress folder. This file can be used to copy settings between game saves or
|
|
|
@ -874,7 +892,7 @@ Invoked as::
|
|
|
|
|
|
|
|
|
|
|
|
job-material <inorganic-token>
|
|
|
|
job-material <inorganic-token>
|
|
|
|
|
|
|
|
|
|
|
|
Intended to be used as a keybinding:
|
|
|
|
:dfhack-keybind:`job-material`
|
|
|
|
|
|
|
|
|
|
|
|
* In :kbd:`q` mode, when a job is highlighted within a workshop or furnace,
|
|
|
|
* In :kbd:`q` mode, when a job is highlighted within a workshop or furnace,
|
|
|
|
changes the material of the job. Only inorganic materials can be used
|
|
|
|
changes the material of the job. Only inorganic materials can be used
|
|
|
@ -887,6 +905,8 @@ job-duplicate
|
|
|
|
In :kbd:`q` mode, when a job is highlighted within a workshop or furnace
|
|
|
|
In :kbd:`q` mode, when a job is highlighted within a workshop or furnace
|
|
|
|
building, calling ``job-duplicate`` instantly duplicates the job.
|
|
|
|
building, calling ``job-duplicate`` instantly duplicates the job.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`job-duplicate`
|
|
|
|
|
|
|
|
|
|
|
|
.. _autogems:
|
|
|
|
.. _autogems:
|
|
|
|
|
|
|
|
|
|
|
|
autogems
|
|
|
|
autogems
|
|
|
@ -1076,6 +1096,8 @@ spotclean
|
|
|
|
Works like ``clean map snow mud``, but only for the tile under the cursor. Ideal
|
|
|
|
Works like ``clean map snow mud``, but only for the tile under the cursor. Ideal
|
|
|
|
if you want to keep that bloody entrance ``clean map`` would clean up.
|
|
|
|
if you want to keep that bloody entrance ``clean map`` would clean up.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`spotclean`
|
|
|
|
|
|
|
|
|
|
|
|
.. _autodump:
|
|
|
|
.. _autodump:
|
|
|
|
|
|
|
|
|
|
|
|
autodump
|
|
|
|
autodump
|
|
|
@ -1098,10 +1120,16 @@ Options:
|
|
|
|
:destroy-here: As ``destroy``, but only the selected item in the :kbd:`k` list,
|
|
|
|
:destroy-here: As ``destroy``, but only the selected item in the :kbd:`k` list,
|
|
|
|
or inside a container.
|
|
|
|
or inside a container.
|
|
|
|
Alias ``autodump-destroy-here``, for keybindings.
|
|
|
|
Alias ``autodump-destroy-here``, for keybindings.
|
|
|
|
|
|
|
|
:dfhack-keybind:`autodump-destroy-here`
|
|
|
|
:visible: Only process items that are not hidden.
|
|
|
|
:visible: Only process items that are not hidden.
|
|
|
|
:hidden: Only process hidden items.
|
|
|
|
:hidden: Only process hidden items.
|
|
|
|
:forbidden: Only process forbidden items (default: only unforbidden).
|
|
|
|
:forbidden: Only process forbidden items (default: only unforbidden).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
``autodump-destroy-item`` destroys the selected item, which may be selected
|
|
|
|
|
|
|
|
in the :kbd:`k` list, or inside a container. If called again before the game
|
|
|
|
|
|
|
|
is resumed, cancels destruction of the item.
|
|
|
|
|
|
|
|
:dfhack-keybind:`autodump-destroy-item`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cleanowned
|
|
|
|
cleanowned
|
|
|
|
==========
|
|
|
|
==========
|
|
|
@ -1139,6 +1167,8 @@ Options:
|
|
|
|
:prefs: Show dwarf preferences summary
|
|
|
|
:prefs: Show dwarf preferences summary
|
|
|
|
:reload: Reload configuration file (``dfhack-config/dwarfmonitor.json``)
|
|
|
|
:reload: Reload configuration file (``dfhack-config/dwarfmonitor.json``)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`dwarfmonitor`
|
|
|
|
|
|
|
|
|
|
|
|
Widget configuration:
|
|
|
|
Widget configuration:
|
|
|
|
|
|
|
|
|
|
|
|
The following types of widgets (defined in :file:`hack/lua/plugins/dwarfmonitor.lua`)
|
|
|
|
The following types of widgets (defined in :file:`hack/lua/plugins/dwarfmonitor.lua`)
|
|
|
@ -1226,7 +1256,16 @@ Options:
|
|
|
|
|
|
|
|
|
|
|
|
workNow
|
|
|
|
workNow
|
|
|
|
=======
|
|
|
|
=======
|
|
|
|
Force all dwarves to look for a job immediately, or as soon as the game is unpaused.
|
|
|
|
Don't allow dwarves to idle if any jobs are available.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When workNow is active, every time the game pauses, DF will make dwarves
|
|
|
|
|
|
|
|
perform any appropriate available jobs. This includes when you one step
|
|
|
|
|
|
|
|
through the game using the pause menu. Usage:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:workNow: print workNow status
|
|
|
|
|
|
|
|
:workNow 0: deactivate workNow
|
|
|
|
|
|
|
|
:workNow 1: activate workNow (look for jobs on pause, and only then)
|
|
|
|
|
|
|
|
:workNow 2: make dwarves look for jobs whenever a job completes
|
|
|
|
|
|
|
|
|
|
|
|
.. _seedwatch:
|
|
|
|
.. _seedwatch:
|
|
|
|
|
|
|
|
|
|
|
@ -1264,6 +1303,8 @@ zone
|
|
|
|
====
|
|
|
|
====
|
|
|
|
Helps a bit with managing activity zones (pens, pastures and pits) and cages.
|
|
|
|
Helps a bit with managing activity zones (pens, pastures and pits) and cages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`zone`
|
|
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
Options:
|
|
|
|
|
|
|
|
|
|
|
|
:set: Set zone or cage under cursor as default for future assigns.
|
|
|
|
:set: Set zone or cage under cursor as default for future assigns.
|
|
|
@ -1738,6 +1779,8 @@ Basic commands:
|
|
|
|
to remove designations, for if you accidentally set 50 levels at once.
|
|
|
|
to remove designations, for if you accidentally set 50 levels at once.
|
|
|
|
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
|
|
|
|
:diglx: Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`digv`
|
|
|
|
|
|
|
|
|
|
|
|
.. _digexp:
|
|
|
|
.. _digexp:
|
|
|
|
|
|
|
|
|
|
|
|
digexp
|
|
|
|
digexp
|
|
|
@ -2209,6 +2252,8 @@ Usage:
|
|
|
|
* When viewing unit details, body-swaps into that unit.
|
|
|
|
* When viewing unit details, body-swaps into that unit.
|
|
|
|
* In the main adventure mode screen, reverts transient swap.
|
|
|
|
* In the main adventure mode screen, reverts transient swap.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:dfhack-keybind:`adv-bodyswap`
|
|
|
|
|
|
|
|
|
|
|
|
.. _createitem:
|
|
|
|
.. _createitem:
|
|
|
|
|
|
|
|
|
|
|
|
createitem
|
|
|
|
createitem
|
|
|
|