diff --git a/README.rst b/README.rst index b32ce4f4e..127c08ce1 100644 --- a/README.rst +++ b/README.rst @@ -19,6 +19,8 @@ binaries at http://github.com/peterix/dfhack Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads +All new releases are announced in the bay12 thread: http://tinyurl.com/dfhack-ng + ============= Compatibility ============= @@ -46,6 +48,11 @@ Uninstalling is basically the same, in reverse: * On Windows, first delete SDL.dll and rename SDLreal.dll to SDL.dll. Then remove the other DFHack files * On Linux, Remove the DFHack files. +The stonesense plugin might require some additional libraries on Linux: + * libjpeg 8 + +If it refuses to load, check the stderr.log file created in your DF folder. + ============ Using DFHack ============ @@ -60,6 +67,12 @@ Some commands can't be used from hotkeys - this includes interactive commands li Most of the commands come from plugins. Those reside in 'DF/plugins/'. +============================= +Something doesn't work, help! +============================= +First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening. +If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (peterix@gmail.com) or visit the #dfhack IRC channel on freenode. + ======== Commands ======== diff --git a/Readme.html b/Readme.html index a10d6356b..e12322084 100644 --- a/Readme.html +++ b/Readme.html @@ -331,49 +331,50 @@ access DF memory and allow for easier development of new tools.
The project is currently hosted on github, for both source and binaries at http://github.com/peterix/dfhack
Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads
+All new releases are announced in the bay12 thread: http://tinyurl.com/dfhack-ng
DFHack basically extends what DF can do with something similar to a quake console. On Windows, this is a separate command line window. On linux, the terminal used to launch the dfhack script is taken over (so, make sure you start from a terminal). Basic interaction with dfhack involves entering commands into the console. For some basic instroduction, use the 'help' command. To list all possible commands, use the 'ls' command. Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.
-The command line has some nce line editing capabilities, including history that's preserved between different runs of DF (use up/down keys to go through the history).
+The command line has some nice line editing capabilities, including history that's preserved between different runs of DF (use up/down keys to go through the history).
The second way to interact with DFHack is to bind the available commands to in-game hotkeys. This is done in the hotkey/zoom menu (normally opened with the 'h' key). Binding the commands is done by assigning a command as a hotkey name (with 'n'). Some commands can't be used from hotkeys - this includes interactive commands like 'liquids' and commands that have names longer than 9 characters.
Most of the commands come from plugins. Those reside in 'DF/plugins/'.
First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening. +If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (peterix@gmail.com) or visit the #dfhack IRC channel on freenode.
+Automated item dumping tool. All loose items on the floor marked for dumping are insta-dumped to the position of the in-game cursor.
Cursor must be placed on a floor tile. Instadumped items may not show up in the cursor description list until you save/reload.