Rewrite README to proper markdown and better readability

This commit is contained in:
SmallJoker 2017-10-02 10:48:57 +02:00
parent 7791ac7fdf
commit 71e05bbd68

View File

@ -1,40 +1,42 @@
minetest-skinsdb
# skinsdb
An skin extention for the Minetest.
This Minetest mod offers changeable player skins with a graphical interface for multiple inventory mods.
Features:
- a flexible Skins-API to manage a skins database
- character_creator supported as "custom skin" possible
- Inventory tabs in sfinv and unified_inventory to select the skins
- Smart_inventory uses the skinsdb for skins selection
- Skin previews supported in selection
- Skin metadata supported showing the selected skin
- Support for different skins lists. Currently implemented a public list and per-player lists trough skin filenames
- Full 3d_armor support
- Previews are used in 3d_armor selection
- skins download scripts included for the Minetest skin database. (http://minetest.fensta.bplaced.net)
## Features
To download the latest there are 3 tools available in "updater" folder:
"./update_skins_db.sh" bash and jq required
"./update_from_db.py" python3 required
"MT_skins_updater.exe" windows required
- Download scripts included for the [Minetest skin database](http://minetest.fensta.bplaced.net)
- Flexible skins API to manage the database
- [character_creator](https://github.com/minetest-mods/character_creator) support for custom skins
- Skin change menu for sfinv (in minetest_game) and [unified_inventory](https://forum.minetest.net/viewtopic.php?t=12767)
- Supported by [smart_inventory](https://forum.minetest.net/viewtopic.php?t=16597) for the skin selection
- Skin previews supported in selection
- Additional information for each skin
- Support for different skins lists: public and a per-player list are currently implemented
- Full [3d_armor](https://forum.minetest.net/viewtopic.php?t=4654) support
Licenses:
--------
cornernote:
- Lua source code (GPLv3)
## Update tools
In order to download the skins from the skin database,
you may use one of the listed update tools below.
They are located in the `updater/` directory.
- `update_skins_db.sh` bash and jq required
- `update_from_db.py` python3 required
- `MT_skins_updater.*` windows or mono (?) required
## License
If nothing else is specified, it is licensed as GPLv3.
Fritigern:
- update_skins_db.sh (CC-BY-NC-SA 4.0)
Krock:
- Lua source code (GPLv3)
- MT_skins_updater.exe (WTFPL)
bell07:
- Lua source code (GPLv3)
### Credits
Credits:
- RealyBadAngel unified_inventory
- Zeg9 skinsdb
- RealBadAngel (unified_inventory)
- Zeg9 (skinsdb)
- cornernote (source code)
- Krock (source code)
- bell07 (source code)