Bram

History

Riu Sakura 2b61231f82 add japanese translation		2022-12-19 15:33:31 +09:00
..
locale	add japanese translation	2022-12-19 15:33:31 +09:00
textures	Update all help mods	2019-03-18 13:20:17 +01:00
API.md	Import Help 1.1.0: doc, doc_items, doc_identifier	2017-03-18 01:00:20 +01:00
README.md	Update doc modpack (1.2.2)	2018-03-27 15:08:31 +02:00
init.lua	fix many codestyle issues (functions, strings, modpaths)	2021-05-29 16:12:33 +02:00
mod.conf	Use mod.conf in all mods, part 1	2021-03-04 15:22:14 +01:00

README.md

Lookup Tool [`doc_identifier`]

Version: 1.2.2

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 help entry of this particular item. The tool comes in two modes which are changed by a right-click. 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 Documentation System [doc] and Item Help [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 MIT License.