1
0
mirror of https://github.com/vcmi/vcmi.git synced 2025-01-26 03:52:01 +02:00

First part of submods support.

- VCMI will load mods from Mods directory recursively. Submods must be
placed into additional Mods directory, e.g.
<data dir>/Mods/<mod name>/Mods/<submod name>

- submods will be loaded only if their parent mod was enabled
- submods namespace for objects will be "<parent mod ID>.<submod ID>"

- TODO: Launcher is not aware of submods yet (seems to be working but
may behave incorrectly)
This commit is contained in:
Ivan Savenko 2014-03-15 10:57:34 +00:00
parent 065b8366fb
commit 7f6f125b4c
6 changed files with 193 additions and 156 deletions

View File

@ -4,6 +4,7 @@
#include "../../lib/VCMIDirs.h"
#include "../../lib/filesystem/Filesystem.h"
#include "../../lib/filesystem/CZipLoader.h"
#include "../../lib/CModHandler.h"
#include "../jsonutils.h"
#include "../launcherdirs.h"
@ -59,7 +60,9 @@ void CModManager::loadRepository(QString file)
void CModManager::loadMods()
{
auto installedMods = CResourceHandler::getAvailableMods();
CModHandler handler;
handler.loadMods();
auto installedMods = handler.getAllMods();
for (auto modname : installedMods)
{

View File

@ -411,6 +411,89 @@ void CContentHandler::load(CModInfo & mod)
logGlobal->infoStream() << "\t\t[SKIP] " << mod.name;
}
static JsonNode loadModSettings(std::string path)
{
if (CResourceHandler::get("local")->existsResource(ResourceID(path)))
{
return JsonNode(ResourceID(path, EResType::TEXT));
}
// Probably new install. Create initial configuration
CResourceHandler::get("local")->createResource(path);
return JsonNode();
}
JsonNode addMeta(JsonNode config, std::string meta)
{
config.setMeta(meta);
return std::move(config);
}
CModInfo::CModInfo(std::string identifier,const JsonNode & local, const JsonNode & config):
identifier(identifier),
name(config["name"].String()),
description(config["description"].String()),
dependencies(config["depends"].convertTo<std::set<std::string> >()),
conflicts(config["conflicts"].convertTo<std::set<std::string> >()),
validation(PENDING),
config(addMeta(config, identifier))
{
loadLocalData(local);
}
JsonNode CModInfo::saveLocalData() const
{
std::ostringstream stream;
stream << std::noshowbase << std::hex << std::setw(8) << std::setfill('0') << checksum;
JsonNode conf;
conf["active"].Bool() = enabled;
conf["validated"].Bool() = validation != FAILED;
conf["checksum"].String() = stream.str();
return conf;
}
std::string CModInfo::getModDir(std::string name)
{
return "MODS/" + boost::algorithm::replace_all_copy(name, ".", "/MODS/");
}
std::string CModInfo::getModFile(std::string name)
{
return getModDir(name) + "/mod.json";
}
void CModInfo::updateChecksum(ui32 newChecksum)
{
// comment-out next line to force validation of all mods ignoring checksum
if (newChecksum != checksum)
{
checksum = newChecksum;
validation = PENDING;
}
}
void CModInfo::loadLocalData(const JsonNode & data)
{
bool validated = false;
enabled = true;
checksum = 0;
if (data.getType() == JsonNode::DATA_BOOL)
{
enabled = data.Bool();
}
if (data.getType() == JsonNode::DATA_STRUCT)
{
enabled = data["active"].Bool();
validated = data["validated"].Bool();
checksum = strtol(data["checksum"].String().c_str(), nullptr, 16);
}
if (enabled)
validation = validated ? PASSED : PENDING;
else
validation = validated ? PASSED : FAILED;
}
CModHandler::CModHandler()
{
for (int i = 0; i < GameConstants::RESOURCE_QUANTITY; ++i)
@ -450,8 +533,8 @@ bool CModHandler::hasCircularDependency(TModID modID, std::set <TModID> currentL
// Mod already present? We found a loop
if (vstd::contains(currentList, modID))
{
logGlobal->errorStream() << "Error: Circular dependency detected! Printing dependency list:";
logGlobal->errorStream() << "\t" << mod.name << " -> ";
logGlobal->errorStream() << "Error: Circular dependency detected! Printing dependency list:";
logGlobal->errorStream() << "\t" << mod.name << " -> ";
return true;
}
@ -462,7 +545,7 @@ bool CModHandler::hasCircularDependency(TModID modID, std::set <TModID> currentL
{
if (hasCircularDependency(dependency, currentList))
{
logGlobal->errorStream() << "\t" << mod.name << " ->\n"; // conflict detected, print dependency list
logGlobal->errorStream() << "\t" << mod.name << " ->\n"; // conflict detected, print dependency list
return true;
}
}
@ -479,7 +562,7 @@ bool CModHandler::checkDependencies(const std::vector <TModID> & input) const
{
if (!vstd::contains(input, dep))
{
logGlobal->errorStream() << "Error: Mod " << mod.name << " requires missing " << dep << "!";
logGlobal->errorStream() << "Error: Mod " << mod.name << " requires missing " << dep << "!";
return false;
}
}
@ -488,7 +571,7 @@ bool CModHandler::checkDependencies(const std::vector <TModID> & input) const
{
if (vstd::contains(input, conflicting))
{
logGlobal->errorStream() << "Error: Mod " << mod.name << " conflicts with " << allMods.at(conflicting).name << "!";
logGlobal->errorStream() << "Error: Mod " << mod.name << " conflicts with " << allMods.at(conflicting).name << "!";
return false;
}
}
@ -545,113 +628,90 @@ std::vector <TModID> CModHandler::resolveDependencies(std::vector <TModID> input
return output;
}
static JsonNode loadModSettings(std::string path)
std::vector<std::string> CModHandler::getModList(std::string path)
{
if (CResourceHandler::get("local")->existsResource(ResourceID(path)))
std::string modDir = boost::to_upper_copy(path + "MODS/");
size_t depth = boost::range::count(modDir, '/');
auto list = CResourceHandler::get("initial")->getFilteredFiles([&](const ResourceID & id) -> bool
{
return JsonNode(ResourceID(path, EResType::TEXT));
if (id.getType() != EResType::DIRECTORY)
return false;
if (!boost::algorithm::starts_with(id.getName(), modDir))
return false;
if (boost::range::count(id.getName(), '/') != depth )
return false;
return true;
});
//storage for found mods
std::vector<std::string> foundMods;
for (auto & entry : list)
{
std::string name = entry.getName();
name.erase(0, modDir.size()); //Remove path prefix
// check if wog is actually present. Hack-ish but better than crash
// TODO: remove soon (hopefully - before 0.96)
if (name == "WOG")
{
if (!CResourceHandler::get("initial")->existsResource(ResourceID("DATA/ZVS", EResType::DIRECTORY)) &&
!CResourceHandler::get("initial")->existsResource(ResourceID("MODS/WOG/DATA/ZVS", EResType::DIRECTORY)))
{
continue;
}
}
if (!name.empty())
foundMods.push_back(name);
}
// Probably new install. Create initial configuration
CResourceHandler::get("local")->createResource(path);
return JsonNode();
return foundMods;
}
JsonNode addMeta(JsonNode config, std::string meta)
void CModHandler::loadMods(std::string path, std::string parent, const JsonNode & modSettings)
{
config.setMeta(meta);
return std::move(config);
}
CModInfo::CModInfo(std::string identifier,const JsonNode & local, const JsonNode & config):
identifier(identifier),
name(config["name"].String()),
description(config["description"].String()),
dependencies(config["depends"].convertTo<std::set<std::string> >()),
conflicts(config["conflicts"].convertTo<std::set<std::string> >()),
validation(PENDING),
config(addMeta(config, identifier))
{
loadLocalData(local);
}
JsonNode CModInfo::saveLocalData()
{
std::ostringstream stream;
stream << std::noshowbase << std::hex << std::setw(8) << std::setfill('0') << checksum;
JsonNode conf;
conf["active"].Bool() = enabled;
conf["validated"].Bool() = validation != FAILED;
conf["checksum"].String() = stream.str();
return conf;
}
void CModInfo::updateChecksum(ui32 newChecksum)
{
// comment-out next line to force validation of all mods ignoring checksum
if (newChecksum != checksum)
for (std::string modName : getModList(path))
{
checksum = newChecksum;
validation = PENDING;
boost::to_lower(modName);
std::string modFullName = parent.empty() ? modName : parent + '.' + modName;
if (CResourceHandler::get("initial")->existsResource(ResourceID(CModInfo::getModFile(modFullName))))
{
CModInfo mod(modFullName, modSettings[modName], JsonNode(ResourceID(CModInfo::getModFile(modFullName))));
if (!parent.empty()) // this is submod, add parent to dependecies
mod.dependencies.insert(parent);
allMods[modFullName] = mod;
if (mod.enabled)
{
activeMods.push_back(modFullName);
loadMods(CModInfo::getModDir(modFullName) + '/', modFullName, modSettings[modName]["mods"]);
}
}
}
}
void CModInfo::loadLocalData(const JsonNode & data)
{
bool validated = false;
enabled = true;
checksum = 0;
if (data.getType() == JsonNode::DATA_BOOL)
{
enabled = data.Bool();
}
if (data.getType() == JsonNode::DATA_STRUCT)
{
enabled = data["active"].Bool();
validated = data["validated"].Bool();
checksum = strtol(data["checksum"].String().c_str(), nullptr, 16);
}
if (enabled)
validation = validated ? PASSED : PENDING;
else
validation = validated ? PASSED : FAILED;
}
void CModHandler::initializeMods(std::vector<std::string> availableMods)
void CModHandler::loadMods()
{
const JsonNode modConfig = loadModSettings("config/modSettings.json");
const JsonNode & modList = modConfig["activeMods"];
std::vector <TModID> detectedMods;
loadMods("", "", modConfig["activeMods"]);
for(std::string name : availableMods)
{
boost::to_lower(name);
std::string modFileName = "mods/" + name + "/mod.json";
if (CResourceHandler::get()->existsResource(ResourceID(modFileName)))
{
CModInfo mod(name, modList[name], JsonNode(ResourceID(modFileName)));
allMods[name] = mod;
if (mod.enabled)
detectedMods.push_back(name);
}
else
logGlobal->warnStream() << "\t\t Directory " << name << " does not contains VCMI mod";
}
coreMod = CModInfo("core", modConfig["core"], JsonNode(ResourceID("config/gameConfig.json")));
coreMod.name = "Original game files";
}
if (!checkDependencies(detectedMods))
{
logGlobal->errorStream() << "Critical error: failed to load mods! Exiting...";
exit(1);
}
std::vector<std::string> CModHandler::getAllMods()
{
std::vector<std::string> modlist;
for (auto & entry : allMods)
modlist.push_back(entry.first);
return modlist;
}
activeMods = resolveDependencies(detectedMods);
loadModFilesystems();
std::vector<std::string> CModHandler::getActiveMods()
{
return activeMods;
}
static JsonNode genDefaultFS()
@ -671,9 +731,9 @@ static ISimpleResourceLoader * genModFilesystem(const std::string & modName, con
static const JsonNode defaultFS = genDefaultFS();
if (!conf["filesystem"].isNull())
return CResourceHandler::createFileSystem("mods/" + modName, conf["filesystem"]);
return CResourceHandler::createFileSystem(CModInfo::getModDir(modName), conf["filesystem"]);
else
return CResourceHandler::createFileSystem("mods/" + modName, defaultFS);
return CResourceHandler::createFileSystem(CModInfo::getModDir(modName), defaultFS);
}
static ui32 calculateModChecksum(const std::string modName, ISimpleResourceLoader * filesystem)
@ -686,7 +746,7 @@ static ui32 calculateModChecksum(const std::string modName, ISimpleResourceLoade
// FIXME: remove workaround for core mod
if (modName != "core")
{
ResourceID modConfFile("mods/" + modName + "/mod", EResType::TEXT);
ResourceID modConfFile(CModInfo::getModFile(modName), EResType::TEXT);
ui32 configChecksum = CResourceHandler::get("initial")->load(modConfFile)->calculateCRC32();
modChecksum.process_bytes(reinterpret_cast<const void *>(&configChecksum), sizeof(configChecksum));
}
@ -698,10 +758,6 @@ static ui32 calculateModChecksum(const std::string modName, ISimpleResourceLoade
boost::starts_with(resID.getName(), "CONFIG"));
});
// these two files may change between two runs of vcmi and must be handled separately
files.erase(ResourceID("CONFIG/SETTINGS", EResType::TEXT));
files.erase(ResourceID("CONFIG/MODSETTINGS", EResType::TEXT));
for (const ResourceID & file : files)
{
ui32 fileChecksum = filesystem->load(file)->calculateCRC32();
@ -712,6 +768,8 @@ static ui32 calculateModChecksum(const std::string modName, ISimpleResourceLoade
void CModHandler::loadModFilesystems()
{
activeMods = resolveDependencies(activeMods);
coreMod.updateChecksum(calculateModChecksum("core", CResourceHandler::get("core")));
for(std::string & modName : activeMods)
@ -774,7 +832,11 @@ void CModHandler::afterLoad()
{
JsonNode modSettings;
for (auto & modEntry : allMods)
modSettings["activeMods"][modEntry.first] = modEntry.second.saveLocalData();
{
std::string pointer = "/" + boost::algorithm::replace_all_copy(modEntry.first, ".", "/mods/");
modSettings["activeMods"].resolvePointer(pointer) = modEntry.second.saveLocalData();
}
modSettings["core"] = coreMod.saveLocalData();
std::ofstream file(*CResourceHandler::get()->getResourceName(ResourceID("config/modSettings.json")), std::ofstream::trunc);

View File

@ -177,9 +177,12 @@ public:
CModInfo(){}
CModInfo(std::string identifier, const JsonNode & local, const JsonNode & config);
JsonNode saveLocalData();
JsonNode saveLocalData() const;
void updateChecksum(ui32 newChecksum);
static std::string getModDir(std::string name);
static std::string getModFile(std::string name);
template <typename Handler> void serialize(Handler &h, const int version)
{
h & identifier & description & name;
@ -197,7 +200,6 @@ class DLL_LINKAGE CModHandler
CModInfo coreMod;
void loadConfigFromFile(std::string name);
void loadModFilesystems();
bool hasCircularDependency(TModID mod, std::set <TModID> currentList = std::set <TModID>()) const;
@ -210,16 +212,24 @@ class DLL_LINKAGE CModHandler
// returns load order in which all dependencies are resolved, e.g. loaded after required mods
// function assumes that input list is valid (checkDependencies returned true)
std::vector <TModID> resolveDependencies(std::vector<TModID> input) const;
std::vector<std::string> getModList(std::string path);
void loadMods(std::string path, std::string namePrefix, const JsonNode & modSettings);
public:
CIdentifierStorage identifiers;
/// receives list of available mods and trying to load mod.json from all of them
void initializeMods(std::vector<std::string> availableMods);
void initializeConfig();
void loadMods();
void loadModFilesystems();
CModInfo & getModData(TModID modId);
/// returns list of all (active) mods
std::vector<std::string> getAllMods();
std::vector<std::string> getActiveMods();
/// load content from all available mods
void load();
void afterLoad();

View File

@ -7,7 +7,7 @@
* Full text of license available in license.txt file, in main folder
*
*/
#include "StdInc.h"
#include "VCMI_Lib.h"
@ -63,18 +63,19 @@ void LibClasses::loadFilesystem()
CStopWatch loadTime;
CResourceHandler::initialize();
logGlobal->infoStream()<<"\t Initialization: "<<loadTime.getDiff();
logGlobal->infoStream()<<"\t Initialization: "<<loadTime.getDiff();
CResourceHandler::load("config/filesystem.json");
logGlobal->infoStream()<<"\t Data loading: "<<loadTime.getDiff();
logGlobal->infoStream()<<"\t Data loading: "<<loadTime.getDiff();
modh = new CModHandler;
logGlobal->infoStream()<<"\tMod handler: "<<loadTime.getDiff();
logGlobal->infoStream()<<"\tMod handler: "<<loadTime.getDiff();
modh->initializeMods(CResourceHandler::getAvailableMods());
logGlobal->infoStream()<<"\t Mod filesystems: "<<loadTime.getDiff();
modh->loadMods();
modh->loadModFilesystems();
logGlobal->infoStream()<<"\t Mod filesystems: "<<loadTime.getDiff();
logGlobal->infoStream()<<"Basic initialization: "<<totalTime.getDiff();
logGlobal->infoStream()<<"Basic initialization: "<<totalTime.getDiff();
}
static void logHandlerLoaded(const std::string& name, CStopWatch &timer)
@ -86,7 +87,7 @@ template <class Handler> void createHandler(Handler *&handler, const std::string
{
handler = new Handler();
logHandlerLoaded(name, timer);
}
}
void LibClasses::init()
{
@ -95,7 +96,7 @@ void LibClasses::init()
modh->initializeConfig();
createHandler(bth, "Bonus type", pomtime);
createHandler(generaltexth, "General text", pomtime);
createHandler(heroh, "Hero", pomtime);
@ -105,9 +106,9 @@ void LibClasses::init()
createHandler(creh, "Creature", pomtime);
createHandler(townh, "Town", pomtime);
createHandler(objh, "Object", pomtime);
createHandler(dobjinfo, "Def information", pomtime);
createHandler(spellh, "Spell", pomtime);

View File

@ -214,37 +214,3 @@ ISimpleResourceLoader * CResourceHandler::createFileSystem(const std::string & p
generator.loadConfig(fsConfig);
return generator.getFilesystem();
}
std::vector<std::string> CResourceHandler::getAvailableMods()
{
static const std::string modDir = "MODS/";
auto list = get("initial")->getFilteredFiles([](const ResourceID & id) -> bool
{
return id.getType() == EResType::DIRECTORY
&& boost::range::count(id.getName(), '/') == 1
&& boost::algorithm::starts_with(id.getName(), modDir);
});
//storage for found mods
std::vector<std::string> foundMods;
for (auto & entry : list)
{
std::string name = entry.getName();
name.erase(0, modDir.size()); //Remove path prefix
if (name == "WOG") // check if wog is actually present. Hack-ish but better than crash
{
if (!get("initial")->existsResource(ResourceID("DATA/ZVS", EResType::DIRECTORY)) &&
!get("initial")->existsResource(ResourceID("MODS/WOG/DATA/ZVS", EResType::DIRECTORY)))
{
continue;
}
}
if (!name.empty())
foundMods.push_back(name);
}
return foundMods;
}

View File

@ -104,11 +104,6 @@ public:
*/
static ISimpleResourceLoader * createFileSystem(const std::string &prefix, const JsonNode & fsConfig);
/**
* Checks all subfolders of MODS directory for presence of mods
* If this directory has mod.json file it will be added to resources
*/
static std::vector<std::string> getAvailableMods();
private:
/** Instance of resource loader */
static std::map<std::string, ISimpleResourceLoader*> knownLoaders;