AddOns Update Tool
Tool to update World of Warcraft AddOns hosted on GitHub
Features
- Pure Python: only Dulwich and Colorlog
- Multithreaded tasks
- Manual and automatic modes
- Able to start the game after an updates
- Automatic backup of updatable AddOns (up to the last 5)
- Automatic detection of AddOn directories (aka modules)
Usage
Before running this script for the first time, I STRONGLY RECOMMEND making a backup of your Interface folder: something bad is unlikely to happen, but just in case
Configuration file
Before using this script, you need to configure the list of repositories (AddOns) for updating. Just see how this is done in the config_example.json file. In general terms, it is a simple JSON file, where you need to specify the repository URL and the branch you want to clone (usually it will be master or main):
{
"URL1" : "master",
"URL2" : "master"
}
Note that curly brackets, quotation marks, colons, and commas are mandatory characters in JSON structure
Help page
When you run the script from the release version or the source code with the -h parameter, the help page will be displayed:
optional arguments
| Argument | Abbrev | Description | Example |
|---|---|---|---|
| --help | -h | show help message and exit | -h |
| --start | -s | start Wow.exe after update | -s |
| --verbose | verbose debug output | --verbose |
required arguments
| Argument | Abbrev | Description | Example |
|---|---|---|---|
| --vault | -v | new or existing Vault name | -v github |
| --wow | -w | path to Wow.exe | -w "G:\World of Warcraft 3.3.5a HD\Wow.exe" |
| --config | -c | path to json config file | -c ".\config_335a.json" |
Launching from RELEASE version
- Download latest release
- Unpack to any folder
- Copy and edit
config.jsonas you need (see Configuration paragraph) - Run app with the
-hparameter viacmdorpowershellto read the help - As an example, use one of the following commands:
.\app.exe -v github -w ..\wow\Wow.exe -c .\config.json -s --verbose
.\AddOnsUpdateTool.exe -v github -w ..\wow\Wow.exe -c .\config.json -s --verbose
or the next one if you putAddOnsUpdateTool.exeandconfig.jsonin the game folder:
.\AddOnsUpdateTool.exe -v github -w -c -s --verbose
or even just startAddOnsUpdateTool.exeinside game folder - If you want, you can create a shortcut to start with the necessary arguments and place it on the desktop or start menu
Launching from SOURCE code
Running the script from source code will require some knowledge of both Git and Cmd/Powershell
Requirements
- Install Python 3.8 (recommended)
- Install Pipenv package via
pip install -U pipenv
Prepare
- Clone this repository
- Run
pipenv installinside repository directory - If successful, you can use
pipenv shellto open Pipenv Venv Shell inside
Launch
- Use
python .\app.py -hinside Pipenv Venv Shell to see the help page
Dev dependencies
If you want to change something in the code, I strongly recommend that you set the PEP-8 code formatter black and pyinstaller via pipenv install --dev command. Dont forget to re-format code after changes to keep it within the PEP-8.
Creating an EXE
To package a set of scripts into a standalone distributable directory, or a single EXE file, use the pyinstaller module:
pipenv run pyinstaller --onefile .\app.py-- for single EXE file (smaller size, but slower runtime due to the temp cache)pipenv run pyinstaller .\AddonsUpdateTool_dir.spec-- for standalone directory (larger whole folder size, but fast runtime)
Additional information
In addition to app.py I also provide scripts to manually update the Vault DB and the Game DB: vault_updater.py and game_updater.py. You can also use the -h argument to view the help page
8 Apr 28, 2022
2 May 18, 2022
11 Dec 15, 2022
1 Jan 30, 2022
51 Jun 14, 2022
36 Dec 30, 2022
49 Jan 1, 2023
6 Nov 24, 2022
4 Jan 20, 2022
5 Nov 21, 2021
4 Aug 06, 2022
0 Dec 26, 2021
1 Nov 04, 2021
25 Dec 23, 2022
1 Dec 26, 2021
0 Dec 18, 2021
25 Nov 24, 2022
94 Dec 15, 2022
3 Jan 29, 2022
3 Mar 02, 2022
5 Dec 24, 2021
26 May 21, 2022
15 Apr 12, 2022
41 Oct 25, 2021
4 Oct 12, 2022
2 Jul 12, 2022
16 Nov 05, 2022
1 Nov 30, 2021