dfhack/docs/builtins/script.rst

script
======
Tags: `tag/system`
:dfhack-keybind:`script`

:index:`Execute a batch file of DFHack commands.
<script; Execute a batch file of DFHack commands.>` It reads a text file and
runs each line as a DFHack command as if it had been typed in by the user --
treating the input like `an init file <init-files>`.

Some other tools, such as `autobutcher` and `workflow`, export their settings as
the commands to create them - which can later be reloaded with ``script``.

Usage::

    script <filename>

Example
-------

``script startup.txt``
    Executes the commands in ``startup.txt``, which exists in your DF game
    directory.
move builtin docs to individual files 2022-07-18 11:58:35 -06:00			`script`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`======`
use a label instead of a custom role since I can't seem to figure out how to inject a link to a label via the role processing code 2022-07-22 16:16:57 -06:00			Tags: `tag/system`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			:dfhack-keybind:`script`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update tags and text for builtins 2022-07-22 11:01:04 -06:00			:index:`Execute a batch file of DFHack commands.
			<script; Execute a batch file of DFHack commands.>` It reads a text file and
enable index building and update builtin docs 2022-07-22 00:21:56 -06:00			`runs each line as a DFHack command as if it had been typed in by the user --`
			treating the input like `an init file <init-files>`.
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
			Some other tools, such as `autobutcher` and `workflow`, export their settings as
			the commands to create them - which can later be reloaded with ``script``.

			`Usage::`

			`script <filename>`

update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			`Example`
			`-------`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``script startup.txt``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			Executes the commands in ``startup.txt``, which exists in your DF game
			`directory.`