CampaignHandler.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693
  1. /*
  2. * CCampaignHandler.cpp, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #include "StdInc.h"
  11. #include "CampaignHandler.h"
  12. #include "CampaignState.h"
  13. #include "../filesystem/Filesystem.h"
  14. #include "../filesystem/CCompressedStream.h"
  15. #include "../filesystem/CMemoryStream.h"
  16. #include "../filesystem/CBinaryReader.h"
  17. #include "../filesystem/CZipLoader.h"
  18. #include "../VCMI_Lib.h"
  19. #include "../constants/StringConstants.h"
  20. #include "../mapping/CMapHeader.h"
  21. #include "../mapping/CMapService.h"
  22. #include "../modding/CModHandler.h"
  23. #include "../modding/IdentifierStorage.h"
  24. #include "../modding/ModScope.h"
  25. #include "../texts/CGeneralTextHandler.h"
  26. #include "../texts/Languages.h"
  27. #include "../texts/TextOperations.h"
  28. VCMI_LIB_NAMESPACE_BEGIN
  29. void CampaignHandler::readCampaign(Campaign * ret, const std::vector<ui8> & input, std::string filename, std::string modName, std::string encoding)
  30. {
  31. if (input.front() < uint8_t(' ')) // binary format
  32. {
  33. CMemoryStream stream(input.data(), input.size());
  34. CBinaryReader reader(&stream);
  35. readHeaderFromMemory(*ret, reader, filename, modName, encoding);
  36. ret->overrideCampaign();
  37. for(int g = 0; g < ret->numberOfScenarios; ++g)
  38. {
  39. auto scenarioID = static_cast<CampaignScenarioID>(ret->scenarios.size());
  40. ret->scenarios[scenarioID] = readScenarioFromMemory(reader, *ret);
  41. }
  42. ret->overrideCampaignScenarios();
  43. }
  44. else // text format (json)
  45. {
  46. JsonNode jsonCampaign(reinterpret_cast<const std::byte*>(input.data()), input.size(), filename);
  47. readHeaderFromJson(*ret, jsonCampaign, filename, modName, encoding);
  48. for(auto & scenario : jsonCampaign["scenarios"].Vector())
  49. {
  50. auto scenarioID = static_cast<CampaignScenarioID>(ret->scenarios.size());
  51. ret->scenarios[scenarioID] = readScenarioFromJson(scenario);
  52. }
  53. }
  54. }
  55. std::unique_ptr<Campaign> CampaignHandler::getHeader( const std::string & name)
  56. {
  57. ResourcePath resourceID(name, EResType::CAMPAIGN);
  58. std::string modName = VLC->modh->findResourceOrigin(resourceID);
  59. std::string language = VLC->modh->getModLanguage(modName);
  60. std::string encoding = Languages::getLanguageOptions(language).encoding;
  61. auto ret = std::make_unique<Campaign>();
  62. auto fileStream = CResourceHandler::get(modName)->load(resourceID);
  63. std::vector<ui8> cmpgn = getFile(std::move(fileStream), name, true)[0];
  64. readCampaign(ret.get(), cmpgn, resourceID.getName(), modName, encoding);
  65. return ret;
  66. }
  67. std::shared_ptr<CampaignState> CampaignHandler::getCampaign( const std::string & name )
  68. {
  69. ResourcePath resourceID(name, EResType::CAMPAIGN);
  70. std::string modName = VLC->modh->findResourceOrigin(resourceID);
  71. std::string language = VLC->modh->getModLanguage(modName);
  72. std::string encoding = Languages::getLanguageOptions(language).encoding;
  73. auto ret = std::make_unique<CampaignState>();
  74. auto fileStream = CResourceHandler::get(modName)->load(resourceID);
  75. std::vector<std::vector<ui8>> files = getFile(std::move(fileStream), name, false);
  76. readCampaign(ret.get(), files[0], resourceID.getName(), modName, encoding);
  77. //first entry is campaign header. start loop from 1
  78. for(int scenarioIndex = 0, fileIndex = 1; fileIndex < files.size() && scenarioIndex < ret->numberOfScenarios; scenarioIndex++)
  79. {
  80. auto scenarioID = static_cast<CampaignScenarioID>(scenarioIndex);
  81. if(!ret->scenarios[scenarioID].isNotVoid()) //skip void scenarios
  82. continue;
  83. std::string scenarioName = resourceID.getName();
  84. boost::to_lower(scenarioName);
  85. scenarioName += ':' + std::to_string(fileIndex - 1);
  86. //set map piece appropriately, convert vector to string
  87. ret->mapPieces[scenarioID] = files[fileIndex];
  88. auto hdr = ret->getMapHeader(scenarioID);
  89. ret->scenarios[scenarioID].scenarioName = hdr->name;
  90. fileIndex++;
  91. }
  92. return ret;
  93. }
  94. static std::string convertMapName(std::string input)
  95. {
  96. boost::algorithm::to_lower(input);
  97. boost::algorithm::trim(input);
  98. size_t slashPos = input.find_last_of("/");
  99. if (slashPos != std::string::npos)
  100. return input.substr(slashPos + 1);
  101. return input;
  102. }
  103. std::string CampaignHandler::readLocalizedString(CampaignHeader & target, CBinaryReader & reader, std::string filename, std::string modName, std::string encoding, std::string identifier)
  104. {
  105. std::string input = TextOperations::toUnicode(reader.readBaseString(), encoding);
  106. return readLocalizedString(target, input, filename, modName, identifier);
  107. }
  108. std::string CampaignHandler::readLocalizedString(CampaignHeader & target, std::string text, std::string filename, std::string modName, std::string identifier)
  109. {
  110. TextIdentifier stringID( "campaign", convertMapName(filename), identifier);
  111. if (text.empty())
  112. return "";
  113. target.getTexts().registerString(modName, stringID, text);
  114. return stringID.get();
  115. }
  116. void CampaignHandler::readHeaderFromJson(CampaignHeader & ret, JsonNode & reader, std::string filename, std::string modName, std::string encoding)
  117. {
  118. ret.version = static_cast<CampaignVersion>(reader["version"].Integer());
  119. if(ret.version < CampaignVersion::VCMI_MIN || ret.version > CampaignVersion::VCMI_MAX)
  120. {
  121. logGlobal->info("VCMP Loading: Unsupported campaign %s version %d", filename, static_cast<int>(ret.version));
  122. return;
  123. }
  124. ret.version = CampaignVersion::VCMI;
  125. ret.campaignRegions = CampaignRegions::fromJson(reader["regions"]);
  126. ret.numberOfScenarios = reader["scenarios"].Vector().size();
  127. ret.name.appendTextID(readLocalizedString(ret, reader["name"].String(), filename, modName, "name"));
  128. ret.description.appendTextID(readLocalizedString(ret, reader["description"].String(), filename, modName, "description"));
  129. ret.author.appendRawString(reader["author"].String());
  130. ret.authorContact.appendRawString(reader["authorContact"].String());
  131. ret.campaignVersion.appendRawString(reader["campaignVersion"].String());
  132. ret.creationDateTime = reader["creationDateTime"].Integer();
  133. ret.difficultyChosenByPlayer = reader["allowDifficultySelection"].Bool();
  134. ret.music = AudioPath::fromJson(reader["music"]);
  135. ret.filename = filename;
  136. ret.modName = modName;
  137. ret.encoding = encoding;
  138. ret.loadingBackground = ImagePath::fromJson(reader["loadingBackground"]);
  139. ret.videoRim = ImagePath::fromJson(reader["videoRim"]);
  140. ret.introVideo = VideoPath::fromJson(reader["introVideo"]);
  141. ret.outroVideo = VideoPath::fromJson(reader["outroVideo"]);
  142. }
  143. CampaignScenario CampaignHandler::readScenarioFromJson(JsonNode & reader)
  144. {
  145. auto prologEpilogReader = [](JsonNode & identifier) -> CampaignScenarioPrologEpilog
  146. {
  147. CampaignScenarioPrologEpilog ret;
  148. ret.hasPrologEpilog = !identifier.isNull();
  149. if(ret.hasPrologEpilog)
  150. {
  151. ret.prologVideo = VideoPath::fromJson(identifier["video"]);
  152. ret.prologMusic = AudioPath::fromJson(identifier["music"]);
  153. ret.prologVoice = AudioPath::fromJson(identifier["voice"]);
  154. ret.prologText.jsonDeserialize(identifier["text"]);
  155. }
  156. return ret;
  157. };
  158. CampaignScenario ret;
  159. ret.mapName = reader["map"].String();
  160. for(auto & g : reader["preconditions"].Vector())
  161. ret.preconditionRegions.insert(static_cast<CampaignScenarioID>(g.Integer()));
  162. ret.regionColor = reader["color"].Integer();
  163. ret.difficulty = reader["difficulty"].Integer();
  164. ret.regionText.jsonDeserialize(reader["regionText"]);
  165. ret.prolog = prologEpilogReader(reader["prolog"]);
  166. ret.epilog = prologEpilogReader(reader["epilog"]);
  167. ret.travelOptions = readScenarioTravelFromJson(reader);
  168. return ret;
  169. }
  170. CampaignTravel CampaignHandler::readScenarioTravelFromJson(JsonNode & reader)
  171. {
  172. CampaignTravel ret;
  173. std::map<std::string, CampaignStartOptions> startOptionsMap = {
  174. {"none", CampaignStartOptions::NONE},
  175. {"bonus", CampaignStartOptions::START_BONUS},
  176. {"crossover", CampaignStartOptions::HERO_CROSSOVER},
  177. {"hero", CampaignStartOptions::HERO_OPTIONS}
  178. };
  179. std::map<std::string, CampaignBonusType> bonusTypeMap = {
  180. {"spell", CampaignBonusType::SPELL},
  181. {"creature", CampaignBonusType::MONSTER},
  182. {"building", CampaignBonusType::BUILDING},
  183. {"artifact", CampaignBonusType::ARTIFACT},
  184. {"scroll", CampaignBonusType::SPELL_SCROLL},
  185. {"primarySkill", CampaignBonusType::PRIMARY_SKILL},
  186. {"secondarySkill", CampaignBonusType::SECONDARY_SKILL},
  187. {"resource", CampaignBonusType::RESOURCE},
  188. //{"prevHero", CScenarioTravel::STravelBonus::EBonusType::HEROES_FROM_PREVIOUS_SCENARIO},
  189. //{"hero", CScenarioTravel::STravelBonus::EBonusType::HERO},
  190. };
  191. std::map<std::string, ui32> primarySkillsMap = {
  192. {"attack", 0},
  193. {"defence", 8},
  194. {"spellpower", 16},
  195. {"knowledge", 24},
  196. };
  197. std::map<std::string, ui16> heroSpecialMap = {
  198. {"strongest", 0xFFFD},
  199. {"generated", 0xFFFE},
  200. {"random", 0xFFFF}
  201. };
  202. std::map<std::string, ui8> resourceTypeMap = {
  203. //FD - wood+ore
  204. //FE - mercury+sulfur+crystal+gem
  205. {"wood", 0},
  206. {"mercury", 1},
  207. {"ore", 2},
  208. {"sulfur", 3},
  209. {"crystal", 4},
  210. {"gems", 5},
  211. {"gold", 6},
  212. {"common", 0xFD},
  213. {"rare", 0xFE}
  214. };
  215. for(auto & k : reader["heroKeeps"].Vector())
  216. {
  217. if(k.String() == "experience") ret.whatHeroKeeps.experience = true;
  218. if(k.String() == "primarySkills") ret.whatHeroKeeps.primarySkills = true;
  219. if(k.String() == "secondarySkills") ret.whatHeroKeeps.secondarySkills = true;
  220. if(k.String() == "spells") ret.whatHeroKeeps.spells = true;
  221. if(k.String() == "artifacts") ret.whatHeroKeeps.artifacts = true;
  222. }
  223. for(auto & k : reader["keepCreatures"].Vector())
  224. {
  225. if(auto identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), "creature", k.String()))
  226. ret.monstersKeptByHero.insert(CreatureID(identifier.value()));
  227. else
  228. logGlobal->warn("VCMP Loading: keepCreatures contains unresolved identifier %s", k.String());
  229. }
  230. for(auto & k : reader["keepArtifacts"].Vector())
  231. {
  232. if(auto identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), "artifact", k.String()))
  233. ret.artifactsKeptByHero.insert(ArtifactID(identifier.value()));
  234. else
  235. logGlobal->warn("VCMP Loading: keepArtifacts contains unresolved identifier %s", k.String());
  236. }
  237. ret.startOptions = startOptionsMap[reader["startOptions"].String()];
  238. switch(ret.startOptions)
  239. {
  240. case CampaignStartOptions::NONE:
  241. //no bonuses. Seems to be OK
  242. break;
  243. case CampaignStartOptions::START_BONUS: //reading of bonuses player can choose
  244. {
  245. ret.playerColor = PlayerColor(PlayerColor::decode(reader["playerColor"].String()));
  246. for(auto & bjson : reader["bonuses"].Vector())
  247. {
  248. CampaignBonus bonus;
  249. bonus.type = bonusTypeMap[bjson["what"].String()];
  250. switch (bonus.type)
  251. {
  252. case CampaignBonusType::RESOURCE:
  253. bonus.info1 = resourceTypeMap[bjson["type"].String()];
  254. bonus.info2 = bjson["amount"].Integer();
  255. break;
  256. case CampaignBonusType::BUILDING:
  257. bonus.info1 = vstd::find_pos(EBuildingType::names, bjson["type"].String());
  258. if(bonus.info1 == -1)
  259. logGlobal->warn("VCMP Loading: unresolved building identifier %s", bjson["type"].String());
  260. break;
  261. default:
  262. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  263. bonus.info1 = heroId;
  264. else
  265. if(auto identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), "hero", bjson["hero"].String()))
  266. bonus.info1 = identifier.value();
  267. else
  268. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  269. bonus.info3 = bjson["amount"].Integer();
  270. switch(bonus.type)
  271. {
  272. case CampaignBonusType::SPELL:
  273. case CampaignBonusType::MONSTER:
  274. case CampaignBonusType::SECONDARY_SKILL:
  275. case CampaignBonusType::ARTIFACT:
  276. if(auto identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), bjson["what"].String(), bjson["type"].String()))
  277. bonus.info2 = identifier.value();
  278. else
  279. logGlobal->warn("VCMP Loading: unresolved %s identifier %s", bjson["what"].String(), bjson["type"].String());
  280. break;
  281. case CampaignBonusType::SPELL_SCROLL:
  282. if(auto Identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), "spell", bjson["type"].String()))
  283. bonus.info2 = Identifier.value();
  284. else
  285. logGlobal->warn("VCMP Loading: unresolved spell scroll identifier %s", bjson["type"].String());
  286. break;
  287. case CampaignBonusType::PRIMARY_SKILL:
  288. for(auto & ps : primarySkillsMap)
  289. bonus.info2 |= bjson[ps.first].Integer() << ps.second;
  290. break;
  291. default:
  292. bonus.info2 = bjson["type"].Integer();
  293. }
  294. break;
  295. }
  296. ret.bonusesToChoose.push_back(bonus);
  297. }
  298. break;
  299. }
  300. case CampaignStartOptions::HERO_CROSSOVER: //reading of players (colors / scenarios ?) player can choose
  301. {
  302. for(auto & bjson : reader["bonuses"].Vector())
  303. {
  304. CampaignBonus bonus;
  305. bonus.type = CampaignBonusType::HEROES_FROM_PREVIOUS_SCENARIO;
  306. bonus.info1 = bjson["playerColor"].Integer(); //player color
  307. bonus.info2 = bjson["scenario"].Integer(); //from what scenario
  308. ret.bonusesToChoose.push_back(bonus);
  309. }
  310. break;
  311. }
  312. case CampaignStartOptions::HERO_OPTIONS: //heroes player can choose between
  313. {
  314. for(auto & bjson : reader["bonuses"].Vector())
  315. {
  316. CampaignBonus bonus;
  317. bonus.type = CampaignBonusType::HERO;
  318. bonus.info1 = bjson["playerColor"].Integer(); //player color
  319. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  320. bonus.info2 = heroId;
  321. else
  322. if (auto identifier = VLC->identifiers()->getIdentifier(ModScope::scopeMap(), "hero", bjson["hero"].String()))
  323. bonus.info2 = identifier.value();
  324. else
  325. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  326. ret.bonusesToChoose.push_back(bonus);
  327. }
  328. break;
  329. }
  330. default:
  331. {
  332. logGlobal->warn("VCMP Loading: Unsupported start options value");
  333. break;
  334. }
  335. }
  336. return ret;
  337. }
  338. void CampaignHandler::readHeaderFromMemory( CampaignHeader & ret, CBinaryReader & reader, std::string filename, std::string modName, std::string encoding )
  339. {
  340. ret.version = static_cast<CampaignVersion>(reader.readUInt32());
  341. ui8 campId = reader.readUInt8() - 1;//change range of it from [1, 20] to [0, 19]
  342. if(ret.version != CampaignVersion::Chr) // For chronicles: Will be overridden later; Chronicles uses own logic (reusing OH3 ID's)
  343. ret.loadLegacyData(campId);
  344. ret.name.appendTextID(readLocalizedString(ret, reader, filename, modName, encoding, "name"));
  345. ret.description.appendTextID(readLocalizedString(ret, reader, filename, modName, encoding, "description"));
  346. ret.author.appendRawString("");
  347. ret.authorContact.appendRawString("");
  348. ret.campaignVersion.appendRawString("");
  349. ret.creationDateTime = 0;
  350. if (ret.version > CampaignVersion::RoE)
  351. ret.difficultyChosenByPlayer = reader.readInt8();
  352. else
  353. ret.difficultyChosenByPlayer = false;
  354. ret.music = prologMusicName(reader.readInt8());
  355. ret.filename = filename;
  356. ret.modName = modName;
  357. ret.encoding = encoding;
  358. }
  359. CampaignScenario CampaignHandler::readScenarioFromMemory( CBinaryReader & reader, CampaignHeader & header)
  360. {
  361. auto prologEpilogReader = [&](const std::string & identifier) -> CampaignScenarioPrologEpilog
  362. {
  363. CampaignScenarioPrologEpilog ret;
  364. ret.hasPrologEpilog = reader.readUInt8();
  365. if(ret.hasPrologEpilog)
  366. {
  367. bool isOriginalCampaign = boost::starts_with(header.getFilename(), "DATA/");
  368. ui8 index = reader.readUInt8();
  369. ret.prologVideo = CampaignHandler::prologVideoName(index);
  370. ret.prologMusic = CampaignHandler::prologMusicName(reader.readUInt8());
  371. ret.prologVoice = isOriginalCampaign ? CampaignHandler::prologVoiceName(index) : AudioPath();
  372. ret.prologText.appendTextID(readLocalizedString(header, reader, header.filename, header.modName, header.encoding, identifier));
  373. }
  374. return ret;
  375. };
  376. CampaignScenario ret;
  377. ret.mapName = reader.readBaseString();
  378. reader.readUInt32(); //packedMapSize - not used
  379. if(header.numberOfScenarios > 8) //unholy alliance
  380. {
  381. ret.loadPreconditionRegions(reader.readUInt16());
  382. }
  383. else
  384. {
  385. ret.loadPreconditionRegions(reader.readUInt8());
  386. }
  387. ret.regionColor = reader.readUInt8();
  388. ret.difficulty = reader.readUInt8();
  389. ret.regionText.appendTextID(readLocalizedString(header, reader, header.filename, header.modName, header.encoding, ret.mapName + ".region"));
  390. ret.prolog = prologEpilogReader(ret.mapName + ".prolog");
  391. ret.epilog = prologEpilogReader(ret.mapName + ".epilog");
  392. ret.travelOptions = readScenarioTravelFromMemory(reader, header.version);
  393. return ret;
  394. }
  395. template<typename Identifier>
  396. static void readContainer(std::set<Identifier> & container, CBinaryReader & reader, int sizeBytes)
  397. {
  398. for(int iId = 0, byte = 0; iId < sizeBytes * 8; ++iId)
  399. {
  400. if(iId % 8 == 0)
  401. byte = reader.readUInt8();
  402. if(byte & (1 << iId % 8))
  403. container.insert(Identifier(iId));
  404. }
  405. }
  406. CampaignTravel CampaignHandler::readScenarioTravelFromMemory(CBinaryReader & reader, CampaignVersion version )
  407. {
  408. CampaignTravel ret;
  409. ui8 whatHeroKeeps = reader.readUInt8();
  410. ret.whatHeroKeeps.experience = whatHeroKeeps & 1;
  411. ret.whatHeroKeeps.primarySkills = whatHeroKeeps & 2;
  412. ret.whatHeroKeeps.secondarySkills = whatHeroKeeps & 4;
  413. ret.whatHeroKeeps.spells = whatHeroKeeps & 8;
  414. ret.whatHeroKeeps.artifacts = whatHeroKeeps & 16;
  415. readContainer(ret.monstersKeptByHero, reader, 19);
  416. readContainer(ret.artifactsKeptByHero, reader, version < CampaignVersion::SoD ? 17 : 18);
  417. ret.startOptions = static_cast<CampaignStartOptions>(reader.readUInt8());
  418. switch(ret.startOptions)
  419. {
  420. case CampaignStartOptions::NONE:
  421. //no bonuses. Seems to be OK
  422. break;
  423. case CampaignStartOptions::START_BONUS: //reading of bonuses player can choose
  424. {
  425. ret.playerColor.setNum(reader.readUInt8());
  426. ui8 numOfBonuses = reader.readUInt8();
  427. for (int g=0; g<numOfBonuses; ++g)
  428. {
  429. CampaignBonus bonus;
  430. bonus.type = static_cast<CampaignBonusType>(reader.readUInt8());
  431. //hero: FFFD means 'most powerful' and FFFE means 'generated'
  432. switch(bonus.type)
  433. {
  434. case CampaignBonusType::SPELL:
  435. {
  436. bonus.info1 = reader.readUInt16(); //hero
  437. bonus.info2 = reader.readUInt8(); //spell ID
  438. break;
  439. }
  440. case CampaignBonusType::MONSTER:
  441. {
  442. bonus.info1 = reader.readUInt16(); //hero
  443. bonus.info2 = reader.readUInt16(); //monster type
  444. bonus.info3 = reader.readUInt16(); //monster count
  445. break;
  446. }
  447. case CampaignBonusType::BUILDING:
  448. {
  449. bonus.info1 = reader.readUInt8(); //building ID (0 - town hall, 1 - city hall, 2 - capitol, etc)
  450. break;
  451. }
  452. case CampaignBonusType::ARTIFACT:
  453. {
  454. bonus.info1 = reader.readUInt16(); //hero
  455. bonus.info2 = reader.readUInt16(); //artifact ID
  456. break;
  457. }
  458. case CampaignBonusType::SPELL_SCROLL:
  459. {
  460. bonus.info1 = reader.readUInt16(); //hero
  461. bonus.info2 = reader.readUInt8(); //spell ID
  462. break;
  463. }
  464. case CampaignBonusType::PRIMARY_SKILL:
  465. {
  466. bonus.info1 = reader.readUInt16(); //hero
  467. bonus.info2 = reader.readUInt32(); //bonuses (4 bytes for 4 skills)
  468. break;
  469. }
  470. case CampaignBonusType::SECONDARY_SKILL:
  471. {
  472. bonus.info1 = reader.readUInt16(); //hero
  473. bonus.info2 = reader.readUInt8(); //skill ID
  474. bonus.info3 = reader.readUInt8(); //skill level
  475. break;
  476. }
  477. case CampaignBonusType::RESOURCE:
  478. {
  479. bonus.info1 = reader.readUInt8(); //type
  480. //FD - wood+ore
  481. //FE - mercury+sulfur+crystal+gem
  482. bonus.info2 = reader.readUInt32(); //count
  483. break;
  484. }
  485. default:
  486. logGlobal->warn("Corrupted h3c file");
  487. break;
  488. }
  489. ret.bonusesToChoose.push_back(bonus);
  490. }
  491. break;
  492. }
  493. case CampaignStartOptions::HERO_CROSSOVER: //reading of players (colors / scenarios ?) player can choose
  494. {
  495. ui8 numOfBonuses = reader.readUInt8();
  496. for (int g=0; g<numOfBonuses; ++g)
  497. {
  498. CampaignBonus bonus;
  499. bonus.type = CampaignBonusType::HEROES_FROM_PREVIOUS_SCENARIO;
  500. bonus.info1 = reader.readUInt8(); //player color
  501. bonus.info2 = reader.readUInt8(); //from what scenario
  502. ret.bonusesToChoose.push_back(bonus);
  503. }
  504. break;
  505. }
  506. case CampaignStartOptions::HERO_OPTIONS: //heroes player can choose between
  507. {
  508. ui8 numOfBonuses = reader.readUInt8();
  509. for (int g=0; g<numOfBonuses; ++g)
  510. {
  511. CampaignBonus bonus;
  512. bonus.type = CampaignBonusType::HERO;
  513. bonus.info1 = reader.readUInt8(); //player color
  514. bonus.info2 = reader.readUInt16(); //hero, FF FF - random
  515. ret.bonusesToChoose.push_back(bonus);
  516. }
  517. break;
  518. }
  519. default:
  520. {
  521. logGlobal->warn("Corrupted h3c file");
  522. break;
  523. }
  524. }
  525. return ret;
  526. }
  527. std::vector< std::vector<ui8> > CampaignHandler::getFile(std::unique_ptr<CInputStream> file, const std::string & filename, bool headerOnly)
  528. {
  529. std::array<ui8, 2> magic;
  530. file->read(magic.data(), magic.size());
  531. file->seek(0);
  532. std::vector< std::vector<ui8> > ret;
  533. static const std::array<ui8, 2> zipHeaderMagic{0x50, 0x4B};
  534. if (magic == zipHeaderMagic) // ZIP archive - assume VCMP format
  535. {
  536. CInputStream * buffer(file.get());
  537. auto ioApi = std::make_shared<CProxyROIOApi>(buffer);
  538. CZipLoader loader("", "_", ioApi);
  539. // load header
  540. JsonPath jsonPath = JsonPath::builtin(VCMP_HEADER_FILE_NAME);
  541. if(!loader.existsResource(jsonPath))
  542. throw std::runtime_error(jsonPath.getName() + " not found in " + filename);
  543. auto data = loader.load(jsonPath)->readAll();
  544. ret.emplace_back(data.first.get(), data.first.get() + data.second);
  545. if(headerOnly)
  546. return ret;
  547. // load scenarios
  548. JsonNode header(reinterpret_cast<const std::byte*>(data.first.get()), data.second, VCMP_HEADER_FILE_NAME);
  549. for(auto scenario : header["scenarios"].Vector())
  550. {
  551. ResourcePath mapPath(scenario["map"].String(), EResType::MAP);
  552. if(!loader.existsResource(mapPath))
  553. throw std::runtime_error(mapPath.getName() + " not found in " + filename);
  554. auto data = loader.load(mapPath)->readAll();
  555. ret.emplace_back(data.first.get(), data.first.get() + data.second);
  556. }
  557. return ret;
  558. }
  559. else // H3C
  560. {
  561. CCompressedStream stream(std::move(file), true);
  562. try
  563. {
  564. do
  565. {
  566. std::vector<ui8> block(stream.getSize());
  567. stream.read(block.data(), block.size());
  568. ret.push_back(block);
  569. ret.back().shrink_to_fit();
  570. }
  571. while (!headerOnly && stream.getNextBlock());
  572. }
  573. catch (const DecompressionException & e)
  574. {
  575. // Some campaigns in French version from gog.com have trailing garbage bytes
  576. // For example, slayer.h3c consist from 5 parts: header + 4 maps
  577. // However file also contains ~100 "extra" bytes after those 5 parts are decompressed that do not represent gzip stream
  578. // leading to exception "Incorrect header check"
  579. // Since H3 handles these files correctly, simply log this as warning and proceed
  580. logGlobal->warn("Failed to read file %s. Encountered error during decompression: %s", filename, e.what());
  581. }
  582. return ret;
  583. }
  584. }
  585. VideoPath CampaignHandler::prologVideoName(ui8 index)
  586. {
  587. JsonNode config(JsonPath::builtin("CONFIG/campaignMedia"));
  588. auto vids = config["videos"].Vector();
  589. if(index < vids.size())
  590. return VideoPath::fromJson(vids[index]);
  591. return VideoPath();
  592. }
  593. AudioPath CampaignHandler::prologMusicName(ui8 index)
  594. {
  595. std::vector<std::string> music;
  596. return AudioPath::builtinTODO(VLC->generaltexth->translate("core.cmpmusic." + std::to_string(static_cast<int>(index))));
  597. }
  598. AudioPath CampaignHandler::prologVoiceName(ui8 index)
  599. {
  600. JsonNode config(JsonPath::builtin("CONFIG/campaignMedia"));
  601. auto audio = config["voice"].Vector();
  602. if(index < audio.size())
  603. return AudioPath::fromJson(audio[index]);
  604. return AudioPath();
  605. }
  606. VCMI_LIB_NAMESPACE_END