1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-14 10:12:59 +02:00
vcmi/docs
Ivan Savenko 6056d385ed Always load json configs from mod that references it
This should fix rather common problem with mods, where two unrelated mods
accidentally use same file name for a config file, leading to very unclear
conflict since this result in a file override.

Now all config files referenced in mod.json are loaded specifically from
filesystem of mod that referenced it. In other words, it is no longer
possible for one mod to override config from another mod.

As a side effect, this allows mods to use shorter directory layout, e.g.
`config/modName/xxx.json` can now be safely replaced with `config/
xxx.json` without fear of broken mod if there is another mod with same
path to config. Similarly, now all mods can use `config/translation/
language.json` scheme for translation files

Since this is no longer a problem, I've also simplified directory layout
of our built-in 'vcmi' mod, by moving all files from `config/vcmi`
directory directly to `config` directory.

- Overrides for miscellaneous configs like mainmenu.json should works as
before
- Images / animations (png's or def's) work as before (and may still
result in confict)
- Rebalance mods work as before and can modify another mod via standard
`modName:objectName` syntax
2024-10-31 14:49:11 +00:00
..
developers Update developers documentation to point to new prebuilts location 2024-08-21 12:14:08 +00:00
maintainers fix headings of md files 2024-07-16 20:29:20 +02:00
modders Always load json configs from mod that references it 2024-10-31 14:49:11 +00:00
players fix order (docs) 2024-10-30 21:25:20 +01:00
translators Added 'translate missing' command for convenience 2024-10-26 12:54:35 +00:00
Readme.md Fix one caption in the source code 2024-09-22 19:37:15 +02:00

VCMI Github Downloads Github Downloads Github Downloads Github Downloads

VCMI Project

VCMI is an open-source recreation of Heroes of Might & Magic III engine, giving it new and extended possibilities.

Vanilla town siege in extended window Vanilla town view with radial menu for touchscreen devices Large Spellbook with German translation New widget for Hero selection, featuring Pavillon Town

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

Forge Town in battle Asylum town with new creature dialog Ruins town siege Map editor

Documentation and guidelines for players

Documentation and guidelines for translators

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

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-2024 VCMI Team (check AUTHORS file for the contributors list)