Dane statusu

Treść POST /api/v1/status, schemat vw.status/1. Wysyłaj tak często, jak mówi odpowiedź: co 2 s, gdy ktoś ogląda postać, w innym razie co 30 s. Pól, których nie znasz, nie wysyłaj; panel pokazuje to, co dostaje.

PoleTypOpis
schema"vw.status/1"Payload schema and version
modulewymaganestringName and version of the sending module, for example voidwatch-feed/0.5.2do 40 znaków
onlinewymaganebooleanThe character is logged in
characterwymaganeCharacter
character.namewymaganestringCharacter namedo 30 znaków
character.vocationstringVocation, for example Elite Knightdo 30 znaków
character.levelwymaganeinteger≥ 1, ≤ 5000
character.expwymaganeintegerTotal experience points≥ 0
poswymaganePosition
pos.xwymaganeintegerMap x≥ 0, ≤ 65535
pos.ywymaganeintegerMap y≥ 0, ≤ 65535
pos.zwymaganeintegerFloor, 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 routedo 80 znaków
routeOnbooleanThe cavebot is running
labelstringThe route label the bot is atdo 40 znaków
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 4do 4 elementów
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.kindwymagane"refill" | "go_depot" | "load_route"
plan.routestringThe route a switch loadsdo 80 znaków
plan.statewymagane"running" | "done" | "stuck" | "cancelled" | "taken_over" | "failed"
plan.step"hunt" | "city" | "depot" | "switch"What the running plan waits for
plan.messagestringdo 200 znaków
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 loaddo 100 elementów
suppliesSupplyItem[]do 60 elementów
supplies[].namewymaganestringItem name, as the game writes itdo 60 znaków
supplies[].havewymaganeintegerHow 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 nameddo 20 znaków
tasksTaskItem[]do 10 elementów
tasks[].namewymaganestringItem or creature name, as the game writes itdo 60 znaków
tasks[].havewymaganeintegerHow many the character has now≥ 0
tasks[].wantwymaganeintegerHow 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.earnedwymaganeintegerTask points earned this week≥ 0
taskWeek.capwymaganeintegerThe most task points a week allows≥ 0
lootLootItem[]do 200 elementów
loot[].namewymaganestringItem namedo 60 znaków
loot[].countwymaganeintegerLooted 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 starteddo 200 elementów
used[].namewymaganestringItem namedo 60 znaków
used[].countwymaganeintegerUsed 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 autolootdo 40 znaków
skullsSkull[]Skulled players in viewdo 20 elementów
skulls[].namewymaganestringPlayer namedo 30 znaków
skulls[].skullwymagane"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.typewymaganeintegerThe 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.8do 60 znaków
targetProfilestringThe loaded targeting profiledo 80 znaków
botProfileintegerThe bot settings profile, for example vBot's 1 to 5≥ 1, ≤ 20
adaptersAdapterState[]The adapters the module runs, and whether each is ondo 30 elementów
adapters[].idwymaganestringAdapter id, for example orion-ots-tasks or botdo 40 znaków
adapters[].versionstringdo 20 znaków
adapters[].onwymaganebooleanFalse: 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 reloaddo 20 znaków
addonsAddonState[]The addons in the data folder, and whether each runsdo 30 elementów
addons[].idwymaganestringAddon id, for example exiva-map
addons[].versionstringThe module version the addon came withdo 20 znaków
addons[].onwymaganebooleanLoaded now
addons[].errorstringWhy it is not loaded: installing, the download failed, or its last errordo 200 znaków
featuresstring[]What the module runs, for example status, captures and commands. The dashboard turns off what is not listed. Left out: everythingdo 20 elementów
actionsstring[]The command actions this client can run now, for example toggle_cavebot. The dashboard offers only thesedo 40 elementów
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

Przykład

{
  "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": []
}

Wersje

Nazwa schematu niesie wersję. Nowe pole zachowuje wersję; zmienione lub usunięte pole dostaje nową, a stara działa jeszcze co najmniej pół roku.