Web API serving pathfinding requests
| Route | Method | Description |
|---|---|---|
| /path | POST | Path generation request |
| /select | GET | Returns selection of data points that should be transmitted as gamestate |
| /metrics | GET | Exposes prometheus metrics |
Example body (2771, 2794, 0) -> (3213, 3427, 0)
{
"start": { "x": 2771, "y": 2794, "plane": 0 },
"end": { "x": 3213, "y": 3427, "plane": 0 },
"game_state": {
"member": true,
"skills": { "MAGIC": 25 },
"varps": {
"273": 110
},
"items": {
"Air rune": 3,
"Fire rune": 1,
"Law rune": 1
}
}
}Legal Coordinates are in the range (0, 0, 0)..(6400, 12800, 4) (exclusive).
game_state is elaborated in more detail below.
Example response
[
{
"Edge": {
"type": "SpellTeleport",
"spell": "Varrock Teleport"
}
},
{
"Step": { "x": 3213, "y": 3425, "plane": 0 }
},
{
"Step": { "x": 3212, "y": 3426, "plane": 0 }
},
{
"Step": { "x": 3213, "y": 3427, "plane": 0 }
}
]If the response code is 200 OK, the response can be parsed as a JSON Array of Steps. The
array is null in case no path could be found.
For the sake of privacy and saving resources, this resource offers the exact data points needed for evaluating all edges during pathfinding.
For example only few varp values are needed like quest varps to evaluate individual shortcuts, transmitting every single varp value would be a waste.
The game_state variable transmitted in pathfinding requests and all of its fields or values are optional, but the
closer all data points from /select are included, the better the results.
Example response
{
"varps": [
273
],
"varbits": [],
"items": [
"Law rune",
"Fire rune",
"Varrock teleport",
"Air rune",
"Ring of dueling\\(\\d\\)",
"Coins"
],
"skills": [
"agility",
"magic"
]
}USAGE:
webservice --navgrid <NAVGRID>
OPTIONS:
-h, --help Print help information
-n, --navgrid <NAVGRID> Path to NavGrid file
Use generator to generate a NavGrid file
Refer to https://rocket.rs/v0.5-rc/guide/configuration/ for documentation on how to configure the server