Voxta docs

Local development modules

The Local Development Modules page: dev folders, installing a module from a .zip or .dll, and reading load errors.

Local Development Modules holds the modules you build yourself and the ones you installed from a file. Open it from Settings → AI Setup → Module Sources: the Local development modules row, then Manage. Browse its modules, in that row's ··· menu, opens what they bring in Add Modules. Administrators only. See who can install.

The page has two sections: Dev folders and From a file. Modules downloaded from a source are managed on that source's page instead.

A module runs with Voxta's full access to the machine. Only load code you trust.

Dev folders

For a module you are building. A dev folder can be:

  • a module's project folder (Voxta uses its newest build),
  • its build output,
  • a repository holding the module's project.

Add one with Add source, on Module Sources or on this page: type the path under Module source and Add, or browse with the folder button. Browsing needs an account password. Without one, the button is greyed out. Voxta then opens this page.

Voxta loads a copy of the build, so you can rebuild while it runs. The page watches enabled dev folders: after a rebuild the entry shows New build and the page offers Apply.

ButtonDoes
Install nowLoads a folder that is not loaded yet, then opens its modules in Add Modules.
Install modulesOpens Add Modules filtered to what the folder brings, to set them up.
··· → Turn off / Turn onKeeps the folder without loading it. Applies at once.
··· → RemoveRemoves the folder.

A dev folder replaces an installed copy of the same module. A version range that does not match your Voxta is only a warning for a dev folder. Folders set with the VOXTA_DEV_MODULES environment variable show it instead of the buttons.

From a file

Install a .zip or .dll, in Add source, uploads a module and loads it at once, then opens this page:

  • .dll: a module with no dependencies of its own.
  • .zip: a module with its dependencies, as its author published it.

Then Install modules to set it up. Each module installed from a file offers Install modules, and in its ··· menu:

ButtonDoes
Install modulesOpens Add Modules filtered to its modules.
Revert to XGoes back to the version it replaced. See Reverting an update.
Load anywayLoads a module marked Incompatible despite its Voxta range. Check the version again undoes it.
Turn off / Turn onKeeps it installed without loading it.
UninstallUninstalls it.

These apply at once. A file cannot replace a module built into Voxta: one using a built-in module's name fails with … is built into Voxta and cannot be replaced.

Removing a module that is in use

Removing a dev folder or uninstalling a package also uninstalls the modules you set up from it in Manage Modules, so none is left broken. The confirmation names them (Also uninstalls …).

Applying changes

Most changes load right away. When something is still waiting (a new build in a dev folder), the page shows Changes not applied yet. with Apply, which loads and unloads modules without restarting Voxta. See Without a restart for what it interrupts and when a restart is still needed.

Load errors

Each entry has a state:

StateMeaning
LoadedRunning.
FailedCould not load or start. The error is shown under it.
IncompatibleIts Voxta range does not include this version. Not loaded unless Load anyway.
DisabledTurned off here.
OverriddenAnother copy of the same module is loaded instead (a dev folder over an installed one).

Warnings under an entry list parts of the module that need something this Voxta version does not have. They fail only when used. A module that fails while starting usually names what is missing. Details expands the full error.

Built-in modules that fail to load are listed on the Built in row of Module Sources. A downloaded module that did not load shows Installed, but did not load in Add Modules, with Reinstall and Remove.

For more, open the Terminal.

On this page