[![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.2.1/total)](https://github.com/vcmi/vcmi/releases/tag/1.2.1)
[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/1.2.0/total)](https://github.com/vcmi/vcmi/releases/tag/1.2.0)
[![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)
