Difference between revisions of "Random map template"

From VCMI Project Wiki
Jump to: navigation, search
(Template format)
(Template format)
Line 11: Line 11:
 
"Triangle" :  
 
"Triangle" :  
 
{
 
{
        //optional name - useful to have several template variations with same name (since 0.99)
+
//optional name - useful to have several template variations with same name (since 0.99)
        "name" : "Custom template name",
+
"name" : "Custom template name",
  
 
/// Minimal and maximal size of the map. Possible formats:
 
/// Minimal and maximal size of the map. Possible formats:
Line 21: Line 21:
  
 
/// Number of players that will be present on map (human or AI)
 
/// Number of players that will be present on map (human or AI)
"players" : "4",
+
"players" : "2-4",
  
 
/// Number of AI-only players
 
/// Number of AI-only players
"cpu" : "2",
+
"cpu" : "1-2",
 +
 
 +
/// [Optional] list of water modes supported by template. All water modes allowed if parameter is not specified
 +
"allowedWaterContent" : ["none", "normal", "islands"]
  
 
/// List of named zones, see below for format description
 
/// List of named zones, see below for format description

Revision as of 08:30, 16 September 2022

Ideally, template format should be 100% compatible with OH3 format and bring additional improvements.

List of currently available templates

  • Analogy
  • Upgrade
  • Golden Ring
  • Unfair Game
  • Jebus Cross

Template format

/// Unique template name
"Triangle" : 
{
	//optional name - useful to have several template variations with same name (since 0.99)
	 "name" : "Custom template name",

	/// Minimal and maximal size of the map. Possible formats:
	/// Size code: s, m, l or xl for size with optional suffix "+u" for underground
	/// Numeric size, e.g.  120x120x1 (width x height x depth). Note that right now depth can only be 0 or 1
	"minSize" : "m",
	"maxSize" : "xl+u",

	/// Number of players that will be present on map (human or AI)
	"players" : "2-4",

	/// Number of AI-only players
	"cpu" : "1-2",

	/// [Optional] list of water modes supported by template. All water modes allowed if parameter is not specified
	"allowedWaterContent" : ["none", "normal", "islands"]

	/// List of named zones, see below for format description
	"zones" :
	{
		"zoneA" : { ... },
		"zoneB" : { ... },
		"zoneC" : { ... }
	},
	"connections" :
	[
		{ "a" : "zoneA", "b" : "zoneB", "guard" : 5000 },
		{ "a" : "zoneA", "b" : "zoneC", "guard" : 5000 },
		{ "a" : "zoneB", "b" : "zoneC", "guard" : 5000 }
	]
}

Zone format

{
	"type" : "playerStart", //"cpuStart" "treasure"
	"size" : 2,
	"owner" : 1,
	"playerTowns" : {
		"castles" : 1
	},
	"neutralTowns" : {
		"towns" : 1
	},
	"townsAreSameType" : true,
	"monsters" : "normal",

	"terrainTypes" : [ "sand" ],
	"matchTerrainToTown" : false,

	"minesLikeZone" : 1,
	"treasureLikeZone" : 1
	"terrainTypeLikeZone" : 3

	"mines" : {
		"wood" : 1,
		"ore" : 1,
	},

	"treasure" : [
		{
			"min" : 2100,
			"max": 3000,
			"density" : 5
		}
		  ...
	]
}