2016-12-19 05:17:22 -08:00
|
|
|
# Example mod for Help modpack (`doc`, `doc_items`, etc.)
|
|
|
|
|
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
|
|
|
|
|
started with this modpack.
|
|
|
|
|
|
|
|
|
|
Using the APIs of the Help modpack helps to improve the overall quality and completeness
|
|
|
|
|
of the entire help.
|
|
|
|
|
|
|
|
|
|
It includes examples for the following mods:
|
|
|
|
|
|
2016-12-19 06:04:09 -08:00
|
|
|
* `doc_items`: In `doc_items.lua`, for item help. Start here!
|
2016-12-19 10:00:52 -08:00
|
|
|
* `doc_identifier`: In `doc_identifier.lua`, for adding lookup tool support for custom entities
|
2016-12-19 06:04:09 -08:00
|
|
|
* `doc`: In `doc.lua`, for adding your own categories. For advanced modding
|
2016-12-19 05:17:22 -08:00
|
|
|
|
|
|
|
|
Activate this mod in your world to see some example categories, entries and items added.
|
|
|
|
|
|
|
|
|
|
Read the source code for some brief explanation.
|
|
|
|
|
|
|
|
|
|
THIS IS NOT A FULL EXAMPLE. Please read `API.md` of the respective mods to learn how to
|
|
|
|
|
use the mod properly.
|
