skinsdb/README.md

64 lines
2.0 KiB
Markdown
Raw Normal View History

# skinsdb
2017-06-21 21:36:30 +02:00
This Minetest mod offers changeable player skins with a graphical interface for multiple inventory mods.
2017-06-21 21:36:30 +02:00
## Features
2017-06-21 21:36:30 +02:00
- 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)
2018-02-14 20:26:14 +01:00
- Skins change menu and command line using chat command /skinsdb (set | show | list | list private | list public | ui)
- 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
2018-04-15 01:09:38 +02:00
- Compatible to 1.0 and 1.8 Minecraft skins format
2017-06-21 21:36:30 +02:00
## Installing skins
2020-06-07 13:39:57 +02:00
### Download from the [database](http://minetest.fensta.bplaced.net/)
#### Ingame Downloader
1) Get Minetest 5.1.0-dev-cb00632 or newer
2) Start your world
3) Run `/skinsdb_download_skins <skindb start page> <amount of pages>`
4) Wait for the Minetest server to shut down
5) Start the server again
You might want to run `minetest` in a Terminal/Console window to check the log output instantly.
2020-06-07 13:39:57 +02:00
#### Python Download script
**Requirements:**
* Python 3
* `requests` library: `pip3 install requests`
Go to the updater folder of this mod and run `python3 update_skins.py`
The Script will download all the skins from the database for you.
### Manual addition
1) Copy your skin textures to `textures` as documented in `textures/readme.txt`
2) Create `meta/character_<name>.txt` with the following fields (separated by new lines):
* Skin name
* Author
* Skin license
## License:
- GPLv3
- skin texture licenses: See "meta" folder
2017-06-21 21:36:30 +02:00
### Credits
2017-06-21 21:36:30 +02:00
- RealBadAngel (unified_inventory)
- Zeg9 (skinsdb)
- cornernote (source code)
- Krock (source code)
2018-02-14 20:26:14 +01:00
- bell07 (source code)
2018-04-15 01:09:38 +02:00
- stujones11 (player models)