README.md

   1 # Item Help [`doc_items`] (Version 1.3.0)
   2 ## Description
   3 Automatically generated help texts of blocks, tools, weapons, crafting
   4 items and other items.
   5
   6 The goal is to tell the player as much about basically almost all items as
   7 possible, making it very convenient to look up simple things.
   8
   9 The ultimate goal of this mod is that eventually all relevant items have
  10 a complete in-game documentation so no item leaves you confused.
  11
  12 This mod is useful to learn the hard facts about practically all items, like
  13 how much damage weapon XYZ deals or whether you can dig that block.
  14 This mod does *not* give you long explanations about how to use certain
  15 nontrivial things, like the furnace from Minetest Game. This info might be
  16 provided by other mods and insert it into the help.
  17
  18 This mod provides 3 new help categories (using the
  19 Documentation System [`doc`]):
  20
  21 * Blocks (e.g. dirt, stone, wooden stair)
  22 * Tools and weapons (e.g. wooden pickaxe, steel sword, screwdriver)
  23 * Misc. items (e.g. dye, stick, flour)
  24
  25 Entries are automatically added. The information in the entries is
  26 mostly automatically generated. It contains information about a wide range
  27 of topics:
  28
  29 * Blocks
  30     * Physics
  31     * Digging properties
  32     * Drops (including probabilities)
  33     * Liquid information
  34     * Pointability
  35     * Luminance
  36     * Much more
  37 * Tools and weapons
  38     * Mining capabilities
  39     * Damage
  40     * Durability
  41     * More
  42 * All items
  43     * Range
  44     * Stack size
  45     * Group memberships
  46     * Other information added by mods
  47
  48 This mod also allows for mods to adding custom written description
  49 and usage help texts in free-form and even custom automatically generated texts
  50 for mod-specific information like flammability in Minetest Game. This is
  51 one of the core features of this mod; the mod relies on other mods to
  52 provide their custom help texts for a complete help.
  53
  54 If you find a particular item which is lacking an explanation on usage,
  55 request the mod author to add `doc_items` support.
  56
  57 ## API
  58 This mod has an API so that modders can add their own custom help texts,
  59 custom factoids (single pieces of information extracted from the
  60 item definition) and more.
  61
  62 For example, if your mods have some complex items which need
  63 explanation, this mod can help you in adding help texts for them.
  64
  65 Read `API.md` to learn more.
  66
  67 ## License
  68 Everything in this mod is licensed under the MIT License.
  69
  70 ## Translation credits
  71 French: Karamel
  72 German: Wuzzy
  73 Portuguese: BrunoMine