Editing Query game API
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | WarLight can provide programmatic access to the details about multi-player WarLight games. This allows for the more technical users to write a program that can analyze information about games. Currently, this data is only available for finished ladder and tournament games. | |
There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games. | There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games. | ||
− | |||
− | |||
==Usage== | ==Usage== | ||
− | To access the data, use a URL like this: | + | To access the data, use a URL like this: http://warlight.net/API/GameFeed?GameID=1212978 |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | If you want to get | + | This will return data describing basic details about the game. If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game. |
==JSON Definition== | ==JSON Definition== | ||
Line 48: | Line 40: | ||
* Booted: This player was booted from the game. | * Booted: This player was booted from the game. | ||
* Won: This player has won the game. This state will only be present in games that have finished. | * Won: This player has won the game. This state will only be present in games that have finished. | ||
− | * | + | * VotedToEnd: This player, along with the other remaining players in the game, have voted to end the game. |
* Declined: This player declined the game and did not play. | * Declined: This player declined the game and did not play. | ||
* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players. | * RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players. | ||
+ | |||
+ | Each finished game is guaranteed to have at least one player with a Won state or a VotedToEnd state. | ||
==Getting a list of Game IDs== | ==Getting a list of Game IDs== | ||
− | In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical | + | In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical WarLight client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number. |
To find game IDs programmatically, you can use the [[Game ID feed API]]. | To find game IDs programmatically, you can use the [[Game ID feed API]]. |