Instance Collection Helper

# InstanceCollectionHelper
This document describes changes to each version of **Instance Collection Helper (ICH)** and will be updated with each new release.

Release versions suffixed with a lowercase letter are considered unofficial _alpha_ or _early access_ versions.

## Changes
**v20.1**
- *Bug Fix:* Removed Normal and Heroic difficulty options for **The Writhing Brood** so that it now correctly shows that the mount drops in Mythic only

**v20**
- **Major update:** Added **World Tour**, a guided farming route that walks you through zones and instances to pick up any mounts, toys, pets, or decor you're still missing (*BETA feature*)
  - Farming route is based on the Mount Planner feature from [Simple Armory](https://simplearmory.com)
  - Choose which collectible types (mounts, toys, pets, decor) to include in the route
  - Automatically drops a map pin (or TomTom waypoint, if enabled) for each stop along the route
  - Hovering a collectible along the route shows the boss it drops from, its difficulty, and any special collection notes
  - Route accounts for faction-specific travel paths for Alliance and Horde
  - Starts fresh each time you log in or switch characters
  - Accessible via the `/ich wt` command
- Updated collectible data and instance drops for patch 12.1.0
- Added waypoints for the Battle for Azeroth Timewalking vendor (Alliance and Horde), along with an accurate waypoint for the Eternal Palace raid entrance and a dynamic Ny'alotha entrance waypoint based on its weekly rotation
  - Added a note indicating a quest may need to be completed before the Ny'alotha entrance appears on the map
- Improved the appearance of guide tooltips (e.g. difficulty and helper buttons) using a custom tooltip window
- *Bug Fix:* Removed 'Mythic Flex' as an available difficulty option for Sporefall since it's not a difficulty that can be set in-game

**v19**
- **Major update:** Added support for advanced searching using `&` (AND), `|` (OR), and `!` (NOT) logical operators, as well as grouping search expressions with parentheses
- **Major update:** Added a "Show Available Only" filter to hide collectibles that are no longer obtainable due to a daily or weekly lockout being in place
  - Restricts Timewalking vendor items to those available during the currently active Timewalking event, or none if no event is active
- Updated the active Timewalking event's expansion name in the Timewalking tab to appear in green
- Updated Mini-Window collectible tooltips to include a colored indicator for whether the item can be looted in the current lockout
- Added tooltips to footer checkboxes to elaborate on what each option does
- Expanded the "How To Use" tooltip with additional guidance covering favorites, column sorting, item previews, footer checkbox behavior, and the mini-window
- Expanded the "Search Hints" tooltip with additional examples covering dungeon and raid type filters, boss and zone name searches, expansion abbreviation shortcuts, and boolean operator syntax
- Updated frame strata for the main window and footer to reduce overlap with other AddOn frames
- *Bug Fix:* Corrected an issue where special characters such as `(` or `+` in search queries could cause errors due to the AddOn's search processing logic

**v18.3**
- Updated Mini-Window collectible tooltips to display the boss that drops each item and any special collection notes where applicable
- Added a collection note for Luminous Sporeglider indicating the Delicious Sporesnack requirement

**v18.2**
- Replace mount previews in the mount journal with a single dressing room window preview
- Add dressing room window previews for pet and decor items
- Updated frame strata for multiple AddOn windows

**v18.1**
- *Bug Fix:* Corrected code that resulted in bosses with special characters in their name to not be correctly flagged as killed

**v18**
- **Major update:** Added a standalone **Settings** panel, accessible by right-clicking the minimap icon or the `/ich config` command
  - Provides the ability to clear favorites by category or across all categories in bulk
- **Major update:** Introducing the **Mini-Window**, a small, movable floating frame that automatically appears when entering a dungeon or raid instance
  - Displays icons for all uncollected mounts, toys, pets, and decor items available at the current difficulty
  - Hovering over any icon displays the full item tooltip
  - Automatically updates when the instance difficulty is changed
  - Automatically hides when no uncollected items remain for the current instance and difficulty
  - Enable or disable this via settings or the `/ich mini` command (disabled by default)
- Updated the minimap icon tooltip to more broadly describe the addon's capabilities
- Updated addon media assets to use TGA images instead of PNGs
  - **Breaking change** for AddOns that reference the PNG versions of this AddOn's images
- Updated localization for all supported languages with previously missing entries
- *Bug Fix:* Corrected lockout detection for collectibles that don't drop from a single boss in an instance
  - Collectibles are now only treated as unavailable once an instance has been fully cleared rather than whenever any saved lockout exists
- *Bug Fix:* Corrected an issue with pet ownership detection that could produce an incorrect ownership result

**v17**
- **Major update:** Added the ability to mark any item as a "favorite".
  - Favorited items will always appear at the top of their respective lists and are stored on an account-wide basis.
- **Major update:** Added the ability to sort by a column's values
  - Mounts, toys, pets, and decor: Sortable by collectible name or instance name
  - Timewalking vendor items: Sortable by name, type, expansion, or cost
  - Sort direction cycles ascending → descending → none and resets when switching tabs
  - Name column only cycles between ascending and descending
- Updated list data and AddOn compatibility for patch 12.0.7
- Minor code refactoring and cleanup
- *Bug Fix:* Corrected an issue where items from a previously viewed tab could appear in the list when scrolling through a different tab's content

**v16.3**
- Fixed `koKR` localization loading
- Fixed a bug causing owned decor items to not be marked as owned in the list

**v16.2**
- Add localization for remaining supported languages (`esES`, `frFR`, `itIT`, `koKR`, `ruRU`)
- Add `enUS` localization string for AddOn title (future-proofing)

**v16.1**
- Add missing localization strings
- Fix duplicate/incorrect localization string keys

**v16**
- Remove **Legion: Remix** tab from view
- Add missing toys and decor items from Midnight instances
- Update AddOn for 12.0.1 compatibility

**v15.1**
- Fixed an issue causing tabs to not open if there was data missing for decor items

**v15**
- **Major update:** Enabled **Decor** tab (previously called **Housing**) and add all decor items currently available as drops from instances
  - Items in this tab can also be searched by using housing category keywords such as "alliance", "elven", "indoors", "outdoors", etc.
- **Major update:** Added missing cosmetic and decor items to **Legion: Remix Vendor** tab
- Added *Slime Serpent* to **Mounts** tab
- Fixed an issue causing searching for a collectible by zone/map name to not consistently show appropriate results
- Fixed a few bugs with items shown in the **Legion: Remix Vendor** tab
- Added the toy *Skull of Corruption* to the **Legion: Remix Vendor** tab
- Updated waypoint tooltips for **Legion: Remix** collectibles to also indicate which instance they can be found in (if applicable)
- Fixed a bug that caused a Lua error to occur when searching with keywords "dungeon" or "raid" in the **Timewalking Vendor** and **Legion: Remix Vendor** tabs
- Minor code refactoring

**v14**
*Code refactors only, no changes to addon features or capabilties*

**v13**
- Decor tab added (to be populated soon)
- Added remaining purchasable cosmetics to **Legion: Remix Vendor** tab
  - Remaining open world/questing sets
  - Dungeon sets
  - Raid sets
  - Lost and Found
- Added Shadowlands items to **Timewalking Vendor** tab
- Update AddOn to check for updates to item ownership in real-time more consistently
- Fixed a bug that caused the mount journal to occasionally open when the icon for a toy, pet, or cosmetic was clicked
- Fixed a bug that caused multiple chat messages to be sent when transferring a Warbound currency was not possible

**v12.3**
- Begin adding all remaining cosmetics and ensembles to **Legion: Remix Vendor** tab
  - Currently available cosmetics: All extra rares, Remix exclusive sets, and open world/questing sets (Phase I only)

**v12.2**
- Fixed bug causing class mounts to appear with incorrect phases sometimes
- Improved highlighting of class mount achievement names in notes
- Added Llothien Prowler to list of available mounts from Remix vendor

**v12.1**
- Add ability to open currency transfer menu for Bronze
- Fixed a bug where the Mage class mount from Remix was missing a phase
- Added ability to filter Remix list by phase

**v12**
- **Major update**: Added a tab to find mounts, pets, toys, and cosmetics that are purchasable from **Legion: Remix Vendors**
- Expanded search capabilties for **Timewalking** and **Legion: Remix Vendor** items
- Updated tooltip text for searching by expansion name/abbreviation
- Updated text displayed for `enUS`, `esMX`, `ptBR`, and `deDE` locales

**v11.2**
- Code cleanup and minor optimizations
- Updated AddOn category to "Collections" for in-game AddOn menu
- Modified CHANGELOG text for `11.1`

**v11.1**
- Added **Aerial Unit R-21/X** to list of available mounts (dropped by King Mechagon, not awarded for the Hard Mode achievement)

**v11**
- **Major update**: New tab for items available at Timewalking vendors along with each of their cost
- **Major update**: AddOn Compartment button to enable hiding the minimap button as per preference is now available
- Fixed a bug where pets could not be filtered by zone and/or sub-zone

**v10**
- **Major update**: Added a list of pets that are available from dungeons and raids as of Patch 11.2 (*Ghosts of K'aresh*)
- **Major update**: Expanded search capabilities to include expansion, instance zone, and continents for select instances
- Added **Stonevault Mechsuit** to list of available mounts from instances
- Added lockout tracking for 40 player raids and pre-Seige of Orgrimmar LFR raids
- Refactored search code to reduce redundancy
- Updated text displayed for `enUS`, `esMX`, `ptBR`, and `deDE` locales
- Updated `/ich` command to toggle the AddOn window instead of just showing it
- Updated code documentation

**v9**
- Updated tooltip for instance icon to show which boss drops a collectible
- Improved method for fetching toy info quicker
- Updated available instance difficulties for toys from **Seat of the Triumvirate**
- Updated notes for **Fandral's Seed Pouch** to indicate additional availability in Timewalking Firelands
- Updated AddOn category
- Updated code documentation

**v8**
- Fixed a bug causing mounts to not display when using the search bar

**v7**
- **Major update:** Added tabs at the bottom of the window to switch between viewing mounts and toys available from instances
- **Major update:** Added a list of toys that are available from dungeons and raids as of Patch 11.2 (*Ghosts of K'aresh*)
- Updated all tooltips to match the one shown in-game for the given collectible
- Refactored code and made minor updates to the UI so that both mounts and toys can be accomodated
- Updated localization strings for supported locales (_still looking for translators!_)
- Updated the icon used for indicating a note on a list item
- Updated AddOn description (_README.md_) and code documentation

**v6**
- Created an "About" window for crediting translators and providing contact info for the AddOn
- Added a button for opening the "About" window with an _info_ icon
- Updated the icon for the "How to Use" tooltip of the AddOn to a _question mark_
- Updated the search bar functionality to filter results more accurately in all languages
- Minor code refactoring

**v5**
- Added Unbound Star-Eater from Manaforge Omega
- Fixed an issue that sometimes caused an error when viewing the note for **Cartel Master's Gearglider**

**v4**
- Added support for `zhCN` locale (_still looking for translators!_)

**v3**
- Added support for `zhTW` locale (_still looking for translators!_)
- Added a note about Karazhan's instance difficulty being 10 player by default regardless of player's settings
- Fixed a translation error where English users would see the note for Tazavesh in German

**v2**
- Added support for **TomTom** waypoints to be dropped at instance entrances with one click
- Added support for `ptBR` and `deDE` locales (_still looking for translators!_)
- Update AddOn for Patch 11.2 compatibility
- Improved text localization for all supported locales
- Documentation updates

**v1**
- Added ability to set Blizzard map pins on instance entrances
- Added support for `esMX` locale (_still looking for more translators!_)
- Updated AddOn UI and tooltip text
- Documentation updates

**v8b**
- Added a missing required dependency to the embedded files of the AddOn
- Minor code cleanup and documentation updates
- Set up framework for localization into non-English languages (_looking for translators!_)

**v8a**
- Update slash commands for setting instance difficulty to display a message when the chosen difficulty is already set
- Fix bug causing slider arrows to not resize the AddOn window
- Reduce minimum allowed value for UI slider to decrease window size beyond default

**v7a**
- Create a "search hints" tooltip to provide examples of how to use the search functionality
- Move the text explaining how the AddOn works into a tooltip
- Create buttons for both "search hints" and "how it works" to show the appropriate tooltip
- Added option to increase the UI size as desired
- Added an option to show owned mounts in the list (indicated with a green background)

**v6a**
- Added a search bar to filter the list of available mounts
- Fixed some typos in instance names
- Added LFR button for tracking completed Raid Finder lockouts
- Update difficulty buttons to be disabled when legacy raid is completed on a different difficulty (shared difficulty lockouts)

**v5a**
- Add difficulty button for **Ashes of Al'ar** to help track weekly lockout
- Added slash commands to update instance difficulty from chat window:
  - `/ich dung` for dungeons
  - `/ich raid` for raids
  - `/ich lraid` for legacy raids
- Updated notes for some mounts

**v4a**
- Update AddOn logo
- Add missing mounts to list
- Update difficulty button colors
- Update some mount-related data
- Added command `/ich diffs` to view all instance difficulty settings at once

**v3a**
- Fixed a bug where _Blizzard_ boss names sometimes didn't correctly match what Blizzard calls the boss in the Encounter Journal
- Updated dependencies that caused issues on load sometimes
- Updated the list to show correct lockout info immediately after opening

**v2b**
- Load necessary _Blizzard_ AddOns when initializing

**v2a**
- Fix bug where owned mounts weren't updated automatically on login

**v1a**
- Initial release