vcmi/docs

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 here. 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

To use VCMI you need to own original data files.

• Android
• Linux
• macOS
• Windows
• iOS

Documentation and guidelines for players

• General information about VCMI Project
• Frequently asked questions
• Engine features
• Game mechanics
• Bug reporting guidelines
• Mod list
• Cheat codes
• Cheat codes

Installation guides

• Windows
• macOS
• Linux
• Android
• iOS

Documentation and guidelines for game 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

Documentation and guidelines for maintainers

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)