minetest_mana/README.txt

52 lines
2.2 KiB
Plaintext
Raw Normal View History

2015-02-05 01:42:20 +01:00
Mana mod [mana]
===============
2015-02-14 07:08:05 +01:00
Version: 0.4.0
2015-02-05 01:42:20 +01:00
Note: This mod uses semantic versioning, as defined by version 2.0.0 of the SemVer standard.
See: <http://semver.org/>
Description
===========
2015-02-04 20:48:11 +01:00
This mod adds basic support for mana to Minetest.
2015-02-14 03:00:02 +01:00
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)
2015-02-14 02:37:03 +01:00
By default, each player spawns with 0/200 mana, and regenerates 1 mana per fifth of a second. All
2015-02-14 02:33:45 +01:00
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.
2015-02-14 03:00:02 +01:00
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.
2015-02-08 00:16:44 +01:00
The API documentation is in the file API.md.
2015-02-04 20:48:11 +01:00
If the mod “HUD bars” [hudbars] is installed, a blue bar will be added to the HUD showing the player's mana reserves.
2015-02-10 02:50:35 +01:00
It currently only works with version 0.3.0 of this mod.
2015-02-04 20:48:11 +01:00
Otherwise, the mana is just shown as text.
2015-02-14 01:01:34 +01:00
Configuration
=============
This mod can be configured with minetest.conf! The following settings are accepted:
2015-02-14 02:33:45 +01:00
* `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
2015-02-14 02:37:03 +01:00
regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values
2015-02-14 02:33:45 +01:00
as those could probably stress your machine a lot.
2015-02-14 01:01:34 +01:00
2015-02-04 20:48:11 +01:00
License information
===================
2015-02-05 01:42:20 +01:00
* textures/mana_icon.png: CC-BY by Buch <http://opengameart.org/users/Buch>.
* textures/mana_bar.png: WTFPL by Wuzzy.
* Everything else: WTFPL.