mirror of
https://repo.or.cz/minetest_hudbars.git
synced 2024-08-20 05:04:12 +02:00
Convert readme file to Markdown format
This commit is contained in:
parent
c25c2d1b6e
commit
003c6214ed
50
README.md
Normal file
50
README.md
Normal file
@ -0,0 +1,50 @@
|
||||
# HUD bars
|
||||
|
||||
## Description
|
||||
This mod changes the HUD of Minetest. It replaces the default health and breath
|
||||
symbols by horizontal colored bars with text showing the number.
|
||||
|
||||
Furthermore, it enables other mods to add their own custom bars to the HUD,
|
||||
this mod will place them accordingly.
|
||||
|
||||
**Important**: Keep in mind if running a server with this mod, that the custom
|
||||
position should be displayed correctly on every screen size.
|
||||
|
||||
## Current version
|
||||
The current version is 1.2.1.
|
||||
|
||||
This software uses [semantic versioning](http://semver.org), as defined by version 2.0.0 of the SemVer
|
||||
standard.
|
||||
|
||||
## Settings
|
||||
This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more.
|
||||
Use the advanced settings menu in Minetest for detailed configuration.
|
||||
|
||||
## API
|
||||
The API is used to add your own custom HUD bars.
|
||||
Documentation for the API of this mod can be found in `API.md`.
|
||||
|
||||
## Legal
|
||||
### License of source code
|
||||
Author: Wuzzy (2015)
|
||||
|
||||
This mod was forked from the “Better HUD” [hud] mod by BlockMen.
|
||||
|
||||
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 (WTFPL), version 2, as published by Sam Hocevar.
|
||||
|
||||
### Licenses of textures
|
||||
|
||||
* `hudbars_icon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
|
||||
* `hudbars_bgicon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
|
||||
* `hudbars_icon_breath.png`—kaeza (WTFPL), modified by BlockMen
|
||||
* `hudbars_bar_health.png`—Wuzzy (WTFPL)
|
||||
* `hudbars_bar_breath.png`—Wuzzy (WTFPL)
|
||||
* `hudbars_bar_background.png`—Wuzzy (WTFPL)
|
||||
|
||||
### License references
|
||||
|
||||
* [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
|
||||
* [WTFPL](http://sam.zoy.org/wtfpl/COPYING)
|
51
README.txt
51
README.txt
@ -1,51 +0,0 @@
|
||||
Minetest mod: HUD bars
|
||||
======================
|
||||
Version: 1.2.1
|
||||
|
||||
This software uses semantic versioning, as defined by version 2.0.0 of the SemVer
|
||||
standard. <http://semver.org/>
|
||||
|
||||
|
||||
License of source code: WTFPL
|
||||
-----------------------------
|
||||
Author: Wuzzy (2015)
|
||||
Forked from the “Better HUD” [hud] mod by BlockMen.
|
||||
|
||||
|
||||
Using the mod:
|
||||
--------------
|
||||
This mod changes the HUD of Minetest. It replaces the default health and breath symbols by horizontal colored bars with text showing
|
||||
the number.
|
||||
|
||||
Furthermore, it enables other mods to add their own custom bars to the HUD, this mod will place them accordingly.
|
||||
|
||||
IMPORTANT:
|
||||
Keep in mind if running a server with this mod, that the custom position should be displayed correctly on every screen size!
|
||||
|
||||
Settings:
|
||||
---------
|
||||
This mod can be configured quite a bit. You can change HUD bar appearance, offsets, ordering, and more. Use the advanced settings
|
||||
in Minetest for detailed configuration.
|
||||
|
||||
API:
|
||||
----
|
||||
The API is used to add your own custom HUD bars.
|
||||
Documentation for the API of this mod can be found in API.md.
|
||||
|
||||
|
||||
License of textures:
|
||||
--------------------
|
||||
hudbars_icon_health.png - celeron55 (CC BY-SA 3.0), modified by BlockMen
|
||||
hudbars_bgicon_health.png - celeron55 (CC BY-SA 3.0), modified by BlockMen
|
||||
hudbars_icon_breath.png - kaeza (WTFPL), modified by BlockMen
|
||||
hudbars_bar_health.png - Wuzzy (WTFPL)
|
||||
hudbars_bar_breath.png - Wuzzy (WTFPL)
|
||||
hudbars_bar_background.png - Wuzzy(WTFPL)
|
||||
|
||||
License of mod:
|
||||
---------------
|
||||
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.
|
Loading…
Reference in New Issue
Block a user