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

Merge pull request #2304 from myk002/myk_doc_feedback 

address feedback on the docs
develop
Myk 2022-09-28 12:52:19 -07:00 committed by GitHub
parent a0cc040d9c b6acf7a928
commit 3fada2f300
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/plugins/3dveins.rst
Unescape Escape View File

@ -25,10 +25,10 @@ Example
3dveins 3dveins
New veins are generated using 3D Perlin noise in order to produce a layout that New veins are generated using natural-looking 3D Perlin noise in order to
flows smoothly between z-levels. The vein distribution is based on the world produce a layout that flows smoothly between z-levels. The vein distribution is
seed, so running the command for the second time should produce no change. It is based on the world seed, so running the command for the second time should
best to run it just once immediately after embark. produce no change. It is best to run it just once immediately after embark.
This command is intended as only a cosmetic change, so it takes care to exactly This command is intended as only a cosmetic change, so it takes care to exactly
preserve the mineral counts reported by ``prospect all``. The amounts of layer preserve the mineral counts reported by ``prospect all``. The amounts of layer

3
docs/plugins/add-spatter.rst
Unescape Escape View File

@ -12,3 +12,6 @@ names starting with ``SPATTER_ADD_``, so there are no commands to run to use it.
These reactions will then produce contaminants on items instead of improvements. These reactions will then produce contaminants on items instead of improvements.
The contaminants are immune to being washed away by water or destroyed by The contaminants are immune to being washed away by water or destroyed by
`clean`. `clean`.
You must have a mod installed that adds the appropriate tokens in order for this
plugin to do anything.

4
docs/plugins/autohauler.rst
Unescape Escape View File

@ -5,7 +5,7 @@ autohauler
:summary: Automatically manage hauling labors. :summary: Automatically manage hauling labors.
:tags: fort auto labors :tags: fort auto labors
Similar to `autolabor`, but instead of managing all labors, ``autohauler`` only Similar to `autolabor`, but instead of managing all labors, autohauler only
addresses hauling labors, leaving the assignment of skilled labors entirely up addresses hauling labors, leaving the assignment of skilled labors entirely up
to you. You can use the in-game `manipulator` UI or an external tool like Dwarf to you. You can use the in-game `manipulator` UI or an external tool like Dwarf
Therapist to do so. Therapist to do so.
@ -19,7 +19,7 @@ assignment, with most skilled labors only being assigned to just a few dwarves
and almost every non-military dwarf having at least one skilled labor assigned. and almost every non-military dwarf having at least one skilled labor assigned.
Autohauler allows a skill to be used as a flag to exempt a dwarf from Autohauler allows a skill to be used as a flag to exempt a dwarf from
``autohauler``'s effects. By default, this is the unused ALCHEMIST labor, but it autohauler's effects. By default, this is the unused ALCHEMIST labor, but it
can be changed by the user. can be changed by the user.
Usage Usage

9
docs/plugins/autolabor.rst
Unescape Escape View File

@ -45,10 +45,11 @@ and manager.
Hunting is never assigned without a butchery, and fishing is never assigned Hunting is never assigned without a butchery, and fishing is never assigned
without a fishery. without a fishery.
For each labor, a preference order is calculated based on skill, biased against For each labor, a preference order is calculated based on skill, excluding those
masters of other trades and excluding those who can't do the job. The labor is who can't do the job. Dwarves who are masters of particular skills are
then added to the best <minimum> dwarves for that labor, then to additional deprioritized in the preference list for other skills. The labor is then added
dwarfs that meet any of these conditions: to the best <minimum> dwarves for that labor, then to additional dwarfs that
meet any of these conditions:
* The dwarf is idle and there are no idle dwarves assigned to this labor * The dwarf is idle and there are no idle dwarves assigned to this labor
* The dwarf has non-zero skill associated with the labor * The dwarf has non-zero skill associated with the labor

14
docs/plugins/autonestbox.rst
Unescape Escape View File

@ -5,13 +5,13 @@ autonestbox
:summary: Auto-assign egg-laying female pets to nestbox zones. :summary: Auto-assign egg-laying female pets to nestbox zones.
:tags: fort auto animals :tags: fort auto animals
To use this feature, you must create pen/pasture zones above nestboxes. If the To use this feature, you must create pen/pasture zones on the same tiles as
pen is bigger than 1x1, the nestbox must be in the top left corner. Only 1 unit built nestboxes. If the pen is bigger than 1x1, the nestbox must be in the top
will be assigned per pen, regardless of the size. Egg layers who are also left corner. Only 1 unit will be assigned per pen, regardless of the size. Egg
grazers will be ignored, since confining them to a 1x1 pasture is not a good layers who are also grazers will be ignored, since confining them to a 1x1
idea. Only tame and domesticated own units are processed since pasturing pasture is not a good idea. Only tame and domesticated own units are processed
half-trained wild egg layers could destroy your neat nestbox zones when they since pasturing half-trained wild egg layers could destroy your neat nestbox
revert to wild. zones when they revert to wild.
Note that the age of the units is not checked, so you might get some egg-laying Note that the age of the units is not checked, so you might get some egg-laying
kids assigned to the nestbox zones. Most birds grow up quite fast, though, so kids assigned to the nestbox zones. Most birds grow up quite fast, though, so