punchinfo/README.md

![Screenshot](screenshot.png)

Node Information on_punch [punchinfo]
=======================================
* Licence: Code: MIT (see LICENSE), Media: CC-BY-SA 3.0
* [GitHub Repository](https://github.com/octacian/punchinfo)
* [Issue Tracker](https://github.com/octacian/punchinfo/issues)
* Dependencies: None.

This is another fairly simple utility mod, but it can serve a very useful purpose. PunchInfo was originally inspired by [azekill_DIABLO's NodeExploror mod](https://forum.minetest.net/viewtopic.php?f=9&t=15565). However, NodeExplorer was missing several features, and since it wasn't on GitHub, I decided to start over from scratch.

The concept of PunchInfo is very simple, whenever a player left-clicks (i.e. punches) a node, information about that node is shown. This information includes the description, itemstring, top texture, light emission level, drawtype, and groups. The HUD is removed after 2 seconds (configurable in `minetest.conf` with `punchnode.hud_show_time`, integer).

The PunchInfo HUD can be disabled per player with the `/punchinfo` command. A list of players who have enabled or disabled the HUD can be found in `[worlddir]/punchinfo.players`.

Example:
```
/punchinfo true -- enables HUD for player
/punchinfo false -- disables HUD for player
```
Added screenshot 2017-01-15 11:37:30 -08:00			`![Screenshot](screenshot.png)`

initial commit 2017-01-14 21:44:13 -08:00			`Node Information on_punch [punchinfo]`
Added screenshot 2017-01-15 11:37:30 -08:00			`=======================================`
initial commit 2017-01-14 21:44:13 -08:00			`* Licence: Code: MIT (see LICENSE), Media: CC-BY-SA 3.0`
			`* [GitHub Repository](https://github.com/octacian/punchinfo)`
			`* [Issue Tracker](https://github.com/octacian/punchinfo/issues)`
			`* Dependencies: None.`

			`This is another fairly simple utility mod, but it can serve a very useful purpose. PunchInfo was originally inspired by [azekill_DIABLO's NodeExploror mod](https://forum.minetest.net/viewtopic.php?f=9&t=15565). However, NodeExplorer was missing several features, and since it wasn't on GitHub, I decided to start over from scratch.`

Add /punchinfo allows enabling or disabling punch info per-player with /punchinfo true or /punchinfo false 2017-01-15 11:57:05 -08:00			The concept of PunchInfo is very simple, whenever a player left-clicks (i.e. punches) a node, information about that node is shown. This information includes the description, itemstring, top texture, light emission level, drawtype, and groups. The HUD is removed after 2 seconds (configurable in `minetest.conf` with `punchnode.hud_show_time`, integer).

			The PunchInfo HUD can be disabled per player with the `/punchinfo` command. A list of players who have enabled or disabled the HUD can be found in `[worlddir]/punchinfo.players`.

			`Example:`
			```
			`/punchinfo true -- enables HUD for player`
			`/punchinfo false -- disables HUD for player`
			```