Create game API - Revision history

Fizzer at 02:35, 18 April 2026

2026-04-18T02:35:55Z

Fizzer at 22:21, 9 November 2024

2024-11-09T22:21:07Z

← Older revision		Revision as of 22:21, 9 November 2024
Line 31:		Line 31:
	* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:		* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:
	** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.		** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.
	** player token: The token identifies the player you're inviting, or the string "~~OpenSeat~~". Players can find their token by visiting https://www.warzone.com/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting, the string "OpenSeat", or the string "AI". Players can find their token by visiting https://www.warzone.com/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's Warzone know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's Warzone know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.
	* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.		* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.

DanWL60: /* Specify Bonus Values */

2023-11-10T09:54:50Z

Specify Bonus Values

← Older revision		Revision as of 09:54, 10 November 2023
Line 73:		Line 73:
	Values specified here will replace any values specified by the template in use.		Values specified here will replace any values specified by the template in use.

	Typically you will specify bonuses by name as shown above. However, if a map has multiple bonuses with the same name, you can specify a "bonusID" attribute instead of the "bonusName" attribute shown above. To find the ID of a bonus, use the [[~~Game Feed~~ API]] on a game using the same map.		Typically you will specify bonuses by name as shown above. However, if a map has multiple bonuses with the same name, you can specify a "bonusID" attribute instead of the "bonusName" attribute shown above. To find the ID of a bonus, use the [[Query game API]] on a game using the same map.

	== Open Seats ==		== Open Seats ==

Fizzer at 03:39, 13 November 2017

2017-11-13T03:39:30Z

Fizzer at 22:30, 5 February 2016

2016-02-05T22:30:32Z

← Older revision		Revision as of 22:30, 5 February 2016
Line 19:		Line 19:
	{ token: "123456789" team: "None" },		{ token: "123456789" team: "None" },
	{ token: "13453531543" team: "None" }		{ token: "13453531543" team: "None" }
	]		],
			settings: { ... }
	}		}

Line 25:		Line 26:

	* hostEmail / hostAPIToken: These elements identify you. You can get your APIToken from the [[Get API Token API]]. The game will be recorded as created by you.		* hostEmail / hostAPIToken: These elements identify you. You can get your APIToken from the [[Get API Token API]]. The game will be recorded as created by you.
	* templateID: This specifies the ID of a template that you create through the normal game GUI. You can either use a built-in template or you can create your own. It does not matter if you ~~create~~ a single-player or multi-player template.		* templateID: This specifies the ID of a template that you create through the normal game GUI. You can either use a built-in template or you can create your own. It does not matter if you choose a single-player or multi-player template. This is optional -- if not specified, the "Normal Game" template will be used.
	* gameName: This will show up as the name of the game. Maximum 50 characters.		* gameName: This will show up as the name of the game. Maximum 50 characters.
	* personalMessage: This will show up in the Lobby as well as the Settings. Maximum 1024 characters.		* personalMessage: This will show up in the Lobby as well as the Settings. Maximum 1024 characters.
Line 32:		Line 33:
	** player token: The token identifies the player you're inviting, or the string "OpenSeat". Players can find their token by visiting https://www.warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting, or the string "OpenSeat". Players can find their token by visiting https://www.warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.
			* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.

	==Output==		==Output==

Fizzer at 06:14, 3 February 2016

2016-02-03T06:14:39Z

← Older revision		Revision as of 06:14, 3 February 2016
Line 30:		Line 30:
	* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:		* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:
	** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.		** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.
	** player token: The token identifies the player you're inviting. Players can find their token by visiting https://www.warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting, or the string "OpenSeat". Players can find their token by visiting https://www.warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.

Fizzer at 05:37, 3 February 2016

2016-02-03T05:37:09Z

← Older revision		Revision as of 05:37, 3 February 2016
Line 79:		Line 79:
	== Level Restriction ==		== Level Restriction ==

	When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses ~~16% luck modifier~~, then all players must have unlocked the ability to create games using the ~~16% or lower luck modifier~~.		When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses the spy card, then all players must have unlocked the ability to create games using the spy card.

	This restriction exists to prevent players from bypassing WarLight's member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.		This restriction exists to prevent players from bypassing WarLight's member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.

Fizzer at 23:57, 18 December 2014

2014-12-18T23:57:03Z

← Older revision		Revision as of 23:57, 18 December 2014
Line 5:		Line 5:
	Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.		Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.

	To create games via the API, you must POST some JSON to ~~http~~://warlight.net/API/CreateGame that contains the details about the game you're creating. Here's an example:		To create games via the API, you must POST some JSON to https://www.warlight.net/API/CreateGame that contains the details about the game you're creating. Here's an example:


Line 30:		Line 30:
	* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:		* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:
	** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.		** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.
	** player token: The token identifies the player you're inviting. Players can find their token by visiting ~~http~~://warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting. Players can find their token by visiting https://www.warlight.net/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's WarLight know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.

Fizzer at 11:09, 8 September 2013

2013-09-08T11:09:05Z

← Older revision		Revision as of 11:09, 8 September 2013
Line 77:		Line 77:
	You may pass the string "OpenSeat" in place of the invite token of a player. This will make that spot an open seat, and the game will be advertised on the Open Games tab along with other open games. When using open seats via this API, a member-only prerequisite will automatically be set on the game.		You may pass the string "OpenSeat" in place of the invite token of a player. This will make that spot an open seat, and the game will be advertised on the Open Games tab along with other open games. When using open seats via this API, a member-only prerequisite will automatically be set on the game.

	== ~~Member~~ Restriction ==		== Level Restriction ==

	~~Member-only features (such as custom scenarios, luck levels below 75%, etc.) can only be used in~~ games ~~created by the Create Game~~ API if all players being invited to the game ~~are members (or otherwise~~ have access to ~~the feature~~, ~~such as~~ if ~~they made~~ the ~~map that's in use~~.)		When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses 16% luck modifier, then all players must have unlocked the ability to create games using the 16% or lower luck modifier.

	This restriction exists to prevent players from bypassing WarLight's member restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.		This restriction exists to prevent players from bypassing WarLight's member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.

	If you create a game that uses a member-only feature, such as a low luck level, and invite non-members, the game will simply revert to using 75% luck. This allows you to freely create games without having to worry about this restriction -- the created games will use low luck when the can, and 75% luck when they can't.		If you want to ensure that everyone you're inviting has access to the features you want to use, call the [[Validate invite token API]] and pass your template ID.

	If you want to ensure that everyone you're inviting ~~is a member~~, call the [[Validate invite token API]] and ~~check the isMember flag~~.

	== Black List Restriction ==		== Black List Restriction ==

Fizzer at 03:04, 8 May 2013

2013-05-08T03:04:59Z

← Older revision		Revision as of 03:04, 8 May 2013
Line 72:		Line 72:

	Typically you will specify bonuses by name as shown above. However, if a map has multiple bonuses with the same name, you can specify a "bonusID" attribute instead of the "bonusName" attribute shown above. To find the ID of a bonus, use the [[Game Feed API]] on a game using the same map.		Typically you will specify bonuses by name as shown above. However, if a map has multiple bonuses with the same name, you can specify a "bonusID" attribute instead of the "bonusName" attribute shown above. To find the ID of a bonus, use the [[Game Feed API]] on a game using the same map.

			== Open Seats ==

			You may pass the string "OpenSeat" in place of the invite token of a player. This will make that spot an open seat, and the game will be advertised on the Open Games tab along with other open games. When using open seats via this API, a member-only prerequisite will automatically be set on the game.

	== Member Restriction ==		== Member Restriction ==
Line 83:		Line 87:
	If you want to ensure that everyone you're inviting is a member, call the [[Validate invite token API]] and check the isMember flag.		If you want to ensure that everyone you're inviting is a member, call the [[Validate invite token API]] and check the isMember flag.

	== ~~Open Seats~~ ==		== Black List Restriction ==

	~~You may pass the string "OpenSeat" in place of the~~ invite ~~token of~~ a ~~player~~. This ~~will make that spot an open seat, and~~ the game ~~will be advertised on~~ the ~~Open Games tab along with other open games~~. ~~When using open seats via this API~~, a ~~member-only prerequisite will automatically be set on~~ the ~~game~~.		This API cannot invite someone who to a game who has you on their black list. This differs from the behavior of normally creating a game via the game's UI. This restriction exists in order to prevent some run-away code (either due to a bug or malicious user), from inviting someone to an excessive number of games that they don't want. This gives a way for players to forcibly stop the code from creating new games with them.

	==See Also==		==See Also==

← Older revision		Revision as of 02:35, 18 April 2026
Line 1:		Line 1:
	The CreateGame API will create multi-player ~~Warzone~~ games programmatically. You can specify the game settings, game name, and what players are invited to the game.		The CreateGame API will create multi-player War.app games programmatically. You can specify the game settings, game name, and what players are invited to the game.

	==Usage==		==Usage==
Line 5:		Line 5:
	Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.		Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.

	To create games via the API, you must POST some JSON to https://www.~~warzone~~.~~com~~/API/CreateGame that contains the details about the game you're creating. Here's an example:		To create games via the API, you must POST some JSON to https://www.war.app/API/CreateGame that contains the details about the game you're creating. Here's an example:


Line 31:		Line 31:
	* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:		* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:
	** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.		** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.
	** player token: The token identifies the player you're inviting, the string "OpenSeat", or the string "AI". Players can find their token by visiting https://www.~~warzone~~.~~com~~/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting, the string "OpenSeat", or the string "AI". Players can find their token by visiting https://www.war.app/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's ~~Warzone~~ know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's War.app know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.
	* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.		* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.

Line 83:		Line 83:
	When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses the spy card, then all players must have unlocked the ability to create games using the spy card.		When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses the spy card, then all players must have unlocked the ability to create games using the spy card.

	This restriction exists to prevent players from bypassing ~~Warzone~~'s member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.		This restriction exists to prevent players from bypassing War.app's member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.

	If you want to ensure that everyone you're inviting has access to the features you want to use, call the [[Validate invite token API]] and pass your template ID.		If you want to ensure that everyone you're inviting has access to the features you want to use, call the [[Validate invite token API]] and pass your template ID.

← Older revision		Revision as of 03:39, 13 November 2017
Line 1:		Line 1:
	The CreateGame API will create multi-player ~~WarLight~~ games programmatically. You can specify the game settings, game name, and what players are invited to the game.		The CreateGame API will create multi-player Warzone games programmatically. You can specify the game settings, game name, and what players are invited to the game.

	==Usage==		==Usage==
Line 5:		Line 5:
	Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.		Using this can allow you to create a program that hosts your own tournaments or ladder-type systems.

	To create games via the API, you must POST some JSON to https://www.~~warlight~~.~~net~~/API/CreateGame that contains the details about the game you're creating. Here's an example:		To create games via the API, you must POST some JSON to https://www.warzone.com/API/CreateGame that contains the details about the game you're creating. Here's an example:


Line 31:		Line 31:
	* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:		* players: This node defines the players that will be invited. It consists of 'player' elements, each of which contains a 'token' attribute and a 'team' attribute:
	** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.		** player team: This can be the string 'None' if you're not creating a team game. If you are creating a team game, then supply a number for each player identifying the team that they're on. 0 is team A, 1 is team B, 2 is team C, etc.
	** player token: The token identifies the player you're inviting, or the string "OpenSeat". Players can find their token by visiting https://www.~~warlight~~.~~net~~/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.		** player token: The token identifies the player you're inviting, or the string "OpenSeat". Players can find their token by visiting https://www.warzone.com/InviteToken. The invite token is the same as the number displayed in the address bar when you view a player's profile page.
	** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's ~~WarLight~~ know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.		** slot: If you're making a game that uses a custom scenario, you must also provide a "slot" attribute on each player that let's Warzone know what scenario to give this player. This should be an integer, where 0 is slot A, 1 is slot B, 2 is slot C, etc.
	* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.		* settings: Optionally, you can provide settings to customize the template you specified above. To see a full list of settings, use the [[Query game API]] with GetSettings=true.

Line 83:		Line 83:
	When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses the spy card, then all players must have unlocked the ability to create games using the spy card.		When creating games via this API, all players that are being invited to the game must have access to all features that your game uses. For example, if you want to create a game that uses the spy card, then all players must have unlocked the ability to create games using the spy card.

	This restriction exists to prevent players from bypassing ~~WarLight~~'s member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.		This restriction exists to prevent players from bypassing Warzone's member and level restrictions completely. For example, if this restriction did not exist, someone could make a website that allowed any non-member to create a game for themselves using all of the member-only features.

	If you want to ensure that everyone you're inviting has access to the features you want to use, call the [[Validate invite token API]] and pass your template ID.		If you want to ensure that everyone you're inviting has access to the features you want to use, call the [[Validate invite token API]] and pass your template ID.