OEVG/ShardCap
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: tidy README and remove unused client mods

Browse Source
This commit is contained in:
OEVG
2026-11-06 16:17:38 -04:00
parent e23e2c4454
commit 767fcb04f9
1 changed files with 28 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -22
View File
@@ -1,32 +1,32 @@
# ShardCap 2.1.1 (WoW 1.12.1 and WoW 1.18.1 Clients)
# ShardCap
[![ClassicAPI](https://img.shields.io/badge/ClassicAPI-Optional-yellow.svg)](https://github.com/brues-code/ClassicAPI)
[![Nampower](https://img.shields.io/badge/Nampower-Optional-yellow.svg)](https://github.com/brues-code/nampower)
Keeps your Soul Shards at a cap. Lightweight and silent by default.
Keeps your Soul Shards at a chosen cap, merges partial stacks, and sorts shards and warlock reagents into soul bags. Lightweight and silent by default.
Merges the original [ShardCap](https://github.com/dogmax/ShardCap), the stacking support from
[ShardCapPlus](https://github.com/akzkak/ShardCapPlus) and the soul-bag sorting idea from
[voxan-dev's fork](https://github.com/voxan-dev/ShardCap), and fixes their bugs.
For **WoW 1.12.1 and OctoWoW / TurtleWoW 1.18.1**. Current version: **2.1.1**. Client mods are optional; slash commands work without them.
## What it does
- **Trims to the cap when you leave combat** (or any time your bags change out of combat).
- **WoW 1.18.1 Clients stacking (3 per slot):** counts shards per stack and deletes *exactly* the excess,
splitting a stack if needed. 13 shards at cap 12 → deletes 1, not a whole stack of 3.
- **Deletes exactly the excess:** supports stacks of 3 on 1.18.1, splitting a stack if needed.
With 13 shards and a cap of 12, it deletes 1 shard.
- **Merges partial stacks** (e.g. 1 + 2 → 3) so shards use as few slots as possible.
- **Soul bag aware:** deletes shards in normal bags first (backpack first), keeps the ones in your
soul bag, and moves loose shards into free soul bag slots. Soul bag can be in any bag slot.
- **Warlock reagents into the soul bag (WoW 1.18.1 Clients):** Demonic Figurines and Infernal
- **Warlock reagents in the soul bag (1.18.1):** Demonic Figurines and Infernal
Stones are moved into free soul bag slots, filling from the end of the bag. Enough slots are always kept
free to hold your shard cap (e.g. cap 12 at 3 per slot = 4 slots), so reagents never crowd out shards.
Skipped on servers where shards don't stack. If the server refuses the move anyway, it stops
after one notice and doesn't retry that session.
- **Safe:** never acts while you hold something on the cursor or a stack is locked, and only
touches item ID 6265 (the 1.x addons matched any link containing "6265", e.g. item 16265).
- **Cursor and lock checks:** waits while you hold an item on the cursor and skips locked stacks.
Deletion matches Soul Shards by their exact item ID.
- **Options window** (needs ClassicAPI): Game Menu → AddOn Options → ShardCap, or `/shardcap options`.
- Settings from ShardCap 1.x are migrated automatically.
## Options window
With ClassicAPI installed, ShardCap adds two pages to the AddOn Options window:
- **ShardCap** — live counts (`Soul Shards: 5/12`, reagents, shards and reagents in the bank),
@@ -36,39 +36,45 @@ With ClassicAPI installed, ShardCap adds two pages to the AddOn Options window:
and automatic or manual soul bag selection per bag slot.
Changes apply immediately. **Cancel** (or Escape) restores the settings you had when you opened the
window, and **Defaults** resets the page you are on. Without ClassicAPI everything still works through
the slash commands.
window, and **Defaults** resets the page you are on. Restoring settings does not undo items already deleted or moved.
## Install
Put the `ShardCap` folder (containing `ShardCap.toc`) in `Interface/AddOns/`, replacing the old one.
If you download the repository as an archive, rename the extracted folder to `ShardCap` first —
WoW only loads an addon whose folder name matches its `.toc` file. Disable ShardCapPlus if you have
it — the addon warns you if both are on.
## Commands (`/shardcap` or `/scap`)
| Command | Effect |
|---|---|
| `/shardcap 12` | Set the cap (0–200) |
| `/shardcap` or `status` | Shards carried vs. cap (e.g. `5/12`), Demonic Figurines and Infernal Stones carried, soul bags, settings |
| `/shardcap` or `/shardcap status` | Show shard and reagent counts, soul bags, and settings |
| `/shardcap delete` | Trim right now, even in combat |
| `/shardcap spam` | Toggle chat notifications |
| `/shardcap sort` | Toggle merging/moving shards into the soul bag |
| `/shardcap combat` | Toggle trimming during combat |
| `/shardcap reagents` | Toggle moving Demonic Figurines / Infernal Stones into the soul bag |
| `/shardcap soulbag auto` / `1-4` | Auto-detect, or mark a bag as soul bag manually |
| `/shardcap soulbag auto` or `/shardcap soulbag 1-4` | Auto-detect, or toggle a bag slot as a soul bag (choose a number from 1 to 4) |
| `/shardcap options` | Open the options window (ClassicAPI) |
| `/shardcap reset` | Restore defaults |
## Client mods (optional, auto-detected)
- **ClassicAPI** — used when present: exact item ID and stack size per slot, locale-free soul bag
detection (works for any custom soul bag on WoW 1.18.1 Clients), cursor-free moves/merges, and `BAG_UPDATE_DELAYED`
so a loot or trade burst triggers one scan instead of many. Also provides the AddOn Options window
ShardCap's options pages live in, and `C_Item.GetItemCount` for showing what's in your bank.
Newer builds reuse an item-info buffer to reduce scan garbage; older builds still work.
- **Nampower** — used if ClassicAPI isn't: `GetBagItem` gives the item ID without parsing links.
Small gain; the vanilla path is already exact.
- **SuperWoW / UnitXP SP3** — not used. Neither adds anything for bags or items.
- **[ClassicAPI](https://github.com/brues-code/ClassicAPI)** provides the options window, bank counts,
locale-independent soul bag detection, cursor-free moves and merges, and batched bag updates.
Newer builds also reduce garbage during bag scans by reusing an item-info buffer.
- **[Nampower](https://github.com/brues-code/nampower)** provides item IDs and stack counts directly
when ClassicAPI's container API is unavailable. Without either mod, ShardCap uses the vanilla API.
## Tests
`tests/test.lua` runs the addon against a mock 1.12 client (stacking, soul bags, combat, cursor,
locked items, migration, options window). Run it from the repo root with a Lua 5.0 interpreter: `lua tests/test.lua`.
## Credits
Based on the original [ShardCap](https://github.com/dogmax/ShardCap), with stacking support inspired by
[ShardCapPlus](https://github.com/akzkak/ShardCapPlus) and soul-bag sorting inspired by
[voxan-dev's fork](https://github.com/voxan-dev/ShardCap).