Merge remote-tracking branch 'myk002/quickfort_no_materials' into develop

data/blueprints/README.md

@@ -428,7 +428,7 @@ Modeline optional markers
 The modeline has some additional optional components that we haven't talked about yet. You can:
 
 * give a blueprint a label by adding a `label()` marker
-* set a cursor offset by adding a `start()` marker
+* set a cursor offset and/or start hint by adding a `start()` marker
 * hide a blueprint with a `hidden()` marker
 * register a message to be displayed after the blueprint is successfully applied
 
@@ -441,7 +441,7 @@ Note that all elements are optional except for the initial `#mode`. Here are a f
     #dig start(3; 3; Center tile of a 5-tile square) Regular blueprint comment
     #build label(noblebedroom) start(10;15)
     #query label(configstockpiles) No explicit start()  means cursor is at upper left corner
-    #meta label(digwholefort)
+    #meta label(digwholefort) start(center of stairs on surface)
     #dig label(digdining) hidden() managed by the digwholefort meta blueprint
     #zone label(pastures) message(remember to assign animals to the new pastures)
 
@@ -453,7 +453,7 @@ Labels are displayed in the `quickfort list` output and are used for addressing
 
 Start positions specify a cursor offset for a particular blueprint, simplifying the task of blueprint alignment. This is very helpful for blueprints that are based on a central staircase, but it helps whenever a blueprint has an obvious "center". For example:
 
-    #build start(2;2;center of workshop) a mason workshop
+    #build start(2;2;center of workshop) label(masonw) a mason workshop
     wm wm wm #
     wm wm wm #
     wm wm wm #
@@ -461,7 +461,10 @@ Start positions specify a cursor offset for a particular blueprint, simplifying
 
 will build the workshop *centered* on the cursor, not down and to the right of the cursor.
 
-The two numbers specify the column and row (or X and Y offset) where the cursor is expected to be when you apply the blueprint. Position 1;1 is the top left cell. The optional comment will show up in the `quickfort list` output and should contain information about where to position the cursor.
+The two numbers specify the column and row (or X and Y offset) where the cursor is expected to be when you apply the blueprint. Position 1;1 is the top left cell. The optional comment will show up in the `quickfort list` output and should contain information about where to position the cursor. If the start position is 1;1, you can omit the numbers and just add a comment describing where to put the cursor. This is useful for meta blueprints that refer to other blueprints that have fully-specified start() markers. For example, a meta blueprint that refers to the `masonw` blueprint above could look like this:
+
+    #meta start(center of workshop) a mason workshop
+    /masonw
 
 ### Hiding blueprints ###
 
@@ -469,8 +472,10 @@ A blueprint with a `hidden()` marker won't appear in `quickfort list` output unl
 
 ### Messages ###
 
-A blueprint with a `message()` marker will display a message after the blueprint is applied. This is useful for reminding players to take manual steps that cannot be automated, like assigning animals to a pasture or assigning minecarts to a route.
+A blueprint with a `message()` marker will display a message after the blueprint is applied with `quickfort run`. This is useful for reminding players to take manual steps that cannot be automated, like assigning animals to a pasture or assigning minecarts to a route, or listing the next step in a series of blueprints. For long or multi-part messages, it is fine to embed newlines:
 
+    "#meta label(surface1) message(This would be a good time to start digging the industry level.
+    Once the area is clear, continue with /surface2.) clear the embark site and set up pastures"
 
 Packaging a set of blueprints
 -----------------------------
@@ -631,7 +636,8 @@ There are a few building types that will generate extra manager orders for relat
 
 - Track stops will generate an order for a minecart
 - Traction benches will generate orders for a table, mechanism, and rope
-- Levers will generate orders for two mechanisms for connecting the lever to a target, in addition to the mechanism required to build the lever itself
+- Levers will generate orders for extra two mechanisms for connecting the lever to a target
+- Cage traps will generate an order for a cage
 
 
 Tips and tricks
@@ -641,6 +647,8 @@ Tips and tricks
 
 * After digging out an area, you may wish to smooth and/or engrave the area before starting the build phase, as dwarves may be unable to access walls or floors that are behind/under built objects.
 
+* If you are designating more than one level for digging at a time, you can make your miners more efficient by using marker mode (`dM`) on all levels but one. This prevents your miners from digging out a few tiles on one level, then running down/up the stairs to do a few tiles on an adjacent level. With only one level "live" and all other levels in marker mode, your miners can concentrate on one level at a time. You just have to rememer to "unmark" a new level when your miners are done with their current one.
+
 * As of DF 0.34.x, it is no longer possible to build doors (d) at the same time that you build adjacent walls (Cw). Doors must now be built *after* walls are constructed for them to be next to. This does not affect the more common case where walls exist as a side-effect of having dug-out a room in a #dig blueprint.
 
 
@@ -651,6 +659,8 @@ Caveats and limitations
 
 * If you use the `jugs` alias in your `#query`-mode blueprints, be aware that there is no way to differentiate jugs from other types of tools in the game. Therefore, `jugs` stockpiles will also take nest boxes and other tools. The only workaround is not to have other tools lying around in your fort.
 
+* Likewise for bags. The game does not differentiate between empty and full bags, so you'll get gabs of gypsum power and sand in your bags stockpile unless you avoid collecting sand and are careful to assign all your gypsum to your hospital.
+
 * Weapon traps and upright spear/spikes can currently only be built with a single weapon.
 
 * Pressure plates can be built, but they cannot be configured yet.

data/quickfort/aliases-common.txt

@@ -69,14 +69,15 @@ animalsprefix:  s
 enableanimals:  {animalsprefix}e^
 disableanimals: {animalsprefix}d^
 
-# enables only the specified type (and disables everything else)
 cages: {animalsprefix}bu^
 traps: {animalsprefix}bj^
 
-# forbids specific items in an already-configured stockpile
 forbidcages: {animalsprefix}u^
 forbidtraps: {animalsprefix}j^
 
+permitcages: {forbidcages}
+permittraps: {forbidtraps}
+
 
 ##################################
 # food stockpile adjustments

data/quickfort/materials-common.txt

@@ -1,8 +0,0 @@
-# quickfort materials common baseline configuration file
-#
-# Defines forbidden materials and material preferences for build blueprints.
-# Please DO NOT EDIT this file directly. Instead, custom materials preferences
-# should be added to dfhack-config/quickfort/materials.txt.
-#
-# Syntax TBD
-

dfhack-config/quickfort/aliases.txt

@@ -73,11 +73,10 @@
 # brackets:
 #   &   expands to {Enter}
 #   @   expands to {Shift}{Enter}
-#   +   expands to {Shift}
 #   ~   expands to {Alt}
 #   !   expands to {Ctrl}
 #   ^   expands to {ESC}
 #
 # If you need literal verisons of the shorthand characters, surround them in
-# curly brackets, for example: "{+}"
+# curly brackets, for example: "{~}"
 #

dfhack-config/quickfort/materials.txt

@@ -1,9 +0,0 @@
-# quickfort materials preference configuration file
-#
-# Defines forbidden materials and material preferences for build blueprints.
-# Settings in this file take precedence over any settings in the baseline
-# materials configuration file at hack/data/quickfort/materials-common.txt. See
-# that file to view the global defaults.
-#
-# Syntax TBD
-

dfhack-config/quickfort/quickfort.txt

@@ -11,6 +11,12 @@
 # path. If set to a relative path, resolves to a directory under the DF folder.
 blueprints_dir=blueprints
 
+# Force all blueprint buildings that could be built with any building material
+# to only use blocks. The prevents logs, boulders, and bars (e.g. potash and
+# coal) from being wasted on constructions. If set to false, buildings will be
+# built with any available building material.
+buildings_use_blocks=true
+
 # Set to "true" or "false". If true, will designate dig blueprints in marker
 # mode. If false, only cells with dig codes explicitly prefixed with an "m" will
 # be designated in marker mode.