summaryrefslogtreecommitdiff
path: root/plugins/Dfusion
diff options
context:
space:
mode:
authorWarmist2012-03-18 02:22:26 +0200
committerWarmist2012-03-18 02:22:26 +0200
commit943c4abe763fb1a2958009a71eecc562881130c4 (patch)
treef9463953779cfc661e4999b2a8beb6ae308d2e33 /plugins/Dfusion
parente1279d79dbefe549008d2d909cfab19d78eb677f (diff)
downloaddfhack-943c4abe763fb1a2958009a71eecc562881130c4.tar.gz
dfhack-943c4abe763fb1a2958009a71eecc562881130c4.tar.bz2
dfhack-943c4abe763fb1a2958009a71eecc562881130c4.tar.xz
updated readme.txt
Diffstat (limited to 'plugins/Dfusion')
-rw-r--r--plugins/Dfusion/readme.txt52
1 files changed, 12 insertions, 40 deletions
diff --git a/plugins/Dfusion/readme.txt b/plugins/Dfusion/readme.txt
index 31436041..c40ac370 100644
--- a/plugins/Dfusion/readme.txt
+++ b/plugins/Dfusion/readme.txt
@@ -1,40 +1,12 @@
-Dfusion command runs file <df dir>\dfusion\init.lua
-Other than std lua commands supported:
- * Console.
- print(string)
- printerr(string)
- clear()
- gotoxy(x,y)
- color(int) //TODO add id's, use numbers upto 16 for now
- reset_color()
- cursor(true/false)
- msleep(int)
- get_columns()
- get_rows()
- lineedit(string) //text input through console
- history_add(string) // adds string to console history
- * Process.
- readDWord
- writeDWord
- readFloat
- readWord
- writeWord
- readByte
- writeByte
- read
- write
- read/writeSTLString
- copySTLString
- doReadClassName
- readClassName
- readCString
- isSuspended
- isIdentified
- getThreadIDs
- getMemRanges
- getBase
- getPath
- setPermisions
-Functions searched:
- OnTick()
- If defined is called each DFHack tick. \ No newline at end of file
+Dfusion plugin offers four DFhack commands: 'dfusion', 'dfuse' and 'lua', 'runlua'.
+lua:
+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.
+runlua:
+Similar to ''lua <filename>'' but not interactive, to be used with hotkeys
+dfusion:
+First this command runs all plugins' init.lua part then show a menu. Type number to run specified plugin.
+dfuse:
+Similar to dfusion but not interactive. To be used with hotkeys (later will have command support).
+
+Also dfuse/dfusion runs an init script located at 'save directory/dfusion/init.lua'. And 'initcustom.lua' if it exists
+More info http://dwarffortresswiki.org/index.php/Utility:DFusion