1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
{
"type" : "object",
"$schema" : "http://json-schema.org/draft-04/schema",
"title" : "VCMI mod file format",
"description" : "Format used to define main mod file (mod.json) in VCMI",
"required" : [ "name", "description", "modType", "version", "author", "contact" ],
"definitions" : {
"fileListOrObject" : {
"oneOf" : [
{
"type" : "array",
"items" : { "type" : "string", "format" : "textFile" }
},
{
"type" : "object"
}
]
},
"localizable" : {
"type" : "object",
"additionalProperties" : false,
"required" : [ "name", "description" ],
"properties" : {
"name" : {
"type" : "string",
"description" : "Short name of your mod. No more than 2-3 words"
},
"description" : {
"type" : "string",
"description" : "More lengthy description of mod. No hard limit"
},
"author" : {
"type" : "string",
"description" : "Author of the mod. Can be nickname, real name or name of team"
},
"changelog" : {
"type" : "object",
"description" : "List of changes/new features in each version",
"additionalProperties" : {
"type" : "array",
"items" : { "type" : "string" }
}
},
"skipValidation" : {
"type" : "boolean",
"description" : "If set to true, vcmi will skip validation of current translation json files"
},
"translations" : {
"description" : "List of files with translations for this language",
"$ref" : "#/definitions/fileListOrObject"
}
}
}
},
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"description" : "Short name of your mod. No more than 2-3 words"
},
"description" : {
"type" : "string",
"description" : "More lengthy description of mod. No hard limit"
},
"modType" : {
"type" : "string",
"enum" : [ "Translation", "Town", "Test", "Templates", "Spells", "Music", "Maps", "Sounds", "Skills", "Other", "Objects", "Mechanics", "Interface", "Heroes", "Graphical", "Expansion", "Creatures", "Compatibility", "Artifacts", "AI" ],
"description" : "Type of mod, e.g. Town, Artifacts, Graphical."
},
"author" : {
"type" : "string",
"description" : "Author of the mod. Can be nickname, real name or name of team"
},
"downloadSize": {
"type" : "number",
"description" : "Approximate size of mod, compressed by zip algorithm, in Mb"
},
"contact" : {
"type" : "string",
"description" : "Home page of mod or link to forum thread"
},
"licenseName" : {
"type" : "string",
"description" : "Name of the license, recommended is Creative Commons Attribution-ShareAlike"
},
"licenseURL" : {
"type" : "string",
"description" : "Url to license text, e.g. http://creativecommons.org/licenses/by-sa/4.0/deed"
},
"version" : {
"type" : "string",
"description" : "Current mod version, up to 3 numbers, dot-separated. Format: A.B.C"
},
"changelog" : {
"type" : "object",
"description" : "List of changes/new features in each version",
"additionalProperties" : {
"type" : "array",
"items" : { "type" : "string" }
}
},
"compatibility" : {
"type" : "object",
"description" : "Supported versions of vcmi engine",
"additionalProperties" : false,
"properties" : {
"min" : {
"type" : "string",
"description" : "minimal compatible vcmi engine version in a format major.minor.patch. When specified, earlier versions won't be supported"
//"pattern" : "^\\d+\\.\\d+\\.\\d+$" // Not implemented in schema support
},
"max" : {
"type" : "string",
"description" : "maximum compatible vcmi engine version in a format major.minor.patch. When specified, later versions won't be supported"
//"pattern" : "^\\d+\\.\\d+\\.\\d+$" // Not implemented in schema support
}
}
},
"depends" : {
"type" : "array",
"description" : "List of mods that are required to run this one",
"items" : { "type" : "string" }
},
"softDepends" : {
"type" : "array",
"description" : "List of mods if they are enabled, should be loaded before this one. This mod will overwrite any conflicting items from its soft dependency mods",
"items" : { "type" : "string" }
},
"conflicts" : {
"type" : "array",
"description" : "List of mods that can't be enabled in the same time as this one",
"items" : { "type" : "string" }
},
"keepDisabled" : {
"type" : "boolean",
"description" : "If set to true, mod will not be enabled automatically on install"
},
"settings" : {
"description" : "List of changed game settings by mod",
"oneOf" : [
{
"type" : "object",
"$ref" : "gameSettings.json"
},
{
"type" : "array",
"items" : { "type" : "string", "format" : "textFile" }
},
]
},
"filesystem" : {
"type" : "object",
"description" : "Optional, description on how files are organized in your mod. In most cases you do not need to use this field",
"additionalProperties" : {
"type" : "array",
"description" : "list of data sources attached to this mount point",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"path" : {
"type" : "string",
"description" : "Path to data source"
},
"type" : {
"type" : "string",
"enum" : [ "dir", "lod", "snd", "vid", "map", "zip" ],
"description" : "Type of data source"
}
}
}
}
},
"language" : {
"type" : "string",
"description" : "Base language of the mod, before applying localizations. By default vcmi assumes English",
"enum" : [ "czech", "chinese", "english", "finnish", "french", "german", "hungarian", "italian", "korean", "polish", "portuguese", "russian", "spanish", "swedish", "turkish", "ukrainian", "vietnamese" ]
},
"czech" : {
"$ref" : "#/definitions/localizable"
},
"chinese" : {
"$ref" : "#/definitions/localizable"
},
"english" : {
"$ref" : "#/definitions/localizable"
},
"finnish" : {
"$ref" : "#/definitions/localizable"
},
"french" : {
"$ref" : "#/definitions/localizable"
},
"german" : {
"$ref" : "#/definitions/localizable"
},
"hungarian" : {
"$ref" : "#/definitions/localizable"
},
"italian" : {
"$ref" : "#/definitions/localizable"
},
"korean" : {
"$ref" : "#/definitions/localizable"
},
"polish" : {
"$ref" : "#/definitions/localizable"
},
"portuguese" : {
"$ref" : "#/definitions/localizable"
},
"russian" : {
"$ref" : "#/definitions/localizable"
},
"spanish" : {
"$ref" : "#/definitions/localizable"
},
"swedish" : {
"$ref" : "#/definitions/localizable"
},
"turkish" : {
"$ref" : "#/definitions/localizable"
},
"ukrainian" : {
"$ref" : "#/definitions/localizable"
},
"vietnamese" : {
"$ref" : "#/definitions/localizable"
},
"translations" : {
"description" : "List of files with translations for this language",
"$ref" : "#/definitions/fileListOrObject"
},
"factions" : {
"description" : "List of configuration files for towns/factions",
"$ref" : "#/definitions/fileListOrObject"
},
"heroClasses" : {
"description" : "List of configuration files for hero classes",
"$ref" : "#/definitions/fileListOrObject"
},
"heroes" : {
"description" : "List of configuration files for heroes",
"$ref" : "#/definitions/fileListOrObject"
},
"skills" : {
"description" : "List of configuration files for skills",
"$ref" : "#/definitions/fileListOrObject"
},
"creatures" : {
"description" : "List of configuration files for creatures",
"$ref" : "#/definitions/fileListOrObject"
},
"artifacts" : {
"description" : "List of configuration files for artifacts",
"$ref" : "#/definitions/fileListOrObject"
},
"spells" : {
"description" : "List of configuration files for spells",
"$ref" : "#/definitions/fileListOrObject"
},
"objects" : {
"description" : "List of configuration files for objects",
"$ref" : "#/definitions/fileListOrObject"
},
"biomes" : {
"description" : "List of configuration files for biomes",
"$ref" : "#/definitions/fileListOrObject"
},
"bonuses" : {
"description" : "List of configuration files for bonuses",
"$ref" : "#/definitions/fileListOrObject"
},
"terrains" : {
"description" : "List of configuration files for terrains",
"$ref" : "#/definitions/fileListOrObject"
},
"roads" : {
"description" : "List of configuration files for roads",
"$ref" : "#/definitions/fileListOrObject"
},
"rivers" : {
"description" : "List of configuration files for rivers",
"$ref" : "#/definitions/fileListOrObject"
},
"battlefields" : {
"description" : "List of configuration files for battlefields",
"$ref" : "#/definitions/fileListOrObject"
},
"obstacles" : {
"description" : "List of configuration files for obstacles",
"$ref" : "#/definitions/fileListOrObject"
},
"templates" : {
"description" : "List of configuration files for RMG templates",
"$ref" : "#/definitions/fileListOrObject"
},
"scripts" : {
"description" : "List of configuration files for scripts",
"$ref" : "#/definitions/fileListOrObject"
}
}
}
|
