games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-11-29 23:07:48 +02:00
Code Issues Releases Activity

Updated modders docs

Browse Source
This commit is contained in:
Ivan Savenko
2023-09-01 01:30:26 +03:00
parent 489faef604
commit 06f9513b32
18 changed files with 145 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/modders/Mod_File_Format.md
View File

@@ -1,9 +1,4 @@
This is description of mod.json file, main file for mods.
Schema in git:
[config/schemas/mod.json](https://github.com/vcmi/vcmi/blob/develop/config/schemas/mod.json)
## Fields for local file and repository
## Fields with description of mod
``` javascript
@@ -60,7 +55,7 @@ Schema in git:
}
```
## Fields specific for local file
## Fields with description of mod content
These are fields that are present only in local mod.json file
@@ -135,27 +130,6 @@ These are fields that are present only in local mod.json file
}
```
## Fields present only in repository
This is list of fields that must be added to mod record in repository
file
``` javascript
{
// URL which launcher will use to download mod
"download" : "http://example.com/mods/helloworld.zip",
// size of mod archive, in kilobytes
"size" : 12345,
// list of URL's with screenshots for this mod
"screenshots" : [
"http://example.com/images/helloworld_1.png"
]
}
```
## Notes
For mod description it is possible to use certain subset of HTML as