vcmi/config/schemas/template.json

{
	"type" : "object",
	"$schema" : "http://json-schema.org/draft-04/schema",
	"title" : "VCMI random map template format",
	"description" : "Format used to define random map templates in VCMI",
	"definitions" :
	{
		"zone" : {
			"type" : "object",
			"required" : ["type", "monsters", "size"],
			"additionalProperties" : false,
			"properties" : {
				"type" : {
					"type" : "string",
					"enum" : ["playerStart", "cpuStart", "treasure", "junction", "sealed"]
				},
				"size" : { "type" : "number", "minimum" : 1 },
				"owner" : {},
				"playerTowns" : {"$ref" : "#/definitions/towns"},
				"neutralTowns" : {"$ref" : "#/definitions/towns"},
				"matchTerrainToTown" : { "type" : "boolean"},
				"minesLikeZone" : { "type" : "number" },
				"terrainTypeLikeZone" : { "type" : "number" },
				"treasureLikeZone" : { "type" : "number" },
				"customObjectsLikeZone" : { "type" : "number" },
				
				"terrainTypes": {"$ref" : "#/definitions/stringArray"},
				"bannedTerrains": {"$ref" : "#/definitions/stringArray"},

				"townsAreSameType" : { "type" : "boolean"},
				"allowedMonsters" : {"$ref" : "#/definitions/stringArray"},
				"bannedMonsters" : {"$ref" : "#/definitions/stringArray"},
				"allowedTowns" : {"$ref" : "#/definitions/stringArray"},
				"bannedTowns" : {"$ref" : "#/definitions/stringArray"},

				"monsters" : {
					"type" : "string",
					"enum" : ["weak", "normal", "strong", "none"]
				},

				"mines" : {"$ref" : "#/definitions/mines"},
				"treasure" : {
					"type" : "array",
					"items" : {
						"type" : "object",
						"properties" : {
							"min" : {"type" : "number", "minimum" : 0},
							"max" : {"type" : "number", "minimum" : 0},
							"density" : {"type" : "number", "minimum" : 1}
						},
						"additionalProperties" : false
					}
				},
				"customObjects" : {
					"type" : "object",
					"properties": {
						"bannedCategories": {
							"type": "array",
							"items": {
								"type": "string",
								"enum": ["all", "dwelling", "creatureBank", "randomArtifact", "bonus", "resource", "resourceGenerator", "spellScroll", "pandorasBox", "questArtifact", "seerHut"]
							}
						},
						"bannedObjects": {
							"type": "array",
							"items": {
								"type": "string"
							}
						},
						"commonObjects": {
							"type": "array",
							"items": {
								"type": "object",
								"properties": {
									"id": {
										"type": "string"
									},
									"rmg": {
										"type": "object",
										"properties": {
											"value": {
												"type": "integer"
											},
											"rarity": {
												"type": "integer"
											},
											"zoneLimit": {
												"type": "integer"
											}
										},
										"required": ["value", "rarity"]
									}
								},
								"required": ["id", "rmg"]
							}
						}
					}
				}
			}
		},

		"towns" : {
			"type" : "object",
			"additionalProperties" : false,
			"properties" : {
				"towns" : { "type" : "number" },
				"castles" : { "type" : "number" },
				"townDensity" : { "type" : "number" },
				"castleDensity" : { "type" : "number" }
			}
		},
		"stringArray" : {
			"type" : "array",
			"items" : { "type" : "string" }
		},
		"mines" : {
			"type" : "object",
			"additionalProperties" : false,
			"properties" : {
				"gold" :    { "type" : "number"},
				"wood" :    { "type" : "number"},
				"ore" :     { "type" : "number"},
				"mercury" : { "type" : "number"},
				"sulfur" :  { "type" : "number"},
				"crystal" : { "type" : "number"},
				"gems" :    { "type" : "number"}
			}
		},
		"connection" :
		{
			"required" : ["a", "b"],
			"additionalProperties" : true,
			"properties" : {
				"a" : {
					"type" : "string"
				},
				"b" : {
					"type" : "string"
				},
				"guard" :
				{
					"type" : "number",
					"minimum" : 0
				},
				"type":
				{
					"type" : "string",
					"enum" : ["wide", "fictive", "repulsive", "forcePortal"]
				}
			}
		},
		"waterContent" :
		{
			"enum" : ["none", "normal", "islands"],
			"type" : "string"
		}
	},
	
	"additionalProperties" : false,
	"properties" :
	{
		"required" : ["zones", "connections", "minSize", "maxSize", "players"],
		
		"players" : {
			"description" : "Number of players that will be present on map (human or AI)",
			"type": "string"
		},
		"humans" : {
			"description" : "Optional, number of AI-only players",
			"type": "string"
		},
		"minSize" : {
			"description" : "Minimal size of the map, e.g. 'm+u' or '120x120x1",
			"type": "string"
		},
		"maxSize" : {
			"description" : "Maximal size of the map, e.g. 'm+u' or '120x120x1",
			"type": "string"
		},
		"settings" : {
			"description" : "List of changed game settings by template",
			"type" : "object",
			"$ref" : "gameSettings.json"
		},
		"name" : {
			"description" : "Optional name - useful to have several template variations with same name",
			"type": "string"
		},
		"description" : {
			"description" : "Optional info about template, author or special rules",
			"type": "string"
		},
		"zones" : {
			"description" : "List of named zones",
			"type" : "object",
			"additionalProperties" : {"$ref" : "#/definitions/zone"	}
		},
		"connections" : {
			"description" : "List of connections between zones",
			"type" : "array",
			"items" : {"$ref" : "#/definitions/connection"}	
		},
		"allowedWaterContent" : {
			"description" : "Optional parameter allowing to prohibit some water modes. All modes are allowed if parameter is not specified",
			"type" : "array",
			"items" : {"$ref" : "#/definitions/waterContent"}
		}
	}
}