MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add overlay docs

develop
myk002 2022-09-16 14:01:29 -07:00
parent 301563d1e6
commit b084171048
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/plugins/overlay.rst
Unescape Escape View File

@ -0,0 +1,20 @@
overlay
=======
.. dfhack-tool::
:summary: Provide an on-screen clickable DFHack launcher button.
:tags: dfhack interface
This tool places a small button in the lower left corner of the screen that you
can click to run DFHack commands with `gui/launcher`.
If you would rather always run `gui/launcher` with the hotkeys, or just don't
want the DFHack button on-screen, just disable the plugin with
``disable overlay``.
Usage
-----
::
enable overlay