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

Make README a bit more helpful

Browse Source
This commit is contained in:
Wuzzy 2016-12-20 14:14:18 +01:00
parent be8a79dd19
commit da00b105a5
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,17 +4,23 @@ It demonstrates the usage of the APIs of the Help mods. This should help you
in getting 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.
knowledge might already suffice. You do not need to understand everything to
use this modpack.
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 of the entire help.
This mod includes examples for the following mods:
* `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`: In `doc.lua`, for adding your own categories. For advanced modding.
* `doc_items`: In `doc_items.lua`.
For adding item help (including nodes). Start here!
* `doc_identifier`: In `doc_identifier.lua`.
This is for adding lookup tool support for custom entities.
* `doc`: In `doc.lua`, for adding your own categories and entries.
This is rather heavy stuff, intended for advanced modding.
But is also very flexible.
Activate this mod in your world to see some example categories, entries and
items added.