https://dwarffortresswiki.org/api.php?action=feedcontributions&feedformat=atom&user=WarmistDwarf Fortress Wiki - User contributions [en]2026-05-19T04:31:57ZUser contributionsMediaWiki 1.35.11https://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=198777Utility:DFusion2014-04-21T08:50:57Z<p>Warmist: Add a outdated warning.</p>
<hr />
<div>WARNING: this page is very outdated. <br />
== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
<br />
Note: You may see the following error when running dfusion in DFHack: "dfusion/common.lua:45: . Text region not found!"<br />
<br />
You just have to do an easy text change to fix it. Find this line in DF/dfusion/common.lua (it's near the top):<br />
local pos=string.find(v.name,".text") or string.find(v.name,"libs/Dwarf_Fortress")<br />
<br />
Then, replace ".text" with "Dwarf Fortress.exe" and save.<br />
<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
Up-to-date api help could be found here: https://github.com/peterix/dfhack/blob/master/LUA_API.rst<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags1.dead=true --is same as...<br />
first_unit.flags1[1]=true --... this<br />
</pre><br />
For convienence there is function printall:<br />
<pre><br />
printall(df.global.world.units.all) --prints all the units, with locations in memory<br />
</pre><br />
<br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| pokestr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
<br />
Individual units can be modified - skills, jobs, attributes, etc. This example selects a unit under the look cursor, updates the name and updates the level and experience for selected skills. <br />
<pre><br />
--Takes a selected unit and instantly turns them into Morul - upgrading all appropriate skills to Legendary or higher, as appropriate<br />
--By Martin, 5/25/2012, excerpt for demonstration purposes<br />
--This code gets cut/pasted at the end of /dfusion/tools/init.lua<br />
function tools.morul(unit)<br />
--include the utils library which we need later<br />
utils = require 'utils'<br />
--a unit address can be passed into this function, handle the case where one isn't<br />
if unit==nil then<br />
unit=getCreatureAtPointer() --place the x pointer on top of the creature you want to change. best use is the look pointer 'k' and not 'v'<br />
end<br />
--Set the name. Surname is comprised of an array of references [words] into the language file. Each entry grabs a word fragment and the name is all of these catenated <br />
unit.name.first_name = "Morul"<br />
unit.name.words[0] = 1416 --[T_WORD:CHANNEL:catten]<br />
unit.name.words[1] = 1304 --[T_WORD:BEND:mat]<br />
<br />
--skill level we wish to apply to all labors. Dabbling is 0, Legendary is 15<br />
labor_rating = 15<br />
--the skill level we wish to apply to all military skills. <br />
military_rating = 70<br />
<br />
--These are the skill ids we want to add. The ids were identified in game_data.ini in DwarfTherapist.<br />
skill = { 0,2,3,4,5,6,7,8,9,10,11,12,13,14,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,41,42,43,44,45,46,47,48,49,54,55,57,58,59,60,61,62,63,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,95,96,97,98,99,100,101,102,103,104,105,109,110,111,112,113,114,115 }<br />
--These are the military skills that will get higher values. Subset of the list above.<br />
military = { 38,39,41,42,43,44,45,46,54,99,100,101,102,103,104,105 }<br />
<br />
--ipairs iterates over each indexed item in the skill list. Lua index is 1 based, so remember that.<br />
for sk,sv in ipairs(skill) do<br />
--assume the labor rating will apply<br />
new_rating = labor_rating<br />
--iterate over the military list<br />
for _,v in ipairs(military) do<br />
--if the value from the skill list iteration is in the military list...<br />
if v == sv then<br />
--then use the military skill level<br />
new_rating = military_rating<br />
end<br />
end<br />
--the skills need to be inserted in a particular way. This standard function passes the id, the skill level, and the experience value, and tells the tool to keep the skills sorted by id. <br />
--the experience calculation reflects the minimum experience to earn the level and allows skills to continue to advance.<br />
utils.insert_or_update(unit.status.current_soul.skills, { new = true, id = sv, rating = new_rating, experience = (new_rating * 500) + (new_rating * (new_rating - 1)) * 50}, 'id')<br />
end<br />
<br />
-- walk over each of the skills we just set and print them out so we can confirm each update<br />
for sk,sv in ipairs(unit.status.current_soul.skills) do<br />
-- print the skill data. Printall will print entire tables and is handy at poking at the data structures<br />
printall(sv)<br />
end<br />
end<br />
<br />
--add the function above to the dfusion menu system as a submenu under the 'Tools' menu.<br />
tools.menu:add("Morul",tools.morul)<br />
</pre><br />
<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfuse'' and then use run ''lua''<br />
* You can bind keys to lua commands (in dfusion context) like this: ''keybindings add Shift-R "dfuse adv_tools.reincarnate()"''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=169649Utility:DFusion2012-04-09T18:39:50Z<p>Warmist: /* Exported functions and objects */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
Up-to-date api help could be found here: https://github.com/peterix/dfhack/blob/master/LUA_API.rst<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags.dead=true --is same as...<br />
first_unit.flags[1]=true --... this<br />
</pre><br />
For convienence there is function printall:<br />
<pre><br />
printall(df.global.world.units.all) --prints all the units, with locations in memory<br />
</pre><br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
<br />
...TODO...<br />
<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfuse'' and then use run ''lua''<br />
* You can bind keys to lua commands (in dfusion context) like this: ''keybindings add Shift-R "dfuse adv_tools.reincarnate()"''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=169427Utility:DFusion2012-04-05T09:33:58Z<p>Warmist: /* Tips and Tricks */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
This is also useful to get what fields are available:<br />
<pre><br />
for k,v in pairs(df.global) do --any object can be instead of df.global<br />
print(k)<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags.dead=true --is same as...<br />
first_unit.flags[1]=true --... this<br />
</pre><br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
<br />
...TODO...<br />
<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfuse'' and then use run ''lua''<br />
* You can bind keys to lua commands (in dfusion context) like this: ''keybindings add Shift-R "dfuse adv_tools.reincarnate()"''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=169426Utility:DFusion2012-04-05T09:32:32Z<p>Warmist: /* How to */ Removed onfunction as that is gone...</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
This is also useful to get what fields are available:<br />
<pre><br />
for k,v in pairs(df.global) do --any object can be instead of df.global<br />
print(k)<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags.dead=true --is same as...<br />
first_unit.flags[1]=true --... this<br />
</pre><br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
<br />
...TODO...<br />
<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=168959Utility:DFusion2012-03-31T08:03:45Z<p>Warmist: /* Patterns */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
This is also useful to get what fields are available:<br />
<pre><br />
for k,v in pairs(df.global) do --any object can be instead of df.global<br />
print(k)<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags.dead=true --is same as...<br />
first_unit.flags[1]=true --... this<br />
</pre><br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=168958Utility:DFusion2012-03-31T08:03:24Z<p>Warmist: /* Exported functions and objects */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
The DF is accessed by object 'df'. This object holds all the types, globals table and some helper functions.<br />
=== Examples ===<br />
<pre><br />
first_unit=df.global.world.units.all[0] --gets first unit<br />
first_unit.name.first_name="Urist"<br />
</pre><br />
You can iterate in all the objects:<br />
<pre><br />
for k,v in pairs(df.global.world.units.all) do --gets ALL the units<br />
v.name.first_name="Urist" --now everyone will be called URIST!!<br />
end<br />
</pre><br />
This is also useful to get what fields are available:<br />
<pre><br />
for k,v in pairs(df.global) do --any object can be instead of df.global<br />
print(k)<br />
end<br />
</pre><br />
Also all the flags can be accessed by name or by number:<br />
<pre><br />
first_unit.flags.dead=true --is same as...<br />
first_unit.flags[1]=true --... this<br />
</pre><br />
=== Other objects ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=167566Utility:DFusion2012-03-18T00:22:51Z<p>Warmist: /* Usage */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
<br />
Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists<br />
<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Df memory object ===<br />
In the new version there is a table called "df". It holds all the global objects of DF. To get list of fields available use 'printGlobals()'.<br />
There are also helper functions 'printFields(object)' and 'addressOf(object,[field])'<br />
Using new df object is very simple:<br />
<pre><br />
-- to get<br />
print(df.window_x)<br />
-- to set<br />
df.window_x=1<br />
</pre><br />
Some objects returned are more complex:<br />
<pre><br />
--most complex object (afaik)<br />
printFields(df.world)<br />
</pre><br />
At first it will be confusing, but worry not, there is a tool (dfusion->editor) that lets you edit df without writing lua code.<br />
<br />
Some notes:<br />
Sometimes returned object is a pointer, than you need to dereference it:<br />
<pre><br />
-- this gets first unit, but it's a pointer, so dereference it<br />
df.world.units.all[0]:deref().pos.x=0<br />
-- also as you can see 'all' is a vector (or an array) so you can access it's members by numbers. This works on flags too.<br />
</pre><br />
<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=167565Utility:DFusion2012-03-18T00:20:46Z<p>Warmist: /* Usage */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Df memory object ===<br />
In the new version there is a table called "df". It holds all the global objects of DF. To get list of fields available use 'printGlobals()'.<br />
There are also helper functions 'printFields(object)' and 'addressOf(object,[field])'<br />
Using new df object is very simple:<br />
<pre><br />
-- to get<br />
print(df.window_x)<br />
-- to set<br />
df.window_x=1<br />
</pre><br />
Some objects returned are more complex:<br />
<pre><br />
--most complex object (afaik)<br />
printFields(df.world)<br />
</pre><br />
At first it will be confusing, but worry not, there is a tool (dfusion->editor) that lets you edit df without writing lua code.<br />
<br />
Some notes:<br />
Sometimes returned object is a pointer, than you need to dereference it:<br />
<pre><br />
-- this gets first unit, but it's a pointer, so dereference it<br />
df.world.units.all[0]:deref().pos.x=0<br />
-- also as you can see 'all' is a vector (or an array) so you can access it's members by numbers. This works on flags too.<br />
</pre><br />
<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=167564Utility:DFusion2012-03-18T00:15:43Z<p>Warmist: /* Exported functions and objects */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Df memory object ===<br />
In the new version there is a table called "df". It holds all the global objects of DF. To get list of fields available use 'printGlobals()'.<br />
There are also helper functions 'printFields(object)' and 'addressOf(object,[field])'<br />
Using new df object is very simple:<br />
<pre><br />
-- to get<br />
print(df.window_x)<br />
-- to set<br />
df.window_x=1<br />
</pre><br />
Some objects returned are more complex:<br />
<pre><br />
--most complex object (afaik)<br />
printFields(df.world)<br />
</pre><br />
At first it will be confusing, but worry not, there is a tool (dfusion->editor) that lets you edit df without writing lua code.<br />
<br />
Some notes:<br />
Sometimes returned object is a pointer, than you need to dereference it:<br />
<pre><br />
-- this gets first unit, but it's a pointer, so dereference it<br />
df.world.units.all[0]:deref().pos.x=0<br />
-- also as you can see 'all' is a vector (or an array) so you can access it's members by numbers. This works on flags too.<br />
</pre><br />
<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=167563Utility:DFusion2012-03-18T00:09:17Z<p>Warmist: /* Exported functions and objects */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Df memory object ===<br />
In the new version there is a table called "df". It holds all the global objects of DF. To get list of fields available use 'printGlobals()'.<br />
<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=167562Utility:DFusion2012-03-18T00:06:00Z<p>Warmist: /* Exported functions and objects */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== runlua ===<br />
Similar to ''lua <filename>'' but not interactive, to be used with hotkeys<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
=== dfuse ===<br />
Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).<br />
<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
DEPRECATED use types[<tname>] or directly df.<subitem><br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=159310Utility:DFusion2012-01-07T22:28:34Z<p>Warmist: /* engine. */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Dfhack/DF interface ===<br />
These functions are sown into dfhack or modifies DF directly<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== OffsetGroup: ====<br />
==== engine. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| peek(b\w\d)<br />
| reads byte\word\double word from memory<br />
| peekb(0x15486)<br />
|-<br />
| peekarb<br />
| reads a chunk of memory<br />
| peekarb(0x15486,100) -- reads 100 bytes from 0x15486<br />
|-<br />
| peekstr<br />
| reads a string from memory<br />
| peekstr(0x15486) <br />
|-<br />
| poke(b\w\d)<br />
| writes byte\word\double word to memory<br />
| peekb(0x15486,100)<br />
|-<br />
| pokearb<br />
| writes a chunk of memory (gotten with peekarb)<br />
| pokearb(0x15486,data,100) -- writes 100 bytes from data to 0x15486<br />
|-<br />
| pokestr<br />
| writes a string to memory<br />
| peekstr(0x15486,"Hello world") <br />
|}<br />
<br />
==== FunctionCall.====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| call(f_ptr,calling_convention,arguments...)<br />
| calls a function from df. Supports up to 7 arguments. Danger: this could (and probably will) crash df if used incorrectly.<br />
| FunctionCall.call(somepointertofunction,FunctionCall.THIS_CALL,thisptr)<br />
|-<br />
| THIS_CALL<br />
| a numeric constant for function calling convention. <br />
| -<br />
|-<br />
| STD_CALL<br />
| -"-<br />
| -<br />
|-<br />
| FAST_CALL<br />
| -"-<br />
| -<br />
|-<br />
| CDECL_CALL<br />
| -"-<br />
| -<br />
|}<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
See patterns.lua and itempatters.lua. This will be refactored in the future to use Memory.xml (thus be version and Os independent).<br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153121Utility:DFusion2011-09-17T16:13:04Z<p>Warmist: /* Dfhack/DF interface */</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Dfhack/DF interface ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
==== Process. ====<br />
==== VersionInfo. ====<br />
==== OffsetGroup: ====<br />
==== engine. ====<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
See patterns.lua and itempatters.lua. This will be refactored in the future to use Memory.xml (thus be version and Os independent).<br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153120Utility:DFusion2011-09-17T16:08:39Z<p>Warmist: Added console exports</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== Exported functions and objects ==<br />
Objects differ from functions by calling convention ( using '':'' instead of '.'). Also most of the functions are grouped.<br />
=== Dfhack/DF interface ===<br />
==== Console. ====<br />
{| class="wikitable"<br />
|-<br />
! name<br />
! description<br />
! example<br />
|-<br />
| print<br />
| prints a message to dfhack console<br />
| Console.print("Hello world!")<br />
|-<br />
| printerr<br />
| prints an error message to dfhack console<br />
| Console.printerr("Error world!")<br />
|-<br />
| clear<br />
| clears console<br />
| Console.clear()<br />
|-<br />
| color<br />
| sets text color<br />
| Console.color(2)<br />
|-<br />
| reset_color<br />
| resets text color to defaults<br />
| Console.reset_color()<br />
|-<br />
| cursor<br />
| sets if the cursor should be visible<br />
| Console.cursor(true)<br />
|-<br />
| msleep<br />
| waits for x milliseconds <br />
| Console.msleep(200)<br />
|-<br />
| get_columns<br />
| returns number of columns in the console<br />
| Console.get_columns()<br />
|-<br />
| get_rows<br />
| returns number of rows in the console<br />
| Console.get_rows()<br />
|-<br />
| lineedit<br />
| asks user for input<br />
| Console.lineedit("Type in your name:")<br />
|}<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
See patterns.lua and itempatters.lua. This will be refactored in the future to use Memory.xml (thus be version and Os independent).<br />
<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153119Utility:DFusion2011-09-17T15:59:36Z<p>Warmist: Added exported functions section</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== Exported functions ==<br />
=== Dfhack/DF interface ===<br />
<br />
=== From scripts ===<br />
These commands are exported from script files. Most of them are in "common.lua" file.<br />
=== Patterns ===<br />
See patterns.lua and itempatters.lua. This will be refactored in the future to use Memory.xml (thus be version and Os independent).<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153118Utility:DFusion2011-09-17T15:56:08Z<p>Warmist: added tips and trics section</p>
<hr />
<div>== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)<br />
== Tips and Tricks ==<br />
* To use dfusion's functionality in lua first run ''dfusion'' (exit it with 'q') and then use run ''lua''</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153117Utility:DFusion2011-09-17T15:46:52Z<p>Warmist: /* OnFunction */</p>
<hr />
<div><br />
== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return address. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name). Then print it to the console.<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153116Utility:DFusion2011-09-17T15:45:53Z<p>Warmist: /* OnFunction */</p>
<hr />
<div><br />
== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by ''onfunction.SetCallback(name,function)''. For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return value. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name).<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153115Utility:DFusion2011-09-17T15:39:04Z<p>Warmist: /* DFusion info page */</p>
<hr />
<div><br />
== DFusion info page ==<br />
Thread for discussions: [http://www.bay12forums.com/smf/index.php?topic=93317.0 Thread]<br />
== Usage ==<br />
Dfusion plugin offers two DFhack commands: 'dfusion' and 'lua'.<br />
=== lua ===<br />
Runs an interactive lua console. For more on lua commands see [http://www.lua.org/manual/5.1/manual.html Lua reference manual] or google "lua". Also this command could be ran with filepath as an argument. Then it runs that file as a lua script file. E.g. ''lua dfusion/temp.lua'' runs a file <your df path>/dfusion/temp.lua.<br />
=== dfusion ===<br />
First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.<br />
== How to ==<br />
This section explains in detail some of more complex things that could be done with dfusion.<br />
=== OnFunction ===<br />
There are two parts to OnFunction: adding new triggers and using already existing triggers. To add new trigger you must know exact location of function call (and what it does) also it would help a lot if you know what registers correspond to what data. Usually this could be worked out by analysing call stack after setting a data breakpoint (watch in GDB) and then guessing what does what. <br />
Using already existing triggers is way simpler. Adding a callback (a function to be called when a trigger is encountered) is done by onfunction.SetCallback(name,function). For possible names see locations.lua (at the time of writing there is "Move" and "Die" both in Linux and Windows). Possible use of it:<br />
<br />
<pre><br />
function DeathMsg(values)<br />
local name<br />
name=engine.peek(values[onfunction.hints["Die"].creature],ptt_dfstring)<br />
print(name:getval().." died")<br />
end<br />
onfunction.SetCallback("Die",DeathMsg)<br />
</pre><br />
In this example we bind 'DeathMsg' function to "Die" trigger. Values argument has all the registers and a return value. So we lookup from witch register do we need to read the creature pointer ( ''values[onfunction.hints["Die"].creature'' ) and read a string just from the beginning (usually the creature starts with his name).<br />
<br />
Note: there can be only one callback per trigger. Also if you know any more trigger locations please share :)</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=153114User:Warmist2011-09-17T15:15:26Z<p>Warmist: /* Intro */</p>
<hr />
<div>=Intro=<br />
A dfhacker :)<br />
<br />
[[Utility:DFusion]] - a lua based DFhack plugin<br />
<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu or playing. (first five tiles either empty or border), from v0.5 fps can be on<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can be used to control (with keyboard, no mouse support) DF if server allows it. To do that DF window must be selected (white star in upper left corner).<br />
*Server settings:<br />
**''Allow new users contorl:True/False'' means that new users can control DF.<br />
**''User:<some name>'' select a user (with arrows or by dragging mouse)<br />
**''Kick'' kicks the selected user<br />
**''Toggle Allow Control'' Toggles selected users permission to control DF.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=Utility:DFusion&diff=153113Utility:DFusion2011-09-17T15:15:08Z<p>Warmist: Created page with ' == DFusion info page =='</p>
<hr />
<div><br />
== DFusion info page ==</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=153112User:Warmist2011-09-17T15:12:53Z<p>Warmist: /* Intro */</p>
<hr />
<div>=Intro=<br />
A dfhacker :)<br />
<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu or playing. (first five tiles either empty or border), from v0.5 fps can be on<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can be used to control (with keyboard, no mouse support) DF if server allows it. To do that DF window must be selected (white star in upper left corner).<br />
*Server settings:<br />
**''Allow new users contorl:True/False'' means that new users can control DF.<br />
**''User:<some name>'' select a user (with arrows or by dragging mouse)<br />
**''Kick'' kicks the selected user<br />
**''Toggle Allow Control'' Toggles selected users permission to control DF.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist/monopage.js&diff=89701User:Warmist/monopage.js2010-04-11T10:45:28Z<p>Warmist: Created page with 'importScript('User:Briess/hideAnnouncements.js');'</p>
<hr />
<div>importScript('User:Briess/hideAnnouncements.js');</div>Warmisthttps://dwarffortresswiki.org/index.php?title=40d:Memory_hacking/v0.28.181.40d16&diff=5485540d:Memory hacking/v0.28.181.40d162009-10-12T19:04:58Z<p>Warmist: Created page with '== Addresses == Note: could be wrong (not all tested from d14), but mostly good and working. <pre> pointer_x_pos == 0x05662B4 pointer_y_pos == 0x05662B8 pointer…'</p>
<hr />
<div>== Addresses ==<br />
Note: could be wrong (not all tested from d14), but mostly good and working.<br />
<pre><br />
pointer_x_pos == 0x05662B4 <br />
pointer_y_pos == 0x05662B8 <br />
pointer_z_pos == 0x05662BC <br />
window_x_pos == 0x09A060C<br />
window_y_pos == 0x09CE6B8<br />
window_z_pos == 0x09CE694<br />
selected_creature_id == 0x09E1F44<br />
is_paused == 0x0FDC2C7<br />
notes_vector == 0x0FEF5E0 <br />
job_list_iterator_st == 0x11BE7E8<br />
creatures_vec == 0x11bde60<br />
items_vec == 0x11bdf54<br />
items_vec_ex == 0x11bdf3c <- includes items not in map(artifacts made in others forts)<br />
messages_vec == 0x1201D1C<br />
reactions_vec == 0x1A30CE0<br />
races_vec == 0x1203F70<br />
effects_vec == 0x1347F24<br />
stonegloss_vec == 0x1203F10<br />
metalgloss_vec == 0x1203F40<br />
</pre></div>Warmisthttps://dwarffortresswiki.org/index.php?title=40d:Memory_hacking&diff=5485440d:Memory hacking2009-10-12T18:56:31Z<p>Warmist: Added 40d16</p>
<hr />
<div>== Versions ==<br />
See the following subpages for version specific information<br />
* '''[[Memory hacking/v0.27.169.33g|v0.27.169.33g]]'''<br />
* [[Memory hacking/v0.27.169.33f|v0.27.169.33f]]<br />
* [[Memory hacking/v0.27.169.33e|v0.27.169.33e]]<br />
* [[Memory hacking/v0.27.169.33d|v0.27.169.33d]]<br />
* [[Memory hacking/v0.27.169.33c|v0.27.169.33c]]<br />
* [[Memory hacking/v0.27.169.33b|v0.27.169.33b]]<br />
* [[Memory hacking/v0.27.169.33a|v0.27.169.33a]]<br />
* [[Memory hacking/v0.28.181.40d16|v0.28.181.40d16]]<br />
== Data Types ==<br />
=== String ===<br />
<br />
{| border="1" cellpadding="2" width="100%"<br />
| Offset || Size || Type || Description<br />
|-<br />
| 0x00 || 4 || Junk || Junk data that exists due to a curious artifact in the C++ standard. Technically it's the allocator - in reality, the default allocator has no data associated with it.<br />
|-<br />
| 0x04 || 16 || Character buffer || Holds the string data if capacity < 16<br />
|-<br />
| 0x04 || 4 || Character pointer || Points to the string data if capacity >= 16<br />
|-<br />
| 0x14 || 4 || Length || Current length of the string<br />
|-<br />
| 0x18 || 4 || Capacity || Current capacity of the string buffer (also indicates which mode the string is in)<br />
|}<br />
<br />
Yes, the second two items overlap. This is correct. This is the MSVC Express string format - Toady appears to be using standard C++ structures pretty much everywhere.<br />
<br />
=== Vector ===<br />
<br />
{| border="1" cellpadding="2" width="100%"<br />
| Offset || Size || Type || Description<br />
|-<br />
| 0x00 || 4 || Junk || Junk data that exists due to a curious artifact in the C++ standard. Technically it's the allocator - in reality, the default allocator has no data associated with it.<br />
|-<br />
| 0x04 || 4 || Array start<br />
|-<br />
| 0x08 || 4 || Array end || (End - Start)/4 = # of elements (if pointers)<br />
|-<br />
| 0x0C || 4 || Array allocated end || (Allocated End - Start)/4 = capacity (if pointers)<br />
|}<br />
<br />
== Type ID list ==<br />
<br />
Most likely incomplete, but this was all that could be found so far.<br />
<br />
{| border="1" cellpadding="2" width="100%"<br />
| ID || Meaning<br />
|-<br />
| <code>0x00</code> || Miner<br />
|-<br />
| <code>0x01</code> || Woodworker<br />
|-<br />
| <code>0x02</code> || Carpenter<br />
|-<br />
| <code>0x03</code> || Bowyer<br />
|-<br />
| <code>0x04</code> || Woodcutter<br />
|-<br />
| <code>0x05</code> || Stoneworker<br />
|-<br />
| <code>0x06</code> || Engraver<br />
|-<br />
| <code>0x07</code> || Mason<br />
|-<br />
| <code>0x08</code> || Ranger<br />
|-<br />
| <code>0x09</code> || Animal Caretaker<br />
|-<br />
| <code>0x0A</code> || Animal Trainer<br />
|-<br />
| <code>0x0B</code> || Hunter<br />
|-<br />
| <code>0x0C</code> || Trapper<br />
|-<br />
| <code>0x0D</code> || Animal Dissector<br />
|-<br />
| <code>0x0E</code> || Metalsmith<br />
|-<br />
| <code>0x0F</code> || Furnace Operator<br />
|-<br />
| <code>0x10</code> || Weaponsmith<br />
|-<br />
| <code>0x11</code> || Armorer<br />
|-<br />
| <code>0x12</code> || Blacksmith<br />
|-<br />
| <code>0x13</code> || Metalcrafter<br />
|-<br />
| <code>0x14</code> || Jeweler<br />
|-<br />
| <code>0x15</code> || Gem Cutter<br />
|-<br />
| <code>0x16</code> || Gem Setter<br />
|-<br />
| <code>0x17</code> || Craftsman<br />
|-<br />
| <code>0x18</code> || Woodcrafter<br />
|-<br />
| <code>0x19</code> || Stonecrafter<br />
|-<br />
| <code>0x1A</code> || Leatherworker<br />
|-<br />
| <code>0x1B</code> || Bone Carver<br />
|-<br />
| <code>0x1C</code> || Weaver<br />
|-<br />
| <code>0x1D</code> || Clothier<br />
|-<br />
| <code>0x1E</code> || Glassmaker<br />
|-<br />
| <code>0x1F</code> || Strand Extractor<br />
|-<br />
| <code>0x20</code> || Queen<br />
|-<br />
| <code>0x21</code> || Queen Consort<br />
|-<br />
| <code>0x22</code> || Fishery Worker<br />
|-<br />
| <code>0x23</code> || Fisherman<br />
|-<br />
| <code>0x24</code> || Fish Dissector<br />
|-<br />
| <code>0x25</code> || Fish Cleaner<br />
|-<br />
| <code>0x26</code> || Farmer<br />
|-<br />
| <code>0x27</code> || Cheese Maker<br />
|-<br />
| <code>0x28</code> || Milker<br />
|-<br />
| <code>0x29</code> || Cook<br />
|-<br />
| <code>0x2A</code> || Thresher<br />
|-<br />
| <code>0x2B</code> || Miller<br />
|-<br />
| <code>0x2C</code> || Butcher<br />
|-<br />
| <code>0x2D</code> || Tanner<br />
|-<br />
| <code>0x2E</code> || Dyer<br />
|-<br />
| <code>0x2F</code> || Planter<br />
|-<br />
| <code>0x30</code> || Herbalist<br />
|-<br />
| <code>0x31</code> || Brewer<br />
|-<br />
| <code>0x32</code> || Soap Maker<br />
|-<br />
| <code>0x33</code> || Potash Maker<br />
|-<br />
| <code>0x34</code> || Lye Maker<br />
|-<br />
| <code>0x35</code> || Wood Burner<br />
|-<br />
| <code>0x36</code> || Engineer<br />
|-<br />
| <code>0x37</code> || Mechanic<br />
|-<br />
| <code>0x38</code> || Siege Engineer<br />
|-<br />
| <code>0x39</code> || Siege Operator<br />
|-<br />
| <code>0x3A</code> || Pump Operator<br />
|-<br />
| <code>0x3B</code> || Clerk<br />
|-<br />
| <code>0x3C</code> || Administrator<br />
|-<br />
| <code>0x3D</code> || Trader<br />
|-<br />
| <code>0x3E</code> || Architect<br />
|-<br />
| <code>0x3F</code> || Alchemist<br />
|-<br />
| <code>0x40</code> || Tax Collector<br />
|-<br />
| <code>0x41</code> || Hammerer<br />
|-<br />
| <code>0x42</code> || Baroness<br />
|-<br />
| <code>0x43</code> || Countess<br />
|-<br />
| <code>0x44</code> || Duchess<br />
|-<br />
| <code>0x45</code> || Baroness Consort<br />
|-<br />
| <code>0x46</code> || Countess Consort<br />
|-<br />
| <code>0x47</code> || Duchness Consort<br />
|-<br />
| <code>0x48</code> || Philosopher<br />
|-<br />
| <code>0x49</code> || Advisor<br />
|-<br />
| <code>0x4A</code> || Dungeon Master<br />
|-<br />
| <code>0x4B</code> || Merchant<br />
|-<br />
| <code>0x4C</code> || Diplomat<br />
|-<br />
| <code>0x4D</code> || Guild Representative<br />
|-<br />
| <code>0x4E</code> || Merchant Baroness<br />
|-<br />
| <code>0x4F</code> || Merchant Princess<br />
|-<br />
| <code>0x50</code> || Outpost Liason<br />
|-<br />
| <code>0x51</code> || Druid<br />
|-<br />
| <code>0x52</code> || Champion<br />
|-<br />
| <code>0x53</code> || Hammerman<br />
|-<br />
| <code>0x54</code> || Hammer Lord<br />
|-<br />
| <code>0x55</code> || Spearman<br />
|-<br />
| <code>0x56</code> || Spearmaster<br />
|-<br />
| <code>0x57</code> || Crossbowman<br />
|-<br />
| <code>0x58</code> || Elite Crossbowman<br />
|-<br />
| <code>0x59</code> || Wrestler<br />
|-<br />
| <code>0x5A</code> || Elite Wrestler<br />
|-<br />
| <code>0x5B</code> || Axeman<br />
|-<br />
| <code>0x5C</code> || Axe Lord<br />
|-<br />
| <code>0x5D</code> || Swordsman<br />
|-<br />
| <code>0x5E</code> || Swordmaster<br />
|-<br />
| <code>0x5F</code> || Maceman<br />
|-<br />
| <code>0x60</code> || Mace Lord<br />
|-<br />
| <code>0x61</code> || Pikeman<br />
|-<br />
| <code>0x62</code> || Pikemaster<br />
|-<br />
| <code>0x63</code> || Bowman<br />
|-<br />
| <code>0x64</code> || Elite Bowman<br />
|-<br />
| <code>0x65</code> || Blowgunner<br />
|-<br />
| <code>0x66</code> || Elite Blowgunner<br />
|-<br />
| <code>0x67</code> || Recruit<br />
|-<br />
| <code>0x68</code> || Hunting creature<br />
|-<br />
| <code>0x69</code> || War creature<br />
|-<br />
| <code>0x6A</code> || Master Thief<br />
|-<br />
| <code>0x6B</code> || Thief<br />
|-<br />
| <code>0x6C</code> || Peasant or creature<br />
|-<br />
| <code>0x6D</code> || Child<br />
|-<br />
| <code>0x6E</code> || Baby<br />
|-<br />
| <code>0x6F</code> || Drunk<br />
|-<br />
| <code>0x70</code> || Lasher<br />
|-<br />
| <code>0x71</code> || Master Lasher<br />
|}<br />
<br />
== Profession list ==<br />
PROFESSION_MINE,<br />
PROFESSION_HAUL_STONE,<br />
PROFESSION_HAUL_WOOD,<br />
PROFESSION_HAUL_BODY,<br />
PROFESSION_HAUL_FOOD,<br />
PROFESSION_HAUL_REFUSE,<br />
PROFESSION_HAUL_ITEM,<br />
PROFESSION_HAUL_FURNITURE,<br />
PROFESSION_HAUL_ANIMALS,<br />
PROFESSION_CLEAN,<br />
PROFESSION_CUTWOOD,<br />
PROFESSION_CARPENTER,<br />
PROFESSION_DETAIL,<br />
PROFESSION_MASON,<br />
PROFESSION_ARCHITECT,<br />
PROFESSION_ANIMALTRAIN,<br />
PROFESSION_ANIMALCARE,<br />
PROFESSION_HEALTHCARE,<br />
PROFESSION_BUTCHER,<br />
PROFESSION_TRAPPER,<br />
PROFESSION_DISSECT_VERMIN,<br />
PROFESSION_LEATHER,<br />
PROFESSION_TANNER,<br />
PROFESSION_BREWER,<br />
PROFESSION_ALCHEMIST,<br />
PROFESSION_SOAP_MAKER,<br />
PROFESSION_WEAVER,<br />
PROFESSION_CLOTHESMAKER,<br />
PROFESSION_MILLER,<br />
PROFESSION_PROCESS_PLANT,<br />
PROFESSION_MAKE_CHEESE,<br />
PROFESSION_MILK,<br />
PROFESSION_COOK,<br />
PROFESSION_PLANT,<br />
PROFESSION_HERBALIST,<br />
PROFESSION_FISH,<br />
PROFESSION_CLEAN_FISH,<br />
PROFESSION_DISSECT_FISH,<br />
PROFESSION_HUNT,<br />
PROFESSION_SMELT,<br />
PROFESSION_FORGE_WEAPON,<br />
PROFESSION_FORGE_ARMOR,<br />
PROFESSION_FORGE_FURNITURE,<br />
PROFESSION_METAL_CRAFT,<br />
PROFESSION_CUT_GEM,<br />
PROFESSION_ENCRUST_GEM,<br />
PROFESSION_WOOD_CRAFT,<br />
PROFESSION_STONE_CRAFT,<br />
PROFESSION_BONE_CARVE,<br />
PROFESSION_GLASSMAKER,<br />
PROFESSION_EXTRACT_STRAND,<br />
PROFESSION_AXE,<br />
PROFESSION_SWORD,<br />
PROFESSION_MACE,<br />
PROFESSION_HAMMER,<br />
PROFESSION_SPEAR,<br />
PROFESSION_DAGGER,<br />
PROFESSION_CROSSBOW,<br />
PROFESSION_BOW,<br />
PROFESSION_BLOWGUN,<br />
PROFESSION_PIKE,<br />
PROFESSION_WHIP,<br />
PROFESSION_SHIELDLEVEL,<br />
PROFESSION_ARMORLEVEL,<br />
PROFESSION_SIEGECRAFT,<br />
PROFESSION_SIEGEOPERATE,<br />
PROFESSION_BOWYER,<br />
PROFESSION_MECHANIC,<br />
PROFESSION_WEAPONNUMBER,<br />
PROFESSION_POTASH_MAKING,<br />
PROFESSION_LYE_MAKING,<br />
PROFESSION_DYER,<br />
PROFESSION_BURN_WOOD,<br />
PROFESSION_OPERATE_PUMP,<br />
PROFESSION_UNUSED_3,<br />
PROFESSION_UNUSED_4,<br />
PROFESSION_UNUSED_5,<br />
PROFESSION_UNUSED_6,<br />
PROFESSION_UNUSED_7,<br />
PROFESSION_UNUSED_8,<br />
PROFESSION_UNUSED_9,<br />
PROFESSION_UNUSED_10,<br />
PROFESSION_UNUSED_11,<br />
PROFESSION_UNUSED_12,<br />
PROFESSION_UNUSED_13,<br />
PROFESSION_UNUSED_14,<br />
PROFESSION_UNUSED_15,<br />
PROFESSION_UNUSED_16,<br />
PROFESSION_UNUSED_17,<br />
PROFESSION_UNUSED_18,<br />
PROFESSION_UNUSED_19,<br />
PROFESSION_UNUSED_20,<br />
PROFESSION_UNUSED_21,<br />
PROFESSION_UNUSED_22,<br />
PROFESSION_UNUSED_23,<br />
PROFESSION_UNUSED_24,<br />
PROFESSION_UNUSED_25,<br />
PROFESSION_UNUSED_26,<br />
PROFESSION_UNUSED_27,<br />
PROFESSION_UNUSED_28,<br />
PROFESSION_UNUSED_29,<br />
PROFESSION_UNUSED_30,<br />
PROFESSIONNUM,<br />
[[Category:Guides]] [[Category:Hacking]]</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50417User:Warmist2009-08-11T00:23:59Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu or playing. (first five tiles either empty or border), from v0.5 fps can be on<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can be used to control (with keyboard, no mouse support) DF if server allows it. To do that DF window must be selected (white star in upper left corner).<br />
*Server settings:<br />
**''Allow new users contorl:True/False'' means that new users can control DF.<br />
**''User:<some name>'' select a user (with arrows or by dragging mouse)<br />
**''Kick'' kicks the selected user<br />
**''Toggle Allow Control'' Toggles selected users permission to control DF.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50416User:Warmist2009-08-11T00:22:33Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu or playing. (first five tiles either empty or border), from v0.5 fps can be on<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for viewing someone play df.<br />
*Server settings:<br />
**''Allow new users contorl:True/False'' means that new users can control DF.<br />
**''User:<some name>'' select a user (with arrows or by dragging mouse)<br />
**''Kick'' kicks the selected user<br />
**''Toggle Allow Control'' Toggles selected users permission to control DF.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50415User:Warmist2009-08-11T00:21:39Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu or playing. (first five tiles either empty or border), from v0.5 fps can be on<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for viewing someone play df.<br />
*Server settings:<br />
**'Allow new users contorl:True/False' means that new users can control DF.<br />
**'User:<some name>' select a user (with arrows or by dragging mouse)<br />
**'Kick' kicks the selected user<br />
**'Toggle Allow Control' Toggles selected users permission to control DF.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User_talk:Warmist&diff=50421User talk:Warmist2009-08-09T13:33:49Z<p>Warmist: </p>
<hr />
<div>Is it possible to have the source please? Just rather curious and have an idea of implementing something similiar in another program for reading stuff from DF. I really would like to know how memory hacking with DF is done, especially the graphics interface, I have been forever stuck on getting a good working example though. Especially as I am a self-taught C++ programmer I feel rather clueless. I really don't mind messy code and I'm not forcing you, but it'd be absolutely invaluable to me. [[User:Nexii Malthus|Nexii Malthus]] 00:26, 9 August 2009 (UTC)<br />
:actually that part of code is quite clean... So I could give you source.[[User:Warmist|Warmist]] 13:33, 9 August 2009 (UTC)</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50414User:Warmist2009-08-08T09:38:36Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu.<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for viewing someone play df.<br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50413User:Warmist2009-08-08T07:56:49Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.And in main menu.<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for <br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50412User:Warmist2009-08-08T07:08:26Z<p>Warmist: </p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*Df must be running.<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for <br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmisthttps://dwarffortresswiki.org/index.php?title=User:Warmist&diff=50411User:Warmist2009-08-08T07:01:47Z<p>Warmist: Creating user page and posting about df view</p>
<hr />
<div>=Intro=<br />
Hello, I'm new here.<br />
=Good stuff=<br />
==Remote df viewer==<br />
Where to get:[http://dffd.wimbli.com/file.php?id=1315 DF File Depot]<br />
===Quick help===<br />
*works only with 40d13!<br />
*ports must be open (if using over internet=> not 127.0.0.1)<br />
*control is with mouse and keyboard:<br />
**select buttons by passing over with mouse or TAB'ing into them.<br />
**press enter or left mouse button. <br />
*currently can only be used for <br />
===Known bugs===<br />
*black scanline<br />
<br />
===Thanks===<br />
Thanks 0x517A5D for writing very useful hexsearch.h.<br />
Thanks jice for writing libTCod.</div>Warmist