write something there

mods/skinsdb/README.md

@@ -0,0 +1,68 @@
+# skinsdb
+
+This Minetest mod offers changeable player skins with a graphical interface for multiple inventory mods.
+
+## Features
+
+- 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)
+- 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
+- Supported by [i3](https://github.com/minetest-mods/i3) inventory mod
+- 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
+- Compatible to 1.0 and 1.8 Minecraft skins format
+- Skinned hand in 1st person view (1.0 skins only)
+
+
+## Installing skins
+
+### Download from the [database](https://skinsdb.terraqueststudios.net/)
+
+#### Ingame Downloader
+
+1) Get Minetest 5.1.0-dev-cb00632 or newer
+2) In the settings menu show advanced options, find the "Developer Options" tab and add "skinsdb" to "Trusted mods" (secure.trusted_mods in minetest.conf)
+3) Start your world
+4) Run `/skinsdb_download_skins <skindb start page> <amount of pages>`
+5) Wait for the Minetest server to shut down
+6) Start the server again
+
+You might want to run `minetest` in a Terminal/Console window to check the log output instantly.
+
+#### 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
+- hand model: CC0
+
+### Credits
+
+- RealBadAngel (unified_inventory)
+- Zeg9 (skinsdb)
+- cornernote (source code)
+- Krock (source code)
+- bell07 (source code)
+- stujones11 (player models)
+- jordan4ibanez (1st person view hand)