Getting Started

This is a quick introduction into project setup using our TypeScript template for Warcraft III.


  1. Node.js
  2. Warcraft III 1.31.0 or greater.

Project setup#

  1. Download (or clone) the repository and cd to the project root.
cd wc3-ts-template
  1. Install the dependencies.
npm install
  1. Configure your project by editing config.json and making sure gameExecutable properly points to your game executable.

Check out Configuration page for more information.

Running your project#

npm run test

When successful, the output should be similar to the text below.

Transpiling TypeScript to Lua...
Building "map.w3x"...
Launching map "map.w3x"...

Warcraft III should also launch and you should see something like the following image.