update guides

including fixing the ordering of the TOC, which, while in alphabetical
order, was not in a logical order
develop
myk002 2022-09-05 20:53:44 -07:00
parent 73b7f13ad6
commit e37b7650fa
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
5 changed files with 17 additions and 15 deletions

@ -1,8 +1,8 @@
.. _config-examples-guide:
.. _dfhack-examples-guide:
DFHack Example Configuration File Index
=======================================
DFHack Config File Examples
===========================
The :source:`hack/examples <data/examples>` folder contains ready-to-use
examples of various DFHack configuration files. You can use them by copying them
@ -14,8 +14,8 @@ The ``init/`` subfolder
-----------------------
The :source:`init/ <data/examples/init>` subfolder contains useful DFHack
`init-files` that you can copy into your main Dwarf Fortress folder -- the same
directory as ``dfhack.init``.
`init-files` that you can copy into your :file:`dfhack-config/init` folder --
the same directory as ``dfhack.init``.
.. _onMapLoad-dreamfort-init:
@ -35,7 +35,7 @@ it is useful (and customizable) for any fort. It includes the following config:
- Periodically enqueues orders to shear and milk shearable and milkable pets.
- Sets up `autofarm` to grow 30 units of every crop, except for pig tails, which
is set to 150 units to support the textile industry.
- Sets up `seedwatch` to keep 30 of every type of seed.
- Sets up `seedwatch` to protect 30 of every type of seed.
- Configures `prioritize` to automatically boost the priority of important and
time-sensitive tasks that could otherwise get ignored in busy forts, like
hauling food, tanning hides, storing items in vehicles, pulling levers, and

@ -6,6 +6,8 @@ These pages are detailed guides covering DFHack tools.
.. toctree::
:maxdepth: 1
:glob:
*
/docs/guides/examples-guide
/docs/guides/quickfort-library-guide
/docs/guides/quickfort-user-guide
/docs/guides/quickfort-alias-guide

@ -1,10 +1,11 @@
.. _quickfort-alias-guide:
Quickfort Keystroke Alias Guide
===============================
Quickfort Keystroke Alias Reference
===================================
Aliases allow you to use simple words to represent complicated key sequences
when configuring buildings and stockpiles in quickfort ``#query`` blueprints.
when configuring buildings and stockpiles in quickfort ``#query`` and
``#config`` blueprints.
For example, say you have the following ``#build`` and ``#place`` blueprints::

@ -1,8 +1,8 @@
.. _blueprint-library-guide:
.. _quickfort-library-guide:
Blueprint Library Index
=======================
Quickfort Blueprint Library
===========================
This guide contains a high-level overview of the blueprints available in the
:source:`quickfort blueprint library <data/blueprints/library>`.

@ -29,9 +29,8 @@ For those just looking to apply existing blueprints, check out the `quickfort
command's documentation <quickfort>` for syntax. There are also many
ready-to-use blueprints available in the ``blueprints/library`` subfolder in
your DFHack installation. Browse them on your computer or
:source:`online <data/blueprints/library>`, or run ``quickfort list`` at the
``[DFHack]#`` prompt to list them, and then ``quickfort run`` to apply them to
your fort!
:source:`online <data/blueprints/library>`, or run `gui/quickfort` to browse
and apply them to your fort!
Before you become an expert at writing blueprints, though, you should know that
the easiest way to make a quickfort blueprint is to build your plan "for real"