Skip to content

Commit

Permalink
fixed bug in emergency 'short' catalogue generation
Browse files Browse the repository at this point in the history
 it would include addons from BFA instead of stopping at Shadowlands
README
TODO
  • Loading branch information
Torkus committed Jul 24, 2024
1 parent a4caa42 commit 0821b88
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 13 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

* fixed bug in emergency 'short' catalogue generation.
- it would include addons from BFA instead of stopping at Shadowlands.

### Removed

## 7.4.0 - 2024-07-19
Expand Down
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Java users can run Strongbox using the `.jar` from the [releases](https://github

## Usage

Strongbox works by matching installed addons to a catalogue of addons available online.
Strongbox works by matching installed addons to a [catalogue of addons](https://github.com/ogri-la/strongbox-catalogue) available online.

Some addons are matched directly to the catalogue but others may require you to search the catalogue and re-install them
before that match can be made.
Expand Down Expand Up @@ -144,7 +144,7 @@ This software interacts with the following remote hosts:

These hosts *may* redirect requests to other hosts.

These interactions use a HTTP user agent header unique to Strongbox so that it may be identified easily:
These interactions use a HTTP user-agent header specific to Strongbox so that it may be identified easily:

"strongbox/x.x (https://github.com/ogri-la/strongbox)"

Expand Down Expand Up @@ -174,11 +174,11 @@ Running Strongbox with `--debug` will generate a file called `debug.log` that I

### classic and retail addon support

"Classic", "Classic (The Burning Crusade)", "Classic (Wrath of the Lich King)" and "Retail" versions of WoW are all
"Classic", "Classic (The Burning Crusade)", "Classic (Wrath of the Lich King)" etc and "Retail" versions of WoW are all
distinct addon systems.

Some addons support all systems in a single download, some support classic as an alternate build of the same addon,
some addons support classic only, some addons have been split up into multiple addons. There is a lot of variation.
Some addon authors support all systems in a single download, some support classic as an alternate build of the same addon,
some addons support classic only, some addons have been split up into separate addons. There is a lot of variation.

Click the drop-down next to your addon directory and select either `retail`, `classic` or `classic (TBC)`.

Expand All @@ -193,7 +193,7 @@ the same addon directory. If an addon is available for multiple addon systems it
* `classic (WotLK)` will prefer `classic (WotLK)` addons, then `classic (Cata)`, then `classic (TBC)`, then `classic` then `retail`
* `classic (Cata)` will prefer `classic (Cata)` addons, then `classic (WotLK)`, then `classic (TBC)`, then `classic` then `retail`

If uncertain which addon system an installed addon supports, look at the `WoW` column value on the `installed` tab and
If uncertain which addon systems an installed addon supports, look at the `WoW` column values on the `installed` tab and
compare it to the `Version` value in the list of WoW [public client builds](https://warcraft.wiki.gg/wiki/Public_client_builds).

### install addons from URL
Expand All @@ -202,7 +202,8 @@ Strongbox supports installing addons using URLs from addon hosts.

Addons installed this way are always available regardless of the catalogue you've selected.

For example, addons imported from Github will be available even if you otherwise use wowinterface.com addons exclusively.
For example, addons installed directly from Github will be available even if you otherwise use wowinterface.com addons
exclusively.

Click `File` from the top menu and select `Import addon` and paste the URL of the addon you want to install.

Expand All @@ -220,8 +221,8 @@ When you search for an addon you are searching a list of thousands of addons tha
Click `Catalogue` from the top menu and choose your preferred catalogue.

The default catalogue is the 'short' catalogue. It contains all addons from all supported hosts that have been *updated*
since *the beginning of the previous expansion*. This is currently Battle For Azeroth, released 2018-08-14 and the
catalogue has approximately 2.8k addons.
since *the beginning of the [previous expansion](https://warcraft.wiki.gg/wiki/Expansion#World_of_Warcraft)*.
This is currently Shadowlands, released 2020-11-23 and the catalogue has approximately 2.8k addons.

The 'full' catalogue contains all addons from all supported hosts, ever, and is approximately 7.2k addons large. It
contains many unmaintained addons.
Expand All @@ -231,7 +232,7 @@ There are also per-host catalogues, like a 'wowinterface' catalogue, and Strongb
Catalogues are updated weekly. New addons released during the week will not be present until the next week. Addons can
be installed using its URL in these cases.

The 'user' catalogue is a little different. It's initially empty but grows as addons are starred while searching or
The 'user' catalogue is a little different. Its initially empty but grows as addons are starred while searching or
imported from addon hosts, like Github.
These addons also appear in search results. Individual addons from the user catalogue are checked for new releases
normally, but the catalogue itself can only be updated manually.
Expand Down
6 changes: 6 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ see CHANGELOG.md for a more formal list of changes by release
## todo

## todo bucket (no particular order)

* patch tooltip, support multiple game versions

* flathub, remove '(Flathub)' from .desktop file
- https://github.com/flathub/la.ogri.strongbox/issues/7

* remove support for parsing templated .toc keyvals: '# ## Key: Value'

* gui, 'set-icon' is taking a long time to do it's thing.
Expand Down
7 changes: 4 additions & 3 deletions src/strongbox/constants.clj
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

(def mascot "ᕙ[°▿°]ᕗ")

;;
(def release-of-previous-expansion
"'Shadowlands', released October 13, 2020. Used to shorten the 'full' catalogue.
https://warcraft.wiki.gg/wiki/Public_client_builds"
"2018-08-14T00:00:00Z")
"'Shadowlands', released November 23rd 2020. Used to shorten the 'full' catalogue.
https://warcraft.wiki.gg/wiki/Expansion#World_of_Warcraft"
"2020-10-23T00:00:00Z")

(def release-of-wow-classic
"the date wow classic went live (addon development may have started before that). Used to guess possible game tracks when it's ambiguous.
Expand Down

0 comments on commit 0821b88

Please sign in to comment.