forked from mtcontrib/minetest_mana
Update README.txt
This commit is contained in:
parent
47c4d35baa
commit
0c8a115c51
11
README.txt
11
README.txt
|
@ -8,6 +8,11 @@ Description
|
||||||
===========
|
===========
|
||||||
This mod adds basic support for mana to Minetest.
|
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.
|
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.
|
||||||
|
By default, each player spawns with 0/200 mana, and regenerates 1 mana per tenth 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 API documentation is in the file API.md.
|
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.
|
If the mod “HUD bars” [hudbars] is installed, a blue bar will be added to the HUD showing the player's mana reserves.
|
||||||
|
@ -20,7 +25,11 @@ Configuration
|
||||||
|
|
||||||
This mod can be configured with minetest.conf! The following settings are accepted:
|
This mod can be configured with minetest.conf! The following settings are accepted:
|
||||||
|
|
||||||
* `mana_default_max`: Initial max. mana given to new players.
|
* `mana_default_max`: Initial max. mana given to new players. Default: `200`. This value must be non-negative.
|
||||||
|
* `mana_default_regen`: Initial regenerated mana per “mana tick”. Default: `1`. This value must be non-negative.
|
||||||
|
* `mana_regen_timer`: The length of a “mana tick” in seconds. Each player will get his/her mana increased by the current
|
||||||
|
regen value per mana tick. Default: `0.1`. This value must be positive, also try to avoid very small values
|
||||||
|
as those could probably stress your machine a lot.
|
||||||
|
|
||||||
|
|
||||||
License information
|
License information
|
||||||
|
|
Loading…
Reference in New Issue
Block a user