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).

If you find the HUD to be too big, it can be configured to one of three sizes in `minetest.conf` with `punchnode.hud_size`. The HUD size can be set to one of three integer, `1`, `2`, or `3` (`2` is default).

### Chatcommand
The HUD can be managed and customized per-player with the `/punchinfo` command. This single command accepts several parameters, as seen below.

| Parameter | Function |
| --------- | -------- |
| `clear` | Clears all information about the player (show time, size, etc...) |
| `get <key>` | Gets HUD information (e.g. size) |
| `enable` | Enables the PunchInfo HUD |
| `disable` | Disables the PunchInfo HUD |
| `time <integer>` | Sets the time before the HUD is hidden |
| `size <integer>` | Sets the HUD size to 1, 2, or 3 |
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).

Add punchinfo.hud_size Allows the HUD size to be configured in minetest.conf with punchinfo.hud_size = 1, 2, or 3 2017-01-16 17:31:40 -08:00			If you find the HUD to be too big, it can be configured to one of three sizes in `minetest.conf` with `punchnode.hud_size`. The HUD size can be set to one of three integer, `1`, `2`, or `3` (`2` is default).

Expand /punchinfo chatcommand Players can now customize the HUD size and show time themselves, rather than being stuck with the global settings. See README for specifics. 2017-01-16 19:34:09 -08:00			`### Chatcommand`
			The HUD can be managed and customized per-player with the `/punchinfo` command. This single command accepts several parameters, as seen below.
Add /punchinfo allows enabling or disabling punch info per-player with /punchinfo true or /punchinfo false 2017-01-15 11:57:05 -08:00
Expand /punchinfo chatcommand Players can now customize the HUD size and show time themselves, rather than being stuck with the global settings. See README for specifics. 2017-01-16 19:34:09 -08:00			`\| Parameter \| Function \|`
			`\| --------- \| -------- \|`
			\| `clear` \| Clears all information about the player (show time, size, etc...) \|
			\| `get <key>` \| Gets HUD information (e.g. size) \|
			\| `enable` \| Enables the PunchInfo HUD \|
			\| `disable` \| Disables the PunchInfo HUD \|
			\| `time <integer>` \| Sets the time before the HUD is hidden \|
			\| `size <integer>` \| Sets the HUD size to 1, 2, or 3 \|