dfhack/docs/plugins/autofarm.rst

autofarm
========

.. dfhack-tool::
    :summary: Automatically manage farm crop selection.
    :tags: fort auto plants

Periodically scan your plant stocks and assign crops to your farm plots based on
which plant stocks are low (as long as you have the appropriate seeds). The
target threshold for each crop type is configurable.

Usage:

``enable autofarm``
    Enable the plugin and start managing crop assignment.
``autofarm runonce``
    Updates all farm plots once, without enabling the plugin.
``autofarm status``
    Prints status information, including any defined thresholds.
``autofarm default <number>``
    Sets the default threshold.
``autofarm threshold <number> <type> [<type> ...]``
    Sets thresholds of individual plant types.

You can find the identifiers for the crop types in your world by running the
following command::

    lua "for _,plant in ipairs(df.global.world.raws.plants.all) do if plant.flags.SEED then print(plant.id) end end"

Examples
--------

``autofarm default 30``
    Set the default threshold to 30.
``autofarm threshold 150 MUSHROOM_HELMET_PLUMP GRASS_TAIL_PIG``
    Set the threshold for Plump Helmets and Pig Tails to 150
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`autofarm`
			`========`
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 farm crop selection.`
revise tag list and assignments 2022-08-12 00:34:37 -06:00			`:tags: fort auto plants`
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
			`Periodically scan your plant stocks and assign crops to your farm plots based on`
			`which plant stocks are low (as long as you have the appropriate seeds). The`
			`target threshold for each crop type is configurable.`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
			`Usage:`

update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``enable autofarm``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Enable the plugin and start managing crop assignment.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm runonce``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Updates all farm plots once, without enabling the plugin.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm status``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Prints status information, including any defined thresholds.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm default <number>``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Sets the default threshold.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm threshold <number> <type> [<type> ...]``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Sets thresholds of individual plant types.`

			`You can find the identifiers for the crop types in your world by running the`
			`following command::`

			`lua "for _,plant in ipairs(df.global.world.raws.plants.all) do if plant.flags.SEED then print(plant.id) end end"`

update formatting for plugin docs 2022-07-20 00:11:02 -06:00			`Examples`
			`--------`
update docs for autofarm 2022-07-18 14:49:51 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm default 30``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Set the default threshold to 30.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``autofarm threshold 150 MUSHROOM_HELMET_PLUMP GRASS_TAIL_PIG``
update docs for autofarm 2022-07-18 14:49:51 -06:00			`Set the threshold for Plump Helmets and Pig Tails to 150`