Update for 0.4.16 settings syntax
[minetest_mana.git] / README.md
1 # Mana [mana]
3 * Version: 1.2.0
4 * Note: This mod uses semantic versioning, as defined by version 2.0.0 of the SemVer standard. See: <http://semver.org/>
6 ## Description
7 This mod adds basic support for mana to Minetest.
9 Each player will have an additional attribute: Mana. To be precise:
11 * Current mana reserves: How much mana the player currently has
12 * Maximum possible mana: How much mana the player can have at maximum
13 * Mana regeneration amont: How much mana will be generated each “mana tick” (default 0.2 seconds)
15 By default, each player spawns with 0/200 mana, and regenerates 1 mana per fifth of a second. All
16 these values can be configured with the server settings (`minetest.conf`) and it is highly advised to do
17 so if you plan to integrate this mod into a subgame.
19 The mana regeneration rate (the “mana tick”) is a global setting and is *not* configured on a
20 per-player basis.
22 The mod provides a simple API to set, get, add and subtract the mana (and maximum) mana of any player, and
23 for setting the regeneration amount. Note that this mod itself does *not* change the gameplay in a meaningful
24 way. You should install other mods which use the Mana mod as a dependency.
26 The API documentation is in the file `API.md`.
28 If the mod “HUD bars” [`hudbars`] is installed, a blue bar will be added to the HUD showing the player's mana reserves.
29 It currently only works with version 0.3.0 of this mod.
31 Otherwise, the mana is just shown as text.
33 ## Configuration
35 This mod can be configured with minetest.conf! The following settings are accepted:
37 * `mana_default_max`: Initial max. mana given to new players. Default: `200`. This value must be non-negative.
38 * `mana_default_regen`: Initial regenerated mana per “mana tick”. Default: `1`. This value can be a floating value. I.e. if the value is `0.5`, 1 mana is generated every two mana ticks (note that the player's mana amount is still a whole number). This value can be negative, in which case the player will lose mana.
39 * `mana_regen_timer`: The length of a “mana tick” in seconds. Each player will get his/her mana increased by the current
40   regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values
41   as those could probably stress your machine a lot.
43 License information
44 ===================
45 * `textures/mana_icon.png`: [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) by [Buch](http://opengameart.org/users/Buch).
46 * `textures/mana_bgicon.png`: CC BY 3.0, originally by Buch, modified by Wuzzy.
47 * `textures/mana_bar.png`: [WTFPL](http://www.wtfpl.net/txt/copying/) by Wuzzy.
48 * Everything else: WTFPL.