2022-07-25 07:08:59 -06:00
|
|
|
.. _prospect:
|
|
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
prospector
|
|
|
|
|
==========
|
sync tags spreadsheet to git
spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995
sync command - for fname in *rst; do name=$(echo $fname | sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv | ~/Downloads/csvtotags.sh); sed -ri "s;[*]*Tags:.*;$tagline;" $fname; done
contents of csvtotags.sh -
fgrep . | sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' | awk -F, '
function tag(idx, tagname) {
if ($idx == "TRUE") {
if (hastag == 1) {printf(", ")}
printf("`tag/%s`", tagname)
hastag = 1
}
}
{
printf("%s", "**Tags:** ")
hastag = 0
tag(2, "adventure")
tag(3, "fort")
tag(4, "legends")
tag(5, "embark")
tag(6, "system")
tag(7, "dev")
tag(8, "auto")
tag(9, "productivity")
tag(10, "inspection")
tag(11, "design")
tag(12, "quickfort")
tag(13, "interface")
tag(14, "fps")
tag(15, "fix")
tag(16, "mod")
tag(17, "armok")
tag(18, "animals")
tag(19, "buildings")
tag(20, "items")
tag(21, "jobs")
tag(22, "map")
tag(23, "labors")
tag(24, "units")
tag(25, "stockpiles")
tag(26, "trees")
printf("\n")
}
'
2022-08-05 18:55:33 -06:00
|
|
|
**Tags:** `tag/fort`, `tag/embark`, `tag/inspection`, `tag/map`
|
2022-07-29 00:12:11 -06:00
|
|
|
:dfhack-keybind:`prospect`
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-08-05 11:08:23 -06:00
|
|
|
Shows a summary of resources that exist on the map. It can also calculate an
|
|
|
|
|
estimate of resources available in the selected embark area.
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
Usage::
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
prospect [all|hell] [<options>]
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
By default, only the visible part of the map is scanned. Include the ``all``
|
|
|
|
|
keyword if you want ``prospect`` to scan the whole map as if it were revealed.
|
|
|
|
|
Use ``hell`` instead of ``all`` if you also want to see the Z range of HFS
|
|
|
|
|
tubes in the 'features' report section.
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
Examples
|
|
|
|
|
--------
|
2022-07-10 00:01:46 -06:00
|
|
|
|
|
|
|
|
``prospect all``
|
|
|
|
|
Shows the entire report for the entire map.
|
|
|
|
|
|
|
|
|
|
``prospect hell --show layers,ores,veins``
|
|
|
|
|
Shows only the layers, ores, and other vein stone report sections, and
|
2022-07-29 00:12:11 -06:00
|
|
|
includes information on HFS tubes (if run on a fortress map and not the
|
|
|
|
|
pre-embark screen).
|
2022-07-10 00:01:46 -06:00
|
|
|
|
|
|
|
|
``prospect all -sores``
|
|
|
|
|
Show only information about ores for the pre-embark or fortress map report.
|
|
|
|
|
|
2022-07-29 00:12:11 -06:00
|
|
|
Options
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
``-s``, ``--show <sections>``
|
|
|
|
|
Shows only the named comma-separated list of report sections. Report section
|
|
|
|
|
names are: summary, liquids, layers, features, ores, gems, veins, shrubs,
|
|
|
|
|
and trees. If run during pre-embark, only the layers, ores, gems, and veins
|
|
|
|
|
report sections are available.
|
|
|
|
|
``-v``, ``--values``
|
|
|
|
|
Includes material value in the output. Most useful for the 'gems' report
|
|
|
|
|
section.
|
|
|
|
|
|
|
|
|
|
Pre-embark estimate
|
|
|
|
|
-------------------
|
2022-07-10 00:01:46 -06:00
|
|
|
|
|
|
|
|
If prospect is called during the embark selection screen, it displays an
|
|
|
|
|
estimate of layer stone availability. If the ``all`` keyword is specified, it
|
|
|
|
|
also estimates ores, gems, and vein material. The estimate covers all tiles of
|
|
|
|
|
the embark rectangle.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
The results of pre-embark prospect are an *estimate*, and can at best be
|
|
|
|
|
expected to be somewhere within +/- 30% of the true amount; sometimes it
|
2022-07-29 00:12:11 -06:00
|
|
|
does a lot worse. In particular, it is not clear how to precisely compute
|
|
|
|
|
how many soil layers there will be in a given embark tile, so it can report
|
|
|
|
|
a whole extra layer, or omit one that is actually present.
|