Set version to 1.0.1
[minetest_hudbars.git] / README.txt
blob689ea55308898c121237259110337e95f377ee77
1 Minetest mod: HUD bars
2 ======================
3 Version: 1.0.1
5 This software uses semantic versioning, as defined by version 2.0.0 of the SemVer
6 standard. <http://semver.org/>
9 License of source code: WTFPL
10 -----------------------------
11 Author: Wuzzy (2015)
12 Forked from the “Better HUD” [hud] mod by BlockMen.
15 Using the mod:
16 --------------
17 This mod changes the HUD of Minetest. It replaces the default health and breath symbols by horizontal colored bars with text showing
18 the number.
20 Furthermore, it enables other mods to add their own custom bars to the HUD, this mod will place them accordingly.
22 You can create a “hudbars.conf” file to customize the positions of the health and breath bars. Take a look at “hudbars.conf.example”
23 to get more infos. The lines starting with “--” are comments, remove the two dashes to activate a setting. Settings which are not
24 set will use a default value instead.
27 IMPORTANT:
28 Keep in mind if running a server with this mod, that the custom position should be displayed correctly on every screen size!
30 API:
31 ----
32 The API is used to add your own custom HUD bars.
33 Documentation for the API of this mod can be found in API.md.
36 License of textures:
37 --------------------
38 hudbars_icon_health.png - celeron55 (CC BY-SA 3.0), modified by BlockMen
39 hudbars_icon_breath.png - kaeza (WTFPL), modified by BlockMen
40 hudbars_bar_health.png - Wuzzy (WTFPL)
41 hudbars_bar_breath.png - Wuzzy (WTFPL)
42 hudbars_bar_background.png - Wuzzy(WTFPL)
44 This program is free software. It comes without any warranty, to
45 the extent permitted by applicable law. You can redistribute it
46 and/or modify it under the terms of the Do What The Fuck You Want
47 To Public License, Version 2, as published by Sam Hocevar. See
48 http://sam.zoy.org/wtfpl/COPYING for more details.