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 `__.