summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorJapa2010-04-09 14:24:27 +0000
committerJapa2010-04-09 14:24:27 +0000
commit114df922d3073bd296b38cf522997f520fb17850 (patch)
treec4cf372825118c3663cd77e18c69a6c3b59d070f /README.txt
parent81aefc8e03ff3f647494012e18bcdc8f33f4de42 (diff)
downloadstonesense-114df922d3073bd296b38cf522997f520fb17850.tar.gz
stonesense-114df922d3073bd296b38cf522997f520fb17850.tar.bz2
stonesense-114df922d3073bd296b38cf522997f520fb17850.tar.xz
updated trunk to the new graphics engine, and the latest DFhack
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt75
1 files changed, 75 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..470c17c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,75 @@
+Welcome to Stonesense 1.0
+
+Thank you for trying out our little visualizer,
+as always, we appreciate any feedback.
+
+Make sure you have DF running, with your game loaded.
+
+If all you see is a blank screen, DON'T PANIC.
+This just means you're viewing a hidden area.
+Use the coordinates in the upper left to move up or down till you hit the surface.
+
+--== 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 --
+Arrow keys: Move around (hold shift for large moves)
+PG UP/PG Down: Move up and down
+9 and 0: Alternative move up and down
+1 and 2: Increase/decrease Z depth shown
+Enter: Rotate view 90 degrees
+ESC: Exit program
+U: Toggle Stockpiles
+I: Toggle Zones
+C: Toggle Truncated Walls
+F: Toggle Follow Mode
+H: Toggle Hidden Blocks
+B: Toggle Blacked Out Areas
+S: Toggle Single Layer View
+N: Toggle Creature Names
+F2: Hide Display Overlays
+F5: Save Screenshot
+Numpad + and -: Increase/Decrease AutoReload Rate
+
+-- Debug Keys --
+(prolly not useful for you guys)
+D: redraw screen
+R: reload memory from DF
+G: reload sprites & config from disk
+F10: display available sprites
+Numpad numbers: Move debug cursor (if available)
+Ctrl+F: Toggle Cursor Follow Mode
+
+-- 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 ==--
+
+The system tries to avoid reading when theres no valid map, but it will still
+occasionally get the timing and die
+Some slight memory leaks- dont leave it running 8 hours
+
+Good Luck!
+- The Stonesense Crew \ No newline at end of file