*** Changelog ***
1.11.1: Verify build consistent against Strongbox and CurseForge. No user-facing changes.
1.11.0: Clearer labels throughout, one Soul shard limits box, and Delete Shard says why it's grey right on the button.
1.10.2: The README and the CurseForge page are rewritten. Under the hood cleanup; nothing you see changed.
[..] Full changelog
- NEW: Delete Shard says why it's grey, right on the button.
- NEW: Guided onboarding that knows your level: before Drain Soul, SSF stays quiet; learn it, and the welcome walks you through setup.
- NEW: Low shard mark stops at your cap: the slider shows the cap in gold and dims the track past it.
- NEW: Shard count on data broker bars (Titan Panel, EllesmereUI's data bars and the like).
- NEW: Delete Shard sits right beside your shard count at the top of the window.
- NEW: The minimap tooltip shows your count, cap, low mark and pause, every time.
- NEW: One click makes the recommended macros: Create macros, at the bottom left of the window.
- NEW: In-game tooltip help: click the "i" in the window.
- NEW: SSF Mode: shards move into your soul bag, and nothing else in your bags moves.
- NEW: Pause all SSF actions so you can stockpile for raid night.
- NEW: Shard count on your soul bag.
- NEW: Sort mode: shards in a block, top down or bottom up.
- NEW: Language localization.
- NEW: Soul Bag support!
A Warlock addon that keeps your Soul Shards at a cap you set. Each press of a key, a macro line or a button deletes one shard if you're over the cap and moves shards into your soul bag, but never in combat. It can show your shard count on the bag bar, color-coded, and glow the bag button when you're running low. A new feature is a pause so you can stockpile for an instance or summoning session without dragging your sliders around.
Why did I write it? The shard addon I used for years had no Forever port when I started (and was somewhat dated). There are a handful of addons that do shard management, but they tend to be hard to configure or have features not related to the task at hand. So this addon is focused on one thing only: deleting soul shards and showing you when you're low.
This addon is for Forever only, and not tied to backwards compatibility.
The game lets an addon destroy one item per keypress, and none in combat. SSF deletes one shard per event, but only when you're over the cap, and it does nothing while you're fighting. It always moves shards into your soul bag when out of combat and not paused, cap or not. Call it however you like:
-
A key. Open the options window (
/ssf, or the minimap icon) and click Keybindings. Bind Delete Shard, and Pause all SSF actions if you want it. -
From chat.
/ssf delete -
A macro. On the line before an ability you spam. Every press trims one shard when you're over the cap, and moves shards into your soul bag.
#showtooltip /ssf delete /cast Life Tap#showtooltip /ssf delete /cast Bane of AgonyLife Tap never puts you in combat. The Bane one deletes on the move: with no target it doesn't cast, but the delete still fires. Don't use it with an enemy targeted, or you're in combat before the delete fires.
Or let SSF make both: click Create macros at the bottom left of the window (it shows while either is missing), then Create recommended macros. SSF makes them as SSF_LT and SSF_BoA, reloads your UI, and opens the macro window with them glowing until you drag them onto a bar.
-
The Delete Shard button in the GUI window, right beside your shard count. When a click can't delete, it's greyed out with the reason on the button: your cap (cap is 8), SSF paused or no Drain Soul yet. The window closes itself when a fight starts and opens again only after it.
Every press deletes first if you're over the cap: the shard nearest the backpack goes, so loose shards go before your soul bag's. Then it moves loose shards into free slots in your soul bag, bottom slots first. No soul bag, or a full one? Nothing moves. Nothing else in your bags is touched unless you pick one of the sort modes.
- Pause all SSF actions stops every press from moving or deleting, for when you want to stockpile shards (raid night: soulstones, healthstones, summons). Your cap stays as it is. While paused the count goes white everywhere and the bag button's red border stays off: you're stockpiling on purpose, so no red and no yellow until you unpause. Colorize bag counter and Glow bag button when low grey out and keep their ticks. Play pause sound plays a soft bag thunk on every paused press, at the volume you pick. Log pauses to chat prints a line to chat as well. In combat a press does nothing, paused or not.
- Shards to keep is the cap, 1 to 100. Use the slider or use the − and + to fine tune.
- Match soul bag size ties the cap to your soul bag's slot count while one is equipped (all of them, if you carry more than one), and writes that number into Shards to keep, so unticking it leaves the cap at the bag size.
- Low shard mark is your low mark, 1 to 100. Below it the shard count turns red and the bag button gets a red border. It can't go above the cap: the slider stops there, the track past the cap is dimmed with a gold line where the cap sits, and if the cap drops under your mark, the mark follows it down and stays. Same slider and − and + as the cap.
- Show shard counter on bag bar is on by default. It puts the number on your far-left bag. Green in range, yellow over the cap, red when you're low, white while paused or before you learn Drain Soul. Pick the font, or turn the colors off on the bag (the window, tooltip and chat keep them).
- Glow bag button when low, under the count, puts a red running border on the bag button while you're under the low mark, so you remember to farm shards before you run out. It shows only while the count shows. Show counter on soul bag is on by default too: the number sits on your soul bag instead, in whatever slot it's in. Untick it to keep the number on your far-left bag.
- How shards move is SSF Mode by default: shards move into your soul bag, and nothing else in your bags moves. Sort top down and Sort bottom up move your other items aside so the shards sit in a block, from the top down or from the bottom up. A soul bag still fills first. With help on, its tooltip describes each choice.
- Log deletions to chat is off by default. Turn it on to see a chat line for each deleted shard, or for addons that watch chat (like MSBT).
- Language is Auto by default, which follows your game client. Pick English, Deutsch, Français, Español, Português or Русский to override it.
The gold "i" next to the window's X turns tooltip help on: hover any option, Delete Shard or Keybindings to see what it does. It turns blue while on, and it's off again after a /reload. The first time a character loads SSF, the window opens with help already on and a welcome screen beside it: every way to delete, and a button that makes the two macros. You see it once per character, and once more when a new version changes it. Create macros brings it back. Before you learn Drain Soul, SSF stays quiet: the count is white and the welcome says so; learn the spell, and the welcome comes back once, when shards start dropping.
The minimap icon opens and closes the window. Its tooltip always shows the count in its color, your cap, your low shard mark and whether SSF is paused. On a data broker bar (Titan Panel, EllesmereUI's data bars and the like) SSF shows the count alone in its color, with the same tooltip and click. Settings are per character.
| Command | What it does |
|---|---|
/ssf |
Opens the options window, and shows pause state, count and cap |
/ssf help |
This list (/ssf ? does as well) |
/ssf delete |
Delete one shard if over the cap, then move shards |
/ssf pause on/off |
Pause all SSF actions. Naked shows status |
/ssf setmax N |
Set the cap, and turn off Match soul bag size. Naked shows cap |
/ssf log on/off |
Chat line per deletion. Naked shows status |
/ssf options |
Opens the GUI window (/ssf settings does as well) |
Tab autocompletes the SSF commands in chat (try it, I hate typing). /click SSFDelete does the same as /ssf delete (for keybind addons that can't run slash commands).
MIT, see LICENSE.
Bundles Ace3 (with CallbackHandler), AceGUI-3.0-SharedMediaWidgets, LibSharedMedia, LibCustomGlow, LibDataBroker, LibDBIcon and LibStub. Each keeps its own license.