The upload script

What the upload script does and where it runs. How to check, update or remove it.

The script is required. The game client sends nothing itself. Without the script, nothing reaches the website.

Why there is a script

Many game clients leak memory each time they send data over the internet. After a few hours, they slow down or crash.

So the module never sends data itself. It writes a few small files. The upload script sends these files.

What it does

  • It looks for game clients with the module every 2 seconds. It looks in the usual folders and in the folders you gave the setup.
  • It sends the character state every 2 seconds while you watch the character. Otherwise, it sends it every 30 seconds.
  • It sends screenshots when the website asks for them.
  • It sends the map files of your client when they change. The website adds them into your own map.
  • It brings your commands from the website to the client within a few seconds.
  • It learns of a new module release from the website within 5 minutes. It installs the release when you click Update in the game.

To stop the minimap upload for one client, open Clients → Module.

The script needs no other software. Windows has PowerShell. Mac and Linux have curl.

Where it runs

SystemThe scriptIt starts at login through
Windows%LOCALAPPDATA%\Voidwatch\upload.ps1a shortcut in your Startup folder
Mac~/Library/Application Support/Voidwatch/Voidwatch Uploada login item, xyz.voidwatch.upload
Linux~/.local/share/voidwatch/upload.sha user service, voidwatch.service

A client in another folder

The setup finds clients in the usual folders. A client in another folder needs one more step.

  1. Start the game client.
  2. Log in with a character. A game message shows the folder of the client.
  3. Give this folder to the setup. The steps for each system are below.
  • 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 "/path/to/voidwatch".

Check that it runs

  1. Open the Live page.
  2. Look at the "updated" time of your character. A recent time means that the script works.

The Clients page also shows when each client was last seen.

The Voidwatch window

Click the Voidwatch button in the top bar of the game. The window has three tabs.

  • Main shows what this client sends, the data sources and the stop buttons.
  • Addons shows the addons with their screenshots. Turn one off for this character only, change its settings, reload it or read its last errors.
  • Settings holds the same settings as the Clients page. Save sends a change to the website.
Note: A change from the game reaches the website within 30 seconds. The client uses it at once.

Update the module

  1. Click the Voidwatch button in the top bar of the game. The Voidwatch window opens.
  2. When a new module is out, the footer of the window shows a yellow link like Update to 0.14.1. Click it.
  3. Wait a few seconds. The script downloads the release from GitHub and checks its checksum. It keeps your current module as a backup.
  4. The module reloads by itself in this client. Other clients in the same folder show Reload to 0.14.1 in the footer. Click it there.

On the Orion client, the update goes into bot/_voidwatch/voidwatch in the same way.

If the new module causes problems, click Roll back in the footer of the window. The link names the version you had before.

The script also needs updates sometimes:

  • From module 0.7.1, the script updates itself from the release, on every system.
  • On Windows, a script older than 0.7.1 cannot do that. Run the setup once more to get the new one.

Update by hand

You must update by hand in 2 cases:

  • The window says "update by hand". The script cannot write to the folder of the module.
  • Your module is older than 0.6.0. These modules have no Update button.
  1. Close the game client.
  2. Copy the new voidwatch folder over the old one. On the Orion client, the old folder is bot/_voidwatch/voidwatch.
  3. Run the setup again.

Remove it

Run the remove file for your system. It stops the script and deletes it.

  • Windows: Double-click remove-windows.cmd.
  • Mac: Double-click remove-mac.command.
  • Linux: Run sh remove-linux.sh.

The module stays in your game client. To remove it, delete its voidwatch folder.

Antivirus and warnings

Windows SmartScreen or an antivirus asks about the script

The script is plain text. You can read every line in Notepad before you allow it.

Mac says the file is "from an unidentified developer"

  1. Right-click the file.
  2. Pick Open.