vcmi/docs/Main Page.md

Welcome to VCMI Project Wiki

VCMI is an open-source project aiming to reimplement HMM3:WoG and SoD game engines, giving it new and extended possibilities.

Latest release

As of 28th of April 2023, we released VCMI 1.2.1. Now we plan to have releases 3-4 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 version of VCMI is usually not supported, so you may want to finish your ongoing games before updating.
Please see corresponding "installation on" articles for details for your platform.

Documentation and guidelines for users

• General information about VCMI Project
• Frequently asked questions
• Engine features
• Game mechanics
• Bug reporting guidelines
• Mod list
• Cheat codes
• Installation guides:
  • Windows
  • macOS
  • Linux
  • Android
  • iOS

Documentation and guidelines for modders

• Modding guidelines
• Mods repository
• Formats:
  • Mod file Format
  • Town Format
  • Hero Classes Format
  • Hero Format
  • Creature Format
  • Artifact Format
  • Animation Format
  • Bonus Format
  • Object Format
  • Spell Format
  • Skill Format

Documentation and guidelines for developers

• How to build using CMake:
  • Linux
  • Linux/MinGW (for Windows)
  • macOS
  • Windows
  • iOS
  • Android
• Unsupported build instructions:
  • Windows/MSVS (Visual Studio 2015)
• Coding guidelines
• Code structure
• Logging API
• Development environment guides:
  • Development with Qt Creator

VCMI Places

• Website
• Forum
• Bugtracker
• Slack invite page
• GitHub repository