MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fetch and merge

develop
Ryan Williams 2022-06-05 16:55:54 -07:00
parent ce36abce47 7b2cb8f9a6
commit 30ed483e1d
3 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
data/blueprints/library/aquifer_tap.csv
Unescape Escape View File

@ -5,21 +5,21 @@ Here's the procedure:
"" ""
1) Dig a tunnel from where you want the water to end up (e.g. your well cistern) off to an unused portion of the map. Be sure to dig a one-tile-wide diagonal segment in this tunnel so water that will eventually flow through the tunnel is depressurized. 1) Dig a tunnel from where you want the water to end up (e.g. your well cistern) off to an unused portion of the map. Be sure to dig a one-tile-wide diagonal segment in this tunnel so water that will eventually flow through the tunnel is depressurized.
"" ""
"2) From the end of that tunnel, dig a staircase straight up to the z-level just below the lowest aquifer level. Also dig the staircase down one z-level." "2) From the end of that tunnel, dig a staircase straight up to the z-level just below the lowest aquifer level. Also dig the staircase down one z-level below the tunnel level."
"" ""
"3) From the bottom of the staircase (the z-level below where the water will flow to your cisterns), dig a straight, one-tile wide tunnel to the edge of the map. Smooth the map edge tile and carve a fortification. The water can flow through the fortification and off the map, allowing the dwarves to dig out the aquifer tap without drowning." "3) From the bottom of the staircase (the z-level below where the water will flow to your cisterns), dig a straight, one-tile wide tunnel to the edge of the map. This is your drainage tunnel. Smooth the map edge tile and carve a fortification. The water can flow through the fortification and off the map, allowing the dwarves to dig out the aquifer tap without drowning."
"" ""
4) Place a lever-controlled floodgate in the drainage tunnel and open the floodgate. 4) Place a lever-controlled floodgate in the drainage tunnel and open the floodgate. Place the lever somewhere else in your fort so that it will remain dry and accessible.
"" ""
"5) If you care about how nice things look, haul away any boulders and smooth the tiles. You won't be able to access any of this area once it fills up with water!" "5) If you care about how nice things look, haul away any boulders in the tunnels and smooth the tiles. You won't be able to access any of this area once it fills up with water!"
"" ""
"6) Apply this blueprint (quickfort run library/aquifer_tap.csv -n /dig) to the z-level above the top of the staircase, inside the lowest aquifer level. Do not unpause until after the next step." "6) Apply this blueprint (gui/quickfort library/aquifer_tap.csv -n /dig) to the z-level above the top of the staircase, inside the lowest aquifer level. Do not unpause until after the next step."
"" ""
"7) Damp tiles cancel dig designations if the tile is currently hidden, so to avoid having to re-apply this blueprint after every tile your dwarves dig, position the cursor straight up (north) of the left-most tile designated for digging and straight left (west) of the topmost designated tile and run the following commands in the DFHack console:" "7) Damp tiles cancel dig designations if the tile is currently hidden, so to avoid having to re-apply this blueprint after every tile your dwarves dig, position the cursor straight up (north) of the left-most tile designated for digging and straight left (west) of the topmost designated tile and run the following commands in the DFHack console:"
tiletypes-command f any ; f designated 1 ; p any ; p hidden 0 ; r 23 23 1 tiletypes-command f any ; f designated 1 ; p any ; p hidden 0 ; r 23 23 1
tiletypes-here tiletypes-here
"" ""
"8) Unpause and dig out the tap. If you care about appearances, haul away any boulders and feel free to remove the ramps (d-z). The water will safely flow down the staircase, through the open floodgate, and off the map until you choose to close the floodgate." "8) Unpause and dig out the tap. If you care about appearances, haul away any boulders and feel free to remove the ramps (d-z). The water will safely flow down the staircase, through the open floodgate, down the drainage tunnel, and off the map until you choose to close the floodgate."
"9) Once everything is dug out and all dwarves are out of the waterways, close the floodgate. Your cisterns will fill with water. Since the waterway to your cisterns is depressurized, the cisterns will stay forever full, but will not flood." "9) Once everything is dug out and all dwarves are out of the waterways, close the floodgate. Your cisterns will fill with water. Since the waterway to your cisterns is depressurized, the cisterns will stay forever full, but will not flood."
"" ""

1 #notes label(help)
5
6 1) Dig a tunnel from where you want the water to end up (e.g. your well cistern) off to an unused portion of the map. Be sure to dig a one-tile-wide diagonal segment in this tunnel so water that will eventually flow through the tunnel is depressurized.
7
8 2) From the end of that tunnel, dig a staircase straight up to the z-level just below the lowest aquifer level. Also dig the staircase down one z-level. 2) From the end of that tunnel, dig a staircase straight up to the z-level just below the lowest aquifer level. Also dig the staircase down one z-level below the tunnel level.
9
10 3) From the bottom of the staircase (the z-level below where the water will flow to your cisterns), dig a straight, one-tile wide tunnel to the edge of the map. Smooth the map edge tile and carve a fortification. The water can flow through the fortification and off the map, allowing the dwarves to dig out the aquifer tap without drowning. 3) From the bottom of the staircase (the z-level below where the water will flow to your cisterns), dig a straight, one-tile wide tunnel to the edge of the map. This is your drainage tunnel. Smooth the map edge tile and carve a fortification. The water can flow through the fortification and off the map, allowing the dwarves to dig out the aquifer tap without drowning.
11
12 4) Place a lever-controlled floodgate in the drainage tunnel and open the floodgate. 4) Place a lever-controlled floodgate in the drainage tunnel and open the floodgate. Place the lever somewhere else in your fort so that it will remain dry and accessible.
13
14 5) If you care about how nice things look, haul away any boulders and smooth the tiles. You won't be able to access any of this area once it fills up with water! 5) If you care about how nice things look, haul away any boulders in the tunnels and smooth the tiles. You won't be able to access any of this area once it fills up with water!
15
16 6) Apply this blueprint (quickfort run library/aquifer_tap.csv -n /dig) to the z-level above the top of the staircase, inside the lowest aquifer level. Do not unpause until after the next step. 6) Apply this blueprint (gui/quickfort library/aquifer_tap.csv -n /dig) to the z-level above the top of the staircase, inside the lowest aquifer level. Do not unpause until after the next step.
17
18 7) Damp tiles cancel dig designations if the tile is currently hidden, so to avoid having to re-apply this blueprint after every tile your dwarves dig, position the cursor straight up (north) of the left-most tile designated for digging and straight left (west) of the topmost designated tile and run the following commands in the DFHack console:
19 tiletypes-command f any ; f designated 1 ; p any ; p hidden 0 ; r 23 23 1
20 tiletypes-here
21
22 8) Unpause and dig out the tap. If you care about appearances, haul away any boulders and feel free to remove the ramps (d-z). The water will safely flow down the staircase, through the open floodgate, and off the map until you choose to close the floodgate. 8) Unpause and dig out the tap. If you care about appearances, haul away any boulders and feel free to remove the ramps (d-z). The water will safely flow down the staircase, through the open floodgate, down the drainage tunnel, and off the map until you choose to close the floodgate.
23 9) Once everything is dug out and all dwarves are out of the waterways, close the floodgate. Your cisterns will fill with water. Since the waterway to your cisterns is depressurized, the cisterns will stay forever full, but will not flood.
24
25 A diagram might be useful. Here is a vertical view through the z-levels. This blueprint goes at the top:

22
data/blueprints/library/pump_stack.csv
Unescape Escape View File

@ -1,23 +1,23 @@
#notes label(help) #notes label(help)
A pump stack is useful for moving water or magma up through the z-levels. A pump stack is useful for moving water or magma up through the z-levels.
"" ""
To use these blueprints: "These blueprints can be used from the quickfort commandline, but are much easier to use with the visual interface. That way you can check the vertical path interactively before you apply. Run gui/quickfort pump_stack"
"" ""
1) Measure how many z-levels the pump stack should span. "1) Select the ""dig"" blueprint and position the blueprint preview on the bottom level of the future pump stack. It should be on the z-level just above the liquid you want to pump."
"" ""
"2) Position the cursor on the bottom level of the future pump stack. It should be on the z-level just above the liquid you want to pump. Run ""quickfort run library/pump_stack.csv -n /dig2SN"" to see where the suction hole will end up. Replace ""run"" with ""undo"" in the previous command to clean up." "2) Enable repetitions with the ""R"" hotkey and lock the blueprint in place with the ""L"" hotkey. Move up the z-levels to check that the pump stack has a clear path and doesn't intersect with any open areas (e.g. caverns). Increase the number of repetitions with the ""+"" or ""*"" hotkeys if you need the pump stack to extend further up. Unlock the blueprint and shift it around if you need to, then lock it again to recheck the vertical path."
"" ""
"3) If you need an East-West pump stack, or if you need the staircase in another spot, use the ""--transform"" commandline option to alter the blueprint to your needs. For example: ""quickfort run library/pump_stack.csv -n /dig2SN --transform rotcw,fliph"". If you use a transformation, be sure to use the same option for the remaining commandlines." "3) If you need to flip the pump stack around to make it fit through the rock layers, enable transformations with the ""t"" hotkey and rotate/flip the blueprint with Ctrl+arrow keys."
"" ""
"4) Once you have everything lined up, run ""quickfort run library/pump_stack.csv -n /dig2SN --repeat up,20"" to designate the entire pump stack for digging. Replace that last ""20"" with the height of your pump stack divided by 2 (since each repetition of /dig2SN is two z-levels high). If the height ends up being one too many at the top, manually undesignate the top level." "4) Once you have everything lined up, hit Enter to apply. If the height ends up being one too many at the top, manually undesignate the top level."
"" ""
"5) Since you do not need to transmit power down below the lowest level, replace the channel designation on the middle tile of the bottom-most pump stack level with a regular dig designation. Likewise, replace the Up/Down staircase designation on the lowest level with an Up staircase designation." "5) Since you do not need to transmit power down below the lowest level, replace the channel designation on the middle tile of the bottom-most pump stack level with a regular dig designation. Likewise, replace the Up/Down staircase designation on the lowest level with an Up staircase designation. Otherwise you might get magma critters climbing up through your access stairway!"
"" ""
"6) After the stack is dug out, prepare for building by setting the buildingplan plugin material filters for screw pumps (b-M-s-M). If you are planning to move magma, be sure to select magma-safe materials." "6) After the stack is dug out, prepare for building by setting the buildingplan plugin material filters for screw pumps (b-M-s-M). If you are planning to move magma, be sure to select magma-safe materials (like green glass) for all three components of the screw pump."
"" ""
"7) Finally, position the cursor back on the access stairs on the lowest level and run ""quickfort run library/pump_stack.csv -n /build2SN --repeat up,20"" (with 20 replaced with your desired repetition count and with your --transform command, if any)." "7) Finally, position the cursor back on the access stairs on the lowest level and run the ""build"" blueprint with the same repetition and transformation settings that you used for the ""dig"" blueprint. As you manufacture the materials you need to construct the screw pumps, your dwarves will build the pump stack from the bottom up."
"" ""
"Sometimes, a screw pump will spontaneously deconstruct while you are building the stack. This will reduce the efficiency of the stack a little, but it's nothing to worry about. Just re-run the /build2SN blueprint over the entire stack to ""fix up"" any broken pieces. The blueprint will harmlessly skip over any correctly-built screw pumps." "Sometimes, a screw pump will spontaneously deconstruct while you are building the stack. This will reduce the efficiency of the stack a little, but it's nothing to worry about. Just re-run the ""build"" blueprint over the entire stack to ""fix up"" any broken pieces. The blueprint will harmlessly skip over any correctly-built screw pumps."
"" ""
See the wiki for more info on pump stacks: https://dwarffortresswiki.org/index.php/Screw_pump#Pump_stack See the wiki for more info on pump stacks: https://dwarffortresswiki.org/index.php/Screw_pump#Pump_stack
#dig label(digSN) start(2;4;on access stairs) hidden() for a pump from south level #dig label(digSN) start(2;4;on access stairs) hidden() for a pump from south level
@ -34,7 +34,7 @@ See the wiki for more info on pump stacks: https://dwarffortresswiki.org/index.p
,i,,h ,i,,h
,,,d ,,,d
#meta label(dig2SN) start(at the bottom level on the access stairs) 2 levels of pump stack - bottom level pumps from the south #meta label(dig) start(at the bottom level on the access stairs) 2 levels of pump stack - bottom level pumps from the south
/digSN /digSN
#< #<
/digNS /digNS
@ -52,7 +52,7 @@ See the wiki for more info on pump stacks: https://dwarffortresswiki.org/index.p
,`,,Msu ,`,,Msu
,,,` ,,,`
#meta label(build2SN) start(at the bottom level on the access stairs) 2 levels of pump stack - bottom level pumps from the south #meta label(build) start(at the bottom level on the access stairs) 2 levels of pump stack - bottom level pumps from the south
/buildSN /buildSN
#< #<
/buildNS /buildNS

Can't render this file because it has a wrong number of fields in line 25.

25
docs/guides/quickfort-library-guide.rst
Unescape Escape View File

@ -7,10 +7,12 @@ Blueprint Library Index
This guide contains a high-level overview of the blueprints available in the This guide contains a high-level overview of the blueprints available in the
:source:`quickfort blueprint library <data/blueprints/library>`. You can list :source:`quickfort blueprint library <data/blueprints/library>`. You can list
library blueprints by running ``quickfort list --library`` or by hitting library blueprints by running ``quickfort list --library`` or by hitting
:kbd:`Alt`:kbd:`l` in the ``quickfort gui`` interactive dialog. :kbd:`Alt`:kbd:`l` in the ``gui/quickfort`` file load dialog.
Each file is hyperlinked to its online version so you can see exactly what the Each file is hyperlinked to its online version so you can see exactly what the
blueprints do before you run them. blueprints do before you run them. Also, if you use `gui/quickfort`, you will
get a live preview of which tiles will be modified by the blueprint before you
apply it to your map.
Whole fort blueprint sets Whole fort blueprint sets
------------------------- -------------------------
@ -34,7 +36,7 @@ automate basic fort needs, such as food, booze, and item production. It can
function by itself or as the core of a larger, more ambitious fortress. Read the function by itself or as the core of a larger, more ambitious fortress. Read the
high-level walkthrough by running ``quickfort run library/dreamfort.csv`` and high-level walkthrough by running ``quickfort run library/dreamfort.csv`` and
list the walkthroughs for the individual levels by running ``quickfort list -l list the walkthroughs for the individual levels by running ``quickfort list -l
dreamfort -m notes`` or ``quickfort gui -l dreamfort notes``. dreamfort -m notes`` or ``gui/quickfort dreamfort notes``.
Dreamfort blueprints are available for easy viewing and copying `online Dreamfort blueprints are available for easy viewing and copying `online
<https://drive.google.com/drive/folders/1iS90EEVqUkxTeZiiukVj1pLloZqabKuP>`__. <https://drive.google.com/drive/folders/1iS90EEVqUkxTeZiiukVj1pLloZqabKuP>`__.
@ -47,14 +49,14 @@ and a convenient `checklist
<https://docs.google.com/spreadsheets/d/13PVZ2h3Mm3x_G1OXQvwKd7oIR2lK4A1Ahf6Om1kFigw/edit#gid=1459509569>`__ <https://docs.google.com/spreadsheets/d/13PVZ2h3Mm3x_G1OXQvwKd7oIR2lK4A1Ahf6Om1kFigw/edit#gid=1459509569>`__
from which you can copy the ``quickfort`` commands. from which you can copy the ``quickfort`` commands.
You can download a fully built Dreamfort-based fort from `dffd If you like, you can download a fully built Dreamfort-based fort from `dffd
<https://dffd.bay12games.com/file.php?id=15434>`__, load it, and explore it <https://dffd.bay12games.com/file.php?id=15434>`__, load it, and explore it
interactively. interactively.
Visual overview Visual overview
``````````````` ```````````````
Here are some annotated screenshots of the major levels (or click `here Here are annotated screenshots of the major Dreamfort levels (or click `here
<https://drive.google.com/drive/folders/14KdE2E2wQKj4F_E-NAe3G3E4x1wiWtrc>`__ <https://drive.google.com/drive/folders/14KdE2E2wQKj4F_E-NAe3G3E4x1wiWtrc>`__
for a slideshow). for a slideshow).
@ -136,7 +138,8 @@ The Quick Fortress is an updated version of the example fortress that came with
inspired DFHack quickfort). While it is not a complete fortress by inspired DFHack quickfort). While it is not a complete fortress by
itself, it is much simpler than Dreamfort and is good for a first introduction itself, it is much simpler than Dreamfort and is good for a first introduction
to `quickfort` blueprints. Read its walkthrough with ``quickfort run to `quickfort` blueprints. Read its walkthrough with ``quickfort run
library/quickfortress.csv``. library/quickfortress.csv`` or view the blueprints `online
<https://docs.google.com/spreadsheets/d/1WuLYZBM6S2nt-XsPS30kpDnngpOQCuIdlw4zjrcITdY>`__.
Layout helpers Layout helpers
-------------- --------------
@ -205,8 +208,8 @@ running ``quickfort run library/aquifer_tap.csv -n /help``.
You can see how to nullify the water pressure (so you don't flood your fort) in You can see how to nullify the water pressure (so you don't flood your fort) in
the `Dreamfort screenshot above <example-plumbing-to-fill-cisterns>`. the `Dreamfort screenshot above <example-plumbing-to-fill-cisterns>`.
Blueprint spreadsheet also available The blueprint spreadsheet is also available
`online <https://docs.google.com/spreadsheets/d/1kwuCipF9FYAHNP9C_XlMpqVseaPu4SmL9YLUSQkbW4s/edit#gid=611877584>`__ `online <https://docs.google.com/spreadsheets/d/1kwuCipF9FYAHNP9C_XlMpqVseaPu4SmL9YLUSQkbW4s/edit#gid=611877584>`__.
Post-embark Post-embark
~~~~~~~~~~~ ~~~~~~~~~~~
@ -219,9 +222,9 @@ starting stockpiles.
Pump Stack Pump Stack
~~~~~~~~~~ ~~~~~~~~~~
The pump stack blueprints help you move water and magma up to move convenient The pump stack blueprints help you move water and magma up to more convenient
locations in your fort. See the step-by-step guide for using it by running locations in your fort. See the step-by-step guide for using it by running
``quickfort run library/pump_stack.csv -n /help``. ``quickfort run library/pump_stack.csv -n /help``.
Blueprint spreadsheet also available The blueprint spreadsheet is also available
`online <https://docs.google.com/spreadsheets/d/1TP2n-W-O9f30Dtl6yoTcn6yczWQRu11iM7U6TEE9634/edit#gid=0>`__ `online <https://docs.google.com/spreadsheets/d/1TP2n-W-O9f30Dtl6yoTcn6yczWQRu11iM7U6TEE9634/edit#gid=0>`__.