gui/gm-editor

Tags: dfhack | armok | inspection | animals | buildings | items | jobs | map | plants | stockpiles | units | workorders

Command: gui/gm-editor

Inspect and edit DF game data.

This editor allows you to inspect or modify almost anything in DF. Press ? for in-game help.

If you just want to browse without fear of accidentally changing anything, hit CtrlD to toggle read-only mode.

Usage

gui/gm-editor [-f]

Open the editor on whatever is selected or viewed (e.g. unit/item description screen)

gui/gm-editor [-f] <lua expression>

Evaluate a lua expression and opens the editor on its results. Field prefixes of df.global can be omitted.

gui/gm-editor [-f] dialog

Show an in-game dialog to input the lua expression to evaluate. Works the same as the version above.

Examples

gui/gm-editor

Opens the editor on the selected unit/item/job/workorder/stockpile etc.

gui/gm-editor world.items.all

Opens the editor on the items list.

gui/gm-editor --freeze scr

Opens the editor on the current viewscreen data and prevents it from getting updates while you have the editor open.

Options

-f, --freeze

Freeze the underlying viewscreen so that it does not receive logic updates. Note that this will prevent scrolling the map by draggint with the middle mouse button.

Screenshot