caldfir / stonesense Goto Github PK

Welcome to Stonesense Felsite(3.1)

Thank you for trying out our little visualizer,
as always, we appreciate any feedback.

Please note that stonesense is tightly bound to DFHack, and so only works for the version that
the accompanying DFHack is built for.

To run stonesense, Copy DFHack into the dwarf fortress folder, and run DwarfFortress.exe.
When DFHack console appears, type in stonesense and press enter.

--== Configuration ==--

Application options are set and documented in the init.txt file

--== Controls ==--

-- Mouse --
Left click: Move debug cursor (if available)
Right click: Recenter screen
Scrollwheel: Move up and down 
Ctrl-Scrollwheel: Increase/decrease Z depth shown

-- Keyboard --
Check keybinds.txt for the configured key bindings and descriptions.

-- Follow mode --
When you turn on follow mode, the screen will jump to the location of the DF window.
You can adjust the position of the follow mode relative to the DF window by
holding Ctrl while using the keyboard window movement keys.

When you turn on cursor follow mode, the debug cursor will follow the DF cursor when it exists.

--== Contacts ==--

Stonesense mailing list:
http://groups.google.com/group/stonesense

Stonesense on Bay12Games forums:
http://www.bay12games.com/forum/index.php?topic=43260.0

--== Known Issues ==--

We have seen some crash bugs from time to times.

Good Luck!
- The Stonesense Crew