comments

Supersedes the 'fsep' setting by automatically detecting
the texture name in both, the skin list and the updater
scripts.
New, automatically fetched skins will now always use the
'.' delimiter to avoid player name issues

API.md

@@ -27,31 +27,6 @@ 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. `<path>/<filename>` (required)
-    * Main skin texture
-2. `<path>/<filenamestem><separator>preview.png` (optional)
-    * Pre-generated preview image
-3. `<path>/../meta/<filenamestem>.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

api.lua

@@ -2,26 +2,14 @@
 local storage = minetest.get_mod_storage()
 
 function skins.get_player_skin(player)
-	local player_name = player:get_player_name()
 	local meta = player:get_meta()
 	if meta:get("skinsdb:skin_key") then
 		-- Move player data prior July 2018 to mod storage
-		storage:set_string(player_name, meta:get_string("skinsdb:skin_key"))
+		storage:set_string(player:get_player_name(), meta:get_string("skinsdb:skin_key"))
 		meta:set_string("skinsdb:skin_key", "")
 	end
-
-	local skin_name = storage:get_string(player_name)
-	local skin = skins.get(skin_name)
-	if #skin_name > 0 and not skin then
-		-- Migration step to convert `_`-delimited skins to `.` (if possible)
-		skin = skins.__fuzzy_match_skin_name(player_name, skin_name, true)
-		if skin then
-			storage:set_string(player_name, skin:get_key())
-		else
-			storage:set_string(player_name, "")
-		end
-	end
-	return skin or skins.get(skins.default)
+	local skin = storage:get_string(player:get_player_name())
+	return skins.get(skin) or skins.get(skins.default)
 end
 
 -- Assign skin to player

init.lua

@@ -72,7 +72,6 @@ minetest.register_on_shutdown(function()
 	end
 end)
 
--- See also: 3d_armor/init.lua
 player_api.register_model("skinsdb_3d_armor_character_5.b3d", {
 	animation_speed = 30,
 	textures = {
@@ -83,21 +82,16 @@ player_api.register_model("skinsdb_3d_armor_character_5.b3d", {
 	},
 	animations = {
 		stand = {x=0, y=79},
-		lay = {x=162, y=166, eye_height = 0.3, override_local = true,
-			collisionbox = {-0.6, 0.0, -0.6, 0.6, 0.3, 0.6}},
+		lay = {x=162, y=166},
 		walk = {x=168, y=187},
 		mine = {x=189, y=198},
 		walk_mine = {x=200, y=219},
-		sit = {x=81, y=160, eye_height = 0.8, override_local = true,
-			collisionbox = {-0.3, 0.0, -0.3, 0.3, 1.0, 0.3}},
+		sit = {x=81, y=160},
 		-- compatibility w/ the emote mod
 		wave = {x = 192, y = 196, override_local = true},
 		point = {x = 196, y = 196, override_local = true},
 		freeze = {x = 205, y = 205, override_local = true},
 	},
-	collisionbox = {-0.3, 0.0, -0.3, 0.3, 1.7, 0.3},
-	-- stepheight: use default
-	eye_height = 1.47,
 })
 
 -- Register default character.png if not part of this mod
@@ -117,6 +111,3 @@ minetest.register_allow_player_inventory_action(function(player, action, inv, da
 		return 0
 	end
 end)
-
---dofile(skins.modpath.."/unittest.lua")
-

mod.conf

@@ -1,5 +1,5 @@
 name = skinsdb
 description = Player skin mod, supporting unified_inventory, sfinv and smart_inventory
 depends = player_api
-optional_depends = unified_inventory, 3d_armor, clothing, creative, sfinv, hand_monoid
+optional_depends = unified_inventory,3d_armor,clothing,sfinv,hand_monoid
 min_minetest_version = 5.4.0

skin_meta_api.lua

@@ -49,25 +49,23 @@ function skin_class:set_texture(value)
 	self._texture = value
 end
 
---- Retrieves the character texture
 function skin_class:get_texture()
 	return self._texture
 end
 
---- Assigns an existing hand item (/node) name to this skin
 function skin_class:set_hand(hand)
 	self._hand = hand
 end
 
-function skin_class:get_hand()
-	return self._hand
-end
-
---- Registers a new hand item based on the skin meta
 local ALPHA_CLIP = minetest.features.use_texture_alpha_string_modes and "clip" or true
 function skin_class:set_hand_from_texture()
 	local hand = core.get_current_modname()..':'..self._texture:gsub('[%p%c%s]', '')
 	local hand_def = {}
+	for k,v in pairs(minetest.registered_items[""]) do
+		if k ~= "mod_origin" and k ~= "type" and k ~= "wield_image" then
+			hand_def[k] = v
+		end
+	end
 	hand_def.tiles = {self:get_texture()}
 	hand_def.visual_scale = 1
 	hand_def.wield_scale = {x=1,y=1,z=1}
@@ -79,39 +77,13 @@ function skin_class:set_hand_from_texture()
 		hand_def.mesh = "skinsdb_hand_18.b3d"
 	end
 	hand_def.use_texture_alpha = ALPHA_CLIP
-
-	core.register_node(hand, table.copy(hand_def))
-
-	self._hand_def = hand_def -- for wieldhand overrides
+	minetest.register_node(hand, hand_def)
 	self:set_hand(hand)
 end
 
--- creative (and other mods?) may overwrite the wieldhand very late.
--- Grab the most recent definition and use them as default for our skin hands.
-core.register_on_mods_loaded(function()
-	local default_hand_def = {}
-	for k, v in pairs(core.registered_items[""]) do
-		if k ~= "mod_origin"
-				and k ~= "name"
-				and k ~= "type"
-				and k ~= "wield_image"
-				and string.sub(k, 1, 1) ~= "_" then
-			default_hand_def[k] = v
-		end
-	end
-	for _, meta in pairs(skins.meta) do
-		local def = core.registered_nodes[meta._hand]
-		if def then
-			local new_def = table.copy(default_hand_def)
-			-- Overwrite the hand with our fields from `set_hand_from_texture`
-			for k, v in pairs(meta._hand_def) do
-				new_def[k] = v
-			end
-			core.override_item(meta._hand, new_def)
-		end
-		meta._hand_def = nil -- no longer needed, free up RAM
-	end
-end)
+function skin_class:get_hand()
+	return self._hand
+end
 
 function skin_class:set_preview(value)
 	self._preview = value
@@ -137,7 +109,7 @@ function skin_class:get_preview()
 	--Right Leg
 	skin = skin .. "([combine:16x32:0,0=" .. player_skin .. "^[mask:skindb_mask_rleg.png)^"
 
-	-- 64x64 skins have non-mirrored arms and legs
+	-- 64x skins have non-mirrored arms and legs
 	local left_arm
 	local left_leg
 
@@ -154,21 +126,17 @@ function skin_class:get_preview()
 	--Left Leg
 	skin = skin .. left_leg
 
-	if self:get_meta("format") == "1.8" then
-		-- Add overlays for 64x64 skins. This check is needed to avoid
-		-- client-side out-of-bounds "[combine" warnings.
-
-		--Chest Overlay
-		skin = skin .. "([combine:16x32:-16,-28=" .. player_skin .. "^[mask:skindb_mask_chest.png)^"
-		--Right Arm Overlay
-		skin = skin .. "([combine:16x32:-44,-28=" .. player_skin .. "^[mask:skindb_mask_rarm.png)^"
-		--Right Leg Overlay
-		skin = skin .. "([combine:16x32:0,-16=" .. player_skin .. "^[mask:skindb_mask_rleg.png)^"
-		--Left Arm Overlay
-		skin = skin .. "([combine:16x32:-40,-44=" .. player_skin .. "^[mask:(skindb_mask_rarm.png^[transformFX))^"
-		--Left Leg Overlay
-		skin = skin .. "([combine:16x32:4,-32=" .. player_skin .. "^[mask:(skindb_mask_rleg.png^[transformFX))"
-	end
+	-- Add overlays for 64x skins. these wont appear if skin is 32x because it will be cropped out
+	--Chest Overlay
+	skin = skin .. "([combine:16x32:-16,-28=" .. player_skin .. "^[mask:skindb_mask_chest.png)^"
+	--Right Arm Overlay
+	skin = skin .. "([combine:16x32:-44,-28=" .. player_skin .. "^[mask:skindb_mask_rarm.png)^"
+	--Right Leg Overlay
+	skin = skin .. "([combine:16x32:0,-16=" .. player_skin .. "^[mask:skindb_mask_rleg.png)^"
+	--Left Arm Overlay
+	skin = skin .. "([combine:16x32:-40,-44=" .. player_skin .. "^[mask:(skindb_mask_rarm.png^[transformFX))^"
+	--Left Leg Overlay
+	skin = skin .. "([combine:16x32:4,-32=" .. player_skin .. "^[mask:(skindb_mask_rleg.png^[transformFX))"
 
 	-- Full Preview
 	skin = "(((" .. skin .. ")^[resize:64x128)^[mask:skindb_transform.png)"

skinlist.lua

@@ -2,11 +2,10 @@ local dbgprint = false and print or function() end
 
 --- @param path     Path to the "textures" directory, without tailing slash.
 --- @param filename Current file name, such as "player.groot.17.png".
---- @return On error: false, error message. On success: true, skin key
-function skins.register_skin(path, filename)
+local function process_skin_texture(path, filename)
 	-- See "textures/readme.txt" for allowed formats
 
-	local prefix, sep, identifier, extension = filename:match("^(%a+)([_.])([%w_.-]+)%.(%a+)$")
+	local prefix, sep, identifier, extension = filename:match("^(%a+)([_.])([%w_]+)%.(%a+)$")
 	--[[
 		prefix:     "character" or "player"
 		sep:        "." (new) or "_" (legacy)
@@ -17,21 +16,17 @@ function skins.register_skin(path, filename)
 
 	-- Filter out files that do not match the allowed patterns
 	if not extension or extension:lower() ~= "png" then
-		return false, "invalid skin name"
+		return -- Not a skin texture
 	end
 	if prefix ~= "player" and prefix ~= "character" then
-		return false, "unknown type"
+		return -- Unknown type
 	end
 
 	local preview_suffix = sep .. "preview"
 	if identifier:sub(-#preview_suffix) == preview_suffix then
-		-- The preview texture is added by the main skin texture (if exists)
-		return false, "preview texture"
-	end
-
-	assert(path)
-	if path == ":UNITTEST:" then
-		path = nil
+		-- skip preview textures
+		-- This is added by the main skin texture (if exists)
+		return
 	end
 
 	dbgprint("Found skin", prefix, identifier, extension)
@@ -63,16 +58,12 @@ function skins.register_skin(path, filename)
 	local skin_obj = skins.get(filename_noext) or skins.new(filename_noext)
 	skin_obj:set_texture(filename)
 	skin_obj:set_meta("_sort_id", sort_id)
-	if sep ~= "_" then
-		skin_obj._legacy_name = filename_noext:gsub("[._]+", "_")
-	end
-
 	if playername then
 		skin_obj:set_meta("assignment", "player:"..playername)
 		skin_obj:set_meta("playername", playername)
 	end
 
-	if path then
+	do
 		-- Get type of skin based on dimensions
 		local file = io.open(path .. "/" .. filename, "r")
 		local skin_format = skins.get_skin_format(file)
@@ -83,7 +74,7 @@ function skins.register_skin(path, filename)
 	skin_obj:set_hand_from_texture()
 	skin_obj:set_meta("name", identifier)
 
-	if path then
+	do
 		-- Optional skin information
 		local file = io.open(path .. "/../meta/" .. filename_noext .. ".txt", "r")
 		if file then
@@ -92,50 +83,18 @@ function skins.register_skin(path, filename)
 			skin_obj:set_meta("name", data[1])
 			skin_obj:set_meta("author", data[2])
 			skin_obj:set_meta("license", data[3])
-			file:close() -- do not rely on delayed GC
 		end
 	end
 
-	if path then
+	do
 		-- Optional preview texture
 		local preview_name = filename_noext .. sep .. "preview.png"
 		local fh = io.open(path .. "/" .. preview_name)
 		if fh then
 			dbgprint("Found preview", preview_name)
 			skin_obj:set_preview(preview_name)
-			fh:close() -- do not rely on delayed GC
 		end
 	end
-
-	return true, skin_obj:get_key()
-end
-
---- Internal function. Fallback/migration code for `.`-delimited skin names that
---- were equipped between d3c7fa7 and 312780c (master branch).
---- During this period, `.`-delimited skin names were internally registered with
---- `_` delimiters. This function tries to find a matching skin.
---- @param player_name (string)
---- @param skin_name   (string) e.g. `player_foo_mc_bar`
---- @param be_noisy    (boolean) whether to print a warning in case of mismatches`
---- @return On match, the new skin (skins.skin_class) or `nil` if nothing matched.
-function skins.__fuzzy_match_skin_name(player_name, skin_name, be_noisy)
-	if select(2, skin_name:gsub("%.", "")) > 0 then
-		-- Not affected by ambiguity
-		return
-	end
-
-	for _, skin in pairs(skins.meta) do
-		if skin._legacy_name == skin_name then
-			dbgprint("Match", skin_name, skin:get_key())
-			return skin
-		end
-		--dbgprint("Try match", skin_name, skin:get_key(), skin._legacy_name)
-	end
-
-	if be_noisy then
-		minetest.log("warning", "skinsdb: cannot find matching skin '" ..
-			skin_name .. "' for player '" .. player_name .. "'.")
-	end
 end
 
 do
@@ -144,7 +103,7 @@ do
 	local skins_dir_list = minetest.get_dir_list(skins_path)
 
 	for _, fn in pairs(skins_dir_list) do
-		skins.register_skin(skins_path, fn)
+		process_skin_texture(skins_path, fn)
 	end
 end
 

textures/readme.txt

@@ -6,7 +6,6 @@ List of accepted texture names
 
 Public skin available for all users:
 	character.[number or name].png
-	^ The allowed characters in "[number or name]" are "[A-z0-9_.-]+".
 
 One or multiple private skins for player "[nick]":
 	player.[nick].png
@@ -27,7 +26,7 @@ The character `_` is accepted in player names, thus it is not recommended to
 use such file names. For compatibility reasons, they are still recognized.
 
 	character_[number or name].png
-	player_[nick].png
+	player_[nick]_png
 	player_[nick]_[number or name].png
 
 ... and corresponding previews that end in `_preview.png`.

unittest.lua

@@ -1,51 +0,0 @@
-local function get_skin(skin_name)
-	local skin = skins.get(skin_name)
-		or skins.__fuzzy_match_skin_name("(unittest)", skin_name, true)
-	return skin and skin:get_key() or nil
-end
-
-local function run_unittest()
-	local PATH = ":UNITTEST:"
-
-	-- -----
-	-- `.`: Simple register + retrieve operations
-	assert(skins.register_skin(PATH, "player.DotSep.png"))
-	assert(skins.register_skin(PATH, "player._DotSep_666_.1.png"))
-	assert(skins.register_skin(PATH, "character._DotSep_With-Dash-.png"))
-
-	assert(get_skin("player.DotSep"))
-	assert(get_skin("player._DotSep_666_.1"))
-	assert(get_skin("player.DotSep.1") == nil)
-	assert(get_skin("character._DotSep_With-Dash-"))
-
-	-- -----
-	-- Ambiguous skin names (filenames without extension). Register + retrieve
-	skins.new("player_AmbSki")
-	skins.new("player_AmbSki_1")
-	skins.new("player_AmbSki_666_1")
-
-	assert(get_skin("player_AmbSki"))
-	assert(get_skin("player_AmbSki_") == nil)
-	assert(get_skin("player_AmbSki_1"))
-	assert(get_skin("player_AmbSki_666_1"))
-	-- There are no `__` patterns as they were silently removed by string.split
-
-
-	-- -----
-	-- Mod Storage backwards compatibility
-	-- Match the old `_` notation to `.`-separated skins
-	skins.register_skin(PATH, "player.ComPat42.png")
-	skins.register_skin(PATH, "player.ComPat42.5.png")
-	skins.register_skin(PATH, "player._Com_Pat_42.png")
-	skins.register_skin(PATH, "player._Com_Pat_42.1.png")
-
-	assert(get_skin("player_ComPat42") == "player.ComPat42")
-	assert(get_skin("player_ComPat42_5") == "player.ComPat42.5")
-	assert(get_skin("player_Com_Pat_42") == "player._Com_Pat_42")
-	assert(get_skin("player_Com_Pat_42_1") == "player._Com_Pat_42.1")
-
-	error("Unittest passed! Please disable them now.")
-end
-
-run_unittest()
-