1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-04 09:42:40 +02:00
vcmi/README.md

44 lines
2.4 KiB
Markdown
Raw Normal View History

2021-07-26 19:24:31 +02:00
[![GitHub](https://github.com/vcmi/vcmi/actions/workflows/github.yml/badge.svg)](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
2017-07-04 03:08:13 +02:00
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/github/vcmi/vcmi?branch=develop&svg=true)](https://ci.appveyor.com/project/vcmi/vcmi)
2016-11-24 18:51:27 +02:00
[![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.1.0/total)](https://github.com/vcmi/vcmi/releases/tag/1.1.0)
[![Github Downloads](https://img.shields.io/github/downloads/vcmi/vcmi/total)](https://github.com/vcmi/vcmi/releases)
2014-04-08 13:49:18 +03:00
# VCMI Project
VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities.
2009-02-14 16:37:13 +02:00
2014-04-08 13:49:18 +03:00
## Links
2009-02-14 16:37:13 +02:00
* Homepage: https://vcmi.eu/
* Wiki: https://wiki.vcmi.eu/
* Forums: https://forum.vcmi.eu/
* Bugtracker: https://github.com/vcmi/vcmi/issues
2017-07-02 17:09:33 +02:00
* Slack: https://slack.vcmi.eu/
2009-02-14 16:37:13 +02:00
## Installation guides
2014-04-08 13:49:18 +03:00
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)
2022-08-16 15:01:43 +02:00
* [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:
2022-10-15 17:33:10 +02:00
* (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 MXE](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux/Cmake/MXE))
* [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))
2022-08-16 15:01:43 +02:00
* [iOS on macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(iOS))
2014-04-08 13:49:18 +03:00
## 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]
2014-04-08 13:49:18 +03:00
Copyright (C) 2007-2022 VCMI Team (check AUTHORS file for the contributors list)