From 824beb0253308adc05bad9bb2c210a97baed109c Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 1 Feb 2021 02:22:04 -0800 Subject: [PATCH 1/4] documentation for bin/barrel/wb feature --- docs/guides/quickfort-user-guide.rst | 34 ++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 8be74ac51..39e65b5fc 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -476,6 +476,40 @@ stockpiles using the keys that represent the categories of items that you want to store, and then only use a ``#query`` blueprint if you need fine-grained customization. +Stockpile bins, barrels, and wheelbarrows +````````````````````````````````````````` + +Quickfort has global settings for default values for the number of bins, +barrels, and wheelbarrows assigned to stockpiles, but these numbers can be set +for individual stockpiles as well. + +To set the number of bins, barrels, or wheelbarrows, just add a number after the +letter that indicates what type of stockpile it is. For example:: + + #place a stone stockpile with 5 wheelbarrows + s5(3x3) + + #place a bar, ammo, weapon, and armor stockpile with 20 bins + bzpd20(5x5) + +If the specified number exceeds the number of available stockpile tiles, the +number of available tiles is used. For wheelbarrows, that limit is reduced by 1 +to ensure there is at least one non-wheelbarrow tile available in the stockpile. +Otherwise no stone would ever be brought to the stockpile since all tiles would +be occupied by wheelbarrows! + +Quickfort figures out which container type is being set by looking at the letter +that comes just before the number. For example ``zf10`` means 10 barrels in a +stockpile that accepts both ammo and food whereas ``z10f`` means 10 bins. If +the stockpile category doesn't usually use any container type, like refuse or +corpses, wheelbarrows are assumed:: + + #place a corpse stockpile with 3 wheelbarrows + y3(3x3) + +Zone detailed configuration +``````````````````````````` + Detailed configuration for zones, such as the pit/pond toggle, can also be set by mimicking the hotkeys used to set them. Note that gather flags default to true, so specifying them in a blueprint will turn the toggles off. If you need From 13fae4628b20ecf59813dde60d7e0f0968322472 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 5 Feb 2021 17:05:34 -0800 Subject: [PATCH 2/4] add docs for #place-generated manager orders --- docs/guides/quickfort-user-guide.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 39e65b5fc..95f4b6a20 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -507,6 +507,16 @@ corpses, wheelbarrows are assumed:: #place a corpse stockpile with 3 wheelbarrows y3(3x3) +Running ``quickfort orders`` on a ``#place`` blueprint with explicitly set +container/wheelbarrow counts will enqueue manager orders for the specified +number of containers or wheelbarrows, even if that number exceeds the in-game +size of the stockpile. For example, ``quickfort orders`` on the following +blueprint will enqueue 10 rock pots, even though the stockpile only has 9 +tiles:: + + #place + f10(3x3) + Zone detailed configuration ``````````````````````````` From 4790e23a5cace42e6f0b020115306fe76bb9a51a Mon Sep 17 00:00:00 2001 From: myk002 Date: Sat, 13 Feb 2021 07:46:45 -0800 Subject: [PATCH 3/4] add more docs for quickfort orders --- docs/guides/quickfort-user-guide.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 95f4b6a20..a2f367ca7 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -476,6 +476,8 @@ stockpiles using the keys that represent the categories of items that you want to store, and then only use a ``#query`` blueprint if you need fine-grained customization. +.. _quickfort-place-containers: + Stockpile bins, barrels, and wheelbarrows ````````````````````````````````````````` @@ -1126,8 +1128,11 @@ to use for blocks. You should also set the `buildingplan` material filter for construction building types to that type of rock as well so other random blocks you might have lying around aren't used. -There are a few building types that will generate extra manager orders for -related materials: +Extra Manager Orders +~~~~~~~~~~~~~~~~~~~~ + +In ``#build`` blueprints, there are a few building types that will generate +extra manager orders for related materials: - Track stops will generate an order for a minecart - Traction benches will generate orders for a table, mechanism, and rope @@ -1135,6 +1140,11 @@ related materials: lever to a target - Cage traps will generate an order for a cage + +Stockpiles in ``#place`` blueprints that `specify wheelbarrow or container +counts ` will generate orders for the appropriate +number of bins, pots, or wheelbarrows. + Tips and tricks --------------- From 3278519c98f4d364b8ff97a1b61d8a3ef8543ecb Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 19 Feb 2021 11:43:10 -0800 Subject: [PATCH 4/4] document how to specify containers for stockpiles that are not specified with expansion syntax --- docs/guides/quickfort-user-guide.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index a2f367ca7..3af2a1920 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -509,6 +509,16 @@ corpses, wheelbarrows are assumed:: #place a corpse stockpile with 3 wheelbarrows y3(3x3) +Note that if you are not using expansion syntax, each tile of the stockpile must +have the same text. Otherwise the stockpile boundaries will not be detected +properly:: + + #place a non-rectangular animal stockpile with 5 wheelbarrows + a5,a5,a5,a5 + a5, , ,a5 + a5, , ,a5 + a5,a5,a5,a5 + Running ``quickfort orders`` on a ``#place`` blueprint with explicitly set container/wheelbarrow counts will enqueue manager orders for the specified number of containers or wheelbarrows, even if that number exceeds the in-game