mirror of
https://github.com/appgurueu/hud_timers.git
synced 2024-11-19 21:53:49 +01:00
63 lines
1.6 KiB
Markdown
63 lines
1.6 KiB
Markdown
# HUD Timers (`hud_timers`)
|
|
|
|
A library for easily maintaining HUD timers.
|
|
|
|
HUD timers are colorful yet subtle bars indicating some time consuming process.
|
|
|
|
## About
|
|
|
|
Configuration help can be found under `config_help.md` in the same folder as this.
|
|
|
|
Depends on [`modlib`](https://github.com/appgurueu/modlib).
|
|
|
|
**Please note that this mod may not work along well with other mods altering the HUD.**
|
|
|
|
Code licensed under the MIT License. Written by Lars Mueller alias LMD or appguru(eu).
|
|
|
|
Media license: files taken or derived from [hudbars](https://repo.or.cz/w/minetest_hudbars.git)
|
|
|
|
* `textures/hudbars_bar_background.png`: made by Wuzzy, licensed under MIT
|
|
* `textures/hud_timers_bar_timeout.png`: made by LMD, but very similar, can be seen as derivative of Wuzzy's work, therefore licensed under MIT as well
|
|
|
|
All in all, the media is licensed under the MIT license, with credits going to Wuzzy.
|
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
## API
|
|
|
|
Code should be self-explanatory. If not, feel free to contact me (opening an issue is also fine). Will probably document it here at some point...
|
|
|
|
## Configuration
|
|
|
|
<!--modlib:conf:2-->
|
|
### `format`
|
|
|
|
The format for the timer label - first string is timer name, second one is seconds left.
|
|
|
|
* Type: string
|
|
* Default: `%s: %s s`
|
|
|
|
### `globalstep`
|
|
|
|
How often timers should be updated (interval duration in seconds).
|
|
|
|
* Type: number
|
|
* Default: `0.1`
|
|
* >= `0`
|
|
|
|
### `hud_pos`
|
|
|
|
Screen coordinates where the timer stack should start.
|
|
|
|
### `hud_timers_max`
|
|
|
|
How many timers(maximum) may exist at a time.
|
|
|
|
* Type: number
|
|
* Default: `10`
|
|
* >= `0`
|
|
* <= `100`
|
|
<!--modlib:conf-->
|