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

Use custom link roles when possible

develop
lethosor 2020-10-02 00:22:35 -04:00
parent 8dfdf75e7c
commit 5f47491e78
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
1 changed files with 9 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,8 +27,7 @@ by Joel Thornton, reused here with his permission.
For those just looking to apply blueprints, check out the `quickfort command's For those just looking to apply blueprints, check out the `quickfort command's
documentation <quickfort>` for syntax. There are also many ready-to-use blueprints documentation <quickfort>` for syntax. There are also many ready-to-use blueprints
available in the ``blueprints/library`` subfolder in your DFHack installation. available in the ``blueprints/library`` subfolder in your DFHack installation.
Browse them on your computer or Browse them on your computer or :source:`online <data/blueprints/library>`,
`online <https://github.com/DFHack/dfhack/tree/develop/data/blueprints/library>`__,
or run ``quickfort list -l`` at the ``[DFHack]#`` prompt to list them, and then or run ``quickfort list -l`` at the ``[DFHack]#`` prompt to list them, and then
``quickfort run`` to apply them to your fort! ``quickfort run`` to apply them to your fort!
@ -231,20 +230,17 @@ over the bed, causing us to 'make room' and "&", which is a special symbol that
expands to "{Enter}", to indicate that we're done. expands to "{Enter}", to indicate that we're done.
In column 2, row 3 we have "booze". This is one of many alias keywords defined In column 2, row 3 we have "booze". This is one of many alias keywords defined
in the included `baseline aliases in the included :source:`baseline aliases file <data/quickfort/aliases-common.txt>`.
file <https://github.com/DFHack/dfhack/tree/develop/data/quickfort/aliases-common.txt>`__.
This particular alias sets a food stockpile to carry booze only. It sends the This particular alias sets a food stockpile to carry booze only. It sends the
keys needed to navigate DF's stockpile settings menu, and then sends an Escape keys needed to navigate DF's stockpile settings menu, and then sends an Escape
character ("^" or "{ESC}") to exit back to the map. It is important to exit out character ("^" or "{ESC}") to exit back to the map. It is important to exit out
of any menus that you enter while in query mode so that the cursor can move to of any menus that you enter while in query mode so that the cursor can move to
the next tile when it is done configuring the current tile. the next tile when it is done configuring the current tile.
Check out the included `blueprint Check out the included :source:`blueprint library <data/blueprints/library>`
library <https://github.com/DFHack/dfhack/tree/develop/data/blueprints/library>`__
to see many more examples. Read the baseline aliases file for helpful to see many more examples. Read the baseline aliases file for helpful
pre-packaged aliases, or create your own in pre-packaged aliases, or create your own in
`dfhack-config/quickfort/aliases.txt <https://github.com/DFHack/dfhack/tree/develop/dfhack-config/quickfort/aliases.txt>`__ :source:`dfhack-config/quickfort/aliases.txt` in your DFHack installation.
in your DFHack installation.
Area expansion syntax Area expansion syntax
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -1085,9 +1081,7 @@ Caveats and limitations
not yet supported by DFHack. not yet supported by DFHack.
- This script is relatively new, and there are bound to be bugs! Please report - This script is relatively new, and there are bound to be bugs! Please report
them at the `DFHack issue them at the :issue:`DFHack issue tracker <>` so they can be addressed.
tracker <https://github.com/DFHack/dfhack/issues>`__ so they can be
addressed.
Links Links
----- -----
@ -1095,13 +1089,10 @@ Links
**Quickfort links:** **Quickfort links:**
- `Quickfort command syntax <quickfort>` - `Quickfort command syntax <quickfort>`
- `Quickfort forum - :forums:`Quickfort forum thread <176889>`
thread <http://www.bay12forums.com/smf/index.php?topic=176889.0>`__ - :source:`Quickfort blueprints library <data/blueprints/library>`
- `Quickfort blueprints - :issue:`DFHack issue tracker <>`
library <https://github.com/DFHack/dfhack/tree/develop/data/blueprints/library>`__ - :source:scripts:`Quickfort source code <internal/quickfort>`
- `DFHack issue tracker <https://github.com/DFHack/dfhack/issues>`__
- `Quickfort source
code <https://github.com/DFHack/scripts/tree/master/internal/quickfort>`__
**Related tools:** **Related tools:**