vcmi / vcmi

Open-source engine for Heroes of Might and Magic III

VCMI Project

VCMI is an open-source recreation of Heroes of Might & Magic III engine, 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
• GPT Store: https://chat.openai.com/g/g-1kNhX0mlO-vcmi-assistant

Latest release

Latest release can be found in Github Releases page. As of right now we plan to have major releases around 3 times per year. Daily builds are still available at builds.vcmi.download 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
• macOS
• Linux
• Android
• iOS

Documentation and guidelines for players

• Frequently asked questions (external link)
• Game mechanics
• Bug reporting guidelines
• Cheat codes
• Privacy Policy

Documentation and guidelines for game modders

• Modding Guidelines
• Mod File Format
• Bonus Format
• Translations
• Map Editor
• Campaign Format
• Configurable Widgets

Documentation and guidelines for developers

Development environment setup instructions:

• Building VCMI for Android
• Building VCMI for iOS
• Building VCMI for Linux
• Building VCMI for macOS
• Building VCMI for Windows
• Conan

Engine documentation: (NOTE: may be outdated)

• Development with Qt Creator
• Coding Guidelines
• Bonus System
• Code Structure
• Logging API
• Lua Scripting System
• Serialization

Documentation and guidelines for maintainers

• Project Infrastructure
• Release Process
• Ubuntu PPA

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-2024 VCMI Team (check AUTHORS file for the contributors list)

vcmi's Issues

Dimension Door spell can't be cancelled with Esc

the only way to cancel seems RMB click

Water has missing ambient sound.

In vanilla H3, when hero stand next to seashore, we can hear ambient sound with waves. This sound is missing in VCMI. But can be easily fixed.
Part od terrains.json should be:

"water" :
	{
		"moveCost" : 100,
		"minimapUnblocked" : [ 8, 81, 148 ],
		"minimapBlocked"   : [ 8, 81, 148 ],
		"music" : "Water.mp3",
		"tiles" : "WATRTL",
		"type" : "WATER",
		"code" : "wt",
		"battleFields" : ["ship"],
		"transitionRequired" : true,
		"terrainViewPatterns" : "water",
		sounds": {
			"ambient": ["LOOPOCEA"]
		}
	},

scenario info window isn't centered

sound of first effect in battle is played before the effect's animation

Noticed in the following cases:

• creature that has the first turn skips turn due to low morale
• Curse cast from Armor of the Damned

Battle intro sound is played in parallel to the first effect sound, effect animation is played at the right time.

Launcher shows errors during mod reinstallation

Pre-conditions: launched needs to be able to download mods from remote server. Launcher from develop can do it, but there is no server with mods available. The branch https://github.com/Nordsoft91/vcmi/tree/mod-from-github allows to download mods from GitHub.

Steps to reproduce:

1. Open launcher
2. Press "download and refresh repositories"
3. Choose any mod with submods (e.g wow/vcmi extra/hota)
4. Install mod
5. Make sure all submods are enabled
6. uninstall mod by pressing uninstall
7. Install mod again

Expected result: no errors, mod is installed and enabled along with all submods
Actual result: error occurs

one cell is missing from ragdoll in Sell Artefacts

[feature] improve marking turn order of creatures

for example, on this SS it's unclear which Naga is next. Knowing this would let me kill the one whose turn is next and grant next turn to Master Gremlins (who will suffer from alive Naga otherwise, most probably).

for example, highlight creature on mouse hovering its portrait.

[feature] H3 file copypaste button in launcher

Would be easier to setup VCMI if there was button that opens file dialog pointing to H3 folder, that would copy data, maps and mp3 folders from H3 to VCMI folder

system message for expected action is printed

not sure if it's a bug or not, but I wouldn't print system message in this case: creature stepped into a sand trap and it's expected that it can't reach its destination.

Vampire's "drain life" animation is played before the attack

In the original, as well as from logical POV, life drain is done after attack

[New terrains] Digging on the new terrains

Game crash if hero is digging on the new terrains

animation of Scorpicore’s attack effect is missing

but the effect itself (creature can't move) works as well as proper sound is played

exchange icon instead of attack on enemy hero

purple is my enemy, but once hovering his hero showed exchange icon instead of attack, happened only once and only with one purple hero: https://imgur.com/a/2rt4PJ2

Replay Opponent Turn doesn't work

cursor shows "pick object" instead of "attack"

My steps were:

1. enter monolith, hero has no more turns, plan to attack Basilisks
2. end turn
3. hover Basilisks - cursor shows "pick object" instead of "attack"

luck bonuses inconsistency

there's some inconsistency with using luck artefacts. My hero has base luck zero. Can't say if it's only a display bug or bonuses are also applied incorrectly.

Screen.Recording.2022-09-03.at.20.52.32.mov

Screen.Recording.2022-09-03.at.16.31.46.mov

tooltip is no longer updated after closing spell book

Untitled.mov

"Save was successful" dialog missing

Original game shows confirmation dialog after successful save

Missing picking scroll sound

When we pick scroll, no sound is played.

Solution: change scroll part in config/object/moddables.json

	"spellScroll" : {
		"index" :93,
		"handler": "artifact",
		"types" : {
			"object" : {
				"index" : 0,
				"aiValue" : 500,
				"sounds" : {
					"removal" : [ "PICKUP01", "PICKUP02", "PICKUP03", "PICKUP04", "PICKUP05", "PICKUP06", "PICKUP07" ]
				},
				"templates" : {
					"normal" : {
						"visitableFrom" : [ "+++", "+-+", "+++" ],
						"mask" : [ "VA" ],
						"animation" : "AVA0001.def"
					}
				}
			}
		}
	},

Inproper Conflux heroes specialties

I don't remember which one, - I guess Thunar has wrong parameters.
Here's fixed conflux heroes json.
conflux.zip

Missing air/storm elemental armageddon vulnability

Strom/Air Elementals should have in json

			"armageddonVulnerablity" :
			{
				"type" : "MORE_DAMAGE_FROM_SPELL",
				"subtype" : "spell.armageddon",
				"val" : 100
			}

Here's fixed json:
conflux.zip

right-clicking the topmost enemy’s stack reveals hero info

right-clicking the topmost enemy’s stack doesn’t seem work: it always shows me hero info instead of creature info. Had this in castle and on plain ground. https://imgur.com/a/3MZqLFU

[Forge] glitchy Sulfur Dune animation

Untitled.mov

Strange sound levels during changing Effects volume.

1. Launch any map.
2. Click System Options buttons
3. Mute Music Volume.
4. Increase Effects Volume and hear for a while Volume level
5. Click Return to Game button

Effects Volume decrease drastically.

crash on Nullkiller AI turn

100% reproducible. Simply end turn, game crashes after you see tan player's hero picking up Lion's Shield of Courage (very top of the map, to the right of the center).

Game logs with "Adventure AI trace" mod enabled: Archive.tar.gz

Save game: Archive 2.tar.gz. Forge town + new terrain for this town, used this build: https://github.com/vcmi/vcmi/actions/runs/2997089185

Relevant bits of the crashlog:

Exception Type:        EXC_BAD_ACCESS (SIGSEGV)
Exception Codes:       KERN_INVALID_ADDRESS at 0x0000000000000068
Exception Codes:       0x0000000000000001, 0x0000000000000068
Exception Note:        EXC_CORPSE_NOTIFY

Termination Reason:    Namespace SIGNAL, Code 11 Segmentation fault: 11
Terminating Process:   exc handler [3500]

Thread 16 Crashed:
0   libNullkiller.dylib           	       0x11d8b9aa8 AINodeStorage::calculateTownPortalTeleportations(std::__1::vector<CGPathNode*, std::__1::allocator<CGPathNode*> >&) + 88
1   libNullkiller.dylib           	       0x11d8b9992 AINodeStorage::getInitialNodes() + 690
2   libvcmi.dylib                 	       0x10dd9fbbb CPathfinder::calculatePaths() + 43
3   libvcmi.dylib                 	       0x10dd44ccc CGameState::calculatePaths(std::__1::shared_ptr<PathfinderConfig>) + 124
4   libvcmi.dylib                 	       0x10dd29664 CGameInfoCallback::calculatePaths(std::__1::shared_ptr<PathfinderConfig>) + 52
5   libNullkiller.dylib           	       0x11d8b0ecb AIPathfinder::updatePaths(std::__1::map<CGHeroInstance const*, HeroRole, std::__1::less<CGHeroInstance const*>, std::__1::allocator<std::__1::pair<CGHeroInstance const* const, HeroRole> > >, PathfinderSettings) + 1035
6   libNullkiller.dylib           	       0x11d93cea0 Nullkiller::updateAiState(int) + 1168
7   libNullkiller.dylib           	       0x11d93d2ec Nullkiller::makeTurn() + 364
8   libNullkiller.dylib           	       0x11d9944e8 AIGateway::makeTurn() + 1080
9   libboost_thread.dylib         	       0x10ccfaca2 boost::(anonymous namespace)::thread_proxy(void*) + 130
10  libsystem_pthread.dylib       	    0x7ff8015f74e1 _pthread_start + 125
11  libsystem_pthread.dylib       	    0x7ff8015f2f6b thread_start + 15

Full crashlog: crash.txt

[feature] UI zoom in window mode

currently the only way to zoom is to use fullscreen (when UI and logical resolution differ), would be great to be able to do it in window mode as well

planned hero path isn't restored on loading game

1. plan some path for a hero (green / black arrows on the ground)
2. end turn
3. load last autosave
4. no green / black arrows on the ground

hotkeys don't work when current keyboard layout is not English

noticed on macOS

make ability cell scrollable

Not sure if this improvement makes sense or Shield Bearers from Forge town should simply adjust/shorten their description.

[Forge] missing strings

minimum required damage dealt is written in the battle log

Say, creature can deal 1000 damage, its target has 500 health. Then battle log says that the creature dealt 500 damage, I think it should say 1000 instead, iirc it's like that in the original.

Make essential files permanent

There are two possible solutions:

• place files from essential to filesystem folders (data/sprites/etc) and remove mod
• keep as a mod but make impossible to disable

sleep/wake hero button icon doesn't update immediately after press

The function itself is applied immediately, only button icon is changed after switching to another hero and back to the current one

"Armor of the Damned" set doesn't cast Misfortune

Noticed when fighting against Gryphons in the Conservatory, I don't think they have any kind of immunity against Misfortune.

https://heroes.thelazy.net/index.php/Armor_of_the_Damned

[feature] show amount of available creatures in dwellings

Currently it's impossible to know how many creatures is available for hire in a dwelling until you actually go there with a hero. Would be great to see this info with RMB click or in the tooltip on hovering.

This should be available only in dwellings owned by player. I think Refugee Camps shouldn't receive this feature.

Fixing linux builds for upcoming release

Easiest to fix (blind guess): probably Ubuntu PPA
Ways of distribution that would work on most distros: flatpak, appimage
Nice person I found on Discord created initial flatpak manifest for VCMI, but did not manage to find a quick way to build without "writable-sdk: true" if that gonna be deal breaker: https://github.com/orowith2os/vcmi-flatpak

[new terrains] strangely placed Garrizon

Garrizon has no creatures, doesn't guard anything and is not even placed on the road. Playing for Forge town on new terrain, using asphalt_terrain-mod.

I'm not entirely sure which part of the project is responsible for this (RMG, mod, mod system...).

[feature] show total required amount to buy all creatures

Currently the "buy all creatures" dialog only shows max amount that you can spend out of your available resources if you try to hire as many as possible. Would also be great to show the total required amount of resources to hire all available creatures, use case: I want to exchange resources on the market to buy the rest of the creatures, but I don't know the exact amount, need to calculate it manually.

wrong icons of arrow towers

Conflux towers have storm els, but in the turn order they have magma els images (the 3x1 stacks): https://imgur.com/a/QgvV8Gb

haven't checked other towns.

show bounding rectangle for Dimension Door spell

some numbers shouldn't be formatted according to locale

Formatting port number according to locale makes no sense. Also noticed the same in resolution values in the game menu.
I have English Windows 8.1 with region set to Russia.

Make Beholders temporary attack graphics more friendly.

Because VCMI hasn't yet implemented rays (Magi and Beholders attack), we have (temporarily) replacements. And for now, Beholders shoot... ballista belts that looks ridiculous. It's better give them something that doesn't hurt the eye, for example:

			"missile" :
			{
				"projectile": "PMAGEX.DEF"
			}

BTW. It would be cool to have some (colourful one?) rays in vcmi.

client bugs when assembling artefact set

Basically a duplicate of https://bugs.vcmi.eu/view.php?id=3039

Untitled.mov

As clearly seen from the video, when you try to assemble a set (AotD in this case), something gets wrong with mouse cursor: the real cursor and the in-game one no longer have the same coordinates, which results in inability to click with the in-game cursor, and the behavior persists after dismissing the dialog.

Also, after clicking OK, the replaced artefact (Targ of Ogre) doesn't appear in the bag immediately, you have to click somewhere first.

Save game: Archive.tar.gz, hero Daneel (Forge + new terrains).

in-game resolution selector should highlight the current resolution by default

upgrade creature hotkey doesn't work

in the original game, if you open creature info in town and there's button to upgrade creature, you can invoke it with U button

enter/return key in "buy all creatures" closes dialog

expected behavior is to buy creatures, Esc already closes dialog.

Also, M hotkey to hire as many creatures as possible doesn't work.

Sultan Efreeti wrong Fire Shield value.

Sultan Efreeti should reflect 20% od damage, now val is 30.
Fix:

			"fireShield" :
			{
				"type" : "FIRE_SHIELD",
				"val" : 20
			}

inferno.zip

Fixed json:

[new terrains] invisible Obelisk

I noticed it only by accident thanks to the cursor form:

When hero stands on it, he also becomes invisible, only flag can be seen:

In View World there's nothing in that spot:

no sound on new week start

When new week starts, respective dialog appears. Only after dismissing it the "new week" sound is played. IIRC in original game the sound is played in parallel to the dialog.

Use case: minimised the game during AI turn, was waiting for "new day" sound to switch back.

tooltip of artefact set piece is shown as Empty

I think it's better to show set piece name there. Dunno the behaviour of original in this case.