2015-12-19 10:42:08 +01:00

60 lines
1.5 KiB
Plaintext

minetest-australopithecus-auto-hud-hide
=======================================
A system which automatically hides the HUD if there are no changes.
Features
--------
* Allows to hide the healthbar and hotbar.
* Completely configurable from teh configuration.
Usage
-----
The system activates itself, you just need to add the mod to the subgame.
Configuration
-------------
The system can be configured by adding settings to the `minetest.conf`:
# If the system should be activated, defaults to true.
autohudhide_activate = true
# If the healthbar should be automatically hidden, defaults to true.
autohudhide_healthbar_autohide
# The delay after which the healthbar is hidden, in seconds, defaults
# to 5 seconds.
autohudhide_healthbar_delay = 5
# If the hotbar should be automatically hidden, defaults to true.
autohudhide_hotbar_autohide = true
# The delay after which the hotbar is hidden, in seconds, defaults
# to 3 seconds.
autohudhide_hotbar_delay = 3
# The interval in which the check is run, in seconds, defaults to 0.1.
autohudhide_interval = 0.1
Run manually
------------
You can invoke the system manually either for all players by invoking
`autohudhide.run`, or on a single player by invoking `autohidehud.run_on_player`
which accepts the Player as single parameter.
Force activation
----------------
You can also force the activation of the system, even if it has been disabled
in the configuration, by invoking `autohudhide.activate_internal`.