vcmi/config/schemas/terrain.json

{
	"type":"object",
	"$schema": "http://json-schema.org/draft-04/schema",
	"title" : "VCMI terrain format",
	"description" : "Format used to define new terrains in VCMI",
	"required" : [ "tiles", "code", "moveCost" ],

	"additionalProperties" : false,
	"properties":{
		"moveCost":
		{
			"type": "number",
			"description": "How many movement points needed to move hero"
		},
		"minimapUnblocked":
		{
			"type": "array",
			"description": "Color of terrain on minimap without unpassable objects",
			"minItems": 3,
			"maxItems": 3,
			"items":
			{
				"type": "number"
			}
		},
		"minimapBlocked":
		{
			"type": "array",
			"description": "Color of terrain on minimap with unpassable objects",
			"minItems": 3,
			"maxItems": 3,
			"items":
			{
				"type": "number"
			}
		},
		"music":
		{
			"type": "string",
			"description": "Music filename to play on this terrain on adventure map"
		},
		"tiles":
		{
			"type": "string",
			"description": "Name of file with graphicks",
			"format": "defFile"
		},
		"type":
		{
			"type": "string",
			"description": "Type of this terrain. Can be land, water, subterranean or rock",
			"enum": ["LAND", "WATER", "SUB", "ROCK"]
		},
		"rockTerrain":
		{
			"type": "string",
			"description": "The name of tock type terrain which will be used as borders in the underground"
		},
		"river":
		{
			"type": "string",
			"description": "River type which should be used for that terrain",
			"enum": ["", "rw", "ri", "rm", "rl"]
		},
		"horseSoundId":
		{
			"type": "number",
			"description": "Id of horse sound to be played when hero is moving across terrain"
		},
		"text":
		{
			"type": "string",
			"description": "Text to be shown when mouse if over terrain"
		},
		"code":
		{
			"type": "string",
			"description": "Two-letters unique indentifier for this terrain. Used for terrain serializaion"
		},
		"battleFields":
		{
			"type": "array",
			"description": "array of battleFields for this terrain",
			"items":
			{
				"type": "string"
			}
		},
		"prohibitTransitions":
		{
			"type": "array",
			"description": "array or terrain names, which is prohibited to make transition from/to",
			"items":
			{
				"type": "string"
			}
		},
		"transitionRequired":
		{
			"type": "boolean",
			"description": "If sand/dirt transition required from/to other terrains"
		},
		"terrainViewPatterns":
		{
			"type": "string",
			"description": "Can be normal, dirt, water, rock"
		}
	}
}