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