dfhack/docs/builtins/script.rst

24 lines
581 B
ReStructuredText

2022-07-18 11:58:35 -06:00
script
======
2022-07-18 11:58:35 -06:00
.. dfhack-tool::
:summary: Execute a batch file of DFHack commands.
2022-08-12 00:34:37 -06:00
:tags: dfhack
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>`.
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>
Example
-------
2022-07-18 11:58:35 -06:00
``script startup.txt``
Executes the commands in ``startup.txt``, which exists in your DF game
directory.