worldedit_hud_helper/README.md

64 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2018-09-14 14:28:01 -07:00
# WorldEdit HUD Helper [worldedit_hud_helper]
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.
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!
2018-09-17 05:02:01 -07:00
**Forum Link:** https://forum.minetest.net/viewtopic.php?f=9&t=20804
2018-09-14 15:17:30 -07:00
![](https://gitlab.com/sbrl/worldedit_hud_helper/raw/master/screenshots/screenshot_a.png)
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.
2018-09-14 15:09:11 -07:00
2018-09-14 15:17:30 -07:00
## Changelog
2018-09-14 15:09:11 -07:00
- v0.1: 14th September 2018
- Initial release.
2018-09-16 04:08:36 -07:00
- v0.2: 16th September 2018
- Fix undeclared global variable access.
2020-05-01 16:11:39 -07:00
- 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)
2021-07-30 18:43:49 -07:00
- Persist per-player settings to disk (per-world)
2018-09-14 15:09:11 -07:00
2018-09-14 15:05:31 -07:00
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)
2021-07-30 18:46:21 -07:00
## Chat commands
worldedit_hud_helper provides 2 chat commands:
## `//hud`
Toggles whether the HUD is shown or not.
## `//hudoffset <offset_in_pixels>`
Adjusts the vertical height of the HUD. For example, to adjust it to be greater (higher up on the screen), do this:
```
//hudoffset 50
```
The default value is 0. You can reset to the default value like this:
```
//hudoffset
```
2019-01-11 16:30:22 -08:00
2018-09-14 15:05:31 -07:00
## 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.
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.