|
|
@@ -0,0 +1,96 @@
|
|
|
+[](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 [here](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
|
|
|
+
|
|
|
+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)
|
|
|
+
|
|
|
+## Documentation and guidelines for players
|
|
|
+
|
|
|
+- [General information about VCMI Project](VCMI "wikilink")
|
|
|
+- [Frequently asked questions](Frequently_asked_questions "wikilink")
|
|
|
+- [Engine features](Engine_features "wikilink")
|
|
|
+- [Game mechanics](Game_mechanics "wikilink")
|
|
|
+- [Bug reporting guidelines](players/Bug_Reporting_Guidelines.md)
|
|
|
+- [Mod list](Mod_list "wikilink")
|
|
|
+- [Cheat codes](Cheat_Codes.md)
|
|
|
+- [Cheat codes](Client_Commands.md)
|
|
|
+
|
|
|
+### Installation guides
|
|
|
+- [Windows](Installation_on_Windows "wikilink")
|
|
|
+- [macOS](Installation_on_macOS "wikilink")
|
|
|
+- [Linux](Installation_on_Linux "wikilink")
|
|
|
+- [Android](Installation_on_Android "wikilink")
|
|
|
+- [iOS](Installation_on_iOS "wikilink")
|
|
|
+
|
|
|
+## Documentation and guidelines for game modders
|
|
|
+
|
|
|
+- [Modding guidelines](Modding_guidelines "wikilink")
|
|
|
+- [Mods repository](Mods_repository "wikilink")
|
|
|
+- Formats:
|
|
|
+ - [Mod file Format](Mod_file_Format "wikilink")
|
|
|
+ - [Town Format](Town_Format "wikilink")
|
|
|
+ - [Hero Classes Format](Hero_Classes_Format "wikilink")
|
|
|
+ - [Hero Format](Hero_Format "wikilink")
|
|
|
+ - [Creature Format](Creature_Format "wikilink")
|
|
|
+ - [Artifact Format](Artifact_Format "wikilink")
|
|
|
+ - [Animation Format](Animation_Format "wikilink")
|
|
|
+ - [Bonus Format](Bonus_Format "wikilink")
|
|
|
+ - [Object Format](Object_Format "wikilink")
|
|
|
+ - [Spell Format](Spell_Format "wikilink")
|
|
|
+ - [Skill Format](Skill_Format "wikilink")
|
|
|
+
|
|
|
+## 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 environment guides:
|
|
|
+ - [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)
|
Ivan Savenko