Last updated: October 29, 2018

Install Java

WurstScript and it’s related tools require Java 8 to run. Please install or verify your installation.

Download JRE

  Download Java

Download the Java Runtime appropriate for your system and follow the installation procedure.

Once finished, continue to the next step

Verify / Update Java Installation

Many tasks rely on a environment variable called JAVA_HOME which might not have been set by the installer. To verify your installation, open a command prompt and enter java -version

A valid installation will return something like this:

> java -version
java version "1.8.0_131"

Make sure your minor version 1.8.0_xxx (xxx) is higher than 101 to avoid any certificate issues. If it is lower, make sure to update your Java installation, otherwise your connection will be insecure.

If you get an error or get a lower version displayed even though you installed a newer one, your JAVA_HOME is either missing or configured wrong.

Refer to this   Windows tutorial in order to setup your JAVA_HOME correctly.

Once you have setup Java correctly, continue by installing VSCode.

Install VSCode

VSCode is a free, open source, cross platform code editor. WurstScript support is provided through a VSCode plugin.

Install VSCode

  Download VSCode

Download and install VSCode on your system.

Once finished, open VSCode and continue to the next step

Install Wurst Plugin

Press F1 to open the VSCode command prompt and run the task >Install Extensions:

In the panel that opened on the left, type Wurst into the search bar and press enter. Install the Wurst language support plugin.

Reload the window to activate the plugin.

If you want fitting icons for .wurst files you may also install the vscode-icons plugin.

You can minimize VSCode now and continue with the next steps

Install WurstScript

Now we will setup a Wurst compiler environment and create a project using the the Wurst Setup.

  Download WurstSetup

Once the download has finished, run the .jar to begin.

Install Compiler

The setup will check if the compiler has already been installed. If not, you are required to install it before you can create a project.

To install the compiler simply click the Install Wurst button. When everything is done, the setup should tell you that your installation is up to date and the Create Project button is now enabled:

Create Project

Now that the compiler is installed you can go ahead and create your Wurst project. Select your desired project folder and name and start the process by clicking the Create Project button. The setup will now create a wurst project structure and download the necessary dependencies. If everything setup correctly, you should see the following message:

When the setup has finished, you can now open the project’s root folder in VSCode.

  Make sure you are opening the project’s root folder (contains file) using File -> Open Folder

Once the project is opened, you can click the Hello.wurst file on the left to activate the Wurst plugin. The code should compile and the setup should be done.

If you are new to WurstScript but not new to programming, you probably want to continue with the   Beginner’s Guide

Update and import Projects

By clicking the import button you can load an existing file. After a successful load clicking the Update Project button will update your dependencies and generate local files as necessary. Use this feature to update your existing projects and to import projects which you didn’t create.