Update changelog

In case a user has misplaced their Breakable window, this allows it to be reset.

It also groups the settings together so that Reset can't be pressed accidentally.

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# description of this workflow, can be anything you want
+name: Package and release
+
+# we need to let GitHub know _when_ we want to release, typically only when we create a new tag.
+# this will target only tags, and not all pushes to the master branch.
+# this part can be heavily customized to your liking, like targeting only tags that match a certain word,
+# other branches or even pullrequests.
+on:
+  push:
+    tags:
+      - '**'
+
+# a workflow is built up as jobs, and within these jobs are steps
+jobs:
+
+  # "release" is a job, you can name it anything you want
+  release:
+
+    # we can run our steps on pretty much anything, but the "ubuntu-latest" image is a safe bet
+    runs-on: ubuntu-latest
+
+    # specify the environment variables used by the packager, matching the secrets from the project on GitHub
+    env:
+      CF_API_KEY: ${{ secrets.CF_API_KEY }}
+      WOWI_API_TOKEN: ${{ secrets.WOWI_API_TOKEN }}
+      WAGO_API_TOKEN: ${{ secrets.WAGO_API_TOKEN }}
+      GITHUB_OAUTH: ${{ secrets.GITHUB_TOKEN }}  # "GITHUB_TOKEN" is a secret always provided to the workflow
+                                                 # for your own token, the name cannot start with "GITHUB_"
+
+    # "steps" holds a list of all the steps needed to package and release our AddOn
+    steps:
+
+      # we first have to clone the AddOn project, this is a required step
+      - name: Clone project
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # gets git history for changelogs
+
+      # once cloned, we just run the GitHub Action for the packager project
+      - name: Package and release
+        uses: BigWigsMods/packager@v2
+
+      # another example where we supply additional arguments, this example is specifically to release
+      # for the Classic version of the game
+      - name: Package and release for Classic
+        uses: BigWigsMods/packager@v2
+        with:
+          args: -g classic -w 0
+
+      - name: Package and release for TBC
+        uses: BigWigsMods/packager@v2
+        with:
+          args: -g bcc -w 0
+
+      - name: Package and release for Wrath
+        uses: BigWigsMods/packager@v2
+        with:
+          args: -g wrath -w 0

.mailmap

@@ -0,0 +1,4 @@
+parnic <parnic@parnic.com> Parnic <chris@parnic.com>
+parnic <parnic@parnic.com> Parnic <parnic@parnic.com>
+parnic <parnic@parnic.com> Chris Pickett <cpickett@perniciousgames.com>
+parnic <parnic@parnic.com> root <root@parnic.com>

.pkgmeta

@@ -34,4 +34,11 @@ externals:
     libs/LibBabble-Inventory-3.0:
         url: svn://svn.wowace.com/wow/libbabble-inventory-3-0/mainline/trunk
         tag: latest
-    libs/LibButtonFacade: svn://svn.wowace.com/wow/buttonfacade/mainline/trunk/Libs/LibButtonFacade
+
+ignore:
+    - readme.md
+    - FUNDING.yml
+
+manual-changelog: changelog.txt
+
+enable-nolib-creation: yes

Breakables.toc

@@ -1,11 +1,23 @@
-## Interface: 40000
+## Interface: 100002
+## Interface-Retail: 100002
+## Interface-Classic: 11403
+## Interface-BCC: 20504
+## Interface-Wrath: 30400
 ## Author: Parnic
 ## Name: Breakables
 ## Title: Breakables |cff7fff7f-Ace3-|r
 ## Notes: Tracks herbs/ore/items that can be broken into component pieces
-## Version: @project-version@ (Revision: @project-revision@)
+#@debug@
+## Version: development
+#@end-debug@
+#@non-debug@
+# ## Version: @project-version@
+#@end-non-debug@
 ## SavedVariables: BreakablesDB
-## OptionalDeps: Ace3, LibBabble-Inventory-3.0, ButtonFacade
+## OptionalDeps: Ace3, LibBabble-Inventory-3.0, Masque
+## X-Curse-Project-ID: 16629
+## X-WoWI-ID: 17929
+## X-Wago-ID: rkGrlA6y
 
 #@no-lib-strip@
 embeds.xml
@@ -14,4 +26,4 @@ embeds.xml
 LibDataBroker-1.1.lua
 loc\loc.xml
 
-Breakables.lua
+Breakables.lua

FUNDING.yml

@@ -0,0 +1,3 @@
+github: parnic
+ko_fi: parnic
+custom: "https://www.paypal.me/parnic"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 parnic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

changelog.txt

@@ -0,0 +1,243 @@
+v1.9.4:
+
+- Update TOC for 10.0.2
+
+v1.9.3:
+
+- Fix error on 10.0.0
+
+v1.9.2:
+
+- Dragonflight/10.0.2 compatibility
+- Add ability to reset placement of the bar in case it gets lost somehow.
+- Shuffled settings into their own categories to make accidental resets unlikely.
+- Fix items being added to the ignore list both on press and release. This would frequently mean that two items would get ignored instead of just the one you wanted to click on.
+
+v1.9.1:
+
+- Fix right-click ignore functionality after the upgrade to 10.0.
+
+v1.9.0:
+
+- Handle gaining and losing a Breakable skill without requiring a UI reload
+- Update TOC, fix button clicking bug for 10.0
+
+v1.8.7:
+
+- Improve reliability of UI updates after picking lockboxes. There's no good game event for "locked item opened", so this uses some best-guess heuristics to make it function as expected in most cases.
+
+v1.8.6:
+
+- Improve enchanting level detection for Wrath Classic
+- Add option to ignore enchanting skill level for showing disenchantable items
+
+v1.8.5:
+
+- Wrath Classic compatibility
+- Updated TOCs
+
+v1.8.4:
+
+- Updated TOCs
+
+v1.8.3:
+- Updated TOCs, added 9.1 and 9.2 herbs, ore, and lockboxes
+
+v1.8.2:
+- Updated TOCs for 9.1.5, Classic, and BCC
+
+v1.8.1:
+- Updated TOC for 9.1
+
+v1.8.0:
+- Classic-BC support
+- Added option to hide during pet battles, by request.
+
+v1.7.4:
+- Fix an issue when IsArtifactRelicItem is not defined
+
+v1.7.3:
+- Add option to suppress tooltips by request
+- Updated Classic TOC to 1.13.6
+
+v1.7.2:
+- Updated TOC for 9.0.5
+
+v1.7.1:
+- Updated TOC to latest
+
+v1.7.0:
+- Added Shadowlands herbs, ore, and lockboxes
+- Updated TOC for 9.0
+
+v1.6.4:
+- Updated TOC for 8.3
+
+v1.6.3:
+- (Classic) Made all items display as disenchantable whether you have the skill for it or not. I have not yet found the correct way to access the player's Enchanting profession level to check against item level for disenchant validity.
+
+v1.6.2:
+- Added 8.2's lockboxes
+
+v1.6.1:
+- Added patch 8.2's new herb and ore
+
+v1.6:
+- Updated TOC for 8.2
+
+v1.5.1:
+- Updated TOC for 8.1
+- Added Highmountain Armor as a disenchantable item
+
+v1.5:
+- Updated TOC for 8.0
+- Added BfA herbs and ore
+- Fixed separate items sometimes showing up as one breakable
+- Added Leystone Lockbox
+
+v1.4.9.1:
+- Added 7.3 herbs and ore
+
+v1.4.9:
+- Updated TOC for 7.3
+
+v1.4.8:
+- Fixed error in ignored items when the ignored item had not been loaded by the server since the last restart.
+- Updated TOC for 7.2
+
+v1.4.7:
+- Fixed up milling herbs that the player knows Mass Milling for. Since Mass Mill is a profession ability and not a player ability/"spell", the addon can't currently automatically cast Mass Milling.
+
+v1.4.6:
+- Added MoP Sparkling Shard as a combinable object.
+- Added support for registering artifact relics as disenchantable.
+- Added an ignore feature so certain items can be set to never show up as breakable.
+
+v1.4.5:
+- Updated TOC for 7.1
+
+v1.4.4:
+- Cap the disenchantable item rarity for Legion items at Epic (so we don't show the player's artifact weapon as disenchantable).
+- Automatically update the tooltip when the breakable list is updated while the player is hovering over a breakable item button.
+- Update the tooltip when the player presses Shift so that disenchantable items show what the player currently has equipped to compare against quickly.
+
+v1.4.3:
+- Fixed up Mass Milling support.
+- Fixed the mod accidentally trying to break the wrong stack of something if, for example, you had a smaller stack placed in front of a larger stack in your bags.
+- Fixed the mod sometimes failing to break something if you had 2 similarly-named items in your bags in a specific order (Whiptail Stems in front of Whiptails, for example).
+- Added better support for disenchanting items in WoD and higher where Enchanting skill level is not a factor in whether you can disenchant an item or not.
+- Made the breakable bar respond to changes much faster so it's less frustrating to work with.
+- Added support for combining items that then result in more breakables ("broken"/"stem" versions of herbs which can be combined into their proper breakable types) so it can all be done from the Breakables bar.
+
+v1.4.2:
+- Added support for Legion ore since the ore items don't match previous expansions.
+
+v1.4.1:
+- Added support for Mass Milling. Mass Milling of a particular herb type will be automatically chosen when clicking on an herb type if that herb is eligible for mass milling and the player knows that mass milling spell.
+- Added support for Legion herbs
+
+v1.4:
+- Updated TOC for patch 7.0
+
+v1.3.21:
+- Updated TOC for patch 6.2
+- Cleared the tooltip after successfully breaking an item so that we don't keep stale tooltips around.
+
+v1.3.20:
+- Updated TOC for patch 6.1
+
+v1.3.19:
+- Stopped True Iron Ore from showing up as prospectable.
+
+v1.3.18:
+- Changed garrison follower armor items to not show up as disenchantable.
+
+v1.3.17:
+- Revised WoD herb fix such that it doesn't cause the game to flag false positives on herbs that are not millable.
+
+v1.3.16:
+- Made WoD herbs show up as millable. They weren't showing up before because they don't contain the "millable" text in the tooltip like every other herb in the game does.
+
+v1.3.15:
+- Switched from LibButtonFacade to Masque (ticket #20).
+
+v1.3.14:
+- Added WoD lockboxes/junkboxes. Oops.
+
+v1.3.13:
+- Updated TOC for patch 6.0
+
+v1.3.12:
+- Updated TOC for patch 5.4
+- Make sure to update the breakables list whenever a tracked tradeskill is updated in case we can then break down new items (right now, that's only enchanting).
+- Added option to hide tabards from the list of breakables. (ticket #16)
+- Only display items the player is capable of disenchanting.
+- Suppress account-bound and bnet-account-bound items when "show soulbound items" is unchecked.
+
+v1.3.11:
+- fixed soulbound items not being ignored sometimes despite the option being checked
+- added lockboxes to the pickable items list
+
+v1.3.10:
+- updated TOC for patch 5.3
+
+v1.3.9:
+- updated TOC for patch 5.2
+
+v1.3.8:
+- updated TOC for patch 5.1
+
+v1.3.7:
+- fixed recognition of MoP junkboxes, herbs, and ore
+
+v1.3.6:
+- updated TOC for patch 5.0.4
+
+v1.3.5:
+- updated TOC for patch 4.3
+
+v1.3.4:
+- updated TOC for patch 4.2
+
+v1.3.3:
+- updated TOC for patch 4.1
+- ticket #10: look through the first 5 lines of the tooltip to find "millable" or "prospectable" instead of requiring it to be on line 2
+- moved LibButtonFacade's Group:Skin call from :OnInitialize() to :OnEnable(). apparently OnInitialize is too soon and causes the custom skin to get overwritten. (ticket #9)
+- added tracking for rogue junkboxes (obtained via 'pick pocket'). clicking the junkbox will automatically unlock it
+- shortened the delay for processing items after a BAG_UPDATE to 1 second (from 1.5)
+
+v1.3.2:
+- properly parented the Breakables frame to UIParent so that it will go away when the user presses alt-z (thanks slayman). note that this change makes the Breakables frame use the UI Scale specified in video settings so it may initially not be in the same location you last set it to and could be a different size.
+
+v1.3.1:
+- fixed a bug where the tooltip could be completely wrong or empty sometimes
+
+v1.3:
+- fixed an error about AceGUI and AceConfigDialog that were showing up on load in certain situations
+- minor garbage/performance fixes
+- added spell tooltip to profession button
+- added ButtonFacade support (ticket #7)
+- added option to specify which direction the buttons grow toward (by Slayman's request)
+- enabled new target-item/spell attributes for secure buttons instead of hacking together a macro
+- don't show heirloom items as disenchantable
+
+v1.2.2:
+- fixed bar position not being saved/restored properly when moved out of the upper left section of the screen
+
+v1.2.1:
+- fixed reported error message
+
+v1.2:
+- created one bar per profession for the case where someone has some combination of inscription, enchanting, and jewelcrafting
+- set bar to update immediately after clicking an item to break it instead of waiting the 1.5 seconds. it was making life harder for mass breaking
+- added button scale and font size options
+- added localization support
+- optimized a little bit of the code that finds breakables in your bags by delaying checks on BAG_UPDATE until 1.5 seconds after the last update request has come in
+- set the button font for item counts to use NumberFont_Outline_Med so that any font overrides (like tekticles) work automagically
+- added LibDataBroker support
+- added option to hide the bar entirely (ticket 5) and option to hide the bar when in combat
+- added short description to the config page explaining the functionality in the mod and how to get support/request features
+- made all slash commands print something back to the user so they know what they changed
+
+v1.1:
+- added ability to hide soulbound disenchantable items that are part of an equipment manager set (since some quest rewards and such are soulbound but the player doesn't actually use them)

embeds.xml

@@ -1,4 +1,5 @@
 <Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd">
+<!--@non-debug@
   <Script file="libs\LibStub\LibStub.lua"/>
   <Script file="libs\CallbackHandler-1.0\CallbackHandler-1.0.lua"/>
   <Include file="libs\AceAddon-3.0\AceAddon-3.0.xml"/>
@@ -10,5 +11,5 @@
   <Include file="libs\AceEvent-3.0\AceEvent-3.0.xml"/>
   <Include file="libs\AceLocale-3.0\AceLocale-3.0.xml"/>
   <Include file="libs\LibBabble-Inventory-3.0\lib.xml"/>
-  <Include file="libs\LibButtonFacade\LibButtonFacade.xml"/>
-</Ui>
+@end-non-debug@-->
+</Ui>

readme.md

@@ -0,0 +1,19 @@
+### **Description**
+
+Displays a bar on screen that allows quick access to enchanting, jewelcrafting, and inscription professions by presenting a Disenchant/Prospect/Mill button and all of the breakable items you have for that profession next to it. Also displays a bar for any locked junkboxes in your inventory if you're a Rogue. This allows one-click access for breaking down items instead of finding the item in your bag, clicking the appropriate profession/skill button, and clicking the item for each and every item you want to break. For prospecting and milling, you will see the number of items you have alongside the number of times you can break it. In the prospecting screenshot on the right, the player has 169 total Saronite Ore in his bags which will allow for 33 total prospects.
+
+### **Usage**
+
+By default, if you have the appropriate profession and items in your inventory, a bar will appear with the profession ability followed by any items that are eligible for breaking. You can hold shift to drag the bar around if you want to move it. Clicking the profession button will activate that ability (disenchant/prospect/mill) and clicking an item will break it. You don't have to click the profession button first as simply clicking the item will automatically break it down.
+
+### **Configuration**
+
+Typing */brk* will open the configuration settings (or you can get to it from Blizzard's Interface options) which consist of:
+
+* **Hide if no breakables**: this will control whether you see the profession button or not when nothing breakable is detected
+* **Max number to display**: this controls the highest number of items that you will see next to your profession button. If this is 5 but you have 10 breakable items in your bags, you will only see 5 at a time.
+* **Show soulbound items**: aimed at enchanters, this controls whether or not you will see items that are soulbound as breakable items or not.
+
+### **Known issues**
+
+* If you have more than 5 of a breakable item but split into stacks all smaller than 5, the game will say you do not have enough items to break. The default UI now has a built-in button to compress stacks that should solve this issue.