Route labels

Four labels tell Voidwatch where each character is in its cavebot route. This guide starts from zero.

Four commands use the labels now. They need module 0.8.0. Rules come soon.

What a route is

A cavebot route is a list of steps. The bot walks through the steps from top to bottom, again and again.

StepWhat it does
goto:x,y,zwalks to a square on the map
label:namemarks a place in the route. The bot does nothing there.
gotolabel:namejumps to a label
function:[[ ... ]]runs a small piece of Lua

The OTClientV8 bot and vBot both keep routes in this form. Each route is one .cfg file in the cavebot_configs folder of the bot.

The four labels

A route has 4 parts. The bot goes through them in this order, then starts again at hunt.

LabelWhere to put itWhat the part covers
huntat the first step of the hunting loopThe character hunts. The supply check is in this part.
refillwhere the supply check sends the character awayThe way to the city. It ends at the depot.
cityright before the step into the depotThe city loop. Depot, loot sellers, supply shops and bank.
respat the first step of the way back to the huntThe way to the hunting place. It ends with gotolabel:hunt.
  • resp is short for respawn. It means the hunting place.
  • Most routes already have these 4 parts, with other names. You only add the 4 labels.
  • There is no label for the supply check. It stays inside the hunt part.

A whole route, before and after

Before, a typical route looks like this:

goto:33191,31798,7      <- first step of the hunt
goto:33200,31805,7
goto:33195,31790,7      <- last step of the hunt
goto:33194,31794,7      <- the way to the city
goto:32369,32241,7      <- a square inside the depot
goto:32360,32230,7      <- loot sellers, supplies, bank
goto:32370,32220,7      <- the way back to the hunt

After, with the 4 labels:

label:hunt
goto:33191,31798,7
goto:33200,31805,7
goto:33195,31790,7
supplycheck:hunt,33195,31790,7
label:refill
goto:33194,31794,7
label:city
goto:32369,32241,7
goto:32360,32230,7
label:resp
goto:32370,32220,7
gotolabel:hunt
  • supplycheck:hunt,... is the supply check of vBot. With enough supplies, it jumps back to hunt. Otherwise, it goes on to refill.
  • With the OTClientV8 bot, a function:[[ ]] step does the same job. Keep the check that your route already uses.
  • Your check can also sit at the start of the loop. Then it jumps to refill when supplies are low.
  • The last line sends the character back to hunt. So the whole route repeats.

The depot is the meeting point

Put city right before the step that walks into the depot. All routes of one town must use the same depot.

  • The step can lead to any free square inside the depot. Each route can use a different square.
  • Avoid the squares right next to the depot boxes. Players often stand there, and the bot can get stuck.
  • Both bots walk to a step only when it is 40 squares away or less. Squares in one depot are close enough.
  • Use one floor of the depot for all routes. Both bots walk only to a step on the same floor.
  • Commands such as "stop in depot" will park the character in the depot.
  • A route switch happens in the depot.

A switch from route A to route B goes like this:

  1. Route A reaches its supply check and goes to its city.
  2. The cavebot stops in the depot.
  3. Route B loads. It starts at its own city, in the same depot.
  4. The bot walks from the square of route A to the square of route B.
  5. Route B does its own city loop. So the character buys the supplies for hunt B.
  6. Route B goes through resp to its own hunt.

Here are two hunts from the same town. Both walk into the same depot, to different squares.

[afk] hunt north              [afk] hunt south
label:city                    label:city
goto:32369,32241,7            goto:32372,32244,7      <- two squares in the same depot
goto:32360,32230,7            goto:32375,32250,7
label:resp                    label:resp
...                           ...
  • Routes from different towns cannot switch between each other. The character would start route B far from its first step. Keep one group of routes for each town.
  • Pick squares inside the depot building. The depot is usually a protection zone. The character waits there safely while the route changes.

Add a label in the bot

  1. Open the bot.
  2. Open CaveBot.
  3. Open the route.
  4. Click the step where the part starts.
  5. Click Add.
  6. Pick label.
  7. Type the label name. It is hunt, refill, city or resp.
  8. Move the label with the arrows. It must be right before the step where the part starts.
  9. Save the route.

Check your work

  1. Open the Routes page. It shows the labels of every route that your client reports.
  2. Look at each route. The status ready means that all 4 labels are there. The status missing lists the labels that are not there.

Your own label names

Your routes can keep their own label names.

  1. Open the Clients page.
  2. Click Module next to the client.
  3. Under Route labels, type your label names for each part. Separate several names with commas. For example, your routes use depo for the way to the city. Type depo in the refill field.
  4. Save.

An empty field uses the standard name. Upper and lower case do not matter.

See where a character is

The Live page shows the part of the route each character is in. It is one of these:

  • hunting, to city, in city or to resp, from the labels.
  • parked, when the cavebot is off in a protection zone or near the depot. Near means 8 squares or less from the first step after city.
  • stopped, when the cavebot is off somewhere else.
  • no route labels, when the loaded route misses a label.

When a label is missing, the Live page shows which one. The Voidwatch window in the game shows the same.

This needs module 0.7.4. After the update, reload the bot once.

Note: Modules 0.7.2 and 0.7.3 used the labels check and leave. Module 0.7.4 ignores them. You can delete them from your routes.

Commands that use the labels

Four commands act at the labels of the route. Send them from the Commands page or with the buttons on the Live tiles.

CommandWhat it does
Force a refillAt the next hunt, the bot jumps to refill.
Stop in depotThe bot refills. After the step into the depot, the cavebot stops.
Switch routeThe bot refills. At city, it loads the new route and starts at its city.
ResumeA parked character starts again at city. It refills, then hunts.
  • A command that waits for a label is a plan. The Live tile and the Voidwatch window show it.
  • Each character runs one plan. A new plan replaces the old one. The website asks you first.
  • Cancel the plan ends it. The bot stays as it is. A parked character stays parked until Resume.
  • A plan never changes your route file. It acts when the bot reaches a label.
  • Put the commands on the tiles under Commands → Buttons on the live tiles.

When a plan ends by itself

  • stuck: the plan waited longer than the wait limit. The limit is 20 minutes. Change it on the Clients page. Click Module, then set Plan wait limit, minutes.
  • taken over: someone loaded another route. That can be you or a script.
  • logout: a plan ends when the character logs out.

A script that turns the cavebot off does not end the plan. An example is a script that waits when a player shows up. The plan waits too, and the wait limit still counts.

This needs module 0.8.0. After the update, reload the bot once.

Common mistakes

  • A typo. refil is not refill. Use these 4 names, or your own names under Route labels.
  • refill inside the hunting loop. The Live page then shows to city while the character hunts. Put refill where the supply check sends the character away.
  • city in a different depot in each route. A route switch then starts far from the route. Use one depot for all routes of one town.
  • Two routes with the same name. The Routes page shows both. Rename one, so that commands pick the right route.
  • A route that never goes to town. A pure hunting route works without labels. But commands such as "force refill" need all 4.