warcraft-vscode

This extension is a Warcraft III map development tool set of Lua.

Install

Features

• Compile script
• Pack map
• Run map
• Open world editor
• Add libraries

Commands

• Warcraft: Create Project
  • Create a map project for Warcraft III Reforge
• Warcraft: Create Classic Project
  • Create a map project for Warcraft III Classic
• Warcraft: Clean Project
  • Remove the .build folder
• Warcraft: Add Library
  • Add a library for project
• Warcraft: Compile Script
  • Compile script
• Warcraft: Pack Map
  • Compile script
  • Pack map to w3x
• Warcraft: Run Map
  • Compile script
  • Pack map to w3x
  • Run map in Warcraft III
• Warcraft: Open World Editor
  • Open the map folder with World Editor
• Warcraft: Toggle Configuration
  • Toggle Configuration between with debug and release

Quick Start

1. Press F1 in vscode
2. Input warcraft create and Press Enter to create a Warcraft III map project
3. Open the project folder and execute the Commands of this extension

Usage

The extension packages all Lua files into single file, Debug and Release behave differently, Debug packages all Lua files in src folder, but Release automatically analyzes dependencies based on the functions require dofile loadfile, so if you call these functions with NON STRING LITERALS, you must explicitly add the list of Lua files to the warcraft.json

warcraft.json

{
    "mapdir": "map.w3x",
    "files": ["main.lua"],
    "jassfile": "",
    "lua.package.path": ["./lib/?.lua", "./lib/?/init.lua"]
}

jassfile - *CLASSIC* Specify the path to the war3map.j file or use it in the map file.

Lua API

The extension implements some APIs in Lua that removed from Warcraft III, These functions are used in the same way as Lua

• require
• dofile
• loadfile

And added some functions for debug

• seterrorhandler(func)
• geterrorhandler()

Macros

There are some macros in lua file.

---Only compile into debug mode
--@debug@
Debug()
--@end-debug@

---Only compile into non debug mode
--@non-debug@
NotDebug()
--@end-non-debug@

---Not compile
--@remove@
OnlyInEditor()
--@end-remove@

---Only Compile into Classic
--@classic@
Classic()
--@end-classic@

--@non-reforge@
Classic()
--@end-non-reforge@

---Only Compile into Reforge
--@reforge@
Reforge()
--@end-reforge

--@non-classic@
Reforge()
--@end-non-classic@

Pack

The extension packages all files in folder named imports and src/lib/*/imports into the map, In Configuration Release, packages the folder named imports.release, In Configuration Debug, it's imports.debug

Libraries

• stdlib
• console

Known Issues

TODOs

• For Release
• Use other github users or organizations to add libraries
• Support compile time
• Support for macOS

Enjoy!