Getting started
Add your characters to the Voidwatch website, step by step. It takes about 5 minutes.
You need a game client that allows modules. A client from the server list in step 3 also works. So far, we verified Voidwatch only on the Orion-OTS client. Most servers lock their client against modules.
1. Create an account
- Open the sign-in page.
- Pick Discord or Google. You need no password.
Voidwatch is in early access. After your first sign-in you start on the Free plan at once. It covers one client, with no time limit.
2. Download the module
- Download the zip file.
- Unpack it to any folder, for example your desktop.
The zip file holds the voidwatch folder, the upload folder and the setup files.
3. Put the module into your game client
Most clients load the module from their modules folder. Some servers need another way. See Server specific below.
A client that allows modules
- Close the game client.
- Open the folder where the game client is installed.
- Find the modules folder. It holds folders such as
game_battleandclient_options. Some servers keep it in the data folder instead. A Windows example is%APPDATA%\OTClientV8\<server name>\modules. - Copy the whole
voidwatchfolder into the modules folder.
Not sure it is the right folder? Start the client after step 4. A game message from Voidwatch shows that the folder is right.
Server specific
Orion client: bot folder
The Orion client does not accept new modules in its modules folder. So Voidwatch runs from the bot folder.
- Close the game client.
- Open the data folder of the client. This is the folder that holds the
botfolder. On Windows, this folder is in%APPDATA%\OTClientV8. - In the
botfolder, make a folder named_voidwatch. - Copy the
voidwatchfolder into the_voidwatchfolder. The result isbot/_voidwatch/voidwatch. - Copy the file
voidwatch_start.luainto the folder of the bot config you use. The file is inbot/_voidwatch/voidwatch. An example of a bot config folder isbot/vBot_4.8.
Caution: Do not copy Voidwatch into the modules folder of the Orion client. The client then closes at start.
When you pick another bot config, Voidwatch copies the start file into it. One second later, it reloads the bot once.
4. Run the setup once
The setup installs the upload script on your computer. The script then starts at every login.
The script sends the data of your game client to the website. The game client itself never connects to the internet.
The script is required. Without it, nothing reaches the website. There is no pairing, no live view, no history and no alerts.
Windows
- Double-click
setup-windows.cmd. - Wait for the text "Voidwatch is set up".
- Press any key to close the window.
Mac
- Right-click
setup-mac.command. - Pick Open.
- Pick Open again.
- When the window asks for a folder, press Enter.
Linux
- Open a terminal in the unpacked folder.
- Run
sh setup-linux.sh.
A game client in Wine or CrossOver uses the setup for Mac or Linux.
5. Pair your client
- Start the game client.
- Log in with a character. A game message shows a code and a link. An example of a code is
K7PQ-2MXD. - Open the link. To see the code again, click the Voidwatch button in the top bar. Its window has the buttons Copy code and Open the link.
- Pick Add it to my account. To look around without an account, pick Try it as a guest. The guest session starts at once and lasts 48 hours.
Your character shows on the Live page within a few seconds. To learn more, read Pairing a client.
6. Label your routes
You can send the first commands from the Live page now:
- Cavebot on or off
- Targeting on or off
- Reset here
- Reset loot
Route commands and rules come soon. They will steer your bot through 4 labels in your cavebot routes. Labels that you add now will work then. Each route takes a few minutes. Read Route labels.
Something did not work?
No game message
- Close the game client.
- Check that the
voidwatchfolder is in the modules folder. See step 3. - Start the game client again.
No game message on the Orion client
- Check that the file
bot/_voidwatch/voidwatch/voidwatch.otmodexists. - Check that
voidwatch_start.luais in the folder of the bot config you use. - Reload the bot.
The game message asks you to run the setup
The setup did not find this client. The game message shows the folder of the client. Give this folder to the setup.
- Windows: Drop the folder onto
setup-windows.cmd. - Mac: Run the setup again. Drag the folder into its window.
- Linux: Run
sh setup-linux.sh "<folder>".
More help
The upload script tells what the script does and how to remove it.