forked from MineClone5/MineClone5
78 lines
2.9 KiB
Markdown
78 lines
2.9 KiB
Markdown
# Skins for MineClone 5
|
|
|
|
This mod allows advanced skin customization.
|
|
Use the /skin command to open the skin configuration screen.
|
|
|
|
## License
|
|
Code under MIT license
|
|
Author: MrRar
|
|
|
|
See image_credits.txt for image licensing.
|
|
|
|
## API
|
|
|
|
### `mcl_skins.register_item(item)`
|
|
Register a skin item. `item` is a table with item properties listed below.
|
|
|
|
### 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.
|
|
If texture is not 64x32 then the automatic preview will not display properly.
|
|
|
|
`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".
|
|
If texture is not 64x32 then the automatic preview will not display properly.
|
|
|
|
`preview`
|
|
Set a custom preview texture. You can use texture modifiers. If preview contains the string `{color}` it will be replaced with the item's colorstring.
|
|
|
|
`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.register_on_set_skin(func)`
|
|
Register a function to be called whenever a player skin changes.
|
|
The function will be given a player ObjectRef as a parameter.
|
|
|
|
### `mcl_skins.make_hand_texture(base, colorspec)`
|
|
Generate a texture string from a base texture and color.
|
|
This function is used by mods that want to have a first person hand textured like 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 name 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.
|