Manage World of Warcraft addons, upload WCL, etc.


Keywords
world of warcraft, wow, addon, lua, world-of-warcraft, curse, tukui, world-of-warcraft-addon, world-of-warcraft-classic, managing-wow-addons, wowa, wowinterface, wow-addons-updater
License
MIT
Install
npm install wowa@1.3.15

Documentation

WoWA

cover status npm npm install size platform

Recent Notice

  • Add support for PTR and BETA mode, see switch modes
  • Now ls only prints short message, if you want detailed message, use wowa ls -l
  • node version: node

WoWA stands for World of Warcraft Assistant, it is designed to help managing WoW addons, uploading WCL logs, etc.

There used to be some command line manager for WoW addons in the past, but are mostly out of maintaince at this time. A list of these projects can be found in the related prjects section.

As comparing to these projects, WoWA offers serveral advantages:

  • Better CLI interface: colorful and meaningful
  • Concurrency: when installing or updating, WoWA can take advantage of multi-processing
  • wowaads.json file: this is the file where WoWA stores addon information. Unlike other projects, WoWA stores this file in the WTF folder. This design benifits people when they want to backup their WoW setting. Backing up one WTF folder is enough

Install

npm install -g wowa

Setup WoW path

The WoW path configuration file is located at %APPDATA%/wowa/wow_path.txt on Windows, and ~/.wowa/wow_path.txt on macOS or Linux.

Normally wowa would remind you to edit this file if it cannot find the game at its default location.

Usage

Quick reference

To install an addon

wowa add deadly-boss-mods                       # install dbm from curse
wowa add curse:deadly-boss-mods                 # install dbm from curse
wowa add mmoui:8814-DeadlyBossMods              # install dbm from wowinterface
wowa add 8814-DeadlyBossMods                    # install dbm from wowinterface
wowa add deadlybossmods/deadlybossmods          # install dbm from github
wowa add bigwigsmods/bigwigs/classic            # install bigwigs (classic branch) from github
wowa add antiwinter/dlt                         # install dlt from github

To search an addon

wowa search dbm                                 # search for dbm automatically
wowa search mmoui:dbm                           # search for dbm only from wowinterface

If an addon does not provide a classic version, but the author declares that the addon supports classic. You can:

wowa add some-addon --anyway

Note: you will need to check the Load out of date addons option in game

Installing an addon

Installing an addon from arbitrary repo

wowa add https://git.tukui.org/Azilroka/AddOnSkins.git            # install master branch
wowa add https://git.tukui.org/Azilroka/AddOnSkins.git@master     # install master branch
wowa add https://git.tukui.org/Azilroka/AddOnSkins.git@v1.88      # install tag v1.88

Search for an addon

Note: that WoWA manages addons by keys (keys are provided by curse) not by addon names, sometimes they are different. If you are not sure a key for an addon, you can search that addon by some fuzzy name, and the search result provides the correct key to use.

Installing two or more addons

Removing an addon

Update all installed addons

Pin an addon, prevent it from updating

wowa pin deadly-boss-mods       # addon is pinned to it's current version
wowa unpin deadly-boss-mods     # addon is unpinned

wowa ls -l displays an exclaimation mark before version, incicating that addon is pinned.

List all installed addons

Import local addons

If use wowa for the first time, you need to import your local addon. Then wowa can manage them for you.

wowa import

Switch modes

wowa sw                 switch between _retail_ and _classic_
wowa sw --ptr           switch mode to: retail PTR
wowa sw --beta          switch mode to: retail BETA
wowa sw --retail        switch mode to: retail formal
wowa sw --retail-ptr    switch mode to: retail PTR
wowa sw --retail-beta   switch mode to: retail BETA
wowa sw --classic       switch mode to: classic formal
wowa sw --classic-ptr   switch mode to: classic PTR
wowa sw --classic-beta  switch mode to: classic BETA

Related projects

Actively maintained

Not Actively maintained

Roadmap

  • Support projects on wowinterface.com
  • Support projects on github.com
  • Game version detection
  • Add test cases
  • Support projects on tukui.org
  • Support WoW Classic !
  • Import existing addons
  • Check wowa updates
  • Optimize color scheme
  • Shrink size of package
  • Support releasing UI (addons list, together with settings) to github.com
  • Support backing up to github.com
  • Support restoring from github.com
  • Support uploading to warcraftlogs.com