37 lines
1.1 KiB
ReStructuredText
37 lines
1.1 KiB
ReStructuredText
enable
|
|
======
|
|
|
|
.. dfhack-tool::
|
|
:summary: Activate a DFHack tool that has some persistent effect.
|
|
: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.
|
|
|
|
Most such plugins or scripts support the built-in ``enable`` and `disable`
|
|
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.
|
|
|
|
If you are a script developer, see `script-enable-api` for how to expose whether
|
|
your script is currently enabled or disabled.
|
|
|
|
Usage
|
|
-----
|
|
|
|
::
|
|
|
|
enable
|
|
enable <plugin> [<plugin> ...]
|
|
|
|
Examples
|
|
--------
|
|
|
|
``enable manipulator``
|
|
Enable the ``manipulator`` plugin.
|
|
``enable manipulator search``
|
|
Enable multiple plugins at once.
|