Skip to content

A tool for automatically downloading, installing and updating World of Warcraft addons.

License

Notifications You must be signed in to change notification settings

Kumodatsu/wow-addon-manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WoW Addon Manager

A tool for automatically downloading, installing and updating World of Warcraft addons.

Disclaimer

So far, the application has only been tested on Windows 10 and only works with Retail World of Warcraft (not with Classic). Note that this project is still early in development and as such may be buggy. Do not use the application if you're unsure. If you do decide you want to use the application, I recommend making a backup of your AddOns folder before first using it.

Setup instructions

You can either get a built executable of the application, or get the source code and compile it yourself.

With a built executable

Go to the releases page. Find the section of the version you want. The latest version is always on top. At the bottom of the section, there is a small "Assets" drop down. Click on it, then click on "wow-addon-manager.zip" to download.

The downloaded zip file contains the executable of the application. Place this executable anywhere you want. I suggest making a new folder to keep it in to keep things organized when you add your configuration file (see "Usage").

Building the project yourself

The project is written in Rust, and as such you need the Rust toolchain (cargo, rustc) to build the project. You can get get it here.

To get the repository, use the following command:

git clone https://github.com/Kumodatsu/wow-addon-manager.git

To build the project, go into the project folder (the one containing the "Cargo.toml" file) and run

cargo build

To run the project, use the command

cargo run

You need to have a configuration file in the directory from which you run this command, or the application will complain (see "Usage").

Usage (0.1.1)

Configuration file

To use the program, you must create a "config.yaml" in the same folder as the application (or in the project folder if you built it yourself). Take care that you can see file name extensions when you do this, or you might accidentally create a file with a name like "config.yaml.txt" (if you're using Windows, in Windows Explorer click on "View" and then check "File name extensions"). Open this file with a text editor. Here you can specify which addons you want to download (or update) as well as where your World of Warcraft AddOns folder is located. Here is an example of a correctly formatted configuration file:

path:
    C:\Program Files (x86)\World of Warcraft\_retail_\Interface\AddOns

curseforge:
    - 290830
    - 311718
    - 75973

github:
    - https://github.com/Kumodatsu/Invite123

tukui:
    - ElvUI

The path section is used to specify where your AddOns folder is located. This is always your World of Warcraft directory, and then _retail_/Interface/AddOns. The curseforge section is to specify addons that should be downloaded from CurseForge. The numbers are the addon's Project ID which you can find on its CurseForge page. The github section is to specify addons that should be downloaded from GitHub. Specify the base URL to the repository here. The tukui section is to specify addons from Tukui. Just specify the addon name (case sensitive!). If you do not need a section, you can just leave it out altogether (for example, if none of your addons are from GitHub, you can just leave the github section out).

Once you have your configuration file (make sure it's saved), simply run the application. It will then try to find the addons you specified online, download them, extract them and finally move them to your AddOns folder. How long this takes naturally depends on the number of addons, your download speed and other such factors.

Command line arguments

The application accepts several command line arguments. Use wow-addon-manager --help to see an exhaustive list of all accepted arguments.

  • -f or --force: Forces the application to download and install all addons even if they are already up to date. Currently, the application does this anyway regardless of whether or not this flag is specified.
  • -h or --help: Prints help information.
  • -V or --version: Prints version information.
  • -v or --verbose: Output all messages regardless of severity.
  • -c <config> or --config=<config>: Specifies the path to a config file.

About

A tool for automatically downloading, installing and updating World of Warcraft addons.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages