README.md

   1 # Example mod for the Help modpack (`doc`, `doc_items`, etc.)
   2 This mod is for modders who want to learn how to use the APIs of the mods
   3 `doc`, `doc_items` and `doc_identifier` from the Help modpack.
   4 It is useless for anyone else. This mod should only be used for testing
   5 and learning. not for actual playing or for servers, as it will only clutter
   6 the the help categories.
   7
   8 It demonstrates the usage of the APIs of the Help mods. This should help you
   9 in getting started with this modpack.
  10
  11 This mod includes examples for the following mods:
  12
  13 * `doc_items`: In `doc_items.lua`.
  14          For adding item help (including nodes). Start here!
  15 * `doc_identifier`: In `doc_identifier.lua`.
  16          This is for adding lookup tool support for custom entities.
  17 * `doc`: In `doc.lua`, for adding your own categories and entries.
  18          This is rather heavy stuff, intended for advanced modding.
  19          But is also very flexible.
  20
  21 This example mod only shows the most frequently-needed features to help
  22 you get started. For most use cases, this knowledge might already
  23 suffice. You do not need to understand everything to use this modpack.
  24 Read `API.md` of the respective mods to learn how to use the Help mods
  25 properly.
  26
  27 Using the APIs of the Help modpack helps to improve the overall quality
  28 and completeness of the entire help.
  29
  30 Activate this mod in your world to see some example categories, entries and
  31 items added.
  32
  33 Read the source code files in this mod for some brief explanations.