mirror of
https://github.com/vcmi/vcmi.git
synced 2024-11-28 08:48:48 +02:00
73 lines
3.6 KiB
Markdown
73 lines
3.6 KiB
Markdown
[](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
|
|
[](https://github.com/vcmi/vcmi/releases/tag/1.3.0)
|
|
[](https://github.com/vcmi/vcmi/releases/tag/1.3.1)
|
|
[](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/
|
|
* 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 [in Github Releases page](https://github.com/vcmi/vcmi/releases/latest). As of right now we plan to have major releases around 3 times per year. Daily builds are still available at [builds.vcmi.download](https://builds.vcmi.download/branch/develop/) 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
|
|
- [Windows](players/Installation_Windows.md)
|
|
- [macOS](players/Installation_macOS.md)
|
|
- [Linux](players/Installation_Linux.md)
|
|
- [Android](players/Installation_Android.md)
|
|
- [iOS](players/Installation_iOS.md)
|
|
|
|
## Documentation and guidelines for players
|
|
|
|
- [General information about VCMI Project](players/Manual.md)
|
|
- [Frequently asked questions](https://vcmi.eu/faq/) (external link)
|
|
- [Game mechanics](players/Game_Mechanics.md)
|
|
- [Bug reporting guidelines](players/Bug_Reporting_Guidelines.md)
|
|
- [Cheat codes](players/Cheat_Codes.md)
|
|
- [Privacy Policy](players/Privacy_Policy.md)
|
|
|
|
## Documentation and guidelines for game modders
|
|
|
|
- [Modding Guidelines](modders/Readme.md)
|
|
- [Mod File Format](modders/Mod_File_Format.md)
|
|
- [Bonus Format](modders/Bonus_Format.md)
|
|
- [Translations](modders/Translations.md)
|
|
- [Map Editor](modders/Map_Editor.md)
|
|
- [Campaign Format](modders/Campaign_Format.md)
|
|
|
|
## Documentation and guidelines for developers
|
|
|
|
- How to build using CMake:
|
|
- [Linux](How_to_build_VCMI_(Linux) "wikilink")
|
|
- [Linux/MinGW (for Windows)](How_to_build_VCMI_(Linux/MinGW) "wikilink")
|
|
- [macOS](How_to_build_VCMI_(macOS) "wikilink")
|
|
- [Windows](How_to_build_VCMI_(Windows/Vcpkg) "wikilink")
|
|
- [iOS](How_to_build_VCMI_(iOS) "wikilink")
|
|
- [Android](How_to_build_VCMI_(Android) "wikilink")
|
|
- Unsupported build instructions:
|
|
- [Windows/MSVS (Visual Studio 2015)](How_to_build_VCMI_(Windows/Visual_Studio_2015) "wikilink")
|
|
- [Coding guidelines](Coding_guidelines "wikilink")
|
|
- [Code structure](Code_structure "wikilink")
|
|
- [Logging API](Logging_API "wikilink")
|
|
- [Development with Qt Creator](Development_with_Qt_Creator "wikilink")
|
|
|
|
## 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)
|