4 Commits

Author SHA1 Message Date
0bfcb4ed14 saner commenting 2024-06-14 23:38:25 +02:00
8deb08696f unitest 2024-06-10 19:51:25 +02:00
e315876c75 try the other way around 2024-06-10 19:49:38 +02:00
00e5696eec Add migration code to player skins using '.' delimiters
Previously, the players would have their selected skin reset.
See 'skins.__fuzzy_match_skin_name' for a detailed explanation.

This also fixes an issue where player.[name].[number].png skins
were not recognized.
2024-06-10 18:31:03 +02:00
25 changed files with 34 additions and 126 deletions

4
.gitignore vendored
View File

@ -1,4 +1,4 @@
#textures/character_*.png textures/character_*.png
textures/player_*.png textures/player_*.png
#meta/character_*.txt meta/character_*.txt
meta/player_*.txt meta/player_*.txt

25
API.md
View File

@ -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: 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.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) ## skins.new(key, object)
Create and register a new skin object for given key Create and register a new skin object for given key

View File

@ -1,4 +1,4 @@
# skinsdb - User-facing branch that includes a few basic skins # skinsdb
This Minetest mod offers changeable player skins with a graphical interface for multiple inventory mods. This Minetest mod offers changeable player skins with a graphical interface for multiple inventory mods.
@ -66,4 +66,3 @@ The Script will download all the skins from the database for you.
- bell07 (source code) - bell07 (source code)
- stujones11 (player models) - stujones11 (player models)
- jordan4ibanez (1st person view hand) - jordan4ibanez (1st person view hand)
- sirrobzeroone (skins)

View File

@ -72,7 +72,6 @@ minetest.register_on_shutdown(function()
end end
end) end)
-- See also: 3d_armor/init.lua
player_api.register_model("skinsdb_3d_armor_character_5.b3d", { player_api.register_model("skinsdb_3d_armor_character_5.b3d", {
animation_speed = 30, animation_speed = 30,
textures = { textures = {
@ -83,21 +82,16 @@ player_api.register_model("skinsdb_3d_armor_character_5.b3d", {
}, },
animations = { animations = {
stand = {x=0, y=79}, stand = {x=0, y=79},
lay = {x=162, y=166, eye_height = 0.3, override_local = true, lay = {x=162, y=166},
collisionbox = {-0.6, 0.0, -0.6, 0.6, 0.3, 0.6}},
walk = {x=168, y=187}, walk = {x=168, y=187},
mine = {x=189, y=198}, mine = {x=189, y=198},
walk_mine = {x=200, y=219}, walk_mine = {x=200, y=219},
sit = {x=81, y=160, eye_height = 0.8, override_local = true, sit = {x=81, y=160},
collisionbox = {-0.3, 0.0, -0.3, 0.3, 1.0, 0.3}},
-- compatibility w/ the emote mod -- compatibility w/ the emote mod
wave = {x = 192, y = 196, override_local = true}, wave = {x = 192, y = 196, override_local = true},
point = {x = 196, y = 196, override_local = true}, point = {x = 196, y = 196, override_local = true},
freeze = {x = 205, y = 205, 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 -- Register default character.png if not part of this mod

View File

@ -1,3 +0,0 @@
Castaway female
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Castaway male
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Farmer female
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Farmer male
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Prince
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Princess
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Rogue female
sirrobzeroone
CC0/Public Domain

View File

@ -1,3 +0,0 @@
Rogue male
sirrobzeroone
CC0/Public Domain

View File

@ -1,5 +1,5 @@
name = skinsdb name = skinsdb
description = Player skin mod, supporting unified_inventory, sfinv and smart_inventory description = Player skin mod, supporting unified_inventory, sfinv and smart_inventory
depends = player_api 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 min_minetest_version = 5.4.0

View File

@ -49,25 +49,23 @@ function skin_class:set_texture(value)
self._texture = value self._texture = value
end end
--- Retrieves the character texture
function skin_class:get_texture() function skin_class:get_texture()
return self._texture return self._texture
end end
--- Assigns an existing hand item (/node) name to this skin
function skin_class:set_hand(hand) function skin_class:set_hand(hand)
self._hand = hand self._hand = hand
end 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 local ALPHA_CLIP = minetest.features.use_texture_alpha_string_modes and "clip" or true
function skin_class:set_hand_from_texture() function skin_class:set_hand_from_texture()
local hand = core.get_current_modname()..':'..self._texture:gsub('[%p%c%s]', '') local hand = core.get_current_modname()..':'..self._texture:gsub('[%p%c%s]', '')
local hand_def = {} 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.tiles = {self:get_texture()}
hand_def.visual_scale = 1 hand_def.visual_scale = 1
hand_def.wield_scale = {x=1,y=1,z=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" hand_def.mesh = "skinsdb_hand_18.b3d"
end end
hand_def.use_texture_alpha = ALPHA_CLIP hand_def.use_texture_alpha = ALPHA_CLIP
minetest.register_node(hand, hand_def)
core.register_node(hand, table.copy(hand_def))
self._hand_def = hand_def -- for wieldhand overrides
self:set_hand(hand) self:set_hand(hand)
end end
-- creative (and other mods?) may overwrite the wieldhand very late. function skin_class:get_hand()
-- Grab the most recent definition and use them as default for our skin hands. return self._hand
core.register_on_mods_loaded(function() end
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:set_preview(value) function skin_class:set_preview(value)
self._preview = value self._preview = value
@ -137,7 +109,7 @@ function skin_class:get_preview()
--Right Leg --Right Leg
skin = skin .. "([combine:16x32:0,0=" .. player_skin .. "^[mask:skindb_mask_rleg.png)^" 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_arm
local left_leg local left_leg
@ -154,10 +126,7 @@ function skin_class:get_preview()
--Left Leg --Left Leg
skin = skin .. left_leg skin = skin .. left_leg
if self:get_meta("format") == "1.8" then -- Add overlays for 64x skins. these wont appear if skin is 32x because it will be cropped out
-- Add overlays for 64x64 skins. This check is needed to avoid
-- client-side out-of-bounds "[combine" warnings.
--Chest Overlay --Chest Overlay
skin = skin .. "([combine:16x32:-16,-28=" .. player_skin .. "^[mask:skindb_mask_chest.png)^" skin = skin .. "([combine:16x32:-16,-28=" .. player_skin .. "^[mask:skindb_mask_chest.png)^"
--Right Arm Overlay --Right Arm Overlay
@ -168,7 +137,6 @@ function skin_class:get_preview()
skin = skin .. "([combine:16x32:-40,-44=" .. player_skin .. "^[mask:(skindb_mask_rarm.png^[transformFX))^" skin = skin .. "([combine:16x32:-40,-44=" .. player_skin .. "^[mask:(skindb_mask_rarm.png^[transformFX))^"
--Left Leg Overlay --Left Leg Overlay
skin = skin .. "([combine:16x32:4,-32=" .. player_skin .. "^[mask:(skindb_mask_rleg.png^[transformFX))" skin = skin .. "([combine:16x32:4,-32=" .. player_skin .. "^[mask:(skindb_mask_rleg.png^[transformFX))"
end
-- Full Preview -- Full Preview
skin = "(((" .. skin .. ")^[resize:64x128)^[mask:skindb_transform.png)" skin = "(((" .. skin .. ")^[resize:64x128)^[mask:skindb_transform.png)"

View File

@ -6,7 +6,7 @@ local dbgprint = false and print or function() end
function skins.register_skin(path, filename) function skins.register_skin(path, filename)
-- See "textures/readme.txt" for allowed formats -- 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" prefix: "character" or "player"
sep: "." (new) or "_" (legacy) sep: "." (new) or "_" (legacy)
@ -92,7 +92,6 @@ function skins.register_skin(path, filename)
skin_obj:set_meta("name", data[1]) skin_obj:set_meta("name", data[1])
skin_obj:set_meta("author", data[2]) skin_obj:set_meta("author", data[2])
skin_obj:set_meta("license", data[3]) skin_obj:set_meta("license", data[3])
file:close() -- do not rely on delayed GC
end end
end end
@ -103,7 +102,6 @@ function skins.register_skin(path, filename)
if fh then if fh then
dbgprint("Found preview", preview_name) dbgprint("Found preview", preview_name)
skin_obj:set_preview(preview_name) skin_obj:set_preview(preview_name)
fh:close() -- do not rely on delayed GC
end end
end end

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

View File

@ -6,7 +6,6 @@ List of accepted texture names
Public skin available for all users: Public skin available for all users:
character.[number or name].png character.[number or name].png
^ The allowed characters in "[number or name]" are "[A-z0-9_.-]+".
One or multiple private skins for player "[nick]": One or multiple private skins for player "[nick]":
player.[nick].png player.[nick].png

View File

@ -9,14 +9,12 @@ local function run_unittest()
-- ----- -- -----
-- `.`: Simple register + retrieve operations -- `.`: Simple register + retrieve operations
assert(skins.register_skin(PATH, "player.DotSep.png")) skins.register_skin(PATH, "player.DotSep.png")
assert(skins.register_skin(PATH, "player._DotSep_666_.1.png")) 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"))
assert(get_skin("player._DotSep_666_.1")) assert(get_skin("player._DotSep_666_.1"))
assert(get_skin("player.DotSep.1") == nil) assert(get_skin("player.DotSep.1") == nil)
assert(get_skin("character._DotSep_With-Dash-"))
-- ----- -- -----
-- Ambiguous skin names (filenames without extension). Register + retrieve -- Ambiguous skin names (filenames without extension). Register + retrieve
@ -44,6 +42,7 @@ local function run_unittest()
assert(get_skin("player_Com_Pat_42") == "player._Com_Pat_42") assert(get_skin("player_Com_Pat_42") == "player._Com_Pat_42")
assert(get_skin("player_Com_Pat_42_1") == "player._Com_Pat_42.1") assert(get_skin("player_Com_Pat_42_1") == "player._Com_Pat_42.1")
error("Unittest passed! Please disable them now.") error("Unittest passed! Please disable them now.")
end end