Soup 10 is a game for programmers. The game is implemented as a REST API - to play YOU write the frontend in whatever form you like - a GUI application, a python script, or even manually via cUrl. The goal is to survive for as long as possible in a hostile environment.
View the public API
Server: https://soup10game.com
First, register your Player by issuing a POST request to the /register endpoint with a Player body:
{
"name": string,
"author": string,
"email": string
}
All three fields are mandatory. An example:{
"name": "MyAwesomeSoupBot",
"author": "me",
"email": "me@there.com"
}
The server will respond with a playerId, like this:{
"id": "fee41e1e-1b8d-473e-a947-778209249a76"
}
This value should be saved as it is required to create and play games.
Next, issue a GET request to the /info endpoint to see what scenarios are available to play. The server will respond with an Info body, like this:{
"scenarios": [
{
"id": "dff69d2f-1b8d-473e-a947-978645321g22",
"name": "Test Scenario",
"description": "A very simple and easy scenario. You start with full health in a safe part of the arena"
},
{
"id": "hji82f4n-3n6a-652l-d782-135798427h342",
"name": "The Island",
"description": "A much larger arena with a challenging landscape"
}
]
}
Note the id of the scenario you'd like to play - you need to provide it when creating a new game.
Finally, issue a POST request to the /new endpoint with a NewGameBody, like this:{The server will respond with a
"playerId": "fee41e1e-1b8d-473e-a947-778209249a76",
"scenarioId": "hji82f4n-3n6a-652l-d782-135798427h342"
}GameState body, like this:{
"gameId": "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"playerId": "fee41e1e-1b8d-473e-a947-778209249a76",
"scenarioId": "hji82f4n-3n6a-652l-d782-135798427h342",
"turnId": 0,
"state": "running",
"health": 20,
"maxHealth": 20,
"abilities": [
"Mountaineering"
],
"easting": -8,
"northing": 21,
"actionCount": 0,
"view": [
{
"easting": -10,
"northing": 23,
"landtype": "Plain",
"food": 0,
"item": ""
},
...
]
}
You will need to include the gameId and playerId fields in all future requests to the server.
To take a turn, issue a POST request to the /turn endpoint with a Turn body, like this:{
"gameId": "0729a580-2240-11e6-9eb5-0002a5d5c51b",
"playerId": "9217a085-4429-23f5-8n12-1236b5c4v72s",
"steps": [
"MoveNorth",
"Eat"
]
}
The steps array is a list of actions for the Player to take during the turn. The array can be any length, but the server will process only the first stepsPerTurn items.
The currently defined actions are:
On successful completion of the turn, the server will respond with an updated GameState. You can continue to take turns until the Player health reaches zero and the game concludes.
Recent changes: