vcmi/config/schemas/river.json

{
	"type" : "object",
	"$schema" : "http://json-schema.org/draft-04/schema",
	"title" : "VCMI river format",
	"description" : "Format used to define new rivers in VCMI",
	"required" : [ "shortIdentifier", "text", "tilesFilename", "delta" ],
	"additionalProperties" : false,
	"properties" : {
		"shortIdentifier" :
		{
			"type" : "string",
			"description" : "Two-letters unique indentifier for this river. Used in map format"
		},
		"text" :
		{
			"type" : "string",
			"description" : "Human-readable name of the river"
		},
		"tilesFilename" :
		{
			"type" : "string",
			"description" : "Name of file with river graphics",
			"format" : "animationFile"
		},
		"delta" :
		{
			"type" : "string",
			"description" : "Name of file with river delta graphics"
		},
		"paletteAnimation" : {
			"type" : "array",
			"description" : "If defined, river will be animated using palette color cycling effect",
			"items" :
			{
				"type" : "object",
				"additionalProperties" : false,
				"properties" : {
					"start" : {
						"type" : "number"
					},
					"length" : {
						"type" : "number"
					}
				}
			}
		},
		"index" : 
		{
			"type" : "number",
			"description" : "Internal, do not use"
		}
	}
}