mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-22 22:13:35 +02:00
96 lines
5.3 KiB
Markdown
96 lines
5.3 KiB
Markdown
[](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
|
|
[](https://github.com/vcmi/vcmi/releases/tag/1.4.0)
|
|
[](https://github.com/vcmi/vcmi/releases/tag/1.4.1)
|
|
[](https://github.com/vcmi/vcmi/releases)
|
|
|
|
# VCMI Project
|
|
|
|
VCMI is an open-source recreation of Heroes of Might & Magic III engine, giving it new and extended possibilities.
|
|
|
|
<p>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.3.0/Castle%20Siege.jpg?raw=true" alt="Vanilla town siege in extended window" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.3.0/Town%20Screen%20with%20Radial%20Menu.jpg?raw=true" alt="Vanilla town view with radial menu for touchscreen devices" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Big%20spellbook.jpg?raw=true" alt="Large Spellbook with German translation" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Quick%20Hero%20Select%20Bastion.jpg?raw=true" alt="New widget for Hero selection, featuring Pavillon Town" style="height:120px;"/>
|
|
</p>
|
|
|
|
|
|
## 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)
|
|
|
|
<p>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Antagarich%20Burning%20Battle.jpg?raw=true" alt="Forge Town in battle" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Town%20and%20Unit.jpg?raw=true" alt="Asylum town with new creature dialog" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Siege.jpg?raw=true" alt="Ruins town siege" style="height:120px;"/>
|
|
<img src="https://github.com/vcmi/VCMI.eu/blob/master/static/img/screenshots/1.4.0/Editor.jpg?raw=true" alt="Map editor" style="height:120px;"/>
|
|
</p>
|
|
|
|
## 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)
|
|
- [Configurable Widgets](modders/Configurable_Widgets.md)
|
|
|
|
## Documentation and guidelines for developers
|
|
|
|
Development environment setup instructions:
|
|
- [Building VCMI for Android](developers/Building_Android.md)
|
|
- [Building VCMI for iOS](developers/Building_iOS.md)
|
|
- [Building VCMI for Linux](developers/Building_Linux.md)
|
|
- [Building VCMI for macOS](developers/Building_macOS.md)
|
|
- [Building VCMI for Windows](developers/Building_Windows.md)
|
|
- [Conan](developers/Conan.md)
|
|
|
|
Engine documentation: (NOTE: may be outdated)
|
|
- [Development with Qt Creator](developers/Development_with_Qt_Creator.md)
|
|
- [Coding Guidelines](developers/Coding_Guidelines.md)
|
|
- [Bonus System](developers/Bonus_System.md)
|
|
- [Code Structure](developers/Code_Structure.md)
|
|
- [Logging API](developers/Logging_API.md)
|
|
- [Lua Scripting System](developers/Lua_Scripting_System.md)
|
|
- [Serialization](developers/Serialization.md)
|
|
|
|
## Documentation and guidelines for maintainers
|
|
|
|
- [Project Infrastructure](maintainers/Project_Infrastructure.md)
|
|
- [Release Process](maintainers/Release_Process.md)
|
|
- [Ubuntu PPA](maintainers/Ubuntu_PPA.md)
|
|
|
|
## 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)
|