Warcraft Addon Dev Tools

Cross-platform Python CLI tools for World of Warcraft Addon development

Requirements

• Requires Python 3.8.8 or greater
• Requires git, svn, and luac to be installed and properly mapped on your PATH
• Requires pyyaml

You can install pyyaml and any other Python package dependencies with pip install -r requirements.txt

Usage

Commands

make libs: Grabs external dependencies defined in your .pkgmeta file and places them in the correct folder. For use during development.

• -d: Path to the folder containing your addon and the .pkgmeta file. Defaults to current working directory

create: Used to generate a basic addon in your World of Warcraft addons folder (or any folder). Saves you a good 45 seconds of creating a new .lua and .toc file! Can be called with no arguments, will prompt the user for the values.

• -n: A name for your addon.
• -a: An author name.
• -d: Path to the folder you want to generate the addon in.

luacheck globals: Used to run luac and automatically add all accessed global variables to your .luacheckrc file.

WARNING: This is not 100% complete and does have the ability to eat your .luacheckrc file. It makes backups, but will only go up to 5 before it starts deleting files.

• -d: Path to your Lua project
• -lc: Path to your existing .luacheckrc file.
• -p: Path to luac.exe. This will be automatically found if it's on your PATH.

Example:

wat make libs -d "<path>/<to>/<your_addon>" // defaults to current working directory if not provided

You can always use -h for help!

Final Note

Please do give me suggestions for more tools that could make addon development easier!