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.

FieldTypeDescription
schema"vw.status/1"Payload schema and version
modulerequiredstringName and version of the sending module, for example voidwatch-feed/0.5.2up to 40 characters
onlinerequiredbooleanThe character is logged in
characterrequiredCharacter
character.namerequiredstringCharacter nameup to 30 characters
character.vocationstringVocation, for example Elite Knightup to 30 characters
character.levelrequiredinteger≥ 1, ≤ 5000
character.exprequiredintegerTotal experience points≥ 0
posrequiredPosition
pos.xrequiredintegerMap x≥ 0, ≤ 65535
pos.yrequiredintegerMap y≥ 0, ≤ 65535
pos.zrequiredintegerFloor, 0 to 15; 7 is ground level≥ 0, ≤ 15
capintegerFree capacity, in oz≥ 0
staminaintegerStamina, in minutes≥ 0, ≤ 2520
expPerHourintegerExp per hour as the client measures it≥ 0
routestringThe loaded cavebot routeup to 80 characters
routeOnbooleanThe cavebot is running
labelstringThe 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
labelsMissingstring[]Route parts without a label. check and leave come from bot adapters before version 4up to 4 items
planPlanStateThe bot's plan: a command that acts when the bot reaches a label. An ended plan stays for two minutes
plan.idintegerThe command that started the plan
plan.kindrequired"refill" | "go_depot" | "load_route"
plan.routestringThe 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.messagestringup to 200 characters
plan.sinceintegerUnix seconds when the plan started
plan.untilintegerUnix seconds when the waiting step gives up as stuck
plan.endedintegerUnix seconds when the plan ended
routesstring[]Every route the bot can loadup to 100 items
suppliesSupplyItem[]up to 60 items
supplies[].namerequiredstringItem name, as the game writes itup to 60 characters
supplies[].haverequiredintegerHow many the character carries, closed bags included where the game said≥ 0
supplies[].wantintegerHow many the bot keeps in stock; missing when the list comes from the use lines≥ 0
suppliesSourcestringbot: the bot's own supply list; used: every item the game's use lines namedup to 20 characters
tasksTaskItem[]up to 10 items
tasks[].namerequiredstringItem or creature name, as the game writes itup to 60 characters
tasks[].haverequiredintegerHow many the character has now≥ 0
tasks[].wantrequiredintegerHow many the bot keeps in stock, or the task goal≥ 0
tasks[].expintegerExp reward for the goal, if the server says≥ 0
tasks[].taskPointsintegerTask points for the goal, if the server has them≥ 0
taskPointsintegerThe task points balance, on servers with task points≥ 0
taskWeekTaskWeekTask points this week, on servers with a weekly cap
taskWeek.earnedrequiredintegerTask points earned this week≥ 0
taskWeek.caprequiredintegerThe most task points a week allows≥ 0
lootLootItem[]up to 200 items
loot[].namerequiredstringItem nameup to 60 characters
loot[].countrequiredintegerLooted since the session started≥ 0
loot[].sellintegerNPC price per item, if the module knows it. The server fills it in otherwise≥ 0
usedUsedItem[]Supplies used since the loot counter startedup to 200 items
used[].namerequiredstringItem nameup to 60 characters
used[].countrequiredintegerUsed since the counter started≥ 0
used[].buyintegerNPC buy price per item, if the module knows it≥ 0
lootHoursnumberHours since the loot counter started≥ 0
lootSourcestringWhere 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
skullsSkull[]Skulled players in viewup to 20 items
skulls[].namerequiredstringPlayer nameup to 30 characters
skulls[].skullrequired"white" | "red" | "black" | "yellow" | "green" | "orange"Skull colour
skulls[].distintegerSquares away from the character≥ 0, ≤ 100
blessedbooleanOnly on servers with blessings
pzbooleanThe character stands in a protection zone
pzLockbooleanThe character is PZ locked: it cannot enter a protection zone
outfitOutfitThe character's look, drawn on the map
outfit.typerequiredintegerThe look type≥ 0, ≤ 10000
outfit.headinteger≥ 0, ≤ 255
outfit.bodyinteger≥ 0, ≤ 255
outfit.legsinteger≥ 0, ≤ 255
outfit.feetinteger≥ 0, ≤ 255
outfit.addonsinteger≥ 0, ≤ 3
skull"white" | "red" | "black" | "yellow" | "green" | "orange"The character's own skull, if it has one
playersInViewintegerOther players in view≥ 0, ≤ 500
redemptionbooleanOnly on servers with death redemption: it is active now
redemptionLeftintegerOnly on servers with redemption≥ 0
targetOnbooleanThe targeting bot is running
botConfigstringThe bot preset, for example vBot_4.8up to 60 characters
targetProfilestringThe loaded targeting profileup to 80 characters
botProfileintegerThe bot settings profile, for example vBot's 1 to 5≥ 1, ≤ 20
adaptersAdapterState[]The adapters the module runs, and whether each is onup to 30 items
adapters[].idrequiredstringAdapter id, for example orion-ots-tasks or botup to 40 characters
adapters[].versionstringup to 20 characters
adapters[].onrequiredbooleanFalse: the adapter stopped after errors, or the bot stopped attaching
adapters[].wantstringFor the bot adapter: the version the module ships. A lower version waits for a bot reloadup to 20 characters
addonsAddonState[]The addons in the data folder, and whether each runsup to 30 items
addons[].idrequiredstringAddon id, for example exiva-map
addons[].versionstringThe module version the addon came withup to 20 characters
addons[].onrequiredbooleanLoaded now
addons[].errorstringWhy it is not loaded: installing, the download failed, or its last errorup to 200 characters
featuresstring[]What the module runs, for example status, captures and commands. The dashboard turns off what is not listed. Left out: everythingup to 20 items
actionsstring[]The command actions this client can run now, for example toggle_cavebot. The dashboard offers only theseup to 40 items
settingsChangeobjectA 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.