From 6c3bac2d6caf7382a88a929afa485a4c3f89487a Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sat, 17 Oct 2020 22:20:39 -0700 Subject: [PATCH] document extended zone configuration syntax --- docs/guides/quickfort-user-guide.rst | 53 +++++++++++++++++++--------- 1 file changed, 37 insertions(+), 16 deletions(-) diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index bef85b161..f4b15969a 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -96,6 +96,7 @@ Features created stockpiles - Automatic splitting of stockpiles and zones that exceed maximum dimension limits + - Full access to all zone settings, such as hospital supply counts - Query mode @@ -478,37 +479,57 @@ It is very common to have stockpiles that accept multiple categories of items or zones that permit more than one activity. Although it is perfectly valid to declare a single-purpose stockpile or zone and then modify it with a ``#query`` blueprint, quickfort also supports directly declaring all the types on the -``#place`` and ``#zone`` blueprints. For example, to declare a 10x10 area that -is a pasture, a fruit picking area, and a meeting area all at once, you could -write: +``#place`` and ``#zone`` blueprints. For example, to declare a 20x10 stockpile +that accepts both corpses and refuse, you could write: + +:: + + #place refuse heap + yr(20x10) + + +And similarly, to declare a zone that is a pasture, a fruit picking area, and a +meeting area all at once: :: #zone main pasture and picnic area nmg(10x10) -And similarly, to declare a stockpile that accepts both corpses and refuse, you -could write: +The order of the individual letters doesn't matter. + +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 +to set configuration from multiple zone subscreens, separate the key sections +with ``^``. Note the special syntax for setting hospital supply levels, which +have no in-game hotkeys: :: - #place refuse heap - yr(20x10) + #zone a combination hospital and shrub (but not fruit) gathering zone + gGtf^hH{hospital buckets=5 splints=20}(10x10) -The order of the individual letters doesn't matter. +The valid hospital settings (and their maximum values) are: +:: + + thread (1500000) + cloth (1000000) + splints (100) + crutches (100) + powder (15000) + buckets (100) + soap (15000) + To toggle the ``active`` flag for zones, add an ``a`` character to the string. -For example, to create a *disabled* pit zone (that you later intend to turn into -a pond and carefully fill to 3-depth water): +For example, to create a *disabled* pond zone (that you later intend to +carefully fill with 3-depth water for a dwarven bathtub): :: - #zone disabled future pond zone - pa(1x3) - -Note that while this notation covers most use cases, tweaking low-level zone -parameters, like hospital supply levels or converting between pits and ponds, -must still be done manually or with a ``#query`` blueprint. + #zone disabled pond zone + apPf(1x3) Minecart tracks ~~~~~~~~~~~~~~~