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

Merge pull request #2298 from wolfboyft/modding-guide-patch 

Add link to a full example mod and show more code configurations in modding guide
develop
Myk 2022-09-22 13:38:26 -07:00 committed by GitHub
parent eac3641d53 6810f9bb90
commit 3532ad3633
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -348,6 +348,9 @@ timer::
The structure of a full mod The structure of a full mod
--------------------------- ---------------------------
For reference, `Tachy Guns <https://www.github.com/wolfboyft/tachy-guns>`__ is a
full mod that conforms to this guide.
Create a folder for mod projects somewhere outside your Dwarf Fortress Create a folder for mod projects somewhere outside your Dwarf Fortress
installation directory (e.g. ``/path/to/mymods/``) and use your mod IDs as the installation directory (e.g. ``/path/to/mymods/``) and use your mod IDs as the
names for the mod folders within it. In the example below, we'll use a mod ID of names for the mod folders within it. In the example below, we'll use a mod ID of
@ -425,13 +428,18 @@ Ok, you're all set up! Now, let's take a look at an example
moduleA.onLoad() moduleA.onLoad()
moduleB.onLoad() moduleB.onLoad()
-- register your callbacks -- multiple functions in the same repeat callback
repeatUtil.scheduleEvery(modId .. ' every tick', 1, 'ticks', repeatUtil.scheduleEvery(modId .. ' every tick', 1, 'ticks', function()
moduleA.every1Tick) moduleA.every1Tick()
moduleB.every1Tick()
end)
-- one function per repeat callback (you can put them in the
-- above format if you prefer)
repeatUtil.scheduleEvery(modId .. ' 100 frames', 1, 'frames', repeatUtil.scheduleEvery(modId .. ' 100 frames', 1, 'frames',
moduleD.every100Frames) moduleD.every100Frames)
-- multiple functions in the same callback -- multiple functions in the same eventful callback
eventful.onReactionComplete[modId] = function(reaction, eventful.onReactionComplete[modId] = function(reaction,
reaction_product, unit, input_items, input_reagents, reaction_product, unit, input_items, input_reagents,
output_items) output_items)
@ -442,7 +450,7 @@ Ok, you're all set up! Now, let's take a look at an example
unit, input_items, input_reagents, output_items) unit, input_items, input_reagents, output_items)
end end
-- one function per callback (you can put them in the -- one function per eventful callback (you can put them in the
-- above format if you prefer) -- above format if you prefer)
eventful.onProjItemCheckMovement[modId] = moduleD.onProjItemCheckMovement eventful.onProjItemCheckMovement[modId] = moduleD.onProjItemCheckMovement
eventful.onProjUnitCheckMovement[modId] = moduleD.onProjUnitCheckMovement eventful.onProjUnitCheckMovement[modId] = moduleD.onProjUnitCheckMovement