Load localization files from subfolders, resolves #1194

Author: Aurelius7309

lsp_def/utils.lua

@@ -340,8 +340,15 @@ function SMODS.SAVE_UNLOCKS() end
 function SMODS.process_loc_text(ref_table, ref_value, loc_txt, key) end
 
 ---@param path string
+--- This method is deprecated. Use SMODS.load_mod_localization instead.
 --- Handles injecting localization files.
-function SMODS.handle_loc_file(path) end
+function SMODS.handle_loc_file(path, mod_id) end
+
+---@param path string The top level path of the mod that localization should be loaded from.
+---@param mod_id string The ID of the mod localization strings are being loaded for.
+---@param depth number Recursive calling depth. This function is called recursively to load localization files located in subfolders of a mod's localization folder up to four folders deep.
+--- Handles injecting a mod's localization files.
+function SMODS.load_mod_localization(path, mod_id, depth) end
 
 ---@param pool table[]
 ---@param center metatable

src/game_object.lua

@@ -400,7 +400,7 @@ Set `prefix_config.key = false` on your object instead.]]):format(obj.key), obj.
         set = '[INTERNAL]',
         register = function() error('INTERNAL CLASS, DO NOT CALL') end,
         pre_inject_class = function()
-            SMODS.handle_loc_file(SMODS.path, '_')
+            SMODS.load_mod_localization(SMODS.path, '_')
             if SMODS.dump_loc then SMODS.dump_loc.pre_inject = copy_table(G.localization) end
             for _, mod in ipairs(SMODS.mod_list) do
                 if mod.process_loc_text and type(mod.process_loc_text) == 'function' then
@@ -3910,7 +3910,7 @@ Set `prefix_config.key = false` on your object instead.]]):format(obj.key), obj.
         pre_inject_class = function()
             for _, mod in ipairs(SMODS.mod_list) do
                 if mod.can_load and not mod.lovely_only then
-                    SMODS.handle_loc_file(mod.path, mod.id)
+                    SMODS.load_mod_localization(mod.path, mod.id)
                 end
             end
         end

src/utils.lua

@@ -219,13 +219,24 @@ local function handle_loc_file(dir, language, force, mod_id)
     end
 end
 
-function SMODS.handle_loc_file(path, mod_id)
-    local dir = path .. 'localization/'
+function SMODS.load_mod_localization(path, mod_id, depth)
+    local dir = path .. (depth and '' or 'localization/')
+    depth = (depth or 0) + 1
     handle_loc_file(dir, 'en-us', true, mod_id)
     handle_loc_file(dir, 'default', true, mod_id)
     handle_loc_file(dir, G.SETTINGS.language, true, mod_id)
     if G.SETTINGS.real_language then handle_loc_file(dir, G.SETTINGS.real_language, true, mod_id) end
+    if depth >= 4 then return end
+    for _,v in ipairs(SMODS.NFS.getDirectoryItems(path)) do
+        local new_path = dir .. v
+        local file_type = SMODS.NFS.getInfo(new_path).type
+        if file_type == 'directory' or file_type == 'symlink' then
+            SMODS.load_mod_localization(new_path..'/', mod_id, depth)
+        end
+    end
 end
+-- deprecated, old identifier kept for compatibility
+SMODS.handle_loc_file = SMODS.load_mod_localization
 
 function SMODS.insert_pool(pool, center, replace)
     assert(pool, ("Attempted to insert object \"%s\" into an empty pool."):format(center.key or "UNKNOWN"))

version.lua

@@ -1 +1 @@
-return "1.0.0~BETA-1416a-STEAMODDED"
+return "1.0.0~BETA-1419a-STEAMODDED"