README.md

   1 # Lookup Tool [`doc_identifier`]
   2 Version: 1.1.0
   3
   4 ## Description
   5 The lookup tool is an useful little helper which can be used to quickly learn
   6 more about about one's closer environment. It identifies blocks, dropped items
   7 and other objects and it shows extensive information about the item on which it
   8 is used, provided documentation is available.
   9
  10 ## How to use the lookup tool
  11 Punch any block or item about you wish to learn more about. This will open up
  12 the help entry of this particular item.
  13 The tool comes in two modes which are changed by a right-click. In liquid mode
  14 (blue) this tool points to liquids as well while in solid mode (red) this is not
  15 the case. Liquid mode is required if you want to identify a liquid.
  16
  17 ## For modders
  18 If you want the tool to identify nodes and (dropped) items, you probably don't
  19 have to do anything, it is probably already supported. The only thing you have
  20 to make sure is that all pointable blocks and items have a help entry, which
  21 is already the case for most items, but you may want to do some testing on
  22 “tricky” items. Consult the documentation of Documentation System [`doc`]
  23 and Item Help [`doc_items`] for getting the item documentation right.
  24
  25 For the lookup tool to be able to work on custom objects/entities, you have to
  26 use the tiny API of this mod, see `API.md`.
  27
  28 ## License
  29 Everything in this mod is licensed under the MIT License.