Skip to content

Commit 707072c

Browse files
committed
docs: Add inline help text and .rst documentation for gui/harvest
1 parent 43b8da0 commit 707072c

2 files changed

Lines changed: 78 additions & 0 deletions

File tree

docs/gui/harvest.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
gui/harvest
2+
============
3+
4+
.. dfhack-tool::
5+
:summary: Instantly harvest plants, shrubs, and crops in a selected area.
6+
:tags: fort armok plants
7+
8+
Opens a GUI window that lets you box-select an area of the map and
9+
instantly harvest all shrubs, mature farm crops, and fallen fruit or
10+
plant items within it.
11+
12+
Harvested goods are automatically placed into the nearest available
13+
barrel or bag, or dropped on the ground if no container is free. You
14+
can also double-click a specific container to use it.
15+
16+
Yield quantities are based on the best grower and herbalist skill
17+
levels in your fortress, or you can toggle forced maximum yields.
18+
19+
Usage
20+
-----
21+
22+
::
23+
24+
gui/harvest
25+
26+
Click and drag on the map to select harvestable plants. Double-click
27+
on the ground (or on a container) to execute the harvest.
28+
29+
In-window controls
30+
------------------
31+
32+
``Ctrl-a``
33+
Select all harvestable tiles on the current z-level.
34+
``Ctrl-c``
35+
Clear the current selection.
36+
``Ctrl-m``
37+
Toggle between simulating your best dwarf's skill level and
38+
forcing maximum yields.
39+
``Ctrl-s``
40+
Toggle whether saplings are included in the harvest.

gui/harvest.lua

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
1+
-- Instantly harvest plants, shrubs, and crops in a selected area.
2+
--[====[
3+
gui/harvest
4+
===========
5+
6+
Tags: fort | armok | plants
7+
8+
Instantly harvest shrubs, farm crops, and fallen fruit/plant
9+
items within a box-selected area. Harvested goods are placed
10+
into a container or on the ground.
11+
12+
Usage
13+
-----
14+
15+
gui/harvest
16+
17+
Click and drag a box on the map to select harvestable plants.
18+
Double-click empty ground to execute the harvest. The tool will
19+
auto-locate an empty barrel or bag in the fortress, or you can
20+
double-click an existing container to use it.
21+
22+
Options (in-window toggles)
23+
---------------------------
24+
25+
Ctrl-A
26+
Select all harvestable tiles on the current z-level.
27+
28+
Ctrl-C
29+
Clear the current selection.
30+
31+
Ctrl-M
32+
Toggle between simulating your best dwarf's skill level
33+
and forcing maximum yields.
34+
35+
Ctrl-S
36+
Toggle whether saplings are included in the harvest.
37+
]====]
38+
139
local gui = require('gui')
240
local guidm = require('gui.dwarfmode')
341
local widgets = require('gui.widgets')

0 commit comments

Comments
 (0)