Browse Source

Updated docs

Ivan Savenko 2 years ago
parent
commit
0b044663d9
2 changed files with 18 additions and 0 deletions
  1. 1 0
      docs/modders/Campaign_Format.md
  2. 17 0
      docs/modders/Mod_File_Format.md

+ 1 - 0
docs/modders/Campaign_Format.md

@@ -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 - 0
docs/modders/Mod_File_Format.md

@@ -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