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

Pad out Getting used to gm-editor and DFStructs exploration a bit

develop
Tachytaenius 2022-07-01 19:10:26 +01:00
parent c026bd6dcb
commit 46d0f36d41
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/modding-guide.rst
Unescape Escape View File

@ -58,9 +58,9 @@ Simple. Save this as a Lua file in your own scripts directory and run it as show
Getting used to gm-editor and DFStructs exploration
---------------------------------------------------
So how could you have known about the field and type we just used?
So how could you have known about the field and type we just used? Well, there are two main tools for discovering the various fields in the game's data structures. The first is the ``df-structures`` repository (at https://github.com/DFHack/df-structures) that contains XML files denoting the contents of the game's structures. The second is the script ``gui/gm-editor`` which is an interactive data explorer. You can run the script while objects like units are selected to view the data within them. You can also pass ``scr`` as an argument to the script to view the data for the current screen. Press ? while the script is active to view help.
s
Familiarising yourself with the many structs of the game will help with ideas immensely, and you can always ask for help in the right places (e.g. DFHack's Discord).
Detecting triggers
------------------