Set map details API - Revision history

Fizzer at 02:35, 18 April 2026

2026-04-18T02:35:53Z

← Older revision		Revision as of 02:35, 18 April 2026
Line 1:		Line 1:
	The '''set map details API''' can be used by map creators to assist in creating their [[map]]. This API can do the things that the built-in ~~Warzone~~ map UI can do, such as setting [[Territories\|territory]] names, setting territory center points, defining the connections between territories, etc.		The '''set map details API''' can be used by map creators to assist in creating their [[map]]. This API can do the things that the built-in War.app map UI can do, such as setting [[Territories\|territory]] names, setting territory center points, defining the connections between territories, etc.

	== Preparation ==		== Preparation ==
Line 5:		Line 5:
	To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	https://www.~~warzone~~.~~com~~/play?PreviewMap=5859		https://www.war.app/play?PreviewMap=5859

	The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.		The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.
Line 11:		Line 11:
	==Usage==		==Usage==

	To enter the details of your map without using the UI, you POST some JSON to https://www.~~warzone~~.~~com~~/API/SetMapDetails		To enter the details of your map without using the UI, you POST some JSON to https://www.war.app/API/SetMapDetails

	The beginning of the JSON should look like this:		The beginning of the JSON should look like this:
Line 27:		Line 27:


	Your ~~Warzone~~ account's e-mail address and API token are always required, as is the map ID you're modifying. You may get your API token using the [[Get API Token API]]. You may only enter the ID of a map you own, and the map must be in development mode (the same restrictions apply to editing the map with the UI.)		Your War.app account's e-mail address and API token are always required, as is the map ID you're modifying. You may get your API token using the [[Get API Token API]]. You may only enter the ID of a map you own, and the map must be in development mode (the same restrictions apply to editing the map with the UI.)

	Note that after updating a map with the API, your browser may need to be refreshed to see the changes reflected in the UI.		Note that after updating a map with the API, your browser may need to be refreshed to see the changes reflected in the UI.
Line 53:		Line 53:
	{ command: 'addTerritoryConnection', id1: 56, id2:78, wrap: "WrapHorizontally" }		{ command: 'addTerritoryConnection', id1: 56, id2:78, wrap: "WrapHorizontally" }

	Specify the two territory IDs as id1 and id2 attributes. It does not matter which territory is 1 and which is 2, since all connections in ~~Warzone~~ are two-way.		Specify the two territory IDs as id1 and id2 attributes. It does not matter which territory is 1 and which is 2, since all connections in War.app are two-way.

	As the wrap attribute, specify either Normal, WrapHorizontally, or WrapVertically to tell ~~Warzone~~ whether or not the connections wrap around the edge of the map.		As the wrap attribute, specify either Normal, WrapHorizontally, or WrapVertically to tell War.app whether or not the connections wrap around the edge of the map.

	Connections cannot be removed via the API, only added. If you accidentally add a mistaken connection, it can be removed through the UI or you can delete the map and start over.		Connections cannot be removed via the API, only added. If you accidentally add a mistaken connection, it can be removed through the UI or you can delete the map and start over.

Fizzer at 21:15, 10 March 2025

2025-03-10T21:15:07Z

← Older revision		Revision as of 21:15, 10 March 2025
Line 65:		Line 65:
	Adding a [[bonus]] is similar to clicking the "Add new Bonus" button. The new bonus will initially have no territories assigned, but you can use addTerritoryToBonus below to add territories.		Adding a [[bonus]] is similar to clicking the "Add new Bonus" button. The new bonus will initially have no territories assigned, but you can use addTerritoryToBonus below to add territories.

	The armies attribute specifies how many armies per turn the bonus is worth, and the color attribute supports six hex characters is in the format #RRGGBB. The hash sign must be included and all six characters must be specified.		The armies attribute specifies how many armies per turn the bonus is worth, and the color attribute supports six hex characters is in the format #RRGGBB. The hash sign must be included and all six characters must be specified. If you don't want the bonus color to affect its territories at all, you may omit the color attribute completely.

	===Add Territory to Bonus===		===Add Territory to Bonus===

JK 3: Fixed wrong example (keys were not strings, but they should be)

2022-12-24T02:58:51Z

Fixed wrong example (keys were not strings, but they should be)

← Older revision		Revision as of 02:58, 24 December 2022
Line 18:		Line 18:

	{		{
	email: 'your@email.com',		"email": "your@email.com",
	APIToken: 'yourapitoken',		"APIToken": "yourapitoken",
	mapID: 5859,		"mapID": 5859,
	commands: [		"commands": [
	]		]
	}		}

Fizzer at 03:39, 13 November 2017

2017-11-13T03:39:42Z

← Older revision		Revision as of 03:39, 13 November 2017
Line 1:		Line 1:
	The '''set map details API''' can be used by map creators to assist in creating their [[map]]. This API can do the things that the built-in ~~WarLight~~ map UI can do, such as setting [[Territories\|territory]] names, setting territory center points, defining the connections between territories, etc.		The '''set map details API''' can be used by map creators to assist in creating their [[map]]. This API can do the things that the built-in Warzone map UI can do, such as setting [[Territories\|territory]] names, setting territory center points, defining the connections between territories, etc.

	== Preparation ==		== Preparation ==
Line 5:		Line 5:
	To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	https://www.~~warlight~~.~~net~~/play?PreviewMap=5859		https://www.warzone.com/play?PreviewMap=5859

	The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.		The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.
Line 11:		Line 11:
	==Usage==		==Usage==

	To enter the details of your map without using the UI, you POST some JSON to https://www.~~warlight~~.~~net~~/API/SetMapDetails		To enter the details of your map without using the UI, you POST some JSON to https://www.warzone.com/API/SetMapDetails

	The beginning of the JSON should look like this:		The beginning of the JSON should look like this:
Line 27:		Line 27:


	Your ~~WarLight~~ account's e-mail address and API token are always required, as is the map ID you're modifying. You may get your API token using the [[Get API Token API]]. You may only enter the ID of a map you own, and the map must be in development mode (the same restrictions apply to editing the map with the UI.)		Your Warzone account's e-mail address and API token are always required, as is the map ID you're modifying. You may get your API token using the [[Get API Token API]]. You may only enter the ID of a map you own, and the map must be in development mode (the same restrictions apply to editing the map with the UI.)

	Note that after updating a map with the API, your browser may need to be refreshed to see the changes reflected in the UI.		Note that after updating a map with the API, your browser may need to be refreshed to see the changes reflected in the UI.
Line 53:		Line 53:
	{ command: 'addTerritoryConnection', id1: 56, id2:78, wrap: "WrapHorizontally" }		{ command: 'addTerritoryConnection', id1: 56, id2:78, wrap: "WrapHorizontally" }

	Specify the two territory IDs as id1 and id2 attributes. It does not matter which territory is 1 and which is 2, since all connections in ~~WarLight~~ are two-way.		Specify the two territory IDs as id1 and id2 attributes. It does not matter which territory is 1 and which is 2, since all connections in Warzone are two-way.

	As the wrap attribute, specify either Normal, WrapHorizontally, or WrapVertically to tell ~~WarLight~~ whether or not the connections wrap around the edge of the map.		As the wrap attribute, specify either Normal, WrapHorizontally, or WrapVertically to tell Warzone whether or not the connections wrap around the edge of the map.

	Connections cannot be removed via the API, only added. If you accidentally add a mistaken connection, it can be removed through the UI or you can delete the map and start over.		Connections cannot be removed via the API, only added. If you accidentally add a mistaken connection, it can be removed through the UI or you can delete the map and start over.

DanWL60: More links, updated the url of previewing maps.

2015-01-18T20:34:41Z

More links, updated the url of previewing maps.

← Older revision		Revision as of 20:34, 18 January 2015
Line 1:		Line 1:
	The '''set map details API''' can be used by map creators to assist in creating their map. This API can do the things that the built-in WarLight map UI can do, such as setting territory names, setting territory center points, defining the connections between territories, etc.		The '''set map details API''' can be used by map creators to assist in creating their [[map]]. This API can do the things that the built-in WarLight map UI can do, such as setting [[Territories\|territory]] names, setting territory center points, defining the connections between territories, etc.

	== Preparation ==		== Preparation ==
Line 5:		Line 5:
	To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	https://www.warlight.net/~~SinglePlayer~~?PreviewMap=5859		https://www.warlight.net/play?PreviewMap=5859

	The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.		The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.
Line 63:		Line 63:
	{ command: 'addBonus', name: "South America", armies: 4, color: "#DD0000" }		{ command: 'addBonus', name: "South America", armies: 4, color: "#DD0000" }

	Adding a bonus is similar to clicking the "Add new Bonus" button. The new bonus will initially have no territories assigned, but you can use addTerritoryToBonus below to add territories.		Adding a [[bonus]] is similar to clicking the "Add new Bonus" button. The new bonus will initially have no territories assigned, but you can use addTerritoryToBonus below to add territories.

	The armies attribute specifies how many armies per turn the bonus is worth, and the color attribute supports six hex characters is in the format #RRGGBB. The hash sign must be included and all six characters must be specified.		The armies attribute specifies how many armies per turn the bonus is worth, and the color attribute supports six hex characters is in the format #RRGGBB. The hash sign must be included and all six characters must be specified.
Line 80:		Line 80:
	Just like making a bonus, this creates an empty distribution mode just as if you clicked "Add new Distribution" in the UI.		Just like making a bonus, this creates an empty distribution mode just as if you clicked "Add new Distribution" in the UI.

	There are two types: Normal and Scenario distributions. To create a normal distribution, just specify a name, as is shown in the first example above.		There are two types: [[Normal Distribution\|Normal]] and [[Scenario distributions]]. To create a normal distribution, just specify a name, as is shown in the first example above.

	The second example shows how to create a scenario distribution. When creating a scenario distribution, also specify the name of each scenario. There must be at least two scenarios defined, although there can be more.		The second example shows how to create a scenario distribution. When creating a scenario distribution, also specify the name of each scenario. There must be at least two scenarios defined, although there can be more.
Line 94:		Line 94:
	To add a territory to a scenario distribution, as is shown in the second example, specify the territory id, distribution name, and scenario name.		To add a territory to a scenario distribution, as is shown in the second example, specify the territory id, distribution name, and scenario name.


	[[Category:API]]		[[Category:API]]

Fizzer at 01:26, 19 December 2014

2014-12-19T01:26:45Z

← Older revision		Revision as of 01:26, 19 December 2014
Line 5:		Line 5:
	To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	~~http~~://warlight.net/SinglePlayer?PreviewMap=5859		https://www.warlight.net/SinglePlayer?PreviewMap=5859

	The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.		The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.
Line 11:		Line 11:
	==Usage==		==Usage==

	To enter the details of your map without using the UI, you POST some JSON to ~~http~~://warlight.net/API/SetMapDetails		To enter the details of your map without using the UI, you POST some JSON to https://www.warlight.net/API/SetMapDetails

	The beginning of the JSON should look like this:		The beginning of the JSON should look like this:

Fizzer at 09:00, 30 July 2013

2013-07-30T09:00:10Z

← Older revision		Revision as of 09:00, 30 July 2013
Line 11:		Line 11:
	==Usage==		==Usage==

	To enter the details of your map without using the UI, you POST some JSON to http://warlight.net/API/SetMapDetails~~.aspx~~		To enter the details of your map without using the UI, you POST some JSON to http://warlight.net/API/SetMapDetails

	The beginning of the JSON should look like this:		The beginning of the JSON should look like this:

Fizzer at 19:35, 29 July 2013

2013-07-29T19:35:23Z

← Older revision		Revision as of 19:35, 29 July 2013
Line 5:		Line 5:
	To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	http://warlight.net/SinglePlayer~~.aspx~~?PreviewMap=5859		http://warlight.net/SinglePlayer?PreviewMap=5859

	The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.		The number at the end of the URL is your map ID. In the example shown, the map ID is 5859.

Fizzer at 15:14, 17 September 2012

2012-09-17T15:14:02Z

Show changes

Fizzer at 05:34, 28 November 2011

2011-11-28T05:34:18Z

← Older revision		Revision as of 05:34, 28 November 2011
Line 3:		Line 3:
	==Preparation==		==Preparation==

	To use the API, you must first have uploaded your SVG file via [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:		To use the API, you must first have uploaded your SVG file via the [[Map Making\|normal process]]. After it's uploaded, click the button named "Get link for sharing" and you'll get a URL such as:

	http://warlight.net/SinglePlayer.aspx?PreviewMap=5859		http://warlight.net/SinglePlayer.aspx?PreviewMap=5859