Add support for putting modpacks directly into mod directories

doc/lua_api.txt

@@ -59,6 +59,12 @@ This happens if the following directory exists:
 Mods should be then be placed in:
   $world/game/mods/
 
+Modpack support
+----------------
+Mods can be put in a subdirectory, if the parent directory, which otherwise
+should be a mod, contains a file named modpack.txt. This file shall be
+empty, except for lines starting with #, which are comments.
+
 Mod directory structure
 ------------------------
 mods

src/mods.cpp

@@ -26,31 +26,40 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "strfnd.h"
 #include "log.h"
 
-// Get a dependency-sorted list of ModSpecs
+static void collectMods(const std::string &modspath,
-core::list<ModSpec> getMods(core::list<std::string> &modspaths)
+		std::queue<ModSpec> &mods_satisfied,
-		throw(ModError)
+		core::list<ModSpec> &mods_unsorted,
+		std::map<std::string, std::string> &mod_names,
+		std::string indentation)
 {
-	std::queue<ModSpec> mods_satisfied;
+	TRACESTREAM(<<indentation<<"collectMods(\""<<modspath<<"\")"<<std::endl);
-	core::list<ModSpec> mods_unsorted;
+	TRACEDO(indentation += "  ");
-	core::list<ModSpec> mods_sorted;
-	// name, path: For detecting name conflicts
-	std::map<std::string, std::string> mod_names;
-	for(core::list<std::string>::Iterator i = modspaths.begin();
-			i != modspaths.end(); i++){
-		std::string modspath = *i;
 	std::vector<fs::DirListNode> dirlist = fs::GetDirListing(modspath);
 	for(u32 j=0; j<dirlist.size(); j++){
 		if(!dirlist[j].dir)
 			continue;
 		std::string modname = dirlist[j].name;
 		std::string modpath = modspath + DIR_DELIM + modname;
+		TRACESTREAM(<<indentation<<"collectMods: "<<modname<<" at \""<<modpath<<"\""<<std::endl);
+		// Handle modpacks (defined by containing modpack.txt)
+		{
+			std::ifstream is((modpath+DIR_DELIM+"modpack.txt").c_str(),
+					std::ios_base::binary);
+			if(is.good()){
+				// Is a modpack
+				is.close(); // We don't actually need the file
+				// Recurse into it
+				collectMods(modpath, mods_satisfied, mods_unsorted, mod_names, indentation);
+				continue;
+			}
+		}
 		// Detect mod name conflicts
 		{
 			std::map<std::string, std::string>::const_iterator i;
 			i = mod_names.find(modname);
 			if(i != mod_names.end()){
 				std::string s;
-					infostream<<"WARNING: Mod name conflict detected: "
+				infostream<<indentation<<"WARNING: Mod name conflict detected: "
 						<<std::endl
 						<<"Already loaded: "<<i->second<<std::endl
 						<<"Will not load: "<<modpath<<std::endl;
@@ -74,6 +83,21 @@ core::list<ModSpec> getMods(core::list<std::string> &modspaths)
 		mod_names[modname] = modpath;
 	}
 }
+
+// Get a dependency-sorted list of ModSpecs
+core::list<ModSpec> getMods(core::list<std::string> &modspaths)
+		throw(ModError)
+{
+	std::queue<ModSpec> mods_satisfied;
+	core::list<ModSpec> mods_unsorted;
+	core::list<ModSpec> mods_sorted;
+	// name, path: For detecting name conflicts
+	std::map<std::string, std::string> mod_names;
+	for(core::list<std::string>::Iterator i = modspaths.begin();
+			i != modspaths.end(); i++){
+		std::string modspath = *i;
+		collectMods(modspath, mods_satisfied, mods_unsorted, mod_names, "");
+	}
 	// Sort by depencencies
 	while(!mods_satisfied.empty()){
 		ModSpec mod = mods_satisfied.front();
@@ -107,9 +131,26 @@ core::list<ModSpec> getMods(core::list<std::string> &modspaths)
 		errs<<"."<<std::endl;
 		mods_sorted.push_back(mod);
 	}
+	// If an error occurred, throw an exception
 	if(errs.str().size() != 0){
 		throw ModError(errs.str());
 	}
+	// Print out some debug info
+	TRACESTREAM(<<"Detected mods in load order:"<<std::endl);
+	for(core::list<ModSpec>::Iterator i = mods_sorted.begin();
+			i != mods_sorted.end(); i++){
+		ModSpec &mod = *i;
+		TRACESTREAM(<<"name=\""<<mod.name<<"\" path=\""<<mod.path<<"\"");
+		TRACESTREAM(<<" depends=[");
+		for(std::set<std::string>::iterator i = mod.depends.begin();
+				i != mod.depends.end(); i++)
+			TRACESTREAM(<<" "<<(*i));
+		TRACESTREAM(<<" ] unsatisfied_depends=[");
+		for(std::set<std::string>::iterator i = mod.unsatisfied_depends.begin();
+				i != mod.unsatisfied_depends.end(); i++)
+			TRACESTREAM(<<" "<<(*i));
+		TRACESTREAM(<<" ]"<<std::endl);
+	}
 	return mods_sorted;
 }