games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-24 22:14:36 +02:00
Code Issues Releases Activity

Updated docs

Browse Source
This commit is contained in:
Ivan Savenko 2023-09-18 14:03:43 +03:00
parent dfc72134f2
commit 0b044663d9
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/modders/Campaign_Format.md
View File

@ -88,6 +88,7 @@ Prolog and epilog properties are optional
{
"video": "NEUTRALA.smk", //video to show
"music": "musicFile.ogg", //music to play, should be located in music directory
"voice": "musicFile.wav", //voice to play, should be located in sounds directory
"text": "some long text" //text to be shown
}
```

17
docs/modders/Mod_File_Format.md
View File

@ -178,6 +178,23 @@ These are fields that are present only in local mod.json file
}
```
## 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
}
```
## Notes
For mod description it is possible to use certain subset of HTML as