add overlay docs

2022-09-16 14:01:29 -07:00 · 2022-09-16 14:01:29 -07:00 · b084171048
parent 301563d1e6
commit b084171048
1 changed files with 20 additions and 0 deletions
--- a/docs/plugins/overlay.rst
+++ b/docs/plugins/overlay.rst
@ -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