fix: Not parsing mods.txt from all available mods paths

Toggleable by 'ParseModsFromAdditionalPaths' in the Overrides section in UE4SS-settings.ini
Defaults to being enabled.

Author: UE4SS

UE4SS/include/SettingsManager.hpp

@@ -16,7 +16,7 @@ namespace RC
         struct SectionOverrides
         {
             File::StringType ModsFolderPath{};
-            std::vector<File::StringType> ModsFolderPaths{};
+            bool ParseModsFromAdditionalPaths{true};
         } Overrides;
 
         struct SectionGeneral

UE4SS/src/SettingsManager.cpp

@@ -68,6 +68,8 @@ namespace RC
             }
         });
 
+        REGISTER_BOOL_SETTING(Overrides.ParseModsFromAdditionalPaths, section_overrides, ParseModsFromAdditionalPaths)
+
         constexpr static File::CharType section_general[] = STR("General");
         REGISTER_BOOL_SETTING(General.EnableHotReloadSystem, section_general, EnableHotReloadSystem)
         StringType hot_reload_key{};

UE4SS/src/UE4SSProgram.cpp

@@ -1304,119 +1304,132 @@ namespace RC
     auto start_mods() -> std::string
     {
         ProfilerScope();
-        // Part #1: Start all mods that are enabled in mods.txt.
-        Output::send(STR("Starting mods (from mods.txt load order)...\n"));
 
-        std::filesystem::path mods_directory = UE4SSProgram::get_program().get_mods_directory();
-        std::wstring enabled_mods_file{mods_directory / "mods.txt"};
-        if (!std::filesystem::exists(enabled_mods_file))
+        const auto& main_mods_directory = UE4SSProgram::get_program().get_mods_directory();
+        for (const auto& mods_directory : std::ranges::reverse_view(UE4SSProgram::get_program().get_mods_directories()))
         {
-            Output::send(STR("No mods.txt file found...\n"));
-        }
-        else
-        {
-            // 'mods.txt' exists, lets parse it
+            if (!std::filesystem::exists(mods_directory))
+            {
+                continue;
+            }
+
+            // Only parse mods.txt from allowed directories.
+            if (UE4SSProgram::settings_manager.Overrides.ParseModsFromAdditionalPaths || mods_directory == main_mods_directory)
+            {
+                // Part #1: Start all mods that are enabled in mods.txt.
+                std::wstring enabled_mods_file{mods_directory / "mods.txt"};
+                if (!std::filesystem::exists(enabled_mods_file))
+                {
+                    Output::send(STR("No mods.txt file found...\n"));
+                }
+                else
+                {
+                    // 'mods.txt' exists, lets parse it
+                    Output::send(STR("Starting mods (from mods.txt ({}) load order)...\n"), ensure_str(enabled_mods_file));
+
+                    // First, check for BOM using a byte stream
+                    std::ifstream bom_check(enabled_mods_file, std::ios::binary);
+                    char bom[3] = {0};
+                    bom_check.read(bom, 3);
+                    bool has_bom = (bom[0] == '\xEF' && bom[1] == '\xBB' && bom[2] == '\xBF');
+                    bom_check.close();
+
+                    // Now open the actual stream
+                    StreamIType mods_stream{enabled_mods_file};
+
+                    // If BOM was detected, skip the first "character" (which will be the BOM interpreted as a wide char)
+                    if (has_bom)
+                    {
+                        wchar_t discard;
+                        mods_stream.get(discard);
+                    }
+
+                    StringType current_line;
+                    while (std::getline(mods_stream, current_line))
+                    {
+                        // Don't parse any lines with ';'
+                        if (current_line.find(STR(";")) != current_line.npos)
+                        {
+                            continue;
+                        }
+
+                        // Don't parse if the line is impossibly short (empty lines for example)
+                        if (current_line.size() <= 4)
+                        {
+                            continue;
+                        }
 
-            // First, check for BOM using a byte stream
-            std::ifstream bom_check(enabled_mods_file, std::ios::binary);
-            char bom[3] = {0};
-            bom_check.read(bom, 3);
-            bool has_bom = (bom[0] == '\xEF' && bom[1] == '\xBB' && bom[2] == '\xBF');
-            bom_check.close();
+                        // Remove all spaces
+                        auto end = std::remove(current_line.begin(), current_line.end(), STR(' '));
+                        current_line.erase(end, current_line.end());
 
-            // Now open the actual stream
-            StreamIType mods_stream{enabled_mods_file};
+                        // Parse the line into something that can be converted into proper data
+                        StringType mod_name = explode_by_occurrence(current_line, STR(':'), 1);
+                        StringType mod_enabled = explode_by_occurrence(current_line, STR(':'), ExplodeType::FromEnd);
 
-            // If BOM was detected, skip the first "character" (which will be the BOM interpreted as a wide char)
-            if (has_bom) {
-                wchar_t discard;
-                mods_stream.get(discard);
+                        auto mod = UE4SSProgram::find_mod_by_name<ModType>(mod_name, UE4SSProgram::IsInstalled::Yes);
+                        if (!mod || !dynamic_cast<ModType*>(mod) || mod->is_started())
+                        {
+                            continue;
+                        }
+
+                        if (!mod_enabled.empty() && mod_enabled[0] == STR('1'))
+                        {
+                            Output::send(STR("Starting {} mod '{}'\n"), std::is_same_v<ModType, LuaMod> ? STR("Lua") : STR("C++"), mod->get_name().data());
+                            mod->start_mod();
+                        }
+                        else
+                        {
+                            Output::send(STR("Mod '{}' disabled in mods.txt.\n"), mod_name);
+                        }
+                    }
+                }
             }
 
-            StringType current_line;
-            while (std::getline(mods_stream, current_line))
+            // Part #2: Start all mods that have enabled.txt present in the mod directory.
+            Output::send(STR("Starting mods (from enabled.txt ({}), no defined load order)...\n"), ensure_str(mods_directory));
+
+            for (const auto& mod_directory : std::filesystem::directory_iterator(mods_directory))
             {
-                // Don't parse any lines with ';'
-                if (current_line.find(STR(";")) != current_line.npos)
+                std::error_code ec{};
+
+                if (!mod_directory.is_directory(ec))
                 {
                     continue;
                 }
-
-                // Don't parse if the line is impossibly short (empty lines for example)
-                if (current_line.size() <= 4)
+                if (ec.value() != 0)
                 {
-                    continue;
+                    return fmt::format("is_directory ran into error {}", ec.value());
                 }
 
-                // Remove all spaces
-                auto end = std::remove(current_line.begin(), current_line.end(), STR(' '));
-                current_line.erase(end, current_line.end());
-
-                // Parse the line into something that can be converted into proper data
-                StringType mod_name = explode_by_occurrence(current_line, STR(':'), 1);
-                StringType mod_enabled = explode_by_occurrence(current_line, STR(':'), ExplodeType::FromEnd);
-
-                auto mod = UE4SSProgram::find_mod_by_name<ModType>(mod_name, UE4SSProgram::IsInstalled::Yes);
-                if (!mod || !dynamic_cast<ModType*>(mod))
+                if (!std::filesystem::exists(mod_directory.path() / "enabled.txt", ec))
                 {
                     continue;
                 }
+                if (ec.value() != 0)
+                {
+                    return fmt::format("exists ran into error {}", ec.value());
+                }
 
-                if (!mod_enabled.empty() && mod_enabled[0] == STR('1'))
+                auto mod = UE4SSProgram::find_mod_by_name<ModType>(ensure_str(mod_directory.path().stem()), UE4SSProgram::IsInstalled::Yes);
+                if (!dynamic_cast<ModType*>(mod))
                 {
-                    Output::send(STR("Starting {} mod '{}'\n"), std::is_same_v<ModType, LuaMod> ? STR("Lua") : STR("C++"), mod->get_name().data());
-                    mod->start_mod();
+                    continue;
                 }
-                else
+                if (!mod)
                 {
-                    Output::send(STR("Mod '{}' disabled in mods.txt.\n"), mod_name);
+                    Output::send<LogLevel::Warning>(STR("Found a mod with enabled.txt but mod has not been installed properly.\n"));
+                    continue;
                 }
-            }
-        }
-
-        // Part #2: Start all mods that have enabled.txt present in the mod directory.
-        Output::send(STR("Starting mods (from enabled.txt, no defined load order)...\n"));
-
-        for (const auto& mod_directory : std::filesystem::directory_iterator(mods_directory))
-        {
-            std::error_code ec{};
-
-            if (!mod_directory.is_directory(ec))
-            {
-                continue;
-            }
-            if (ec.value() != 0)
-            {
-                return fmt::format("is_directory ran into error {}", ec.value());
-            }
-
-            if (!std::filesystem::exists(mod_directory.path() / "enabled.txt", ec))
-            {
-                continue;
-            }
-            if (ec.value() != 0)
-            {
-                return fmt::format("exists ran into error {}", ec.value());
-            }
 
-            auto mod = UE4SSProgram::find_mod_by_name<ModType>(ensure_str(mod_directory.path().stem()), UE4SSProgram::IsInstalled::Yes);
-            if (!dynamic_cast<ModType*>(mod))
-            {
-                continue;
-            }
-            if (!mod)
-            {
-                Output::send<LogLevel::Warning>(STR("Found a mod with enabled.txt but mod has not been installed properly.\n"));
-                continue;
-            }
+                if (mod->is_started())
+                {
+                    continue;
+                }
 
-            if (mod->is_started())
-            {
-                continue;
+                Output::send(STR("Mod '{}' has enabled.txt, starting mod.\n"), mod->get_name().data());
+                mod->start_mod();
             }
-
-            Output::send(STR("Mod '{}' has enabled.txt, starting mod.\n"), mod->get_name().data());
-            mod->start_mod();
         }
 
         return {};

assets/Changelog.md

@@ -444,6 +444,10 @@ Fixed `LoadMod` function issue that variables would go out-of-scope in the `Exec
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: none
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; The key that will trigger a reload of all mods.
 ; The CTRL key is always required.

assets/CustomGameConfigs/Atomic Heart/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1

assets/CustomGameConfigs/Borderlands 3/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1

assets/CustomGameConfigs/Deadly Days Roadtrip/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1

assets/CustomGameConfigs/Final Fantasy 7 Rebirth/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1

assets/CustomGameConfigs/Final Fantasy 7 Remake/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1

assets/CustomGameConfigs/Kingdom Hearts 3/UE4SS-settings.ini

@@ -13,6 +13,10 @@ ModsFolderPath =
 ;   -ModsFolderPaths = ../SharedMods
 ; Default: None
 
+; Whether to parse 'mods.txt' from the additional paths set by 'ModsFolderPath', and 'ModsFolderPaths' options.
+; Default: 1
+ParseModsFromAdditionalPaths =
+
 [General]
 ; Whether to reload all mods when the key defined by HotReloadKey is hit.
 ; Default: 1