History

Johannes Fritz f5cd23908f Fix displaying model element on MT 5.4		2022-09-16 18:09:15 +02:00
..
locale	Add simple skins skins support	2022-09-06 12:51:43 -05:00
meta	Re add alex skin	2022-09-06 19:23:06 -06:00
models
textures	Re add alex skin	2022-09-06 19:23:06 -06:00
.gitignore	Re-add gitignore file to mcl_skins	2022-09-06 19:25:58 -06:00
edit_skin.lua	Fix displaying model element on MT 5.4	2022-09-16 18:09:15 +02:00
init.lua	Add simple skins skins support	2022-09-06 12:51:43 -05:00
LICENSE.txt	Add simple skins skins support	2022-09-06 12:51:43 -05:00
list.json	Add simple skins skins support	2022-09-06 12:51:43 -05:00
media_credits.txt
mesh_hand.lua	Add simple skins skins support	2022-09-06 12:51:43 -05:00
mod.conf	Fix invisibility potion when changing skin	2022-09-15 12:04:20 -05:00
README.md	Fix invisibility potion when changing skin	2022-09-15 12:04:20 -05:00
simple_skins.lua	Add simple skins skins support	2022-09-06 12:51:43 -05:00

README.md

Mineclone Skins

This mod allows advanced skin customization. Use the /skin command to open the skin configuration screen.

License

Code under MIT license Author: TenPlus1, Zeg9, MrRar

See image_credits.txt for image licensing.

API

`mcl_skins.register_item(item)`

Item properties

type Set the item type. Valid values are: "base", "footwear", "eye", "mouth", "bottom", "top", "hair", "headwear"

texture Set to the image file that will be used. If this property is omitted "blank.png" is used.

mask Set the color mask texture. Coloring is only applied to non transparent areas of the texture. Coloring only works for "base", "bottom, "top", and "hair".

preview_rotation A table containing properties x and y. x and y represent the x and y rotation of the item preview.

alex If set to true the item will be default for female character.

steve If set to true the item will be default for male character.

`mcl_skins.show_formspec(player, active_tab, page_num)`

Show the skin configuration screen. player is a player ObjectRef. active_tab is the tab that will be displayed. This parameter is optional. Can be one of: "arm", "base", "footwear", "eye", "mouth", "bottom", "top", "hair", "headwear"

page_num The page number to display of there are multiple pages of items. This parameter is optional. Must be a number. If it is not a valid page number the closest page number will be shown.

`mcl_skins.get_skin_list()`

This function is used by mods that want a list of skins to register nodes that use the player skin as a texture. Returns an array of tables containing information about each skin. Each table contains the following properties:

id: A string representing the node ID. A node can be registered using this node ID. texture: A texture string that can be used in the node defintion. slim_arms: A boolean value. If true, this texture is used with the "female" player mesh. Otherwise the regular mesh is to be used.

`mcl_skins.get_node_id_by_player(player)`

player is a player ObjectRef. Returns a string node ID based on players current skin for use by mods that want to register nodes that use the player skin.

`mcl_skins.save(player)`

Save player skin. player is a player ObjectRef.

`mcl_skins.update_player_skin(player)`

Update a player based on skin data in mcl_skins.players. player is a player ObjectRef.

`mcl_skins.base_color`

A table of ColorSpec integers that the player can select to color the base item. These colors are separate from mcl_skins.color because some mods register two nodes per base color so the amount of base colors needs to be limited.

`mcl_skins.color`

A table of ColorSpec integers that the player can select to color colorable skin items.

`mcl_skins.players`

A table mapped by player ObjectRef containing tables holding the player's selected skin items and colors. Only stores skin information for logged in users.

mcl_skins.compile_skin(skin)

skin is a table with skin item properties. Returns an image string.