From b7cd514cea0c5592ef110ea2b136b8eb703ad8ff Mon Sep 17 00:00:00 2001 From: SmallJoker Date: Sun, 7 Jul 2024 18:51:48 +0200 Subject: [PATCH] API: make skins.register_skin public (#106) --- API.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/API.md b/API.md index acb51d0..c60c760 100644 --- a/API.md +++ b/API.md @@ -27,6 +27,31 @@ Get all allowed skins for player. All public and all player's private skins. If Get all skins with metadata key is set to value. Example: skins.get_skinlist_with_meta("playername", playername) - Get all private skins (w.o. public) for playername +## skins.register_skin(path, filename) +Registers a new skin based on the texture file path specified by `path` and `filename`. + + * `path` (string): points to the parent directory of the texture `filename`. + Generally, this should be in the format `mymod.modpath .. "/textures"`. + * `filename` (string): full file name, without any path specifications. + The file name must adhere to [one of the accepted naming formats](textures/readme.txt). + +Note: this function takes the following files into consideration: + +1. `/` (required) + * Main skin texture +2. `/preview.png` (optional) + * Pre-generated preview image +3. `/../meta/.txt` (optional) + * Metadata regarding the skin + +Return values: + + * On failure: `false, reason` + * `reason` (string): human readable reason string (similar to `io.open` errors) + * On success: `true, key` + * `key`: unique skins key for use with e.g. `skins.get(key)` for subsequent + fine-tuning of the skin registration. + ## skins.new(key, object) Create and register a new skin object for given key