Wuzzy/minetest_doc_example
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Wuzzy 2016-12-20 12:26:31 +01:00
parent 40f4f3008d
commit c2bfbe06d3
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,20 +1,20 @@
# Example mod for Help modpack (`doc`, `doc_items`, etc.) # Example mod for the Help modpack (`doc`, `doc_items`, etc.)
This mod is for modders and useless for anyone else. This mod is for modders and useless for anyone else.
It demonstrates the usage of the APIs of the Help mods. This should help you in getting It demonstrates the usage of the APIs of the Help mods. This should help you in getting
started with this modpack. started with this modpack.
This example mod does not demonstrate everything, only the most frequently-needed features
to help you get started. For most use cases, this knowledge might already suffice.
Read `API.md` of the respective mods to learn how to use the Help mods properly.
Using the APIs of the Help modpack helps to improve the overall quality and completeness Using the APIs of the Help modpack helps to improve the overall quality and completeness
of the entire help. of the entire help.
It includes examples for the following mods: This mod includes examples for the following mods:
* `doc_items`: In `doc_items.lua`, for item help. Start here! * `doc_items`: In `doc_items.lua`, for item help. Start here!
* `doc_identifier`: In `doc_identifier.lua`, for adding lookup tool support for custom entities * `doc_identifier`: In `doc_identifier.lua`, for adding lookup tool support for custom entities.
* `doc`: In `doc.lua`, for adding your own categories. For advanced modding * `doc`: In `doc.lua`, for adding your own categories. For advanced modding.
Activate this mod in your world to see some example categories, entries and items added. Activate this mod in your world to see some example categories, entries and items added.
Read the source code for some brief explanation. Read the source code files in this mod for some brief explanations.
THIS IS NOT A FULL EXAMPLE. Please read `API.md` of the respective mods to learn how to
use the mod properly.