From afd5d0b18466692bf401f1fcdb9bb107eda6d0e6 Mon Sep 17 00:00:00 2001 From: lethosor Date: Sat, 18 Jan 2020 18:49:15 -0500 Subject: [PATCH] Add autofarm docs --- docs/Plugins.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 35eeb61e6..4e7fa0542 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -1862,6 +1862,31 @@ Examples: * ``autoclothing cloth dress``: Displays the currently set number of cloth dresses chosen per citizen. +.. _autofarm: + +autofarm +======== + +Automatically handles crop selection in farm plots based on current plant +stocks, and selects crops for planting if current stock is below a threshold. +Selected crops are dispatched on all farmplots. (Note that this plugin replaces +an older Ruby script of the same name.) + +Use the `enable` or `disable` commands to change whether this plugin is +enabled. + +Usage: + +* ``autofarm runonce``: + Updates all farm plots once, without enabling the plugin +* ``autofarm status``: + Prints status information, including any applied limits +* ``autofarm default 30``: + Sets the default threshold +* ``autofarm threshold 150 helmet_plump tail_pig``: + Sets thresholds of individual plants + + ================ Map modification ================