Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 3.72 KB

File metadata and controls

90 lines (72 loc) · 3.72 KB

stonesense

.. dfhack-tool::
    :summary: A 3D isometric visualizer.
    :tags: adventure fort graphics map

.. dfhack-command:: ssense
   :summary: An alias for stonesense.

Usage

stonesense or ssense
Open the visualiser in a new window.

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 dfhack-config/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_X and SEGMENTSIZE_Y -- normal values are 50 to 80, depending on your screen resolution.

../images/stonesense-roadtruss.jpg

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 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 F5, larger screenshots with CtrlF5, and screenshot the whole map at full resolution with CtrlShiftF5. 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 dfhack-config/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:

Streaming stonesense on Windows

If you wish to stream stonesense thru a broadcasting software such as OBS then you may find that opening stonesense causes your main DF window to flicker between DF and stonesense. While it is unknown exactly what causes this, a fix does exist. Simply make sure that both DF and stonesense are using Window Capture and NOT Game Capture. This will stop the flickering from happening and enable you to stream stonesense for all to enjoy. This has been tested in OBS on Windows 10 but should work on Windows 11 and in Streamlabs. Linux, having no Game Capture option should be unaffected by this issue.

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 requires working graphics acceleration, and we recommend at least a dual core CPU to avoid slowing down your game of DF.

Useful links