2016-12-20 03:26:31 -08:00
|
|
|
# Example mod for the Help modpack (`doc`, `doc_items`, etc.)
|
2016-12-19 05:17:22 -08:00
|
|
|
This mod is for modders and useless for anyone else.
|
2016-12-20 04:48:16 -08:00
|
|
|
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.
|
2016-12-19 05:17:22 -08:00
|
|
|
|
2016-12-20 04:48:16 -08:00
|
|
|
Using the APIs of the Help modpack helps to improve the overall quality
|
|
|
|
|
and completeness of the entire help.
|
2016-12-19 05:17:22 -08:00
|
|
|
|
2016-12-20 03:26:31 -08:00
|
|
|
This mod includes examples for the following mods:
|
2016-12-19 05:17:22 -08:00
|
|
|
|
2016-12-20 04:48:16 -08:00
|
|
|
* `doc_items`: In `doc_items.lua` for item help. Start here!
|
2016-12-20 03:26:31 -08:00
|
|
|
* `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.
|
2016-12-19 05:17:22 -08:00
|
|
|
|
2016-12-20 04:48:16 -08:00
|
|
|
Activate this mod in your world to see some example categories, entries and
|
|
|
|
|
items added.
|
2016-12-19 05:17:22 -08:00
|
|
|
|
2016-12-20 03:26:31 -08:00
|
|
|
Read the source code files in this mod for some brief explanations.
|
