Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 3.01 KB

Stonesense.rst

File metadata and controls

83 lines (63 loc) · 3.01 KB
Raw
orphan

Stonesense

Stonesense is an isometric visualizer for Dwarf Fortress, implemented as a DFHack plugin <plugin-stonesense>.

Useful links:

  • Official Stonesense thread <106497> for feedback, questions, requests or bug reports
  • Screenshots thread <48172>
  • Main wiki page <Utility:Stonesense>
  • How to add content <Utility:Stonesense/Adding_Content>
  • Stonesense on Github

Usage

The DFHack command stonesense (or ssense) opens Stonesense in a new window. This viewer window has read-only access to the game, and can follow the game view, or be moved independently.

The above-ground part of the fortress Roadtruss.

The above-ground part of the fortress Roadtruss.

Configuration options are documented and can be pre-set in ../resources/init.txt.

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 keyboard 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 ../resources/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:

Known Issues

If Stonesense gives an error saying that it can't load creatures/large_256/*.png, your video card cannot handle the high detail sprites used. Either open creatures/init.txt and remove the line containing that folder, or use these smaller sprites <6096>.

Mega screenshots (CtrlShiftF5) put the buffer into an invalid state after the screenshot is written to disk. After completing a mega screenshot, the Stonesense window becomes unresponsive and you have to close it and re-run stonesense to continue using it.

Stonesense requires working graphics acceleration, and we recommend at least a dual core CPU to avoid slowing down your game of DF.