Command actions

The actions that the website sends, with their arguments. Module 0.7.0 runs the first group. Rules and chat will send the planned actions in the same way.

Runs now

ActionArgumentsWhat the module does
reset_lootnonestarts the loot, supplies and time counters from zero
toggle_caveboton: true or falseturns the cavebot on or off
toggle_targetboton: true or falseturns the targeting on or off
reset_herenonepoints the cavebot at the nearest waypoint on the same floor
capturenonetakes a screenshot now
logout_in_pznonelogs out when in a protection zone

The bot actions run in the bot adapter, version 2. It works with the stock cavebot, vBot and presets that are based on them. reset_here does not start the cavebot.

Plans, module 0.8.0

ActionArgumentsWhat the module does
refillnoneat the next hunt label, jumps to refill
go_depotnonerefills, then turns the cavebot off after the first step after city
load_routerouterefills, then at city loads the route and starts it at its own city
resumenonefor a parked character: turns the cavebot on at city
cancel_plannoneends the running plan. The bot stays as it is.
  • The first 3 actions start a plan. The result comes at once. It says that the plan started, or why it did not.
  • The bot adapter, version 5, runs the plans. It wraps the bot's label and goto steps and CaveBot.gotoLabel.
  • The status field plan reports the plan: kind, state, step, message, since, until and ended.
  • state is running, done, stuck, cancelled, taken_over or failed. An ended plan stays in the status for 2 minutes.
  • The website sets the status of the command from the plan. It is running while the plan waits, then done or failed.

Team exiva, module 0.9.0

ActionArgumentsWhat the module does
cast_exivatarget, run, bycasts exiva at once and answers later, with the game message
exiva_showtarget, x, y, zmin, zmax, radius, answers, area, casts, partial, firstshows the result as a game message
  • cast_exiva needs Team exiva on, half of the HP, mana for the spell, and 5 s since the last cast. On "You are exhausted." it casts again after 0.4 s, up to 5 times.
  • Its result comes when the game answers. data holds x, y, z, band, dir and level.
  • The player's own cast writes outbox/exiva.json. The upload script sends it to POST /api/v1/exiva, which starts the run.
  • exiva_show sends area when the server found one. It holds step and rows. Each row is [y, first x, last x] in cell centres. The Exiva map addon draws it.
  • exiva_show with partial is an area while answers still come. The first one also has first. The module shows a game message only for first and for the final area.
  • exiva_show sends casts with area: x, y, band and dir of each caster. A guild mate's cast is in the list only when they share their position. The Exiva map addon draws each one as a thin outline.
  • exiva_show sends shape with area: the exact outline of the area. edges holds lines ["l", x1, y1, x2, y2] and arcs ["a", cx, cy, r, a0, a1], with angles in degrees clockwise from east. best is the number of answers that meet. Fill it row by row: the area lies between the 1st and 2nd crossing, the 3rd and 4th, and so on. Module 0.13.0 draws it.
  • The player's own cast reaches addons as the event exiva_cast, with target, x, y, z, band, dir and level. It comes also with Team exiva off. Module 0.11.0 sends it.

Addons, module 0.10.0

ActionArgumentsWhat the module does
addon_installaddonadds the addon id to addons-wanted.json
addon_removeaddonremoves the id. The upload script deletes the addon folder.
  • The upload script reads addons-wanted.json. It downloads addon-<id>.zip from the module release.
  • The upload script checks each zip against SHA256SUMS of the same release.
  • Every game client that shares the data folder loads the addon within 5 seconds.
  • The status field addons lists each addon with id, version, on and error.
  • The status reply field addonCatalog lists the addons of the newest release, with id and name.
  • Only addons from the module release load. The module never runs player code.
  • Each new reply reaches addons as the event reply, with the whole reply. Module 0.12.0 sends it.
  • The reply field radar comes only while the status says that Team radar runs. It lists name, x, y, z and kind, which is own or guild.
  • While Team radar runs, the client and every character on its radar report every 5 seconds.

Planned

ActionArgumentsWhat the module should do
goto_labellabeljump to a label of the loaded route
reload_botnonereload the scripts of the bot
chat_replyto, textsend a private message

Delivery

  • The upload script writes each batch of commands to its own file, inbox/commands-<time>-<n>.json.
  • The module runs each command once, by its id.
  • A command older than 60 seconds does not run. The API also stops its delivery, and the log shows it as expired.

Results

Add one result for each command to outbox/results.json.

[{ "id": 812, "ok": true, "message": "cavebot off" }]

The upload script moves the file aside before it sends the results. So a new result never gets lost.

An action that the module does not know gets ok: false and the message not supported on this client. The command log shows it. So players see what their server supports.