Rewrite README and convert to Markdown

This commit is contained in:
Wuzzy 2016-11-12 19:33:19 +01:00
parent dd1bf4e74c
commit 41fbe9a0d0
2 changed files with 43 additions and 49 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# HUD bar for `3d_armor` [`hbarmor`]
* Version: 0.1.0
## Description
This mod adds a simple HUD bar which displays the current damage
of the player's armor (from the 3D Armor [`3d_armor`] mod) as a percentage (rounded).
100% armor means the armor is in perfect shape. 0% means the armor is almost destroyed
or non-existant. Note that to reach 100%, the player must wear at least 4 different
pieces of armor in perfect shape.
The armor bar also does not tell anything about the armor's strength,
only how worn out it already is.
By default, the armor bar is hidden if the player wears no armor.
## Dependencies
* HUD bars [`hudbars`], major version 1
* 3D Armor [`3d_armor`] (tested with Minetest 0.4.14)
## Licensing
This mod is entirly free softare.
### Source code
* License: WTFPL (see below)
* Authors: Wuzzy, forked from the mod “Better HUD (and hunger)” [`hud`] by BlockMen (2013-2014)
### Textures
* `hbarmor_icon.png`—Stu ([CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)), modified by BlockMen
* `hbarmor_bgicon.png`—Stu (CC BY-SA 3.0), modified by BlockMen
* `hbarmor_bar.png`—Wuzzy (WTFPL)
Everything else is WTFPL:
© Copyright BlockMen (2013-2014)
This program is free software. It comes without any warranty, to
the extent permitted by applicable law. You can redistribute it
and/or modify it under the terms of the Do What The Fuck You Want
To Public License, Version 2, as published by Sam Hocevar. See
http://sam.zoy.org/wtfpl/COPYING for more details.

View File

@ -1,49 +0,0 @@
Minetest mod: HUD bar for armor [hbarmor]
=========================================
Version: 0.1.0
License of source code: WTFPL
-----------------------------
By Wuzzy,
forked from the mod “Better HUD (and hunger)” [hud]
by BlockMen (2013-2014).
Using the mod:
--------------
This mod adds a simple HUD bar which displays the current
damage of the player's armor (from the 3D Armor mod) as a percentage,
this number is of course rounded.
100% means the armor is in perfect shape, 0% means the armor
is almost destroyed or non-existant.
Note that to reach 100%, the player must wear at least 4 different
pieces of armor in perfect shape.
The armor bar also does not tell anything about the armor's strength,
only how worn out it already is.
By default, the armor bar is hidden if the player wears no armor.
Dependencies:
- HUD bars [hudbars], major version 1
- 3D Armor [3d_armor] (tested with 0.4.3)
License of textures:
--------------------
hbarmor_icon.png - Stu (CC BY-SA 3.0), modified by BlockMen
hbarmor_bgicon.png - Stu (CC BY-SA 3.0), modified by BlockMen
hbarmor_bar.png - Wuzzy (WTFPL)
everything else is WTFPL:
(c) Copyright BlockMen (2013-2014)
This program is free software. It comes without any warranty, to
the extent permitted by applicable law. You can redistribute it
and/or modify it under the terms of the Do What The Fuck You Want
To Public License, Version 2, as published by Sam Hocevar. See
http://sam.zoy.org/wtfpl/COPYING for more details.