nalc/minetest_mana
1
0
Fork 0
forked from mtcontrib/minetest_mana
Code Issues Pull Requests Releases Wiki Activity

Use Markdown format for README file

Browse Source
This commit is contained in:
Wuzzy 2016-10-29 15:27:00 +02:00
parent fc0efd94fb
commit 3b8097e44a
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.txt → README.md
View File

@ -1,18 +1,16 @@
Mana mod [mana] # Mana [mana]
===============
Version: 1.1.0
Note: This mod uses semantic versioning, as defined by version 2.0.0 of the SemVer standard.
See: <http://semver.org/>
Description * Version: 1.1.0
=========== * Note: This mod uses semantic versioning, as defined by version 2.0.0 of the SemVer standard. See: <http://semver.org/>
## Description
This mod adds basic support for mana to Minetest. This mod adds basic support for mana to Minetest.
Each player will have an additional attribute: Mana. To be precise: Each player will have an additional attribute: Mana. To be precise:
- Current mana reserves: How much mana the player currently has * Current mana reserves: How much mana the player currently has
- Maximum possible mana: How much mana the player can have at maximum * 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) * 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 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 these values can be configured with the server settings (`minetest.conf`) and it is highly advised to do
@ -25,15 +23,14 @@ The mod provides a simple API to set, get, add and subtract the mana (and maximu
for setting the regeneration amount. Note that this mod itself does *not* change the gameplay in a meaningful 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. way. You should install other mods which use the Mana mod as a dependency.
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.
It currently only works with version 0.3.0 of this mod. It currently only works with version 0.3.0 of this mod.
Otherwise, the mana is just shown as text. Otherwise, the mana is just shown as text.
Configuration ## 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:
@ -43,10 +40,9 @@ This mod can be configured with minetest.conf! The following settings are accept
regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values
as those could probably stress your machine a lot. as those could probably stress your machine a lot.
License information License information
=================== ===================
* textures/mana_icon.png: CC-BY by Buch <http://opengameart.org/users/Buch>. * `textures/mana_icon.png`: [CC BY 3.0](http://opengameart.org/sites/default/files/license_images/cc-by.png) by [Buch](http://opengameart.org/users/Buch).
* textures/mana_bgicon.png: CC-BY, originally by Buch <http://opengameart.org/users/Buch>, modified by Wuzzy. * `textures/mana_bgicon.png`: CC BY 3.0, originally by Buch, modified by Wuzzy.
* textures/mana_bar.png: WTFPL by Wuzzy. * `textures/mana_bar.png`: [WTFPL](http://www.wtfpl.net/txt/copying/) by Wuzzy.
* Everything else: WTFPL. * Everything else: WTFPL.