1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-16 10:19:47 +02:00
vcmi/docs/modders/Mod_File_Format.md

203 lines
4.9 KiB
Markdown
Raw Normal View History

< [Documentation](../Readme.md) / [Modding](Readme.md) / Mod File Format
2023-09-01 00:30:26 +02:00
## Fields with description of mod
2023-08-12 11:39:44 +02:00
``` javascript
{
// Name of your mod. While it does not have hard length limit
// it should not be longer than ~30 symbols to fit into allowed space
"name" : "My test mod",
// More lengthy description of mod. No hard limit. This text will be visible in launcher.
// This field can use small subset of HTML, see link at the bottom of this page.
"description" : "My test mod that add a lot of useless stuff into the game",
// Author of mod. Can be nickname, real name or name of team
"author" : "Anonymous",
// Full name of license used by mod. Should be set only if you're author of mod
// or received permission to use such license from original author
"licenseName" : "Creative Commons Attribution-ShareAlike",
// URL which user can use to see license terms and text
"licenseURL" : "https://creativecommons.org/licenses/by-sa/4.0/",
// Home page of mod or link to forum thread to contact the author
"contact" : "http://example.com",
// Current mod version, up to 3 numbers, dot-separated. Format: A.B.C
"version" : "1.2.3"
// Type of mod, list of all possible values:
// "Translation", "Town", "Test", "Templates", "Spells", "Music", "Sounds", "Skills", "Other", "Objects",
// "Mechanics", "Interface", "Heroes", "Graphical", "Expansion", "Creatures", "Artifacts", "AI"
"modType" : "Graphical",
// Base language of the mod, before applying localizations. By default vcmi assumes English
// This property is mostly needed for translation mods only
"language" : "english"
// List of mods that are required to run this one
"depends" :
[
"baseMod"
],
2023-08-12 11:39:44 +02:00
// List of mods that can't be enabled in the same time as this one
"conflicts" :
[
"badMod"
],
// Supported versions of vcmi engine
"compatibility" : {
"min" : "1.2.0"
"max" : "1.3.0"
}
//List of changes/new features in each version
"changelog" :
{
"1.0" : [ "initial release" ],
"1.0.1" : [ "change 1", "change 2" ],
"1.1" : [ "change 3", "change 4" ]
},
// If set to true, mod will not be enabled automatically on install
"keepDisabled" : false
// List of game settings changed by a mod. See <VCMI Install>/config/gameConfig.json for reference
"settings" : {
"combat" : {
"goodLuckDice" : [] // disable luck
}
}
2023-08-12 11:39:44 +02:00
}
```
2023-09-01 00:30:26 +02:00
## Fields with description of mod content
2023-08-12 11:39:44 +02:00
These are fields that are present only in local mod.json file
``` javascript
{
// Following section describes configuration files with content added by mod
// It can be split into several files in any way you want but recommended organization is
// to keep one file per object (creature/hero/etc) and, if applicable, add separate file
// with translatable strings for each type of content
// list of factions/towns configuration files
"factions" :
[
"config/myMod/faction.json"
]
// List of hero classes configuration files
"heroClasses" :
[
"config/myMod/heroClasses.json"
],
// List of heroes configuration files
"heroes" :
[
"config/myMod/heroes.json"
],
// List of configuration files for skills
skills
// list of creature configuration files
"creatures" :
[
"config/myMod/creatures.json"
],
// List of artifacts configuration files
"artifacts" :
[
"config/myMod/artifacts.json"
],
// List of objects defined in this mod
"objects" :
[
"config/myMod/objects.json"
],
// List of spells defined in this mod
"spells" :
[
"config/myMod/spells.json"
],
// List of configuration files for terrains
"terrains" :
[
"config/myMod/terrains.json"
],
// List of configuration files for roads
"roads" :
[
"config/myMod/roads.json"
],
// List of configuration files for rivers
"rivers" :
[
"config/myMod/rivers.json"
],
// List of configuration files for battlefields
"battlefields" :
[
"config/myMod/battlefields.json"
],
// List of configuration files for obstacles
"obstacles" :
[
"config/myMod/obstacles.json"
],
// List of RMG templates defined in this mod
"templates" :
[
"config/myMod/templates.json"
],
// Optional, primaly used by translation mods
// Defines strings that are translated by mod into base language specified in "language" field
"translations" :
[
"config/myMod/englishStrings.json
]
2023-08-12 11:39:44 +02:00
}
```
2023-09-18 13:03:43 +02:00
## Mod repository fields
These are fields that are present only in remote repository and are generally not used in mod.json
```jsonc
{
// URL to mod.json that describes this mod
"mod" : "https://raw.githubusercontent.com/vcmi-mods/vcmi-extras/vcmi-1.4/mod.json",
// URL that player can use to download mod
"download" : "https://github.com/vcmi-mods/vcmi-extras/archive/refs/heads/vcmi-1.4.zip",
// Approximate size of download, megabytes
"downloadSize" : 4.496
}
```
2023-08-12 11:39:44 +02:00
## Notes
For mod description it is possible to use certain subset of HTML as
described here:
<http://qt-project.org/doc/qt-5.0/qtgui/richtext-html-subset.html>