wow-addon-packager 0.7.0

A user-friendly World of Warcraft addon packager

wap is a user-friendly World of Warcraft addon packager.

Features

• Builds retail or classic WoW addons (or both!)

• Uploads your addons to CurseForge

• Installs your addons to your Addons folder for fast development feedback

• Generates valid TOC files automagically

• Sets up new addon projects quickly, ready to go with one command

• Consolidates all configuration in one easy-to-edit file

• Supports and is tested on Windows, macOS, and Linux

• Has awesome documentation

wap in 5 minutes

This entire set of instructions is runnable without editing a single line of code!

1. Download Python 3.9 or greater and install it.

2. Install wap with pip:

   $ pip install --upgrade --user wow-addon-packager

3. Create a new project:

   $ wap quickstart MyAddon  # or whatever name you'd like!

   and answer the prompted questions. Don’t worry too much about your answers – you can always change them later in your configuration file.

   Then change to your new project’s directory

   $ cd "MyAddon"

4. Build your addon

   $ wap build

5. Install your addon so you can test it out in your local WoW installation:

   on Windows
   $ wap dev-install --wow-addons-path "C:\Program Files (x86)\World of Warcraft\_retail_\Interface\AddOns"
   
   on macOS
   $ wap dev-install --wow-addons-path "/Applications/World of Warcraft/_retail_/Interface/AddOns"

6. Upload your project to CurseForge

   $ wap upload --addon-version "dev" --curseforge-token "<your-token>"

   You can generate a new token at Curseforge’s My API Tokens page.

Further Help

See the official documentation site. There’s a lot more information there!

Also, the wap command is fully documented in its help text. View it with:

$ wap --help
$ wap build --help
$ wap upload --help
... etc

Contributing

See how to contribute in the official docs.

TODOs

• localization via curseforge?

• Dockerfile github action https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action