From 42c35b05cc8e30bff3bbf5654af3165bcc921ab8 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 3 Jun 2022 17:02:01 -0700 Subject: [PATCH 1/4] update help text for library blueprints refer users to gui/blueprint for interactive positioning --- data/blueprints/library/aquifer_tap.csv | 13 +++++++------ data/blueprints/library/pump_stack.csv | 22 +++++++++++----------- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/data/blueprints/library/aquifer_tap.csv b/data/blueprints/library/aquifer_tap.csv index 22025d8e7..649e9161e 100644 --- a/data/blueprints/library/aquifer_tap.csv +++ b/data/blueprints/library/aquifer_tap.csv @@ -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. "" -"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:" tiletypes-command f any ; f designated 1 ; p any ; p hidden 0 ; r 23 23 1 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." "" @@ -58,3 +58,4 @@ u <- drainage level ,,,,,r,r,r,r,r,r,r,r,r,r,r,r,r,r,r ,,,,,,,,,,,,r ,,,,,,,,,,,,r + diff --git a/data/blueprints/library/pump_stack.csv b/data/blueprints/library/pump_stack.csv index c49a2c310..6bd129308 100644 --- a/data/blueprints/library/pump_stack.csv +++ b/data/blueprints/library/pump_stack.csv @@ -1,23 +1,23 @@ #notes label(help) 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 #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 ,,,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 #< /digNS @@ -52,7 +52,7 @@ See the wiki for more info on pump stacks: https://dwarffortresswiki.org/index.p ,`,,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 #< /buildNS From 3928bb67d7fbff07703286f8d4831b6631ff3947 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 3 Jun 2022 17:15:57 -0700 Subject: [PATCH 2/4] promote gui/quickfort in the library guide also add a link to the TheQuickFortress online spreadsheets --- docs/guides/quickfort-library-guide.rst | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/guides/quickfort-library-guide.rst b/docs/guides/quickfort-library-guide.rst index 366272052..2f9b3a06f 100644 --- a/docs/guides/quickfort-library-guide.rst +++ b/docs/guides/quickfort-library-guide.rst @@ -7,10 +7,12 @@ Blueprint Library Index This guide contains a high-level overview of the blueprints available in the :source:`quickfort blueprint library `. You can list 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 -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 ------------------------- @@ -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 high-level walkthrough by running ``quickfort run library/dreamfort.csv`` and 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 `__. @@ -47,14 +49,14 @@ and a convenient `checklist `__ 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 `__, load it, and explore it interactively. 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 `__ 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 itself, it is much simpler than Dreamfort and is good for a first introduction to `quickfort` blueprints. Read its walkthrough with ``quickfort run -library/quickfortress.csv``. +library/quickfortress.csv`` or view the blueprints `online +`__. 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 the `Dreamfort screenshot above `. -Blueprint spreadsheet also available -`online `__ +The blueprint spreadsheet is also available +`online `__. Post-embark ~~~~~~~~~~~ @@ -219,9 +222,9 @@ starting stockpiles. 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 ``quickfort run library/pump_stack.csv -n /help``. -Blueprint spreadsheet also available -`online `__ +The blueprint spreadsheet is also available +`online `__. From 1424e8c867f8b7d3be31c339e113ae33c173f928 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 3 Jun 2022 17:19:11 -0700 Subject: [PATCH 3/4] remove extra EOF newline --- data/blueprints/library/aquifer_tap.csv | 1 - 1 file changed, 1 deletion(-) diff --git a/data/blueprints/library/aquifer_tap.csv b/data/blueprints/library/aquifer_tap.csv index 649e9161e..3cc560ce8 100644 --- a/data/blueprints/library/aquifer_tap.csv +++ b/data/blueprints/library/aquifer_tap.csv @@ -58,4 +58,3 @@ u <- drainage level ,,,,,r,r,r,r,r,r,r,r,r,r,r,r,r,r,r ,,,,,,,,,,,,r ,,,,,,,,,,,,r - From 7b2cb8f9a631b8b44bfc2ff1f4e684d34b18b5f6 Mon Sep 17 00:00:00 2001 From: DFHack-Urist via GitHub Actions <63161697+DFHack-Urist@users.noreply.github.com> Date: Sun, 5 Jun 2022 07:16:27 +0000 Subject: [PATCH 4/4] Auto-update submodules library/xml: master --- library/xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library/xml b/library/xml index b5ec10a98..a24581cc5 160000 --- a/library/xml +++ b/library/xml @@ -1 +1 @@ -Subproject commit b5ec10a9817d0990f8c39cceb0c3a2cb69fca10c +Subproject commit a24581cc5318bdbc6227f368f67bc03a9082c19c