games/vcmi

mirror of https://github.com/vcmi/vcmi.git synced 2024-11-30 08:57:00 +02:00

History

DjWarmonger 047d03c52a Merge pull request #3165 from vcmi/update_doc Update and edit docs		2023-11-15 09:22:48 +01:00
..
developers	Docs: Fix CMake commands for enabling Ccache	2023-11-10 02:40:10 +01:00
maintainers	Update docs according to review	2023-09-17 01:50:31 +03:00
modders	More detailed info with examples	2023-11-12 09:07:52 +01:00
players	Removed old Manual.md. Moved content to Game_Mechanics.md.	2023-11-09 13:33:10 +01:00
Readme.md	convert line endings from CRLF (Windows) to LF (Linux/Unix)	2023-10-19 16:23:21 +02:00

Readme.md

VCMI Project

VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities.

Latest release

Latest release can be found in Github Releases page. As of right now we plan to have major releases around 3 times per year. Daily builds are still available at builds.vcmi.download 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

Documentation and guidelines for players

General information about VCMI Project
Frequently asked questions (external link)
Game mechanics
Bug reporting guidelines
Cheat codes
Privacy Policy

Documentation and guidelines for game modders

Documentation and guidelines for developers

Development environment setup instructions:

Engine documentation: (NOTE: may be outdated)

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