a90c24c414
- Create API Reference with detailed engine API documentation - Add Developer Quickstart Guide for new contributors - Create Testing and Debugging guide with practical examples - Add Contributing Guidelines for community standards - Create Engine Architecture overview document - Update Lua Scripting documentation (remove outdated warning) - Fix outdated Logging section in Coding Guidelines - Update main README with organized documentation structure - Remove "may be outdated" warning from engine docs Co-authored-by: dydzio0614 <9436577+dydzio0614@users.noreply.github.com>
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
- 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
See also installation guide for Heroes Chronicles.
Documentation and guidelines for players
- Frequently asked questions (external link)
- Game mechanics
- Bug reporting guidelines
- Cheat codes
- Privacy Policy
Documentation and guidelines for translators
Documentation and guidelines for game modders
Documentation and guidelines for developers
Development Environment Setup
- Developer Quickstart Guide - Quick setup and first steps
- Building VCMI for Android
- Building VCMI for iOS
- Building VCMI for Linux
- Building VCMI for macOS
- Building VCMI for Windows
- Conan Package Management
Engine Documentation
- Engine Architecture - High-level architecture overview
- API Reference - Comprehensive engine API documentation
- Code Structure - Detailed code organization
- Coding Guidelines - Code style and best practices
- Contributing Guidelines - How to contribute effectively
- Testing and Debugging - Testing strategies and debugging techniques
Specialized Topics
- Development with Qt Creator
- Bonus System - Core gameplay mechanic system
- Serialization - Save/load and networking system
- Networking - Network protocol documentation
- Logging API - Logging system usage
- Lua Scripting System - Scripting API reference
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-2025 VCMI Team (check AUTHORS file for the contributors list)