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

fix library paths in docs

develop
Myk Taylor 2023-03-10 18:00:10 -08:00
parent c48c9c77c0
commit c7a058c308
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,7 +5,7 @@ Quickfort blueprint library
=========================== ===========================
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>`. :source:`quickfort blueprint library <data/blueprints>`.
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. Also, if you use `gui/quickfort`, you will blueprints do before you run them. Also, if you use `gui/quickfort`, you will
@ -18,8 +18,8 @@ Whole fort blueprint sets
These files contain the plans for entire fortresses. Each file has one or more These files contain the plans for entire fortresses. Each file has one or more
help sections that walk you through how to build the fort, step by step. help sections that walk you through how to build the fort, step by step.
- :source:`library/dreamfort.csv <data/blueprints/library/dreamfort.csv>` - :source:`library/dreamfort.csv <data/blueprints/dreamfort.csv>`
- :source:`library/quickfortress.csv <data/blueprints/library/quickfortress.csv>` - :source:`library/quickfortress.csv <data/blueprints/quickfortress.csv>`
.. _dreamfort: .. _dreamfort:
@ -149,10 +149,10 @@ these ``#dig`` blueprints can only mark undug wall tiles for mining, they are
best used underground. They won't do much on the surface, where there aren't best used underground. They won't do much on the surface, where there aren't
many walls. many walls.
- :source:`library/layout-helpers/mark_up_left.csv <data/blueprints/library/layout-helpers/mark_up_left.csv>` - :source:`library/layout-helpers/mark_up_left.csv <data/blueprints/layout-helpers/mark_up_left.csv>`
- :source:`library/layout-helpers/mark_up_right.csv <data/blueprints/library/layout-helpers/mark_up_right.csv>` - :source:`library/layout-helpers/mark_up_right.csv <data/blueprints/layout-helpers/mark_up_right.csv>`
- :source:`library/layout-helpers/mark_down_right.csv <data/blueprints/library/layout-helpers/mark_down_right.csv>` - :source:`library/layout-helpers/mark_down_right.csv <data/blueprints/layout-helpers/mark_down_right.csv>`
- :source:`library/layout-helpers/mark_down_left.csv <data/blueprints/library/layout-helpers/mark_down_left.csv>` - :source:`library/layout-helpers/mark_down_left.csv <data/blueprints/layout-helpers/mark_down_left.csv>`
Bedrooms Bedrooms
-------- --------
@ -161,9 +161,9 @@ These are popular bedroom layouts from the :wiki:`Bedroom design` page on the
wiki. Each file has ``#dig``, ``#build``, and ``#query`` blueprints to dig the wiki. Each file has ``#dig``, ``#build``, and ``#query`` blueprints to dig the
rooms, build the furniture, and configure the beds as bedrooms, respectively. rooms, build the furniture, and configure the beds as bedrooms, respectively.
- :source:`library/bedrooms/48-4-Raynard_Whirlpool_Housing.csv <data/blueprints/library/bedrooms/48-4-Raynard_Whirlpool_Housing.csv>` - :source:`library/bedrooms/48-4-Raynard_Whirlpool_Housing.csv <data/blueprints/bedrooms/48-4-Raynard_Whirlpool_Housing.csv>`
- :source:`library/bedrooms/95-9-Hactar1_3_Branch_Tree.csv <data/blueprints/library/bedrooms/95-9-Hactar1_3_Branch_Tree.csv>` - :source:`library/bedrooms/95-9-Hactar1_3_Branch_Tree.csv <data/blueprints/bedrooms/95-9-Hactar1_3_Branch_Tree.csv>`
- :source:`library/bedrooms/28-3-Modified_Windmill_Villas.csv <data/blueprints/library/bedrooms/28-3-Modified_Windmill_Villas.csv>` - :source:`library/bedrooms/28-3-Modified_Windmill_Villas.csv <data/blueprints/bedrooms/28-3-Modified_Windmill_Villas.csv>`
Tombs Tombs
----- -----
@ -171,8 +171,8 @@ Tombs
These blueprints have burial plot layouts for fortress that expect a lot of These blueprints have burial plot layouts for fortress that expect a lot of
casualties. casualties.
- :source:`library/tombs/Mini_Saracen.csv <data/blueprints/library/tombs/Mini_Saracen.csv>` - :source:`library/tombs/Mini_Saracen.csv <data/blueprints/tombs/Mini_Saracen.csv>`
- :source:`library/tombs/The_Saracen_Crypts.csv <data/blueprints/library/tombs/The_Saracen_Crypts.csv>` - :source:`library/tombs/The_Saracen_Crypts.csv <data/blueprints/tombs/The_Saracen_Crypts.csv>`
Exploratory mining Exploratory mining
------------------ ------------------
@ -181,18 +181,18 @@ Several mining patterns to choose from when searching for gems or ores. The
patterns can be repeated up or down z-levels (via quickfort's ``--repeat`` patterns can be repeated up or down z-levels (via quickfort's ``--repeat``
commandline option) for exploring through the depths. commandline option) for exploring through the depths.
- :source:`library/exploratory-mining/tunnels.csv <data/blueprints/library/exploratory-mining/tunnels.csv>` - :source:`library/exploratory-mining/tunnels.csv <data/blueprints/exploratory-mining/tunnels.csv>`
- :source:`library/exploratory-mining/vertical-mineshafts.csv <data/blueprints/library/exploratory-mining/vertical-mineshafts.csv>` - :source:`library/exploratory-mining/vertical-mineshafts.csv <data/blueprints/exploratory-mining/vertical-mineshafts.csv>`
- :source:`library/exploratory-mining/connected-mineshafts.csv <data/blueprints/library/exploratory-mining/connected-mineshafts.csv>` - :source:`library/exploratory-mining/connected-mineshafts.csv <data/blueprints/exploratory-mining/connected-mineshafts.csv>`
Miscellaneous Miscellaneous
------------- -------------
Extra blueprints that are useful in specific situations. Extra blueprints that are useful in specific situations.
- :source:`library/aquifer_tap.csv <data/blueprints/library/aquifer_tap.csv>` - :source:`library/aquifer_tap.csv <data/blueprints/aquifer_tap.csv>`
- :source:`library/embark.csv <data/blueprints/library/embark.csv>` - :source:`library/embark.csv <data/blueprints/embark.csv>`
- :source:`library/pump_stack.csv <data/blueprints/library/pump_stack.csv>` - :source:`library/pump_stack.csv <data/blueprints/pump_stack.csv>`
Light aquifer tap Light aquifer tap
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~

10
docs/guides/quickfort-user-guide.rst
Unescape Escape View File

@ -27,9 +27,9 @@ written by Joel Thornton, reused here with his permission.
For those just looking to apply existing blueprints, check out the `quickfort For those just looking to apply existing blueprints, check out the `quickfort
command's documentation <quickfort>` for syntax. There are also many command's documentation <quickfort>` for syntax. There are also many
ready-to-use blueprints available in the ``blueprints/library`` subfolder in ready-to-use blueprints available in the ``hack/data/blueprints`` subfolder in
your DFHack installation. Browse them on your computer or your DFHack installation. Browse them on your computer or
:source:`online <data/blueprints/library>`, or run `gui/quickfort` to browse :source:`online <data/blueprints>`, or run `gui/quickfort` to browse
and apply them to your fort! and apply them to your fort!
Before you become an expert at writing blueprints, though, you should know that Before you become an expert at writing blueprints, though, you should know that
@ -248,7 +248,7 @@ You can save a lot of time and effort by using aliases instead of adding all
key sequences directly to your blueprints. For more details, check out the key sequences directly to your blueprints. For more details, check out the
`quickfort-alias-guide`. You can also see examples of aliases being used in the `quickfort-alias-guide`. You can also see examples of aliases being used in the
query blueprints in the query blueprints in the
:source:`DFHack blueprint library <data/blueprints/library>`. You can create :source:`DFHack blueprint library <data/blueprints>`. You can create
your own aliases by adding them to :source:`dfhack-config/quickfort/aliases.txt` your own aliases by adding them to :source:`dfhack-config/quickfort/aliases.txt`
in your DFHack folder or you can package them in your DFHack folder or you can package them
`together with your blueprint files <quickfort-aliases-blueprints>`. `together with your blueprint files <quickfort-aliases-blueprints>`.
@ -1467,7 +1467,7 @@ Dreamfort organization and packaging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Dreamfort blueprints are distributed with DFHack as The Dreamfort blueprints are distributed with DFHack as
:source:`one large .csv file <data/blueprints/library/dreamfort.csv>`, but :source:`one large .csv file <data/blueprints/dreamfort.csv>`, but
editing in that format would be frustrating. Instead, the blueprints are editing in that format would be frustrating. Instead, the blueprints are
edited `online as Google drive spreadsheets edited `online as Google drive spreadsheets
<https://drive.google.com/drive/folders/1iS90EEVqUkxTeZiiukVj1pLloZqabKuP>`__. <https://drive.google.com/drive/folders/1iS90EEVqUkxTeZiiukVj1pLloZqabKuP>`__.
@ -1825,7 +1825,7 @@ Links
- `blueprint-library-guide` - `blueprint-library-guide`
- :forums:`Quickfort forum thread <176889>` - :forums:`Quickfort forum thread <176889>`
- :issue:`DFHack issue tracker <>` - :issue:`DFHack issue tracker <>`
- :source:`Blueprint library source <data/blueprints/library>` - :source:`Blueprint library source <data/blueprints>`
- :source-scripts:`Quickfort source code <internal/quickfort>` - :source-scripts:`Quickfort source code <internal/quickfort>`
**Related tools:** **Related tools:**