Skip to content

VoltScript on Windows

On Windows, you can use VoltScript natively. If Volt Foundry is installed on Windows, it is recommended that you develop also on Windows.

Prerequisites

The only pre-requisite for using VoltScript is:

  • Installing Visual Studio Code.

Info

On Windows, you do not have to develop in a dev container, but can. The most obvious use case for this will be if Volt Foundry is running on Linux and wanting to develop on the same architecture. If you wish to follow this approach, the steps are the same as for dev containers.

Installing on Windows

  1. Download the VoltScript installer file from My HCLSoftware.
  2. Run the VoltScript installer, installing to your desired location, for example C:\Program Files\VoltScript.

Note

If you previously installed VoltScript via a zip and manually added the PATH environment variable, you will need to manually remove the old PATH environment variable.

Installing the Visual Studio Code extensions

  1. Download the VoltScript VS Code extensions zip from My HCLSoftware and unzip.
  2. Open Visual Studio Code.

  3. Bring up the Extensions view by using Ctrl + Shift + X or clicking the Extensions icon in the Activity Bar.

    VoltScript Extensions

  4. In the title bar of the Extensions editor, click the ellipsis (...) and select "Install from VSIX...".

    Note

    The search bar allows you to search for an extension in the VS Code Marketplace and not in the folder of installed extensions. The "VoltScript Language Support" extension has not yet been published to the VS Code Marketplace.

  5. Navigate to the directory into which you unzipped the VoltScript VS Code extensions.

  6. Install vscode-voltscript-1.1.0.vsix.
  7. Repeat steps 3 - 5 for vscode-voltscript-archipelago-1.2.0.vsix. NOTE: there is a new release for this extension, but not for the VoltScript Language Support extension.
  8. Reload Visual Studio Code.

Error mapping path

Note that in EA4, if this is the first time you have installed the VoltScript Visual Studio Code Extensions, the VoltScript executable path is not correctly identified. It will find "HCL VoltScript Early Access 4 Notices and Information.txt" instead of the VoltScript executable. During EA4 you will need to manually amend the value.

  1. Go to Visual Studio Code's settings (Code > Settings > Settings on Mac, File > Preferences > Settings on Windows).
  2. Expand "Extensions" and select "VoltScript Language Support".
  3. Click on "Edit in settings.json"
  4. Amend the "voltscript.executablePath" value. It identifies the correct directory, but the filename needs amending to "VoltScript.exe" on Windows and "VoltScript" on Mac.
  5. Restart VS Code.

You are now ready to start coding with VoltScript in Visual Studio Code.