From 0c8a115c5179c7c4de536f76cf5f9a98385a5b5e Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Sat, 14 Feb 2015 02:33:45 +0100 Subject: [PATCH] Update README.txt --- README.txt | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.txt b/README.txt index 7076db6..e020397 100644 --- a/README.txt +++ b/README.txt @@ -8,6 +8,11 @@ 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. +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. 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: -* `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