diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..266a7ea2c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +*.json linguist-language=JSON-with-Comments +*.h linguist-language=C++ +*.cpp linguist-language=C++ diff --git a/AI/BattleAI/BattleAI.cpp b/AI/BattleAI/BattleAI.cpp index 0f7068402..00f6295e7 100644 --- a/AI/BattleAI/BattleAI.cpp +++ b/AI/BattleAI/BattleAI.cpp @@ -93,6 +93,12 @@ void CBattleAI::initBattleInterface(std::shared_ptr ENV, std::share movesSkippedByDefense = 0; } +void CBattleAI::initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB, AutocombatPreferences autocombatPreferences) +{ + initBattleInterface(ENV, CB); + autobattlePreferences = autocombatPreferences; +} + BattleAction CBattleAI::useHealingTent(const CStack *stack) { auto healingTargets = cb->battleGetStacks(CBattleInfoEssentials::ONLY_MINE); @@ -283,7 +289,8 @@ void CBattleAI::activeStack( const CStack * stack ) return; } - attemptCastingSpell(); + if(autobattlePreferences.enableSpellsUsage) + attemptCastingSpell(); logAi->trace("Spellcast attempt completed in %lld", timeElapsed(start)); diff --git a/AI/BattleAI/BattleAI.h b/AI/BattleAI/BattleAI.h index 37338d299..a83fcfd25 100644 --- a/AI/BattleAI/BattleAI.h +++ b/AI/BattleAI/BattleAI.h @@ -68,6 +68,7 @@ public: ~CBattleAI(); void initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB) override; + void initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB, AutocombatPreferences autocombatPreferences) override; void attemptCastingSpell(); void evaluateCreatureSpellcast(const CStack * stack, PossibleSpellcast & ps); //for offensive damaging spells only @@ -102,4 +103,5 @@ public: private: BattleAction goTowardsNearest(const CStack * stack, std::vector hexes) const; std::vector getBrokenWallMoatHexes() const; + AutocombatPreferences autobattlePreferences = AutocombatPreferences(); }; diff --git a/AI/StupidAI/StupidAI.cpp b/AI/StupidAI/StupidAI.cpp index 85a9fe571..aad18351e 100644 --- a/AI/StupidAI/StupidAI.cpp +++ b/AI/StupidAI/StupidAI.cpp @@ -47,6 +47,11 @@ void CStupidAI::initBattleInterface(std::shared_ptr ENV, std::share CB->unlockGsWhenWaiting = false; } +void CStupidAI::initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB, AutocombatPreferences autocombatPreferences) +{ + initBattleInterface(ENV, CB); +} + void CStupidAI::actionFinished(const BattleAction &action) { print("actionFinished called"); diff --git a/AI/StupidAI/StupidAI.h b/AI/StupidAI/StupidAI.h index 3b074d643..6b0d230ad 100644 --- a/AI/StupidAI/StupidAI.h +++ b/AI/StupidAI/StupidAI.h @@ -29,6 +29,7 @@ public: ~CStupidAI(); void initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB) override; + void initBattleInterface(std::shared_ptr ENV, std::shared_ptr CB, AutocombatPreferences autocombatPreferences) override; void actionFinished(const BattleAction &action) override;//occurs AFTER every action taken by any stack or by the hero void actionStarted(const BattleAction &action) override;//occurs BEFORE every action taken by any stack or by the hero void activeStack(const CStack * stack) override; //called when it's turn of that stack diff --git a/CI/mingw-ubuntu/before_install.sh b/CI/mingw-ubuntu/before_install.sh index 75e8d47a8..bc1acca52 100755 --- a/CI/mingw-ubuntu/before_install.sh +++ b/CI/mingw-ubuntu/before_install.sh @@ -6,10 +6,10 @@ sudo update-alternatives --set x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw3 # Workaround for getting new MinGW headers on Ubuntu 22.04. # Remove it once MinGW headers version in repository will be 10.0 at least -curl -O -L http://mirrors.kernel.org/ubuntu/pool/universe/m/mingw-w64/mingw-w64-common_10.0.0-2_all.deb \ - && sudo dpkg -i mingw-w64-common_10.0.0-2_all.deb; -curl -O -L http://mirrors.kernel.org/ubuntu/pool/universe/m/mingw-w64/mingw-w64-x86-64-dev_10.0.0-2_all.deb \ - && sudo dpkg -i mingw-w64-x86-64-dev_10.0.0-2_all.deb; +curl -O -L http://mirrors.kernel.org/ubuntu/pool/universe/m/mingw-w64/mingw-w64-common_10.0.0-3_all.deb \ + && sudo dpkg -i mingw-w64-common_10.0.0-3_all.deb; +curl -O -L http://mirrors.kernel.org/ubuntu/pool/universe/m/mingw-w64/mingw-w64-x86-64-dev_10.0.0-3_all.deb \ + && sudo dpkg -i mingw-w64-x86-64-dev_10.0.0-3_all.deb; mkdir ~/.conan ; cd ~/.conan curl -L "https://github.com/vcmi/vcmi-deps-windows-conan/releases/download/1.0/vcmi-deps-windows-conan-w64.tgz" \ diff --git a/ChangeLog.md b/ChangeLog.md index 31a09a49b..873ce4147 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,65 @@ +# 1.3.1 -> 1.3.2 + +### GENERAL +* VCMI now uses new application icon +* Added initial version of Czech translation +* Game will now use tile hero is moving from for movement cost calculations, in line with H3 +* Added option to open hero backpack window in hero screen +* Added detection of misclicks for touch inputs to make hitting small UI elements easier +* Hero commander will now gain option to learn perks on reaching master level in corresponding abilities +* It is no longer possible to stop movement while moving over water with Water Walk +* Game will now automatically update hero path if it was blocked by another hero +* Added "vcmiartifacts angelWings" form to "give artifacts" cheat + +### STABILITY +* Fixed freeze in Launcher on repository checkout and on mod install +* Fixed crash on loading VCMI map with placed Abandoned Mine +* Fixed crash on loading VCMI map with neutral towns +* Fixed crash on attempting to visit unknown object, such as Market of Time +* Fixed crash on attempting to teleport unit that is immune to a spell +* Fixed crash on switching fullscreen mode during AI turn + +### CAMPAIGNS +* Fixed reorderging of hero primary skills after moving to next scenario in campaigns + +### BATTLES +* Conquering a town will now correctly award additional 500 experience points +* Quick combat is now enabled by default +* Fixed invisible creatures from SUMMON_GUARDIANS and TRANSMUTATION bonuses +* Added option to toggle spell usage by AI in quick combat +* Fixed updating of spell point of enemy hero in game interface after spell cast +* Fixed wrong creature spellcasting shortcut (now set to "F") +* It is now possible to perform melee attack by creatures with spells, especially area spells +* Right-click will now properly end spellcast mode +* Fixed cursor preview when casting spell using touchscreen +* Long tap during spell casting will now properly abort the spell + +### INTERFACE +* Added "Fill all empty slots with 1 creature" option to radial wheel in garrison windows +* Context popup for adventure map monsters will now show creature icon +* Game will now show correct victory message for gather troops victory condition +* Fixed incorrect display of number of owned Sawmills in Kingdom Overview window +* Fixed incorrect color of resource bar in hotseat mode +* Fixed broken toggle map level button in world view mode +* Fixed corrupted interface after opening puzzle window from world view mode +* Fixed blocked interface after attempt to start invalid map +* Add yellow border to selected commander grandmaster ability +* Always use bonus description for commander abilities instead of not provided wog-specific translation +* Fix scrolling when commander has large number of grandmaster abilities +* Fixed corrupted message on another player defeat +* Fixed unavailable Quest Log button on maps with quests +* Fixed incorrect values on a difficulty selector in save load screen +* Removed invalid error message on attempting to move non-existing unit in exchange window + +### RANDOM MAP GENERATOR +* Fixed bug leading to unreachable resources around mines + +### MAP EDITOR +* Fixed crash on maps containing abandoned mines +* Fixed crash on maps containing neutral objects +* Fixed problem with random map initialized in map editor +* Fixed problem with initialization of random dwellings + # 1.3.0 -> 1.3.1 ### GENERAL: @@ -430,8 +492,8 @@ ### MODDING: * All configurable objects from H3 now have their configuration in json * Improvements to functionality of configurable objects -* Replaced `SECONDARY_SKILL_PREMY` bonus with separate bonuses for each skill. See https://wiki.vcmi.eu/List_of_all_bonus_types -* Removed multiple bonuses that can be replaced with another bonus. See https://wiki.vcmi.eu/List_of_all_bonus_types +* Replaced `SECONDARY_SKILL_PREMY` bonus with separate bonuses for each skill. +* Removed multiple bonuses that can be replaced with another bonus. * It is now possible to define new hero movement sounds in terrains * Implemented translation support for mods * Implemented translation support for .h3m maps and .h3c campaigns @@ -756,7 +818,7 @@ * Wall hit/miss sound will be played when using catapult during siege ### SPELLS: -* New configuration format: http://wiki.vcmi.eu/index.php?title=Spell_Format +* New configuration format ### RANDOM MAP GENERATOR: * Towns from mods can be used @@ -789,7 +851,6 @@ * (linux) Added a SIGSEV violation handler to vcmiserver executable for logging stacktrace (for convenience) ### ADVENTURE AI: -More info at http://wiki.vcmi.eu/index.php?title=Adventure_AI * AI will use fuzzy logic to compare and choose multiple possible subgoals. * AI will now use SectorMap to find a way to guarded / covered objects. * Significantly improved exploration algorithm. @@ -812,7 +873,6 @@ More info at http://wiki.vcmi.eu/index.php?title=Adventure_AI * Extended building dependencies support ### MODS: -* See http://wiki.vcmi.eu/index.php?title=Modding_changelog#0.94_-.3E_0.95 for format changes * Custom victory/loss conditions for maps or campaigns * 7 days without towns loss condition is no longer hardcoded * Only changed mods will be validated @@ -870,7 +930,6 @@ More info at http://wiki.vcmi.eu/index.php?title=Adventure_AI * Fixed crash at month of double population. ### MODS: -* See http://wiki.vcmi.eu/index.php?title=Modding_changelog#0.92_-.3E_0.93 for compatibility info. * Improved json validation. Now it support most of features from latest json schema draft. * Icons use path to icon instead of image indexes. * It is possible to edit data of another mod or H3 data via mods. diff --git a/Mods/vcmi/Data/radialMenu/stackFillOne.png b/Mods/vcmi/Data/radialMenu/stackFillOne.png new file mode 100644 index 000000000..d2f1632a0 Binary files /dev/null and b/Mods/vcmi/Data/radialMenu/stackFillOne.png differ diff --git a/Mods/vcmi/Data/radialMenu/stackInfo.png b/Mods/vcmi/Data/radialMenu/stackInfo.png deleted file mode 100644 index 9a7a72620..000000000 Binary files a/Mods/vcmi/Data/radialMenu/stackInfo.png and /dev/null differ diff --git a/Mods/vcmi/Data/radialMenu/stackSplitEqual.png b/Mods/vcmi/Data/radialMenu/stackSplitEqual.png index b9582f549..2d660c5f1 100644 Binary files a/Mods/vcmi/Data/radialMenu/stackSplitEqual.png and b/Mods/vcmi/Data/radialMenu/stackSplitEqual.png differ diff --git a/Mods/vcmi/Data/radialMenu/stackSplitOne.png b/Mods/vcmi/Data/radialMenu/stackSplitOne.png index a1945631a..38b6d30f3 100644 Binary files a/Mods/vcmi/Data/radialMenu/stackSplitOne.png and b/Mods/vcmi/Data/radialMenu/stackSplitOne.png differ diff --git a/Mods/vcmi/Sprites/buttons/backpack.json b/Mods/vcmi/Sprites/buttons/backpack.json new file mode 100644 index 000000000..a74a8c3a1 --- /dev/null +++ b/Mods/vcmi/Sprites/buttons/backpack.json @@ -0,0 +1,8 @@ +{ + "basepath" : "buttons/", + "images" : + [ + { "frame" : 0, "file" : "backpackNormal.png"}, + { "frame" : 1, "file" : "backpackPressed.png"} + ] +} diff --git a/Mods/vcmi/Sprites/buttons/backpackButtonIcon.png b/Mods/vcmi/Sprites/buttons/backpackButtonIcon.png new file mode 100644 index 000000000..d71289833 Binary files /dev/null and b/Mods/vcmi/Sprites/buttons/backpackButtonIcon.png differ diff --git a/Mods/vcmi/Sprites/buttons/backpackNormal.png b/Mods/vcmi/Sprites/buttons/backpackNormal.png new file mode 100644 index 000000000..6ea22798c Binary files /dev/null and b/Mods/vcmi/Sprites/buttons/backpackNormal.png differ diff --git a/Mods/vcmi/Sprites/buttons/backpackPressed.png b/Mods/vcmi/Sprites/buttons/backpackPressed.png new file mode 100644 index 000000000..2de1c6be2 Binary files /dev/null and b/Mods/vcmi/Sprites/buttons/backpackPressed.png differ diff --git a/Mods/vcmi/Sprites/heroWindow/artifactSlotEmpty.png b/Mods/vcmi/Sprites/heroWindow/artifactSlotEmpty.png new file mode 100644 index 000000000..f0dec0972 Binary files /dev/null and b/Mods/vcmi/Sprites/heroWindow/artifactSlotEmpty.png differ diff --git a/Mods/vcmi/Sprites/mapFormatIcons/vcmi1.png b/Mods/vcmi/Sprites/mapFormatIcons/vcmi1.png index b575cf133..a2d7b1126 100644 Binary files a/Mods/vcmi/Sprites/mapFormatIcons/vcmi1.png and b/Mods/vcmi/Sprites/mapFormatIcons/vcmi1.png differ diff --git a/Mods/vcmi/config/vcmi/czech.json b/Mods/vcmi/config/vcmi/czech.json new file mode 100644 index 000000000..dcbb8ccaf --- /dev/null +++ b/Mods/vcmi/config/vcmi/czech.json @@ -0,0 +1,370 @@ +{ + "vcmi.adventureMap.monsterThreat.title" : "\n\nHrozba: ", + "vcmi.adventureMap.monsterThreat.levels.0" : "Bez námahy", + "vcmi.adventureMap.monsterThreat.levels.1" : "Velmi slabá", + "vcmi.adventureMap.monsterThreat.levels.2" : "Slabá", + "vcmi.adventureMap.monsterThreat.levels.3" : "Trochu slabší", + "vcmi.adventureMap.monsterThreat.levels.4" : "Podobná", + "vcmi.adventureMap.monsterThreat.levels.5" : "Trochu silnější", + "vcmi.adventureMap.monsterThreat.levels.6" : "Silná", + "vcmi.adventureMap.monsterThreat.levels.7" : "Velmi silná", + "vcmi.adventureMap.monsterThreat.levels.8" : "Výzva", + "vcmi.adventureMap.monsterThreat.levels.9" : "Převažující", + "vcmi.adventureMap.monsterThreat.levels.10" : "Smrtelná", + "vcmi.adventureMap.monsterThreat.levels.11" : "Nemožná", + + "vcmi.adventureMap.confirmRestartGame" : "Jste si jisti, že chcete restartovat hru?", + "vcmi.adventureMap.noTownWithMarket" : "Nejsou dostupná jakákoliv tržiště!", + "vcmi.adventureMap.noTownWithTavern" : "Nejsou dostupná jakákoliv města s krčmou!", + "vcmi.adventureMap.spellUnknownProblem" : "Neznámý problém s tímto kouzlem! Další informace nejsou k dispozici.", + "vcmi.adventureMap.playerAttacked" : "Hráč byl napaden: %s", + "vcmi.adventureMap.moveCostDetails" : "Body pohybu - Cena: %TURNS tahů + %POINTS bodů, zbylé body: %REMAINING", + "vcmi.adventureMap.moveCostDetailsNoTurns" : "Body pohybu - Cena: %POINTS bodů, zbylé body: %REMAINING", + + "vcmi.capitalColors.0" : "Červený", + "vcmi.capitalColors.1" : "Modrý", + "vcmi.capitalColors.2" : "Hnědý", + "vcmi.capitalColors.3" : "Zelený", + "vcmi.capitalColors.4" : "Oranžový", + "vcmi.capitalColors.5" : "Fialový", + "vcmi.capitalColors.6" : "Tyrkysový", + "vcmi.capitalColors.7" : "Růžový", + + "vcmi.radialWheel.mergeSameUnit" : "Sloučit stejné jednotky", + "vcmi.radialWheel.fillSingleUnit" : "Vyplnit jednou jednotkou", + "vcmi.radialWheel.splitSingleUnit" : "Rozdělit jedinou jednotku", + "vcmi.radialWheel.splitUnitEqually" : "Rovnoměrně rozdělit jednotky", + "vcmi.radialWheel.moveUnit" : "Přesunout jednotky do jiného oddílu", + "vcmi.radialWheel.splitUnit" : "Rozdělit jednotku do jiné pozice", + + "vcmi.mainMenu.highscoresNotImplemented" : "Omlouvám se, menu nejvyšší skóre ještě není implementováno\n", + "vcmi.mainMenu.serverConnecting" : "Připojování...", + "vcmi.mainMenu.serverAddressEnter" : "Zadejte adresu:", + "vcmi.mainMenu.serverClosing" : "Zavírání...", + "vcmi.mainMenu.hostTCP" : "Pořádat hru TCP/IP", + "vcmi.mainMenu.joinTCP" : "Připojit se do hry TCP/IP", + "vcmi.mainMenu.playerName" : "Hráč", + + "vcmi.lobby.filename" : "Název souboru", + "vcmi.lobby.creationDate" : "Datum vytvoření", + + "vcmi.server.errors.existingProcess" : "Již běží jiný server VCMI. Prosím, ukončete ho před startem nové hry.", + "vcmi.server.errors.modsIncompatibility" : "Následující modifikace jsou nutné pro načtení hry:", + "vcmi.server.confirmReconnect" : "Chcete se připojit k poslední relaci?", + + "vcmi.settingsMainWindow.generalTab.hover" : "Obecné", + "vcmi.settingsMainWindow.generalTab.help" : "Přepne na kartu obecných nastavení, která obsahuje nastavení související s obecným chováním klienta hry", + "vcmi.settingsMainWindow.battleTab.hover" : "Bitva", + "vcmi.settingsMainWindow.battleTab.help" : "Přepne na kartu nastavení bitvy, která umožňuje konfiguraci chování hry v bitvách", + "vcmi.settingsMainWindow.adventureTab.hover" : "Mapa světa", + "vcmi.settingsMainWindow.adventureTab.help" : "Přepne na kartu nastavení mapy světa (mapa světa je sekce hry, ve které hráči mohou ovládat pohyb hrdinů)", + + "vcmi.systemOptions.videoGroup" : "Nastavení obrazu", + "vcmi.systemOptions.audioGroup" : "Nastavení zvuku", + "vcmi.systemOptions.otherGroup" : "Ostatní nastavení", // unused right now + "vcmi.systemOptions.townsGroup" : "Obrazovka města", + + "vcmi.systemOptions.fullscreenBorderless.hover" : "Celá obrazovka (bez okrajů)", + "vcmi.systemOptions.fullscreenBorderless.help" : "{Celá obrazovka bez okrajů}\n\nPokud je vybráno, VCMI poběží v režimu celé obrazovky bez okrajů. V tomto režimu bude hra respektovat systémové rozlišení a ignorovat vybrané rozlišení ve hře.", + "vcmi.systemOptions.fullscreenExclusive.hover" : "Celá obrazovka (exkluzivní)", + "vcmi.systemOptions.fullscreenExclusive.help" : "{Celá obrazovka}\n\nPokud je vybráno, VCMI poběží v režimu exkluzivní celé obrazovky. V tomto režimu hra změní rozlišení na vybrané.", + "vcmi.systemOptions.resolutionButton.hover" : "Rozlišení: %wx%h", + "vcmi.systemOptions.resolutionButton.help" : "{Vybrat rozlišení}\n\nZmění rozlišení herní obrazovky.", + "vcmi.systemOptions.resolutionMenu.hover" : "Vybrat rozlišení", + "vcmi.systemOptions.resolutionMenu.help" : "Změnit rozlišení herní obrazovky.", + "vcmi.systemOptions.scalingButton.hover" : "Škálování rozhraní: %p%", + "vcmi.systemOptions.scalingButton.help" : "{Škálování rozhraní}\n\nZmění škálování herního rozhraní", + "vcmi.systemOptions.scalingMenu.hover" : "Vybrat škálování rozhraní", + "vcmi.systemOptions.scalingMenu.help" : "Změní škálování herního rozhraní.", + "vcmi.systemOptions.longTouchButton.hover" : "Doba dlouhého podržení: %d ms", // Translation note: "ms" = "milliseconds" + "vcmi.systemOptions.longTouchButton.help" : "{Doba dlouhého podržení}\n\nPři používání dotykové obrazovky budou zobrazeno vyskakovací okno při podržení prstu na obrazovce, v milisekundách", + "vcmi.systemOptions.longTouchMenu.hover" : "Vybrat dobu dlouhého podržení", + "vcmi.systemOptions.longTouchMenu.help" : "Změnit dobu dlouhého podržení.", + "vcmi.systemOptions.longTouchMenu.entry" : "%d milisekund", + "vcmi.systemOptions.framerateButton.hover" : "Zobrazit FPS", + "vcmi.systemOptions.framerateButton.help" : "{Zobrazit FPS}\n\nPřepne viditelnost počitadla snímků za sekundu v rohu obrazovky hry", + "vcmi.systemOptions.hapticFeedbackButton.hover" : "Vibrace", + "vcmi.systemOptions.hapticFeedbackButton.help" : "{Vibrace}\n\nPřepnout stav vibrací při dotykovém ovládání", + + "vcmi.adventureOptions.infoBarPick.hover" : "Zobrazit zprávy v panelu informací", + "vcmi.adventureOptions.infoBarPick.help" : "{Zobrazit zprávy v panelu informací}\n\nKdyž bude možné, herní zprávy z návštěv míst na mapě budou zobrazeny v panelu informací místo ve zvláštním okně.", + "vcmi.adventureOptions.numericQuantities.hover" : "Číselné množství jednotek", + "vcmi.adventureOptions.numericQuantities.help" : "{Číselné množství jednotek}\n\nZobrazit přibližné množství nepřátelských jednotek ve formátu A-B.", + "vcmi.adventureOptions.forceMovementInfo.hover" : "Vždy zobrazit cenu pohybu", + "vcmi.adventureOptions.forceMovementInfo.help" : "{Vždy zobrazit cenu pohybu}\n\nVždy zobrazit informace o bodech pohybu v panelu informací. (Místo zobrazení pouze při stisknuté klávese ALT)", + "vcmi.adventureOptions.showGrid.hover" : "Zobrazit mřížku", + "vcmi.adventureOptions.showGrid.help" : "{Zobrazit mřížku}\n\nZobrazit překrytí mřížkou, zvýrazňuje hranice mezi dlaždicemi mapy světa.", + "vcmi.adventureOptions.borderScroll.hover" : "Posouvání okraji", + "vcmi.adventureOptions.borderScroll.help" : "{Posouvání okraji}\n\nPosouvat mapu světa, když je kurzor na okraji obrazovky. Může být zakázáno držením klávesy CTRL.", + "vcmi.adventureOptions.infoBarCreatureManagement.hover" : "Info Panel Creature Management", //TODO + "vcmi.adventureOptions.infoBarCreatureManagement.help" : "{Info Panel Creature Management}\n\nAllows rearranging creatures in info panel instead of cycling between default components", + "vcmi.adventureOptions.leftButtonDrag.hover" : "Left Click Drag Map", + "vcmi.adventureOptions.leftButtonDrag.help" : "{Left Click Drag Map}\n\nWhen enabled, moving mouse with left button pressed will drag adventure map view", + "vcmi.adventureOptions.mapScrollSpeed1.hover": "", + "vcmi.adventureOptions.mapScrollSpeed5.hover": "", + "vcmi.adventureOptions.mapScrollSpeed6.hover": "", + "vcmi.adventureOptions.mapScrollSpeed1.help": "Nastavit posouvání mapy na velmi pomalé", + "vcmi.adventureOptions.mapScrollSpeed5.help": "Nastavit posouvání mapy na velmi rychlé", + "vcmi.adventureOptions.mapScrollSpeed6.help": "Nastavit posouvání mapy na okamžité", + + "vcmi.battleOptions.queueSizeLabel.hover": "Zobrazit frontu pořadí tahů", + "vcmi.battleOptions.queueSizeNoneButton.hover": "VYPNUTO", + "vcmi.battleOptions.queueSizeAutoButton.hover": "AUTO", + "vcmi.battleOptions.queueSizeSmallButton.hover": "MALÁ", + "vcmi.battleOptions.queueSizeBigButton.hover": "VELKÁ", + "vcmi.battleOptions.queueSizeNoneButton.help": "Nezobrazovat frontu pořadí tahů", + "vcmi.battleOptions.queueSizeAutoButton.help": "Nastavit automaticky velikost fronty pořadí tahů podle rozlišení obrazovky hry (Při výšce herního rozlišení menší než 700 pixelů je použita velikost MALÁ, jinak velikost VELKÁ)", + "vcmi.battleOptions.queueSizeSmallButton.help": "Zobrazit malou frontu pořadí tahů", + "vcmi.battleOptions.queueSizeBigButton.help": "Zobrazit velkou frontu pořadí tahů (není podporováno, pokud výška rozlišení hry není alespoň 700 pixelů)", + "vcmi.battleOptions.animationsSpeed1.hover": "", + "vcmi.battleOptions.animationsSpeed5.hover": "", + "vcmi.battleOptions.animationsSpeed6.hover": "", + "vcmi.battleOptions.animationsSpeed1.help": "Nastavit rychlost animací na velmi pomalé", + "vcmi.battleOptions.animationsSpeed5.help": "Nastavit rychlost animací na velmi rychlé", + "vcmi.battleOptions.animationsSpeed6.help": "Nastavit rychlost animací na okamžité", + "vcmi.battleOptions.movementHighlightOnHover.hover": "Zvýraznění pohybu při najetí", + "vcmi.battleOptions.movementHighlightOnHover.help": "{Zvýraznění pohybu při najetí}\n\nZvýraznit rozsah pohybu jednotky při najetí na něj.", + "vcmi.battleOptions.rangeLimitHighlightOnHover.hover": "Zobrazit omezení dostřelu střelců", + "vcmi.battleOptions.rangeLimitHighlightOnHover.help": "{Zobrazit omezení dostřelu střelců při najetí}\n\nZobrazit dostřel střelce při najetí na něj.", + "vcmi.battleOptions.showStickyHeroInfoWindows.hover": "Zobrazit okno statistik hrdinů", + "vcmi.battleOptions.showStickyHeroInfoWindows.help": "{Zobrazit okno statistik hrdinů}\n\nTrvale zapne okno statistiky hrdinů, které ukazuje hlavní schopnosti a magickou energii.", + "vcmi.battleOptions.skipBattleIntroMusic.hover": "Přeskočit úvodní hudbu", + "vcmi.battleOptions.skipBattleIntroMusic.help": "{Přeskočit úvodní hudbu}\n\nPovolí akce při úvodní hudbě přehrávané při začátku každé bitvy.", + + "vcmi.battleWindow.pressKeyToSkipIntro" : "Stiskněte jakoukoliv klávesu pro okamžité zahájení bitvy", + "vcmi.battleWindow.damageEstimation.melee" : "Zaútočit na %CREATURE (%DAMAGE).", + "vcmi.battleWindow.damageEstimation.meleeKills" : "Zaútočit na %CREATURE (%DAMAGE, %KILLS).", + "vcmi.battleWindow.damageEstimation.ranged" : "Vystřelit na %CREATURE (%SHOTS, %DAMAGE).", + "vcmi.battleWindow.damageEstimation.rangedKills" : "Vystřelit na %CREATURE (%SHOTS, %DAMAGE, %KILLS).", + "vcmi.battleWindow.damageEstimation.shots" : "%d střel zbývá", + "vcmi.battleWindow.damageEstimation.shots.1" : "%d střela zbývá", + "vcmi.battleWindow.damageEstimation.damage" : "%d poškození", + "vcmi.battleWindow.damageEstimation.damage.1" : "%d poškození", + "vcmi.battleWindow.damageEstimation.kills" : "%d zahyne", + "vcmi.battleWindow.damageEstimation.kills.1" : "%d zahyne", + + "vcmi.battleResultsWindow.applyResultsLabel" : "Použít výsledek bitvy", + + "vcmi.otherOptions.availableCreaturesAsDwellingLabel.hover" : "Zobrazit dostupné jednotky", + "vcmi.otherOptions.availableCreaturesAsDwellingLabel.help" : "{Zobrazit dostupné jednotky}\n\nZobrazit počet jednotek dostupných ke koupení místo jejich týdenního přírůstku v přehledu města. (levý spodní okraj obrazovky města).", + "vcmi.otherOptions.creatureGrowthAsDwellingLabel.hover" : "Zobrazit týdenní přírůstek jednotek", + "vcmi.otherOptions.creatureGrowthAsDwellingLabel.help" : "{Zobrazit týdenní přírůstek jednotek}\n\nZobrazit týdenní přírůstek jednotek místo dostupného počtu ke koupení v přehledu města (levý spodní okraj obrazovky města).", + "vcmi.otherOptions.compactTownCreatureInfo.hover": "Kompaktní informace o jednotkách", + "vcmi.otherOptions.compactTownCreatureInfo.help": "{Kompaktní informace o jednotkách}\n\nZobrazit menší informace o jednotkách města v jeho přehledu (levý spodní okraj obrazovky města).", + + "vcmi.townHall.missingBase" : "Základní budova %s musí být postavena jako první", + "vcmi.townHall.noCreaturesToRecruit" : "Žádné jednotky k vycvičení!", //TODO + "vcmi.townHall.greetingManaVortex" : "As you near the %s your body is filled with new energy. You have doubled your normal spell points.", + "vcmi.townHall.greetingKnowledge" : "You study the glyphs on the %s and gain insight into the workings of various magics (+1 Knowledge).", + "vcmi.townHall.greetingSpellPower" : "%s vás učí nové cesty zaměření vaší magické síly (+1 Síla kouzel).", + "vcmi.townHall.greetingExperience" : "Návštěva %s vás naučila spoustu nových dovedností (+1000 zkušeností).", + "vcmi.townHall.greetingAttack" : "Čas strávený poblíž místa zvaného %s allows you to learn more effective combat skills (+1 Attack Skill).", + "vcmi.townHall.greetingDefence" : "Spending time in the %s, the experienced warriors therein teach you additional defensive skills (+1 Defense).", + "vcmi.townHall.hasNotProduced" : "%s zatím nic nevyrobil.", + "vcmi.townHall.hasProduced" : "%s vyrobil %d %s tento týden.", + "vcmi.townHall.greetingCustomBonus" : "%s vám dává +%d %s%s", + "vcmi.townHall.greetingCustomUntil" : " do další bitvy.", + "vcmi.townHall.greetingInTownMagicWell" : "%s obnovil na maximum vaši magickou energii.", + + "vcmi.logicalExpressions.anyOf" : "Něco z následujících:", + "vcmi.logicalExpressions.allOf" : "Všechny následující:", + "vcmi.logicalExpressions.noneOf" : "Žádné z následujících:", + + "vcmi.heroWindow.openCommander.hover" : "Open commander info window", + "vcmi.heroWindow.openCommander.help" : "Shows details about the commander of this hero", + "vcmi.heroWindow.openBackpack.hover" : "Open artifact backpack window", + "vcmi.heroWindow.openBackpack.help" : "Opens window that allows easier artifact backpack management", + + "vcmi.commanderWindow.artifactMessage" : "Do you want to return this artifact to the hero?", + + "vcmi.creatureWindow.showBonuses.hover" : "Switch to bonuses view", + "vcmi.creatureWindow.showBonuses.help" : "Display all active bonuses of the commander", + "vcmi.creatureWindow.showSkills.hover" : "Switch to skills view", + "vcmi.creatureWindow.showSkills.help" : "Display all learned skills of the commander", + "vcmi.creatureWindow.returnArtifact.hover" : "Vrátit artefakt", + "vcmi.creatureWindow.returnArtifact.help" : "Klikněte na toto tlačítko pro navrácení artefaktů do hrdinova batohu", + + "vcmi.questLog.hideComplete.hover" : "Hide complete quests", + "vcmi.questLog.hideComplete.help" : "Hide all completed quests", + + "vcmi.randomMapTab.widgets.randomTemplate" : "(Random)", + "vcmi.randomMapTab.widgets.templateLabel" : "Šablona", + "vcmi.randomMapTab.widgets.teamAlignmentsButton" : "Setup...", + "vcmi.randomMapTab.widgets.teamAlignmentsLabel" : "Team Alignments", + "vcmi.randomMapTab.widgets.roadTypesLabel" : "Druhy cest", + + "vcmi.optionsTab.widgets.chessFieldBase.help" : "{Extra timer}\n\nStarts counting down when the {turn timer} reaches zero. It is set only once at the beginning of the game. When this timer reaches zero, the player's turn ends.", + "vcmi.optionsTab.widgets.chessFieldTurn.help" : "{Turn timer}\n\nStarts counting down when the player starts their turn on the adventure map. It is reset to its initial value at the start of each turn. Any unused turn time will be added to the {Extra timer} if it is in use.", + "vcmi.optionsTab.widgets.chessFieldBattle.help" : "{Battle timer}\n\nCounts down during battles when the {stack timer} reaches zero. It is reset to its initial value at the start of each battle. If the timer reaches zero, the currently active stack will defend.", + "vcmi.optionsTab.widgets.chessFieldCreature.help" : "{Stack timer}\n\nStarts counting down when the player is selecting an action for the current stack during battle. It resets to its initial value after the stack's action is completed.", + "vcmi.optionsTab.widgets.labelTimer" : "Časovač", + "vcmi.optionsTab.widgets.timerModeSwitch.classic" : "Klasický časovač", + "vcmi.optionsTab.widgets.timerModeSwitch.chess" : "Šachový časovač", + + + // Custom victory conditions for H3 campaigns and HotA maps + "vcmi.map.victoryCondition.daysPassed.toOthers" : "Nepřítel zvládl přežít do této chvíle. Vítězství je jeho!", + "vcmi.map.victoryCondition.daysPassed.toSelf" : "Gratulace! Zvládli jste přežít. Vítězství je vaše!", + "vcmi.map.victoryCondition.eliminateMonsters.toOthers" : "Nepřítel porazil všechny bojovníky zamořující tuto zemi a nárokuje si vítězství!", + "vcmi.map.victoryCondition.eliminateMonsters.toSelf" : "Gratulace! Porazili jste všechny nepřátele zamořující tuto zemi a můžete si nárokovat vítězství!", + "vcmi.map.victoryCondition.collectArtifacts.message" : "Získejte tři artefakty", + "vcmi.map.victoryCondition.angelicAlliance.toSelf" : "Gratulace! Všichni vaši nepřítelé byli poraženi a máte Andělskou alianci! Vítězství je vaše!", + "vcmi.map.victoryCondition.angelicAlliance.message" : "Porazte všechny nepřátele a vyrobte Andělskou alianci", + + // few strings from WoG used by vcmi + "vcmi.stackExperience.description" : "» S t a c k E x p e r i e n c e D e t a i l s «\n\nCreature Type ................... : %s\nExperience Rank ................. : %s (%i)\nExperience Points ............... : %i\nExperience Points to Next Rank .. : %i\nMaximum Experience per Battle ... : %i%% (%i)\nNumber of Creatures in stack .... : %i\nMaximum New Recruits\n without losing current Rank .... : %i\nExperience Multiplier ........... : %.2f\nUpgrade Multiplier .............. : %.2f\nExperience after Rank 10 ........ : %i\nMaximum New Recruits to remain at\n Rank 10 if at Maximum Experience : %i", + "vcmi.stackExperience.rank.0" : "Basic", + "vcmi.stackExperience.rank.1" : "Novice", + "vcmi.stackExperience.rank.2" : "Trained", + "vcmi.stackExperience.rank.3" : "Skilled", + "vcmi.stackExperience.rank.4" : "Proven", + "vcmi.stackExperience.rank.5" : "Veteran", + "vcmi.stackExperience.rank.6" : "Adept", + "vcmi.stackExperience.rank.7" : "Expert", + "vcmi.stackExperience.rank.8" : "Elite", + "vcmi.stackExperience.rank.9" : "Master", + "vcmi.stackExperience.rank.10" : "Ace", + + "core.bonus.ADDITIONAL_ATTACK.name": "Dvojitý úder", + "core.bonus.ADDITIONAL_ATTACK.description": "Útočí dvakrát", + "core.bonus.ADDITIONAL_RETALIATION.name": "Additional retaliations", + "core.bonus.ADDITIONAL_RETALIATION.description": "May retaliate ${val} extra times", + "core.bonus.AIR_IMMUNITY.name": "Vzdušná odolnost", + "core.bonus.AIR_IMMUNITY.description": "Immune to all spells from the school of Air magic", + "core.bonus.ATTACKS_ALL_ADJACENT.name": "Útok okolo", + "core.bonus.ATTACKS_ALL_ADJACENT.description": "Útočí na všechny sousední jednotky", + "core.bonus.BLOCKS_RETALIATION.name": "No retaliation", + "core.bonus.BLOCKS_RETALIATION.description": "Enemy cannot retaliate", + "core.bonus.BLOCKS_RANGED_RETALIATION.name": "No ranged retaliation", + "core.bonus.BLOCKS_RANGED_RETALIATION.description": "Enemy cannot retaliate by using a ranged attack", + "core.bonus.CATAPULT.name": "Katapult", + "core.bonus.CATAPULT.description": "Attacks siege walls", + "core.bonus.CHANGES_SPELL_COST_FOR_ALLY.name": "Reduce Casting Cost (${val})", + "core.bonus.CHANGES_SPELL_COST_FOR_ALLY.description": "Reduces the spellcasting cost for the hero by ${val}", + "core.bonus.CHANGES_SPELL_COST_FOR_ENEMY.name": "Magic Damper (${val})", + "core.bonus.CHANGES_SPELL_COST_FOR_ENEMY.description": "Increases spellcasting cost of enemy spells by ${val}", + "core.bonus.CHARGE_IMMUNITY.name": "Immune to Charge", + "core.bonus.CHARGE_IMMUNITY.description": "Immune to Cavalier's and Champion's Charge", + "core.bonus.DARKNESS.name": "Darkness cover", + "core.bonus.DARKNESS.description": "Creates a shroud of darkness with a ${val} radius", + "core.bonus.DEATH_STARE.name": "Death Stare (${val}%)", + "core.bonus.DEATH_STARE.description": "Has a ${val}% chance to kill a single creature", + "core.bonus.DEFENSIVE_STANCE.name": "Defense Bonus", + "core.bonus.DEFENSIVE_STANCE.description": "+${val} Defense when defending", + "core.bonus.DESTRUCTION.name": "Destruction", + "core.bonus.DESTRUCTION.description": "Has ${val}% chance to kill extra units after attack", + "core.bonus.DOUBLE_DAMAGE_CHANCE.name": "Death Blow", + "core.bonus.DOUBLE_DAMAGE_CHANCE.description": "Has a ${val}% chance of dealing double base damage when attacking", + "core.bonus.DRAGON_NATURE.name": "Drak", + "core.bonus.DRAGON_NATURE.description": "Creature has a Dragon Nature", + "core.bonus.EARTH_IMMUNITY.name": "Zemní odolnost", + "core.bonus.EARTH_IMMUNITY.description": "Immune to all spells from the school of Earth magic", + "core.bonus.ENCHANTER.name": "Enchanter", + "core.bonus.ENCHANTER.description": "Can cast mass ${subtype.spell} every turn", + "core.bonus.ENCHANTED.name": "Enchanted", + "core.bonus.ENCHANTED.description": "Affected by permanent ${subtype.spell}", + "core.bonus.ENEMY_DEFENCE_REDUCTION.name": "Ignore Defense (${val}%)", + "core.bonus.ENEMY_DEFENCE_REDUCTION.description": "When attacking, ${val}% of the defender's defense is ignored", + "core.bonus.FIRE_IMMUNITY.name": "Ohnivá odolnost", + "core.bonus.FIRE_IMMUNITY.description": "Immune to all spells from the school of Fire magic", + "core.bonus.FIRE_SHIELD.name": "Ohnivý štít (${val}%)", + "core.bonus.FIRE_SHIELD.description": "Reflects part of melee damage", + "core.bonus.FIRST_STRIKE.name": "First Strike", + "core.bonus.FIRST_STRIKE.description": "This creature retaliates before being attacked", + "core.bonus.FEAR.name": "Fear", + "core.bonus.FEAR.description": "Causes Fear on an enemy stack", + "core.bonus.FEARLESS.name": "Nebojácnost", + "core.bonus.FEARLESS.description": "Odolnost proti strachu", + "core.bonus.FLYING.name": "Letec", + "core.bonus.FLYING.description": "Při pohybu létá (přes překážky)", + "core.bonus.FREE_SHOOTING.name": "Blízké výstřely", + "core.bonus.FREE_SHOOTING.description": "Může použít výstřely při útoku zblízka", + "core.bonus.GARGOYLE.name": "Gargoyle", + "core.bonus.GARGOYLE.description": "Cannot be raised or healed", + "core.bonus.GENERAL_DAMAGE_REDUCTION.name": "Reduce Damage (${val}%)", + "core.bonus.GENERAL_DAMAGE_REDUCTION.description": "Reduces physical damage from ranged or melee attacks", + "core.bonus.HATE.name": "Nesnáší ${subtype.creature}", + "core.bonus.HATE.description": "Does ${val}% more damage to ${subtype.creature}", + "core.bonus.HEALER.name": "Léčitel", + "core.bonus.HEALER.description": "Léčí spojenecké jednotky", + "core.bonus.HP_REGENERATION.name": "Regenerace", + "core.bonus.HP_REGENERATION.description": "Každé kolo léčí ${val} životů", + "core.bonus.JOUSTING.name": "Champion charge", + "core.bonus.JOUSTING.description": "+${val}% damage for each hex travelled", + "core.bonus.KING.name": "Král", + "core.bonus.KING.description": "Vulnerable to SLAYER level ${val} or higher", + "core.bonus.LEVEL_SPELL_IMMUNITY.name": "Spell immunity 1-${val}", + "core.bonus.LEVEL_SPELL_IMMUNITY.description": "Immune to spells of levels 1-${val}", + "core.bonus.LIMITED_SHOOTING_RANGE.name" : "Limited shooting range", + "core.bonus.LIMITED_SHOOTING_RANGE.description" : "Unable to target units farther than ${val} hexes", + "core.bonus.LIFE_DRAIN.name": "Vysátí životů (${val}%)", + "core.bonus.LIFE_DRAIN.description": "Vysaje ${val}% uděleného poškození", + "core.bonus.MANA_CHANNELING.name": "Magic Channel ${val}%", + "core.bonus.MANA_CHANNELING.description": "Gives your hero ${val}% of the mana spent by the enemy", + "core.bonus.MANA_DRAIN.name": "Vysátí many", + "core.bonus.MANA_DRAIN.description": "Každé kolo vysaje ${val} many", + "core.bonus.MAGIC_MIRROR.name": "Kouzelné zrcadlo (${val}%)", + "core.bonus.MAGIC_MIRROR.description": "Has a ${val}% chance to redirect an offensive spell to an enemy unit", + "core.bonus.MAGIC_RESISTANCE.name": "Magic Resistance (${val}%)", + "core.bonus.MAGIC_RESISTANCE.description": "Has a ${val}% chance to resist an enemy spell", + "core.bonus.MIND_IMMUNITY.name": "Mind Spell Immunity", + "core.bonus.MIND_IMMUNITY.description": "Immune to Mind-type spells", + "core.bonus.NO_DISTANCE_PENALTY.name": "No distance penalty", + "core.bonus.NO_DISTANCE_PENALTY.description": "Does full damage at any distance", + "core.bonus.NO_MELEE_PENALTY.name": "No melee penalty", + "core.bonus.NO_MELEE_PENALTY.description": "Creature has no Melee Penalty", + "core.bonus.NO_MORALE.name": "Neutral Morale", + "core.bonus.NO_MORALE.description": "Creature is immune to morale effects", + "core.bonus.NO_WALL_PENALTY.name": "No wall penalty", + "core.bonus.NO_WALL_PENALTY.description": "Full damage during siege", + "core.bonus.NON_LIVING.name": "Non living", + "core.bonus.NON_LIVING.description": "Immunity to many effects", + "core.bonus.RANDOM_SPELLCASTER.name": "Random spellcaster", + "core.bonus.RANDOM_SPELLCASTER.description": "Can cast random spell", + "core.bonus.RANGED_RETALIATION.name": "Ranged retaliation", + "core.bonus.RANGED_RETALIATION.description": "Can perform ranged counterattack", + "core.bonus.RECEPTIVE.name": "Receptive", + "core.bonus.RECEPTIVE.description": "No Immunity to Friendly Spells", + "core.bonus.REBIRTH.name": "Rebirth (${val}%)", + "core.bonus.REBIRTH.description": "${val}% of stack will rise after death", + "core.bonus.RETURN_AFTER_STRIKE.name": "Attack and Return", + "core.bonus.RETURN_AFTER_STRIKE.description": "Returns after melee attack", + "core.bonus.SHOOTER.name": "Ranged", + "core.bonus.SHOOTER.description": "Creature can shoot", + "core.bonus.SHOOTS_ALL_ADJACENT.name": "Shoot all around", + "core.bonus.SHOOTS_ALL_ADJACENT.description": "This creature's ranged attacks strike all targets in a small area", + "core.bonus.SOUL_STEAL.name": "Soul Steal", + "core.bonus.SOUL_STEAL.description": "Gains ${val} new creatures for each enemy killed", + "core.bonus.SPELLCASTER.name": "Spellcaster", + "core.bonus.SPELLCASTER.description": "Can cast ${subtype.spell}", + "core.bonus.SPELL_AFTER_ATTACK.name": "Cast After Attack", + "core.bonus.SPELL_AFTER_ATTACK.description": "Has a ${val}% chance to cast ${subtype.spell} after it attacks", + "core.bonus.SPELL_BEFORE_ATTACK.name": "Cast Before Attack", + "core.bonus.SPELL_BEFORE_ATTACK.description": "Has a ${val}% chance to cast ${subtype.spell} before it attacks", + "core.bonus.SPELL_DAMAGE_REDUCTION.name": "Spell Resistance", + "core.bonus.SPELL_DAMAGE_REDUCTION.description": "Damage from spells reduced by ${val}%.", + "core.bonus.SPELL_IMMUNITY.name": "Odolnost vůči kouzlům", + "core.bonus.SPELL_IMMUNITY.description": "Odolnost proti ${subtype.spell}", + "core.bonus.SPELL_LIKE_ATTACK.name": "Spell-like attack", + "core.bonus.SPELL_LIKE_ATTACK.description": "Attacks with ${subtype.spell}", + "core.bonus.SPELL_RESISTANCE_AURA.name": "Aura of Resistance", + "core.bonus.SPELL_RESISTANCE_AURA.description": "Nearby stacks get ${val}% magic resistance", + "core.bonus.SUMMON_GUARDIANS.name": "Summon guardians", + "core.bonus.SUMMON_GUARDIANS.description": "At the start of battle summons ${subtype.creature} (${val}%)", + "core.bonus.SYNERGY_TARGET.name": "Synergizable", + "core.bonus.SYNERGY_TARGET.description": "This creature is vulnerable to synergy effect", + "core.bonus.TWO_HEX_ATTACK_BREATH.name": "Breath", + "core.bonus.TWO_HEX_ATTACK_BREATH.description": "Breath Attack (2-hex range)", + "core.bonus.THREE_HEADED_ATTACK.name": "Three-headed attack", + "core.bonus.THREE_HEADED_ATTACK.description": "Attacks three adjacent units", + "core.bonus.TRANSMUTATION.name": "Transmutation", + "core.bonus.TRANSMUTATION.description": "${val}% chance to transform attacked unit to a different type", + "core.bonus.UNDEAD.name": "Nemrtvý", + "core.bonus.UNDEAD.description": "Jednotka je nemrtvá", + "core.bonus.UNLIMITED_RETALIATIONS.name": "Unlimited retaliations", + "core.bonus.UNLIMITED_RETALIATIONS.description": "Can retaliate against an unlimited number of attacks", + "core.bonus.WATER_IMMUNITY.name": "Water immunity", + "core.bonus.WATER_IMMUNITY.description": "Immune to all spells from the school of Water magic", + "core.bonus.WIDE_BREATH.name": "Wide breath", + "core.bonus.WIDE_BREATH.description": "Wide breath attack (multiple hexes)" +} diff --git a/Mods/vcmi/config/vcmi/english.json b/Mods/vcmi/config/vcmi/english.json index 26eecc0ba..315011511 100644 --- a/Mods/vcmi/config/vcmi/english.json +++ b/Mods/vcmi/config/vcmi/english.json @@ -31,7 +31,7 @@ "vcmi.capitalColors.7" : "Pink", "vcmi.radialWheel.mergeSameUnit" : "Merge same creatures", - "vcmi.radialWheel.showUnitInformation" : "Show creature information", + "vcmi.radialWheel.fillSingleUnit" : "Fill with single creatures", "vcmi.radialWheel.splitSingleUnit" : "Split off single creature", "vcmi.radialWheel.splitUnitEqually" : "Split creatures equally", "vcmi.radialWheel.moveUnit" : "Move creatures to another army", @@ -173,6 +173,8 @@ "vcmi.heroWindow.openCommander.hover" : "Open commander info window", "vcmi.heroWindow.openCommander.help" : "Shows details about the commander of this hero", + "vcmi.heroWindow.openBackpack.hover" : "Open artifact backpack window", + "vcmi.heroWindow.openBackpack.help" : "Opens window that allows easier artifact backpack management", "vcmi.commanderWindow.artifactMessage" : "Do you want to return this artifact to the hero?", diff --git a/Mods/vcmi/config/vcmi/german.json b/Mods/vcmi/config/vcmi/german.json index 3a1694cc7..b2a92ce4b 100644 --- a/Mods/vcmi/config/vcmi/german.json +++ b/Mods/vcmi/config/vcmi/german.json @@ -31,7 +31,6 @@ "vcmi.capitalColors.7" : "Rosa", "vcmi.radialWheel.mergeSameUnit" : "Gleiche Kreaturen zusammenführen", - "vcmi.radialWheel.showUnitInformation" : "Informationen zur Kreatur anzeigen", "vcmi.radialWheel.splitSingleUnit" : "Wegtrennen einzelner Kreaturen", "vcmi.radialWheel.splitUnitEqually" : "Gleichmäßiges trennen der Kreaturen", "vcmi.radialWheel.moveUnit" : "Verschieben der Kreatur in andere Armee", diff --git a/Mods/vcmi/config/vcmi/polish.json b/Mods/vcmi/config/vcmi/polish.json index c6a5f4231..9f175e83e 100644 --- a/Mods/vcmi/config/vcmi/polish.json +++ b/Mods/vcmi/config/vcmi/polish.json @@ -31,7 +31,6 @@ "vcmi.capitalColors.7" : "Różowy", "vcmi.radialWheel.mergeSameUnit" : "Złącz takie same stworzenia", - "vcmi.radialWheel.showUnitInformation" : "Pokaż informacje o stworzeniu", "vcmi.radialWheel.splitSingleUnit" : "Wydziel pojedyncze stworzenie", "vcmi.radialWheel.splitUnitEqually" : "Podziel stworzenia równo", "vcmi.radialWheel.moveUnit" : "Przenieś stworzenia do innej armii", @@ -173,6 +172,8 @@ "vcmi.heroWindow.openCommander.hover" : "Otwórz okno dowódcy", "vcmi.heroWindow.openCommander.help" : "Wyświetla informacje o dowódcy przynależącym do tego bohatera", + "vcmi.heroWindow.openBackpack.hover" : "Otwórz okno sakwy", + "vcmi.heroWindow.openBackpack.help" : "Otwiera okno pozwalające łatwiej zarządzać artefaktami w sakwie", "vcmi.commanderWindow.artifactMessage" : "Czy chcesz zwrócić ten artefakt bohaterowi?", diff --git a/Mods/vcmi/config/vcmi/ukrainian.json b/Mods/vcmi/config/vcmi/ukrainian.json index e4d03e423..b41fe68cc 100644 --- a/Mods/vcmi/config/vcmi/ukrainian.json +++ b/Mods/vcmi/config/vcmi/ukrainian.json @@ -31,7 +31,7 @@ "vcmi.capitalColors.7" : "Рожевий", "vcmi.radialWheel.mergeSameUnit" : "Об'єднати однакових істот", - "vcmi.radialWheel.showUnitInformation" : "Показати відомості про істоту", + "vcmi.radialWheel.fillSingleUnit" : "Заповнити одиничними істотами", "vcmi.radialWheel.splitSingleUnit" : "Відділити одну істоту", "vcmi.radialWheel.splitUnitEqually" : "Розділити істот порівну", "vcmi.radialWheel.moveUnit" : "Перемістити істоту до іншої армії", @@ -173,6 +173,8 @@ "vcmi.heroWindow.openCommander.hover" : "Відкрити вікно командира", "vcmi.heroWindow.openCommander.help" : "Показує інформацію про командира героя", + "vcmi.heroWindow.openBackpack.hover" : "Відкрити вікно рюкзака з артефактами", + "vcmi.heroWindow.openBackpack.help" : "Відкриває вікно, що дозволяє легше керувати рюкзаком артефактів", "vcmi.commanderWindow.artifactMessage" : "Бажаєте передати цей артефакт герою?", diff --git a/Mods/vcmi/mod.json b/Mods/vcmi/mod.json index 0a0702f0b..cf65ef8df 100644 --- a/Mods/vcmi/mod.json +++ b/Mods/vcmi/mod.json @@ -12,6 +12,16 @@ ] }, + "czech" : { + "name" : "Nezbytné soubory VCMI", + "description" : "Nezbytné soubory pro správný běh VCMI", + + "skipValidation" : true, + "translations" : [ + "config/vcmi/czech.json" + ] + }, + "french" : { "name" : "VCMI - fichiers nécessaires", "description" : "Fichiers nécessaires pour exécuter correctement VCMI", diff --git a/README.md b/README.md deleted file mode 100644 index b635ac00c..000000000 --- a/README.md +++ /dev/null @@ -1,45 +0,0 @@ -[![GitHub](https://github.com/vcmi/vcmi/actions/workflows/github.yml/badge.svg)](https://github.com/vcmi/vcmi/actions/workflows/github.yml) -[![Coverity Scan Build Status](https://scan.coverity.com/projects/vcmi/badge.svg)](https://scan.coverity.com/projects/vcmi) -[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.3.0/total)](https://github.com/vcmi/vcmi/releases/tag/1.3.0) -[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.3.1/total)](https://github.com/vcmi/vcmi/releases/tag/1.3.1) -[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/total)](https://github.com/vcmi/vcmi/releases) -# VCMI Project -VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities. - -## Links - - * Homepage: https://vcmi.eu/ - * Wiki: https://wiki.vcmi.eu/ - * Forums: https://forum.vcmi.eu/ - * Bugtracker: https://github.com/vcmi/vcmi/issues - * Slack: https://slack.vcmi.eu/ - * Discord: https://discord.gg/chBT42V - -## Installation guides - -To use VCMI you need to own original data files. - - * [Android](https://wiki.vcmi.eu/Installation_on_Android) - * [Linux](https://wiki.vcmi.eu/Installation_on_Linux) - * [macOS](https://wiki.vcmi.eu/Installation_on_macOS) - * [Windows](https://wiki.vcmi.eu/Installation_on_Windows) - * [iOS](https://wiki.vcmi.eu/Installation_on_iOS) - -## Building from source - -Platform support is constantly tested by continuous integration and CMake configuration adjusted to generate nice looking projects for all major IDE. Following guides will help you to setup build environment with no effort: - - * (optional) All platforms: [using Conan package manager to obtain prebuilt dependencies](docs/conan.md) - * [On Linux](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux)) - * [On Linux for Windows with Conan and mingw](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux/Cmake/Conan)) - * [On macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(macOS)) - * [On Windows using MSVC and Vcpkg](https://wiki.vcmi.eu/How_to_build_VCMI_(Windows/Vcpkg)) - * [iOS on macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(iOS)) - * [Android on any OS](https://wiki.vcmi.eu/How_to_build_VCMI_(Android)) - -## Copyright and license - -VCMI Project source code is licensed under GPL version 2 or later. -VCMI Project assets are licensed under CC-BY-SA 4.0. Assets sources and information about contributors are available under following link: [https://github.com/vcmi/vcmi-assets] - -Copyright (C) 2007-2023 VCMI Team (check AUTHORS file for the contributors list) diff --git a/android/vcmi-app/build.gradle b/android/vcmi-app/build.gradle index 0da7e2b64..ed44fba0b 100644 --- a/android/vcmi-app/build.gradle +++ b/android/vcmi-app/build.gradle @@ -10,7 +10,7 @@ android { applicationId "is.xyz.vcmi" minSdk 19 targetSdk 33 - versionCode 1311 + versionCode 1320 versionName "1.3.1" setProperty("archivesBaseName", "vcmi") } diff --git a/android/vcmi-app/src/main/res/mipmap-hdpi/ic_launcher.png b/android/vcmi-app/src/main/res/mipmap-hdpi/ic_launcher.png index 0112f0583..4adf6a8e4 100644 Binary files a/android/vcmi-app/src/main/res/mipmap-hdpi/ic_launcher.png and b/android/vcmi-app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/android/vcmi-app/src/main/res/mipmap-mdpi/ic_launcher.png b/android/vcmi-app/src/main/res/mipmap-mdpi/ic_launcher.png index 4c6c239af..1e59f556d 100644 Binary files a/android/vcmi-app/src/main/res/mipmap-mdpi/ic_launcher.png and b/android/vcmi-app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/android/vcmi-app/src/main/res/mipmap-xhdpi/ic_launcher.png b/android/vcmi-app/src/main/res/mipmap-xhdpi/ic_launcher.png index 308b6da28..46c1851ea 100644 Binary files a/android/vcmi-app/src/main/res/mipmap-xhdpi/ic_launcher.png and b/android/vcmi-app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/android/vcmi-app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/android/vcmi-app/src/main/res/mipmap-xxhdpi/ic_launcher.png index 03c68efa7..929de2aaf 100644 Binary files a/android/vcmi-app/src/main/res/mipmap-xxhdpi/ic_launcher.png and b/android/vcmi-app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/android/vcmi-app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/android/vcmi-app/src/main/res/mipmap-xxxhdpi/ic_launcher.png index ecbf76a7a..5a63d09d6 100644 Binary files a/android/vcmi-app/src/main/res/mipmap-xxxhdpi/ic_launcher.png and b/android/vcmi-app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/android/vcmi-app/src/main/res/values/strings.xml b/android/vcmi-app/src/main/res/values/strings.xml index a44b781b6..6affdbcc3 100644 --- a/android/vcmi-app/src/main/res/values/strings.xml +++ b/android/vcmi-app/src/main/res/values/strings.xml @@ -3,7 +3,7 @@ https://vcmi.eu https://github.com/vcmi/vcmi https://github.com/vcmi/vcmi-android - https://github.com/vcmi/vcmi/wiki/VCMI-App-Privacy-Policy + https://github.com/vcmi/vcmi/blob/master/docs/players/Privacy_Policy.md VCMI VCMI Server diff --git a/client/CMakeLists.txt b/client/CMakeLists.txt index e67d803e1..81debb398 100644 --- a/client/CMakeLists.txt +++ b/client/CMakeLists.txt @@ -457,6 +457,7 @@ endif() if(NOT WIN32 AND NOT APPLE AND NOT ANDROID) #FIXME: move to client makefile? install(FILES "${CMAKE_SOURCE_DIR}/client/icons/vcmiclient.16x16.png" DESTINATION share/icons/hicolor/16x16/apps RENAME vcmiclient.png) + install(FILES "${CMAKE_SOURCE_DIR}/client/icons/vcmiclient.22x22.png" DESTINATION share/icons/hicolor/22x22/apps RENAME vcmiclient.png) install(FILES "${CMAKE_SOURCE_DIR}/client/icons/vcmiclient.32x32.png" DESTINATION share/icons/hicolor/32x32/apps RENAME vcmiclient.png) install(FILES "${CMAKE_SOURCE_DIR}/client/icons/vcmiclient.48x48.png" DESTINATION share/icons/hicolor/48x48/apps RENAME vcmiclient.png) install(FILES "${CMAKE_SOURCE_DIR}/client/icons/vcmiclient.64x64.png" DESTINATION share/icons/hicolor/64x64/apps RENAME vcmiclient.png) diff --git a/client/CPlayerInterface.cpp b/client/CPlayerInterface.cpp index 69fde8c7b..824b97b07 100644 --- a/client/CPlayerInterface.cpp +++ b/client/CPlayerInterface.cpp @@ -476,9 +476,6 @@ void CPlayerInterface::heroManaPointsChanged(const CGHeroInstance * hero) adventureInt->onHeroChanged(hero); if (makingTurn && hero->tempOwner == playerID) adventureInt->onHeroChanged(hero); - - for (auto window : GH.windows().findWindows()) - window->heroManaPointsChanged(hero); } void CPlayerInterface::heroMovePointsChanged(const CGHeroInstance * hero) { @@ -662,7 +659,11 @@ void CPlayerInterface::battleStart(const CCreatureSet *army1, const CCreatureSet if ((replayAllowed && useQuickCombat) || forceQuickCombat) { autofightingAI = CDynLibHandler::getNewBattleAI(settings["server"]["friendlyAI"].String()); - autofightingAI->initBattleInterface(env, cb); + + AutocombatPreferences autocombatPreferences = AutocombatPreferences(); + autocombatPreferences.enableSpellsUsage = settings["battle"]["enableAutocombatSpells"].Bool(); + + autofightingAI->initBattleInterface(env, cb, autocombatPreferences); autofightingAI->battleStart(army1, army2, tile, hero1, hero2, side, false); isAutoFightOn = true; cb->registerBattleInterface(autofightingAI); @@ -897,6 +898,12 @@ void CPlayerInterface::battleTriggerEffect (const BattleTriggerEffect & bte) RETURN_IF_QUICK_COMBAT; battleInt->effectsController->battleTriggerEffect(bte); + + if(bte.effect == vstd::to_underlying(BonusType::MANA_DRAIN)) + { + const CGHeroInstance * manaDrainedHero = LOCPLINT->cb->getHero(ObjectInstanceID(bte.additionalInfo)); + battleInt->windowObject->heroManaPointsChanged(manaDrainedHero); + } } void CPlayerInterface::battleStacksAttacked(const std::vector & bsa, bool ranged) { @@ -1611,15 +1618,6 @@ void CPlayerInterface::gameOver(PlayerColor player, const EVictoryLossCheckResul if (GH.curInt == this) GH.curInt = nullptr; } - else - { - if (victoryLossCheckResult.loss() && cb->getPlayerStatus(playerID) == EPlayerStatus::INGAME) //enemy has lost - { - MetaString message = victoryLossCheckResult.messageToSelf; - message.appendLocalString(EMetaText::COLOR, player.getNum()); - showInfoDialog(message.toString(), std::vector>(1, std::make_shared(CComponent::flag, player.getNum(), 0))); - } - } } void CPlayerInterface::playerBonusChanged( const Bonus &bonus, bool gain ) @@ -2009,13 +2007,13 @@ void CPlayerInterface::doMoveHero(const CGHeroInstance * h, CGPath path) auto canStop = [&](CGPathNode * node) -> bool { - if (node->layer == EPathfindingLayer::LAND || node->layer == EPathfindingLayer::SAIL) - return true; + if (node->layer != EPathfindingLayer::LAND && node->layer != EPathfindingLayer::SAIL) + return false; - if (node->accessible == EPathAccessibility::ACCESSIBLE) - return true; + if (node->accessible != EPathAccessibility::ACCESSIBLE) + return false; - return false; + return true; }; for (i=(int)path.nodes.size()-1; i>0 && (stillMoveHero.data == CONTINUE_MOVE || !canStop(&path.nodes[i])); i--) diff --git a/client/CServerHandler.cpp b/client/CServerHandler.cpp index 7a21a5b84..b2fc6f70f 100644 --- a/client/CServerHandler.cpp +++ b/client/CServerHandler.cpp @@ -573,17 +573,35 @@ void CServerHandler::sendRestartGame() const sendLobbyPack(endGame); } -void CServerHandler::sendStartGame(bool allowOnlyAI) const +bool CServerHandler::validateGameStart(bool allowOnlyAI) const { try { verifyStateBeforeStart(allowOnlyAI ? true : settings["session"]["onlyai"].Bool()); } - catch (const std::exception & e) + catch(CModHandler::Incompatibility & e) { - showServerError( std::string("Unable to start map! Reason: ") + e.what()); - return; + logGlobal->warn("Incompatibility exception during start scenario: %s", e.what()); + + auto errorMsg = CGI->generaltexth->translate("vcmi.server.errors.modsIncompatibility") + '\n'; + errorMsg += e.what(); + + showServerError(errorMsg); + return false; } + catch(std::exception & e) + { + logGlobal->error("Exception during startScenario: %s", e.what()); + showServerError( std::string("Unable to start map! Reason: ") + e.what()); + return false; + } + + return true; +} + +void CServerHandler::sendStartGame(bool allowOnlyAI) const +{ + verifyStateBeforeStart(allowOnlyAI ? true : settings["session"]["onlyai"].Bool()); LobbyStartGame lsg; if(client) @@ -708,7 +726,7 @@ void CServerHandler::startCampaignScenario(std::shared_ptr cs) }); } -void CServerHandler::showServerError(std::string txt) const +void CServerHandler::showServerError(const std::string & txt) const { CInfoWindow::showInfoDialog(txt, {}); } diff --git a/client/CServerHandler.h b/client/CServerHandler.h index 4b3e61c65..1b4f712de 100644 --- a/client/CServerHandler.h +++ b/client/CServerHandler.h @@ -148,16 +148,18 @@ public: void sendRestartGame() const override; void sendStartGame(bool allowOnlyAI = false) const override; + bool validateGameStart(bool allowOnlyAI = false) const; + void debugStartTest(std::string filename, bool save = false); + void startGameplay(VCMI_LIB_WRAP_NAMESPACE(CGameState) * gameState = nullptr); void endGameplay(bool closeConnection = true, bool restart = false); void startCampaignScenario(std::shared_ptr cs = {}); - void showServerError(std::string txt) const; + void showServerError(const std::string & txt) const; // TODO: LobbyState must be updated within game so we should always know how many player interfaces our client handle int howManyPlayerInterfaces(); ui8 getLoadMode(); - void debugStartTest(std::string filename, bool save = false); void restoreLastSession(); void visitForLobby(CPackForLobby & lobbyPack); diff --git a/client/NetPacksClient.cpp b/client/NetPacksClient.cpp index c2f89316f..422aa3481 100644 --- a/client/NetPacksClient.cpp +++ b/client/NetPacksClient.cpp @@ -17,7 +17,9 @@ #include "mapView/mapHandler.h" #include "adventureMap/CInGameConsole.h" #include "battle/BattleInterface.h" +#include "battle/BattleWindow.h" #include "gui/CGuiHandler.h" +#include "gui/WindowHandler.h" #include "widgets/MiscWidgets.h" #include "CMT.h" #include "CServerHandler.h" @@ -153,6 +155,9 @@ void ApplyClientNetPackVisitor::visitSetMana(SetMana & pack) { const CGHeroInstance *h = cl.getHero(pack.hid); callInterfaceIfPresent(cl, h->tempOwner, &IGameEventsReceiver::heroManaPointsChanged, h); + + for (auto window : GH.windows().findWindows()) + window->heroManaPointsChanged(h); } void ApplyClientNetPackVisitor::visitSetMovePoints(SetMovePoints & pack) diff --git a/client/NetPacksLobbyClient.cpp b/client/NetPacksLobbyClient.cpp index 3a153006f..1f037e776 100644 --- a/client/NetPacksLobbyClient.cpp +++ b/client/NetPacksLobbyClient.cpp @@ -102,7 +102,10 @@ void ApplyOnLobbyHandlerNetPackVisitor::visitLobbyEndGame(LobbyEndGame & pack) } if(pack.restart) - handler.sendStartGame(); + { + if (handler.validateGameStart()) + handler.sendStartGame(); + } } void ApplyOnLobbyHandlerNetPackVisitor::visitLobbyStartGame(LobbyStartGame & pack) diff --git a/client/PlayerLocalState.cpp b/client/PlayerLocalState.cpp index e731cff16..6ace13258 100644 --- a/client/PlayerLocalState.cpp +++ b/client/PlayerLocalState.cpp @@ -68,7 +68,10 @@ bool PlayerLocalState::setPath(const CGHeroInstance * h, const int3 & destinatio { CGPath path; if(!owner.cb->getPathsInfo(h)->getPath(path, destination)) + { + paths.erase(h); //invalidate previously possible path if selected (before other hero blocked only path / fly spell expired) return false; + } setPath(h, path); return true; diff --git a/client/adventureMap/AdventureMapShortcuts.cpp b/client/adventureMap/AdventureMapShortcuts.cpp index 3fb44f0dc..38193b405 100644 --- a/client/adventureMap/AdventureMapShortcuts.cpp +++ b/client/adventureMap/AdventureMapShortcuts.cpp @@ -397,12 +397,12 @@ void AdventureMapShortcuts::moveHeroDirectional(const Point & direction) bool AdventureMapShortcuts::optionCanViewQuests() { - return optionInMapView() && CGI->mh->getMap()->quests.empty(); + return optionInMapView() && !CGI->mh->getMap()->quests.empty(); } bool AdventureMapShortcuts::optionCanToggleLevel() { - return optionInMapView() && LOCPLINT->cb->getMapSize().z > 1; + return optionSidePanelActive() && LOCPLINT->cb->getMapSize().z > 1; } bool AdventureMapShortcuts::optionMapLevelSurface() diff --git a/client/adventureMap/AdventureMapWidget.cpp b/client/adventureMap/AdventureMapWidget.cpp index b8f50dcd4..65e1230be 100644 --- a/client/adventureMap/AdventureMapWidget.cpp +++ b/client/adventureMap/AdventureMapWidget.cpp @@ -372,11 +372,15 @@ void AdventureMapWidget::setPlayerChildren(CIntObject * widget, const PlayerColo auto container = dynamic_cast(entry); auto icon = dynamic_cast(entry); auto button = dynamic_cast(entry); + auto resDataBar = dynamic_cast(entry); auto texture = dynamic_cast(entry); if(button) button->setPlayerColor(player); + if(resDataBar) + resDataBar->colorize(player); + if(icon) icon->setPlayer(player); diff --git a/client/battle/BattleActionsController.cpp b/client/battle/BattleActionsController.cpp index 1ccdbf10f..8c525c072 100644 --- a/client/battle/BattleActionsController.cpp +++ b/client/battle/BattleActionsController.cpp @@ -24,6 +24,7 @@ #include "../gui/CIntObject.h" #include "../gui/WindowHandler.h" #include "../windows/CCreatureWindow.h" +#include "../windows/InfoWindows.h" #include "../../CCallback.h" #include "../../lib/CConfigHandler.h" @@ -215,7 +216,7 @@ std::vector BattleActionsController::getPossibleActi return std::vector(allActions); } -void BattleActionsController::reorderPossibleActionsPriority(const CStack * stack, MouseHoveredHexContext context) +void BattleActionsController::reorderPossibleActionsPriority(const CStack * stack, const CStack * targetStack) { if(owner.tacticsMode || possibleActions.empty()) return; //this function is not supposed to be called in tactics mode or before getPossibleActionsForStack @@ -229,10 +230,17 @@ void BattleActionsController::reorderPossibleActionsPriority(const CStack * stac case PossiblePlayerBattleAction::NO_LOCATION: case PossiblePlayerBattleAction::FREE_LOCATION: case PossiblePlayerBattleAction::OBSTACLE: - if(!stack->hasBonusOfType(BonusType::NO_SPELLCAST_BY_DEFAULT) && context == MouseHoveredHexContext::OCCUPIED_HEX) - return 1; - else - return 100; //bottom priority + if(!stack->hasBonusOfType(BonusType::NO_SPELLCAST_BY_DEFAULT) && targetStack != nullptr) + { + PlayerColor stackOwner = owner.curInt->cb->battleGetOwner(targetStack); + bool enemyTargetingPositiveSpellcast = item.spell().toSpell()->isPositive() && stackOwner != LOCPLINT->playerID; + bool friendTargetingNegativeSpellcast = item.spell().toSpell()->isNegative() && stackOwner == LOCPLINT->playerID; + + if(!enemyTargetingPositiveSpellcast && !friendTargetingNegativeSpellcast) + return 1; + } + return 100; //bottom priority + break; case PossiblePlayerBattleAction::RANDOM_GENIE_SPELL: return 2; @@ -600,10 +608,10 @@ bool BattleActionsController::actionIsLegal(PossiblePlayerBattleAction action, B return false; case PossiblePlayerBattleAction::ANY_LOCATION: - return isCastingPossibleHere(action.spell().toSpell(), targetStack, targetHex); + return isCastingPossibleHere(action.spell().toSpell(), nullptr, targetHex); case PossiblePlayerBattleAction::AIMED_SPELL_CREATURE: - return !selectedStack && targetStack && isCastingPossibleHere(action.spell().toSpell(), targetStack, targetHex); + return !selectedStack && targetStack && isCastingPossibleHere(action.spell().toSpell(), nullptr, targetHex); case PossiblePlayerBattleAction::RANDOM_GENIE_SPELL: if(targetStack && targetStackOwned && targetStack != owner.stacksController->getActiveStack() && targetStack->alive()) //only positive spells for other allied creatures @@ -621,7 +629,7 @@ bool BattleActionsController::actionIsLegal(PossiblePlayerBattleAction action, B case PossiblePlayerBattleAction::OBSTACLE: case PossiblePlayerBattleAction::FREE_LOCATION: - return isCastingPossibleHere(action.spell().toSpell(), targetStack, targetHex); + return isCastingPossibleHere(action.spell().toSpell(), nullptr, targetHex); case PossiblePlayerBattleAction::CATAPULT: return owner.siegeController && owner.siegeController->isAttackableByCatapult(targetHex); @@ -788,7 +796,7 @@ PossiblePlayerBattleAction BattleActionsController::selectAction(BattleHex targe const CStack * targetStack = getStackForHex(targetHex); - reorderPossibleActionsPriority(owner.stacksController->getActiveStack(), targetStack ? MouseHoveredHexContext::OCCUPIED_HEX : MouseHoveredHexContext::UNOCCUPIED_HEX); + reorderPossibleActionsPriority(owner.stacksController->getActiveStack(), targetStack); for (PossiblePlayerBattleAction action : possibleActions) { @@ -972,6 +980,11 @@ void BattleActionsController::activateStack() case PossiblePlayerBattleAction::AIMED_SPELL_CREATURE: actionsToSelect.push_back(possibleActions.front()); + actionsToSelect.push_back(PossiblePlayerBattleAction::ATTACK); + break; + case PossiblePlayerBattleAction::ANY_LOCATION: + actionsToSelect.push_back(possibleActions.front()); + actionsToSelect.push_back(PossiblePlayerBattleAction::ATTACK); break; } } @@ -981,8 +994,19 @@ void BattleActionsController::activateStack() void BattleActionsController::onHexRightClicked(BattleHex clickedHex) { - if (spellcastingModeActive()) + auto spellcastActionPredicate = [](PossiblePlayerBattleAction & action) + { + return action.spellcast(); + }; + + bool isCurrentStackInSpellcastMode = std::all_of(possibleActions.begin(), possibleActions.end(), spellcastActionPredicate); + + if (spellcastingModeActive() || isCurrentStackInSpellcastMode) + { endCastingSpell(); + CRClickPopup::createAndPush(CGI->generaltexth->translate("core.genrltxt.731")); // spell cancelled + return; + } auto selectedStack = owner.curInt->cb->battleGetStackByPos(clickedHex, true); @@ -998,7 +1022,7 @@ void BattleActionsController::onHexRightClicked(BattleHex clickedHex) bool BattleActionsController::spellcastingModeActive() const { - return heroSpellToCast != nullptr;; + return heroSpellToCast != nullptr; } bool BattleActionsController::currentActionSpellcasting(BattleHex hoveredHex) diff --git a/client/battle/BattleActionsController.h b/client/battle/BattleActionsController.h index 3010ac4e2..86acc8e44 100644 --- a/client/battle/BattleActionsController.h +++ b/client/battle/BattleActionsController.h @@ -23,12 +23,6 @@ VCMI_LIB_NAMESPACE_END class BattleInterface; -enum class MouseHoveredHexContext -{ - UNOCCUPIED_HEX, - OCCUPIED_HEX -}; - /// Class that controls actions that can be performed by player, e.g. moving stacks, attacking, etc /// As well as all relevant feedback for these actions in user interface class BattleActionsController @@ -53,7 +47,7 @@ class BattleActionsController bool isCastingPossibleHere (const CSpell * spell, const CStack *shere, BattleHex myNumber); bool canStackMoveHere (const CStack *sactive, BattleHex MyNumber) const; //TODO: move to BattleState / callback std::vector getPossibleActionsForStack (const CStack *stack) const; //called when stack gets its turn - void reorderPossibleActionsPriority(const CStack * stack, MouseHoveredHexContext context); + void reorderPossibleActionsPriority(const CStack * stack, const CStack * targetStack); bool actionIsLegal(PossiblePlayerBattleAction action, BattleHex hoveredHex); diff --git a/client/battle/BattleFieldController.cpp b/client/battle/BattleFieldController.cpp index 8eda33038..cb239a3eb 100644 --- a/client/battle/BattleFieldController.cpp +++ b/client/battle/BattleFieldController.cpp @@ -128,6 +128,9 @@ BattleFieldController::BattleFieldController(BattleInterface & owner): attackCursors = std::make_shared("CRCOMBAT"); attackCursors->preload(); + spellCursors = std::make_shared("CRSPELL"); + spellCursors->preload(); + initializeHexEdgeMaskToFrameIndex(); rangedFullDamageLimitImages = std::make_shared("battle/rangeHighlights/rangeHighlightsGreen.json"); @@ -888,10 +891,22 @@ void BattleFieldController::show(Canvas & to) if (isActive() && isGesturing() && getHoveredHex() != BattleHex::INVALID) { - auto cursorIndex = CCS->curh->get(); - auto imageIndex = static_cast(cursorIndex); + auto combatCursorIndex = CCS->curh->get(); + if (combatCursorIndex) + { + auto combatImageIndex = static_cast(*combatCursorIndex); + to.draw(attackCursors->getImage(combatImageIndex), hexPositionAbsolute(getHoveredHex()).center() - CCS->curh->getPivotOffsetCombat(combatImageIndex)); + return; + } + + auto spellCursorIndex = CCS->curh->get(); + if (spellCursorIndex) + { + auto spellImageIndex = static_cast(*spellCursorIndex); + to.draw(spellCursors->getImage(spellImageIndex), hexPositionAbsolute(getHoveredHex()).center() - CCS->curh->getPivotOffsetSpellcast()); + return; + } - to.draw(attackCursors->getImage(imageIndex), hexPositionAbsolute(getHoveredHex()).center() - CCS->curh->getPivotOffsetCombat(imageIndex)); } } diff --git a/client/battle/BattleFieldController.h b/client/battle/BattleFieldController.h index 00c0ca793..b97649cc8 100644 --- a/client/battle/BattleFieldController.h +++ b/client/battle/BattleFieldController.h @@ -37,6 +37,7 @@ class BattleFieldController : public CIntObject std::shared_ptr shootingRangeLimitImages; std::shared_ptr attackCursors; + std::shared_ptr spellCursors; /// Canvas that contains background, hex grid (if enabled), absolute obstacles and movement range of active stack std::unique_ptr backgroundWithHexes; diff --git a/client/battle/BattleInterface.cpp b/client/battle/BattleInterface.cpp index 6420cdc77..4159895de 100644 --- a/client/battle/BattleInterface.cpp +++ b/client/battle/BattleInterface.cpp @@ -104,11 +104,9 @@ void BattleInterface::playIntroSoundAndUnlockInterface() { auto onIntroPlayed = [this]() { + boost::unique_lock un(*CPlayerInterface::pim); if(LOCPLINT->battleInt) - { - boost::unique_lock un(*CPlayerInterface::pim); onIntroSoundPlayed(); - } }; int battleIntroSoundChannel = CCS->soundh->playSoundFromSet(CCS->soundh->battleIntroSounds); diff --git a/client/battle/BattleWindow.cpp b/client/battle/BattleWindow.cpp index 36c430272..78a5f690c 100644 --- a/client/battle/BattleWindow.cpp +++ b/client/battle/BattleWindow.cpp @@ -450,6 +450,10 @@ void BattleWindow::showAlternativeActionIcon(PossiblePlayerBattleAction action) case PossiblePlayerBattleAction::AIMED_SPELL_CREATURE: iconName = variables["actionIconSpell"].String(); break; + + case PossiblePlayerBattleAction::ANY_LOCATION: + iconName = variables["actionIconSpell"].String(); + break; //TODO: figure out purpose of this icon //case PossiblePlayerBattleAction::???: @@ -500,7 +504,11 @@ void BattleWindow::bAutofightf() blockUI(true); auto ai = CDynLibHandler::getNewBattleAI(settings["server"]["friendlyAI"].String()); - ai->initBattleInterface(owner.curInt->env, owner.curInt->cb); + + AutocombatPreferences autocombatPreferences = AutocombatPreferences(); + autocombatPreferences.enableSpellsUsage = settings["battle"]["enableAutocombatSpells"].Bool(); + + ai->initBattleInterface(owner.curInt->env, owner.curInt->cb, autocombatPreferences); ai->battleStart(owner.army1, owner.army2, int3(0,0,0), owner.attackingHeroInstance, owner.defendingHeroInstance, owner.curInt->cb->battleGetMySide(), false); owner.curInt->autofightingAI = ai; owner.curInt->cb->registerBattleInterface(ai); diff --git a/client/eventsSDL/InputHandler.cpp b/client/eventsSDL/InputHandler.cpp index c65fefef0..698616d7b 100644 --- a/client/eventsSDL/InputHandler.cpp +++ b/client/eventsSDL/InputHandler.cpp @@ -128,6 +128,7 @@ void InputHandler::preprocessEvent(const SDL_Event & ev) #endif else if(ev.type == SDL_KEYDOWN && ev.key.keysym.sym==SDLK_F4) { + boost::unique_lock lock(*CPlayerInterface::pim); Settings full = settings.write["video"]["fullscreen"]; full->Bool() = !full->Bool(); diff --git a/client/eventsSDL/InputSourceMouse.cpp b/client/eventsSDL/InputSourceMouse.cpp index cf2b80785..ec971c645 100644 --- a/client/eventsSDL/InputSourceMouse.cpp +++ b/client/eventsSDL/InputSourceMouse.cpp @@ -50,10 +50,10 @@ void InputSourceMouse::handleEventMouseButtonDown(const SDL_MouseButtonEvent & b if(button.clicks > 1) GH.events().dispatchMouseDoubleClick(position); else - GH.events().dispatchMouseLeftButtonPressed(position); + GH.events().dispatchMouseLeftButtonPressed(position, 0); break; case SDL_BUTTON_RIGHT: - GH.events().dispatchShowPopup(position); + GH.events().dispatchShowPopup(position, 0); break; case SDL_BUTTON_MIDDLE: middleClickPosition = position; @@ -74,7 +74,7 @@ void InputSourceMouse::handleEventMouseButtonUp(const SDL_MouseButtonEvent & but switch(button.button) { case SDL_BUTTON_LEFT: - GH.events().dispatchMouseLeftButtonReleased(position); + GH.events().dispatchMouseLeftButtonReleased(position, 0); break; case SDL_BUTTON_RIGHT: GH.events().dispatchClosePopup(position); diff --git a/client/eventsSDL/InputSourceTouch.cpp b/client/eventsSDL/InputSourceTouch.cpp index 02e89015c..456d9cfc7 100644 --- a/client/eventsSDL/InputSourceTouch.cpp +++ b/client/eventsSDL/InputSourceTouch.cpp @@ -39,6 +39,7 @@ InputSourceTouch::InputSourceTouch() params.relativeModeSpeedFactor = settings["general"]["relativePointerSpeedMultiplier"].Float(); params.longTouchTimeMilliseconds = settings["general"]["longTouchTimeMilliseconds"].Float(); params.hapticFeedbackEnabled = settings["general"]["hapticFeedback"].Bool(); + params.touchToleranceDistance = settings["input"]["touchToleranceDistance"].Float(); if (params.useRelativeMode) state = TouchState::RELATIVE_MODE; @@ -121,9 +122,9 @@ void InputSourceTouch::handleEventFingerDown(const SDL_TouchFingerEvent & tfinge if(tfinger.x > 0.5) { if (tfinger.y < 0.5) - GH.events().dispatchShowPopup(GH.getCursorPosition()); + GH.events().dispatchShowPopup(GH.getCursorPosition(), params.touchToleranceDistance); else - GH.events().dispatchMouseLeftButtonPressed(GH.getCursorPosition()); + GH.events().dispatchMouseLeftButtonPressed(GH.getCursorPosition(), params.touchToleranceDistance); } break; } @@ -168,7 +169,7 @@ void InputSourceTouch::handleEventFingerUp(const SDL_TouchFingerEvent & tfinger) if (tfinger.y < 0.5) GH.events().dispatchClosePopup(GH.getCursorPosition()); else - GH.events().dispatchMouseLeftButtonReleased(GH.getCursorPosition()); + GH.events().dispatchMouseLeftButtonReleased(GH.getCursorPosition(), params.touchToleranceDistance); } break; } @@ -180,8 +181,8 @@ void InputSourceTouch::handleEventFingerUp(const SDL_TouchFingerEvent & tfinger) case TouchState::TAP_DOWN_SHORT: { GH.input().setCursorPosition(convertTouchToMouse(tfinger)); - GH.events().dispatchMouseLeftButtonPressed(convertTouchToMouse(tfinger)); - GH.events().dispatchMouseLeftButtonReleased(convertTouchToMouse(tfinger)); + GH.events().dispatchMouseLeftButtonPressed(convertTouchToMouse(tfinger), params.touchToleranceDistance); + GH.events().dispatchMouseLeftButtonReleased(convertTouchToMouse(tfinger), params.touchToleranceDistance); state = TouchState::IDLE; break; } @@ -230,7 +231,7 @@ void InputSourceTouch::handleUpdate() uint32_t currentTime = SDL_GetTicks(); if (currentTime > lastTapTimeTicks + params.longTouchTimeMilliseconds) { - GH.events().dispatchShowPopup(GH.getCursorPosition()); + GH.events().dispatchShowPopup(GH.getCursorPosition(), params.touchToleranceDistance); if (GH.windows().isTopWindowPopup()) { diff --git a/client/eventsSDL/InputSourceTouch.h b/client/eventsSDL/InputSourceTouch.h index b82ae1688..56d112dc7 100644 --- a/client/eventsSDL/InputSourceTouch.h +++ b/client/eventsSDL/InputSourceTouch.h @@ -78,6 +78,9 @@ struct TouchInputParameters /// gesture will be qualified as pinch if distance between fingers is at least specified here uint32_t pinchSensitivityThreshold = 10; + /// touch event will trigger clicking of elements up to X pixels away from actual touch position + uint32_t touchToleranceDistance = 20; + bool useRelativeMode = false; bool hapticFeedbackEnabled = false; diff --git a/client/gui/CIntObject.cpp b/client/gui/CIntObject.cpp index 93d0ebc70..74c946d16 100644 --- a/client/gui/CIntObject.cpp +++ b/client/gui/CIntObject.cpp @@ -263,6 +263,11 @@ bool CIntObject::receiveEvent(const Point & position, int eventType) const return pos.isInside(position); } +const Rect & CIntObject::getPosition() const +{ + return pos; +} + void CIntObject::onScreenResize() { center(pos, true); diff --git a/client/gui/CIntObject.h b/client/gui/CIntObject.h index 4b4dbfd87..c1bddd586 100644 --- a/client/gui/CIntObject.h +++ b/client/gui/CIntObject.h @@ -109,6 +109,8 @@ public: /// by default, usedEvents inside UI elements are always handled bool receiveEvent(const Point & position, int eventType) const override; + const Rect & getPosition() const override; + const Rect & center(const Rect &r, bool propagate = true); //sets pos so that r will be in the center of screen, assigns sizes of r to pos, returns new position const Rect & center(const Point &p, bool propagate = true); //moves object so that point p will be in its center const Rect & center(bool propagate = true); //centers when pos.w and pos.h are set, returns new position diff --git a/client/gui/CursorHandler.h b/client/gui/CursorHandler.h index 531594b3a..20ad2b337 100644 --- a/client/gui/CursorHandler.h +++ b/client/gui/CursorHandler.h @@ -125,7 +125,6 @@ class CursorHandler final void changeGraphic(Cursor::Type type, size_t index); - Point getPivotOffsetSpellcast(); Point getPivotOffset(); void updateSpellcastCursor(); @@ -153,7 +152,7 @@ public: /// Returns current index of cursor template - Index get() + std::optional get() { bool typeValid = true; @@ -164,9 +163,10 @@ public: if (typeValid) return static_cast(frame); - return Index::POINTER; + return std::nullopt; } + Point getPivotOffsetSpellcast(); Point getPivotOffsetDefault(size_t index); Point getPivotOffsetMap(size_t index); Point getPivotOffsetCombat(size_t index); diff --git a/client/gui/EventDispatcher.cpp b/client/gui/EventDispatcher.cpp index 068cbb8b3..36e5822f2 100644 --- a/client/gui/EventDispatcher.cpp +++ b/client/gui/EventDispatcher.cpp @@ -16,7 +16,7 @@ #include "MouseButton.h" #include "WindowHandler.h" -#include "../../lib/Point.h" +#include "../../lib/Rect.h" template void EventDispatcher::processLists(ui16 activityFlag, const Functor & cb) @@ -134,28 +134,64 @@ void EventDispatcher::dispatchMouseDoubleClick(const Point & position) } if(!doubleClicked) - handleLeftButtonClick(position, true); + handleLeftButtonClick(position, 0, true); } -void EventDispatcher::dispatchMouseLeftButtonPressed(const Point & position) +void EventDispatcher::dispatchMouseLeftButtonPressed(const Point & position, int tolerance) { - handleLeftButtonClick(position, true); + handleLeftButtonClick(position, tolerance, true); } -void EventDispatcher::dispatchMouseLeftButtonReleased(const Point & position) +void EventDispatcher::dispatchMouseLeftButtonReleased(const Point & position, int tolerance) { - handleLeftButtonClick(position, false); + handleLeftButtonClick(position, tolerance, false); } -void EventDispatcher::dispatchShowPopup(const Point & position) +AEventsReceiver * EventDispatcher::findElementInToleranceRange(const EventReceiversList & list, const Point & position, int eventToTest, int tolerance) { + AEventsReceiver * bestElement = nullptr; + int bestDistance = std::numeric_limits::max(); + + for(auto & i : list) + { + // if there is element that can actually receive event then tolerance clicking is disabled + if( i->receiveEvent(position, eventToTest)) + return nullptr; + + if (i->getPosition().distanceTo(position) > bestDistance) + continue; + + Point center = i->getPosition().center(); + Point distance = center - position; + + if (distance.lengthSquared() == 0) + continue; + + Point moveDelta = distance * tolerance / distance.length(); + Point testPosition = position + moveDelta; + + if( !i->receiveEvent(testPosition, eventToTest)) + continue; + + bestElement = i; + bestDistance = i->getPosition().distanceTo(position); + } + + return bestElement; +} + +void EventDispatcher::dispatchShowPopup(const Point & position, int tolerance) +{ + AEventsReceiver * nearestElement = findElementInToleranceRange(rclickable, position, AEventsReceiver::LCLICK, tolerance); + auto hlp = rclickable; + for(auto & i : hlp) { if(!vstd::contains(rclickable, i)) continue; - if( !i->receiveEvent(position, AEventsReceiver::LCLICK)) + if( !i->receiveEvent(position, AEventsReceiver::SHOW_POPUP) && i != nearestElement) continue; i->showPopupWindow(position); @@ -170,7 +206,7 @@ void EventDispatcher::dispatchClosePopup(const Point & position) assert(!GH.windows().isTopWindowPopup()); } -void EventDispatcher::handleLeftButtonClick(const Point & position, bool isPressed) +void EventDispatcher::handleLeftButtonClick(const Point & position, int tolerance, bool isPressed) { // WARNING: this approach is NOT SAFE // 1) We allow (un)registering elements when list itself is being processed/iterated @@ -181,13 +217,15 @@ void EventDispatcher::handleLeftButtonClick(const Point & position, bool isPress // 3) new element is created *with exactly same address(!) // 4) new element is registered and code will incorrectly assume that this element is still registered // POSSIBLE SOLUTION: make EventReceivers inherit from create_shared_from this and store weak_ptr's in lists + AEventsReceiver * nearestElement = findElementInToleranceRange(lclickable, position, AEventsReceiver::LCLICK, tolerance); auto hlp = lclickable; + for(auto & i : hlp) { if(!vstd::contains(lclickable, i)) continue; - if( i->receiveEvent(position, AEventsReceiver::LCLICK)) + if( i->receiveEvent(position, AEventsReceiver::LCLICK) || i == nearestElement) { if(isPressed) i->clickPressed(position); diff --git a/client/gui/EventDispatcher.h b/client/gui/EventDispatcher.h index c259b14e3..dee3d77cd 100644 --- a/client/gui/EventDispatcher.h +++ b/client/gui/EventDispatcher.h @@ -35,8 +35,8 @@ class EventDispatcher EventReceiversList textInterested; EventReceiversList panningInterested; - void handleLeftButtonClick(const Point & position, bool isPressed); - + void handleLeftButtonClick(const Point & position, int tolerance, bool isPressed); + AEventsReceiver * findElementInToleranceRange(const EventReceiversList & list, const Point & position, int eventToTest, int tolerance); template void processLists(ui16 activityFlag, const Functor & cb); @@ -56,15 +56,15 @@ public: void dispatchShortcutReleased(const std::vector & shortcuts); /// Mouse events - void dispatchMouseLeftButtonPressed(const Point & position); - void dispatchMouseLeftButtonReleased(const Point & position); + void dispatchMouseLeftButtonPressed(const Point & position, int tolerance); + void dispatchMouseLeftButtonReleased(const Point & position, int tolerance); void dispatchMouseScrolled(const Point & distance, const Point & position); void dispatchMouseDoubleClick(const Point & position); void dispatchMouseMoved(const Point & distance, const Point & position); void dispatchMouseDragged(const Point & currentPosition, const Point & lastUpdateDistance); - void dispatchShowPopup(const Point & position); + void dispatchShowPopup(const Point & position, int tolerance); void dispatchClosePopup(const Point & position); void dispatchGesturePanningStarted(const Point & initialPosition); diff --git a/client/gui/EventsReceiver.h b/client/gui/EventsReceiver.h index 37aeb5fa4..2206c70bf 100644 --- a/client/gui/EventsReceiver.h +++ b/client/gui/EventsReceiver.h @@ -11,6 +11,7 @@ VCMI_LIB_NAMESPACE_BEGIN class Point; +class Rect; VCMI_LIB_NAMESPACE_END class EventDispatcher; @@ -39,6 +40,8 @@ protected: /// If true, event of selected type in selected position will be processed by this element virtual bool receiveEvent(const Point & position, int eventType) const= 0; + virtual const Rect & getPosition() const= 0; + public: virtual void clickPressed(const Point & cursorPosition) {} virtual void clickReleased(const Point & cursorPosition) {} diff --git a/client/gui/ShortcutHandler.cpp b/client/gui/ShortcutHandler.cpp index 9014d1fcf..13f4f7307 100644 --- a/client/gui/ShortcutHandler.cpp +++ b/client/gui/ShortcutHandler.cpp @@ -120,7 +120,7 @@ std::vector ShortcutHandler::translateKeycode(SDL_Keycode key) const {SDLK_KP_MINUS, EShortcut::ADVENTURE_ZOOM_OUT }, {SDLK_BACKSPACE, EShortcut::ADVENTURE_ZOOM_RESET }, {SDLK_q, EShortcut::BATTLE_TOGGLE_QUEUE }, - {SDLK_c, EShortcut::BATTLE_USE_CREATURE_SPELL }, + {SDLK_f, EShortcut::BATTLE_USE_CREATURE_SPELL }, {SDLK_s, EShortcut::BATTLE_SURRENDER }, {SDLK_r, EShortcut::BATTLE_RETREAT }, {SDLK_a, EShortcut::BATTLE_AUTOCOMBAT }, diff --git a/client/gui/TextAlignment.h b/client/gui/TextAlignment.h index 8cb379e70..5c716ba31 100644 --- a/client/gui/TextAlignment.h +++ b/client/gui/TextAlignment.h @@ -9,4 +9,4 @@ */ #pragma once -enum class ETextAlignment {TOPLEFT, CENTER, BOTTOMRIGHT}; +enum class ETextAlignment {TOPLEFT, TOPCENTER, CENTER, BOTTOMRIGHT}; diff --git a/client/icons/vcmiclient.1024x1024.png b/client/icons/vcmiclient.1024x1024.png index 3d5d93ad8..d21f276ef 100644 Binary files a/client/icons/vcmiclient.1024x1024.png and b/client/icons/vcmiclient.1024x1024.png differ diff --git a/client/icons/vcmiclient.128x128.png b/client/icons/vcmiclient.128x128.png index 5a1457b08..9080c94bc 100644 Binary files a/client/icons/vcmiclient.128x128.png and b/client/icons/vcmiclient.128x128.png differ diff --git a/client/icons/vcmiclient.16x16.png b/client/icons/vcmiclient.16x16.png index a4458bd8c..73ed1df8b 100644 Binary files a/client/icons/vcmiclient.16x16.png and b/client/icons/vcmiclient.16x16.png differ diff --git a/client/icons/vcmiclient.2048x2048.png b/client/icons/vcmiclient.2048x2048.png index 59822f2e5..d0b02502f 100644 Binary files a/client/icons/vcmiclient.2048x2048.png and b/client/icons/vcmiclient.2048x2048.png differ diff --git a/client/icons/vcmiclient.22x22.png b/client/icons/vcmiclient.22x22.png new file mode 100644 index 000000000..4c21a5f6b Binary files /dev/null and b/client/icons/vcmiclient.22x22.png differ diff --git a/client/icons/vcmiclient.256x256.png b/client/icons/vcmiclient.256x256.png index 012cd0999..cc345dd51 100644 Binary files a/client/icons/vcmiclient.256x256.png and b/client/icons/vcmiclient.256x256.png differ diff --git a/client/icons/vcmiclient.32x32.png b/client/icons/vcmiclient.32x32.png index 89819f298..cd849931b 100644 Binary files a/client/icons/vcmiclient.32x32.png and b/client/icons/vcmiclient.32x32.png differ diff --git a/client/icons/vcmiclient.48x48.png b/client/icons/vcmiclient.48x48.png index 4c6c239af..1e59f556d 100644 Binary files a/client/icons/vcmiclient.48x48.png and b/client/icons/vcmiclient.48x48.png differ diff --git a/client/icons/vcmiclient.512x512.png b/client/icons/vcmiclient.512x512.png index 8c0b7e4df..0b8bd58de 100644 Binary files a/client/icons/vcmiclient.512x512.png and b/client/icons/vcmiclient.512x512.png differ diff --git a/client/icons/vcmiclient.64x64.png b/client/icons/vcmiclient.64x64.png index 89865281b..71ae6ca54 100644 Binary files a/client/icons/vcmiclient.64x64.png and b/client/icons/vcmiclient.64x64.png differ diff --git a/client/icons/vcmiclient.svg b/client/icons/vcmiclient.svg index 0d1f01b5b..474c07a1d 100644 --- a/client/icons/vcmiclient.svg +++ b/client/icons/vcmiclient.svg @@ -2,19 +2,22 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + gradientTransform="translate(1.5699347,0.84779727)" /> diff --git a/client/icons/vcmiclient.xpm b/client/icons/vcmiclient.xpm deleted file mode 100644 index ce82b0f95..000000000 --- a/client/icons/vcmiclient.xpm +++ /dev/null @@ -1,238 +0,0 @@ -/* XPM */ -static char *x[] = { -/* columns rows colors chars-per-pixel */ -"32 32 200 2 ", -" c gray11", -". c #161616", -"X c #2C0E00", -"o c #2D1003", -"O c #25140C", -"+ c #28130A", -"@ c #311305", -"# c #331609", -"$ c #34190C", -"% c #391C0D", -"& c #241610", -"* c #241A16", -"= c #251E1A", -"- c #2C1C14", -"; c #391E11", -": c #2A241D", -"> c #20201F", -", c #3D2112", -"< c #38231B", -"1 c #3C351E", -"2 c #242323", -"3 c #2C2B2B", -"4 c #282625", -"5 c #332E20", -"6 c #362D29", -"7 c #302620", -"8 c #363122", -"9 c #3C3521", -"0 c #3E352C", -"q c #36302D", -"w c #353433", -"e c #3D3B3B", -"r c #3B3431", -"t c #412516", -"y c #462A1B", -"u c #492E1E", -"i c #45271B", -"p c #443A1B", -"a c #4A3F1C", -"s c #4A2F20", -"d c #4D3323", -"f c #423B24", -"g c #48372E", -"h c #483F25", -"j c #503627", -"k c #513728", -"l c #543B2C", -"z c #593D2F", -"x c #483D37", -"c c #473C37", -"v c #573E30", -"b c #583F31", -"n c #5A4C1D", -"m c #63531C", -"M c #6F5C18", -"N c #725D13", -"B c #7D6515", -"V c #4E4426", -"C c #514623", -"Z c #44423F", -"A c #5C4234", -"S c #5A4438", -"D c #625220", -"F c #6C5A24", -"G c #6B5A29", -"H c #715E26", -"J c #674D3F", -"K c #604537", -"L c #7A6525", -"P c #746129", -"I c #444242", -"U c #494645", -"Y c #4C4B4A", -"T c #4A4845", -"R c #554A46", -"E c #5B4D45", -"W c #514742", -"Q c #555352", -"! c #595757", -"~ c #5D5B5A", -"^ c #694E40", -"/ c #6B5549", -"( c #775D4F", -") c #705648", -"_ c #6B5F58", -"` c #755E52", -"' c #62605E", -"] c #7E6557", -"[ c #7A665A", -"{ c #666564", -"} c #696766", -"| c #6D6B6A", -" . c #6A6865", -".. c #7B6B62", -"X. c #726D69", -"o. c #7A7674", -"O. c #7D7B7B", -"+. c #767471", -"@. c #95750A", -"#. c #98770A", -"$. c #846B1B", -"%. c #876D17", -"&. c #8E731E", -"*. c #93761D", -"=. c #96781C", -"-. c #9B7B10", -";. c #A07F0F", -":. c #A07D10", -">. c #836C22", -",. c #866F29", -"<. c #8C7324", -"1. c #997D22", -"2. c #967A28", -"3. c #826A5D", -"4. c #80675A", -"5. c #856D60", -"6. c #897164", -"7. c #8C7569", -"8. c #8F786C", -"9. c #927C6F", -"0. c #827D79", -"q. c #937E72", -"w. c #A7840F", -"e. c #AE8A16", -"r. c #A5831A", -"t. c #B08C1C", -"y. c #B79015", -"u. c #BD961A", -"i. c #A88825", -"p. c #B08E23", -"a. c #BB9624", -"s. c #BB9626", -"d. c #C69D1B", -"f. c #C29B22", -"g. c #C29C2A", -"h. c #CCA220", -"j. c #CDA42A", -"k. c #D9AD26", -"l. c #D2A726", -"z. c #E6B726", -"x. c #86827D", -"c. c #8A847F", -"v. c #978175", -"b. c #94867D", -"n. c #9B867A", -"m. c #9E897D", -"M. c #998377", -"N. c #848383", -"B. c #8A8680", -"V. c #8F8B86", -"C. c #9B8D85", -"Z. c #938E89", -"A. c #918984", -"S. c #96928E", -"D. c #9A9693", -"F. c #9C9996", -"G. c #9D9B99", -"H. c #939292", -"J. c #A28E82", -"K. c #A69287", -"L. c #A5948A", -"P. c #AC988D", -"I. c #A9958A", -"U. c #A69C96", -"Y. c #AD9C93", -"T. c #A29D99", -"R. c #A89F99", -"E. c #B19E93", -"W. c #A5A29F", -"Q. c #B3A196", -"!. c #B8A69C", -"~. c #B9A69C", -"^. c #A4A3A2", -"/. c #A9A6A3", -"(. c #ADABA9", -"). c #ABA8A5", -"_. c #BCABA1", -"`. c #B2AEAC", -"'. c #B5A9A3", -"]. c #B3B2AF", -"[. c #B3B2B2", -"{. c #B9B5B3", -"}. c #BAB9B9", -"|. c #BBB9B6", -" X c #C0AFA5", -".X c #C4B3AA", -"XX c #C8B8AE", -"oX c #C1BFBE", -"OX c #CDBDB4", -"+X c #CCC9C7", -"@X c #CFCCCB", -"#X c #C5C3C1", -"$X c #D3D1CF", -"%X c #D6D3D2", -"&X c #DDDBDA", -"*X c #EDECEB", -"=X c #E4E3E3", -"-X c #F3F3F3", -";X c #F9F9F9", -":X c None", -/* pixels */ -":X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X", -":X:X:XO.V.| Q :X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:XZ Q ' T :X:X", -":X:XI G.(.}.}.}.(.^.H.N.O.| } ~ ! ' { { } X.o.0.B.x.x.x.x.x.:X:X", -":X:X3 N.H.^.[.}.}.}.}.}.}.}.}.[.`.(./.^.T.T.D.S.Z.V.B.x.x.o.:X:X", -":X:X:X| O. .^ ..b.D./.[.{.}.}.}.{.[.`.(.^.F.S.D.W.'.'.c.c.' :X:X", -":X:X:X! { c % s b ^ ( 5.7.q.b.C.C.L.L.I.Y.E.~. X XXXOXZ.V.~ :X:X", -":X:X:XU ~ c X @ t j K ) [ 3.6.7.q.b.n.J.L.P.E.E.~. XXXZ.D.Y :X:X", -":X:X:Xw Q Z X X X % y v ^ ( ] 5.6.8.q.M.C.J.I.E.Q.~.~.F.F.:X:X:X", -":X:X:X4 Y U X X X X @ t d A ) ] 3.6.7.9.q.n.J.K.P.E.W.W.D.:X:X:X", -":X:X:X:XI U @ X X X X X % i z ^ ( 4.3.6.8.q.M.n.m.I.U.(.x.:X:X:X", -":X . w 3 * + X + O & & & - d K g x Z ^ 7...U E R N.N.e :X:X", -":XG j.9 2 ,.s.* + = s.j.j.j.P * i F j.j.0 [ R i.l.i.' Y g.2.:X:X", -":XH z.f 2 2.k.* * p.f.,.,.2.l.G X L z.z.8 x q p.z.s.{ Y k.i.:X:X", -":Xh i.f.>.d.L : = h.1.O X : L V X H k.p.a.4 <.f.a.p.{ e h.1.:X:X", -":X:XF d.<.d.w k = d.&.+ X X X X o F d.B d.2 <.t.<.r.{ w u.*.:X:X", -":X:XF y.$.y.I ' : e.$.- # & = * X D y.V =.e.e.D %.=.{ 2 e.$.:X:X", -":X:X9 %.w.n Q G.: -.B : : 1 w.n X n w.: M w.-.2 B %.Y > -.B :X:X", -":X:X:Xm #. -X-X6 a @.@.@.#.M 5 o n @.: 1 a a = N B w @.N :X:X", -":X:X:X8 a #X;XC.7 p p p p 8 , # 8 p * X X X + 1 p p 9 :X:X", -":X:X:X:X:X:XO.*X@Xk d h u u u y t % # o X X X < Q Y :X:X:X:X:X:X", -":X:X:X:X:X:X:X&X*X[ d j j d s u u t , % @ o X r Y 3 :X:X:X:X:X:X", -":X:X:X:X:X:X:XF.&XW.z k k j j s d u y , , # - c I :X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X$X%X/ z l k k d d d u u t , 6 w 3 :X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:XF.@XT.v l l l k d d d d u S .Y :X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:XI |.#X..A z l l k j j d v F.F.! :X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:XO.{.]./ A z l z l j z {.=X}.:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:XF.].).` A A z l S `.-X;XO.:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:Xe G.).].V.....b.$X=X*X^.:X:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:X:XT D.W.(.{.}.+X%X&X/.:X:X:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:X:X:Xe x.T./.].|.}.O.:X:X:X:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:X:X:X:X:XY | o. .:X:X:X:X:X:X:X:X:X:X:X:X:X:X", -":X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X:X" -}; diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png index aee9354ef..d575b4b11 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png index e5583f4b7..c4c0b80d8 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png index 6c58aa09f..3071027d3 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png index 045a0bc89..bb0ee71e7 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png index 704fc9815..4a306d85d 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png index 3fb265c48..f50864ce4 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png index e5583f4b7..ae4a61187 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png index 244512b03..220b233b8 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png index ca7b489be..1a407db91 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@1x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@1x.png new file mode 100644 index 000000000..caaf8bc5c Binary files /dev/null and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@1x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png index ca7b489be..1a407db91 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png index aa20b6471..b7d87b2ab 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png index 1fbffde17..d24e0ddb0 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png index c184e5a54..572699c5f 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png index c08e86964..a9bdfe432 100644 Binary files a/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png and b/client/ios/Images.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/client/ios/vcmi_logo.png b/client/ios/vcmi_logo.png index 73d432480..12a7e7f03 100644 Binary files a/client/ios/vcmi_logo.png and b/client/ios/vcmi_logo.png differ diff --git a/client/lobby/CBonusSelection.cpp b/client/lobby/CBonusSelection.cpp index 3544b828d..18eaa66d0 100644 --- a/client/lobby/CBonusSelection.cpp +++ b/client/lobby/CBonusSelection.cpp @@ -343,7 +343,7 @@ void CBonusSelection::updateAfterStateChange() { buttonStart->block(getCampaign()->scenario(CSH->campaignMap).travelOptions.bonusesToChoose.size()); } - else if(buttonStart->isBlocked()) + else { buttonStart->block(false); } @@ -390,6 +390,9 @@ void CBonusSelection::goBack() void CBonusSelection::startMap() { + if (!CSH->validateGameStart()) + return; + auto showPrologVideo = [=]() { auto exitCb = [=]() diff --git a/client/lobby/CLobbyScreen.cpp b/client/lobby/CLobbyScreen.cpp index d38e209f7..5c3d5696b 100644 --- a/client/lobby/CLobbyScreen.cpp +++ b/client/lobby/CLobbyScreen.cpp @@ -88,6 +88,8 @@ CLobbyScreen::CLobbyScreen(ESelectionScreen screenType) break; } + buttonStart->block(true); // to be unblocked after map list is ready + buttonBack = std::make_shared(Point(581, 535), "SCNRBACK.DEF", CGI->generaltexth->zelp[105], [&]() { CSH->sendClientDisconnecting(); @@ -126,34 +128,11 @@ void CLobbyScreen::startCampaign() void CLobbyScreen::startScenario(bool allowOnlyAI) { - try + if (CSH->validateGameStart(allowOnlyAI)) { CSH->sendStartGame(allowOnlyAI); buttonStart->block(true); } - catch(CModHandler::Incompatibility & e) - { - logGlobal->warn("Incompatibility exception during start scenario: %s", e.what()); - - auto errorMsg = CGI->generaltexth->translate("vcmi.server.errors.modsIncompatibility") + '\n'; - errorMsg += e.what(); - - CInfoWindow::showInfoDialog(errorMsg, CInfoWindow::TCompsInfo(), PlayerColor(1)); - } - catch(std::exception & e) - { - logGlobal->error("Exception during startScenario: %s", e.what()); - - if(std::string(e.what()) == "ExceptionNoHuman") - CInfoWindow::showInfoDialog(CGI->generaltexth->allTexts[530], CInfoWindow::TCompsInfo(), PlayerColor(1)); - - if(std::string(e.what()) == "ExceptionNoTemplate") - CInfoWindow::showInfoDialog(CGI->generaltexth->allTexts[751], CInfoWindow::TCompsInfo(), PlayerColor(1)); - } - catch(...) - { - logGlobal->error("Unknown exception"); - } } void CLobbyScreen::toggleMode(bool host) @@ -192,6 +171,8 @@ void CLobbyScreen::updateAfterStateChange() if(CSH->mi && tabOpt) tabOpt->recreate(); + buttonStart->block(CSH->mi == nullptr || CSH->isGuest()); + card->changeSelection(); if (card->iconDifficulty) { diff --git a/client/lobby/CSelectionBase.cpp b/client/lobby/CSelectionBase.cpp index cc1d49ba9..a80a08ffb 100644 --- a/client/lobby/CSelectionBase.cpp +++ b/client/lobby/CSelectionBase.cpp @@ -216,6 +216,10 @@ void InfoCard::changeSelection() flagbox->recreate(); labelDifficulty->setText(CGI->generaltexth->arraytxt[142 + mapInfo->mapHeader->difficulty]); iconDifficulty->setSelected(SEL->getCurrentDifficulty()); + if(SEL->screenType == ESelectionScreen::loadGame || SEL->screenType == ESelectionScreen::saveGame) + for(auto & button : iconDifficulty->buttons) + button.second->setEnabled(button.first == SEL->getCurrentDifficulty()); + const std::array difficultyPercent = {"80%", "100%", "130%", "160%", "200%"}; labelDifficultyPercent->setText(difficultyPercent[SEL->getCurrentDifficulty()]); diff --git a/client/mapView/MapRenderer.cpp b/client/mapView/MapRenderer.cpp index 0b073177a..65a374f97 100644 --- a/client/mapView/MapRenderer.cpp +++ b/client/mapView/MapRenderer.cpp @@ -18,6 +18,7 @@ #include "../render/CAnimation.h" #include "../render/Canvas.h" #include "../render/IImage.h" +#include "../render/Colors.h" #include "../../CCallback.h" @@ -246,7 +247,6 @@ uint8_t MapRendererRoad::checksum(IMapRendererContext & context, const int3 & co MapRendererBorder::MapRendererBorder() { - emptyFill = std::make_unique(Point(32,32)); animation = std::make_unique("EDG"); animation->preload(); } @@ -298,7 +298,7 @@ void MapRendererBorder::renderTile(IMapRendererContext & context, Canvas & targe } else { - target.draw(*emptyFill, Point(0,0)); + target.drawColor(Rect(0,0,32,32), Colors::BLACK); } } diff --git a/client/mapView/MapRenderer.h b/client/mapView/MapRenderer.h index 2ee036f88..d56a37c74 100644 --- a/client/mapView/MapRenderer.h +++ b/client/mapView/MapRenderer.h @@ -90,7 +90,6 @@ public: class MapRendererBorder { std::unique_ptr animation; - std::unique_ptr emptyFill; size_t getIndexForTile(IMapRendererContext & context, const int3 & coordinates); diff --git a/client/mapView/MapViewController.cpp b/client/mapView/MapViewController.cpp index 09f6589d6..7f37cfeb4 100644 --- a/client/mapView/MapViewController.cpp +++ b/client/mapView/MapViewController.cpp @@ -218,8 +218,9 @@ void MapViewController::afterRender() if(!hero) hero = boat->hero; - if(movementContext->progress >= 1.0) + if(movementContext->progress >= 0.999) { + logGlobal->debug("Ending movement animation"); setViewCenter(hero->getSightCenter()); removeObject(context->getObject(movementContext->target)); @@ -229,20 +230,23 @@ void MapViewController::afterRender() } } - if(teleportContext && teleportContext->progress >= 1.0) + if(teleportContext && teleportContext->progress >= 0.999) { + logGlobal->debug("Ending teleport animation"); activateAdventureContext(teleportContext->animationTime); } - if(fadingOutContext && fadingOutContext->progress <= 0.0) + if(fadingOutContext && fadingOutContext->progress <= 0.001) { + logGlobal->debug("Ending fade out animation"); removeObject(context->getObject(fadingOutContext->target)); activateAdventureContext(fadingOutContext->animationTime); } - if(fadingInContext && fadingInContext->progress >= 1.0) + if(fadingInContext && fadingInContext->progress >= 0.999) { + logGlobal->debug("Ending fade in animation"); activateAdventureContext(fadingInContext->animationTime); } } @@ -300,6 +304,7 @@ bool MapViewController::isEventVisible(const CGHeroInstance * obj, const int3 & void MapViewController::fadeOutObject(const CGObjectInstance * obj) { + logGlobal->debug("Starting fade out animation"); fadingOutContext = std::make_shared(*state); fadingOutContext->animationTime = adventureContext->animationTime; adventureContext = fadingOutContext; @@ -319,6 +324,7 @@ void MapViewController::fadeOutObject(const CGObjectInstance * obj) void MapViewController::fadeInObject(const CGObjectInstance * obj) { + logGlobal->debug("Starting fade in animation"); fadingInContext = std::make_shared(*state); fadingInContext->animationTime = adventureContext->animationTime; adventureContext = fadingInContext; @@ -457,6 +463,7 @@ void MapViewController::onAfterHeroTeleported(const CGHeroInstance * obj, const if(isEventVisible(obj, from, dest)) { + logGlobal->debug("Starting teleport animation"); teleportContext = std::make_shared(*state); teleportContext->animationTime = adventureContext->animationTime; adventureContext = teleportContext; @@ -491,6 +498,7 @@ void MapViewController::onHeroMoved(const CGHeroInstance * obj, const int3 & fro if(movementTime > 1) { + logGlobal->debug("Starting movement animation"); movementContext = std::make_shared(*state); movementContext->animationTime = adventureContext->animationTime; adventureContext = movementContext; diff --git a/client/render/Canvas.cpp b/client/render/Canvas.cpp index dded81c9e..8a20e3d3d 100644 --- a/client/render/Canvas.cpp +++ b/client/render/Canvas.cpp @@ -149,6 +149,7 @@ void Canvas::drawText(const Point & position, const EFonts & font, const SDL_Col switch (alignment) { case ETextAlignment::TOPLEFT: return graphics->fonts[font]->renderTextLeft (surface, text, colorDest, renderArea.topLeft() + position); + case ETextAlignment::TOPCENTER: return graphics->fonts[font]->renderTextCenter(surface, text, colorDest, renderArea.topLeft() + position); case ETextAlignment::CENTER: return graphics->fonts[font]->renderTextCenter(surface, text, colorDest, renderArea.topLeft() + position); case ETextAlignment::BOTTOMRIGHT: return graphics->fonts[font]->renderTextRight (surface, text, colorDest, renderArea.topLeft() + position); } @@ -159,6 +160,7 @@ void Canvas::drawText(const Point & position, const EFonts & font, const SDL_Col switch (alignment) { case ETextAlignment::TOPLEFT: return graphics->fonts[font]->renderTextLinesLeft (surface, text, colorDest, renderArea.topLeft() + position); + case ETextAlignment::TOPCENTER: return graphics->fonts[font]->renderTextLinesCenter(surface, text, colorDest, renderArea.topLeft() + position); case ETextAlignment::CENTER: return graphics->fonts[font]->renderTextLinesCenter(surface, text, colorDest, renderArea.topLeft() + position); case ETextAlignment::BOTTOMRIGHT: return graphics->fonts[font]->renderTextLinesRight (surface, text, colorDest, renderArea.topLeft() + position); } diff --git a/client/vcmi.ico b/client/vcmi.ico index 2c27331dd..0c431b808 100644 Binary files a/client/vcmi.ico and b/client/vcmi.ico differ diff --git a/client/widgets/Buttons.cpp b/client/widgets/Buttons.cpp index ae4737df7..b33bd8e6a 100644 --- a/client/widgets/Buttons.cpp +++ b/client/widgets/Buttons.cpp @@ -128,6 +128,13 @@ void CButton::setState(ButtonState newState) { if (state == newState) return; + + if (newState == BLOCKED) + removeUsedEvents(LCLICK | SHOW_POPUP | HOVER | KEYBOARD); + else + addUsedEvents(LCLICK | SHOW_POPUP | HOVER | KEYBOARD); + + state = newState; update(); } diff --git a/client/widgets/CArtifactsOfHeroBackpack.cpp b/client/widgets/CArtifactsOfHeroBackpack.cpp index 18a704a19..ed25c1357 100644 --- a/client/widgets/CArtifactsOfHeroBackpack.cpp +++ b/client/widgets/CArtifactsOfHeroBackpack.cpp @@ -11,11 +11,9 @@ #include "CArtifactsOfHeroBackpack.h" #include "../gui/CGuiHandler.h" -#include "../gui/Shortcut.h" -#include "Buttons.h" +#include "Images.h" #include "GameSettings.h" -#include "IHandlerBase.h" #include "ObjectLists.h" #include "../CPlayerInterface.h" @@ -27,25 +25,28 @@ CArtifactsOfHeroBackpack::CArtifactsOfHeroBackpack(const Point & position) { OBJECT_CONSTRUCTION_CAPTURING(255 - DISPOSE); pos += position; + setRedrawParent(true); const auto backpackCap = VLC->settings()->getInteger(EGameSettings::HEROES_BACKPACK_CAP); - auto visibleCapasityMax = HERO_BACKPACK_WINDOW_SLOT_LINES * HERO_BACKPACK_WINDOW_SLOT_COLUMNS; + auto visibleCapacityMax = HERO_BACKPACK_WINDOW_SLOT_ROWS * HERO_BACKPACK_WINDOW_SLOT_COLUMNS; if(backpackCap >= 0) - visibleCapasityMax = visibleCapasityMax > backpackCap ? backpackCap : visibleCapasityMax; + visibleCapacityMax = visibleCapacityMax > backpackCap ? backpackCap : visibleCapacityMax; - backpack.resize(visibleCapasityMax); + backpack.resize(visibleCapacityMax); size_t artPlaceIdx = 0; for(auto & artPlace : backpack) { - artPlace = std::make_shared( - Point(46 * (artPlaceIdx % HERO_BACKPACK_WINDOW_SLOT_COLUMNS), 46 * (artPlaceIdx / HERO_BACKPACK_WINDOW_SLOT_COLUMNS))); + const auto pos = Point(slotSizeWithMargin * (artPlaceIdx % HERO_BACKPACK_WINDOW_SLOT_COLUMNS), + slotSizeWithMargin * (artPlaceIdx / HERO_BACKPACK_WINDOW_SLOT_COLUMNS)); + backpackSlotsBackgrounds.emplace_back(std::make_shared("heroWindow/artifactSlotEmpty", pos)); + artPlace = std::make_shared(pos); artPlace->setArtifact(nullptr); artPlace->leftClickCallback = std::bind(&CArtifactsOfHeroBase::leftClickArtPlace, this, _1); artPlace->rightClickCallback = std::bind(&CArtifactsOfHeroBase::rightClickArtPlace, this, _1); artPlaceIdx++; } - if(backpackCap < 0 || visibleCapasityMax < backpackCap) + if(backpackCap < 0 || visibleCapacityMax < backpackCap) { auto onCreate = [](size_t index) -> std::shared_ptr { @@ -56,9 +57,19 @@ CArtifactsOfHeroBackpack::CArtifactsOfHeroBackpack(const Point & position) scrollBackpack(static_cast(pos) * HERO_BACKPACK_WINDOW_SLOT_COLUMNS - backpackPos); }; backpackListBox = std::make_shared( - posMoved, onCreate, Point(0, 0), Point(0, 0), HERO_BACKPACK_WINDOW_SLOT_LINES, 0, 0, 1, - Rect(HERO_BACKPACK_WINDOW_SLOT_COLUMNS * 46 + 10, 0, HERO_BACKPACK_WINDOW_SLOT_LINES * 46 - 5, 0)); + posMoved, onCreate, Point(0, 0), Point(0, 0), HERO_BACKPACK_WINDOW_SLOT_ROWS, 0, 0, 1, + Rect(HERO_BACKPACK_WINDOW_SLOT_COLUMNS * slotSizeWithMargin + sliderPosOffsetX, 0, HERO_BACKPACK_WINDOW_SLOT_ROWS * slotSizeWithMargin - 2, 0)); } + + pos.w = visibleCapacityMax > HERO_BACKPACK_WINDOW_SLOT_COLUMNS ? HERO_BACKPACK_WINDOW_SLOT_COLUMNS : visibleCapacityMax; + pos.w *= slotSizeWithMargin; + if(backpackListBox) + pos.w += sliderPosOffsetX + 16; // 16 is slider width. TODO: get it from CListBox directly; + + pos.h = (visibleCapacityMax / HERO_BACKPACK_WINDOW_SLOT_COLUMNS); + if(visibleCapacityMax % HERO_BACKPACK_WINDOW_SLOT_COLUMNS != 0) + pos.h += 1; + pos.h *= slotSizeWithMargin; } void CArtifactsOfHeroBackpack::swapArtifacts(const ArtifactLocation & srcLoc, const ArtifactLocation & dstLoc) @@ -75,7 +86,7 @@ void CArtifactsOfHeroBackpack::pickUpArtifact(CHeroArtPlace & artPlace) void CArtifactsOfHeroBackpack::scrollBackpack(int offset) { if(backpackListBox) - backpackListBox->resize(getActiveSlotLinesNum()); + backpackListBox->resize(getActiveSlotRowsNum()); backpackPos += offset; auto slot = ArtifactPosition(GameConstants::BACKPACK_START + backpackPos); for(auto artPlace : backpack) @@ -89,11 +100,11 @@ void CArtifactsOfHeroBackpack::scrollBackpack(int offset) void CArtifactsOfHeroBackpack::updateBackpackSlots() { if(backpackListBox) - backpackListBox->resize(getActiveSlotLinesNum()); + backpackListBox->resize(getActiveSlotRowsNum()); CArtifactsOfHeroBase::updateBackpackSlots(); } -size_t CArtifactsOfHeroBackpack::getActiveSlotLinesNum() +size_t CArtifactsOfHeroBackpack::getActiveSlotRowsNum() { return (curHero->artifactsInBackpack.size() + HERO_BACKPACK_WINDOW_SLOT_COLUMNS - 1) / HERO_BACKPACK_WINDOW_SLOT_COLUMNS; } diff --git a/client/widgets/CArtifactsOfHeroBackpack.h b/client/widgets/CArtifactsOfHeroBackpack.h index f504ba62c..ce51531ef 100644 --- a/client/widgets/CArtifactsOfHeroBackpack.h +++ b/client/widgets/CArtifactsOfHeroBackpack.h @@ -27,10 +27,13 @@ public: void pickUpArtifact(CHeroArtPlace & artPlace); void scrollBackpack(int offset) override; void updateBackpackSlots() override; - size_t getActiveSlotLinesNum(); + size_t getActiveSlotRowsNum(); private: std::shared_ptr backpackListBox; + std::vector> backpackSlotsBackgrounds; const size_t HERO_BACKPACK_WINDOW_SLOT_COLUMNS = 8; - const size_t HERO_BACKPACK_WINDOW_SLOT_LINES = 8; + const size_t HERO_BACKPACK_WINDOW_SLOT_ROWS = 8; + const int slotSizeWithMargin = 46; + const int sliderPosOffsetX = 10; }; diff --git a/client/widgets/CGarrisonInt.cpp b/client/widgets/CGarrisonInt.cpp index b272d7d9f..59271b7cb 100644 --- a/client/widgets/CGarrisonInt.cpp +++ b/client/widgets/CGarrisonInt.cpp @@ -368,14 +368,15 @@ void CGarrisonSlot::gesture(bool on, const Point & initialPosition, const Point std::vector menuElements = { { RadialMenuConfig::ITEM_NW, hasSameUnit, "stackMerge", "vcmi.radialWheel.mergeSameUnit", [this](){owner->bulkMergeStacks(this);} }, - { RadialMenuConfig::ITEM_NE, stackExists, "stackInfo", "vcmi.radialWheel.showUnitInformation", [this](){viewInfo();} }, + { RadialMenuConfig::ITEM_NE, hasOwnEmptySlots, "stackFillOne", "vcmi.radialWheel.fillSingleUnit", [this](){owner->bulkSplitStack(this);} }, { RadialMenuConfig::ITEM_WW, hasOwnEmptySlots, "stackSplitOne", "vcmi.radialWheel.splitSingleUnit", [this](){splitIntoParts(this->getGarrison(), 1); } }, { RadialMenuConfig::ITEM_EE, hasOwnEmptySlots, "stackSplitEqual", "vcmi.radialWheel.splitUnitEqually", [this](){owner->bulkSmartSplitStack(this);} }, { RadialMenuConfig::ITEM_SW, hasOtherEmptySlots, "heroMove", "vcmi.radialWheel.moveUnit", [this](){owner->moveStackToAnotherArmy(this);} }, { RadialMenuConfig::ITEM_SE, hasAnyEmptySlots, "heroSwap", "vcmi.radialWheel.splitUnit", [this](){ owner->selectSlot(this); owner->splitClick();} }, }; - GH.windows().createAndPushWindow(pos.center(), menuElements); + if (hasAnyEmptySlots || hasSameUnit) + GH.windows().createAndPushWindow(pos.center(), menuElements); } void CGarrisonSlot::update() diff --git a/client/widgets/CWindowWithArtifacts.cpp b/client/widgets/CWindowWithArtifacts.cpp index 5bd2a00a3..3a9c3156a 100644 --- a/client/widgets/CWindowWithArtifacts.cpp +++ b/client/widgets/CWindowWithArtifacts.cpp @@ -165,7 +165,7 @@ void CWindowWithArtifacts::leftClickArtPlaceHero(CArtifactsOfHeroBase & artsInst if constexpr(std::is_same_v>) { - if(!isTransferAllowed) + if(!isTransferAllowed && artPlace.getArt()) { if(closeCallback) closeCallback(); diff --git a/client/widgets/MiscWidgets.cpp b/client/widgets/MiscWidgets.cpp index 6a973bb18..0fe9a83b9 100644 --- a/client/widgets/MiscWidgets.cpp +++ b/client/widgets/MiscWidgets.cpp @@ -17,6 +17,7 @@ #include "../CPlayerInterface.h" #include "../CGameInfo.h" +#include "../PlayerLocalState.h" #include "../widgets/TextControls.h" #include "../widgets/CGarrisonInt.h" #include "../windows/CCastleInterface.h" @@ -31,6 +32,7 @@ #include "../../lib/CModHandler.h" #include "../../lib/GameSettings.h" #include "../../lib/TextOperations.h" +#include "../../lib/mapObjects/CGCreature.h" #include "../../lib/mapObjects/CGHeroInstance.h" #include "../../lib/mapObjects/CGTownInstance.h" @@ -436,6 +438,27 @@ void CInteractableTownTooltip::init(const InfoAboutTown & town) } } +CreatureTooltip::CreatureTooltip(Point pos, const CGCreature * creature) +{ + OBJ_CONSTRUCTION_CAPTURING_ALL_NO_DISPOSE; + + auto creatureData = (*CGI->creh)[creature->stacks.begin()->second->getCreatureID()].get(); + creatureImage = std::make_shared(graphics->getAnimation("TWCRPORT"), creatureData->getIconIndex()); + creatureImage->center(Point(parent->pos.x + parent->pos.w / 2, parent->pos.y + creatureImage->pos.h / 2 + 11)); + + bool isHeroSelected = LOCPLINT->localState->getCurrentHero() != nullptr; + std::string textContent = isHeroSelected + ? creature->getHoverText(LOCPLINT->localState->getCurrentHero()) + : creature->getHoverText(LOCPLINT->playerID); + + //TODO: window is bigger than OH3 + //TODO: vertical alignment does not match H3. Commented below example that matches H3 for creatures count but supports only 1 line: + /*std::shared_ptr = std::make_shared(parent->pos.w / 2, 103, + FONT_SMALL, ETextAlignment::CENTER, Colors::WHITE, creature->getHoverText(LOCPLINT->playerID));*/ + + tooltipTextbox = std::make_shared(textContent, Rect(15, 95, 230, 150), 0, FONT_SMALL, ETextAlignment::TOPCENTER, Colors::WHITE); +} + void MoraleLuckBox::set(const AFactionMember * node) { OBJECT_CONSTRUCTION_CUSTOM_CAPTURING(255-DISPOSE); diff --git a/client/widgets/MiscWidgets.h b/client/widgets/MiscWidgets.h index f2e316cb3..ed45f0ab7 100644 --- a/client/widgets/MiscWidgets.h +++ b/client/widgets/MiscWidgets.h @@ -14,6 +14,7 @@ VCMI_LIB_NAMESPACE_BEGIN class CGGarrison; +class CGCreature; struct InfoAboutArmy; class CArmedInstance; class AFactionMember; @@ -21,6 +22,7 @@ class AFactionMember; VCMI_LIB_NAMESPACE_END class CLabel; +class CTextBox; class CGarrisonInt; class CCreatureAnim; class CComponent; @@ -147,6 +149,15 @@ public: void setAmount(int newAmount); }; +class CreatureTooltip : public CIntObject +{ + std::shared_ptr creatureImage; + std::shared_ptr tooltipTextbox; + +public: + CreatureTooltip(Point pos, const CGCreature * creature); +}; + /// Resource bar like that at the bottom of the adventure map screen class CMinorResDataBar : public CIntObject { diff --git a/client/widgets/TextControls.cpp b/client/widgets/TextControls.cpp index 62d7ddd5d..e4e61a0c5 100644 --- a/client/widgets/TextControls.cpp +++ b/client/widgets/TextControls.cpp @@ -158,6 +158,12 @@ void CTextContainer::blitLine(Canvas & to, Rect destRect, std::string what) where.y += getBorderSize().y; } + if(alignment == ETextAlignment::TOPCENTER) + { + where.x += (int(destRect.w) - int(f->getStringWidth(what) - delimitersCount)) / 2; + where.y += getBorderSize().y; + } + if(alignment == ETextAlignment::CENTER) { where.x += (int(destRect.w) - int(f->getStringWidth(what) - delimitersCount)) / 2; @@ -268,6 +274,7 @@ Rect CMultiLineLabel::getTextLocation() switch(alignment) { case ETextAlignment::TOPLEFT: return Rect(pos.topLeft(), textSize); + case ETextAlignment::TOPCENTER: return Rect(pos.topLeft(), textSize); case ETextAlignment::CENTER: return Rect(pos.topLeft() + textOffset / 2, textSize); case ETextAlignment::BOTTOMRIGHT: return Rect(pos.topLeft() + textOffset, textSize); } @@ -477,6 +484,7 @@ Point CGStatusBar::getBorderSize() switch(alignment) { case ETextAlignment::TOPLEFT: return Point(borderSize.x, borderSize.y); + case ETextAlignment::TOPCENTER: return Point(pos.w / 2, borderSize.y); case ETextAlignment::CENTER: return Point(pos.w / 2, pos.h / 2); case ETextAlignment::BOTTOMRIGHT: return Point(pos.w - borderSize.x, pos.h - borderSize.y); } diff --git a/client/windows/CCreatureWindow.cpp b/client/windows/CCreatureWindow.cpp index 1dc950fec..1e43f7a0a 100644 --- a/client/windows/CCreatureWindow.cpp +++ b/client/windows/CCreatureWindow.cpp @@ -15,6 +15,7 @@ #include "../CGameInfo.h" #include "../CPlayerInterface.h" +#include "../render/Canvas.h" #include "../widgets/Buttons.h" #include "../widgets/CArtifactHolder.h" #include "../widgets/CComponent.h" @@ -84,7 +85,6 @@ public: { } - std::string getName() const { if(commander) @@ -96,11 +96,14 @@ private: }; -CCommanderSkillIcon::CCommanderSkillIcon(std::shared_ptr object_, std::function callback) +CCommanderSkillIcon::CCommanderSkillIcon(std::shared_ptr object_, bool isMasterAbility_, std::function callback) : object(), - callback(callback) + isMasterAbility(isMasterAbility_), + isSelected(false), + callback(callback) { pos = object_->pos; + this->isMasterAbility = isMasterAbility_; setObject(object_); } @@ -117,6 +120,25 @@ void CCommanderSkillIcon::setObject(std::shared_ptr newObject) void CCommanderSkillIcon::clickPressed(const Point & cursorPosition) { callback(); + isSelected = true; +} + +void CCommanderSkillIcon::deselect() +{ + isSelected = false; +} + +bool CCommanderSkillIcon::getIsMasterAbility() +{ + return isMasterAbility; +} + +void CCommanderSkillIcon::show(Canvas &to) +{ + CIntObject::show(to); + + if(isMasterAbility && isSelected) + to.drawBorder(pos, Colors::YELLOW, 2); } static std::string skillToFile(int skill, int level, bool selected) @@ -376,7 +398,7 @@ CStackWindow::CommanderMainSection::CommanderMainSection(CStackWindow * owner, i { Point skillPos = getSkillPos(index); - auto icon = std::make_shared(std::make_shared(getSkillImage(index), skillPos.x, skillPos.y), [=]() + auto icon = std::make_shared(std::make_shared(getSkillImage(index), skillPos.x, skillPos.y), false, [=]() { LOCPLINT->showInfoDialog(getSkillDescription(index)); }); @@ -430,7 +452,7 @@ CStackWindow::CommanderMainSection::CommanderMainSection(CStackWindow * owner, i { const auto bonus = CGI->creh->skillRequirements[skillID-100].first; const CStackInstance * stack = parent->info->commander; - auto icon = std::make_shared(std::make_shared(stack->bonusToGraphics(bonus)), [](){}); + auto icon = std::make_shared(std::make_shared(stack->bonusToGraphics(bonus)), true, [](){}); icon->callback = [=]() { parent->setSelection(skillID, icon); @@ -447,6 +469,7 @@ CStackWindow::CommanderMainSection::CommanderMainSection(CStackWindow * owner, i }; abilities = std::make_shared(onCreate, Point(38, 3+pos.h), Point(63, 0), 6, abilitiesCount); + abilities->setRedrawParent(true); leftBtn = std::make_shared(Point(10, pos.h + 6), "hsbtns3.def", CButton::tooltip(), [=](){ abilities->moveToPrev(); }, EShortcut::MOVE_LEFT); rightBtn = std::make_shared(Point(411, pos.h + 6), "hsbtns5.def", CButton::tooltip(), [=](){ abilities->moveToNext(); }, EShortcut::MOVE_RIGHT); @@ -897,13 +920,22 @@ void CStackWindow::setSelection(si32 newSkill, std::shared_ptrsetObject(std::make_shared(getSkillImage(oldSelection))); if(selectedIcon) - selectedIcon->text = getSkillDescription(oldSelection, false); //update previously selected icon's message to existing skill level + { + if(!selectedIcon->getIsMasterAbility()) //unlike WoG, in VCMI master skill descriptions are taken from bonus descriptions + { + selectedIcon->text = getSkillDescription(oldSelection, false); //update previously selected icon's message to existing skill level + } + selectedIcon->deselect(); + } selectedIcon = newIcon; // update new selection if(newSkill < 100) { newIcon->setObject(std::make_shared(getSkillImage(newSkill))); - newIcon->text = getSkillDescription(newSkill, true); //update currently selected icon's message to show upgrade description + if(!newIcon->getIsMasterAbility()) + { + newIcon->text = getSkillDescription(newSkill, true); //update currently selected icon's message to show upgrade description + } } } diff --git a/client/windows/CCreatureWindow.h b/client/windows/CCreatureWindow.h index 0ffe83a88..4b904cb22 100644 --- a/client/windows/CCreatureWindow.h +++ b/client/windows/CCreatureWindow.h @@ -32,14 +32,20 @@ class CCommanderArtPlace; class CCommanderSkillIcon : public LRClickableAreaWText //TODO: maybe bring commander skill button initialization logic inside? { std::shared_ptr object; // passive object that will be used to determine clickable area + bool isMasterAbility; // refers to WoG abilities obtainable via combining master skills (for example attack + speed unlocks shoot) + bool isSelected; // used only for programatically created border around selected "master abilities" public: - CCommanderSkillIcon(std::shared_ptr object_, std::function callback); + CCommanderSkillIcon(std::shared_ptr object_, bool isMasterAbility_, std::function callback); std::function callback; void clickPressed(const Point & cursorPosition) override; void setObject(std::shared_ptr object); + void deselect(); //TODO: consider using observer pattern instead? + bool getIsMasterAbility(); + + void show(Canvas &to) override; }; class CStackWindow : public CWindowObject diff --git a/client/windows/CHeroBackpackWindow.cpp b/client/windows/CHeroBackpackWindow.cpp index b491bf57d..3455b2b0b 100644 --- a/client/windows/CHeroBackpackWindow.cpp +++ b/client/windows/CHeroBackpackWindow.cpp @@ -14,17 +14,37 @@ #include "../gui/Shortcut.h" #include "../widgets/Buttons.h" +#include "../widgets/Images.h" +#include "CMessage.h" +#include "render/Canvas.h" +#include "CPlayerInterface.h" CHeroBackpackWindow::CHeroBackpackWindow(const CGHeroInstance * hero) - : CWindowObject(PLAYER_COLORED) + : CWindowObject((EOptions)0) { OBJECT_CONSTRUCTION_CAPTURING(255-DISPOSE); - - arts = std::make_shared(Point(-100, -170)); + + stretchedBackground = std::make_shared("DIBOXBCK", Rect()); + + arts = std::make_shared(Point(windowMargin, windowMargin)); arts->setHero(hero); addSet(arts); addCloseCallback(std::bind(&CHeroBackpackWindow::close, this)); - quitButton = std::make_shared(Point(242, 200), "hsbtns.def", CButton::tooltip(""), [this]() { close(); }, EShortcut::GLOBAL_RETURN); + quitButton = std::make_shared(Point(), "IOKAY32.def", CButton::tooltip(""), [this]() { close(); }, EShortcut::GLOBAL_RETURN); + + stretchedBackground->pos.w = arts->pos.w + 2 * windowMargin; + stretchedBackground->pos.h = arts->pos.h + quitButton->pos.h + 3 * windowMargin; + pos.w = stretchedBackground->pos.w; + pos.h = stretchedBackground->pos.h; + center(); + + quitButton->moveBy(Point(GH.screenDimensions().x / 2 - quitButton->pos.w / 2 - quitButton->pos.x, arts->pos.h + 2 * windowMargin)); +} + +void CHeroBackpackWindow::showAll(Canvas & to) +{ + CIntObject::showAll(to); + CMessage::drawBorder(PlayerColor(LOCPLINT->playerID), to.getInternalSurface(), pos.w+28, pos.h+29, pos.x-14, pos.y-15); } diff --git a/client/windows/CHeroBackpackWindow.h b/client/windows/CHeroBackpackWindow.h index fefd1902d..73d736b0a 100644 --- a/client/windows/CHeroBackpackWindow.h +++ b/client/windows/CHeroBackpackWindow.h @@ -12,6 +12,8 @@ #include "../widgets/CWindowWithArtifacts.h" #include "CWindowObject.h" +class CFilledTexture; + class CHeroBackpackWindow : public CWindowObject, public CWindowWithArtifacts { public: @@ -20,4 +22,8 @@ public: private: std::shared_ptr arts; std::shared_ptr quitButton; + std::shared_ptr stretchedBackground; + const int windowMargin = 10; + + void showAll(Canvas & to) override; }; diff --git a/client/windows/CHeroWindow.cpp b/client/windows/CHeroWindow.cpp index 771d4a521..55f26c829 100644 --- a/client/windows/CHeroWindow.cpp +++ b/client/windows/CHeroWindow.cpp @@ -84,11 +84,20 @@ CHeroWindow::CHeroWindow(const CGHeroInstance * hero) quitButton = std::make_shared(Point(609, 516), "hsbtns.def", CButton::tooltip(heroscrn[17]), [=](){ close(); }, EShortcut::GLOBAL_RETURN); - dismissLabel = std::make_shared(CGI->generaltexth->jktexts[8], Rect(370, 430, 65, 35), 0, FONT_SMALL, ETextAlignment::TOPLEFT, Colors::WHITE); - dismissButton = std::make_shared(Point(454, 429), "hsbtns2.def", CButton::tooltip(heroscrn[28]), [=](){ dismissCurrent(); }, EShortcut::HERO_DISMISS); - - questlogLabel = std::make_shared(CGI->generaltexth->jktexts[9], Rect(510, 430, 65, 35), 0, FONT_SMALL, ETextAlignment::TOPLEFT, Colors::WHITE); - questlogButton = std::make_shared(Point(314, 429), "hsbtns4.def", CButton::tooltip(heroscrn[0]), [=](){ LOCPLINT->showQuestLog(); }, EShortcut::ADVENTURE_QUEST_LOG); + if(settings["general"]["enableUiEnhancements"].Bool()) + { + questlogButton = std::make_shared(Point(314, 429), "hsbtns4.def", CButton::tooltip(heroscrn[0]), [=](){ LOCPLINT->showQuestLog(); }, EShortcut::ADVENTURE_QUEST_LOG); + backpackButton = std::make_shared(Point(424, 429), "buttons/backpack", CButton::tooltipLocalized("vcmi.heroWindow.openBackpack"), [=](){ createBackpackWindow(); }, EShortcut::HERO_BACKPACK); + backpackButton->addOverlay(std::make_shared("buttons/backpackButtonIcon")); + dismissButton = std::make_shared(Point(534, 429), "hsbtns2.def", CButton::tooltip(heroscrn[28]), [=](){ dismissCurrent(); }, EShortcut::HERO_DISMISS); + } + else + { + dismissLabel = std::make_shared(CGI->generaltexth->jktexts[8], Rect(370, 430, 65, 35), 0, FONT_SMALL, ETextAlignment::TOPLEFT, Colors::WHITE); + questlogLabel = std::make_shared(CGI->generaltexth->jktexts[9], Rect(510, 430, 65, 35), 0, FONT_SMALL, ETextAlignment::TOPLEFT, Colors::WHITE); + dismissButton = std::make_shared(Point(454, 429), "hsbtns2.def", CButton::tooltip(heroscrn[28]), [=](){ dismissCurrent(); }, EShortcut::HERO_DISMISS); + questlogButton = std::make_shared(Point(314, 429), "hsbtns4.def", CButton::tooltip(heroscrn[0]), [=](){ LOCPLINT->showQuestLog(); }, EShortcut::ADVENTURE_QUEST_LOG); + } formations = std::make_shared(0); formations->addToggle(0, std::make_shared(Point(481, 483), "hsbtns6.def", std::make_pair(heroscrn[23], heroscrn[29]), 0, EShortcut::HERO_TIGHT_FORMATION)); diff --git a/client/windows/CKingdomInterface.cpp b/client/windows/CKingdomInterface.cpp index 300092027..d81acf5a9 100644 --- a/client/windows/CKingdomInterface.cpp +++ b/client/windows/CKingdomInterface.cpp @@ -555,7 +555,7 @@ std::shared_ptr CKingdomInterface::createMainTab(size_t index) void CKingdomInterface::generateMinesList(const std::vector & ownedObjects) { ui32 footerPos = OVERVIEW_SIZE * 116; - TResources minesCount(GameConstants::RESOURCE_QUANTITY, 0); + ResourceSet minesCount = ResourceSet(); int totalIncome=0; for(const CGObjectInstance * object : ownedObjects) diff --git a/client/windows/GUIClasses.cpp b/client/windows/GUIClasses.cpp index e921cdf88..bba9a5d5d 100644 --- a/client/windows/GUIClasses.cpp +++ b/client/windows/GUIClasses.cpp @@ -749,6 +749,9 @@ void CExchangeController::moveStack( SlotID sourceSlot) { auto creature = source->getCreature(sourceSlot); + if(creature == nullptr) + return; + SlotID targetSlot = target->getSlotFor(creature); if(targetSlot.validSlot()) diff --git a/client/windows/InfoWindows.cpp b/client/windows/InfoWindows.cpp index 4b9a541bb..55d716884 100644 --- a/client/windows/InfoWindows.cpp +++ b/client/windows/InfoWindows.cpp @@ -35,6 +35,7 @@ #include "../../lib/CConfigHandler.h" #include "../../lib/CondSh.h" #include "../../lib/CGeneralTextHandler.h" //for Unicode related stuff +#include "../../lib/mapObjects/CGCreature.h" #include "../../lib/mapObjects/CGHeroInstance.h" #include "../../lib/mapObjects/CGTownInstance.h" #include "../../lib/mapObjects/MiscObjects.h" @@ -243,6 +244,9 @@ CInfoPopup::CInfoPopup(SDL_Surface * Bitmap, const Point &p, ETextAlignment alig case ETextAlignment::TOPLEFT: init(p.x, p.y); break; + case ETextAlignment::TOPCENTER: + init(p.x - Bitmap->w/2, p.y); + break; default: assert(0); //not implemented } @@ -333,7 +337,7 @@ void CRClickPopup::createAndPush(const std::string & txt, std::shared_ptr(Point(9, 10), iah); } -std::shared_ptr CRClickPopup::createInfoWin(Point position, const CGObjectInstance * specific) //specific=0 => draws info about selected town/hero +CInfoBoxPopup::CInfoBoxPopup(Point position, const CGCreature * creature) + : CWindowObject(RCLICK_POPUP | BORDERED, "DIBOXBCK", toScreen(position)) +{ + OBJECT_CONSTRUCTION_CAPTURING(255-DISPOSE); + tooltip = std::make_shared(Point(9, 10), creature); +} + +std::shared_ptr CRClickPopup::createCustomInfoWindow(Point position, const CGObjectInstance * specific) //specific=0 => draws info about selected town/hero { if(nullptr == specific) specific = LOCPLINT->localState->getCurrentArmy(); if(nullptr == specific) { - logGlobal->error("createInfoWin: no object to describe"); + logGlobal->error("createCustomInfoWindow: no object to describe"); return nullptr; } @@ -418,6 +429,8 @@ std::shared_ptr CRClickPopup::createInfoWin(Point position, const CG return std::make_shared(position, dynamic_cast(specific)); case Obj::TOWN: return std::make_shared(position, dynamic_cast(specific)); + case Obj::MONSTER: + return std::make_shared(position, dynamic_cast(specific)); case Obj::GARRISON: case Obj::GARRISON2: return std::make_shared(position, dynamic_cast(specific)); diff --git a/client/windows/InfoWindows.h b/client/windows/InfoWindows.h index caf9bfa03..ec84a6693 100644 --- a/client/windows/InfoWindows.h +++ b/client/windows/InfoWindows.h @@ -16,6 +16,7 @@ VCMI_LIB_NAMESPACE_BEGIN class CGGarrison; +class CGCreature; class Rect; VCMI_LIB_NAMESPACE_END @@ -78,7 +79,7 @@ public: virtual void close(); bool isPopupWindow() const override; - static std::shared_ptr createInfoWin(Point position, const CGObjectInstance * specific); + static std::shared_ptr createCustomInfoWindow(Point position, const CGObjectInstance * specific); static void createAndPush(const std::string & txt, const CInfoWindow::TCompsInfo &comps = CInfoWindow::TCompsInfo()); static void createAndPush(const std::string & txt, std::shared_ptr component); static void createAndPush(const CGObjectInstance * obj, const Point & p, ETextAlignment alignment = ETextAlignment::BOTTOMRIGHT); @@ -108,15 +109,16 @@ public: ~CInfoPopup(); }; -/// popup on adventure map for town\hero objects +/// popup on adventure map for town\hero and other objects with customized popup content class CInfoBoxPopup : public CWindowObject { - std::shared_ptr tooltip; + std::shared_ptr tooltip; Point toScreen(Point pos); public: CInfoBoxPopup(Point position, const CGTownInstance * town); CInfoBoxPopup(Point position, const CGHeroInstance * hero); CInfoBoxPopup(Point position, const CGGarrison * garr); + CInfoBoxPopup(Point position, const CGCreature * creature); }; /// component selection window diff --git a/client/windows/settings/BattleOptionsTab.cpp b/client/windows/settings/BattleOptionsTab.cpp index 99f874a4e..1e657d61c 100644 --- a/client/windows/settings/BattleOptionsTab.cpp +++ b/client/windows/settings/BattleOptionsTab.cpp @@ -64,6 +64,10 @@ BattleOptionsTab::BattleOptionsTab(BattleInterface * owner) { showStickyHeroWindowsChangedCallback(value, owner); }); + addCallback("enableAutocombatSpellsChanged", [this](bool value) + { + enableAutocombatSpellsChangedCallback(value); + }); build(config); std::shared_ptr animationSpeedToggle = widget("animationSpeedPicker"); @@ -92,6 +96,9 @@ BattleOptionsTab::BattleOptionsTab(BattleInterface * owner) std::shared_ptr skipBattleIntroMusicCheckbox = widget("skipBattleIntroMusicCheckbox"); skipBattleIntroMusicCheckbox->setSelected(settings["gameTweaks"]["skipBattleIntroMusic"].Bool()); + + std::shared_ptr enableAutocombatSpellsCheckbox = widget("enableAutocombatSpellsCheckbox"); + enableAutocombatSpellsCheckbox->setSelected(settings["battle"]["enableAutocombatSpells"].Bool()); } int BattleOptionsTab::getAnimSpeed() const @@ -235,3 +242,9 @@ void BattleOptionsTab::skipBattleIntroMusicChangedCallback(bool value) musicSkipSettingValue->Bool() = value; } +void BattleOptionsTab::enableAutocombatSpellsChangedCallback(bool value) +{ + Settings enableAutocombatSpells = settings.write["battle"]["enableAutocombatSpells"]; + enableAutocombatSpells->Bool() = value; +} + diff --git a/client/windows/settings/BattleOptionsTab.h b/client/windows/settings/BattleOptionsTab.h index 6a71d2e68..43d4d7e50 100644 --- a/client/windows/settings/BattleOptionsTab.h +++ b/client/windows/settings/BattleOptionsTab.h @@ -32,6 +32,7 @@ private: void queueSizeChangedCallback(int value, BattleInterface * parentBattleInterface); void skipBattleIntroMusicChangedCallback(bool value); void showStickyHeroWindowsChangedCallback(bool value, BattleInterface * parentBattleInterface); + void enableAutocombatSpellsChangedCallback(bool value); public: BattleOptionsTab(BattleInterface * owner = nullptr); }; diff --git a/cmake_modules/VCMI_lib.cmake b/cmake_modules/VCMI_lib.cmake index 70c41549a..15efa56c2 100644 --- a/cmake_modules/VCMI_lib.cmake +++ b/cmake_modules/VCMI_lib.cmake @@ -322,6 +322,7 @@ macro(add_main_lib TARGET_NAME LIBRARY_TYPE) ${MAIN_LIB_DIR}/../include/vcmi/Team.h ${MAIN_LIB_DIR}/battle/AccessibilityInfo.h + ${MAIN_LIB_DIR}/battle/AutocombatPreferences.h ${MAIN_LIB_DIR}/battle/BattleAction.h ${MAIN_LIB_DIR}/battle/BattleAttackInfo.h ${MAIN_LIB_DIR}/battle/BattleHex.h diff --git a/cmake_modules/VersionDefinition.cmake b/cmake_modules/VersionDefinition.cmake index e90590d32..7c87e116c 100644 --- a/cmake_modules/VersionDefinition.cmake +++ b/cmake_modules/VersionDefinition.cmake @@ -1,6 +1,6 @@ set(VCMI_VERSION_MAJOR 1) set(VCMI_VERSION_MINOR 3) -set(VCMI_VERSION_PATCH 1) +set(VCMI_VERSION_PATCH 2) add_definitions( -DVCMI_VERSION_MAJOR=${VCMI_VERSION_MAJOR} -DVCMI_VERSION_MINOR=${VCMI_VERSION_MINOR} diff --git a/config/factions/neutral.json b/config/factions/neutral.json index 580a14c21..4a1d55a52 100644 --- a/config/factions/neutral.json +++ b/config/factions/neutral.json @@ -5,6 +5,7 @@ "index" : 9, "nativeTerrain" : "none", "alignment" : "neutral", + "boat" : "boatFortress", "creatureBackground" : { "120px" : "TPCASNEU", diff --git a/config/objects/generic.json b/config/objects/generic.json index 602f314cc..49c6e01ca 100644 --- a/config/objects/generic.json +++ b/config/objects/generic.json @@ -870,7 +870,15 @@ }, "marketOfTime" : { // Unused/not implemented H3 object present on some RoE maps "index" :50, - "handler": "generic" + "handler": "generic", + "types" : { + "object" : { + "index" : 0, + "aiValue" : 0, + "rmg" : { + } + } + } }, "tavern" : { "index" :95, diff --git a/config/schemas/artifact.json b/config/schemas/artifact.json index 88a4f4e68..5a7aed863 100644 --- a/config/schemas/artifact.json +++ b/config/schemas/artifact.json @@ -123,7 +123,7 @@ }, "onlyOnWaterMap" : { "type" : "boolean", - "description" : "It true, artifact won't spawn on a map without water" + "description" : "If set to true, artifact won't spawn on a map without water" } } } diff --git a/config/schemas/bonus.json b/config/schemas/bonus.json index 49d9c62ba..e578243e0 100644 --- a/config/schemas/bonus.json +++ b/config/schemas/bonus.json @@ -158,10 +158,10 @@ "description" : "addInfo" }, "duration" : { - "anyOf" : [ - { "type" : "string"}, - { "type" : "array", "items" : {"type" : "string"} } - ], + "anyOf" : [ + { "type" : "string"}, + { "type" : "array", "items" : {"type" : "string"} } + ], "description" : "duration" }, "turns" : { diff --git a/config/schemas/creature.json b/config/schemas/creature.json index 71bc352eb..58a09ca12 100644 --- a/config/schemas/creature.json +++ b/config/schemas/creature.json @@ -23,7 +23,7 @@ }, "disabled" : { "type" : "boolean", - "description" : "Object is competely disabled and may not be even loaded in-game" + "description" : "Internal. Object is competely disabled and may not be even loaded in-game" }, "name" : { "type" : "object", @@ -122,26 +122,22 @@ "$ref" : "bonus.json" } }, - "abilityText" : { - "type" : "string", - "description" : "Text version of creature abilities. Used only with original creature window" - }, "graphics" : { "type" : "object", "additionalProperties" : false, - "description" : "Describes how this creature looks like during battles", + "description" : "Describes how this creature looks like", "required" : [ "animation", "animationTime", "timeBetweenFidgets" ], "properties" : { "animation" : { "type" : "string", - "description" : ".def file with animation of this creature in battles", + "description" : "File with animation of this creature in battles", "format" : "defFile" }, "map" : { "type" : "string", - "description" : ".def file with animation of this creature on adventure map", + "description" : "File with animation of this creature on adventure map", "format" : "defFile" }, "mapMask" : { @@ -247,7 +243,7 @@ }, "attackClimaxFrame" : { "type" : "number", - "description" : "Frame from attack animation during which creature deals damage" + "description" : "Frame at which shooter shoots his projectile (e.g. releases arrow)" } } }, @@ -264,7 +260,7 @@ "sound" : { "type" : "object", "additionalProperties" : false, - "description" : "Various sound files associated with this creature", + "description" : "Sound files associated with this creature", "properties" : { "attack" : { "type" : "string", "format" : "soundFile" }, "defend" : { "type" : "string", "format" : "soundFile" }, diff --git a/config/schemas/faction.json b/config/schemas/faction.json index e0a09f02d..8aabe60ca 100644 --- a/config/schemas/faction.json +++ b/config/schemas/faction.json @@ -30,20 +30,20 @@ "$schema" : "http://json-schema.org/draft-04/schema", "title" : "VCMI faction format", "description" : "Json format for defining new faction (aka towns) in VCMI", - "required" : [ "name", "alignment", "nativeTerrain", "creatureBackground" ], + "required" : [ "name", "boat", "alignment", "nativeTerrain", "creatureBackground" ], "dependencies" : { - "town" : [ "puzzleMap", "boat" ] + "town" : [ "puzzleMap" ] }, "additionalProperties" : false, "properties" : { "name" : { "type" : "string", - "description" : "Translatable name of town" + "description" : "Localizable faction name, e.g. Rampart" }, "alignment" : { "type" : "string", "enum" : [ "good", "neutral", "evil" ], - "description" : "Town alignment, good, neutral or evil" + "description" : "Faction alignment, good, neutral or evil" }, "nativeTerrain" : { "type" : "string", @@ -51,12 +51,12 @@ }, "boat" : { "type" : "string", - "description" : "Identifier of boat type that is produced by shipyard in town, if any" + "description" : "Identifier of boat type that is produced by shipyard and used by heroes in water taverns or prisons" }, "preferUndergroundPlacement" : { "type" : "boolean", - "description" : "Random map generator places player/cpu-owned towns underground if true is specified and on the ground otherwise. Parameter is unused for maps without underground. False by default." + "description" : "Random map generator places player/cpu-owned towns underground if true is specified and on the ground otherwise. Parameter is unused for maps without underground." }, "creatureBackground" : { "type" : "object", @@ -173,7 +173,7 @@ }, "buildingsIcons" : { "type" : "string", - "description" : "Path to .def file with building icons", + "description" : "Path to building icons for town hall", "format" : "animationFile" }, "mapObject" : { diff --git a/config/schemas/hero.json b/config/schemas/hero.json index 8516885da..3b434ae07 100644 --- a/config/schemas/hero.json +++ b/config/schemas/hero.json @@ -16,19 +16,19 @@ "properties" : { "special" : { "type" : "boolean", - "description" : "Marks this object as special and not available by default" + "description" : "If set to true hero will be unavailable on start and won't appear in taverns (campaign heroes)" }, "class" : { "type" : "string", - "description" : "Hero class, e.g. knight or battleMage" + "description" : "Identifier of class this hero belongs to. Such as knight or battleMage" }, "female" : { "type" : "boolean", - "description" : "This hero is female (changeable via editor)" + "description" : "Set to true if the hero is female by default (can be changed in map editor)" }, "battleImage" : { "type" : "string", - "description" : "Custom def used on battle", + "description" : "Custom animation to be used on battle, overrides hero class property", "format" : "defFile" }, "images" : { @@ -174,11 +174,11 @@ }, "onlyOnWaterMap" : { "type" : "boolean", - "description" : "It true, hero won't show up on a map with water" + "description" : "If set to true, hero won't show up on a map with water" }, "onlyOnMapWithoutWater" : { "type" : "boolean", - "description" : "It true, hero will show up only if the map contains no water" + "description" : "If set to true, hero will show up only if the map contains no water" } } } diff --git a/config/schemas/heroClass.json b/config/schemas/heroClass.json index ec3bc5151..c090a1816 100644 --- a/config/schemas/heroClass.json +++ b/config/schemas/heroClass.json @@ -16,7 +16,7 @@ }, "faction" : { "type" : "string", - "description" : "Faction this hero class belongs to" + "description" : "Identifier of faction this class belongs to" }, "affinity" : { "type" : "string", diff --git a/config/schemas/objectTemplate.json b/config/schemas/objectTemplate.json index 3e766f8ce..9450f5af8 100644 --- a/config/schemas/objectTemplate.json +++ b/config/schemas/objectTemplate.json @@ -14,11 +14,11 @@ "editorAnimation" : { "type" : "string", "description" : "Optional path to def file with animation of this object to use in map editor", - "format" : "defFile" + "format" : "defFile" }, "visitableFrom" : { "type" : "array", - "description" : "Directions from which this object is visible", + "description" : "Directions from which hero can visit this object", "minItems" : 3, "maxItems" : 3, "items" : { diff --git a/config/schemas/settings.json b/config/schemas/settings.json index 20699af25..3dbbaf0b1 100644 --- a/config/schemas/settings.json +++ b/config/schemas/settings.json @@ -38,7 +38,8 @@ "autosaveCountLimit", "useSavePrefix", "savePrefix", - "startTurnAutosave" + "startTurnAutosave", + "enableUiEnhancements" ], "properties" : { "playerName" : { @@ -126,6 +127,10 @@ "startTurnAutosave" : { "type": "boolean", "default": false + }, + "enableUiEnhancements" : { + "type": "boolean", + "default": true } } }, @@ -209,11 +214,15 @@ "type" : "object", "additionalProperties" : false, "default" : {}, - "required" : [ "radialWheelGarrisonSwipe" ], + "required" : [ "radialWheelGarrisonSwipe", "touchToleranceDistance" ], "properties" : { "radialWheelGarrisonSwipe" : { "type" : "boolean", "default" : true + }, + "touchToleranceDistance" : { + "type" : "number", + "default" : 20 } } }, @@ -241,7 +250,7 @@ }, "quickCombat" : { "type" : "boolean", - "default" : false + "default" : true }, "objectAnimation" : { "type" : "boolean", @@ -272,7 +281,7 @@ "type" : "object", "additionalProperties" : false, "default" : {}, - "required" : [ "speedFactor", "mouseShadow", "cellBorders", "stackRange", "movementHighlightOnHover", "rangeLimitHighlightOnHover", "showQueue", "swipeAttackDistance", "queueSize", "stickyHeroInfoWindows" ], + "required" : [ "speedFactor", "mouseShadow", "cellBorders", "stackRange", "movementHighlightOnHover", "rangeLimitHighlightOnHover", "showQueue", "swipeAttackDistance", "queueSize", "stickyHeroInfoWindows", "enableAutocombatSpells" ], "properties" : { "speedFactor" : { "type" : "number", @@ -314,6 +323,10 @@ "stickyHeroInfoWindows" : { "type" : "boolean", "default" : true + }, + "enableAutocombatSpells" : { + "type": "boolean", + "default": true } } }, diff --git a/config/schemas/skill.json b/config/schemas/skill.json index 85958af20..12a77f4af 100644 --- a/config/schemas/skill.json +++ b/config/schemas/skill.json @@ -15,7 +15,7 @@ }, "images" : { "type" : "object", - "description" : "skill icons of varying size", + "description" : "Skill icons of varying size", "properties" : { "small" : { "type" : "string", @@ -47,11 +47,11 @@ "properties" : { "name" : { "type" : "string", - "description" : "localizable skill name" + "description" : "Mandatory, localizable skill name" }, "index" : { "type" : "number", - "description" : "numeric id of skill, required for existing skills" + "description" : "Internal, numeric id of skill, required for existing skills" }, "obligatoryMajor" : { "type" : "boolean", @@ -63,22 +63,16 @@ }, "gainChance" : { "description" : "Chance for the skill to be offered on level-up (heroClass may override)", - "anyOf" : [ - { - "type" : "number" - }, - { - "type" : "object", - "required" : ["might", "magic"], - "properties" : { - "might" : { - "type" : "number", - "description" : "Chance for hero classes with might affinity" - }, - "magic" : { - "type" : "number", - "description" : "Chance for hero classes with magic affinity" - } + "type" : "object", + "required" : ["might", "magic"], + "properties" : { + "might" : { + "type" : "number", + "description" : "Chance for hero classes with might affinity" + }, + "magic" : { + "type" : "number", + "description" : "Chance for hero classes with magic affinity" } } ] diff --git a/config/schemas/townBuilding.json b/config/schemas/townBuilding.json index c06dbf3f6..43b1344ee 100644 --- a/config/schemas/townBuilding.json +++ b/config/schemas/townBuilding.json @@ -27,11 +27,11 @@ "description" : "Numeric identifier of this building" }, "name" : { - "description" : "Name of this building", + "description" : "Localizable name of this building", "type" : "string" }, "description" : { - "description" : "Full decsription of this building", + "description" : "Localizable decsription of this building", "type" : "string" }, "type" : { @@ -53,13 +53,13 @@ "description" : "List of town buildings that must be built before this one" }, "upgrades" : { - "description" : "If this building is upgrade, identifier of base building", + "description" : "Optional, indicates that this building upgrades another base building", "type" : "string" }, "cost" : { "type" : "object", "additionalProperties" : false, - "description" : "Cost to build this building", + "description" : "Resources needed to build building", "properties" : { "gold" : { "type" : "number"}, "wood" : { "type" : "number"}, @@ -69,11 +69,11 @@ "crystal" : { "type" : "number"}, "gems" : { "type" : "number"} } - }, + }, "produce" : { "type" : "object", "additionalProperties" : false, - "description" : "Resources this building produce each day", + "description" : "Resources produced each day by this building", "properties" : { "gold" : { "type" : "number"}, "wood" : { "type" : "number"}, diff --git a/config/schemas/townStructure.json b/config/schemas/townStructure.json index 9dce55d04..c66cdc7eb 100644 --- a/config/schemas/townStructure.json +++ b/config/schemas/townStructure.json @@ -21,7 +21,7 @@ }, "area" : { "type" : "string", - "description" : "Area that indicate when building is selected. Must be 8-bit image", + "description" : "Area that indicate when building is selected.", "format" : "imageFile" }, "border" : { diff --git a/config/widgets/adventureMap.json b/config/widgets/adventureMap.json index c73932bf2..36dd1e501 100644 --- a/config/widgets/adventureMap.json +++ b/config/widgets/adventureMap.json @@ -126,7 +126,7 @@ "playerColored" : true, "area": { "top" : 0, "left": 0, "width" : 32, "height" : 32 } } - ], + ] }, { "type": "adventureMapContainer", @@ -142,7 +142,7 @@ "playerColored" : true, "area": { "top" : 0, "left": 0, "width" : 32, "height" : 32 } } - ], + ] }, { "type": "adventureMapButton", @@ -507,12 +507,19 @@ "area": { "top" : 23, "left": 128, "width" : 60, "height" : 32 } }, { - "type": "adventureMapButton", - "name": "worldViewSurface", - "image" : "IAM003.DEF", - "hotkey": "adventureToggleMapLevel", - "playerColored" : true, - "area": { "top" : 79, "left": 343, "width" : 32, "height" : 32 } + "type": "adventureMapContainer", + "hideWhen" : "mapLayerSurface", + "area": { "top" : 343, "left": 79, "width" : 32, "height" : 32 } + "items" : [ + { + "type": "adventureMapButton", + "name": "worldViewSurface", + "image" : "IAM003.DEF", + "hotkey": "adventureToggleMapLevel", + "playerColored" : true, + "area": { "top" : 0, "left": 0, "width" : 32, "height" : 32 } + } + ] }, { "type": "adventureMapButton", @@ -523,12 +530,19 @@ "area": { "top" : 343, "left": 5, "width" : 66, "height" : 32 } }, { - "type": "adventureMapButton", - "name": "worldViewUnderground", - "image" : "IAM010.DEF", - "playerColored" : true, - "hotkey": "adventureToggleMapLevel", + "type": "adventureMapContainer", + "hideWhen" : "mapLayerUnderground", "area": { "top" : 343, "left": 79, "width" : 32, "height" : 32 } + "items" : [ + { + "type": "adventureMapButton", + "name": "worldViewUnderground", + "image" : "IAM010.DEF", + "playerColored" : true, + "hotkey": "adventureToggleMapLevel", + "area": { "top" : 0, "left": 0, "width" : 32, "height" : 32 } + } + ] }, { "type": "adventureMapButton", diff --git a/config/widgets/settings/battleOptionsTab.json b/config/widgets/settings/battleOptionsTab.json index 0fde2a031..8f47a3fd5 100644 --- a/config/widgets/settings/battleOptionsTab.json +++ b/config/widgets/settings/battleOptionsTab.json @@ -51,14 +51,37 @@ ] }, { - "name": "autoCombatCheckboxes", + "name": "autoCombatFakeCheckboxes", "type" : "verticalLayout", "customType" : "checkboxFake", "position": {"x": 380, "y": 83}, "items": [ - {}, - {}, + {} + ] + }, + + { + "type" : "verticalLayout", + "customType" : "checkbox", + "position": {"x": 380, "y": 113}, + "items": + [ + { + "name": "enableAutocombatSpellsCheckbox", + "help": "vcmi.battleOptions.enableAutocombatSpells", + "callback": "enableAutocombatSpellsChanged" + } + ] + }, + + { + "name": "autoCombatFakeCheckboxes2", + "type" : "verticalLayout", + "customType" : "checkboxFake", + "position": {"x": 380, "y": 143}, + "items": + [ {}, {}, {} diff --git a/debian/changelog b/debian/changelog index f7e3380cc..0761d2ed4 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +vcmi (1.3.2) jammy; urgency=medium + + * New upstream release + + -- Ivan Savenko Fri, 15 Sep 2023 16:00:00 +0200 + vcmi (1.3.1) jammy; urgency=medium * New upstream release diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 000000000..77ccb0964 --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,81 @@ +[![GitHub](https://github.com/vcmi/vcmi/actions/workflows/github.yml/badge.svg)](https://github.com/vcmi/vcmi/actions/workflows/github.yml) +[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.3.0/total)](https://github.com/vcmi/vcmi/releases/tag/1.3.0) +[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.3.1/total)](https://github.com/vcmi/vcmi/releases/tag/1.3.1) +[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.3.2/total)](https://github.com/vcmi/vcmi/releases/tag/1.3.2) +[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/total)](https://github.com/vcmi/vcmi/releases) + +# VCMI Project + +VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities. + +## Links + + * Homepage: https://vcmi.eu/ + * Forums: https://forum.vcmi.eu/ + * Bugtracker: https://github.com/vcmi/vcmi/issues + * Slack: https://slack.vcmi.eu/ + * Discord: https://discord.gg/chBT42V + +## Latest release + +Latest release can be found [in Github Releases page](https://github.com/vcmi/vcmi/releases/latest). As of right now we plan to have major releases around 3 times per year. Daily builds are still available at [builds.vcmi.download](https://builds.vcmi.download/branch/develop/) but they are not guaranteed to be stable. So we encourage everybody to use them and report found bugs so that we can fix them. +Loading saves made with different major version of VCMI is usually **not** supported, so you may want to finish your ongoing games before updating. +Please see corresponding installation guide articles for details for your platform. + +## Installation guides +- [Windows](players/Installation_Windows.md) +- [macOS](players/Installation_macOS.md) +- [Linux](players/Installation_Linux.md) +- [Android](players/Installation_Android.md) +- [iOS](players/Installation_iOS.md) + +## Documentation and guidelines for players + +- [General information about VCMI Project](players/Manual.md) +- [Frequently asked questions](https://vcmi.eu/faq/) (external link) +- [Game mechanics](players/Game_Mechanics.md) +- [Bug reporting guidelines](players/Bug_Reporting_Guidelines.md) +- [Cheat codes](players/Cheat_Codes.md) +- [Privacy Policy](players/Privacy_Policy.md) + +## Documentation and guidelines for game modders + +- [Modding Guidelines](modders/Readme.md) +- [Mod File Format](modders/Mod_File_Format.md) +- [Bonus Format](modders/Bonus_Format.md) +- [Translations](modders/Translations.md) +- [Map Editor](modders/Map_Editor.md) +- [Campaign Format](modders/Campaign_Format.md) +- [Configurable Widgets](modders/Configurable_Widgets.md) + +## Documentation and guidelines for developers + +Development environment setup instructions: +- [Building VCMI for Android](developers/Building_Android.md) +- [Building VCMI for iOS](developers/Building_iOS.md) +- [Building VCMI for Linux](developers/Building_Linux.md) +- [Building VCMI for macOS](developers/Building_macOS.md) +- [Building VCMI for Windows](developers/Building_Windows.md) +- [Conan](developers/Conan.md) + +Engine documentation: (NOTE: may be outdated) +- [Development with Qt Creator](developers/Development_with_Qt_Creator.md) +- [Coding Guidelines](developers/Coding_Guidelines.md) +- [Bonus System](developers/Bonus_System.md) +- [Code Structure](developers/Code_Structure.md) +- [Logging API](developers/Logging_API.md) +- [Lua Scripting System](developers/Lua_Scripting_System.md) +- [Serialization](developers/Serialization.md) + +## Documentation and guidelines for maintainers + +- [Project Infrastructure](maintainers/Project_Infrastructure.md) +- [Release Process](maintainers/Release_Process.md) +- [Ubuntu PPA](maintainers/Ubuntu_PPA.md) + +## Copyright and license + +VCMI Project source code is licensed under GPL version 2 or later. +VCMI Project assets are licensed under CC-BY-SA 4.0. Assets sources and information about contributors are available under following link: https://github.com/vcmi/vcmi-assets + +Copyright (C) 2007-2023 VCMI Team (check AUTHORS file for the contributors list) diff --git a/docs/developers/BattleField.png b/docs/developers/BattleField.png new file mode 100644 index 000000000..90022a324 Binary files /dev/null and b/docs/developers/BattleField.png differ diff --git a/docs/developers/Bonus_System.md b/docs/developers/Bonus_System.md new file mode 100644 index 000000000..addb66530 --- /dev/null +++ b/docs/developers/Bonus_System.md @@ -0,0 +1,76 @@ +< [Documentation](../Readme.md) / Bonus System + +The bonus system of VCMI is a set of mechanisms that make handling of different bonuses for heroes, towns, players and units easier. The system consists of a set of nodes representing objects that can be a source or a subject of a bonus and two directed acyclic graphs (DAGs) representing inheritance and propagation of bonuses. Core of bonus system is defined in HeroBonus.h file. + +## Propagation and inheritance + +Each bonus originates from some node in the bonus system, and may have propagator and limiter objects attached to it. Bonuses are shared around as follows: + +1. Bonuses with propagator are propagated to "matching" descendants in the red DAG - which descendants match is determined by the propagator. Bonuses without a propagator will not be propagated. +2. Bonuses without limiters are inherited by all descendants in the black DAG. If limiters are present, they can restrict inheritance to certain nodes. + +Inheritance is the default means of sharing bonuses. A typical example is an artefact granting a bonus to attack/defense stat, which is inherited by the hero wearing it, and then by creatures in the hero's army. +A common limiter is by creature - e.g. the hero Eric has a specialty that grants bonuses to attack, defense and speed, but only to griffins. +Propagation is used when bonuses need to be shared in a different direction than the black DAG for inheritance. E.g. Magi and Archmagi on the battlefield reduce the cost of spells for the controlling hero. + +### Technical Details + +- Propagation is done by copying bonuses to the target nodes. This happens when bonuses are added. +- Inheritance is done on-the-fly when needed, by traversing the black DAG. Results are cached to improve performance. +- Whenever a node changes (e.g. bonus added), a global counter gets increased which is used to check whether cached results are still current. + +## Operations on the graph + +There are two basic types of operations that can be performed on the graph: + +### Adding a new node + +When node is attached to a new black parent (the only possibility - adding parent is the same as adding a child to it), the propagation system is triggered and works as follows: +- For the attached node and its all red ancestors +- For every bonus +- Call propagator giving the new descendant - then attach appropriately bonuses to the red descendant of attached node (or the node itself). + +E.g. when a hero equips an artifact, the hero gets attached to the artifact to inherit its bonuses. + +### Deleting an existing node + +Analogically to the adding a new node, just remove propagated bonuses instead of adding them. Then update the hierarchy. + +E.g. when a hero removes an artifact, the hero (which became a child of the artifact when equipping it) is removed from it. + +Note that only *propagated* bonuses need to be handled when nodes are added or removed. *Inheritance* is done on-the-fly and thus automatic. + +## Limiters + +If multiple limiters are specified for a bonus, a child inherits the bonus only if all limiters say that it should. + +So e.g. a list of multiple creature type limiters (with different creatures) would ensure that no creature inherits the bonus. In such a case, the solution is to use one bonus per creature. + +## Propagators + +## Updaters + +Updaters are objects attached to bonuses. They can modify a bonus (typically by changing *val*) during inheritance, including bonuses that a node "inherits" from itself, based on properties (typically level) of the node it passes through. Which nodes update a bonus depends on the type of updater. E.g. updaters that perform updates based on hero level will update bonuses as the are inherited by heroes. + +The following example shows an artifact providing a bonus based on the level of the hero that wears it: + +```javascript + "core:greaterGnollsFlail": + { + "text" : { "description" : "This mighty flail increases the attack of all gnolls under the hero's command by twice the hero's level." }, + "bonuses" : [ + { + "limiters" : [ + { + "parameters" : [ "gnoll", true ], + "type" : "CREATURE_TYPE_LIMITER" + } + ], + "subtype" : "primSkill.attack", + "type" : "PRIMARY_SKILL", + "val" : 2, + "updater" : "TIMES_HERO_LEVEL" + } + ] + } +``` diff --git a/docs/developers/Building_Android.md b/docs/developers/Building_Android.md new file mode 100644 index 000000000..cbd6a14f7 --- /dev/null +++ b/docs/developers/Building_Android.md @@ -0,0 +1,86 @@ +< [Documentation](../Readme.md) / Building for Android + +The following instructions apply to **v1.2 and later**. For earlier versions the best documentation is https://github.com/vcmi/vcmi-android/blob/master/building.txt (and reading scripts in that repo), however very limited to no support will be provided from our side if you wish to go down that rabbit hole. + +*Note*: building has been tested only on Linux and macOS. It may or may not work on Windows out of the box. + +## Requirements + +1. CMake 3.20+: download from your package manager or from https://cmake.org/download/ +2. JDK 11, not necessarily from Oracle +3. Android command line tools or Android Studio for your OS: https://developer.android.com/studio/ +4. Android NDK version **r25c (25.2.9519653)**, there're multiple ways to obtain it: +- - install with Android Studio +- - install with `sdkmanager` command line tool +- - download from https://developer.android.com/ndk/downloads +- - download with Conan, see [#NDK and Conan](#ndk-and-conan) +5. (optional) Ninja: download from your package manager or from https://github.com/ninja-build/ninja/releases + +## Obtaining source code + +Clone https://github.com/vcmi/vcmi with submodules. Example for command line: + +```sh +git clone --recurse-submodules https://github.com/vcmi/vcmi.git +``` + +## Obtaining dependencies + +We use Conan package manager to build/consume dependencies, find detailed usage instructions [here](https://github.com/vcmi/vcmi/tree/develop/docs/conan.md). Note that the link points to the cutting-edge state in `develop` branch, for the latest release check the same document in the [master +branch](https://github.com/vcmi/vcmi/tree/master/docs/conan.md). + +On the step where you need to replace **PROFILE**, choose: +- `android-32` to build for 32-bit architecture (armeabi-v7a) +- `android-64` to build for 64-bit architecture (aarch64-v8a) + +### NDK and Conan + +Conan must be aware of the NDK location when you execute `conan install`. There're multiple ways to achieve that as written in the [Conan docs](https://docs.conan.io/1/integrations/cross_platform/android.html): + +- the easiest is to download NDK from Conan (option 1 in the docs), then all the magic happens automatically. You need to create your own Conan profile that imports our Android profile and adds 2 new lines (you can of course just copy everything from our profile into yours without including) and then pass this new profile to `conan install`: + +```sh +include(/path/to/vcmi/CI/conan/android-64) +[tool_requires] +android-ndk/r25c +``` + +- to use an already installed NDK, you can simply pass it on the command line to `conan install`: + +```sh +conan install -c tools.android:ndk_path=/path/to/ndk ... +``` + +## Build process + +Building for Android is a 2-step process. First, native C++ code is compiled to a shared library (unlike executable on other platforms), then Java code is compiled to an actual executable which will be loading the native shared library at runtime. + +### C++ code + +This is a traditional CMake project, you can build it from command line or some IDE. You're not required to pass any custom options (except Conan toolchain file), defaults are already good. If you wish to use your own CMake presets, inherit them from our `build-with-conan` preset. Example: + +```sh +cmake -S . -B ../build -G Ninja -D CMAKE_BUILD_TYPE=Debug --toolchain ... +cmake --build ../build +``` + +You can also see a more detailed walkthrough on CMake configuration at [How to build VCMI (macOS)](../developers/Building_macOS.md). + +### Java code + +After the C++ part is built, native shared libraries are copied to the appropriate location of the Java project (they will be packaged in the APK). You can either open the Java project located in `android` directory of the repo in Android studio and work with it as with any Android project or build from command line. + +Example how to build from command line in Bash shell, assumes that current working directory is VCMI repository: + +```sh +# the following environment variables must be set +export JAVA_HOME=/path/to/jdk11 +export ANDROID_HOME=/path/to/android/sdk +`` +cd android +./gradlew assembleDebug +``` + +APK will appear in `android/vcmi-app/build/outputs/apk/debug` directory which you can then install to your device with `adb install -r /path/to/apk` (adb command is from Android command line tools). + +If you wish to build and install to your device in single action, use `installDebug` instead of `assembleDebug`. \ No newline at end of file diff --git a/docs/developers/Building_Linux.md b/docs/developers/Building_Linux.md new file mode 100644 index 000000000..d274ac35c --- /dev/null +++ b/docs/developers/Building_Linux.md @@ -0,0 +1,146 @@ +< [Documentation](../Readme.md) / Building on Linux + +# Compiling VCMI + +- Current baseline requirement for building is Ubuntu 20.04 +- Supported C++ compilers for UNIX-like systems are GCC 9+ and Clang 13+ + +Older distributions and compilers might work, but they aren't tested by Github CI (Actions) + +# Installing dependencies + +## Prerequisites + +To compile, the following packages (and their development counterparts) are needed to build: + +- CMake +- SDL2 with devel packages: mixer, image, ttf +- zlib and zlib-devel +- Boost C++ libraries v1.48+: program-options, filesystem, system, thread, locale +- Recommended, if you want to build launcher or map editor: Qt 5, widget and network modules +- Recommended, FFmpeg libraries, if you want to watch in-game videos: libavformat and libswscale. Their name could be libavformat-devel and libswscale-devel, or ffmpeg-libs-devel or similar names. +- Optional, if you want to build scripting modules: LuaJIT + +## On Debian-based systems (e.g. Ubuntu) + +For Ubuntu and Debian you need to install this list of packages: + +`sudo apt-get install cmake g++ libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev zlib1g-dev libavformat-dev libswscale-dev libboost-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libboost-program-options-dev libboost-locale-dev qtbase5-dev libtbb-dev libluajit-5.1-dev qttools5-dev` + +Alternatively if you have VCMI installed from repository or PPA you can use: + +`sudo apt-get build-dep vcmi` + +## On RPM-based distributions (e.g. Fedora) + +`sudo yum install cmake gcc-c++ SDL2-devel SDL2_image-devel SDL2_ttf-devel SDL2_mixer-devel boost boost-devel boost-filesystem boost-system boost-thread boost-program-options boost-locale zlib-devel ffmpeg-devel ffmpeg-libs qt5-qtbase-devel tbb-devel luajit-devel fuzzylite-devel` + +NOTE: `fuzzylite-devel` package is no longer available in recent version of Fedora, for example Fedora 38. It's not a blocker because VCMI bundles fuzzylite lib in its source code. + +## On Arch-based distributions + +On Arch-based distributions, there is a development package available for VCMI on the AUR. + +It can be found at: + +Information about building packages from the Arch User Repository (AUR) can be found at the Arch wiki. + +# Getting the sources + +VCMI is still in development. We recommend the following initial directory structure: + + . + ├── vcmi -> contains sources and is under git control + └── build -> contains build output, makefiles, object files,... + +You can get latest sources with: + +`git clone -b develop --recursive https://github.com/vcmi/vcmi.git` + +# Compilation + +## Configuring Makefiles + +```sh +mkdir build && cd build +cmake ../vcmi +``` + +# Additional options that you may want to use: + +## To enable debugging: +`cmake ../vcmi -DCMAKE_BUILD_TYPE=Debug` + +**Notice**: The ../vcmi/ is not a typo, it will place makefile scripts into the build dir as the build dir is your working dir when calling CMake. + +## Trigger build + +`cmake --build . -- -j2` +(-j2 = compile with 2 threads, you can specify any value) + +That will generate vcmiclient, vcmiserver, vcmilauncher as well as .so libraries in **build/bin/** directory. + +# Package building + +## RPM package + +The first step is to prepare a RPM build environment. On Fedora systems you can follow this guide: http://fedoraproject.org/wiki/How_to_create_an_RPM_package#SPEC_file_overview + +0. Enable RPMFusion free repo to access to ffmpeg libs: + +```sh +sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm +``` + +NOTE: the stock ffmpeg from Fedora repo is no good as it has stripped lots of codecs + +1. Perform a git clone from a tagged branch for the right Fedora version from https://github.com/rpmfusion/vcmi; for example for Fedora 38: 
git clone -b f38 --single-branch https://github.com/rpmfusion/vcmi.git
+ +2. Copy all files to ~/rpmbuild/SPECS with command: 
cp vcmi/*  ~/rpmbuild/SPECS
+ +3. Fetch all sources by using spectool: + +```sh +sudo dnf install rpmdevtools +spectool -g -R ~/rpmbuild/SPECS/vcmi.spec +``` + +4. Fetch all dependencies required to build the RPM: + +```sh +sudo dnf install dnf-plugins-core +sudo dnf builddep ~/rpmbuild/SPECS/vcmi.spec +``` + +4. Go to ~/rpmbuild/SPECS and open terminal in this folder and type: +```sh +rpmbuild -ba ~/rpmbuild/SPECS/vcmi.spec +``` + +5. Generated RPM is in folder ~/rpmbuild/RPMS + +If you want to package the generated RPM above for different processor architectures and operating systems you can use the tool mock. +Moreover, it is necessary to install mock-rpmfusion_free due to the packages ffmpeg-devel and ffmpeg-libs which aren't available in the standard RPM repositories(at least for Fedora). Go to ~/rpmbuild/SRPMS in terminal and type: + +```sh +mock -r fedora-38-aarch64-rpmfusion_free path_to_source_RPM +mock -r fedora-38-x86_64-rpmfusion_free path_to_source_RPM +``` + +For other distributions that uses RPM, chances are there might be a spec file for VCMI. If there isn't, you can adapt the RPMFusion's file + +Available root environments and their names are listed in /etc/mock. + +## Debian/Ubuntu + +1. Install debhelper and devscripts packages + +2. Run dpkg-buildpackage command from vcmi source directory + +```sh +sudo apt-get install debhelper devscripts +cd /path/to/source +dpkg-buildpackage +``` + +To generate packages for different architectures see "-a" flag of dpkg-buildpackage command diff --git a/docs/developers/Building_Windows.md b/docs/developers/Building_Windows.md new file mode 100644 index 000000000..cab0722dc --- /dev/null +++ b/docs/developers/Building_Windows.md @@ -0,0 +1,133 @@ +< [Documentation](../Readme.md) / Building on Windows + +# Preparations +Windows builds can be made in more than one way and with more than one tool. This guide focuses on the simplest building process using Microsoft Visual Studio 2022 + +# Prerequisites + +- Windows Vista or newer. +- [Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/) +- Git or git GUI, for example, SourceTree [download link](http://www.sourcetreeapp.com/download) +- CMake [download link](https://cmake.org/download/). During install after accepting license agreement make sure to check "Add CMake to the system PATH for all users". +- To unpack pre-build Vcpkg: [7-zip](http://www.7-zip.org/download.html) +- Optionally, to create installer: [NSIS](http://nsis.sourceforge.net/Main_Page) + +## Choose an installation directory + +Create a directory for VCMI development, eg. `C:\VCMI` We will call this directory `%VCMI_DIR%` + +Warning! Replace `%VCMI_DIR%` with path you've chosen for VCMI installation in the following commands. + +It is recommended to avoid non-ascii characters in the path to your working folders. The folder should not be write-protected by system. + +Good locations: +- `C:\VCMI` + +Bad locations: +- `C:\Users\Michał\VCMI (non-ascii character)` +- `C:\Program Files (x86)\VCMI (write protection)` + +# Install VCMI dependencies + +You have two options: to use pre-built libraries or build your own. We strongly recommend start with using pre-built ones. + +## Option A. Use pre-built Vcpkg + +### Download and unpack archive + +Vcpkg Archives are available at our GitHub: https://github.com/vcmi/vcmi-deps-windows/releases + +- Download latest version available. +EG: v1.6 assets - [vcpkg-export-x64-windows-v143.7z](https://github.com/vcmi/vcmi-deps-windows/releases/download/v1.6/vcpkg-export-x64-windows-v143.7z) +- Extract archive by right clicking on it and choosing "7-zip -> Extract Here". + +### Move dependencies to target directory +Once extracted, a `vcpkg` directory will appear with `installed` and `scripts` subfolders inside. +Move extracted `vcpkg` directory into your `%VCMI_DIR%` + +## Option B. Build Vcpkg on your own + +Please be aware that if you're running 32-bit Windows version, then this is impossible due to +Be aware that building Vcpkg might take a lot of time depend on your CPU model and 10-20GB of disk space. + +### Create initial directory + +### Clone vcpkg + +1. open SourceTree +2. File -\> Clone +3. select **** as source +4. select **%VCMI_DIR%/vcpkg** as destination +5. click **Clone** + +From command line use: + + git clone https://github.com/microsoft/vcpkg.git %VCMI_DIR%/vcpkg + +### Build vcpkg and dependencies + +- Run +`%VCMI_DIR%/vcpkg/bootstrap-vcpkg.bat` +- For 32-bit build run: +`%VCMI_DIR%/vcpkg/vcpkg.exe install tbb:x64-windows fuzzylite:x64-windows sdl2:x64-windows sdl2-image:x64-windows sdl2-ttf:x64-windows sdl2-mixer[mpg123]:x64-windows boost:x64-windows qt5-base:x64-windows ffmpeg:x64-windows luajit:x64-windows` +- For 64-bit build run: +`%VCMI_DIR%/vcpkg/vcpkg.exe install install tbb:x86-windows fuzzylite:x86-windows sdl2:x86-windows sdl2-image:x86-windows sdl2-ttf:x86-windows sdl2-mixer[mpg123]:x86-windows boost:x86-windows qt5-base:x86-windows ffmpeg:x86-windows luajit:x86-windows` + +For the list of the packages used you can also consult [vcmi-deps-windows readme](https://github.com/vcmi/vcmi-deps-windows) in case this article gets outdated a bit. + +# Build VCMI + +#### From GIT GUI +- Open SourceTree +- File -> Clone +- select `https://github.com/vcmi/vcmi/` as source +- select `%VCMI_DIR%/source` as destination +- expand Advanced Options and change Checkout Branch to `develop` +- tick `Recursive submodules` +- click Clone + +#### From command line +- `git clone --recursive https://github.com/vcmi/vcmi.git %VCMI_DIR%/source` + +## Generate solution for VCMI +- Create `%VCMI_DIR%/build` folder +- Open a command line prompt at `%VCMI_DIR%/build` +- Execute `cd %VCMI_DIR%/build` +- Create solution (Visual Studio 2022 64-bit) `cmake %VCMI_DIR%/source -DCMAKE_TOOLCHAIN_FILE=%VCMI_DIR%/vcpkg/scripts/buildsystems/vcpkg.cmake -G "Visual Studio 17 2022" -A x64` + +## Compile VCMI with Visual Studio +- Open `%VCMI_DIR%/build/VCMI.sln` in Visual Studio +- Select `Release` build type in combobox +- Right click on `BUILD_ALL` project. This `BUILD_ALL` project should be in `CMakePredefinedTargets` tree in Solution Explorer. +- VCMI will be built in `%VCMI_DIR%/build/bin` folder! + +# Create VCMI installer (This step is not required for just building & development) + +Make sure NSIS is installed to default directory or have registry entry so CMake can find it. +After you build VCMI execute following commands from `%VCMI_DIR%/build`. + +- for release build: `cpack` +- for debug build: `cpack -C Debug` + +# Troubleshooting and workarounds + +Vcpkg might be very unstable due to limited popularity and fact of using bleeding edge packages (such as most recent Boost). Using latest version of dependencies could also expose both problems in VCMI code or library interface changes that developers not checked yet. So if you're built Vcpkg yourself and can't get it working please try to use binary package. + +Pre-built version we provide is always manually tested with all supported versions of MSVC for both Release and Debug builds and all known quirks are listed below. + +#$# Build is successful but can not start new game +Make sure you have: +* Installed Heroes III from disk or using GOG installer +* Copied `Data`, `Maps` and `Mp3` folders from Heroes III to: `%USERPROFILE%\Documents\My Games\vcmi\` + +### VCMI won't run since some library is missing + +**If you open solution using vcmi.sln** Try to build INSTALL target and see if its output works as expected. Copy missing libraries or even all libraries from there to your build directory. Or run cpack and use produced installer and see if you can get libs from there. cpack -V will give more info. If cpack complains that it can not find dumpbin try Visual Studio Command Prompt (special version of cmd provided with Visual Studio with additional PATH) or modify PATH to have this tool available. Another alternative if you use prebuilt vcpkg package is to download latest msvc build, install it and copy missing/all libraries from there. + +### Debug build is very slow + +Debug builds with MSVC are generally extremely slow since it's not just VCMI binaries are built as debug, but every single dependency too and this usually means no optimizations at all. Debug information that available for release builds is often sufficient so just avoid full debug builds unless absolutely necessary. Instead use RelWithDebInfo configuration, optionally with Optimization Disabled (/Od) to avoid variables being optimized away Also Debug configuration might have some compilation issues because it is not checked via CI for now. + +### I got crash within library XYZ.dll + +VCPKG generated projects quite often have both debug and regular libs available to linker so it can select wrong lib. For stable RelWithDebInfo build you may try to remove debug folder from VCPKG/installed/x64-windows. Same is done on CI. Also it reduces package size at least twice. diff --git a/docs/developers/Building_iOS.md b/docs/developers/Building_iOS.md new file mode 100644 index 000000000..7b06136b4 --- /dev/null +++ b/docs/developers/Building_iOS.md @@ -0,0 +1,70 @@ +< [Documentation](../Readme.md) / Building for iOS + +## Requirements + +1. **macOS** +2. Xcode: +3. CMake 3.21+: `brew install --cask cmake` or get from + +## Obtaining source code + +Clone with submodules. Example for command line: + +`git clone --recurse-submodules https://github.com/vcmi/vcmi.git` + +## Obtaining dependencies + +There are 2 ways to get prebuilt dependencies: + +- [Conan package manager](https://github.com/vcmi/vcmi/tree/develop/docs/conan.md) - recommended. Note that the link points to the cutting-edge state in `develop` branch, for the latest release check the same document in the [master branch (https://github.com/vcmi/vcmi/tree/master/docs/conan.md). +- [legacy manually built libraries](https://github.com/vcmi/vcmi-ios-deps) - can be used if you have Xcode 11/12 or to build for simulator / armv7 device + +## Configuring project + +Only Xcode generator (`-G Xcode`) is supported! + +As a minimum, you must pass the following variables to CMake: + +- `BUNDLE_IDENTIFIER_PREFIX`: unique bundle identifier prefix, something like `com.MY-NAME` +- (if using legacy dependencies) `CMAKE_PREFIX_PATH`: path to the downloaded dependencies, e.g. `~/Downloads/vcmi-ios-depends/build/iphoneos` + +There're a few [CMake presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html): for device (Conan and legacy dependencies) and for simulator, named `ios-device-conan`, `ios-device` and `ios-simulator` respectively. You can also create your local "user preset" to avoid typing variables each time, see example [here](https://gist.github.com/kambala-decapitator/59438030c34b53aed7d3895aaa48b718). + +Open terminal and `cd` to the directory with source code. Configuration example for device with Conan: + +`cmake --preset ios-device-conan \` +` -D BUNDLE_IDENTIFIER_PREFIX=com.MY-NAME` + +By default build directory containing Xcode project will appear at `../build-ios-device-conan`, but you can change it with `-B` option. + +### Building for device + +To be able to build for iOS device, you must also specify codesigning settings. If you don't know your development team ID, open the generated Xcode project, open project settings (click **VCMI** with blue icon on the very top in the left panel with files), select **vcmiclient** target, open **Signing & Capabilities** tab and select yout team. Now you can copy the value from **Build Settings** tab - `DEVELOPMENT_TEAM` variable (paste it in the Filter field on the right) - click the greenish value - Other... - copy. Now you can pass it in `CMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM` variable when configuring the project to avoid selecting the team manually every time CMake re-generates the project. + +Advanced users who know exact private key and provisioning profile to sign with, can use `CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY` and `CMAKE_XCODE_ATTRIBUTE_PROVISIONING_PROFILE_SPECIFIER` variables instead. In this case you must also pass `-D CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_STYLE=Manual`. + +## Building project + +### From Xcode IDE + +Open `VCMI.xcodeproj` from the build directory, select `vcmiclient` scheme (the only one with nice icon) with your destination device/simulator and hit Run (Cmd+R). + +You must also install game files, see [Installation on iOS](../players/Installation_iOS.md). But this is not necessary if you are going to run on simulator, as it is able to use game data from your Mac located at `~/Library/Application Support/vcmi`. + +### From command line + +`cmake --build `` --target vcmiclient -- -quiet` + +You can pass additional xcodebuild options after the `--`. Here `-quiet` is passed to reduce amount of output. + +Alternatively, you can invoke `xcodebuild` directly. + +There's also `ios-release-conan` configure and build preset that is used to create release build on CI. + +## Creating ipa file for distribution + +Invoke `cpack` after building: + +`cpack -C Release` + +This will generate file with extension **ipa** if you use CMake 3.25+and **zip** otherwise (simply change extension to ipa). \ No newline at end of file diff --git a/docs/developers/Building_macOS.md b/docs/developers/Building_macOS.md new file mode 100644 index 000000000..a84297852 --- /dev/null +++ b/docs/developers/Building_macOS.md @@ -0,0 +1,123 @@ +< [Documentation](../Readme.md) / Building on macOS + +# Requirements + +1. C++ toolchain, either of: + - Xcode Command Line Tools (aka CLT): `sudo xcode-select --install` + - Xcode IDE: + - (not tested) other C++ compilers, e.g. gcc/clang from [Homebrew](https://brew.sh/) +2. CMake: `brew install --cask cmake` or get from +3. (optional) Ninja: `brew install ninja` or get from + +# Obtaining source code + +Clone with submodules. Example for command line: + +`git clone --recurse-submodules https://github.com/vcmi/vcmi.git` + +# Obtaining dependencies + +There're 2 ways to get dependencies automatically. + +## Conan package manager + +Please find detailed instructions in [VCMI repository](https://github.com/vcmi/vcmi/tree/develop/docs/conan.md). Note that the link points to the cutting-edge state in `develop` branch, for the latest release check the same document in the [master branch](https://github.com/vcmi/vcmi/tree/master/docs/conan.md). + +On the step where you need to replace **PROFILE**, choose: + +- if you're on an Intel Mac: `macos-intel` +- if you're on an Apple Silicon Mac: `macos-arm` + +Note: if you wish to build 1.0 release in non-`Release` configuration, you should define `USE_CONAN_WITH_ALL_CONFIGS=1` environment variable when executing `conan install`. + +## Homebrew + +1. [Install Homebrew](https://brew.sh/) +2. Install dependencies: +`brew install boost minizip sdl2 sdl2_image sdl2_mixer sdl2_ttf tbb` +3. If you want to watch in-game videos, also install FFmpeg: +`brew install ffmpeg@4` +4. Install Qt dependency in either of the ways (note that you can skip this if you're not going to build Launcher): + - `brew install qt@5` for Qt 5 or `brew install qt` for Qt 6 + - using [Qt Online Installer](https://www.qt.io/download) - choose **Go open source** + +# Preparing build environment + +This applies only to Xcode-based toolchain. If `xcrun -f clang` prints errors, then use either of the following ways: + +- select an Xcode instance from Xcode application - Preferences - Locations - Command Line Tools +- use `xcode-select` utility to set Xcode or Xcode Command Line Tools path: for example, + `sudo xcode-select -s /Library/Developer/CommandLineTools` +- set `DEVELOPER_DIR` environment variable pointing to Xcode or Xcode Command Line Tools path: for example, `export DEVELOPER_DIR=/Applications/Xcode.app` + +# Configuring project for building + +Note that if you wish to use Qt Creator IDE, you should skip this step and configure respective variables inside the IDE. + +1. In Terminal `cd` to the source code directory +2. Start assembling CMake invocation: type `cmake -S . -B BUILD_DIR` where *BUILD_DIR* can be any path, **don't press Return** +3. Decide which CMake generator you want to use: + - Makefiles: no extra option needed or pass `-G 'Unix Makefiles'` + - Ninja (if you have installed it): pass `-G Ninja` + - Xcode IDE (if you have installed it): pass `-G Xcode` +4. If you picked Makefiles or Ninja, pick desired *build type* - either of Debug / RelWithDebInfo / Release / MinSizeRel - and pass it in `CMAKE_BUILD_TYPE` option, for example: `-D CMAKE_BUILD_TYPE=Release`. If you don't pass this option, `RelWithDebInfo` will be used. +5. If you don't want to build Launcher, pass `-D ENABLE_LAUNCHER=OFF` +6. You can also pass `-Wno-dev` if you're not interested in CMake developer warnings +7. Next step depends on the dependency manager you have picked: + - Conan: pass `-D CMAKE_TOOLCHAIN_FILE=conan-generated/conan_toolchain.cmake` where **conan-generated** must be replaced with your directory choice + - Homebrew: if you installed FFmpeg or Qt 5, you need to pass `-D "CMAKE_PREFIX_PATH="` variable. See below what you can insert after `=` (but **before the closing quote**), multiple values must be separated with `;` (semicolon): + - if you installed FFmpeg, insert `$(brew --prefix ffmpeg@4)` + - if you installed Qt 5 from Homebrew, insert:`$(brew --prefix qt@5)` + - if you installed Qt from Online Installer, insert your path to Qt directory, for example: `/Users/kambala/dev/Qt-libs/5.15.2/Clang64` + - example for FFmpeg + Qt 5: `-D "CMAKE_PREFIX_PATH=$(brew --prefix ffmpeg@4);$(brew --prefix qt@5)"` +8. now press Return + +# Building project + +You must also install game files to be able to run the built version, see [Installation on macOS](players/Installation_macOS.md). + +## From Xcode IDE + +Open `VCMI.xcodeproj` from the build directory, select `vcmiclient` scheme and hit Run (Cmd+R). To build Launcher, select `vcmilauncher` scheme instead. + +## From command line + +`cmake --build ` + +- If using Makefiles generator, you'd want to utilize all your CPU cores by appending `-- -j$(sysctl -n hw.ncpu)` to the above +- If using Xcode generator, you can also choose which configuration to build by appending `--config ` to the above, for example: `--config Debug` + +# Packaging project into DMG file + +After building, run `cpack` from the build directory. If using Xcode generator, also pass `-C ` with the same configuration that you used to build the project. + +If you use Conan, it's expected that you use **conan-generated** directory at step 4 of [Conan package manager](Conan.md). + +# Running VCMI + +You can run VCMI from DMG, but it's will also work from your IDE be it Xcode or Qt Creator. + +Alternatively you can run binaries directly from "bin" directory: + + BUILD_DIR/bin/vcmilauncher + BUILD_DIR/bin/vcmiclient + BUILD_DIR/bin/vcmiserver + +CMake include commands to copy all needed assets from source directory into "bin" on each build. They'll work when you build from Xcode too. + +# Some useful debugging tips + +Anyone who might want to debug builds, but new to macOS could find following commands useful: + +- To attach DMG file from command line use +`hdiutil attach vcmi-1.0.dmg` +- Detach volume: +`hdiutil detach /Volumes/vcmi-1.0` +- To view dependency paths +`otool -L /Volumes/vcmi-1.0/VCMI.app/Contents/MacOS/vcmiclient` +- To display load commands such as LC_RPATH +`otool -l /Volumes/vcmi-1.0/VCMI.app/Contents/MacOS/vcmiclient` + +# Troubleshooting + +In case of troubles you can always consult our CI build scripts or contact the dev team via slack \ No newline at end of file diff --git a/docs/developers/Code_Structure.md b/docs/developers/Code_Structure.md new file mode 100644 index 000000000..2456727ad --- /dev/null +++ b/docs/developers/Code_Structure.md @@ -0,0 +1,124 @@ +< [Documentation](../Readme.md) / Code Structure + +The code of VCMI is divided into several main parts: client, server, lib and AIs, each one in a separate binary file. + +# The big picture + +VCMI contains three core projects: VCMI_lib (dll / so), VCMI_client (executable) and VCMI_server (executable). Server handles all game mechanics and events. Client presents game state and events to player and collects input from him. + +During the game, we have one (and only one) server and one or more (one for each player computer) clients. + +Important: State of the game and its mechanics are synchronized between clients and server. All changes to the game state or mechanics must be done by server which will send appropriate notices to clients. + +## Game state + +It's basically CGameState class object and everything that's accessible from it: map (with objects), player statuses, game options, etc. + +## Bonus system + +One of the more important pieces of VCMI is the [bonus system](Bonus_System.md). It's described in a separate article. + +## Configuration + +Most of VCMI configuration files uses Json format and located in "config" directory + +### Json parser and writer + +# Client + +## Main purposes of client + +Client is responsible for: +- displaying state of game to human player +- capturing player's actions and sending requests to server +- displaying changes in state of game indicated by server + +## Rendering of graphics + +Rendering of graphics relies heavily on SDL. Currently we do not have any wrapper for SDL internal structures and most of rendering is about blitting surfaces using SDL_BlitSurface. We have a few function that make rendering easier or make specific parts of rendering (like printing text). They are places in client/SDL_Extensions and client/SDL_Framerate (the second one contains code responsible for keeping appropriate framerate, it should work more smart than just SDL_Delay(miliseconds)). +In rendering, Interface object system is quite helpful. Its base is CIntObject class that is basically a base class for our library of GUI components and other objects. + +# Server + +## Main purposes of server + +Server is responsible for: + +- maintaining state of the game +- handling requests from all clients participating in game +- informing all clients about changes in state of the game that are + visible to them + +# Lib + +## Main purposes of lib + +VCMI_Lib is a library that contains code common to server and client, so we avoid it's duplication. Important: the library code is common for client and server and used by them, but the library instance (in opposition to the library as file) is not shared by them! Both client and server create their own "copies" of lib with all its class instances. + +iOS platform pioneered single process build, where server is a static library and not a dedicated executable. For that to work, the lib had to be wrapped into special namespace that is defined by client and server targets on iOS, so that single process is able to contain 2 versions of the library. To make it more convenient, a few macros were introduced that can be found in [Global.h](https://github.com/vcmi/vcmi/blob/develop/Global.h). The most important ones are `VCMI_LIB_NAMESPACE_BEGIN` and `VCMI_LIB_NAMESPACE_END` which must be used anywhere a symbol from the lib is needed, otherwise building iOS (or any other platform that would use single process approach) fails. + +Lib contains code responsible for: + +- handling most of Heroes III files (.lod, .txt setting files) +- storing information common to server and client like state of the game +- managing armies, buildings, artifacts, spells, bonuses and other game objects +- handling general game mechanics and related actions (only adventure map objects; it's an unwanted remnant of past development - all game mechanics should be handled by the server) +- networking and serialization + +### Serialization + +The serialization framework can serialize basic types, several standard containers among smart pointers and custom objects. Its design is based on the [boost serialization libraries](http://www.boost.org/doc/libs/1_52_0/libs/serialization/doc/index.html). +In addition to the basic functionality it provides light-weight transfer of CGObjectInstance objects by sending only the index/id. + +Serialization page for all the details. + +### Wrapped namespace examples + +#### Inside the lib + +Both header and implementation of a new class inside the lib should have the following structure: + +`` +`VCMI_LIB_NAMESPACE_BEGIN` +`` +`VCMI_LIB_NAMESPACE_END` + +#### Headers outside the lib + +Forward declarations of the lib in headers of other parts of the project need to be wrapped in the macros: + +`` +`VCMI_LIB_NAMESPACE_BEGIN` +`` +`VCMI_LIB_NAMESPACE_END` +`` +`` + + +#### New project part + +If you're creating new project part, place `VCMI_LIB_USING_NAMESPACE` in its `StdInc.h` to be able to use lib classes without explicit namespace in implementation files. Example: + +# Artificial Intelligence + +## StupidAI + +Stupid AI is recent and used battle AI. + +## Adventure AI + +VCAI module is currently developed agent-based system driven by goals and heroes. + +## Programming challenge + +## Fuzzy logic + +VCMI includes [FuzzyLite](http://code.google.com/p/fuzzy-lite/) library to make use of fuzzy rule-based algorithms. They are useful to handle uncertanity and resemble human behaviour who takes decisions based on rough observations. FuzzyLite is linked as separate static library in AI/FuzzyLite.lib file. + +# Utilities + +## Launcher + +## Duels + +## ERM parser \ No newline at end of file diff --git a/docs/developers/Coding_Guidelines.md b/docs/developers/Coding_Guidelines.md new file mode 100644 index 000000000..8931b035d --- /dev/null +++ b/docs/developers/Coding_Guidelines.md @@ -0,0 +1,877 @@ +< [Documentation](../Readme.md) / Coding Guidelines + +## C++ Standard + +VCMI implementation bases on C++17 standard. Any feature is acceptable as long as it's will pass build on our CI, but there is list below on what is already being used. + +Any compiler supporting C++17 should work, but this has not been thoroughly tested. You can find information about extensions and compiler support at http://en.cppreference.com/w/cpp/compiler_support + +## Style Guidelines + +In order to keep the code consistent, please use the following conventions. From here on 'good' and 'bad' are used to attribute things that would make the coding style match, or not match. It is not a judgment call on your coding abilities, but more of a style and look call. Please try to follow these guidelines to ensure prettiness. + +### Indentation + +Use tabs for indentation. If you are modifying someone else's code, try to keep the coding style similar. + +### Where to put braces + +Inside a code block put the opening brace on the next line after the current statement: + +Good: + +``` cpp +if(a) +{ + code(); + code(); +} +``` + +Bad: + +``` cpp +if(a) { + code(); + code(); +} +``` + +Avoid using unnecessary open/close braces, vertical space is usually limited: + +Good: + +``` cpp +if(a) + code(); +``` + +Bad: + +``` cpp +if(a) { + code(); +} +``` + +Unless there are either multiple hierarchical conditions being used or that the condition cannot fit into a single line. + +Good: + +``` cpp +if(a) +{ + if(b) + code(); +} +``` + +Bad: + +``` cpp +if(a) + if(b) + code(); +``` + +If there are brackets inside the body, outside brackets are required. + +Good: + +``` cpp +if(a) +{ + for(auto elem : list) + { + code(); + } +} +``` + +Bad: + +``` cpp +if(a) + for(auto elem : list) + { + code(); + } +``` + +If "else" branch has brackets then "if" should also have brackets even if it is one line. + +Good: + +``` cpp +if(a) +{ + code(); +} +else +{ + for(auto elem : list) + { + code(); + } +} +``` + +Bad: + +``` cpp +if(a) + code(); +else +{ + for(auto elem : list) + { + code(); + } +} +``` + +If you intentionally want to avoid usage of "else if" and keep if body indent make sure to use braces. + +Good: + +``` cpp +if(a) +{ + code(); +} +else +{ + if(b) + code(); +} +``` + +Bad: + +``` cpp +if(a) + code(); +else + if(b) + code(); +``` + +When defining a method, use a new line for the brace, like this: + +Good: + +``` cpp +void method() +{ +} +``` + +Bad: + +``` cpp +void Method() { +} +``` + +### Use whitespace for clarity + +Use white space in expressions liberally, except in the presence of parenthesis. + +**Good:** + +``` cpp +if(a + 5 > method(blah('a') + 4)) + foo += 24; +``` + +**Bad:** + +``` cpp +if(a+5>method(blah('a')+4)) +foo+=24; +``` + +Between if, for, while,.. and the opening brace there shouldn't be a whitespace. The keywords are highlighted, so they don't need further separation. + +### Where to put spaces + +Use a space before and after the address or pointer character in a pointer declaration. + +Good: + +``` cpp +CIntObject * images[100]; +``` + +Bad: + +``` cpp +CIntObject* images[100]; or +CIntObject *images[100]; +``` + +Do not use spaces before parentheses. + +Good: + +``` cpp +if(a) + code(); +``` + +Bad: + +``` cpp +if (a) + code(); +``` + +Do not use extra spaces around conditions inside parentheses. + +Good: + +``` cpp +if(a && b) + code(); + +if(a && (b || c)) + code(); +``` + +Bad: + +``` cpp +if( a && b ) + code(); + +if(a && ( b || c )) + code(); +``` + +Do not use more than one space between operators. + +Good: + +``` cpp +if((a && b) || (c + 1 == d)) + code(); +``` + +Bad: + +``` cpp +if((a && b) || (c + 1 == d)) + code(); + +if((a && b) || (c + 1 == d)) + code(); +``` + +### Where to use parentheses + +When allocating objects, don't use parentheses for creating stack-based objects by zero param c-tors to avoid c++ most vexing parse and use parentheses for creating heap-based objects. + +Good: + +``` cpp +std::vector v; +CGBoat btn = new CGBoat(); +``` + +Bad: + +``` cpp +std::vector v(); // shouldn't compile anyway +CGBoat btn = new CGBoat; +``` + +Avoid overuse of parentheses: + +Good: + +``` cpp +if(a && (b + 1)) + return c == d; +``` + +Bad: + +``` cpp +if((a && (b + 1))) + return (c == d); +``` + +### Class declaration + +Base class list must be on same line with class name. + +``` cpp +class CClass : public CClassBaseOne, public CClassBaseOne +{ + int id; + bool parameter; + +public: + CClass(); + ~CClass(); +}; +``` + +When 'private:', 'public:' and other labels are not on the line after opening brackets there must be a new line before them. + +Good: + +``` cpp +class CClass +{ + int id; + +public: + CClass(); +}; +``` + +Bad: + +``` cpp +class CClass +{ + int id; +public: + CClass(); +}; +``` + +Good: + +``` cpp +class CClass +{ +protected: + int id; + +public: + CClass(); +}; +``` + +Bad: + +``` cpp +class CClass +{ + +protected: + int id; + +public: + CClass(); +}; +``` + +### Constructor base class and member initialization + +Constructor member and base class initialization must be on new line, indented with tab with leading colon. + +``` cpp +CClass::CClass() + : CClassBaseOne(true, nullptr), id(0), bool parameters(false) +{ + code(); +} +``` + +### Switch statement + +Switch statements have the case at the same indentation as the switch. + +Good: + +``` cpp +switch(alignment) +{ +case EAlignment::EVIL: + do_that(); + break; +case EAlignment::GOOD: + do_that(); + break; +case EAlignment::NEUTRAL: + do_that(); + break; +default: + do_that(); + break; +} +``` + +Bad: + +``` cpp +switch(alignment) +{ + case EAlignment::EVIL: + do_that(); + break; + default: + do_that(); + break; +} + +switch(alignment) +{ + case EAlignment::EVIL: + do_that(); + break; + default: + do_that(); + break; +} + +switch(alignment) +{ +case EAlignment::EVIL: +{ + do_that(); +} +break; +default: +{ + do_that(); +} +break; +} +``` + +### Lambda expressions + +Good: + +``` cpp +auto lambda = [this, a, &b](int3 & tile, int index) -> bool +{ + do_that(); +}; +``` + +Bad: + +``` cpp +auto lambda = [this,a,&b](int3 & tile, int index)->bool{do_that();}; +``` + +Empty parameter list is required even if function takes no arguments. + +Good: + +``` cpp +auto lambda = []() +{ + do_that(); +}; +``` + +Bad: + +``` cpp +auto lambda = [] +{ + do_that(); +}; +``` + +Do not use inline lambda expressions inside if-else, for and other conditions. + +Good: + +``` cpp +auto lambda = []() +{ + do_that(); +}; +if(lambda) +{ + code(); +} +``` + +Bad: + +``` cpp +if([]() +{ + do_that(); +}) +{ + code(); +} +``` + +Do not pass inline lambda expressions as parameter unless it's the last parameter. + +Good: + +``` cpp +auto lambda = []() +{ + do_that(); +}; +obj->someMethod(lambda, true); +``` + +Bad: + +``` cpp +obj->someMethod([]() +{ + do_that(); +}, true); +``` + +Good: + +``` cpp +obj->someMethod(true, []() +{ + do_that(); +}); +``` + +### Serialization + +Serialization of each element must be on it's own line since this make debugging easier. + +Good: + +``` cpp +template void serialize(Handler & h, const int version) +{ + h & identifier; + h & description; + h & name; + h & dependencies; +} +``` + +Bad: + +``` cpp +template void serialize(Handler & h, const int version) +{ + h & identifier & description & name & dependencies; +} +``` + +Save backward compatibility code is exception when extra brackets are always useful. + +Good: + +``` cpp +template void serialize(Handler & h, const int version) +{ + h & identifier; + h & description; + if(version >= 123) + { + h & totalValue; + } + else if(!h.saving) + { + totalValue = 200; + } + h & name; + h & dependencies; +} +``` + +Bad: + +``` cpp +template void serialize(Handler & h, const int version) +{ + h & identifier; + h & description; + if(version >= 123) + h & totalValue; + else if(!h.saving) + totalValue = 200; + h & name; + h & dependencies; +} +``` + +### File headers + +For any new files, please paste the following info block at the very top of the source file: + +``` cpp +/* + * Name_of_File.h, part of VCMI engine + * + * Authors: listed in file AUTHORS in main folder + * + * License: GNU General Public License v2.0 or later + * Full text of license available in license.txt file, in main folder + * + */ +``` + +The above notice have to be included both in header and source files (.h/.cpp). + +### Code order in files + +For any header or source file code must be in following order: + +1. Licensing information +2. pragma once preprocessor directive +3. include directives +4. Forward declarations +5. All other code + +``` cpp +/* + * Name_of_File.h, part of VCMI engine + * + * Authors: listed in file AUTHORS in main folder + * + * License: GNU General Public License v2.0 or later + * Full text of license available in license.txt file, in main folder + * + */ +#pragma once + +#include "Header.h" + +class CGObjectInstance; +struct CPackForClient; +``` + +### Where and how to comment + +If you comment on the same line with code there must be one single space between code and slashes. + +Good: + +``` cpp +if(a) +{ + code(); //Do something +} +else // Do something. +{ + code(); // Do something. +} +``` + +Bad: + +``` cpp +if(a) +{ + code();//Do something +} +else // Do something. +{ + code(); // TODO: +} +``` + +If you add single-line comment on own line slashes must have same indent as code around: + +Good: + +``` cpp +// Do something +if(a) +{ + //Do something + for(auto item : list) + code(); +} +``` + +Bad: + +``` cpp + // Do something +if(a) +{ +//Do something + for(auto item : list) + code(); +} +``` + +Avoid comments inside multi-line if-else conditions. If your conditions are too hard to understand without additional comments this usually means that code need refactoring. Example given below is need improvement though. **FIXME** + +Good: + +``` cpp +bool isMyHeroAlive = a && b || (c + 1 > 15); +bool canMyHeroMove = myTurn && hero.movePoints > 0; +if(isMyHeroAlive && canMyHeroMove) +{ + code(); +} +``` + +Bad: + +``` cpp +if((a && b || (c + 1 > 15)) //Check if hero still alive + && myTurn && hero.movePoints > 0) //Check if hero can move +{ + code(); +} +``` + +You should write a comment before the class definition which describes shortly the class. 1-2 sentences are enough. Methods and class data members should be commented if they aren't self-describing only. Getters/Setters, simple methods where the purpose is clear or similar methods shouldn't be commented, because vertical space is usually limited. The style of documentation comments should be the three slashes-style: ///. + +``` cpp +/// Returns true if a debug/trace log message will be logged, false if not. +/// Useful if performance is important and concatenating the log message is a expensive task. +bool isDebugEnabled() const; +bool isTraceEnabled() const; +``` + +The above example doesn't follow a strict scheme on how to comment a method. It describes two methods in one go. Comments should be kept short. + +If you need a more detailed description for a method you can use such style: + +``` cpp +/// +/// +/// +/// +/// +/// @param Description of method's or function's input parameter +/// @param ... +/// @return Description of the return value +``` + +A good essay about writing comments: http://ardalis.com/when-to-comment-your-code + +### Casing + +Local variables and methods start with a lowercase letter and use the camel casing. Classes/Structs start with an uppercase letter and use the camel casing as well. Macros and constants are written uppercase. + +### Line length + +The line length for c++ source code is 120 columns. If your function declaration arguments go beyond this point, please align your arguments to match the opening brace. For best results use the same number of tabs used on the first line followed by enough spaces to align the arguments. + +### Warnings + +Avoid use of #pragma to disable warnings. Compile at warning level 3. Avoid commiting code with new warnings. + +### File/directory naming + +Compilation units(.cpp,.h files) start with a uppercase letter and are named like the name of a class which resides in that file if possible. Header only files start with a uppercase letter. JSON files start with a lowercase letter and use the camel casing. + +Directories start with a lowercase letter and use the camel casing where necessary. + +### Logging + +Outdated. There is separate entry for [Logging API](Logging_API.md) + +If you want to trace the control flow of VCMI, then you should use the macro LOG_TRACE or LOG_TRACE_PARAMS. The first one prints a message when the function is entered or leaved. The name of the function will also be logged. In addition to this the second macro, let's you specify parameters which you want to print. You should print traces with parameters like this: + +``` cpp +LOG_TRACE_PARAMS(logGlobal, "hero '%s', spellId '%d', pos '%s'.", hero, spellId, pos); +``` + +When using the macro every "simple" parameter should be logged. The parameter can be a number, a string or a type with a ostream operator\<\<. You should not log contents of a whole text file, a byte array or sth. like this. If there is a simple type with a few members you want to log, you should write an ostream operator\<\<. The produced message can look like this: + +`{BattleAction: side '0', stackNumber '1', actionType 'Walk and attack', destinationTile '{BattleHex: x '7', y '1', hex '24'}', additionalInfo '7', selectedStack '-1'}` + +The name of the type should be logged first, e.g. {TYPE_NAME: members...}. The members of the object will be logged like logging trace parameters. Collection types (vector, list, ...) should be logged this way: \[{BattleHex: ...}, {...}\] There is no format which has to be followed strictly, so if there is a reason to format members/objects in a different way, then this is ok. + +## Best practices + +### Avoid code duplication + +Avoid code duplication or don't repeat yourself(DRY) is the most important aspect in programming. Code duplication of any kind can lead to inconsistency and is much harder to maintain. If one part of the system gets changed you have to change the code in several places. This process is error-prone and leads often to problems. Here you can read more about the DRY principle: [](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself) + +### Do not use uncommon abbrevations + +Do not use uncommon abbrevations for class, method, parameter and global object names. + +Bad: + +``` cpp +CArt * getRandomArt(...) +class CIntObject +``` + +Good: + +``` cpp +CArtifact * getRandomArtifact(...) +class CInterfaceObject +``` + +### Loop handling + +Use range-based for loops. It should be used in any case except you absolutely need iterator, then you may use a simple for loop. + +The loop counter should be of type int, unless you are sure you won't need negative indices -- then use size_t. + +### Include guards + +Use #pragma once instead of the traditional #ifndef/#define/#endif include guards. + +### Pre compiled header file + +The header StdInc.h should be included in every compilation unit. It has to be included before any C macro and before any c++ statements. Pre compiled header should not be changed, except any important thing is missing. The StdInc includes most Boost libraries and nearly all standard STL and C libraries, so you don’t have to include them by yourself. + +### Enumeration handling + +Do not declare enumerations in global namespace. It is better to use strongly typed enum or to wrap them in class or namespace to avoid polluting global namespace: + +``` cpp +enum class EAlignment +{ + GOOD, + EVIL, + NEUTRAL +}; + +namespace EAlignment +{ + enum EAlignment + { + GOOD, EVIL, NEUTRAL + }; +} +``` + +### Avoid senseless comments + +If the comment duplicates the name of commented member, it's better if it wouldn't exist at all. It just increases maintenance cost. Bad: + +``` cpp +size_t getHeroesCount(); //gets count of heroes (surprise?) +``` + +### Class handling + +There is no definitive rule which has to be followed strictly. You can freely decide if you want to pack your own classes, where you are programming on, all in one file or each in one file. It's more important that you feel comfortable with the code, than consistency overall the project. VCMI has several container class files, so if you got one additional class to them than just add it to them instead of adding new files. + +### Functions and interfaces + +Don't return const objects or primitive types from functions -- it's pointless. Also, don't return pointers to non-const game data objects from callbacks to player interfaces. + +Bad: + +``` cpp +const std::vector guardingCreatures(int3 pos) const; +``` + +Good: + +``` cpp +std::vector guardingCreatures(int3 pos) const; +``` + +## Sources + +[Mono project coding guidelines](http://www.mono-project.com/Coding_Guidelines) \ No newline at end of file diff --git a/docs/conan.md b/docs/developers/Conan.md similarity index 56% rename from docs/conan.md rename to docs/developers/Conan.md index 352085f5d..d592ef26e 100644 --- a/docs/conan.md +++ b/docs/developers/Conan.md @@ -1,3 +1,5 @@ +< [Documentation](../Readme.md) / Using Conan + # Using dependencies from Conan [Conan](https://conan.io/) is a package manager for C/C++. We provide prebuilt binary dependencies for some platforms that are used by our CI, but they can also be consumed by users to build VCMI. However, it's not required to use only the prebuilt binaries: you can build them from source as well. @@ -8,12 +10,10 @@ The following platforms are supported and known to work, others might require ch - **macOS**: x86_64 (Intel) - target 10.13 (High Sierra), arm64 (Apple Silicon) - target 11.0 (Big Sur) - **iOS**: arm64 - target 12.0 -- **Windows**: x86_64 and x86 fully supported with building from Linux -- **Android**: armeabi-v7a (32-bit ARM) - target 4.4 (API level 19), aarch64-v8a (64-bit ARM) - target 5.0 (API level 21) ## Getting started -1. [Install Conan](https://docs.conan.io/en/latest/installation.html). Currently we support only Conan v1, you can install it with `pip` like this: `pip3 install 'conan<2.0'` +1. [Install Conan](https://docs.conan.io/en/latest/installation.html) 2. Execute in terminal: `conan profile new default --detect` ## Download dependencies @@ -22,45 +22,36 @@ The following platforms are supported and known to work, others might require ch 1. Check if your build environment can use the prebuilt binaries: basically, that your compiler version (or Xcode major version) matches the information below. If you're unsure, simply advance to the next step. - - **macOS**: libraries are built with Apple clang 14 (Xcode 14.2), should be consumable by Xcode and Xcode CLT 14.x (older library versions are also available for Xcode 13, see Releases in the respective repo) - - **iOS**: libraries are built with Apple clang 14 (Xcode 14.2), should be consumable by Xcode 14.x (older library versions are also available for Xcode 13, see Releases in the respective repo) - - **Windows**: libraries are built with x86_64-mingw-w64-gcc version 10 (which is available in repositories of Ubuntu 22.04) - - **Android**: libraries are built with NDK r25c (25.2.9519653) + - macOS: libraries are built with Apple clang 13 (Xcode 13.4.1), should be consumable by Xcode and Xcode CLT 13.x + - iOS: libraries are built with Apple clang 13 (Xcode 13.4.1), should be consumable by Xcode 13.x 2. Download the binaries archive and unpack it to `~/.conan` directory: - [macOS](https://github.com/vcmi/vcmi-deps-macos/releases/latest): pick **intel.txz** if you have Intel Mac, otherwise - **intel-cross-arm.txz** - [iOS](https://github.com/vcmi/vcmi-ios-deps/releases/latest) - - [Windows](https://github.com/vcmi/vcmi-deps-windows-conan/releases/latest): pick **vcmi-deps-windows-conan-w64.tgz** - if you want x86, otherwise pick **vcmi-deps-windows-conan.tgz** - - [Android](https://github.com/vcmi/vcmi-dependencies/releases) -3. Only if you have Apple Silicon Mac and trying to build for macOS or iOS: - - 1. Open file `~/.conan/data/qt/5.15.x/_/_/export/conanfile.py` (`5.15.x` is a placeholder), search for string `Designer` (there should be only one match), comment this line and the one above it by inserting `#` in the beginning, and save the file. - 2. (optional) If you don't want to use Rosetta, follow [instructions how to build Qt host tools for Apple Silicon](https://github.com/vcmi/vcmi-ios-deps#note-for-arm-macs), on step 3 copy them to `~/.conan/data/qt/5.15.x/_/_/package/SOME_HASH/bin` (`5.15.x` and `SOME_HASH` are placeholders). Make sure **not** to copy `qt.conf`! +3. Only if you have Apple Silicon Mac and trying to build for macOS or iOS: follow [instructions how to build Qt host tools for Apple Silicon](https://github.com/vcmi/vcmi-ios-deps#note-for-arm-macs), on step 3 copy them to `~/.conan/data/qt/5.15.x/_/_/package/SOME_HASH/bin` (`5.15.x` and `SOME_HASH` are placeholders). ## Generate CMake integration Conan needs to generate CMake toolchain file to make dependencies available to CMake. See `CMakeDeps` and `CMakeToolchain` [in the official documentation](https://docs.conan.io/en/latest/reference/conanfile/tools/cmake.html) for details. -In terminal `cd` to the VCMI source directory and run the following command. Also check subsections for additional requirements on consuming prebuilt binaries. +In terminal `cd` to the VCMI source directory and run the following command. If you want to download prebuilt binaries from ConanCenter, also read the [next section](#using-prebuilt-binaries-from-conancenter). -
+```sh
 conan install . \
   --install-folder=conan-generated \
   --no-imports \
   --build=never \
   --profile:build=default \
   --profile:host=CI/conan/PROFILE
-
+``` The highlighted parts can be adjusted: - ***conan-generated***: directory (absolute or relative) where the generated files will appear. This value is used in CMake presets from VCMI, but you can actually use any directory and override it in your local CMake presets. - ***never***: use this value to avoid building any dependency from source. You can also use `missing` to build recipes, that are not present in your local cache, from source. -- ***CI/conan/PROFILE***: if you want to consume our prebuilt binaries, ***PROFILE*** must be replaced with one of filenames from our [Conan profiles directory](../CI/conan) (determining the right file should be straight-forward). Otherwise, either select one of our profiles or replace ***CI/conan/PROFILE*** with `default` (your default profile). -- ***note for Windows x86***: use profile mingw32-linux.jinja for building instead of mingw64-linux.jinja +- ***CI/conan/PROFILE***: if you want to consume our prebuilt binaries, ***PROFILE*** must be replaced with one of filenames from our [Conan profiles directory](../../CI/conan) (determining the right file should be straight-forward). Otherwise, either select one of our profiles or replace ***CI/conan/PROFILE*** with `default` (your default profile). If you use `--build=never` and this command fails, then it means that you can't use prebuilt binaries out of the box. For example, try using `--build=missing` instead. @@ -68,10 +59,6 @@ VCMI "recipe" also has some options that you can specify. For example, if you do _Note_: you can find full reference of this command [in the official documentation](https://docs.conan.io/en/latest/reference/commands/consumer/install.html) or by executing `conan help install`. -### Using our prebuilt binaries for macOS/iOS - -We use custom recipes for some libraries that are provided by the OS. You must additionally pass `-o with_apple_system_libs=True` for `conan install` to use them. - ### Using prebuilt binaries from ConanCenter First, check if binaries for [your platform](https://github.com/conan-io/conan-center-index/blob/master/docs/supported_platforms_and_configurations.md) are produced. @@ -81,25 +68,6 @@ You must adjust the above `conan install` command: 1. Replace ***CI/conan/PROFILE*** with `default`. 2. Additionally pass `-o default_options_of_requirements=True`: this disables all custom options of our `conanfile.py` to match ConanCenter builds. -### Building dependencies from source - -This subsection describes platform specifics to build libraries from source properly. - -#### Building for macOS/iOS - -- To build Locale module of Boost in versions >= 1.81, you must use `compiler.cppstd=11` Conan setting (our profiles already contain it). To use it with another profile, either add this setting to your _host_ profile or pass `-s compiler.cppstd=11` on the command line. -- If you wish to build dependencies against system libraries (like our prebuilt ones do), follow [below instructions](#using-recipes-for-system-libraries) executing `conan create` for all directories. Don't forget to pass `-o with_apple_system_libs=True` to `conan install` afterwards. - -#### Building for Android - -Android has issues loading self-built shared Zlib library because binary name is identical to the system one, so we enforce using the OS-provided library. To achieve that, follow [below instructions](#using-recipes-for-system-libraries), you only need `zlib` directory. - -##### Using recipes for system libraries - -1. Clone/download https://github.com/kambala-decapitator/conan-system-libs -2. Execute `conan create PACKAGE vcmi/apple`, where `PACKAGE` is a directory path in that repository. Do it for each library you need. -3. Now you can execute `conan install` to build all dependencies. - ## Configure project for building You must pass the generated toolchain file to CMake invocation. @@ -113,14 +81,13 @@ In these examples only the minimum required amount of options is passed to `cmak ### Use our prebuilt binaries to build for macOS x86_64 with Xcode -``` +```sh conan install . \ --install-folder=conan-generated \ --no-imports \ --build=never \ --profile:build=default \ - --profile:host=CI/conan/macos-intel \ - -o with_apple_system_libs=True + --profile:host=CI/conan/macos-intel cmake -S . -B build -G Xcode \ --toolchain conan-generated/conan_toolchain.cmake @@ -130,7 +97,7 @@ cmake -S . -B build -G Xcode \ If you also want to build the missing binaries from source, use `--build=missing` instead of `--build=never`. -``` +```sh conan install . \ --install-folder=~/my-dir \ --no-imports \ @@ -145,14 +112,13 @@ cmake -S . -B build \ ### Use our prebuilt binaries to build for iOS arm64 device with custom preset -``` +```sh conan install . \ --install-folder=~/my-dir \ --no-imports \ --build=never \ --profile:build=default \ - --profile:host=CI/conan/ios-arm64 \ - -o with_apple_system_libs=True + --profile:host=CI/conan/ios-arm64 cmake --preset ios-conan ``` @@ -181,28 +147,3 @@ cmake --preset ios-conan ] } ``` - -### Build VCMI with all deps for 32-bit windows in Ubuntu 22.04 WSL -```powershell -wsl --install -wsl --install -d Ubuntu -ubuntu -``` -Next steps are identical both in WSL and in real Ubuntu 22.04 -```bash -sudo pip3 install conan -sudo apt install cmake build-essential -sed -i 's/x86_64-w64-mingw32/i686-w64-mingw32/g' CI/mingw-ubuntu/before-install.sh -sed -i 's/x86-64/i686/g' CI/mingw-ubuntu/before-install.sh -sudo ./CI/mingw-ubuntu/before-install.sh -conan install . \ - --install-folder=conan-generated \ - --no-imports \ - --build=missing \ - --profile:build=default \ - --profile:host=CI/conan/mingw32-linux \ - -c tools.cmake.cmaketoolchain.presets:max_schema_version=2 -cmake --preset windows-mingw-conan-linux -cmake --build --preset windows-mingw-conan-linux --target package -``` -After that, you will have functional VCMI installer for 32-bit windows. diff --git a/docs/developers/Development_with_Qt_Creator.md b/docs/developers/Development_with_Qt_Creator.md new file mode 100644 index 000000000..d7a481c14 --- /dev/null +++ b/docs/developers/Development_with_Qt_Creator.md @@ -0,0 +1,26 @@ +< [Documentation](../Readme.md) / Development with Qt Creator + +# Introduction to Qt Creator + +Qt Creator is the recommended IDE for VCMI development on Linux distributions, but it may be used on other operating systems as well. It has the following advantages compared to other IDEs: + +- Fast parser/indexer, stable. +- Almost no manual configuration when used with CMake. Project configuration is read from CMake text files, +- Easy to setup and use with multiple different compiler toolchains: GCC, Visual Studio, Clang + +You can install Qt Creator from repository, but better to stick to latest version from Qt website: https://www.qt.io/download-qt-installer-oss + +## Configuration + +To open the project you have to click File -\> Open file or project... -\> Select /path/to/vcmi/src/CMakeLists.txt. + +For the first time and for every CMake project configuration change you have to execute CMake. This step can be done when opening the project for the first time or alternatively via the left bar -\> Projects -\> Build Settings -\> Execute CMake. You have to specify CMake arguments and the build dir. CMake arguments can be the following: `-DCMAKE_BUILD_TYPE=Debug` + +The build dir should be set to something like /trunk/build for the debug build and /trunk/buildrel for the release build. For cleaning the build dir a command like "make clean" may be not enough. Better way is to delete the build dir, re-create it and re-execute CMake. Steps for cleaning can be configured in the Projects tab as well. + +## Debugging + +There is a problem with QtCreator when debugging both vcmiclient and vcmiserver. If you debug the vcmiclient, start a game, attach the vcmiserver process to the gdb debugger(Debug \> Start Debugging \> Attach to Running External Application...) then breakpoints which are set for vcmiserver will be ignored. This looks like a bug, in any case it's not intuitively. Two workarounds are available luckily: + +1. Run vcmiclient (no debug mode), then attach server process to the debugger +2. Open two instances of QtCreator and debug vcmiserver and vcmiclient separately(it works!) \ No newline at end of file diff --git a/docs/developers/Logging_API.md b/docs/developers/Logging_API.md new file mode 100644 index 000000000..65ea11ea0 --- /dev/null +++ b/docs/developers/Logging_API.md @@ -0,0 +1,163 @@ +< [Documentation](../Readme.md) / Logging System + +# Features + +- A logger belongs to a "domain", this enables us to change log level settings more selectively +- The log format can be customized +- The color of a log entry can be customized based on logger domain and logger level +- Logger settings can be changed in the settings.json file +- No std::endl at the end of a log entry required +- Thread-safe +- Macros for tracing the application flow +- Provides stream-like and function-like logging + +# Class diagram + +![Logging_Class_Diagram](https://github.com/IvanSavenko/vcmi/assets/1576820/31c9b14e-a055-4b07-87fe-00da43430a2b) + +Some notes: + +- There are two methods `configure` and `configureDefault` of the class `CBasicLogConfigurator` to initialize and setup the logging system. The latter one setups default logging and isn't dependent on VCMI's filesystem, whereas the first one setups logging based on the user's settings which can be configured in the settings.json. +- The methods `isDebugEnabled` and `isTraceEnabled` return true if a log record of level debug respectively trace will be logged. This can be useful if composing the log message is a expensive task and performance is important. + +# Usage + +## Setup settings.json + +``` javascript +{ + "logging" : { + "console" : { + "threshold" : "debug", + "colorMapping" : [ + { + "domain" : "network", + "level" : "trace", + "color" : "magenta" + } + ] + }, + "loggers" : [ + { + "domain" : "global", + "level" : "debug" + }, + { + "domain" : "ai", + "level" : "trace" + } + ] + } +} +``` + +The above code is an example on how to configure logging. It sets the log level to debug globally and the log level of the domain ai to trace. In addition, it tells the console to log debug messages as well with the threshold attribute. Finally, it configures the console so that it logs network trace messages in magenta. + +## Configuration + +The following code shows how the logging system can be configured: + +```cpp + console = new CConsoleHandler; + CBasicLogConfigurator logConfig(VCMIDirs::get().localPath() + "/VCMI_Server_log.txt", console); + logConfig.configureDefault(); // Initialize default logging due to that the filesystem and settings are not available + preinitDLL(console); // Init filesystem + settings.init(); // Init settings + logConfig.configure(); // Now setup "real" logging system, overwrites default settings +``` + +If `configureDefault` or `configure` won't be called, then logs aren't written either to the console or to the file. The default logging setups a system like this: + +**Console** + +Format: %m +Threshold: info +coloredOutputEnabled: true + +colorMapping: trace -\> gray, debug -\> white, info -\> green, warn -\> yellow, error -\> red + +**File** + +Format: %d %l %n \[%t\] - %m + +**Loggers** + +global -\> info + +## How to get a logger + +There exist only one logger object per domain. A logger object cannot be copied. You can get access to a logger object by using the globally defined ones like `logGlobal` or `logAi`, etc... or by getting one manually: +```cpp +Logger * logger = CLogger::getLogger(CLoggerDomain("rmg")); +``` + +## Logging + +Logging can be done via two ways, stream-like or function-like. + +```cpp + logGlobal->warnStream() << "Call to loadBitmap with void fname!"; + logGlobal->warn("Call to loadBitmap with void fname!"); +``` + +Don't include a '\n' or std::endl at the end of your log message, a new line will be appended automatically. + +The following list shows several log levels from the highest one to the lowest one: + +- error -\> for errors, e.g. if resource is not available, if a initialization fault has occured, if a exception has been thrown (can result in program termination) +- warn -\> for warnings, e.g. if sth. is wrong, but the program can continue execution "normally" +- info -\> informational messages, e.g. Filesystem initialized, Map loaded, Server started, etc... +- debug -\> for debugging, e.g. hero moved to (12,3,0), direction 3', 'following artifacts influence X: .. or pattern detected at pos (10,15,0), p-nr. 30, flip 1, repl. 'D' +- trace -\> for logging the control flow, the execution progress or fine-grained events, e.g. hero movement completed, entering CMapEditManager::updateTerrainViews: posx '10', posy '5', width '10', height '10', mapLevel '0',... + +The following colors are available for console output: + +- default +- green +- red +- magenta +- yellow +- white +- gray +- teal + +## How to trace execution + +The program execution can be traced by using the macros TRACE_BEGIN, TRACE_END and their \_PARAMS counterparts. This can be important if you want to analyze the operations/internal workings of the AI or the communication of the client-server. In addition, it can help you to find bugs on a foreign VCMI installation with a custom mod configuration. + +```cpp + int calculateMovementPointsForPath(int3 start, int3 end, CHero * hero) // This is just an example, the function is fictive + { + TRACE_BEGIN_PARAMS(logGlobal, "start '%s', end '%s', hero '%s'", start.toString() % end.toString() % hero.getName()); // toString is fictive as well and returns a string representation of the int3 pos, .... + int movPoints; + // Do some stuff + // ... + TRACE_END_PARAMS(logGlobal, "movPoints '%i'", movPoints); + return movPoints; + } +``` + +# Concepts + +## Domain + +A domain is a specific part of the software. In VCMI there exist several domains: + +- network +- ai +- bonus +- network + +In addition to these domains, there exist always a super domain called "global". Sub-domains can be created with "ai.battle" or "ai.adventure" for example. The dot between the "ai" and "battle" is important and notes the parent-child relationship of those two domains. A few examples how the log level will be inherited: + +global, level=info +network, level=not set, effective level=info + +global, level=warn +network, level=trace, effective level=trace + +global, level=debug +ai, level=not set, effective level=debug +ai.battle, level=trace, effective level=trace + +The same technique is applied to the console colors. If you want to have another debug color for the domain ai, you can explicitely set a color for that domain and level. \ No newline at end of file diff --git a/docs/developers/Lua_Scripting_System.md b/docs/developers/Lua_Scripting_System.md new file mode 100644 index 000000000..fb3904a00 --- /dev/null +++ b/docs/developers/Lua_Scripting_System.md @@ -0,0 +1,204 @@ +< [Documentation](../Readme.md) / Lua Scripting System + +# Configuration + +``` javascript +{ + //general purpose script, Lua or ERM, runs on server + "myScript": + { + "source":"path/to/script/with/ext", + "implements":"ANYTHING" + }, + + + //custom battle spell effect, Lua only, runs on both client and server + //script ID will be used as effect 'type' (with mod prefix) + "mySpellEffect": + { + "source":"path/to/script/with/ext", + "implements":"BATTLE_EFFECT" + }, + + //TODO: object|building type + //custom map object or building, Lua only, runs on both client and server + //script ID will be used as 'handler' (with mod prefix) + "myObjectType": + { + "source":"path/to/script/with/ext", + "implements":"MAP_OBJECT" + }, + //TODO: server query + //TODO: client query + +} +``` + +# Lua + +## API Reference + +TODO **In near future Lua API may change drastically several times. Information here may be outdated** + +### Globals + +- DATA - persistent table +- - DATA.ERM contains ERM state, anything else is free to use. +- GAME - IGameInfoCallback API +- BATTLE - IBattleInfoCallback API +- EVENT_BUS - opaque handle, for use with events API +- SERVICES - root "raw" access to all static game objects +- - SERVICES:artifacts() +- - SERVICES:creatures() +- - SERVICES:factions() +- - SERVICES:heroClasses() +- - SERVICES:heroTypes() +- - SERVICES:spells() +- - SERVICES:skills() +- require(URI) +- -works similar to usual Lua require +- -require("ClassName") - loads additional API and returns it as table (for C++ classes) +- -require("core:relative.path.to.module") - loads module from "SCRIPTS/LIB" +- -TODO require("modName:relative.path.to.module") - loads module from dependent mod +- -TODO require(":relative.path.to.module") - loads module from same mod +- logError(text) - backup error log function + +### Low level events API + +``` Lua + +-- Each event type must be loaded first +local PlayerGotTurn = require("events.PlayerGotTurn") + +-- in this example subscription handles made global, do so if there is no better place +-- !!! do not store them in local variables +sub1 = PlayerGotTurn.subscribeAfter(EVENT_BUS, function(event) + --do smth + end) + +sub2 = PlayerGotTurn.subscribeBefore(EVENT_BUS, function(event) + --do smth + end) +``` + +### Lua standard library + +VCMI uses LuaJIT, which is Lua 5.1 API, see [upstream documentation](https://www.lua.org/manual/5.1/manual.html) + +Following libraries are supported + +- base +- table +- string +- math +- bit + +# ERM + +## Features + +- no strict limit on function/variable numbers (technical limit 32 bit integer except 0)) +- TODO semi compare +- DONE macros + +## Bugs + +- TODO Broken XOR support (clashes with \`X\` option) + +## Triggers + +- TODO **!?AE** Equip/Unequip artifact +- WIP **!?BA** when any battle occurs +- WIP **!?BF** when a battlefield is prepared for a battle +- TODO **!?BG** at every action taken by any stack or by the hero +- TODO **!?BR** at every turn of a battle +- *!?CM (client only) click the mouse button.* +- TODO **!?CO** Commander triggers +- TODO **!?DL** Custom dialogs +- DONE **!?FU** function +- TODO **!?GE** "global" event +- TODO **!?GM** Saving/Loading +- TODO **!?HE** when the hero \# is attacked by an enemy hero or + visited by an allied hero +- TODO **!?HL** hero gains a level +- TODO **!?HM** every step a hero \# takes +- *!?IP Multiplayer support.* +- TODO **!?LE** (!$LE) An Event on the map +- WIP **!?MF** stack taking physical damage(before an action) +- TODO **!?MG** casting on the adventure map +- *!?MM scroll text during a battle* +- TODO **!?MR** Magic resistance +- TODO **!?MW** Wandering Monsters +- WIP **!?OB** (!$OB) visiting objects +- DONE **!?PI** Post Instruction. +- TODO **!?SN** Sound and ERA extensions +- *!?TH town hall* +- TODO **!?TL** Real-Time Timer +- TODO **!?TM** timed events + +## Receivers + +### VCMI + +- **!!MC:S@varName@** - declare new "normal" variable (technically + v-var with string key) +- TODO Identifier resolver +- WIP Bonus system + +### ERA + +- DONE !!if !!el !!en +- TODO !!br !!co +- TODO !!SN:X + +### WoG + +- TODO !!AR Артефакт (ресурс) в определенной позиции +- TODO !!BA Битва + - !!BA:A$ return 1 for battle evaluation +- TODO !!BF Препятствия на поле боя +- TODO !!BG Действий монстров в бою +- TODO !!BH Действия героя в бою +- TODO !!BM Монстр в битве +- WIP !!BU Универсальные параметры битвы +- TODO !!CA Замок +- TODO !!CD Разрушения замков +- TODO !!CE События в замке +- TODO !!CM Клика мышью +- TODO !!DL Нестандартный диалог (только ТЕ или выше) +- TODO !!CO Командиры +- WIP !!DO Многократный вызов функции +- TODO !!EA Бонусы опыта существ +- TODO !!EX Опыт стека +- DONE !!FU Однократный вызов функции +- TODO !!GE Глобальное событие +- WIP !!HE Герой +- TODO !!HL Новый уровень героя +- TODO !!HO Взаимодействия героев +- TODO !!HT Подсказки по правому клику +- WIP !!IF Диалоги и флагов +- TODO !!IP Сетевой сервис битвы +- TODO !!LE Локальное события +- WIP !!MA Общие параметры монстров +- DONE !!MC Макросы +- WIP !!MF Получение физ. урона в бою +- TODO !!MM Текст в битве +- WIP !!MO Монстр в определенной позиции +- TODO !!MP Контроль MP3 +- TODO !!MR Сопротивления магии +- TODO !!MW Бродячих монстров +- WIP !!OB Объект в определенной позиции +- TODO !!OW Параметры игрока +- TODO !!PM Пирамиды или новые объекты +- TODO !!PO Информация квадрата карты +- TODO (???) !!QW Журнала +- TODO !!SN Проигрываемые звуков +- TODO !!SS Настройка заклинаний (только ТЕ или выше) +- TODO !!TL Контроль времени хода (только ТЕ или выше) +- TODO !!TM Временный таймер +- TODO !!TR Квадрата карты (почва, проходимость, т.п.) +- TODO !!UN Универсальная команда +- *!#VC Контроль переменных* +- WIP !!VR Установка переменных + +## Persistence \ No newline at end of file diff --git a/docs/developers/Serialization.md b/docs/developers/Serialization.md new file mode 100644 index 000000000..726530313 --- /dev/null +++ b/docs/developers/Serialization.md @@ -0,0 +1,267 @@ +< [Documentation](../Readme.md) / Serialization System + +# Introduction + +The serializer translates between objects living in our code (like int or CGameState\*) and stream of bytes. Having objects represented as a stream of bytes is useful. Such bytes can send through the network connection (so client and server can communicate) or written to the disk (savegames). + +VCMI uses binary format. The primitive types are simply copied from memory, more complex structures are represented as a sequence of primitives. + +## Typical tasks + +### Bumping a version number + +Different major version of VCMI likely change the format of the save game. Every save game needs a version identifier, that loading can work properly. Backward compatibility isn't supported for now. The version identifier is a constant named version in Connection.h and should be updated every major VCMI version or development version if the format has been changed. Do not change this constant if it's not required as it leads to full rebuilds. Why should the version be updated? If VCMI cannot detect "invalid" save games the program behaviour is random and undefined. It mostly results in a crash. The reason can be anything from null pointer exceptions, index out of bounds exceptions(ok, they aren't available in c++, but you know what I mean:) or invalid objects loading(too much elements in a vector, etc...) This should be avoided at least for public VCMI releases. + +### Adding a new class + +If you want your class to be serializable (eg. being storable in a savegame) you need to define a serialize method template, as described in [#User types](#user-types) + +Additionally, if your class is part of one of registered object hierarchies (basically: if it derives from CGObjectInstance, IPropagator, ILimiter, CBonusSystemNode, CPack) it needs to be registered. Just add an appropriate entry in the `RegisterTypes.h` file. See polymorphic serialization for more information. + +# How does it work + +## Primitive types + +They are simply stored in a binary form, as in memory. Compatibility is ensued through the following means: + +- VCMI uses internally types that have constant, defined size (like int32_t - has 32 bits on all platforms) +- serializer stores information about its endianess + +It's not "really" portable, yet it works properly across all platforms we currently support. + +## Dependant types + +### Pointers + +Storing pointers mechanics can be and almost always is customized. See [#Additional features](additional-features). + +In the most basic form storing pointer simply sends the object state and loading pointer allocates an object (using "new" operator) and fills its state with the stored data. + +### Arrays + +Serializing array is simply serializing all its elements. + +## Standard library types + +### STL Containers + +First the container size is stored, then every single contained element. + +Supported STL types include: + +`vector` +`array` +`set` +`unordered_set` +`list` +`string` +`pair` +`map` + +### Smart pointers + +Smart pointers at the moment are treated as the raw C-style pointers. This is very bad and dangerous for shared_ptr and is expected to be fixed somewhen in the future. + +The list of supported data types from standard library: + +`shared_ptr (partial!!!)` +`unique_ptr` + +### Boost + +Additionally, a few types for Boost are supported as well: + +`variant` +`optional` + +## User types + +To make the user-defined type serializable, it has to provide a template method serialize. The first argument (typed as template parameter) is a reference to serializer. The second one is version number. + +Serializer provides an operator& that is internally expanded to `<<` when serialziing or `>>` when deserializing. + +Serializer provides a public bool field `saving`that set to true during serialziation and to false for deserialziation. + +Typically, serializing class involves serializing all its members (given that they are serializable). Sample: + +``` cpp +/// The rumor struct consists of a rumor name and text. +struct DLL_LINKAGE Rumor +{ + std::string name; + std::string text; + + template + void serialize(Handler & h, const int version) + { + h & name; + h & text; + } +}; +``` + +## Backwards compatibility + +Serializer, before sending any data, stores its version number. It is passed as the parameter to the serialize method, so conditional code ensuring backwards compatibility can be added. + +Yet, because of numerous changes to our game data structure, providing means of backwards compatibility is not feasible. The versioning feature is rarely used. + +Sample: + +``` cpp +/// The rumor struct consists of a rumor name and text. +struct DLL_LINKAGE Rumor +{ + std::string name; //introduced in version 1065 + std::string text; + + template + void serialize(Handler & h, const int version) + { + if(version >= 1065) + h & name; + else //when loading old savegame + name = "no name"; //set name to a sane default value + + h & text; + } +}; +``` + +## Serializer classes + +### Common information + +Serializer classes provide iostream-like interface with operator `<<` for serialization and operator `>>` for deserialization. Serializer upon creation will retrieve/store some metadata (version number, endianess), so even if no object is actually serialized, some data will be passed. + +### Serialization to file + +CLoadFile/CSaveFile classes allow to read data to file and store data to file. They take filename as the first parameter in constructor and, optionally, the minimum supported version number (default to the current version). If the construction fails (no file or wrong file) the exception is thrown. + +### Networking + +CConnection class provides support for sending data structures over TCP/IP protocol. It provides 3 constructors: +1. connect to given hostname at given port (host must be accepting connection) +2. accept connection (takes boost.asio acceptor and io_service) +3. adapt boost.asio socket with already established connection + +All three constructors take as the last parameter the name that will be used to identify the peer. + +## Additional features + +Here is the list of additional custom features serialzier provides. Most of them can be turned on and off. + +- Polymorphic serialization — no flag to control it, turned on by calls to registerType. +- Vectorized list member serialization — enabled by smartVectorMembersSerialization flag. +- Stack instance serialization — enabled by sendStackInstanceByIds flag. +- Smart pointer serialization — enabled by smartPointerSerialization flag. + +### Polymorphic serialization + +Serializer is to recognize the true type of object under the pointer if classes of that hierarchy were previously registered. + +This means that following will work + +``` cpp +Derived *d = new Derived(); +Base *basePtr = d; +CSaveFile output("test.dat"); +output << b; +// +Base *basePtr = nullptr; +CLoadFile input("test.dat"); +input >> basePtr; //a new Derived object will be put under the pointer +``` + +Class hierarchies that are now registered to benefit from this feature are mostly adventure map object (CGObjectInstance) and network packs (CPack). See the RegisterTypes.h file for the full list. + +It is crucial that classes are registered in the same order in the both serializers (storing and loading). + +### Vectorized list member serialization + +Both client and server store their own copies of game state and VLC (handlers with data from config). Many game logic objects are stored in the vectors and possess a unique id number that represent also their position in such vector. + +The vectorised game objects are: + +`CGObjectInstance` +`CGHeroInstance` +`CCreature` +`CArtifact` +`CArtifactInstance` +`CQuest` + +For this to work, serializer needs an access to gamestate library classes. This is done by calling a method `CSerializer::addStdVecItems(CGameState *gs, LibClasses *lib)`. + +When the game ends (or gamestate pointer is invaldiated for another reason) this feature needs to be turned off by toggling its flag. + +When vectorized member serialization is turned on, serializing pointer to such object denotes not sending an object itself but rather its identity. For example: + +``` cpp +//Server code +CCreature *someCreature = ...; +connection << someCreature; +``` + +the last line is equivalent to + +``` cpp +connection << someCreature->idNumber; +``` + +``` cpp +//Client code +CCreature *someCreature = nullptr; +connection >> someCreature; +``` + +the last line is equivalent to + +``` cpp +CreatureID id; +connection >> id; +someCreature = VLC->creh->creatures[id.getNum()]; +``` + +Important: this means that the object state is not serialized. + +This feature makes sense only for server-client network communication. + +### Stack instance serialization + +This feature works very much like the vectorised object serialization. It is like its special case for stack instances that are not vectorised (each hero owns its map). When this option is turned on, sending CStackInstance\* will actually send an owning object (town, hero, garrison, etc) id and the stack slot position. + +For this to work, obviously, both sides of the connection need to have exactly the same copies of an armed object and its stacks. + +This feature depends on vectorised member serialization being turned on. (Sending owning object by id.) + +### Smart pointer serialization + +Note: name is unfortunate, this feature is not about smart pointers (like shared-ptr and unique_ptr). It is for raw C-style pointers, that happen to point to the same object. + +This feature makes it that multiple pointers pointing to the same object are not stored twice. + +Each time a pointer is stored, a unique id is given to it. If the same pointer is stored a second time, its contents is not serialized — serializer just stores a reference to the id. + +For example: + +``` cpp +Foo * a = new Foo(); +Foo * b = b; + +{ + CSaveFile test("test.txt"); + test << a << b; +} + +Foo *loadedA, *loadedB; +{ + CLoadFile test("test.txt"); + test >> loadedA >> loadedB; + //now both pointers point to the same object + assert(loadedA == loadedB); +} +``` + +The feature recognizes pointers by addresses. Therefore it allows mixing pointers to base and derived classes. However, it does not allow serializing classes with multiple inheritance using a "non-first" base (other bases have a certain address offset from the actual object). + +Pointer cycles are properly handled. This feature makes sense for savegames and is turned on for them. \ No newline at end of file diff --git a/docs/maintainers/Project_Infrastructure.md b/docs/maintainers/Project_Infrastructure.md new file mode 100644 index 000000000..710f1f994 --- /dev/null +++ b/docs/maintainers/Project_Infrastructure.md @@ -0,0 +1,136 @@ +< [Documentation](../Readme.md) / Project Infrastructure + +# Project Infrastructure + +This section hold important information about project infrastructure for current and future contributors. At moment it's all maintained by me (SXX), but following information will be useful if someone going to replace me in future. + +## Services and accounts + +So far we using following services: + +### Most important + +- VCMI.eu domain paid until July of 2019. + - Owner: Tow + - Our main domain used by services. +- VCMI.download paid until November of 2026. + - Owner: SXX + - Intended to be used for all assets downloads. + - Domain registered on GANDI and **can be renewed by anyone without access to account**. +- [DigitalOcean](https://cloud.digitalocean.com/) team. + - Our hosting sponsor. + - Administrator access: SXX, Warmonger. + - User access: AVS, Tow. +- [CloudFlare](https://www.cloudflare.com/a/overview) account. + - Access through shared login / password. + - All of our infrastructure is behind CloudFlare and all our web. We manage our DNS there. +- [Google Apps (G Suite)](https://admin.google.com/) account. + - It's only for vcmi.eu domain and limited to 5 users. Each account has limit of 500 emails / day. + - One administrative email used for other services registration. + - "noreply" email used for outgoing mail on Wiki and Bug Tracker. + - "forum" email used for outgoing mail on Forums. Since we authenticate everyone through forum it's should be separate email. + - Administrator access: Tow, SXX. +- [Google Play Console](https://play.google.com/apps/publish/) account. + - Hold ownership over VCMI Android App. + - Owner: SXX + - Administrator access: Warmonger, AVS, Ivan. + - Release manager access: Fay. + +Not all services let us safely share login credentials, but at least when possible at least two of core developers must have access to them in case of emergency. + +### Public relations + +We want to notify players about updates on as many social services as possible. + +- Facebook page: + - Administrator access: SXX, Warmonger +- Twitter account: + - Administrator access: SXX. + - User access via TweetDeck: +- VK / VKontakte page: + - Owner: SXX + - Administrator access: AVS +- Steam group: + - Administrator access: SXX + - Moderator access: Dydzio +- Reddit: + - Administrator access: SXX +- ModDB entry: + - Administrator access: SXX + +### Communication channels + +- Slack team: + - Owner: vmarkovtsev + - Administrator access: SXX, Warmonger, AVS... +- Trello team: + - Administrator access: SXX +- Discord: + - Owner: dydzio + - Administrator access: SXX, Warmonger, Ivan... + +### Other services + +- Launchpad PPA: + - Member access: AVS + - Administrator access: Ivan, SXX +- Snapcraft Dashboard: + - Administrator access: SXX +- Coverity Scan page: + - Administrator access: SXX, Warmonger, AVS +- OpenHub page: + - Administrator access: Tow +- Docker Hub organization: + - Administrator access: SXX + +Reserve accounts for other code hosting services: + +- GitLab organization: + - Administrator access: SXX +- BitBucket organization: + - Administrator access: SXX + +## What's to improve + +1. Encourage Tow to transfer VCMI.eu to GANDI so it's can be also renewed without access. +2. Use 2FA on CloudFlare and just ask everyone to get FreeOTP and then use shared secret. +3. Centralized way to post news about game updates to all social media. + +# Project Servers Configuration + +This section dedicated to explain specific configurations of our servers for anyone who might need to improve it in future. + +## Droplet configuration + +### Droplet and hosted services + +Currently we using two droplets: + +- First one serve all of our web services: + - [Forum](https://forum.vcmi.eu/) + - [Bug tracker](https://bugs.vcmi.eu/) + - [Wiki](https://wiki.vcmi.eu/) + - [Slack invite page](https://slack.vcmi.eu/) +- Second serve downloads: + - [Legacy download page](http://download.vcmi.eu/) + - [Build download page](https://builds.vcmi.download/) + +To keep everything secure we should always keep binary downloads separate from any web services. + +### Rules to stick to + +- SSH authentication by public key only. +- Incoming connections to all ports except SSH (22) must be blocked. +- Exception for HTTP(S) connection on ports 80 / 443 from [CloudFlare IP Ranges](https://www.cloudflare.com/ips/). +- No one except core developers should ever know real server IPs. +- Droplet hostname should never be valid host. Otherwise it's exposed in [reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS). +- If some non-web service need to listen for external connections then read below. + +### Our publicly-facing server + +We only expose floating IP that can be detached from droplet in case of emergency using [DO control panel](https://cloud.digitalocean.com/networking/floating_ips). This also allow us to easily move public services to dedicated droplet in future. + +- Address: beholder.vcmi.eu (67.207.75.182) +- Port 22 serve SFTP for file uploads as well as CI artifacts uploads. + +If new services added firewall rules can be adjusted in [DO control panel](https://cloud.digitalocean.com/networking/firewalls). \ No newline at end of file diff --git a/docs/maintainers/Release_Process.md b/docs/maintainers/Release_Process.md new file mode 100644 index 000000000..2e23e41b7 --- /dev/null +++ b/docs/maintainers/Release_Process.md @@ -0,0 +1,48 @@ +< [Documentation](../Readme.md) / Release Process + +## Branches +Our branching strategy is very similar to GitFlow +* `master` branch has release commits. One commit - one release. Each release commit should be tagged with version `maj.min.patch` +* `beta` branch is for stabilization of ongoing release. We don't merge new features into `beta` branch - only bug fixes are acceptable. Hotfixes for already released software should be delivered to this branch as well. +* `develop` branch is a main branch for ongoing development. Pull requests with new features should be targeted to this branch, `develop` version is one step ahead of 'beta` + +## Release process step-by-step +Assuming that all features planned to be released are implemented in `develop` branch and next release version will be `1.x.0` + +### Start of stabilization stage +Should be done several weeks before planned release date + +- Create [milestone](https://github.com/vcmi/vcmi/milestones) named `Release 1.x` +- Specify new milestone for all regression bugs and major bugs related to new functionality +- Create `beta` branch from `develop` +- Bump vcmi version on `develop` branch +- Bump version for linux on `develop` branch + +### Release preparation stage +Should be done several days before planned release date + +- Make sure to announce codebase freeze deadline to all developers +- Update [release notes](https://github.com/vcmi/vcmi/blob/develop/ChangeLog.md) +- Update release date for Linux packaging. See [example](https://github.com/vcmi/vcmi/pull/1258) +- Update release date for Android packaging. See [example](https://github.com/vcmi/vcmi/pull/2090) +- Create draft release page, specify `1.x.0` as tag for `master` after publishing +- Prepare pull request with release update for web site https://github.com/vcmi/VCMI.eu +- Prepare pull request for [vcmi-updates](https://github.com/vcmi/vcmi-updates) + +### Release publishing phase +Should be done on release date + +- Check that all items from milestone `Release 1.x` completed +- Merge `beta` into `master` +- Check that artifacts for all platforms are available on `master` branch +- Trigger builds for new release on Ubuntu PPA +- Attach build artifacts for all platforms to release page +- Merge prepared pull requests +- Publish release page + +### After release publish + +- Close `Release 1.x` milestone +- Write announcements in social networks +- Merge `master` into `develop` +- Update downloads counter in readme.md. See [example](https://github.com/vcmi/vcmi/pull/2091) diff --git a/docs/maintainers/Ubuntu_PPA.md b/docs/maintainers/Ubuntu_PPA.md new file mode 100644 index 000000000..6241d91da --- /dev/null +++ b/docs/maintainers/Ubuntu_PPA.md @@ -0,0 +1,44 @@ +< [Documentation](../Readme.md) / Ubuntu PPA + +## Main links +- [Team](https://launchpad.net/~vcmi) +- [Project](https://launchpad.net/vcmi) +- [Sources](https://code.launchpad.net/~vcmi/vcmi/+git/vcmi) +- [Recipes](https://code.launchpad.net/~vcmi/+recipes) +- - [Stable recipe](https://code.launchpad.net/~vcmi/+recipe/vcmi-stable) +- - [Daily recipe](https://code.launchpad.net/~vcmi/+recipe/vcmi-daily) +- PPA's +- - [Stable PPA](https://launchpad.net/~vcmi/+archive/ubuntu/ppa) +- - [Daily PPA](https://launchpad.net/~vcmi/+archive/ubuntu/vcmi-latest) + +## Automatic daily builds process + +### Code import +- Launchpad performs regular (once per few hours) clone of our git repository. +- This process can be observed on [Sources](https://code.launchpad.net/~vcmi/vcmi/+git/vcmi) page. +- If necessary, it is possible to trigger fresh clone immediately (Import Now button) +### Build dependencies +- All packages required for building of vcmi are defined in [debian/control](https://github.com/vcmi/vcmi/blob/develop/debian/control) file +- Launchpad will automatically install build dependencies during build +- Dependencies of output .deb package are defined implicitly as dependencies of packages required for build +### Recipe building +- Every 24 hours Launchpad triggers daily builds on all recipes that have build schedule enable. For vcmi this is [Daily recipe](https://code.launchpad.net/~vcmi/+recipe/vcmi-daily) +- Alternatively, builds can be triggered manually using "request build(s) link on recipe page. VCMI uses this for [Stable recipe](https://code.launchpad.net/~vcmi/+recipe/vcmi-stable) +### Recipe content (build settings) +- Version of resulting .deb package is set in recipe content, e.g `{debupstream}+git{revtime}` for daily builds +- Base version (referred as `debupstream` on Launchpad is taken from source code, [debian/changelog](https://github.com/vcmi/vcmi/blob/develop/debian/changelog) file +- CMake configuration settings are taken from source code, [debian/rules](https://github.com/vcmi/vcmi/blob/develop/debian/rules) file +- Branch which is used for build is specified in recipe content, e.g. `lp:vcmi master` +## Workflow for creating a release build +- if necessary, push all required changes including `debian/changelog` update to `vcmi/master` branch +- Go to [Sources](https://code.launchpad.net/~vcmi/vcmi/+git/vcmi) and run repository import. +- Wait for import to finish, which usually happens within a minute. Press F5 to actually see changes. +- Go to [Stable recipe](https://code.launchpad.net/~vcmi/+recipe/vcmi-stable) and request new builds +- Wait for builds to finish. This takes quite a while, usually - over a hour, even more for arm builds +- Once built, all successfully built packages are automatically copied to PPA linked to the recipe +- If any of builds have failed, open page with build info and check logs. +## People with access +- [alexvins](https://github.com/alexvins) (https://launchpad.net/~alexvins) +- [ArseniyShestakov](https://github.com/ArseniyShestakov) (https://launchpad.net/~sxx) +- [IvanSavenko](https://github.com/IvanSavenko) (https://launchpad.net/~saven-ivan) +- (Not member of VCMI, creator of PPA) (https://launchpad.net/~mantas) \ No newline at end of file diff --git a/docs/modders/Animation_Format.md b/docs/modders/Animation_Format.md new file mode 100644 index 000000000..5cd6ef760 --- /dev/null +++ b/docs/modders/Animation_Format.md @@ -0,0 +1,117 @@ +< [Documentation](../Readme.md) / [Modding](Readme.md) / Animation Format + +VCMI allows overriding HoMM3 .def files with .json replacement. Compared to .def this format allows: + +- Overriding individual frames from json file (e.g. icons) +- Modern graphics formats (targa, png - all formats supported by VCMI image loader) +- Does not requires any special tools - all you need is text editor and images. + +# Format description + +``` javascript +{ + // Base path of all images in animation. Optional. + // Can be used to avoid using long path to images + "basepath" : "path/to/images/directory/", + + // List of sequiences / groups in animation + // This will replace original group with specified list of files + // even if original animation is longer + "sequences" : + [ + { + // Index of group, zero-based + "group" : 1, + + // List of files in this group + "frames" : + [ + "frame1.png", + "frame2.png" + ... + ] + }, + ... + ], + + // Allow overriding individual frames in file + "images" : + [ + { + // Group of this image. Optional, default = 0 + "group" : 0, + + // Imdex of the image in group + "frame" : 0, + + // Filename for this frame + "file" : "filename.png" + }. + ... + ] + +} +``` + +# Creature animation groups + +Animation for creatures consist from multiple groups, with each group +representing one specific animation. VCMI uses groups as follows: + +**Basic animations** + +- [0] Movement: Used for creature movement +- [1] Mouse over: Used for random idle movements and when mouse is moved on the creature +- [2] Idle: Basic animation that plays continuously when stack is not acting +- [3] Hitted: Animation that plays whenever stack is hit +- [4] Defence: Alternative animation that plays when stack is defending and was hit in melee +- [5] Death: Animation that plays when stack dies +- [6] Death (ranged): Alternative animation, plays when stack is killed by ranged attack + +**Rotation animations** + +- [7] Turn left: Animation for rotating stack, only contains first part of animation, with stack turning towards viewer +- [8] Turn right: Second part of animation for rotating stack +- [9] (unused in vcmi, present in H3 files) +- [10] (unused in vcmi, present in H3 files) + +**Melee attack animations** + +- [11] Attack (up): Attacking animation, stack facing upwards +- [12] Attack (front): Attacking animation, stack facing front +- [13] Attack (down): Attacking animation, stack facing downwards + +**Ranged attack animations** + +- [14] Shooting (up): Ranged attack animation, stack facing upwards +- [15] Shooting (front): Ranged attack animation, stack facing front +- [16] Shooting (down): Ranged attack animation, stack facing downwards + +**Special animations** + +- [17] Special (up): Special animation, used if dedicated cast or group attack animations were not found +- [18] Special (front): Special animation, used if dedicated cast or group attack animations were not found +- [19] Special (down): Special animation, used if dedicated cast or group attack animations were not found + +**Additional H3 animations** + +- [20] Movement start: Animation that plays before movement animation starts. +- [21] Movement end: Animation that plays after movement animation ends. + +**Additional VCMI animations** + +- [22] Dead: Animation that plays when creature is dead. If not present, will consist from last frame from "Death" group +- [23] Dead (ranged): Animation that plays when creature is dead after ranged attack. If not present, will consist from last frame from "Death (ranged)" group +- [24] Resurrection: Animation that plays when creature is resurrected. If not present, will consist from reversed version of "Death" animation + +**Spellcasting animations** + +- [30] Cast (up): Used when creature casts spell facing upwards +- [31] Cast (front): Used when creature casts spell facing front +- [32] Cast (down): Used when creature casts spell facing downwards + +**Group attack animations** + +- [40] Group Attack (up): Used when creature attacks multiple target, with primary target facing up (Dragon Breath attack, or creatures like Hydra) +- [41] Group Attack (front): Used when creature attacks multiple target, with primary target facing front (Dragon Breath attack, or creatures like Hydra) +- [42] Group Attack (down): Used when creature attacks multiple target, with primary target facing downwards (Dragon Breath attack, or creatures like Hydra) diff --git a/docs/modders/Bonus/Bonus_Duration_Types.md b/docs/modders/Bonus/Bonus_Duration_Types.md new file mode 100644 index 000000000..28056c6b1 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Duration_Types.md @@ -0,0 +1,16 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Duration Types + +Bonus may have any of these durations. They acts in disjunction. + +## List of all bonus duration types + +- PERMANENT +- ONE_BATTLE: at the end of battle +- ONE_DAY: at the end of day +- ONE_WEEK: at the end of week (bonus lasts till the end of week, NOT 7 days) +- N_TURNS: used during battles, after battle bonus is always removed +- N_DAYS +- UNTIL_BEING_ATTACKED: removed after any damage-inflicting attack +- UNTIL_ATTACK: removed after attack and counterattacks are performed +- STACK_GETS_TURN: removed when stack gets its turn - used for defensive stance +- COMMANDER_KILLED \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Limiters.md b/docs/modders/Bonus/Bonus_Limiters.md new file mode 100644 index 000000000..c9d124e18 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Limiters.md @@ -0,0 +1,124 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Limiters + +## Predefined Limiters + +The limiters take no parameters: + +- SHOOTER_ONLY +- DRAGON_NATURE +- IS_UNDEAD +- CREATURE_NATIVE_TERRAIN +- CREATURE_FACTION +- SAME_FACTION +- CREATURES_ONLY +- OPPOSITE_SIDE + +Example: + +``` javascript +"limiters" : [ "SHOOTER_ONLY" ] +``` + +## Customizable Limiters + +### HAS_ANOTHER_BONUS_LIMITER + +Parameters: + +- Bonus type +- (optional) bonus subtype +- (optional) bonus sourceType and sourceId in struct +- example: (from Adele's bless): + +``` javascript + "limiters" : [ + { + "type" : "HAS_ANOTHER_BONUS_LIMITER", + "parameters" : [ + "GENERAL_DAMAGE_PREMY", + 1, + { + "type" : "SPELL_EFFECT", + "id" : "spell.bless" + } + ] + } + ], +``` + +### CREATURE_TYPE_LIMITER + +Parameters: + +- Creature id (string) +- (optional) include upgrades - default is false + +### CREATURE_ALIGNMENT_LIMITER + +Parameters: + +- Alignment identifier + +### CREATURE_LEVEL_LIMITER + +If parameters is empty, level limiter works as CREATURES_ONLY limiter + +Parameters: +- Minimal level +- Maximal level + +### FACTION_LIMITER + +Parameters: + +- Faction identifier + +### CREATURE_TERRAIN_LIMITER + +Parameters: + +- Terrain identifier + +Example: + +``` javascript +"limiters": [ { + "type":"CREATURE_TYPE_LIMITER", + "parameters": [ "angel", true ] +} ], +``` + +``` javascript +"limiters" : [ { + "type" : "CREATURE_TERRAIN_LIMITER", + "parameters" : ["sand"] +} ] +``` + +### UNIT_ON_HEXES + +Parameters: + +- List of affected battlefield hexes + +## Aggregate Limiters + +The following limiters must be specified as the first element of a list, +and operate on the remaining limiters in that list: + +- allOf (default when no aggregate limiter is specified) +- anyOf +- noneOf + +Example: + +``` javascript +"limiters" : [ + "noneOf", + "IS_UNDEAD", + { + "type" : "HAS_ANOTHER_BONUS_LIMITER", + "parameters" : [ "SIEGE_WEAPON" ] + } +] +``` \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Propagators.md b/docs/modders/Bonus/Bonus_Propagators.md new file mode 100644 index 000000000..40da21750 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Propagators.md @@ -0,0 +1,10 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Propagators + +## Available propagators + +- BATTLE_WIDE: Affects both sides during battle +- VISITED_TOWN_AND_VISITOR: Used with Legion artifacts (town visited by hero) +- PLAYER_PROPAGATOR: Bonus will affect all objects owned by player. Used by Statue of Legion. +- HERO: Bonus will be transferred to hero (for example from stacks in his army). +- TEAM_PROPAGATOR: Bonus will affect all objects owned by player and his allies. +- GLOBAL_EFFECT: This effect will influence all creatures, heroes and towns on the map. \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Range_Types.md b/docs/modders/Bonus/Bonus_Range_Types.md new file mode 100644 index 000000000..21ce14d36 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Range_Types.md @@ -0,0 +1,19 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Range Types + +# List of all Bonus range types + +- NO_LIMIT +- ONLY_DISTANCE_FIGHT +- ONLY_MELEE_FIGHT + +TODO: ONLY_MELEE_FIGHT / ONLY_DISTANCE_FIGHT range types work ONLY with creature attack, should be extended to all battle abilities. + +For replacing ONLY_ENEMY_ARMY alias, you should use the following parameters of bonus: + +``` + "propagator": "BATTLE_WIDE", + "propagationUpdater" : "BONUS_OWNER_UPDATER", + "limiters" : [ "OPPOSITE_SIDE" ] +``` + +If some propagators was set before, it was actually ignored and should be replaced to code above. And OPPOSITE_SIDE limiter should be first, if any other limiters exists. \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Sources.md b/docs/modders/Bonus/Bonus_Sources.md new file mode 100644 index 000000000..64d469d97 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Sources.md @@ -0,0 +1,22 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Sources + +# List of all possible bonus sources + +- ARTIFACT +- ARTIFACT_INSTANCE +- OBJECT +- CREATURE_ABILITY +- TERRAIN_NATIVE +- TERRAIN_OVERLAY +- SPELL_EFFECT +- TOWN_STRUCTURE +- HERO_BASE_SKILL +- SECONDARY_SKILL +- HERO_SPECIAL +- ARMY +- CAMPAIGN_BONUS +- SPECIAL_WEEK +- STACK_EXPERIENCE +- COMMANDER +- GLOBAL +- OTHER \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Types.md b/docs/modders/Bonus/Bonus_Types.md new file mode 100644 index 000000000..873d43e37 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Types.md @@ -0,0 +1,862 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Types + +The bonuses were grouped according to their original purpose. The bonus system allows them to propagate freely betwen the nodes, however they may not be recognized properly beyond the scope of original use. + +# General-purpose bonuses + +### NONE + +Special bonus that gives no effect + +### MORALE + +Changes morale of affected units + +- val: change in morale + +### LUCK + +Changes luck of affected units + +- val: change in luck + +### MAGIC_SCHOOL_SKILL + +Changes mastery level of spells of affected heroes and units. Examples are magic plains terrain and magic school secondary skills + +- subtype: school of magic +- val: level + +### DARKNESS + +On each turn, hides area in fog of war around affected town for all players other than town owner + +- val: radius in tiles + +# Hero bonuses + +### MOVEMENT + +Increases amount of movement points available to affected hero on new turn + +- subtype: 0 - sea, subtype 1 - land +- val: number of movement points (100 points for a tile) + +### WATER_WALKING + +Allows movement over water for affected heroes + +- subtype: 1 - without penalty, 2 - with penalty + +### FLYING_MOVEMENT + +Allows flying movement for affected heroes + +- subtype: 1 - without penalty, 2 - with penalty + +### NO_TERRAIN_PENALTY + +Eliminates terrain penalty on certain terrain types for affected heroes (Nomads ability). + +- subtype: type of terrain + +### PRIMARY_SKILL + +Changes selected primary skill for affected heroes and units + +- subtype: primary skill +- additional info: 1 - only for melee attacks, 2 - only for ranged attacks + +### SIGHT_RADIUS + +Reveal area of fog of war around affected heroes when hero is recruited or moves + +- val: radius in tiles + +### MANA_REGENERATION + +Restores specific amount of mana points for affected heroes on new turn + +- val: amount of spell points to restore + +### FULL_MANA_REGENERATION + +Restores entire mana pool for affected heroes on new turn + +### NONEVIL_ALIGNMENT_MIX + +Allows mixing of creaturs of neutral and good factions in affected armies without penalty to morale + +### SURRENDER_DISCOUNT + +Changes surrender cost for affected heroes + +- val: decrease in cost, in precentage + +### IMPROVED_NECROMANCY + +TODO: Determine units which is raised by necromancy skill. + +- subtype: creature raised +- val: Necromancer power +- addInfo: limiter by Necromancer power +- Example (from Necromancy skill): + +` "power" : {` +` "type" : "IMPROVED_NECROMANCY",` +` "subtype" : "creature.skeleton",` +` "addInfo" : 0` +` }` + +### LEARN_BATTLE_SPELL_CHANCE + +Determines chance for affected heroes to learn spell casted by enemy hero after battle + +- val: chance to learn spell, percentage + +### LEARN_BATTLE_SPELL_LEVEL_LIMIT + +Allows affected heroes to learn spell casted by enemy hero after battle + +- subtype: must be set to -1 +- val: maximal level of spell that can be learned + +### LEARN_MEETING_SPELL_LIMIT + +Allows affected heroes to learn spells from each other during hero exchange + +- subtype: must be set to -1 +- val: maximal level of spell that can be learned + +### ROUGH_TERRAIN_DISCOUNT + +Reduces movement points penalty when moving on terrains with movement cost over 100 points. Can not reduce movement cost below 100 points + +- val: penalty reduction, in movement points per tile. + +### WANDERING_CREATURES_JOIN_BONUS + +Increases probability for wandering monsters to join army of affected heroes + +- val: change in disposition factor when calculating join chance + +### BEFORE_BATTLE_REPOSITION + +Allows affected heroes to position army before start of battle (Tactics) + +- val: distance within which hero can reposition his troops + +### BEFORE_BATTLE_REPOSITION_BLOCK + +Reduces distance in which enemy hero can reposition. Counters BEFORE_BATTLE_REPOSITION bonus + +- val: distance within which hero can reposition his troops + +### HERO_EXPERIENCE_GAIN_PERCENT + +Increases experience gain from all sources by affected heroes + +- val: additional experience bonus, percentage + +### UNDEAD_RAISE_PERCENTAGE + +Defines percentage of enemy troops that will be raised after battle into own army (Necromancy). Raised unit is determined by IMPROVED_NECROMANCY bonus + +- val: percentage of raised troops + +### MANA_PER_KNOWLEDGE + +Defines amount of mana points that hero gains per each point of knowledge (Intelligence) + +- val: Amount of mana points per knowledge + +### HERO_GRANTS_ATTACKS + +Gives additional attacks to specific creatures in affected army (Artillery) + +- subtype: creature to give additional attacks +- val: number of attacks + +### BONUS_DAMAGE_CHANCE + +Gives specific creature in affected army chance to deal additional damage (Artillery) + +- subtype: creature to give additional damage chance +- val: chance to deal additional damage, percentage + +### BONUS_DAMAGE_PERCENTAGE + +Defines additional damage dealt for creatures affected by BONUS_DAMAGE_CHANCE bonus (Artillery) + +- subtype: creature to give additional damage percentage +- val: bonus damage, percentage + +### MAX_LEARNABLE_SPELL_LEVEL + +Defines maximum level of spells than hero can learn from any source (Wisdom) + +- val: maximal level to learn + +## Hero specialties + +### SPECIAL_SPELL_LEV + +Gives additional bonus to effect of specific spell based on level of creature it is casted on + +- subtype: identifier of affected spell +- val: bonus to spell effect, percentage, divided by target creature level + +### SPELL_DAMAGE + +Gives additional bonus to effect of all spells of selected school + +- subtype: affected spell school +- val: spell effect bonus, percentage + +### SPECIFIC_SPELL_DAMAGE + +Gives additional bonus to effect of specific spell + +- subtype: identifier of affected spell +- val: bonus to spell effect, percentage + +### SPECIAL_PECULIAR_ENCHANT + +TODO: blesses and curses with id = val dependent on unit's level + +- subtype: 0 or 1 for Coronius + +### SPECIAL_UPGRADE + +Allows creature upgrade for affected armies + +- subtype: identifier of creature that can being upgraded +- addInfo: identifier of creature to which perform an upgrade + +# Artifact bonuses + +### SPELL_DURATION + +Changes duration of timed spells casted by affected hero + +- val: additional duration, turns + +### SPELL + +Allows affected heroes to cast specified spell, even if this spell is banned in map options or set to "special". + +- subtype: spell identifier +- val: skill level mastery (0 - 3) + +### SPELLS_OF_LEVEL + +Allows affected heroes to cast any spell of specified level. Does not grant spells banned in map options. + +- subtype: spell level + +### SPELLS_OF_SCHOOL + +Allows affected heroes to cast any spell of specified school. Does not grant spells banned in map options. + +- subtype: spell school + +### GENERATE_RESOURCE + +Affected heroes will add specified resources amounts to player treasure on new day + +- subtype: resource identifier +- val: additional daily income + +### CREATURE_GROWTH + +Increases weekly growth of creatures in affected towns (Legion artifacts) + +- value: number of additional weekly creatures +- subtype: level of affected dwellings + +### CREATURE_GROWTH_PERCENT + +Increases weekly growth of creatures in affected towns + +- val: additional growth, percentage + +### BATTLE_NO_FLEEING + +Heroes affected by this bonus can not retreat or surrender in battle + +### NEGATE_ALL_NATURAL_IMMUNITIES + +- subtype: TODO +Orb of Vulnerability + +### OPENING_BATTLE_SPELL + +In battle, army affected by this bonus will cast spell at the very start of the battle + +- subtype: spell identifer +- val: spell mastery level + +### FREE_SHIP_BOARDING + +Heroes affected by this bonus will keep all their movement points when embarking or disembarking ship + +### WHIRLPOOL_PROTECTION + +Heroes affected by this bonus won't lose army when moving through whirlpool + +# Creature bonuses + +### STACK_HEALTH + +Increases maximum hit point of affected units + +- val: additional hit points to gain + +### STACKS_SPEED + +Increases movement speed of units in battle + +- val: additional movement speed points + +### CREATURE_DAMAGE + +Increases base damage of creature in battle + +- subtype: 0 = both min and max, 1 = min, 2 = max +- val: additional damage points + +### SHOTS + +Increases starting amount of shots that unit has in battle + +- val: additional shots + +# Creature abilities + +## Static abilities and immunities + +### NON_LIVING + +Affected unit is considered to not be alive and not affected by morale and certain spells + +### GARGOYLE + +Affected unit is considered to be a gargoyle and not affected by certain spells + +### UNDEAD + +Affected unit is considered to be undead + +### SIEGE_WEAPON + +Affected unit is considered to be a siege machine and can not be raised, healed, have morale or move. + +### DRAGON_NATURE + +Affected unit is dragon. This bonus proved no effect, but is used as limiter several effects. + +### KING + +Affected unit will take more damage from units under Slayer spell effect + +- val: required skill mastery of Slayer spell to affect this unit + +### FEARLESS + +Affected unit is immune to Fear ability + +### NO_LUCK + +Affected units can not receive good or bad luck + +### NO_MORALE + +Affected units can not receive good or bad morale + +## Combat abilities + +### FLYING + +Affected unit can fly on the battlefield + +- subtype: 0 - flying unit, 1 - teleporting unit + +### SHOOTER + +Affected unit can shoot + +### CHARGE_IMMUNITY + +Affected unit is immune to JOUSTING ability + +### ADDITIONAL_ATTACK + +Affected unit can perform additional attacks. Attacked unit will retaliate after each attack if can + +- val: number of additional attacks to perform + +### UNLIMITED_RETALIATIONS + +Affected unit will always retaliate if able + +### ADDITIONAL_RETALIATION + +Affected unit can retaliate multiple times per turn + +- value: number of additional retaliations + +### JOUSTING + +Affected unit will deal more damage based on movement distance (Champions) + +- val: additional damage per passed tile, percentage + +### HATE + +Affected unit will deal more damage when attacking specific creature + +- subtype - identifier of hated creature, +- val - additional damage, percentage + +### SPELL_LIKE_ATTACK + +Affected unit ranged attack will use animation and range of specified spell (Magog, Lich) + +- subtype - spell identifier +- value - spell mastery level + +### THREE_HEADED_ATTACK + +Affected unit attacks creatures located on tiles to left and right of targeted tile (Cerberus). Only directly targeted creature will attempt to retaliate + +### ATTACKS_ALL_ADJACENT + +Affected unit attacks all adjacent creatures (Hydra). Only directly targeted creature will attempt to retaliate + +### TWO_HEX_ATTACK_BREATH + +Affected unit attacks creature located directly behind targeted tile (Dragons). Only directly targeted creature will attempt to retaliate + +### RETURN_AFTER_STRIKE + +Affected unit can return to his starting location after attack (Harpies) + +### ENEMY_DEFENCE_REDUCTION + +Affected unit will ignore specified percentage of attacked unit defence (Behemoth) + +- val: amount of defence points to ignore, percentage + +### GENERAL_DAMAGE_REDUCTION + +- subtype - 0 - shield (melee) , 1 - air shield effect (ranged), -1 - + armorer secondary skill (all, since 1.2) + +### PERCENTAGE_DAMAGE_BOOST + +- subtype: -1 - any damage (not used), 0 - melee damage (offence), 1 - + ranged damage (archery) + +### GENERAL_ATTACK_REDUCTION + +eg. while stoned or blinded - in % + +- subtype: -1 - any damage, 0 - melee damage, 1 - ranged damage + +### DEFENSIVE_STANCE + +WoG ability. + +- val - bonus to defense while defending + +### NO_DISTANCE_PENALTY + +### NO_MELEE_PENALTY + +Ranged stack does full damage in melee. + +### NO_WALL_PENALTY + +### FREE_SHOOTING + +stacks can shoot even if otherwise blocked (sharpshooter's bow effect) + +### BLOCKS_RETALIATION + +eg. naga + +### SOUL_STEAL + +WoG ability. Gains new creatures for each enemy killed + +- val: number of units gained per enemy killed +- subtype: 0 - gained units survive after battle, 1 - they do not + +### TRANSMUTATION + +WoG ability. % chance to transform attacked unit to other type + +- val: chance to trigger in % +- subtype: 0 - resurrection based on HP, 1 - based on unit count +- addInfo: additional info - target creature ID (attacker default) + +### SUMMON_GUARDIANS + +WoG ability. Summon guardians surrounding desired stack + +- val - amount in % of stack count +- subtype = creature ID + +### RANGED_RETALIATION + +Allows shooters to perform ranged retaliation + +- no additional parameters + +### BLOCKS_RANGED_RETALIATION + +Disallows ranged retaliation for shooter unit, BLOCKS_RETALIATION bonus +is for melee retaliation only + +- no additional parameters + +### WIDE_BREATH + +Dragon breath affecting multiple nearby hexes + +- no additional parameters + +### FIRST_STRIKE + +First counterattack, then attack if possible + +- no additional parameters + +### SHOOTS_ALL_ADJACENT + +H4 Cyclops-like shoot (attacks all hexes neighboring with target) +without spell-like mechanics + +- no additional parameters + +### DESTRUCTION + +Kills extra units after hit + +- subtype: 0 - kill percentage of units, 1 - kill amount +- val: chance in percent to trigger +- addInfo: amount/percentage to kill + +### LIMITED_SHOOTING_RANGE + +Limits shooting range and/or changes long range penalty + +- val: max shooting range in hexes +- addInfo: optional - sets range for "broken arrow" half damage + mechanic - default is 10 + +## Special abilities + +### CATAPULT + +- subtype: ability to use when catapulting (usually it contains ballistics parameters, ability for standard catapult and affected by ballistics is core:spell.catapultShot) + +### CATAPULT_EXTRA_SHOTS + +- subtype: ability to be affected. Ability of CATAPULT bonus should match. Used for ballistics secondary skill with subtype of core:spell.catapultShot. +- val: ability level to be used with catapult. Additional shots configured in ability level, not here. + +### MANUAL_CONTROL + +- manually control warmachine with +- id = subtype +- val = chance + +### CHANGES_SPELL_COST_FOR_ALLY + +eg. mage + +- value - reduction in mana points + +### CHANGES_SPELL_COST_FOR_ENEMY + +eg. Silver Pegasus + +- value - mana points penalty + +### SPELL_RESISTANCE_AURA + +eg. unicorns + +- value - resistance bonus in % for adjacent creatures + +### HP_REGENERATION + +creature regenerates val HP every new round + +- val: amount of HP regeneration per round + +### MANA_DRAIN + +value - spell points per turn + +### MANA_CHANNELING + +eg. familiar + +- value in % + +### LIFE_DRAIN + +- val - precentage of life drained + +### DOUBLE_DAMAGE_CHANCE + +eg. dread knight + +- value in % + +### FEAR + +### HEALER + +First aid tent + +- subtype: ability used for healing. + +### FIRE_SHIELD + +### MAGIC_MIRROR + +- value - chance of redirecting in % + +### ACID_BREATH + +- val - damage per creature after attack, +- additional info - chance in percent + +### DEATH_STARE + +- subtype: 0 - gorgon, 1 - commander +- val: if subtype is 0, its the (average) percentage of killed + creatures related to size of attacking stack + +### SPECIAL_CRYSTAL_GENERATION + +Crystal dragon crystal generation + +### NO_SPELLCAST_BY_DEFAULT + +Spellcast will not be default attack option for this creature + +## Creature spellcasting and activated abilities + +### SPELLCASTER + +Creature gain activated ability to cast a spell. Example: Archangel, +Faerie Dragon + +- subtype - spell id +- value - level of school +- additional info - weighted chance + +use SPECIFIC_SPELL_POWER, CREATURE_SPELL_POWER or CREATURE_ENCHANT_POWER +for calculating the power (since 1.2 those bonuses can be used for +calculating CATAPULT and HEALER bonuses) + +### ENCHANTER + +for Enchanter spells + +- val - skill level +- subtype - spell id +- additionalInfo - cooldown (number of turns) + +### RANDOM_SPELLCASTER + +eg. master genie + +- val - spell mastery level + +### SPELL_AFTER_ATTACK + +- subtype - spell id +- value - chance % +- additional info - \[X, Y\] +- X - spell level +- Y = 0 - all attacks, 1 - shot only, 2 - melee only + +### SPELL_BEFORE_ATTACK + +- subtype - spell id +- value - chance % +- additional info - \[X, Y\] +- X - spell level +- Y = 0 - all attacks, 1 - shot only, 2 - melee only + +### CASTS + +how many times creature can cast activated spell + +### SPECIFIC_SPELL_POWER + +- value used for Thunderbolt and Resurrection casted by units, also + for Healing secondary skill (for core:spell.firstAid used by First + Aid tent) +- subtype - spell id + +### CREATURE_SPELL_POWER + +- value per unit, divided by 100 (so faerie Dragons have 500) + +### CREATURE_ENCHANT_POWER + +total duration of spells casted by creature + +### REBIRTH + +- val - percent of total stack HP restored +- subtype = 0 - regular, 1 - at least one unit (sacred Phoenix) + +### ENCHANTED + +Stack is permanently enchanted with spell subID of skill level = val, if val > 3 then spell is mass and has level of val-3. Enchantment is refreshed every turn. + +## Spell immunities + +### LEVEL_SPELL_IMMUNITY + +creature is immune to all spell with level below or equal to value of this bonus + +### MAGIC_RESISTANCE + +- value - percent + +### SPELL_DAMAGE_REDUCTION + +eg. golems + +- value - reduction in % +- subtype - spell school; -1 - all, 0 - air, 1 - fire, 2 - water, 3 - + earth + +### MORE_DAMAGE_FROM_SPELL + +- value - damage increase in % +- subtype - spell id + +### FIRE_IMMUNITY,WATER_IMMUNITY, EARTH_IMMUNITY, AIR_IMMUNITY + +- subtype 0 - all, 1 - all except positive, 2 - only damage spells + +### MIND_IMMUNITY + +Creature is immune to all mind spells. + +### SPELL_IMMUNITY + +- subtype - spell id +- ainfo - 0 - normal, 1 - absolute + +### RECEPTIVE + +WoG ability. Creature accepts all friendly spells even though it would +be normally immune to it. + +# Spell effects + +### POISON + +- val - max health penalty from poison possible + +### SLAYER + +- value - spell level + +### BIND_EFFECT + +doesn't do anything particular, works as a marker + +### FORGETFULL + +forgetfulness spell effect + +- value - level + +### NOT_ACTIVE + +### ALWAYS_MINIMUM_DAMAGE + +unit does its minimum damage from range + +- subtype: -1 - any attack, 0 - melee, 1 - ranged +- value: additional damage penalty (it'll subtracted from dmg) +- additional info - multiplicative anti-bonus for dmg in % \[eg 20 + means that creature will inflict 80% of normal minimal dmg\] + +### ALWAYS_MAXIMUM_DAMAGE + +eg. bless effect + +- subtype: -1 - any attack, 0 - melee, 1 - ranged +- value: additional damage +- additional info - multiplicative bonus for dmg in % + +### ATTACKS_NEAREST_CREATURE + +while in berserk + +### IN_FRENZY + +- value - level + +### HYPNOTIZED + +### NO_RETALIATION + +Eg. when blinded or paralyzed. + +# Undocumented + +### LEVEL_COUNTER +for commander artifacts + +### BLOCK_MAGIC_ABOVE +blocks casting spells of the level > value + +### BLOCK_ALL_MAGIC +blocks casting spells + +### SPELL_IMMUNITY +subid - spell id + +### GENERAL_DAMAGE_PREMY + +### ADDITIONAL_UNITS +val of units with id = subtype will be added to hero's army at the beginning of battle + +### SPOILS_OF_WAR +val * 10^-6 * gained exp resources of subtype will be given to hero after battle + +### BLOCK + +### DISGUISED +subtype - spell level + +### VISIONS +subtype - spell level + +### SYNERGY_TARGET +dummy skill for alternative upgrades mod + +### BLOCK_MAGIC_BELOW +blocks casting spells of the level < value + +### SPECIAL_ADD_VALUE_ENCHANT +specialty spell like Aenin has, increased effect of spell, additionalInfo = value to add + +### SPECIAL_FIXED_VALUE_ENCHANT +specialty spell like Melody has, constant spell effect (i.e. 3 luck), additionalInfo = value to fix. + +### TOWN_MAGIC_WELL +one-time pseudo-bonus to implement Magic Well in the town diff --git a/docs/modders/Bonus/Bonus_Updaters.md b/docs/modders/Bonus/Bonus_Updaters.md new file mode 100644 index 000000000..3839d6653 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Updaters.md @@ -0,0 +1,89 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Updaters + +# List of Bonus Updaters + +Updaters come in two forms: simple and complex. Simple updaters take no +parameters and are specified as strings. Complex updaters do take +parameters (sometimes optional), and are specified as structs. + +Check the files in *config/heroes/* for additional usage examples. + +## GROWS_WITH_LEVEL + +- Type: Complex +- Parameters: valPer20, stepSize=1 +- Effect: Updates val to + +` ceil(valPer20 * floor(heroLevel / stepSize) / 20)` + +Example: The following updater will cause a bonus to grow by 6 for every +40 levels. At first level, rounding will cause the bonus to be 0. + +` "updater" : {` +` "parameters" : [ 6, 2 ],` +` "type" : "GROWS_WITH_LEVEL"` +` }` + +Example: The following updater will cause a bonus to grow by 3 for every +20 levels. At first level, rounding will cause the bonus to be 1. + +` "updater" : {` +` "parameters" : [ 3 ],` +` "type" : "GROWS_WITH_LEVEL"` +` }` + +Remarks: + +- The rounding rules are designed to match the attack/defense bonus + progression for heroes with creature specialties in HMM3. +- There is no point in specifying val for a bonus with a + GROWS_WITH_LEVEL updater. + +## TIMES_HERO_LEVEL + +- Type: Simple +- Effect: Updates val to + +` val * heroLevel` + +Usage: + +` "updater" : "TIMES_HERO_LEVEL"` + +Remark: This updater is redundant, in the sense that GROWS_WITH_LEVEL +can also express the desired scaling by setting valPer20 to 20\*val. It +has been added for convenience. + +## TIMES_STACK_LEVEL + +- Type: Simple +- Effect: Updates val to + +` val * stackLevel` + +Usage: + +` "updater" : "TIMES_STACK_LEVEL"` + +Remark: The stack level for war machines is 0. + +## ARMY_MOVEMENT + +- Type: Complex +- Parameters: basePerSpeed, dividePerSpeed, additionalMultiplier, + maxValue +- Effect: Updates val to val+= max((floor(basePerSpeed / + dividePerSpeed)\* additionalMultiplier), maxValue) +- Remark: this updater is designed for MOVEMENT bonus to match H3 army + movement rules (in the example - actual movement updater, which + produces values same as in default movement.txt). +- Example: + +` "updater" : {` +` "parameters" : [ 20, 3, 10, 700 ],` +` "type" : "ARMY_MOVEMENT"` +` }` + +## BONUS_OWNER_UPDATER + +TODO: document me \ No newline at end of file diff --git a/docs/modders/Bonus/Bonus_Value_Types.md b/docs/modders/Bonus/Bonus_Value_Types.md new file mode 100644 index 000000000..2bfda7d99 --- /dev/null +++ b/docs/modders/Bonus/Bonus_Value_Types.md @@ -0,0 +1,25 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / [Bonus Format](../Bonus_Format.md) / Bonus Value Types + +Total value of Bonus is calculated using the following: + +- For each bonus source type we calculate new source value (for all bonus value types except PERCENT_TO_SOURCE and PERCENT_TO_TARGET_TYPE) using the following: +` newVal = (val * (100 + PERCENT_TO_SOURCE) / 100))` + +- PERCENT_TO_TARGET_TYPE applies as PERCENT_TO_SOURCE to targetSourceType of bonus. + +- All bonus value types summarized and then used as subject of the following formula: + +` clamp(((BASE_NUMBER * (100 + PERCENT_TO_BASE) / 100) + ADDITIVE_VALUE) * (100 + PERCENT_TO_ALL) / 100), INDEPENDENT_MAX, INDEPENDENT_MIN)` + +Semantics of INDEPENDENT_MAX and INDEPENDENT_MIN are wrapped, and first means than bonus total value will be at least INDEPENDENT_MAX, and second means than bonus value will be at most INDEPENDENT_MIN. + +# List of all bonus value types + +- ADDITIVE_VALUE +- BASE_NUMBER +- PERCENT_TO_ALL +- PERCENT_TO_BASE +- INDEPENDENT_MAX +- INDEPENDENT_MIN +- PERCENT_TO_SOURCE +- PERCENT_TO_TARGET_TYPE \ No newline at end of file diff --git a/docs/modders/Bonus_Format.md b/docs/modders/Bonus_Format.md new file mode 100644 index 000000000..bd51188a7 --- /dev/null +++ b/docs/modders/Bonus_Format.md @@ -0,0 +1,99 @@ +< [Documentation](../Readme.md) / [Modding](Readme.md) / Bonus Format + +## Full format + +All parameters but type are optional. + +``` javascript +{ + "type": "BONUS_TYPE", + "subtype": 0, + "val" : 0, + "valueType": "VALUE_TYPE", + "addInfo" : 0, // or [1, 2, ...] + + "duration" : "BONUS_DURATION", //or ["BONUS_DURATION1", "BONUS_DURATION2", ...]" + "turns" : 0, + + "targetSourceType" : "SOURCE_TYPE", + "sourceType" : "SOURCE_TYPE", + "sourceID" : 0, + "effectRange" : "EFFECT_RANGE", + + "limiters" : [ + "PREDEFINED_LIMITER", optional_parameters (...), //whhich one is preferred? + {"type" : LIMITER_TYPE, "parameters" : [1,2,3]} + ], + + "propagator" : ["PROPAGATOR_TYPE", optional_parameters (...)], + "updater" : {Bonus Updater}, + "propagationUpdater" : {Bonus Updater, but works during propagation}, + "description" : "", + "stacking" : "" +} +``` + +## Supported bonus types + +- [Bonus Duration Types](Bonus/Bonus_Duration_Types.md) +- [Bonus Sources](Bonus/Bonus_Sources.md) +- [Bonus Limiters](Bonus/Bonus_Limiters.md) +- [Bonus Types](Bonus/Bonus_Types.md) +- [Bonus Propagators](Bonus/Bonus_Propagators.md) +- [Bonus Updaters](Bonus/Bonus_Updaters.md) +- [Bonus Range Types](Bonus/Bonus_Range_Types.md) +- [Bonus Value Types](Bonus/Bonus_Value_Types.md) + +## Subtype resolution + +All string identifiers of items can be used in "subtype" field. This allows cross-referencing between the mods and make config file more readable. + +### Available prefixes + +- creature. +- artifact. +- skill: +``` javascript + "pathfinding", "archery", "logistics", "scouting", "diplomacy", + "navigation", "leadership", "wisdom", "mysticism", "luck", + "ballistics", "eagleEye", "necromancy", "estates", "fireMagic", + "airMagic", "waterMagic", "earthMagic", "scholar", "tactics", + "artillery", "learning", "offence", "armorer", "intelligence", + "sorcery", "resistance", "firstAid" +``` + +- resource: +``` javascript + "wood", "mercury", "ore", "sulfur", "crystal", "gems", "gold", "mithril" +``` + +- hero. +- faction. +- spell. +- primarySkill +``` javascript + "attack", "defence", "spellpower", "knowledge" +``` + +- terrain: +``` javascript + "dirt", "sand", "grass", "snow", "swamp", "rough", "subterra", "lava", "water", "rock" +``` + +- spellSchool +```javascript +"any", "fire", "air", "water", "earth" +``` + +### Example + +``` javascript +"bonus" : +{ + "type" : "HATE", + "subtype" : "creature.enchanter", + "val" : 50 +} +``` + +This bonus makes creature do 50% more damage to Enchanters. \ No newline at end of file diff --git a/docs/modders/Building_Bonuses.md b/docs/modders/Building_Bonuses.md new file mode 100644 index 000000000..59804a915 --- /dev/null +++ b/docs/modders/Building_Bonuses.md @@ -0,0 +1,171 @@ +< [Documentation](../Readme.md) / [Modding](Readme.md) / Building Bonuses + +Work-in-progress page do describe all bonuses provided by town buildings +for future configuration. + +## unique buildings + +Hardcoded functionalities, selectable but not configurable. In future +should be moved to scripting. + +Includes: + +- mystic pond +- treasury +- god of fire +- castle gates +- cover of darkness +- portal of summoning +- escape tunnel + +Function of all of these objects can be enabled by this: + +``` javascript + "function" : "castleGates" +``` + +## trade-related + +Hardcoded functionality for now due to complexity of these objects. +Temporary can be handles as unique buildings. Includes: + +- resource - resource +- resource - player +- artifact - resource +- resource - artifact +- creature - resource +- resource - skills +- creature - skeleton + +## hero visitables + +Buildings that give one or another bonus to visiting hero. All should be +handled via configurable objects system. + +Includes: + +- gives mana points +- gives movement points +- give bonus to visitor +- permanent bonus to hero + +## generic functions + +Generic town-specific functions that can be implemented as part of +CBuilding class. + +### unlock guild level + +``` javascript + "guildLevels" : 1 +``` + +### unlock hero recruitment + +``` javascript + "allowsHeroPurchase" : true +``` + +### unlock ship purchase + +``` javascript + "allowsShipPurchase" : true +``` + +### unlock building purchase + +``` javascript + "allowsBuildingPurchase" : true +``` + +### unlocks creatures + +``` javascript + "dwelling" : { "level" : 1, "creature" : "archer" } +``` + +### creature growth bonus + +Turn into town bonus? What about creature-specific bonuses from hordes? + +### gives resources + +``` javascript + "provides" : { "gold" : 500 } +``` + +### gives guild spells + +``` javascript + "guildSpells" : [5, 0, 0, 0, 0] +``` + +### gives thieves guild + +``` javascript + "thievesGuildLevels" : 1 +``` + +### gives fortifications + +``` javascript + "fortificationLevels" : 1 +``` + +### gives war machine + +``` javascript + "warMachine" : "ballista" +``` + +## simple bonuses + +Bonuses that can be made part of CBuilding. Note that due to how bonus +system works this bonuses won't be stackable. + +TODO: how to handle stackable bonuses like Necromancy Amplifier? + +Includes: + +- bonus to defender +- bonus to alliance +- bonus to scouting range +- bonus to player + +``` javascript +"bonuses" : +{ + "moraleToDefenders" : + { + "type": "MORALE", + "val" : 1, + "propagator" : ["VISITED_TOWN_AND_VISITOR"] + }, + "luckToTeam" : + { + "type" : "LUCK", + "val" : 2, + "propagator" : [ "TEAM_PROPAGATOR" ] + } +``` + +## misc + +Some other properties of town building that does not fall under "bonus" +category. + +### unique building + +Possible issue - with removing of fixed ID's buildings in different town +may no longer share same ID. However Capitol must be unique across all +town. Should be fixed somehow. + +``` javascript + "onePerPlayer" : true +``` + +### chance to be built on start + +``` javascript + "prebuiltChance" : 75 +``` \ No newline at end of file diff --git a/docs/modders/Campaign_Format.md b/docs/modders/Campaign_Format.md new file mode 100644 index 000000000..32500d269 --- /dev/null +++ b/docs/modders/Campaign_Format.md @@ -0,0 +1,215 @@ +< [Documentation](../Readme.md) / [Modding](Readme.md) / Campaign Format + +# Introduction + +Starting from version 1.3, VCMI supports its own campaign format. +Campaigns have *.vcmp file format and it consists from campaign json and set of scenarios (can be both *.vmap and *.h3m) + +To start making campaign, create file named `00.json`. See also [Packing campaign](#packing-campaign) + +Basic structure of this file is here, each section is described in details below +```js +{ + "version" : 1, + +
+ + "scenarios" : [ + { + //scenario 1 + + }, + { + //scenario 2 + + } + ] +} +``` + +`"version"` defines version of campaign file. Larger versions should have more features and flexibility, but may not be supported by older VCMI engines. See [compatibility table](#compatibility-table) + +# Header properties + +In header are parameters describing campaign properties +```js + ... + "regions": {...}, + "name": "Campaign name", + "description": "Campaign description", + "allowDifficultySelection": true, +``` + +- `"regions"` contains information about background and regions. See section [campaign regions](#regions-description) for more information +- `"name"` is a human readable title of campaign +- `"description"` is a human readable description of campaign +- `"allowDifficultySelection"` is a boolean field (`true`/`false`) which allows or disallows to choose difficulty before scenario start + +# Scenario description + +Scenario description looks like follow: +```js +{ + "map": "maps/SomeMap", + "preconditions": [], + "color": 0, + "difficulty": 2, + "regionText": "", + "prolog": {}, + "epilog": {}, + "heroKeeps": [], + "keepCreatures": [], + "startOptions": "none", + "playerColor": 0, + "bonuses": [ ] +} +``` + +- `"map"` map name without extension but with relative path. Both *.h3m and *.vmap maps are supported. If you will pack scenarios inside campaign, numerical map name should be used, see details in [packing campaign](#packing-campaign) +- `"preconditions"` enumerate scenarios indexes which must be completed to unlock this scenario. For example, if you want to make sequential missions, you should specify `"preconditions": []` for first scenario, but for second scenario it should be `"preconditions": [0]` and for third `"preconditions": [0, 1]`. But you can allow non-linear conquering using this parameter +- `"color"` defines color id for the region. Possible values are `0: red, 1: blue, tan: 2, green: 3, orange: 4, purple: 5, teal: 6, pink: 7` +- `"difficulty"` sets initial difficulty for this scenario. If `"allowDifficultySelection"`is defined for campaign, difficulty may be changed by player. Possible values are `0: pawn, 1: knight, 2: rook, 3: queen, 4: king` +- `"regionText"` is a text which will be shown if player holds right button over region +- `"prolog"`/`"epilog"` optional, defines prolog/epilog for scenario. See [prolog/epilog](#prologepilog) section for more information +- `"heroKeeps"` defines what hero will carry to the next scenario. Can be specified one or several attributes from list `"experience", "primarySkills", "secondarySkills", "spells", "artifacts"` +- `"keepCreatures"` array of creature types which hero will carry to the next scenario. Game identifiers are used to specify creature type. +- `"startOptions"` defines what type of bonuses player may have. Possible values are `"none", "bonus", "crossover", "hero"` + - `none`: player starts scenario without bonuses. [Description](#none-start-option) + - `bonus`: player chooses one of the predefined bonuses. [Description](#bonus-start-option) + - `crossover`: player will start with hero from previous scenario. [Description](#crossover-start-option) + - `hero` : player will start scenario with specified hero. [Description](#hero-start-option) +- `"playerColor"` defines color id of flag which player will play for. Possible values are `0: red, 1: blue, tan: 2, green: 3, orange: 4, purple: 5, teal: 6, pink: 7` +- "bonuses" array of possible bonus objects, format depends on `"startOptions"` parameter + +## Prolog/Epilog + +Prolog and epilog properties are optional +```js +{ + "video": "NEUTRALA.smk", //video to show + "music": "musicFile.ogg", //music to play, should be located in music directory + "text": "some long text" //text to be shown +} +``` + +## Start options and bonuses + +### None start option + +If `startOptions` is `none`, `bonuses` field will be ignored + +### Bonus start option + +If `startOptions` is `bonus`, bonus format may vary depending on its type. + +```js +{ + "what": "", + + +}, +``` + +- `"what"` field defines bonus type. Possible values are: `spell, creature, building, artifact, scroll, primarySkill, secondarySkill, resource` + - `"spell"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"type"`: spell type, string, e.g. "firewall" + - `"creature"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"type"`: creature type, string, e.g. "pikeman" + - `"amount"`: amount of creatures + - `"building"` has following attributes (fields): + - `"type"`: building type (string), e.g. "citadel" or "dwellingLvl1" + - `"artifact"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"type"`: artifact type, string, e.g. "spellBook" + - `"scroll"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"type"`: spell type in the scroll, string, e.g. "firewall" + - `"primarySkill"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"attack"`: amount of attack gained + - `"defence"`: amount of defence gained + - `"spellpower"`: amount of spellpower gained + - `"knowledge"`: amount of knowledge gained + - `"secondarySkill"` has following attributes (fields): + - `"hero"`: hero who will get spell (see below) + - `"type"`: skill type, string, e.g. "logistics" + - `"amount"`: skill level, `1: beginner, 2: advanced, 3: expert` + - `"resource"` has following attributes (fields): + - `"type"`: resource type, one of `wood, ore, mercury, sulfur, crystal, gems, gold, common, rare`, where `common` is both wood and ore, `rare` means that bonus gives each rare resource + - `"amount"`: amount of resources +- `"hero"` can be specified as explicit hero name and as one of keywords: `strongest`, `generated` + +### Crossover start option + +If `startOptions` is `crossover`, heroes from specific scenario will be moved to this scenario. Bonus format is following + +```js +{ + "playerColor": 0, + "scenario": 0 +}, +``` +- `"playerColor"` from what player color heroes shall be taken. Possible values are `0: red, 1: blue, tan: 2, green: 3, orange: 4, purple: 5, teal: 6, pink: 7` +- `"scenario"` from which scenario heroes shall be taken. 0 means first scenario + +### Hero start option + +If `startOptions` is `hero`, hero can be chosen as a starting bonus. Bonus format is following +```js +{ + "playerColor": 0, + "hero": "random" +} +``` + +- `"playerColor"` from what player color heroes shall be taken. Possible values are `0: red, 1: blue, tan: 2, green: 3, orange: 4, purple: 5, teal: 6, pink: 7` +- `"hero"` can be specified as explicit hero name and as one of keywords: `random` + +## Regions description + +Predefined campaign regions are located in file `campaign_regions.json` + +```js +{ + "prefix": "G3", + "color_suffix_length": 1, + "desc": [ + { "infix": "A", "x": 289, "y": 376 }, + { "infix": "B", "x": 60, "y": 147 }, + { "infix": "C", "x": 131, "y": 202 } + ] +}, +``` + +- `"prefix"` used to identify all images related to campaign. In this example, background picture will be `G3_BG` +- `"inflix"` ised to identify all images related to region. In this example, it will be pictures starting from `G3A_..., G3B_..., G3C_..."` +- `"color_suffix_length"` identifies suffix length for region colourful frames. 1 is used for `R, B, N, G, O, V, T, P`, value 2 is used for `Re, Bl, Br, Gr, Or, Vi, Te, Pi` + +# Packing campaign + +After campaign scenarios and campaign description are ready, you should pack them into *.vcmp file. +This file is basically headless gz archive. + +Your campaign should be stored in some folder with json describing campaign information. +Place all your scenarios inside same folder and enumerate their filenames, e.g `01.vmap`, '02.vmap', etc. +``` +my-campaign/ +|-- 00.json +|-- 01.vmap +|-- 02.vmap +|-- 03.vmap +``` + +If you use unix system, execute this command to pack your campaign: +``` +gzip -c -n ./* >> my-campaign.vcmp +``` + +If you are using Windows system, try this https://gnuwin32.sourceforge.net/packages/gzip.htm + +# Compatibility table +| Version | Min VCMI | Max VCMI | Description | +|---------|----------|----------|-------------| +| 1 | 1.3 | | Initial release | \ No newline at end of file diff --git a/docs/modders/Configurable_Widgets.md b/docs/modders/Configurable_Widgets.md new file mode 100644 index 000000000..d13af3a64 --- /dev/null +++ b/docs/modders/Configurable_Widgets.md @@ -0,0 +1,835 @@ +< [Documentation](../Readme.md) / [Modding](Readme.md) / Configurable Widgets + +# Table of contents + +- [Introduction](#introduction) +- [Tutorial](#tutorial) +- [Documentation](#documentation) + - [Types](#types) + - [Configurable objects](#configurable-objects) + - [Basic widgets](#basic-widgets) + - [High-level widgets](#high-level-widgets) + - [Custom widgets](#custom-widgets) +- [For developers](#for-developers) + +# Introduction + +VCMI has capabilities to change some UI elements in your mods beyond only replacing one image with another. Not all UI elements are possible to modify currently, but development team is expanding them. + +Elements possible to modify are located in `config/widgets`. + +# Tutorial + +Let's take `extendedLobby` mod from `vcmi-extras` as an example for VCMI-1.4. [Example sources](https://github.com/vcmi-mods/vcmi-extras/tree/vcmi-1.4/Mods/extendedLobby). + +**You can take all assets from this tutorial from sources.** + +This submod offers extended options while player creates new game. +For random map tab it defines UI to select RMG template, select map size bigger than XL, configure teams and roads. +For options tab it introduces UI for chess timers. + +In this tutorial we will recreate options tab to support chess timers UI. + +## Creating mod structure + +To start making mod, create following folders structure; +``` +extendedLobby/ +|- content/ +| |- sprites/ +| |- config/ +| | |- widgets/ +|- mod.json +``` + +File `mod.json` is generic and could look like this: +```json +{ + "name" : "Configurable UI tutorial mod", + "description" : "See tutorial here https://github.com/vcmi/vcmi/wiki/Configurable-UI-widgets", + "version" : "0.1", + "modType" : "Interface", + "compatibility": + { + "min" : "1.4.0" + }, +} +``` + +After that you can copy `extendedLobby/ folder to `mods/` folder and your mod will immediately appear in launcher but it does nothing for now. + +## Making layout for timer + +Let's copy `config/widgets/optionsTab.json` file from VCMI folder to `content/config/widgets/` folder from our mod. +It defines UI for options tab as it designed in original game, we will keep everything related to player settings and will modify only timer area. + +**It's important, that when you are modifying `optionsTab.json`, game restart is not needed! When you updated file, it's enough to go back to main menu and then open lobby and options again. However, when you add new assets (images), you have to restart game to make possible find them.** + +It looks like on image below and has 3 elements: label with "Player Turn Duration", label with timer duration ("Unlimited" on picture) and slider to control timer. + +Снимок экрана 2023-08-30 в 14 53 49 + +So we need to modify turn duration label and add combo box with timer types + +Снимок экрана 2023-08-30 в 14 53 02 + +Open `optionsTab.json` and scroll it until you see comment `timer`. Three elements after this comment are related to timer. + +Let's find first element, which is label +```json +{ + "items" + [ + ... + // timer + { + "type": "label", + "font": "small", + "alignment": "center", + "color": "yellow", + "text": "core.genrltxt.521", + "position": {"x": 222, "y": 544} + }, + ... + ], + ... +} +``` + +And modify it a bit +```json +{ + "name": "labelTimer", //add name, only for convenience + "type": "label", + "font": "small", + "alignment": "center", + "color": "yellow", + "text": "vcmi.optionsTab.widgets.labelTimer", //replace text + "position": {"x": 104, "y": 542} //move to the left +}, +``` + +But we also need proper background image for this label. Add image widget BEFORE labelTimer widget: +```json +{ + "type": "picture", + "image": "RmgTTBk", + "position": {"x": 54, "y": 532} +}, +{ + "name": "labelTimer", //add name, only for convenience + ... +}, +``` +In order to make it work, add file `RmgTTBk.bmp` to `content/sprites/` + +Elements named `labelTurnDurationValue` and `sliderTurnDuration` we will keep without change - they are needed to configure classic timer. + +## Adding combo box + +Now, let's add combo box. + +Copy image `DrDoCoBk.bmp` to `content/sprites/`. Button objects use animated images to show different button states. +For normal, pressed, blocked and highlighted. Our combo box inherits this behavior, so let's convert image to animation. +In order to do it, we need to create file `DrDoCoBk.json` in same folder `content/sprites/` with following content: + +```json +{ + "sequences" : + [ + { + "group" : 0, + "frames" : + [ + "DrDoCoBk.bmp" + ] + } + ] +} +``` + +Thus we created file with animation, containing single frame which can be used for combo box. + +Let's add one more element after `//timer` comment: + +```json +... +//timer +{ + "name": "timerModeSwitch", //this is important to name it timerModeSwitch, because VCMI binds behavior to element called this way + "type": "comboBox", + "image": "DrDoCoBk", + "position": {"x": 158, "y": 532}, + "imageOrder": [0, 0, 0, 0], + "dropDown": {}, //here will be defined elements to be shown in drop down list +}, +``` + +`imageOrder` helps VCMI to understand, which frame from animation to use in normal, pressed, blocked and highlighted states. In our case they will be same and we use 0 frame from `DrDoCoBk` animation. + +We also want to have label on the top of this combo box showing which element is selected. You need to add `items` array, where additional elements can be specified, label in our case: + +```json +... +//timer +{ + "name": "timerModeSwitch", + "type": "comboBox", + "image": "DrDoCoBk", + "position": {"x": 158, "y": 532}, + "imageOrder": [0, 0, 0, 0], + "dropDown": {}, //here will be defined elements to be shown in drop down list + "items": + [ + { + "name": "timer", + "type": "label", + "font": "small", + "alignment": "left", + "color": "yellow", + "text": "vcmi.optionsTab.widgets.timerModeSwitch.classic" //default value for timer label + } + ] +}, +``` + +With that we already have desired layout with all elements shown by default, but we also need to add elements with timer modes into drop-down list: + +Снимок экрана 2023-08-30 в 15 34 47 + +First of all, add images to `content/sprites/` folder: `List2Bk.bmp` for drop-down background and `List10Sl.bmp` for element highlighting. + +Now specify items inside `dropDown` field + +```json +"dropDown": +{ + "items": + [ + { + "name": "background", + "type": "picture", + "image": "List2Bk", + "position": {"x": 0, "y": -52} //negative value because our drop-down shall open in the top direction + }, + + { + "name": "slider", //let's add slider if we have more elements in future + "type": "slider", + "position": {"x": 212, "y": -52}, + "size": 52, + "style": "blue", + "itemsVisible": 2, //we show only two elements + "itemsTotal": 0, + "selected": 0, + "orientation": "vertical", + "callback": "sliderMove" //callback predefined for drop-down menu to control which elements to show + }, + + //now list elements + { //classic timer + "type": "item", //this is special type for drop-down elements + "position": {"x": 0, "y": -52}, + "items": //each element may have several elements + [ + { + "type": "label", + "name": "labelName", + "font": "small", + "alignment": "left", + "color": "white", + "position": {"x": 4, "y": 0}, + "text": "vcmi.optionsTab.widgets.timerModeSwitch.classic" + }, + { + "type": "picture", + "name": "hoverImage", //"hoverImage" is a key word, helping VCMI to understand which element to show when cursor hovers element + "visible": false, //invisible by default + "image": "List10Sl" + } + ] + }, + + { //chess timer + "type": "item", + "position": {"x": 0, "y": -27}, + "items": + [ + { + "type": "label", + "name": "labelName", + "font": "small", + "alignment": "left", + "color": "white", + "position": {"x": 4, "y": 0}, + "text": "vcmi.optionsTab.widgets.timerModeSwitch.chess" + }, + { + "type": "picture", + "name": "hoverImage", + "visible": false, + "image": "List10Sl" + } + ] + }, + ] +}, +``` + +Now we can press drop-down menu and even select elements. + +## Switching timer modes + +After view part is done, let's make behavioural part. +Let's hide elements, related to classic timer when chess timer is selected and show them back if classic selected. + +To do that, find `"variables"` part inside `optionsTab.json` and add there `"timers"` array, containing 2 elements: +```json +"variables": +{ + "timers": + [ + { //variables used if first element is chosen + "text": "vcmi.optionsTab.widgets.timerModeSwitch.classic", + "showWidgets": ["labelTurnDurationValue", "sliderTurnDuration"], + "hideWidgets": [], + }, + + { //variables used if second element is chosen + "text": "vcmi.optionsTab.widgets.timerModeSwitch.chess", + "showWidgets": [], + "hideWidgets": ["labelTurnDurationValue", "sliderTurnDuration"], + }, + ], + "timerPresets" : + [ + ... + ] +} +``` + +Now we show and hide elements, but visually you still can some "artifacts": + +Снимок экрана 2023-08-30 в 15 51 22 + +It's because options tab background image we use has those elements drawn. Let's hide them with overlay image `timchebk.bmp`. +It should be drawn before all other timer elements: + +```json +... +// timer +{ + "name": "timerBackground", + "type": "picture", + "image": "timchebk", + "position": {"x": 0, "y": 530} +}, + +{ + "name": "timerModeSwitch", + ... + }, +... +``` + +This background must be visible for chess timer and hidden for classic timer. Just put its name `"timerBackground"` into `"hideWidgets"` and `"showWidgets"` for corresponding elements. + +It works and can switch elements, the only missing part is chess timer configuration. + +## Chess timer configuration + +We should add text input fields, to specify different timers. We will use background for them `timerField.bmp`, copy it to `content/sprites/` folder of your mod. + +There are 4 different timers: base, turn, battle and creature. Read about them here: https://github.com/vcmi/vcmi/issues/1364 +We can add editors for them into items list, their format will be following: +```json +{ + "name": "chessFieldBase", + "type": "textInput", + "background": "timerField", + "alignment": "center", + "text": "00:00", //default text + "rect": {"x": 54, "y": 557, "w": 84, "h": 25}, + "offset": {"x": 0, "y": 0}, + "callback": "parseAndSetTimer_base", //callback to specify base timer value from string + "help": "vcmi.optionsTab.widgets.chessFieldBase.help" +}, +``` + +Add three remaining elements for different timers by yourself. You can play with all settings, except callback. There are 4 predefined callbacks to setup timers: +- `parseAndSetTimer_base` +- `parseAndSetTimer_turn` +- `parseAndSetTimer_battle` +- `parseAndSetTimer_creature` + +And what we want to do is to hide/show those fields when classic/chess times is selected. Just add names of those elements into corresponding variables `"showWidgets"`, `"hideWidgets". + +We are done! You can find more information about configurable UI elements in documentation section. + +# Documentation + +## Types + +All fields have format `"key": value` +There are different basic types, which can be used as value. + +### Primitive types + +Read JSON documentation for primitive types description: https://www.json.org/json-en.html + +### Text + +Load predefined text which can be localised, examples: +`"vcmi.otherOptions.availableCreaturesAsDwellingLabel"` +`"core.genrltxt.738"` + +### Position + +Point with two coordinates, example: +`{ "x": 43, "y": -28 }` + +### Rect + +Rectangle ares, example: +`{ "x": 28, "y": 220, "w": 108, "h": 50 }` + +### Text alignment + +Defines text alignment, can be one of values: +`"center"`, `"left"`, `"right"` + +### Color + +Predefined colors: +`"yellow"`, `"white"`, `"gold"`, `"green"`, `"orange"`, `"bright-yellow"` + +To have custom color make an array of four elements in RGBA notation: +`[255, 128, 0, 255]` + +### Font + +Predefined fonts: +`"big"`, `"medium"`, `"small"`, `"tiny"`, `"calisto"` + +### Hint text + +Hint text is a pair of strings, one is usually shown in status bar when cursor hovers element, another hint while right button pressed. +Each of elements is a [Text](#text) + +``` +{ + "hover": "Text", + "help": "Text +} +``` + +If one string specified, it will be applied for both hover and help. + +`"text"` + +### Shortcut + +String value defines shortcut. Some examples of shortcuts: +`"globalAccept", "globalCancel", "globalReturn","globalFullscreen", "globalOptions", "globalBackspace", "globalMoveFocus"` + +Full list is TBD + +### [VCMI-1.4] Player color + +One of predefined values: +`"red"`, `"blue"`, `"tan"`, `"green"`, `"orange"`, `"purple"`, `"teal"`, `"pink"` + +## Configurable objects + +Configurable object has following structure: +```json +{ + "items": [], + "variables": {}, //optional + "customTypes": {}, //optional + "library": {} //optional +} +``` + +`items` - array of widgets to be created. Widgets are created in sequentially in same order as they described. + +`variables` - variables, which can be used by object. Meaningful variable names are predefined for each object + +`customTypes` - description of custom widgets, which can be used for this object, see [Custom widgets](#custom-widgets) + +`library` - same as above, but custom widgets are described in separate json, this parameter should contain path to library json is specified + +## Basic widgets + +### Label + +`"type": "label"` + +`"name": "string"` optional, object name + +`"font"`: [font](#font) + +`"alignment"`: [alignment](#text-alignment), + +`"color"`: [color](#color), + +`"text"`: [text](#text), + +`"position"`: [position](#position) + +### [VCMI-1.4] Multi-line label + +`"type": "multiLineLabel"` + +`"name": "string"` optional, object name + +`"font"`: [font](#font) + +`"alignment"`: [alignment](#text-alignment), + +`"color"`: [color](#color), + +`"text"`: [text](#text), + +`"position"`: [position](#position) + +`"rect"`: [rect](#rect) //text area + +`"adoptHeight": bool` //if true, text area height will be adopted automatically based on content + +### Label group + +`"type": "labelGroup"` + +`"name": "string"` optional, object name + +`"font"`: [font](#font) + +`"alignment"`: [alignment](#text-alignment), + +`"color"`: [color](#color), + +`"items": []` array of elements + +**Label group item** + +`"position"`: [position](#position) + +`"text"`: [text](#text), + +### Picture + +`"type": "picture"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename + +`"visible": bool`, optional + +`"playerColored", bool`, optional, if true will be colorised to current player + +### Image + +Use to show single frame from animation + +`"type": "image"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename, animation only (def, json) + +`"group": integer` optional, specify animation group + +`"frame": integer` optional, specify animation frame + +### Texture + +Filling area with texture + +`"type": "texture"` + +`"name": "string"` optional, object name + +`"image": string`, specify filename + +`"rect"`: [rect](#rect) + +### Animation + +`"type": "animation"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename, animation only (def, json) + +`"repeat": bool`, play only once or repeat animation + +`"group": integer` optional, specify animation group + +`"alpha": integer` optional, specify alpha opacity + +`"callback": string` optional, callback to be called after animation complete + +`"frames": []` optional, array of frame ranges to show + +**Frame range** + +`"start": integer`, first frame + +`"end": integer`, last frame + +### [VCMI-1.4] Text input + +`"type": "textInput"` + +`"name": "string"` optional, object name + +`"rect"`: [rect](#rect) + +`"backgroundOffset": [position](#position) + +`"background": string`, specify filename + +`"font"`: [font](#font) + +`"alignment"`: [alignment](#text-alignment), + +`"color"`: [color](#color), + +`"text": string` optional, default text. Translations are not supported + +`"position"`: [position](#position) + +`"help"`: [hint](#hint-text) + +`"callback": string` optional, callback to be called on text changed. Input text is passed to callback function as an argument. + +### Button + +`"type": "button"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename, animation only (def, json) + +`"help"`: [hint](#hint-text) + +`"imageOrder": []` array of 4 integers, each is responsible for frame to be shown in different states: normal, pressed, blocked and highlighted + +`"borderColor"`: [color](#color), optional + +`"hotkey"`: [shortcut](#shortcut), optional + +`"callback": string` optional, callback to be called on press. No arguments are passed to callback function. + +`"items": []` array of widgets to be shown as overlay (caption [label](#label), for example) + +### Toggle button + +`"type": "toggleButton"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename, animation only (def, json) + +`"help"`: [hint](#hint-text) + +`"imageOrder": []` array of 4 integers, each is responsible for frame to be shown in different states: normal, pressed, blocked and highlighted + +`"callback": string` optional, callback to be called on selection. Toggle identifier is passed to callback function as an argument. + +`"selected": bool`, optional, is selected by default + +`"items": []` array of widgets to be shown as overlay (caption [label](#label), for example) + +### Toggle group + +Group of [toggle buttons](#toggle-button), when one is selected, other will be de-selected + +`"type": "toggleGroup"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"callback": string` optional, callback to be called when one of toggles is selected + +`"items": []` array of [toggle buttons](#toggle-button) + +### Slider + +`"type": "slider"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"size": integer` size in pixels + +`"style": string`, can be `"brown"` or `"blue"` + +`"itemsVisible": integer`, how many items are visible + +`"itemsTotal": integer`, how many items in total + +`"selected": integer`, current state for slider + +`"orientation" string`, can be `"horizontal"` or `"vertical"` + +`"callback": string` callback to be called on state change. Slider position is passed to callback function as an argument. + +`"scrollBounds":` [rect](#rect), optional + +`"panningStep": integer`, optional + +### Combo box + +`"type": "comboBox"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"image": string`, specify filename, animation only (def, json) + +`"help"`: [hint](#hint-text) + +`"imageOrder": []` array of 4 integers, each is responsible for frame to be shown in different states: normal, pressed, blocked and highlighted + +`"borderColor"`: [color](#color), optional + +`"hotkey"`: [shortcut](#shortcut), optional + +`"items": []` array of widgets to be shown as overlay, for example, [label](#label) + +`"dropDown" : {}` description of [drop down](#drop-down) menu widget + +### Drop down + +Used only as special object for [combo box](#combo-box) + +`"items": []` array of widgets to be built. Usually contains background [picture](#picture), [slider](#slider) and item elements. + +**Item elements** + +`"type": "item"` + +`"name": "string"` optional, object name + +`"position"`: [position](#position) + +`"items": []` array of overlay widgets with certain types and names: + - `"name": "hoverImage"`, `"type": ` [picture](#picture) - image to be shown when cursor hovers elements + - `"name": "labelName"`, `"type": ` [label](#label) - element caption + +**Callbacks** + - `sliderMove` connect to slider callback to correctly navigate over elements + +### Layout + +`"type": "layout"` + +`"name": "string"` optional, object name + +## High-level widgets + +## Custom widgets + +# For developers + +While designing a new element, you can make it configurable to reuse all functionality described above. It will provide flexibility to further changes as well as modding capabilities. + +Class should inherit `InterfaceObjectConfigurable`. +```C++ +#include "gui/InterfaceObjectConfigurable.h" //assuming we are in client folder + +class MyYesNoDialog: public InterfaceObjectConfigurable +{ +} +``` + +`InterfaceObjectConfigurable` doesn't have default constructor, but has possibility to specify arguments to be passed to `CIntObject`. + +To make new object work, it's sufficient to define constructor, which receives const reference to `JsonNode`. + +```C++ +MyYesNoDialog::MyYesNoDialog(const JsonNode & config): + InterfaceObjectConfigurable(), //you can pass arguments same as for CIntObject +{ + //register custom builders + REGISTER_BUILDER("MyItem", &MyYesNoDialog::buildMyItem); + + //add callbacks which can be used by widgets + addCallback("okPressed", std::bind(&MyYesNoDialog::onOk, this, std::placeholders::_1)); + addCallback("cancelPressed", std::bind(&MyYesNoDialog::onCancel, this, std::placeholders::_1)); + + build(config); //after this point all widgets are built and accessible + + //access widgets by name + if(auto w = widget("cancel")) + { + //now you can do something with button + } +} +``` + +## Callbacks + +## Custom widgets + +You can build custom widgets, related to your UI element specifically. Like in example above, there is Item widget, which can be also used on JSON config. + +```C++ +REGISTER_BUILDER("myItem", &MyYesNoDialog::buildMyItem); +``` + +You have to define function, which takes JsonNode as an argument and return pointer to built widget + +```C++ +std::shared_ptr MyYesNoDialog::buildMyItem(const JsonNode & config) +{ + auto position = readPosition(config["position"]); + return std::make_shared(*this, position); //define Item object as you want +} +``` + +After that, if your JSON file has items with type "MyItem", the new Item element will be constructed. + +```json +{ + "items": + [ + { + "type": "myItem", + "position": {"x": 100, "y": 50} + } + ] +} +``` + +## Variables + +After calling `build(config)` variables defined in config JSON file become available. You can interpret them and use in callbacks or in element code + +```C++ +build(config); + +if(variables["colorfulText"].Bool()) +{ + if(auto w = widget("text")) + { + w->setColor(getMyPlayerColor()); //for reference only, getMyPlayerColor is not defined + } +} +``` diff --git a/docs/modders/Entities_Format/Artifact_Format.md b/docs/modders/Entities_Format/Artifact_Format.md new file mode 100644 index 000000000..bc7c72ad4 --- /dev/null +++ b/docs/modders/Entities_Format/Artifact_Format.md @@ -0,0 +1,83 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Artifact Format + +Artifact bonuses use [Bonus Format](../Bonus_Format.md) + +## Required data + +In order to make functional artifact you also need: + +- Icon for hero inventory (1 image) +- Icon for popup windows (1 image, optional) +- Animation for adventure map (1 animation) + +## Format + +``` jsonc +{ + // Type of this artifact - creature, hero or commander + "type": ["HERO", "CREATURE", "COMMANDER"] + + // TREASURE, MINOR, MAJOR, RELIC, SPECIAL + "class": "TREASURE", + + // Slot(s) to which this artifact can be put, if applicable + // SHOULDERS, NECK, RIGHT_HAND, LEFT_HAND, TORSO, RIGHT_RING, LEFT_RING, FEET, MISC1, MISC2, MISC3, MISC4, + // MACH1, MACH2, MACH3, MACH4, SPELLBOOK, MISC5 + // MISC, RING + "slot": "HEAD", + "slot": [ "LEFT_HAND", "RIGHT_HAND ], + + // Cost of this artifact, in gold + "value": 12000, + + "text": + { + // Name of the artifact + "name": "Big Sword", + + // Long description of this artifact + "description": "Big sword gived +10 attack to hero", + + // Text that visible on picking this artifact on map + "event": "On your travel, you stumble upon big sword. You dust it off and stick in your backpack" + }, + "graphics": + { + // Base image for this artifact, used for example in hero screen + "image": "BigSword.png", + + // Large image, used for drag-and-drop and popup messages + "large": "BigSword_large.png", + + //def file for adventure map + "map": "BigSword.def" + }, + + // Bonuses provided by this artifact using bonus system + "bonuses": + { + Bonus_1, + Bonus_2 + }, + + // Optional, list of components for combinational artifacts + "components": + [ + "artifact1", + "artifact2", + "artifact3" + ], + + // Creature id to use on battle field. If set, this artifact is war machine + "warMachine" : "some.creature" + + // If set to true, artifact won't spawn on a map without water + "onlyOnWaterMap" : false, + + // TODO: document + "growing" : { + "bonusesPerLevel" : {}, + "thresholdBonuses" : {}, + } +} +``` diff --git a/docs/modders/Entities_Format/Battle_Obstacle_Format.md b/docs/modders/Entities_Format/Battle_Obstacle_Format.md new file mode 100644 index 000000000..e0d64eeb4 --- /dev/null +++ b/docs/modders/Entities_Format/Battle_Obstacle_Format.md @@ -0,0 +1,3 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battle Obstacle Format + +TODO \ No newline at end of file diff --git a/docs/modders/Entities_Format/Battlefield_Format.md b/docs/modders/Entities_Format/Battlefield_Format.md new file mode 100644 index 000000000..bdbc098c5 --- /dev/null +++ b/docs/modders/Entities_Format/Battlefield_Format.md @@ -0,0 +1,3 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battlefield Format + +TODO \ No newline at end of file diff --git a/docs/modders/Entities_Format/Creature_Format.md b/docs/modders/Entities_Format/Creature_Format.md new file mode 100644 index 000000000..96d9ce1c1 --- /dev/null +++ b/docs/modders/Entities_Format/Creature_Format.md @@ -0,0 +1,210 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Creature Format + +## Required data + +In order to make functional creature you also need: + +### Animation + +- Battle animation (1 def file) +- Set of rendered projectiles (1 def files, shooters only) +- Adventure map animation (1 def file) + +### Images + +- Small portrait for hero exchange window (1 image) +- Large portrait for hero window (1 image) + +### Sounds + +- Set of sounds (up to 8 sounds) + +## Format + +``` javascript +// camelCase unique creature identifier +"creatureName" : +{ + // Translatable names for this creature + "name" : + { + "singular" : "Creature", + "plural" : "Creatures" + }, + "level" : 0, + + // Marks this object as special and not available by default + "special" : true, + + // Faction this creature belongs to. Examples: castle, rampart + "faction" : "", + + // Cost to recruit this creature, zero values can be omitted. + "cost" : + { + "wood" : 0, + "mercury" : 0, + "ore" : 0, + "sulfur" : 0, + "crystal" : 0, + "gems" : 0, + "gold" : 0 + }, + // "value" of creature, used to determine for example army strength + "fightValue" : 0, + + // Describes how valuable this creature is to AI. Usually similar to fightValue + "aiValue" : 0, + + // Basic growth of this creature in town or in external dwellings + "growth" : 0, + + // Bonus growth of this creature from built horde + "hordeGrowth" : 0, + + // Creature stats in battle + "attack" : 0, + "defense" : 0, + "hitPoints" : 0, + "speed" : 0, + "damage" : + { + "min" : 0, + "max" : 0 + }, + + // Number of shots this creature has, required only for ranged units + "shots" : 0, + + // Spell points this creature has (usually equal to number of casts) + "spellPoints" : 0, + + // Initial size of random stacks on adventure map + "advMapAmount" : + { + "min" : 0, + "max" : 0 + }, + + // List of creatures to which this one can be upgraded + "upgrades" : + [ + "anotherCreature" + ], + + // If set, creature will be two tiles wide on battlefield + "doubleWide" : false, + + // Creature abilities described using Bonus system + "abilities" : + [ + "someName1" : Bonus Format, + "someName2" : Bonus Format + ], + + // creature may receive "week of" events + "hasDoubleWeek": true, + + "graphics" : + { + // File with animation of this creature in battles + "animation" : "", + // File with animation of this creature on adventure map + "map" : "", + // Optional. Object mask that describes on which tiles object is visible/blocked/activatable + "mapMask" : [ "VV", "VA" ], + + // Small icon for this creature, used for example in exchange screen + "iconSmall" : "", + // Large icon for this creature, used for example in town screen + "iconLarge" : "", + + // animation parameters + + // how often creature should play idle animation + "timeBetweenFidgets" : 1.00, + + "animationTime" : + { + // movement animation time factor + "walk" : 1.00, + + // idle animation time. For H3 creatures this value is always 10 + "idle" : 10.00, + + // ranged attack animation time. Applicable to shooting and casting animation + // NOTE: does NOT affects melee attacks + // This is H3 behaviour, likely for proper synchronization of attack/defense animations + "attack" : 1.00, + }, + "missile" : + { + // name of file for missile + "animation" : "", + + // indicates that creature uses ray animation for ranged attacks instead of missile image (e.g. Evil Eye) + "ray" : + [ + { // definition of first (top-most) line in the ray + "start" : [ 160, 192, 0, 255 ], // color (RGBA components) of ray at starting point + "end" : [ 160, 192, 0, 64 ] // color (RGBA components) of ray at finishing point + }, + {}, // definition of second from top line in the ray, identical format + ... // definitions of remaining lines, till desired width of the ray + ], + // Frame at which shooter shoots his projectile (e.g. releases arrow) + "attackClimaxFrame" : 0, + + // Position where projectile image appears during shooting in specific direction + "offset" : + { + "upperX" : 0, + "upperY" : 0, + "middleX" : 0, + "middleY" : 0, + "lowerX" : 0, + "lowerY" : 0 + }, + // angles from which frames in .def file were rendered, -90...90 range + // Example below will work for file that contains following frames: + // 1) facing top, 2) facing top-right, 3)facing right, + // 4) facing bottom-right 5) facing bottom. + "frameAngles" : [ -90, -45, 0, 45, 90] + } + }, + + // names of sound files + "sound" : + { + // Creature attack enemy in melee (counter-)attack + "attack": "", + // Creature in "defend mode" is attacked + "defend": "", + // Creature killed + "killed": "", + // Plays in loop during creature movement + "move": "", + // Shooters only, creature shoots + "shoot" : "", + // Creature not in "defend mode" is under attack + "wince": "", + + // Creature start/end movement or teleports + "startMoving" : "", + "endMoving" : "" + }, + + // Stack experience, using bonus system + "stackExperience" : [ + { + // Bonus description + "bonus" : { BONUS_FORMAT }, + // Per-level value of bonus. Must have 10 elements + "values" : [ + 0, 0, 1, 1, 2, 2, 3, 3, 4, 4 + ] + }, + ... + ] +} +``` \ No newline at end of file diff --git a/docs/modders/Entities_Format/Faction_Format.md b/docs/modders/Entities_Format/Faction_Format.md new file mode 100644 index 000000000..d4d31d77e --- /dev/null +++ b/docs/modders/Entities_Format/Faction_Format.md @@ -0,0 +1,433 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Faction Format + +## Required data + +In order to make functional town you also need: + +### Images + +- Creature backgrounds images, 120x100 and 130x100 versions (2 images) +- Set of puzzle map pieces (48 images) +- Background scenery (1 image) +- Mage guild window view (1 image) +- Town hall background (1 image) + +- Set of town icons, consists from all possible combinations of: (8 + images total) + - small and big icons + - village and fort icons + - built and normal icons + +- Set for castle siege screen, consists from: + - Background (1 image) + - Destructible towers (3 parts, 3 images each) + - Destructible walls (4 parts, 3 images each) + - Static walls (3 images) + - Town gates (5 images) + - Moat (2 images) + +### Animation + +- Adventure map images for village, town and capitol (3 def files) + +### Music + +- Town theme music track (1 music file) + +### Buildings + +Each town requires a set of buildings (Around 30-45 buildings) + +- Town animation file (1 animation file) +- Selection highlight (1 image) +- Selection area (1 image) +- Town hall icon (1 image) + +## Faction node (root entry for town configuration) + +```jsonc +// Unique faction identifier. +"myFaction" : +{ + // Main part of town description, see below + // Optional but it should be present for playable faction + "town" : { ... }, + + // Native terrain for creatures. Creatures fighting on native terrain receive several bonuses + "nativeTerrain" : "grass", + + // Localizable faction name, e.g. "Rampart" + "name" : "", + + // Faction alignment. Can be good, neutral (default) or evil. + "alignment" : "", + + // Backgrounds for creature screen, two versions: 120px-height and 130-px height + "creatureBackground" + { + // Paths to background images + "120px" : "", + "130px" : "" + }, + + // Identifier of boat type that is produced by shipyard and used by heroes in water taverns or prisons + "boat" : "boatFortress", + + // Random map generator places player/cpu-owned towns underground if true is specified and on the ground otherwise. Parameter is unused for maps without underground. + "preferUndergroundPlacement" : false + + // Town puzzle map + "puzzleMap" : + { + // Prefix for image names, e.g. "PUZCAS" for name "PUZCAS12.png" + "prefix" : "", + // List of map pieces. First image will have name 00, second - 01 and so on + "pieces" : + [ + { + // Position of image on screen + "x" : 0 + "y" : 0 + + //indicates order in which this image will be opened + "index" : 0 + }, + ... + ] + ] +} +``` + +## Town node + +```jsonc +{ + // Field that describes behavior of map object part of town. Town-specific part of object format + "mapObject" : + { + // Optional, controls what template will be used to display this object. + // Whenever player builds a building in town game will test all applicable templates using + // tests with matching name and on success - set such template as active. + // There are 3 predefined filters: "village", "fort" and "capitol" that emulate H3 behavior + "filter" : { + "capitol" : [ "anyOf", [ "capitol" ], [ "castle" ] ] + }, + + // List of templates that represent this object. For towns only animation is required + // See object template description for other fields that can be used. + "templates" : { + "village" : { "animation" : "" }, + "castle" : { "animation" : "" }, + "capitol" : { "animation" : "" } + } + }, + + //icons, small and big. Built versions indicate constructed during this turn building. + "icons" : + { + "village" : { + "normal" : { + "small" : "modname/icons/hall-small.bmp", + "large" : "modname/icons/hall-big.bmp" + }, + "built" : { + "small" : "modname/icons/hall-builded-small.bmp", + "large" : "modname/icons/hall-builded-big.bmp" + } + }, + "fort" : { + "normal" : { + "small" : "modname/icons/fort-small.bmp", + "large" : "modname/icons/fort-big.bmp" + }, + "built" : { + "small" : "modname/icons/fort-builded-small.bmp", + "large" : "modname/icons/fort-builded-big.bmp" + } + } + }, + // Path to town music theme, e.g. "music/castleTheme" + "musicTheme" : "", + + // List of structures which represents visible graphical objects on town screen. + // See detailed description below + "structures" : + { + "building1" : { ... }, + ... + "building9" : { ... } + }, + + // List of names for towns on adventure map e.g. "Dunwall", "Whitestone" + // Does not have any size limitations + "names" : [ "", ""], + + // Background scenery for town screen, size must be 800x374 + "townBackground": "", + + // Small scenery for window in mage guild screen + "guildWindow": "", + + // Background image for window in mage guild screen + "guildBackground" : "", + + // Video for tavern window + "tavernVideo" : "", + + // Path to building icons for town hall + "buildingsIcons": "HALLCSTL.DEF", + + // Background image for town hall window + "hallBackground": "", + + // List of buildings available in each slot of town hall window + // Note that size of gui is limited to 5 rows and 4 columns + "hallSlots": + [ + [ [ "buildingID1" ], [ "buildingID2", "buildingID3" ] ], + ... + ], + // List of creatures available on each tier. Number of creatures on each tier + // is not hardcoded but it should match with number of dwelling for each level. + // For example structure below would need buildings with these id's: + // first tier: 30 and 37, second tier: 31, third tier: 32, 39, 46 + "creatures" : + [ + ["centaur", "captainCentaur"], + ["dwarf"], + ["elf", "grandElf", "sharpshooter"], + ... + ], + + // Buildings, objects in town that affect mechanics. See detailed description below + "buildings" : + { + "building1" : { ... }, + ... + "building9" : { ... } + }, + // Description of siege screen, see below + "siege" : { ... }, + + // Chance for a hero class to appear in this town, creates pair with same field in class format + // Used for situations where chance was not set in "tavern" field, chance will be determined as: + // square root( town tavern chance * hero class tavern chance ) + "defaultTavern" : 5, + + // Chance of specific hero class to appear in this town + // Mirrored version of field "tavern" from hero class format + "tavern" : + { + "knight" : 5, + "druid" : 6 + }, + + // Chance of specific spell to appear in mages guild of this town + // If spell is missing or set to 0 it will not appear unless set as "always present" in editor + // Spells from unavailable levels are not required to be in this list + "guildSpells" : + { + "magicArrow" : 30, + "bless" : 10 + }, + + // Which tiers in this town have creature hordes. Set to -1 to disable horde(s) + "horde" : [ 2, -1 ], + + // Resource given by starting bonus. If not set silo will produce wood + ore + "primaryResource" : "gems", + + // maximum level of mage guild + "mageGuild" : 4, + + // war machine produced in town + "warMachine" : "ballista" + + // Identifier of spell that will create effects for town moat during siege + "moatAbility" : "castleMoat" +} +``` + +## Siege node + +```jsonc +// Describes town siege screen +// Comments in the end of each graphic position indicate specify required suffix for image +// Note: one not included image is battlefield background with suffix "BACK" +{ + // shooter creature name + "shooter" : "archer", + + // Large icon of towers, for use in battle queue + "towerIconLarge" : "", + + // (Small icon of towers, for use in battle queue + "towerIconSmall" : "", + + // Prefix for all siege images. Final name will be composed as + "imagePrefix" : "SGCS", + + // Descriptions for towers. Each tower consist from 3 parts: + // tower itself - two images with untouched and destroyed towers + // battlement or creature cover - section displayed on top of creature + // creature using type from "shooter" field above + "towers": + { + // Top tower description + "top" : + { + "tower" : { "x": 0, "y": 0}, // "TW21" ... "TW22" + "battlement" : { "x": 0, "y": 0}, // "TW2C" + "creature" : { "x": 0, "y": 0} + }, + // Central keep description + "keep" : + { + "tower" : { "x": 0, "y": 0}, // "MAN1" ... "MAN2" + "battlement" : { "x": 0, "y": 0}, // "MANC" + "creature" : { "x": 0, "y": 0} + }, + // Bottom tower description + "bottom" : + { + "tower" : { "x": 0, "y": 0}, // "TW11" ... "TW12" + "battlement" : { "x": 0, "y": 0}, // "TW1C" + "creature" : { "x": 0, "y": 0} + }, + }, + // Two parts of gate: gate itself and arch above it + "gate" : + { + "gate" : { "x": 0, "y": 0}, // "DRW1" ... "DRW3" and "DRWC" (rope) + "arch" : { "x": 0, "y": 0} // "ARCH" + }, + // Destructible walls. In this example they are ordered from top to bottom + // Each of them consist from 3 files: undestroyed, damaged, destroyed + "walls" : + { + "upper" : { "x": 0, "y": 0}, // "WA61" ... "WA63" + "upperMid" : { "x": 0, "y": 0}, // "WA41" ... "WA43" + "bottomMid" : { "x": 0, "y": 0}, // "WA31" ... "WA33" + "bottom" : { "x": 0, "y": 0} // "WA11" ... "WA13" + }, + + // Two pieces for moat: moat itself and moat bank + "moat" : + { + "bank" : { "x" : 0, "y" : 0 }, // "MOAT" + "moat" : { "x" : 0, "y" : 0 } // "MLIP" + }, + + // Static non-destructible walls. All of them have only one piece + "static" : + { + // Section between two bottom destructible walls + "bottom" : { "x": 0, "y": 0}, // "WA2" + + // Section between two top destructible walls + "top" : { "x": 0, "y": 0}, // "WA5" + + // Topmost wall located behind hero + "background" : { "x": 0, "y": 0} // "TPWL" + } +} +``` + +## Building node + +```jsonc +{ + // Numeric identifier of this building + "id" : 0, + + // Localizable name of this building + "name" : "", + + // Localizable decsription of this building + "description" : "", + + // Optional, indicates that this building upgrades another base building + "upgrades" : "baseBuilding", + + // List of town buildings that must be built before this one. See below for full format + "requires" : [ "allOf", [ "mageGuild1" ], [ "tavern" ] ], + + // Resources needed to build building + "cost" : { ... }, + + // TODO: Document me: Subtype for some special buildings + "type" : "", + + // TODO: Document me: Height for lookout towers and some grails + "height" : "average" + + // Resources produced each day by this building + "produce" : { ... }, + + //determine how this building can be built. Possible values are: + // normal - default value. Fulfill requirements, use resources, spend one day + // auto - building appears when all requirements are built + // special - building can not be built manually + // grail - building reqires grail to be built + "mode" : "auto", + + // Buildings which bonuses should be overridden with bonuses of the current building + "overrides" : [ "anotherBuilding ] + + // Bonuses, provided by this special building on build using bonus system + "bonuses" : BONUS_FORMAT + + // Bonuses, provided by this special building on hero visit and applied to the visiting hero + "onVisitBonuses" : BONUS_FORMAT +} +``` + +Building requirements can be described using logical expressions: + +```jsonc +"requires" : +[ + "allOf", // Normal H3 "build all" mode + [ "mageGuild1" ], + [ + "noneOf", // available only when none of these building are built + [ "dwelling5A" ], + [ "dwelling5AUpgrade" ] + ], + [ + "anyOf", // any non-zero number of these buildings must be built + [ "tavern" ], + [ "blacksmith" ] + ] +] +``` + +## Structure node + +```jsonc +{ + // Main animation file for this building + "animation" : "", + + // Horizontal position on town screen + "x" : 0, + + // Vertical position on town screen + "y" : 0, + + // used for blit order. Higher value places structure close to screen and drawn on top of buildings with lower values + "z" : 0, + + // Path to image with golden border around building, displayed when building is selected + "border" : "", + + // Path to image with area that indicate when building is selected + "area" : "", + + //TODO: describe me + "builds": "", + + // If upgrade, this building will replace parent animation but will not alter its behaviour + "hidden" : false +} +``` \ No newline at end of file diff --git a/docs/modders/Entities_Format/Hero_Class_Format.md b/docs/modders/Entities_Format/Hero_Class_Format.md new file mode 100644 index 000000000..4601cb423 --- /dev/null +++ b/docs/modders/Entities_Format/Hero_Class_Format.md @@ -0,0 +1,109 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Hero Class Format + +## Required data + +In order to make functional hero class you also need: + +- Adventure animation (1 def file) +- Battle animation, male and female version (2 def files) + +## Format + +``` javascript +// Unique identifier of hero class, camelCase +"myClassName" : +{ + // Various hero animations + "animation" + { + "battle" : + { + // Battle animation for female heroes + "female" : "myMod/battle/heroFemale", + + // Battle animation for male heroes, can be same as female + "male" : "myMod/battle/heroMale" + } + }, + + // Description of map object representing this hero class. See map template format for details + "mapObject" : { + // Optional, hero ID-base filter, using same rules as building requirements + "filters" : { + "mutare" : [ "anyOf", [ "mutare" ], [ "mutareDrake" ]] + }, + + // List of templates used for this object, normally - only one is needed + "templates" : { + "normal" : { "animation" : "AH00_.def" } + } + }, + + // Translatable name of hero class + "name" : "My hero class", + + // Identifier of faction this class belongs to + "faction" : "myFaction", + + // Identifier of creature that should be used as commander for this hero class + // Can be a regular creature that has shooting animation + "commander" : "mage", + + // Affinity of this class, might or magic + "affinity" : "might", + + // Initial primary skills of heroes + "primarySkills" : + { + "attack" : 2, + "defence" : 0, + "spellpower" : 1, + "knowledge" : 2 + }, + + // Chance to get specific primary skill on level-up, applicable for levels less than 10 + "lowLevelChance" : + { + "attack" : 15, + "defence" : 10, + "spellpower" : 50, + "knowledge" : 25 + }, + + // Chance to get specific primary skill on level-up, applicable for levels starting from 10 + "highLevelChance" : + { + "attack" : 25, + "defence" : 5, + "spellpower" : 45, + "knowledge" : 25 + }, + + // Chance to get specific secondary skill on level-up + // All missing skills are considered to be banned, including universities + "secondarySkills" : + { + "pathfinding" : 3. + "archery" : 6. + ... + "resistance" : 5, + "firstAid" : 4 + }, + + // Chance for a this hero class to appear in a town, creates pair with same field in town format + // Used for situations where chance was not set in "tavern" field, chance will be determined as: + // square root( town tavern chance * hero class tavern chance ) + "defaultTavern" : 5, + + // Chance for this hero to appear in tavern of this factions. + // Reversed version of field "tavern" from town format + // If faction-class pair is not listed in any of them + // chance set to 0 and the class won't appear in tavern of this town + "tavern" : + { + "castle" : 4, + ... + "conflux" : 6 + } +} +``` \ No newline at end of file diff --git a/docs/modders/Entities_Format/Hero_Type_Format.md b/docs/modders/Entities_Format/Hero_Type_Format.md new file mode 100644 index 000000000..def2a12cb --- /dev/null +++ b/docs/modders/Entities_Format/Hero_Type_Format.md @@ -0,0 +1,133 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Hero Type Format + +## Required data + +In order to make functional hero you also need: + +- Portraits, small and big versions (2 images) +- Specialty icons, small and big versions (2 images) + +## Format + +``` javascript +"myHeroName" : +{ + // Identifier of class this hero belongs to. Such as knight or battleMage + "class" : "wizard", + + // List of starting spells, if available. This entry (even empty) will also grant spellbook + "spellbook" : + [ + "magicArrow" + ], + + // Set to true if the hero is female by default (can be changed in map editor) + "female" : true, + + // If set to true hero will be unavailable on start and won't appear in taverns (campaign heroes) + "special" : true, + + // If set to true, hero won't show up on a map with water + "onlyOnWaterMap" : false, + + // If set to true, hero will show up only if the map contains no water + "onlyOnMapWithoutWater" : false, + + // All translatable texts related to hero + "texts" : + { + "name" : "My Hero", + "biography" : "This is a long story...", + + "specialty" : + { + // Description visible when hovering over specialty icon + "description" : "Spell mastery: Magic Arrow", + + // Tooltip visible on clicking icon. Can use {} symbols to change title to yellow + // as well as escape sequences "\n" to add line breaks + "tooltip" : "{Magic Arrow}\n\nCasts powerfull magic arrows", + + // Name of your specialty + "name" : "Magic Arrow" + } + }, + + // Graphics used by hero + "images" : + { + // Small 32px speciality icon + "specialtySmall" : "myMod/myHero/specSmall.png", + + // Large 44px speciality icon + "specialtyLarge" : "myMod/myHero/specLarge.png", + + // Large 58x64px portrait + "large" : "myMod/myHero/large.png", + + // Small 48x32px portrait + "small" : "myMod/myHero/small.png" + }, + + // Custom animation to be used on battle, overrides hero class property + "battleImage" : "heroInBattle.def" + + // Initial hero army when recruited in tavern + // Must have 1-3 elements + "army" : + [ + // First always available stack + { + // Identifier of creature in this stack + "creature" : "mage", + + // Minimal and maximum size of stack. Size will be + // determined randomly at the start of the game + "max" : 2, + "min" : 1 + }, + // Second stack has 90 % chance to appear + { + "creature" : "archmage", + "max" : 1, + "min" : 1 + }, + // Third stack with just 20 % chance to appear + { + "creature" : "mage", + "max" : 2, + "min" : 1 + } + ], + + // List of skills initially known by hero + // Not limited by size - you can add as many skills as you wish + "skills" : + [ + { + // Skill level, basic, advanced or expert + "level" : "basic", + + // Skill identifier, camelCase version of name + "skill" : "wisdom" + }, + { + "level" : "basic", + "skill" : "waterMagic" + } + ], + + // Description of specialty mechanics using bonuses (with updaters) + "specialty" : { + // to be merged with all bonuses, use for specialties with multiple similar bonuses (optional) + "base" : {common bonus properties}, + "bonuses" : { + // use updaters for bonuses that grow with level + "someBonus" : {Bonus Format}, + "anotherOne" : {Bonus Format} + }, + // adds creature specialty following the HMM3 default formula + "creature" : "griffin" + } +} +``` \ No newline at end of file diff --git a/docs/modders/Entities_Format/River_Format.md b/docs/modders/Entities_Format/River_Format.md new file mode 100644 index 000000000..8b157aa90 --- /dev/null +++ b/docs/modders/Entities_Format/River_Format.md @@ -0,0 +1,3 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / River Format + +TODO \ No newline at end of file diff --git a/docs/modders/Entities_Format/Road_Format.md b/docs/modders/Entities_Format/Road_Format.md new file mode 100644 index 000000000..a15c0af36 --- /dev/null +++ b/docs/modders/Entities_Format/Road_Format.md @@ -0,0 +1,3 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Road Format + +TODO \ No newline at end of file diff --git a/docs/modders/Entities_Format/Secondary_Skill_Format.md b/docs/modders/Entities_Format/Secondary_Skill_Format.md new file mode 100644 index 000000000..ae4a8ff39 --- /dev/null +++ b/docs/modders/Entities_Format/Secondary_Skill_Format.md @@ -0,0 +1,117 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Secondary Skill Format + +## Main format + +```jsonc +{ + "skillName": + { + //Mandatory, localizable skill name + "name": "Localizable name", + + // Optional base format, will be merged with basic/advanced/expert + "base": {Skill level base format}, + + // Configuration for different skill levels + "basic": {Skill level format}, + "advanced": {Skill level format}, + "expert": {Skill level format}, + + // Chance for the skill to be offered on level-up (heroClass may override) + "gainChance" : { + // Chance for hero classes with might affinity + "might" : 4, + // Chance for hero classes with magic affinity + "magic" : 6, + // Chance for specific classes + "knight" : 2, + "cleric" : 8, + ... + }, + + // This skill is major obligatory (like H3 Wisdom) and is guaranteed to be offered once per specific number of levels + "obligatoryMajor" : false, + + // This skill is minor obligatory (like H3 Magic school) and is guaranteed to be offered once per specific number of levels + "obligatoryMinor" : false, + } +} +``` + +## Skill level base format + +Json object with data common for all levels can be put here. These +configuration parameters will be default for all levels. All mandatory +level fields become optional if they equal "base" configuration. + +## Skill level format + +```jsonc +{ + // Localizable description + // Use {xxx} for formatting + "description": "", + + // Bonuses provided by skill at given level + // If different levels provide same bonus with different val, only the highest applies + "effects": + { + "firstEffect": {bonus format}, + "secondEffect": {bonus format} + //... + }, + + // Skill icons of varying size + "images" : { + // 32x32 skill icon + "small" : "", + // 44x44 skill icon + "medium" : "", + // 82x93 skill icon + "large" : "", + } +} +``` + +## Example + +The following modifies the tactics skill to grant an additional speed +boost at advanced and expert levels. + +```jsonc +"core:tactics" : { + "base" : { + "effects" : { + "main" : { + "subtype" : "skill.tactics", + "type" : "SECONDARY_SKILL_PREMY", + "valueType" : "BASE_NUMBER" + }, + "xtra" : { + "type" : "STACKS_SPEED", + "valueType" : "BASE_NUMBER" + } + } + }, + "basic" : { + "effects" : { + "main" : { "val" : 3 }, + "xtra" : { "val" : 0 } + } + }, + "advanced" : { + "description" : "{Advanced Tactics}\n\nAllows you to rearrange troups within 5 hex rows, and increases their speed by 1.", + "effects" : { + "main" : { "val" : 5 }, + "xtra" : { "val" : 1 } + } + }, + "expert" : { + "description" : "{Expert Tactics}\n\nAllows you to rearrange troups within 7 hex rows, and increases their speed by 2.", + "effects" : { + "main" : { "val" : 7 }, + "xtra" : { "val" : 2 } + } + } +} +``` \ No newline at end of file diff --git a/docs/modders/Entities_Format/Spell_Format.md b/docs/modders/Entities_Format/Spell_Format.md new file mode 100644 index 000000000..3bd3882e3 --- /dev/null +++ b/docs/modders/Entities_Format/Spell_Format.md @@ -0,0 +1,383 @@ +< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Spell Format + +# Main format + +``` javascript +{ + "spellName": + { //numeric id of spell required only for original spells, prohibited for new spells + "index": 0, + //Original Heroes 3 info + //Mandatory, spell type + "type": "adventure",//"adventure", "combat", "ability" + + //Mandatory, spell target type + "targetType":"NO_TARGET",//"CREATURE","OBSTACLE"."LOCATION" + + //Mandatory + "name": "Localizable name", + //Mandatory, flags structure of school names, Spell schools this spell belongs to + "school": {"air":true, "earth":true, "fire":true, "water":true}, + //number, mandatory, Spell level, value in range 1-5 + "level": 1, + //Mandatory, base power + "power": 10, + //Mandatory, default chance for this spell to appear in Mage Guilds + //Used only if chance for a faction is not set in gainChance field + "defaultGainChance": 0, + //Optional, chance for it to appear in Mage Guild of a specific faction + //NOTE: this field is linker with faction configuration + "gainChance": + { + "factionName": 3 + }, + //VCMI info + + "animation":{}, + + //countering spells, flags structure of spell ids (spell. prefix is required) + "counters": {"spell.spellID1":true, ...} + + //Mandatory,flags structure: + // indifferent, negative, positive - Positiveness of spell for target (required) + // damage - spell does damage (direct or indirect) + // offensive - direct damage (implicitly sets damage and negative) + // rising - rising spell (implicitly sets positive) + // summoning //todo: + // special - can be obtained only with bonus::SPELL + + "flags" : {"flag1": true, "flag2": true}, + + //DEPRECATED | optional| no default | flags structure of bonus names,any one of these bonus grants immunity. Negatable by the Orb. + "immunity": {"BONUS_NAME":true, ...}, + + //DEPRECATED | optional| no default | flags structure of bonus names + //any one of these bonus grants immunity, cant be negated + "absoluteImmunity": {"BONUS_NAME": true, ...}, + + //DEPRECATED | optional| no default | flags structure of bonus names, presence of all bonuses required to be affected by. Negatable by the Orb. + "limit": {"BONUS_NAME": true, ...}, + + //DEPRECATED | optional| no default | flags structure of bonus names, presence of all bonuses required to be affected by. Cant be negated + "absoluteLimit": {"BONUS_NAME": true, ...}, + + //[WIP] optional | default no limit no immunity + // + "targetCondition" { + //at least one required to be affected + "anyOf" : { + //generic format + "mod:metaClassName.typeName":"absolute",//"normal", null or empty ignored - use for overrides + }, + //all required to be affected (like [absolute]limit) + "allOf" : { + //bonus type format + "bonus.BONUS_TYPE":"absolute"//"normal" Short bonus type format + "modId:bonus.bonusTypeName":"absolute"//"normal" Future bonus format for configurable bonuses + }, + //at least one grants immunity (like [absolute]immunity) + "noneOf": { + //some more examples + "core:creature.imp":"absolute", //[to be in initial version] this creature explicitly absolutely immune + "core:bonus.MIND_IMMUITY":"normal", // [to be in initial version] new format of existing mind spell immunity + "core:artifact.armorOfWonder":"absolute", //[possible future extension] this artifact on target itself (!) explicitly grant absolute immune + "core:luck":["absolute", 3], // [possible future extension] lack value of at least 3 grant absolute immunity from this horrible spell + "core:custom":[