Add mod.conf and improve README.md (#3)

* Create mod.conf

* Update README.md

* Update README.md

* Update README.md
master
David Leal 2020-09-21 09:09:43 -05:00 committed by GitHub
parent a3b81882a3
commit 96b8d78fa8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 9 deletions

View File

@ -1,4 +1,4 @@
### skin_db
# Skin Database
A minetest skin mod that uses the skins resources located at http://minetest.fensta.bplaced.net/ to offer:
@ -7,12 +7,13 @@ A minetest skin mod that uses the skins resources located at http://minetest.fen
* assign personal skins to specific players
* supports Unified Inventory
* supports Inventory Plus
* supports 3D Armor
#### Use:
## How to use
To activate a skin double click it, after selecting a skin in the active list you have the options to remove it by double clicking, set moderator or admin flags and assign the skin to a specific player by typing their name in the field and clicking the private checkbox.
#### INSTALLATION
## INSTALLATION
skin_db requires lsqlite3 (https://github.com/LuaDist/lsqlite3).
@ -21,21 +22,22 @@ you can easily install lsqlite3 in a terminal:
luarocks install lsqlite3
If the target server runs mods in secure mode[recommended], you must add skin_db
If the target server runs mods in secure mode(recommended), you must add skin_db
to the list of trusted mods in minetest.conf:
secure.trusted_mods = skin_db
then move the skin_db.sqlite file into the world folder.
then move the skin_db.sqlite file into the world folder.
Also see https://wiki.minetest.net/Installing_Mods for more information.
##### Adding skins:
## Adding skins
You need 3 files before you can import a skin.
```
character_<number>.png -- 64 x 32 skin image
character_<number>_preview.png -- 16 x 32 preview image
character_<number>.txt -- name, author, licence on seperate lines
character_<number>.txt -- name, author, license on seperate lines
```
the png files are placed in the textures folder and the txt file in the meta folder, use the admin GUI import button. New skins appear in the inactive list and can be used immediately by adding them to the active list.
The .png files are placed in the textures folder and the txt file in the meta folder, use the admin GUI import button. New skins appear in the inactive list and can be used immediately by adding them to the active list.
Texture Info: All textures retain original licensing which can be found in the respective meta file
Texture Info: All textures retain original licensing which can be found in the respective meta file.

4
mod.conf Normal file
View File

@ -0,0 +1,4 @@
name = skin_db
depends = default
optional_depends = sfinv, unified_inventory, inventory_plus, 3d_armor
description = Adds over 1000 skins to Minetest.