sbrl
/
worldedit_hud_helper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: Document chat commands

master
Starbeamrainbowlabs 2021-07-31 02:46:21 +01:00
parent 881ada0773
commit 44aaac5a6a
No known key found for this signature in database
GPG Key ID: 1BE5172E637709C2
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -35,8 +35,27 @@ To toggle its display, use the `//hud` command - it takes no arguments.
![](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
## 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
```
## 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.