Status payload
The body of POST /api/v1/status, schema vw.status/1. Send it as often as the reply says: every 2 s while someone watches the character, every 30 s otherwise. Fields you do not know stay out; the dashboard shows what it gets.
| Field | Type | Description |
|---|---|---|
schema | "vw.status/1" | Payload schema and version |
modulerequired | string | Name and version of the sending module, for example voidwatch-feed/0.5.2up to 40 characters |
onlinerequired | boolean | The character is logged in |
characterrequired | Character | |
character.namerequired | string | Character nameup to 30 characters |
character.vocation | string | Vocation, for example Elite Knightup to 30 characters |
character.levelrequired | integer | ≥ 1, ≤ 5000 |
character.exprequired | integer | Total experience points≥ 0 |
posrequired | Position | |
pos.xrequired | integer | Map x≥ 0, ≤ 65535 |
pos.yrequired | integer | Map y≥ 0, ≤ 65535 |
pos.zrequired | integer | Floor, 0 to 15; 7 is ground level≥ 0, ≤ 15 |
cap | integer | Free capacity, in oz≥ 0 |
stamina | integer | Stamina, in minutes≥ 0, ≤ 2520 |
expPerHour | integer | Exp per hour as the client measures it≥ 0 |
route | string | The loaded cavebot routeup to 80 characters |
routeOn | boolean | The cavebot is running |
label | string | The route label the bot is atup to 40 characters |
phase | "hunting" | "to_city" | "in_city" | "to_resp" | "parked" | "stopped" | "unknown" | "town" | "at_check" | "leaving" | Where the character is in its route, from the labels hunt, refill, city and resp: unknown when a label is missing. town, at_check and leaving come from bot adapters before version 4 |
labelsMissing | string[] | Route parts without a label. check and leave come from bot adapters before version 4up to 4 items |
plan | PlanState | The bot's plan: a command that acts when the bot reaches a label. An ended plan stays for two minutes |
plan.id | integer | The command that started the plan |
plan.kindrequired | "refill" | "go_depot" | "load_route" | |
plan.route | string | The route a switch loadsup to 80 characters |
plan.staterequired | "running" | "done" | "stuck" | "cancelled" | "taken_over" | "failed" | |
plan.step | "hunt" | "city" | "depot" | "switch" | What the running plan waits for |
plan.message | string | up to 200 characters |
plan.since | integer | Unix seconds when the plan started |
plan.until | integer | Unix seconds when the waiting step gives up as stuck |
plan.ended | integer | Unix seconds when the plan ended |
routes | string[] | Every route the bot can loadup to 100 items |
supplies | SupplyItem[] | up to 60 items |
supplies[].namerequired | string | Item name, as the game writes itup to 60 characters |
supplies[].haverequired | integer | How many the character carries, closed bags included where the game said≥ 0 |
supplies[].want | integer | How many the bot keeps in stock; missing when the list comes from the use lines≥ 0 |
suppliesSource | string | bot: the bot's own supply list; used: every item the game's use lines namedup to 20 characters |
tasks | TaskItem[] | up to 10 items |
tasks[].namerequired | string | Item or creature name, as the game writes itup to 60 characters |
tasks[].haverequired | integer | How many the character has now≥ 0 |
tasks[].wantrequired | integer | How many the bot keeps in stock, or the task goal≥ 0 |
tasks[].exp | integer | Exp reward for the goal, if the server says≥ 0 |
tasks[].taskPoints | integer | Task points for the goal, if the server has them≥ 0 |
taskPoints | integer | The task points balance, on servers with task points≥ 0 |
taskWeek | TaskWeek | Task points this week, on servers with a weekly cap |
taskWeek.earnedrequired | integer | Task points earned this week≥ 0 |
taskWeek.caprequired | integer | The most task points a week allows≥ 0 |
loot | LootItem[] | up to 200 items |
loot[].namerequired | string | Item nameup to 60 characters |
loot[].countrequired | integer | Looted since the session started≥ 0 |
loot[].sell | integer | NPC price per item, if the module knows it. The server fills it in otherwise≥ 0 |
used | UsedItem[] | Supplies used since the loot counter startedup to 200 items |
used[].namerequired | string | Item nameup to 60 characters |
used[].countrequired | integer | Used since the counter started≥ 0 |
used[].buy | integer | NPC buy price per item, if the module knows it≥ 0 |
lootHours | number | Hours since the loot counter started≥ 0 |
lootSource | string | Where the loot count comes from: corpse, the loot messages every server sends, or the id of an adapter such as an autolootup to 40 characters |
skulls | Skull[] | Skulled players in viewup to 20 items |
skulls[].namerequired | string | Player nameup to 30 characters |
skulls[].skullrequired | "white" | "red" | "black" | "yellow" | "green" | "orange" | Skull colour |
skulls[].dist | integer | Squares away from the character≥ 0, ≤ 100 |
blessed | boolean | Only on servers with blessings |
pz | boolean | The character stands in a protection zone |
pzLock | boolean | The character is PZ locked: it cannot enter a protection zone |
outfit | Outfit | The character's look, drawn on the map |
outfit.typerequired | integer | The look type≥ 0, ≤ 10000 |
outfit.head | integer | ≥ 0, ≤ 255 |
outfit.body | integer | ≥ 0, ≤ 255 |
outfit.legs | integer | ≥ 0, ≤ 255 |
outfit.feet | integer | ≥ 0, ≤ 255 |
outfit.addons | integer | ≥ 0, ≤ 3 |
skull | "white" | "red" | "black" | "yellow" | "green" | "orange" | The character's own skull, if it has one |
playersInView | integer | Other players in view≥ 0, ≤ 500 |
redemption | boolean | Only on servers with death redemption: it is active now |
redemptionLeft | integer | Only on servers with redemption≥ 0 |
targetOn | boolean | The targeting bot is running |
botConfig | string | The bot preset, for example vBot_4.8up to 60 characters |
targetProfile | string | The loaded targeting profileup to 80 characters |
botProfile | integer | The bot settings profile, for example vBot's 1 to 5≥ 1, ≤ 20 |
adapters | AdapterState[] | The adapters the module runs, and whether each is onup to 30 items |
adapters[].idrequired | string | Adapter id, for example orion-ots-tasks or botup to 40 characters |
adapters[].version | string | up to 20 characters |
adapters[].onrequired | boolean | False: the adapter stopped after errors, or the bot stopped attaching |
adapters[].want | string | For the bot adapter: the version the module ships. A lower version waits for a bot reloadup to 20 characters |
addons | AddonState[] | The addons in the data folder, and whether each runsup to 30 items |
addons[].idrequired | string | Addon id, for example exiva-map |
addons[].version | string | The module version the addon came withup to 20 characters |
addons[].onrequired | boolean | Loaded now |
addons[].error | string | Why it is not loaded: installing, the download failed, or its last errorup to 200 characters |
features | string[] | What the module runs, for example status, captures and commands. The dashboard turns off what is not listed. Left out: everythingup to 20 items |
actions | string[] | The command actions this client can run now, for example toggle_cavebot. The dashboard offers only theseup to 40 items |
settingsChange | object | A change from the Settings tab of the Voidwatch window: {rev, values}. The values follow the rules of the Clients page. A bad value never refuses the status: settingsSaved in the reply says why |
Example
{
"schema": "vw.status/1",
"module": "voidwatch-feed/0.5.2",
"online": true,
"character": {
"name": "Franz Kafka",
"vocation": "Royal Paladin",
"level": 589,
"exp": 3380000000
},
"pos": {
"x": 32376,
"y": 31779,
"z": 7
},
"cap": 8568,
"stamina": 2502,
"expPerHour": 14998739,
"route": "[afk] fu.exodar HH",
"routeOn": true,
"label": "hunt",
"routes": [
"[afk] fu.exodar HH",
"UD & HH Left"
],
"supplies": [
{
"name": "great spirit potion",
"have": 3498,
"want": 4000
}
],
"tasks": [
{
"name": "hellhound",
"have": 578,
"want": 1000
}
],
"loot": [
{
"name": "fire sword",
"count": 192
}
],
"lootHours": 2.4,
"skulls": []
}Versions
The schema name carries the version. A new field keeps the version; a changed or removed field gets a new one, and the old version keeps working for at least six months.