dfhack/docs/builtins/enable.rst

37 lines
1.1 KiB
ReStructuredText

2022-07-18 11:58:35 -06:00
enable
======
2022-07-18 11:58:35 -06:00
.. dfhack-tool::
:summary: Activate a DFHack tool that has some persistent effect.
2022-08-12 00:34:37 -06:00
:tags: dfhack
Many plugins and scripts can be in a distinct enabled or disabled state. Some
of them activate and deactivate automatically depending on the contents of the
world raws. Others store their state in world data. However a number of them
have to be enabled globally, and the init file is the right place to do it.
2022-07-18 11:58:35 -06:00
Most such plugins or scripts support the built-in ``enable`` and `disable`
2022-07-18 11:58:35 -06:00
commands. Calling them at any time without arguments prints a list of enabled
and disabled plugins, and shows whether that can be changed through the same
commands. Passing plugin names to these commands will enable or disable the
specified plugins.
2022-12-06 17:42:14 -07:00
If you are a script developer, see `script-enable-api` for how to expose whether
your script is currently enabled or disabled.
2022-08-17 23:42:02 -06:00
Usage
-----
::
2022-07-18 11:58:35 -06:00
enable
enable <plugin> [<plugin> ...]
2022-07-18 11:58:35 -06:00
Examples
--------
2022-07-18 11:58:35 -06:00
``enable manipulator``
Enable the ``manipulator`` plugin.
``enable manipulator search``
Enable multiple plugins at once.