update docs for stonesense

conf.py

@@ -183,7 +183,7 @@ def write_tool_docs():
                     mode=0o755, exist_ok=True)
         with write_file_if_changed('docs/tools/{}.rst'.format(k[0])) as outfile:
             outfile.write(header)
-            if k[0] != 'search' and k[0] != 'stonesense':
+            if k[0] != 'search':
                 outfile.write(label)
             outfile.write(include)
 
@@ -315,6 +315,7 @@ exclude_patterns = [
     'docs/pseudoxml/*',
     'docs/xml/*',
     'scripts/docs/*',
+    'plugins/*',
     ]
 
 # The reST default role (used for this markup: `text`) to use for all

docs/plugins/stonesense.rst

@@ -1,10 +1,79 @@
-.. _plugin-stonesense:
-
 stonesense
 ==========
-An isometric visualizer that runs in a second window. Usage:
+Tags:
+:dfhack-keybind:`stonesense`
+:dfhack-keybind:`ssense`
+
+A 3D isometric visualizer that runs in a second window.
+
+Usage:
+
+``stonesense`` or ``ssense``
+    Open the visualiser in a new window.
+``ssense overlay``
+    Overlay DF window, replacing the map area.
+
+The viewer window has read-only access to the game, and can follow the game view
+or be moved independently. Configuration for stonesense can be set in the
+``stonesense/init.txt`` file in your DF game directory. If the window refresh
+rate is too low, change ``SEGMENTSIZE_Z`` to ``2`` in this file, and if you are
+unable to see the edges of the map with the overlay active, try decreasing the
+value for ``SEGMENTSIZE_XY`` -- normal values are ``50`` to ``80``, depending
+on your screen resolution.
+
+If you replace the map section of your DF window with ``ssense overlay``, be
+aware that it's not (yet) suitable for use as your only interface. Use DF's
+``[PRINT_MODE:2D]`` init option (in ``data/init/init.txt``) for stability.
+
+.. figure:: ../images/stonesense-roadtruss.jpg
+   :align: center
+   :target: http://www.bay12forums.com/smf/index.php?topic=48172.msg3198664#msg3198664
+
+   The above-ground part of the fortress *Roadtruss*.
+
+Controls
+--------
+Mouse controls are hard-coded and cannot be changed.
+
+:Left click:    Move debug cursor (if available)
+:Right click:   Recenter screen
+:Scrollwheel:   Move up and down
+:Ctrl-Scroll:   Increase/decrease Z depth shown
+
+Follow mode makes the Stonesense view follow the location of the DF
+window. The offset can be adjusted by holding :kbd:`Ctrl` while using the
+keyboard window movement keys. When you turn on cursor follow mode, the
+Stonesense debug cursor will follow the DF cursor when the latter exists.
+
+You can take screenshots with :kbd:`F5`, larger screenshots with
+:kbd:`Ctrl`:kbd:`F5`, and screenshot the whole map at full resolution with
+:kbd:`Ctrl`:kbd:`Shift`:kbd:`F5`.  Screenshots are saved to the DF directory.
+Note that feedback is printed to the DFHack console, and you may need
+to zoom out before taking very large screenshots.
+
+See ``stonesense/keybinds.txt`` to learn or set keybindings, including
+zooming, changing the dimensions of the rendered area, toggling various
+views, fog, and rotation. Here's the important section:
+
+.. include:: ../../plugins/stonesense/resources/keybinds.txt
+   :literal:
+   :end-before: VALID ACTIONS:
+
+Known Issues
+------------
+If Stonesense gives an error saying that it can't load
+:file:`creatures/large_256/*.png`, your video card cannot handle the high
+detail sprites used. Either open :file:`creatures/init.txt` and remove the
+line containing that folder, or :dffd:`use these smaller sprites <6096>`.
 
-:stonesense:        Open the visualiser in a new window.  Alias ``ssense``.
+Stonesense requires working graphics acceleration, and we recommend
-:ssense overlay:    Overlay DF window, replacing the map area.
+at least a dual core CPU to avoid slowing down your game of DF.
 
-For more information, see `the full Stonesense README <stonesense>`.
+Useful links
+------------
+- :forums:`Official Stonesense thread <106497>` for feedback,
+  questions, requests or bug reports
+- :forums:`Screenshots thread <48172>`
+- :wiki:`Main wiki page <Utility:Stonesense>`
+- :wiki:`How to add content <Utility:Stonesense/Adding_Content>`
+- `Stonesense on Github <https://github.com/DFHack/stonesense>`_