worldedit_hud_helper/README.md

# WorldEdit HUD Helper [worldedit_hud_helper]

> A helpful HUD that shows the name of the node you're pointing at and the direction you're pointing in.
> Makes using WorldEdit that little bit easier :-)

Despite the name, it doesn't actually depend on `worldedit` at all!

**Forum Link:** https://forum.minetest.net/viewtopic.php?f=9&t=20804

![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_a.png)

## Usage
After installing the mod and restarting your server, you should see it appear automagically above your hotbar.

To toggle its display, use the `//hud` command - it takes no arguments.


## Changelog
 - v0.1: 14th September 2018
	 - Initial release.
 - v0.2: 16th September 2018
     - Fix undeclared global variable access.
 - v0.3: 2nd May 2020
     - Fix potential bug in raycast
     - Ignore `wielded_light:*` nodes when raycasting
 - v0.4: 31st May 2021
     - Fix deprecation warning for `getpos` → `get_pos` (#2)
 - v0.5: 31st July 2021
     - Add `//hudoffset [<offset_in_pixels>]` chat command to adjust the vertical offset of the HUD (fixes #1)
     - Persist per-player settings to disk


## More Screenshots
![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_b.png)
![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_c.png)
![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_d.png)

## Todo
 - Add a setting based on [this code](https://github.com/Pilcrow182/flying_saucer/blob/master/init.lua#L21-L30) to change whether the node id or the display text is shown to the user

## License
This mod is licensed under the _Mozilla Public License 2.0_, a copy of which (along with a helpful summary as to what you can and can't do with it) can be found in the [`LICENSE`](https://gitlab.com/sbrl/worldedit_hud_helper/blob/master/LICENSE) file in this repository.

If you'd like to do something that the license prohibits, please get in touch as it's possible we can negotiate something.
Initial commit. It's going well! 2018-09-14 14:28:01 -07:00			`# WorldEdit HUD Helper [worldedit_hud_helper]`

README: Improve wording 2018-09-14 15:08:37 -07:00			`> A helpful HUD that shows the name of the node you're pointing at and the direction you're pointing in.`
Fill out the README a bit 2018-09-14 15:05:31 -07:00			`> Makes using WorldEdit that little bit easier :-)`

			Despite the name, it doesn't actually depend on `worldedit` at all!

Update README.md 2018-09-17 05:02:01 -07:00			`Forum Link: https://forum.minetest.net/viewtopic.php?f=9&t=20804`

Add screenshots to README 2018-09-14 15:17:30 -07:00			`![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_a.png)`
Fill out the README a bit 2018-09-14 15:05:31 -07:00
			`## Usage`
			`After installing the mod and restarting your server, you should see it appear automagically above your hotbar.`

			To toggle its display, use the `//hud` command - it takes no arguments.

Add changelog to README 2018-09-14 15:09:11 -07:00
Add screenshots to README 2018-09-14 15:17:30 -07:00			`## Changelog`
Add changelog to README 2018-09-14 15:09:11 -07:00			`- v0.1: 14th September 2018`
			`- Initial release.`
Update changelog 2018-09-16 04:08:36 -07:00			`- v0.2: 16th September 2018`
			`- Fix undeclared global variable access.`
Update changelog 2020-05-01 16:11:39 -07:00			`- v0.3: 2nd May 2020`
			`- Fix potential bug in raycast`
			- Ignore `wielded_light:*` nodes when raycasting
Fix getpos deprecation warning Fixes #2 2021-05-31 04:11:26 -07:00			`- v0.4: 31st May 2021`
			- Fix deprecation warning for `getpos` → `get_pos` (#2)
Add //hudoffset chat command to adjust vertical offset of HUD Fixes #1. 2021-07-30 18:04:03 -07:00			`- v0.5: 31st July 2021`
			- Add `//hudoffset [<offset_in_pixels>]` chat command to adjust the vertical offset of the HUD (fixes #1)
Update changelog 2021-07-30 18:43:36 -07:00			`- Persist per-player settings to disk`
Add changelog to README 2018-09-14 15:09:11 -07:00
Fill out the README a bit 2018-09-14 15:05:31 -07:00
Add screenshots to README 2018-09-14 15:17:30 -07:00			`## More Screenshots`
			`![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_b.png)`
			`![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_c.png)`
			`![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_d.png)`

Add quick TODO to README 2019-01-11 16:30:22 -08:00			`## Todo`
			`- Add a setting based on [this code](https://github.com/Pilcrow182/flying_saucer/blob/master/init.lua#L21-L30) to change whether the node id or the display text is shown to the user`

Fill out the README a bit 2018-09-14 15:05:31 -07:00			`## License`
Add link to LICENSE 2018-09-14 15:23:34 -07:00			This mod is licensed under the _Mozilla Public License 2.0_, a copy of which (along with a helpful summary as to what you can and can't do with it) can be found in the [`LICENSE`](https://gitlab.com/sbrl/worldedit_hud_helper/blob/master/LICENSE) file in this repository.
Fill out the README a bit 2018-09-14 15:05:31 -07:00
			`If you'd like to do something that the license prohibits, please get in touch as it's possible we can negotiate something.`