Update README.txt

This commit is contained in:
Wuzzy 2015-02-14 03:00:02 +01:00
parent 583040c63a
commit 1ed318446e

View File

@ -7,12 +7,24 @@ See: <http://semver.org/>
Description
===========
This mod adds basic support for mana to Minetest.
It provides a simple API to set, get, add and subtract the mana (and maximum) mana of any player.
The mod also automatically allows for regenerating Mana automatically.
Each player will have an additional attribute: Mana. To be precise:
- Current mana reserves: How much mana the player currently has
- Maximum possible mana: How much mana the player can have at maximum
- Mana regeneration amont: How much mana will be generated each “mana tick” (default 0.2 seconds)
By default, each player spawns with 0/200 mana, and regenerates 1 mana per fifth of a second. All
these values can be configured with the server settings (`minetest.conf`) and it is highly advised to do
so if you plan to integrate this mod into a subgame.
The mana regeneration rate (the “mana tick”) is a global setting and is *not* configured on a
per-player basis.
The mod provides a simple API to set, get, add and subtract the mana (and maximum) mana of any player, and
for setting the regeneration amount. Note that this mod itself does *not* change the gameplay in a meaningful
way. You should install other mods which use the Mana mod as a dependency.
The API documentation is in the file API.md.
If the mod “HUD bars” [hudbars] is installed, a blue bar will be added to the HUD showing the player's mana reserves.