.. dfhack-tool::
    :summary: Provides commands for designating tiles for digging.
    :tags: fort design productivity map
    :no-command:

.. dfhack-command:: digv
    :summary: Designate all of the selected vein for digging.

.. dfhack-command:: digvx
    :summary: Dig a vein across z-levels, digging stairs as needed.

.. dfhack-command:: digl
    :summary: Dig all of the selected layer stone.

.. dfhack-command:: diglx
    :summary: Dig layer stone across z-levels, digging stairs as needed.

.. dfhack-command:: digcircle
    :summary: Designate circles.

.. dfhack-command:: digtype
    :summary: Designate all vein tiles of the same type as the selected tile.

.. dfhack-command:: digexp
    :summary: Designate dig patterns for exploratory mining.

This plugin provides commands to make complicated dig patterns easy.

digv [x] [-p<number>]

Designate all of the selected vein for digging.

digvx [-p<number>]

Dig a vein across z-levels, digging stairs as needed. This is an alias for digv x.

digl [x] [undo] [-p<number>]

Dig all of the selected layer stone. If undo is specified, removes the designation instead (for if you accidentally set 50 levels at once).

diglx [-p<number>]

Dig layer stone across z-levels, digging stairs as needed. This is an alias for digl x.

digcircle [<diameter>] [<solidity>] [<action>] [<designation>] [-p<number>]

Designate circles. The diameter is the number of tiles across the center of the circle that you want to dig. See the digcircle section below for options.

digtype [<designation>] [-p<number>] [-z]

Designate all vein tiles of the same type as the selected tile. See the digtype section below for options.

digexp [<pattern>] [<filter>] [-p<number>]

Designate dig patterns for exploratory mining. See the digexp section below for options.

All commands support specifying the priority of the dig designations with -p<number>, where the number is from 1 to 7. If a priority is not specified, the priority selected in-game is used as the default.

digcircle filled 3 -p2

Dig a filled circle with a diameter of 3 tiles at dig priority 2.

digcircle

Do it again (previous parameters are reused).

expdig diag5 hidden

Designate the diagonal 5 pattern over all hidden tiles on the current z-level.

expdig ladder designated

Take existing designations on the current z-level and replace them with the ladder pattern.

expdig

Do it again (previous parameters are reused).

The digcircle command can accept up to one option of each type below.

Solidity options:

hollow

Designates hollow circles (default).

filled

Designates filled circles.

Action options:

set

Set designation (default).

unset

Unset current designation.

invert

Invert designations already present.

Designation options:

dig

Normal digging designation (default).

ramp

Dig ramps.

ustair

Dig up staircases.

dstair

Dig down staircases.

xstair

Dig up/down staircases.

chan

Dig channels.

After you have set the options, the command called with no options repeats with the last selected parameters.

For every tile on the map of the same vein type as the selected tile, this command designates it to have the same designation as the selected tile. If the selected tile has no designation, they will be dig designated.

If an argument is given, the designation of the selected tile is ignored, and all appropriate tiles are set to the specified designation.

Designation options:

dig

Normal digging designation.

channel

Dig channels.

ramp

Dig ramps.

updown

Dig up/down staircases.

up

Dig up staircases.

down

Dig down staircases.

clear

Clear any designations.

You can also pass a -z option, which restricts designations to the current z-level and down. This is useful when you don't want to designate tiles on the same z-levels as your carefully dug fort above.

This command is for :wiki:`exploratory mining <Exploratory_mining>`.

There are two variables that can be set: pattern and filter.

Patterns:

diag5

Diagonals separated by 5 tiles.

diag5r

The diag5 pattern rotated 90 degrees.

ladder

A 'ladder' pattern.

ladderr

The ladder pattern rotated 90 degrees.

cross

A cross, exactly in the middle of the map.

clear

Just remove all dig designations.

Filters:

hidden

Designate only hidden tiles of z-level (default)

all

Designate the whole z-level.

designated

Take current designation and apply the selected pattern to it.

After you have a pattern set, you can use expdig to apply it again.