dfhack/docs/plugins/autohauler.rst

autohauler
==========

.. dfhack-tool::
    :summary: Automatically manage hauling labors.
    :tags: untested fort auto labors

Similar to `autolabor`, but instead of managing all labors, autohauler only
addresses hauling labors, leaving the assignment of skilled labors entirely up
to you. You can use the in-game `manipulator` UI or an external tool like Dwarf
Therapist to do so.

Idle dwarves who are not on active military duty will be assigned the hauling
labors; everyone else (including those currently hauling) will have the hauling
labors removed. This is to encourage every dwarf to do their assigned skilled
labors whenever possible, but resort to hauling when those jobs are not
available. This also implies that the user will have a very tight skill
assignment, with most skilled labors only being assigned to just a few dwarves
and almost every non-military dwarf having at least one skilled labor assigned.

Autohauler allows a skill to be used as a flag to exempt a dwarf from
autohauler's effects. By default, this is the unused ALCHEMIST labor, but it
can be changed by the user.

Autohauler uses DFHack's `debug` functionality to display information about the changes it makes. The amount of
information displayed can be controlled through appropriate use of the ``debugfilter`` command.

Usage
-----

``enable autohauler``
    Start managing hauling labors. This is normally all you need to do.
    Autohauler works well on default settings.
``autohauler status``
    Show autohauler status and status of fort dwarves.
``autohauler <labor> haulers``
    Set whether a particular labor should be assigned to haulers.
``autohauler <labor> allow|forbid``
    Set whether a particular labor should mark a dwarf as exempt from hauling.
    By default, only the ``ALCHEMIST`` labor is set to ``forbid``.
``autohauler reset-all|<labor> reset``
    Reset a particular labor (or all labors) to their default
    haulers/allow/forbid state.
``autohauler list``
    Show the active configuration for all labors.
``autohauler frameskip <number>``
    Set the number of frames between runs of autohauler.

Examples
--------

``autohauler HAUL_STONE haulers``
    Set stone hauling as a hauling labor (this is already the default).
``autohauler RECOVER_WOUNDED allow``
    Allow the "Recover wounded" labor to be manually assigned by the player. By
    default it is automatically given to haulers.
``autohauler MINE forbid``
    Don't assign hauling labors to dwarves with the Mining labor enabled.
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`autohauler`
			`==========`
update formatting for plugin docs 2022-07-20 00:11:02 -06:00
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00			`.. dfhack-tool::`
			`:summary: Automatically manage hauling labors.`
add untested tag to plugins 2023-01-10 23:26:12 -07:00			`:tags: untested fort auto labors`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
address feedback on the docs 2022-09-28 13:45:57 -06:00			Similar to `autolabor`, but instead of managing all labors, autohauler only
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00			`addresses hauling labors, leaving the assignment of skilled labors entirely up`
			to you. You can use the in-game `manipulator` UI or an external tool like Dwarf
			`Therapist to do so.`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Idle dwarves who are not on active military duty will be assigned the hauling`
			`labors; everyone else (including those currently hauling) will have the hauling`
			`labors removed. This is to encourage every dwarf to do their assigned skilled`
			`labors whenever possible, but resort to hauling when those jobs are not`
			`available. This also implies that the user will have a very tight skill`
			`assignment, with most skilled labors only being assigned to just a few dwarves`
			`and almost every non-military dwarf having at least one skilled labor assigned.`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Autohauler allows a skill to be used as a flag to exempt a dwarf from`
address feedback on the docs 2022-09-28 13:45:57 -06:00			`autohauler's effects. By default, this is the unused ALCHEMIST labor, but it`
update docs for autohauler 2022-07-18 15:33:24 -06:00			`can be changed by the user.`

update documentation for autolabor & autohauler 2022-11-30 20:54:58 -07:00			Autohauler uses DFHack's `debug` functionality to display information about the changes it makes. The amount of
			information displayed can be controlled through appropriate use of the ``debugfilter`` command.

make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`
update docs for autohauler 2022-07-18 15:33:24 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``enable autohauler``
update docs for autolabor 2022-07-18 15:53:06 -06:00			`Start managing hauling labors. This is normally all you need to do.`
			`Autohauler works well on default settings.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler status``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Show autohauler status and status of fort dwarves.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler <labor> haulers``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Set whether a particular labor should be assigned to haulers.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler <labor> allow\|forbid``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Set whether a particular labor should mark a dwarf as exempt from hauling.`
			By default, only the ``ALCHEMIST`` labor is set to ``forbid``.
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler reset-all\|<labor> reset``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Reset a particular labor (or all labors) to their default`
			`haulers/allow/forbid state.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler list``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Show the active configuration for all labors.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler frameskip <number>``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Set the number of frames between runs of autohauler.`

update formatting for plugin docs 2022-07-20 00:11:02 -06:00			`Examples`
			`--------`
fix formatting typos 2022-07-18 17:20:43 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler HAUL_STONE haulers``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Set stone hauling as a hauling labor (this is already the default).`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler RECOVER_WOUNDED allow``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Allow the "Recover wounded" labor to be manually assigned by the player. By`
			`default it is automatically given to haulers.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autohauler MINE forbid``
update docs for autohauler 2022-07-18 15:33:24 -06:00			`Don't assign hauling labors to dwarves with the Mining labor enabled.`