feat: multi spr file support

meta.lua

@@ -151,19 +151,19 @@ g_things = {}
 
 ---@param file string
 ---@return boolean
-function g_things.loadAppearances(file) end
+function g_things.loadAppearances(file, resourceId) end
 
 ---@param file string
 ---@return boolean
 function g_things.loadStaticData(file) end
 
 ---@param file string
 ---@return boolean
-function g_things.loadDat(file) end
+function g_things.loadDat(file, resourceId) end
 
 ---@param file string
 ---@return boolean
-function g_things.loadOtml(file) end
+function g_things.loadOtml(file, resourceId) end
 
 ---@return boolean
 function g_things.isDatLoaded() end
@@ -181,7 +181,7 @@ function g_things.getThingType(id, category) end
 
 ---@param category integer
 ---@return ThingType[]
-function g_things.getThingTypes(category) end
+function g_things.getThingTypes(category, resourceId) end
 
 ---@param attr integer
 ---@param category integer
@@ -308,47 +308,6 @@ function g_towns.getTowns() end
 
 function g_towns.sort() end
 
---------------------------------
----------- g_sprites -----------
---------------------------------
-
----@class g_sprites
-g_sprites = {}
-
----@param file string
----@return boolean
-function g_sprites.loadSpr(file) end
-
-function g_sprites.unload() end
-
----@return boolean
-function g_sprites.isLoaded() end
-
----@return number
-function g_sprites.getSprSignature() end
-
----@return integer
-function g_sprites.getSpritesCount() end
-
----* FRAMEWORK_EDITOR
----@param fileName string
-function g_sprites.saveSpr(fileName) end
-
---------------------------------
------- g_spriteAppearances -----
---------------------------------
-
----@class g_spriteAppearances
-g_spriteAppearances = {}
-
----@param id integer
----@param file string
-function g_spriteAppearances.saveSpriteToFile(id, file) end
-
----@param id integer
----@param file string
-function g_spriteAppearances.saveSheetToFileBySprite(id, file) end
-
 --------------------------------
 ------------ g_map -------------
 --------------------------------

modules/client_options/data_options.lua

@@ -397,7 +397,7 @@ return {
     asyncTxtLoading                   = {
         value = false,
         action = function(value, options, controller, panels, extraWidgets)
-            if g_game.isUsingProtobuf() then
+            if true then --g_game.isUsingProtobuf() then -- deprecated
                 value = true
             elseif g_app.isEncrypted() then
                 local asyncWidget = panels.graphicsPanel:recursiveGetChildById('asyncTxtLoading')

modules/game_actionbar/logics/ActionButtonLogic.lua

@@ -682,7 +682,7 @@ function updateButton(button)
 
     button.cache = getButtonCache(button)
     if button.item.getItemId and not button.cache.actionType then
-        button.item:setItemId(0, true)
+        button.item:setItemId(0)
         button.item:setOn(false)
     end
 
@@ -704,7 +704,7 @@ function updateButton(button)
     local passiveAbility = buttonData["actionsetting"]["passiveAbility"]
 
     if useAction then
-        button.item:setItemId(useAction, true)
+        button.item:setItemId(useAction, 0) -- to do: resourceId
         button.item:setOn(true)
         local cached = cachedItemWidget[useAction]
         if cached then

modules/game_things/things.lua

@@ -1,12 +1,7 @@
 ThingsLoaderController = Controller:new()
 
-local filename = nil
 local loaded = false
 
-function setFileName(name)
-    filename = name
-end
-
 function isLoaded()
     return loaded
 end
@@ -41,62 +36,243 @@ local function tryLoadDatWithFallbacks(datPath)
     return false
 end
 
-local function load(version)
-    local errorList = {}
+local function findFileByExtension(path, ext)
+	-- find Tibia.ext
+	local fileName = "Tibia" .. ext
+	local resolvedPath = resolvepath(path .. fileName)
+	if g_resources.fileExists(resolvedPath) then
+		return resolvedPath
+	end
 
-    if version >= 1281 and not g_game.getFeature(GameLoadSprInsteadProtobuf) then
-        local filePath = resolvepath(string.format('/things/%d/', version))
-        if not g_things.loadAppearances(filePath) then
-            errorList[#errorList + 1] = "Couldn't load assets"
-        end
-        if not g_things.loadStaticData(filePath) then
-            errorList[#errorList + 1] = "Couldn't load staticdata"
-        end
-    else
-        local datPath, sprPath
-        if filename then
-            datPath = resolvepath('/data/things/' .. filename)
-            sprPath = resolvepath('/data/things/' .. filename)
-        else
-            datPath = resolvepath('/data/things/' .. version .. '/Tibia')
-            sprPath = resolvepath('/data/things/' .. version .. '/Tibia')
+	-- find any filename.ext
+	resolvedPath = resolvepath(path)
+    local files = g_resources.listDirectoryFiles(resolvedPath)
+    for _, file in ipairs(files) do
+		-- match .otfi extension
+		if file:lower():sub(ext:len()) == ext then
+			resolvedPath = resolvepath(path .. "/" .. file)
+            return resolvedPath
         end
+    end
 
-        g_logger.setLevel(5)
-        if not tryLoadDatWithFallbacks(datPath) then
-            errorList[#errorList + 1] = tr('Unable to load dat file, please place a valid dat in \'%s.dat\'', datPath)
-        end
-        g_logger.setLevel(1)
+	-- no file found
+end
+
+-- helper to get boolean from parsed otfi
+local function toboolean(v)
+    if v == nil then
+        return false
+    end
+
+    if type(v) == "boolean" then
+        return v
+    end
 
-        if not g_sprites.loadSpr(sprPath) then
-            errorList[#errorList + 1] = tr('Unable to load spr file, please place a valid spr in \'%s.spr\'', sprPath)
+    if type(v) ~= "string" then
+        return false
+    end
+
+    v = string.lower(v)
+    return v == "true" or v == "1" or v == "yes" or v == "on" or v == "enabled"
+end
+
+local function setFeature(feature, value)
+	if value == nil then
+		-- use version default if not defined in otfi
+		return
+	elseif toboolean(value) then
+		-- evaluated to true
+		g_game.enableFeature(feature)
+	else
+		-- evaluated to false
+		g_game.disableFeature(feature)
+	end
+end
+
+local function addError(errorList, message, resourceId)
+	if resourceId > 0 then
+		errorList[#errorList + 1] = string.format("Resource %d: %s", resourceId, message)
+	else
+		errorList[#errorList + 1] = message
+	end
+end
+
+local function loadResource(path, version, resourceId, errorList)
+	-- file loading fallback order:
+	-- 1. catalog-content.json - if found: load assets
+	-- 2. Tibia.otfi - if found: load dat specified in it
+	-- 3. any otfi - if found: load dat specified in it
+	-- 4. Tibia.dat
+	-- 5. any dat
+
+	-- assets
+	if g_resources.fileExists(resolvepath(path .. 'catalog-content.json')) then
+		g_logger.info(string.format("Loading resource %d (assets) ...", resourceId))
+		if not g_things.loadAppearances(resolvepath(path), resourceId) then
+            addError(errorList, "Couldn't load assets", resourceId)
         end
-        if g_game.getFeature(GameLoadSprInsteadProtobuf) and version >= 1281 then
-            local staticPath = resolvepath(string.format('/things/%d/appearances', version))
-            if not g_things.loadAppearances(staticPath) then
-                g_logger.warning(string.format(
-                    "[game_things.load()] Couldn't load /things/%d/appearances.dat, possible packets error.", version))
-            end
+        if not g_things.loadStaticData(path) then
+            addError(errorList, "Couldn't load staticdata", resourceId)
         end
-    end
+
+		return
+	end
+
+	g_logger.info(string.format("Loading resource %d (spr/dat) from %s ...", resourceId, path))
+
+	-- otfi-defined spr/dat
+	local otfiPath = findFileByExtension(path, ".otfi")
+	if otfiPath then
+		-- read config from otfi
+		local otfiSettings = g_configs.create(otfiPath)
+		if not otfiSettings then
+			addError(errorList, "Failed to load OTFI", resourceId)
+			return
+		end
+
+		local datSpr = otfiSettings:getNode("DatSpr")
+		if not datSpr then
+			addError(errorList, "Invalid OTFI structure", resourceId)
+			return
+		end
+
+		-- nodes priority:
+		-- 1. otfi assets-name
+		-- 2. otfi "-file" nodes
+		-- 3. (if not defined by otfi) Tibia .spr/.dat
+		local sprName = "Tibia.spr"
+		local datName = "Tibia.dat"
+
+		local assetsName = datSpr["assets-name"]
+		if assetsName then
+			sprName = assetsName .. ".spr"
+			datName = assetsName .. ".dat"
+		else
+			sprName = datSpr["sprites-file"] or sprName
+			datName = datSpr["metadata-file"] or datName
+		end
+
+		-- set features according to otfi
+		setFeature(GameSpritesU32, datSpr["extended"])
+		setFeature(GameSpritesAlphaChannel, datSpr["transparency"])
+		setFeature(GameIdleAnimations, datSpr["frame-groups"])
+		setFeature(GameEnhancedAnimations,datSpr["frame-durations"])
+
+		-- check if otfi-specified dat file exists
+		local datPath = resolvepath(path .. datName)
+		if not g_resources.fileExists(datPath) then
+			addError(errorList, string.format("Unable to load %s: file not found", datName), resourceId)
+			return
+		end
+
+		-- try to load dat file
+		if not g_things.loadDat(datPath, resourceId) then
+			addError(errorList, string.format("Failed to read %s: file structure does not match the defined version or OTFI specification", datName), resourceId)
+			return
+		end
+
+		-- check if otfi-specified spr file exists
+		local sprPath = resolvepath(path .. sprName)
+		if not g_resources.fileExists(sprPath) then
+			addError(errorList, string.format("Unable to load %s: file not found", datName), resourceId)
+			return
+		end
+
+		-- try to load spr file
+		if not g_things.loadSpr(sprPath, resourceId) then
+			addError(errorList, string.format("Failed to read %s: file structure does not match the defined version or OTFI specification", datName), resourceId)
+			return
+		end
+	else
+		-- normal dat file
+		local datPath = findFileByExtension(path, ".dat")
+		if not datPath then
+			addError(errorList, "DAT file not found", resourceId)
+			return
+		end
+
+		-- try to load dat
+		local datResult = tryLoadDatWithFallbacks(datPath, resourceId)
+		if not datResult then
+			addError(errorList, "Failed to read dat file: file structure does not match the defined version", resourceId)
+		end
+
+		-- normal spr file
+		local sprPath = findFileByExtension(path, ".spr")
+		if not sprPath then
+			addError(errorList, "SPR file not found", resourceId)
+			return
+		end
+
+		-- try to load spr
+		local sprResult = g_things.loadSpr(sprPath, resourceId)
+		if not sprResult then
+			addError(errorList, "Failed to read dat file: file structure does not match the defined version", resourceId)
+		end
+	end
+end
+
+local function loadPackInfo(packPath, errorList)
+	g_logger.info("Found packinfo.xml")
+	local packInfo = g_things.decodePackInfo(resolvepath(packPath))
+	if #packInfo == 0 then
+		addError(errorList, "Failed to decode packinfo.xml", 0)
+		return
+	end
+
+	for _, resInfo in pairs(packInfo) do
+		loadResource(string.format("%s%s/", packPath, resInfo.dir), resInfo.version, resInfo.id, errorList)
+
+		if #errorList > 0 then
+			break
+		end
+	end
+
+	-- enable resource ids in packets
+	-- g_game.enableFeature(GameMultiSpr)
+end
+
+local function load(version)
+	-- prevent calling again after a failed attempt
+	if version == 0 then
+		return
+	end
+
+    local errorList = {}
+	local path = string.format('/data/things/%s/', version)
+
+	g_logger.info("Loading game assets from " .. path)
+
+	local packPath = resolvepath(path .. 'packinfo.xml')
+	if g_resources.fileExists(packPath) then
+		loadPackInfo(path, errorList)
+	else
+		loadResource(path, version, 0, errorList)
+	end
 
     loaded = #errorList == 0
     if loaded then
         -- loading client files was successful, try to load sounds now
         -- sound files are optional, this means that failing to load them
         -- will not block logging into game
-        g_sounds.loadClientFiles(resolvepath(string.format('/sounds/%d/', version)))
+		if version > 1300 then
+			g_sounds.loadClientFiles(resolvepath(string.format('/sounds/%d/', version)))
+		end
+
+		g_logger.info("Assets loading complete.")
         return
     end
 
-    local messageBox = displayErrorBox(tr('Error'), table.concat(errorList, "\n"))
+	local errors = table.concat(errorList, "\n")
+    local messageBox = displayErrorBox(tr('Error'), errors)
     addEvent(function()
         messageBox:raise()
         messageBox:focus()
     end)
 
     g_game.setClientVersion(0)
     g_game.setProtocolVersion(0)
+	g_logger.error(errors)
 end
 
 function ThingsLoaderController:onInit()