MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some info about stonesense to readme.

develop
Petr Mrázek 2011-08-14 03:18:34 +02:00
parent 42e06c6330
commit 02ea81c0b3
2 changed files with 37 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
Unescape Escape View File

@ -53,10 +53,12 @@ DFHack basically extends what DF can do with something similar to a quake consol
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. 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. 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 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'). 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. 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/). Most of the commands come from plugins. Those reside in 'DF/plugins/'.
======== ========
Commands Commands
@ -189,6 +191,20 @@ revflood
======== ========
This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor. This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.
ssense / stonesense
===================
This is an isometric visualizer that is runs in a second window.
This requires working graphics acceleration, at least a dual core CPU (otherwise it will slow down DF) and on Linux, the allegro 5 libraries installed (look for 'allegro5' in your package manager app).
For further details, see the contents of 'DF/stonesense'.
Older versions, support and extra graphics can be found in the bay12 forum thread:
http://www.bay12forums.com/smf/index.php?topic=43260.0
Some additional resources:
http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository
tubefill tubefill
========== ==========
Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug). Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).
@ -201,7 +217,3 @@ weather
======= =======
Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.
Fill those ponds without mucking around with dfliquids :D Rain can also stop brush fires. Fill those ponds without mucking around with dfliquids :D Rain can also stop brush fires.
ssense
======
Creates a stonesense window!

26
Readme.html
Unescape Escape View File

@ -366,9 +366,10 @@ access DF memory and allow for easier development of new tools.</p>
<li><a class="reference internal" href="#unreveal" id="id32">unreveal</a></li> <li><a class="reference internal" href="#unreveal" id="id32">unreveal</a></li>
<li><a class="reference internal" href="#revtoggle" id="id33">revtoggle</a></li> <li><a class="reference internal" href="#revtoggle" id="id33">revtoggle</a></li>
<li><a class="reference internal" href="#revflood" id="id34">revflood</a></li> <li><a class="reference internal" href="#revflood" id="id34">revflood</a></li>
<li><a class="reference internal" href="#tubefill" id="id35">tubefill</a></li> <li><a class="reference internal" href="#ssense-stonesense" id="id35">ssense / stonesense</a></li>
<li><a class="reference internal" href="#vdig" id="id36">vdig</a></li> <li><a class="reference internal" href="#tubefill" id="id36">tubefill</a></li>
<li><a class="reference internal" href="#weather" id="id37">weather</a></li> <li><a class="reference internal" href="#vdig" id="id37">vdig</a></li>
<li><a class="reference internal" href="#weather" id="id38">weather</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -412,9 +413,10 @@ Copy the files from a release archive so that:</p>
<p>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). <p>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. 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.</p> Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.</p>
<p>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).</p>
<p>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'). <p>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.</p> Some commands can't be used from hotkeys - this includes interactive commands like 'liquids' and commands that have names longer than 9 characters.</p>
<p>Most of the commands come from plugins (those reside in DF/plugins/).</p> <p>Most of the commands come from plugins. Those reside in 'DF/plugins/'.</p>
</div> </div>
<div class="section" id="commands"> <div class="section" id="commands">
<h1><a class="toc-backref" href="#id10">Commands</a></h1> <h1><a class="toc-backref" href="#id10">Commands</a></h1>
@ -582,16 +584,26 @@ You just lost a fortress and gained an adventurer.</p>
<h2><a class="toc-backref" href="#id34">revflood</a></h2> <h2><a class="toc-backref" href="#id34">revflood</a></h2>
<p>This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.</p> <p>This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.</p>
</div> </div>
<div class="section" id="ssense-stonesense">
<h2><a class="toc-backref" href="#id35">ssense / stonesense</a></h2>
<p>This is an isometric visualizer that is runs in a second window.</p>
<p>This requires working graphics acceleration, at least a dual core CPU (otherwise it will slow down DF) and on Linux, the allegro 5 libraries installed (look for 'allegro5' in your package manager app).</p>
<p>For further details, see the contents of 'DF/stonesense'.</p>
<p>Older versions, support and extra graphics can be found in the bay12 forum thread:
<a class="reference external" href="http://www.bay12forums.com/smf/index.php?topic=43260.0">http://www.bay12forums.com/smf/index.php?topic=43260.0</a></p>
<p>Some additional resources:
<a class="reference external" href="http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository">http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository</a></p>
</div>
<div class="section" id="tubefill"> <div class="section" id="tubefill">
<h2><a class="toc-backref" href="#id35">tubefill</a></h2> <h2><a class="toc-backref" href="#id36">tubefill</a></h2>
<p>Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).</p> <p>Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).</p>
</div> </div>
<div class="section" id="vdig"> <div class="section" id="vdig">
<h2><a class="toc-backref" href="#id36">vdig</a></h2> <h2><a class="toc-backref" href="#id37">vdig</a></h2>
<p>Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).</p> <p>Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).</p>
</div> </div>
<div class="section" id="weather"> <div class="section" id="weather">
<h2><a class="toc-backref" href="#id37">weather</a></h2> <h2><a class="toc-backref" href="#id38">weather</a></h2>
<p>Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. <p>Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.
Fill those ponds without mucking around with dfliquids :D Rain can also stop brush fires.</p> Fill those ponds without mucking around with dfliquids :D Rain can also stop brush fires.</p>
</div> </div>