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

Update modding-guide.rst 

Change use of word entities to objects because entitiy is a taken word in DF, and remove incorrect slash from a command.
develop
Tachytaenius 2022-09-13 10:51:38 +01:00 committed by GitHub
parent cd83f3fcf1
commit b89a30a309
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -107,7 +107,7 @@ structures. The first is the ``df-structures``
`repository <https://github.com/DFHack/df-structures>`__ that contains XML files `repository <https://github.com/DFHack/df-structures>`__ that contains XML files
describing the contents of the game's structures. These are complete, but difficult describing the contents of the game's structures. These are complete, but difficult
to read (for a human). The second option is the `gui/gm-editor` script, an to read (for a human). The second option is the `gui/gm-editor` script, an
interactive data explorer. You can run the script while entities like units are interactive data explorer. You can run the script while obects like units are
selected to view the data within them. You can also run ``gui/gm-editor scr`` to selected to view the data within them. You can also run ``gui/gm-editor scr`` to
view the data for the current screen. Press :kbd:`?` while the script is active to view the data for the current screen. Press :kbd:`?` while the script is active to
view help. view help.
@ -338,7 +338,7 @@ environment for fully-functioning modular mods are as follows:
* The main content of the mod would be in the ``raw`` folder: * The main content of the mod would be in the ``raw`` folder:
* A Lua file in ``raw/init.d/`` to initialise the mod by calling * A Lua file in ``raw/init.d/`` to initialise the mod by calling
``your-mod-id/main/ enable``. ``your-mod-id/main enable``.
* Raw content (potentially with custom raw tokens) in ``raw/objects/``. * Raw content (potentially with custom raw tokens) in ``raw/objects/``.
* A subfolder for your mod in ``raw/scripts/`` containing a ``main.lua`` file * A subfolder for your mod in ``raw/scripts/`` containing a ``main.lua`` file
(an example of which we will see) and all the modules containing the functions (an example of which we will see) and all the modules containing the functions