From ae3f10b3291daeb3020902d93c58636f1a2e1974 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Wed, 10 Aug 2016 03:13:36 +0200 Subject: [PATCH] Add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f500f3 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Lookup Tool [`doc_identifier`] + +## Description +The lookup tool is an useful little helper which can be used to quickly learn more about about one's closer environment. +It identifies blocks, dropped items and other objects and it shows extensive information about the item on which it is used, +provided documentation is available. + +## How to use the lookup tool +Punch any block or item about you wish to learn more about. This will open up the Documentation System entry of this particular +item. +The tool comes in two modes which are changed by a rightclick. In liquid mode (blue) this tool points to liquids as well +while in solid mode (red) this is not the case. Liquid mode is required if you want to identify a liquid. + +## For modders +If you want the tool to identify nodes and (dropped) items, you probably don't have to do anything, it is probably already +supported. The only thing you have to make sure is that all pointable blocks and items have a help entry, which is already +the case for most items, but you may want to do some testing on “tricky” items. Consult the documentation of the +Documentation System [`doc`] and Item Documentation [`doc_items`] for getting the item documentation right. + +For the lookup tool to be able to work on custom objects/entities, you have to use the tiny API of this mod, see `API.md`. + +## License +Everything in this mod is licensed under the “conditions” of the WTFPL. +In other words: Just do what the fuck you want. Have fun! ;-)