Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion QUALITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ are named below as waivers with owners and follow-ups, not hidden.
| UX & accessibility (6) | 4 | Pass (waiver closed 2026-11-16) | The UI is complete in code and smoke, and SEAN's in-game field test passed for every release through 1.15.31 on Forever (reported 2026-11-16). Not 5: no accessibility audit beyond the tag-symbol, reduced-motion and text-scale options. |
| Scalability (5) | 3 | Pass | Host caps group size (40); scan cost is linear in roster size and throttled; the row pool is capped at 15 with overflow counted on the coverage line. 10x/100x testing is not applicable to a host-capped addon; the cap behaviour is smoke-tested. |
| Idiomatic quality (5) | 4 | Pass | luacheck 1.2.0 at strict settings: 0 warnings / 0 errors; project checkers (compile, limits, locale) green; consistent style across the file. |
| Test & corpus evidence (5) | 4 | Pass | 1.15.38: 2,802 smoke steps across seven fake-client setups, 22 two-client coordination scenarios, and seven packaging regressions. See the [audit ledger](docs/AUDIT_1.15.38.md) and [candidate matrix](docs/FOREVER_1.15.38_VALIDATION.md); Windows package parity passed in CI; the full local Windows gate and live Forever checks remain pending. The corpus only grows. Line-coverage percentage is not measurable for this stack, so the corpus fraction is the recorded evidence. |
| Test & corpus evidence (5) | 4 | Pass | 1.16.0: 2,802 smoke steps across seven fake-client setups, 22 two-client coordination scenarios, and seven packaging regressions. See the [audit ledger](docs/AUDIT_1.15.38.md) and [release matrix](docs/FOREVER_1.16.0_VALIDATION.md); the full local Windows gate and live Forever checks remain pending. The corpus only grows. Line-coverage percentage is not measurable for this stack, so the corpus fraction is the recorded evidence. |
| Self-documentation (4) | 3 | Pass | Section banners and why-comments throughout; architecture and rules in `AGENTS.md`; module map in the root README's Layout table. Versioned [status API](docs/STATUS_API.md) and [roadmap](docs/ROADMAP.md). |
| Documentation (4) | 4 | Pass | Four-doc set per edition (README / FEATURES / DESCRIPTION / CHANGELOG) plus `tools/README.md`, in-game help covering every command, `SECURITY.md`, and `## TL;DR` openings on all three READMEs (added at adoption). Checked against the code at every release. |
| Diagnostics & supportability (4) | 4 | Pass | `/br selftest` (versioned paste-able block), `/br debug`, `/br apicheck [export]` (client API probe), `/br buffcheck` (spell table vs live client), `/br perf` (separate CPU timing buckets and total addon memory), `/br why <name>` (the deciding listing check) and the Nearby Player Diagnostics panel. Local only; nothing is sent anywhere. Not 5: no stable error IDs — the game's error frame carries those. |
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ BuffRadar shows which players need a buff you can cast in **WoW: Forever**
(Interface 16001). Click a name, press your **Cast next buff** key, or use a
macro to work through the list. Your character goes first by default.

**1.15.38 candidate:** safer imports and saves, stricter cast checks, and a
list that fits shorter viewports. See the [changes](editions/forever/CHANGELOG.md)
and [verification status](docs/FOREVER_1.15.38_VALIDATION.md).
**1.16.0:** safer imports and saves, stricter cast checks, and a list that fits
shorter viewports. See the [changes](editions/forever/CHANGELOG.md) and
[release verification](docs/FOREVER_1.16.0_VALIDATION.md).

## Download and Install

Expand Down Expand Up @@ -300,7 +300,7 @@ Replace `X.Y.Z` with the TOC version. In CI the Windows and POSIX digests
must match. Test the exact ZIP in Forever with the
[release checklist](docs/FOREVER_RELEASE_CHECKLIST.md), not a loose source
copy. Record the digest, game build and results. See the
[1.15.38 audit ledger](docs/AUDIT_1.15.38.md) for offline coverage and limits.
[audit ledger](docs/AUDIT_1.15.38.md) for offline coverage and limits.
After a tagged release, verify the hosted ZIP against its published checksum
and the tested artifact.

Expand Down
4 changes: 4 additions & 0 deletions docs/AUDIT_1.15.38.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# BuffRadar 1.15.38 — audit follow-up

This ledger preserves the evidence for the unpublished 1.15.38 candidate.
The changes ship as **1.16.0**; use the [release matrix](FOREVER_1.16.0_VALIDATION.md)
for the new version's distinct ZIP and checksum.

This ledger groups the 32 follow-up items by subsystem. It compares the
candidate with v1.15.37 (`a02f3ebcafb663352d1e6038cb95e8e3c3eaf41e`).
Unless marked otherwise, the evidence is from Lua 5.1 fake clients, static
Expand Down
45 changes: 45 additions & 0 deletions docs/FOREVER_1.16.0_VALIDATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# BuffRadar 1.16.0 — release verification

- **Artifact:** `BuffRadar-1.16.0-Forever.zip` · 1,280,608 bytes
- **SHA-256:** `0d2e610f4129b91be229a8bff6fe33d1274919174e0217a139f75eeeb5aa82db`
- **Target:** WoW: Forever, Interface 16001 · SavedVariables schema 23
- **Source:** [`v1.16.0`](https://github.com/SeanShaffer88/BuffRadar/tree/v1.16.0)

1.16.0 publishes the runtime changes from the unpublished 1.15.38 audit
candidate. It is a new ZIP; do not use the candidate's checksum or carry over
its field-test status. The [audit ledger](AUDIT_1.15.38.md) explains the runtime
changes and their limits.

| Check | Evidence |
|---|---|
| Local Lua 5.1 gate | Passed: compile, advisory limits, German keys and format checks, pattern check, 2,802 smoke steps across seven setups, 22 two-client coordination scenarios, and seven packaging tests. |
| Local Luacheck 1.2.0 | Passed with Lua 5.1.5: zero warnings or errors across 22 addon and locale files. |
| Local release build | Two byte-identical ZIPs and checksum files. Exact `--tag v1.16.0` check, matching changelog section, source-aware verification of all 32 files, 22 TOC entries, four bindings, and `/br selftest` version/edition. |
| Windows/POSIX package parity | See the [release preparation CI runs](https://github.com/SeanShaffer88/BuffRadar/actions/workflows/ci.yml?query=branch%3Aarena%2F6447ba6f-buffradar) for the `windows-package` digest comparison. The full local Windows `tools/check.ps1` gate was not run. |
| Tagged package and hosted readback | See the [tagged Release run](https://github.com/SeanShaffer88/BuffRadar/actions/workflows/release.yml?query=branch%3Av1.16.0) and [published assets](https://github.com/SeanShaffer88/BuffRadar/releases/tag/v1.16.0). The release workflow verifies the matching tag and then compares the downloaded ZIP and `SHA256SUMS.txt` to the build. |
| Live WoW: Forever field test | **Unverified**. The fake client and package checks do not exercise real protected actions, rendering, restricted aura data, latency or server chat delivery. |

## Verify the download

Download the ZIP and `SHA256SUMS.txt` from the same GitHub release. In their
folder run `sha256sum -c SHA256SUMS.txt`, or compare `Get-FileHash -Algorithm
SHA256 BuffRadar-1.16.0-Forever.zip` to the digest above in PowerShell. Install
only the matching ZIP into `Interface/AddOns`, then confirm `/br selftest`
reports **1.16.0 · Forever edition · interface 16001** and schema 23.

## Field handoff

Run the [audit field scenarios](FOREVER_1.15.38_VALIDATION.md#forever-field-pass--pending)
against the exact **1.16.0** ZIP above, substituting its version and hash for the
1.15.38 candidate in the install check. Also run the applicable
[Forever release checklist](FOREVER_RELEASE_CHECKLIST.md) steps. Record tester,
client build/interface and locale, resolution and UI scale, roster size, ZIP
hash, and outcomes. The priority checks are:

- Save upgrade and non-destructive future/overflow recovery with backed-up data.
- BR1, BR2 and plan review, cancellation, replacement and scope drift.
- Row, keybind, macro, modifier and group/pet casts through combat, death and roster changes.
- Short viewports, Settings and Ready Check positions, Nearby closure and German layout.
- Confirmed versus unknown aura/coating data, pull cancellation, chat routing, and `/br perf` in a raid.

Mark individual checks verified only after running them on this artifact.
8 changes: 4 additions & 4 deletions docs/FOREVER_RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Run this against the exact candidate ZIP after CI passes. Record the version, client build, tester, and pass/fail for each check. Do not mark a build field-tested until the applicable checks pass.

## 1.15.38 Audit Follow-up
## 1.16.0 Audit Follow-up

Use the [candidate verification matrix](FOREVER_1.15.38_VALIDATION.md) to
identify the ZIP and record Windows and Forever results. Run the 1.15.38 rows
there plus the applicable readiness and general checks below. Use a backed-up
Use the [1.16.0 verification matrix](FOREVER_1.16.0_VALIDATION.md) to identify
and check the ZIP. Run its field scenarios plus the applicable readiness and
general checks below. Use a backed-up
SavedVariables file and disposable test settings for downgrade and cap checks.
An offline pass does not verify rendering, protected actions, or delivery.

Expand Down
4 changes: 2 additions & 2 deletions docs/PARITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ and the TOC module refactor).
| Nearby player options | Complement another Paladin's blessing outside the group; names-only and reversible nameplates | Complete | Trial run: cast-source ownership and explicit-rule precedence, verified CVar writes, refusal, persistence and restore | Aura ownership and plate appearance still need a Forever field test |
| Forever buff set | Classic set incl. blessings, ranks, group variants | Complete | Forever setups incl. rank-table and Kings-first steps | Verified in game at 1.12.0 on 1.60.1.70862 |
| Coordination (1.5.0–1.8.0) | Cast sync, chat requests, assignments, buddy split, blessing plan, peer hello, cover-me handoff, coverage roster, plan strings | Complete (batches 1–3) | Trial steps: sync handled-marks, request tags, leader-trust assignment sink/float, buddy hash split, blessing plan set/broadcast/receive, cover handoff + return, roster line, plan export/import round-trip; two-client coordination harness | All multi-user behaviour Unverified in game (needs a second BuffRadar user) |
| List & window | Sorts (name/role/distance/need), filters, strip, chips, pill, idle fade, rescue, pin, name finder, grow-up anchor, combat hide, color themes, two-column layout, saved custom themes, row spacing + icon size, window strata, click-through while locked, group-by-buff view | Complete (batches 1–4 + 1.10.0) | Trial steps per feature, incl. pill show/hide/peek, off-screen rescue via `/br resetpos`, pin order under name sort, find filter, grow-up anchor, combat hide/show, theme cycle, two-column split + widen/narrow (harness records anchors + width); 1.10.0 steps: theme save/apply/delete + sanitizer round-trip, row-pitch + icon-size deltas, frame strata, click-through mouse flags locked/unlocked, buff-view fold + cast target | 1.15.38 covers rejected and off-screen anchors, pooled short viewports, and failed row paints offline. Live layout still needs testing |
| List & window | Sorts (name/role/distance/need), filters, strip, chips, pill, idle fade, rescue, pin, name finder, grow-up anchor, combat hide, color themes, two-column layout, saved custom themes, row spacing + icon size, window strata, click-through while locked, group-by-buff view | Complete (batches 1–4 + 1.10.0) | Trial steps per feature, incl. pill show/hide/peek, off-screen rescue via `/br resetpos`, pin order under name sort, find filter, grow-up anchor, combat hide/show, theme cycle, two-column split + widen/narrow (harness records anchors + width); 1.10.0 steps: theme save/apply/delete + sanitizer round-trip, row-pitch + icon-size deltas, frame strata, click-through mouse flags locked/unlocked, buff-view fold + cast target | 1.16.0 covers rejected and off-screen anchors, pooled short viewports, and failed row paints offline. Live layout still needs testing |
| Rows & interaction | Tags (expired/rezzed/asked/handled/queued/assigned/buddy/pinned/weapon/drinking/pet), portraits, compact rows, text scale, tooltips (3 detail levels), duration bars, raid markers, estimated-range text, focus line, coverage-line part toggles, row color marks, name formats (class colors / realm / trim), buff priority order | Complete (batches 1–3 + 1.10.0) | Tag-priority steps incl. queue + pinned + weapon + drinking tags; tooltip step (recorder GameTooltip: missing + remaining-time lines); bars/markers/range/focus steps; 1.10.0 display step (coverage part off/on, tooltip minimal/full lines, tank color mark, realm + trimmed names, plain name color); priority step (offer order flips + resets) | Explicitly out-of-range rows no longer display. Range Watch and opt-in estimated range remain |
| Coverage expansion | Built-in buffs + consumables + custom spells + uptime + weapon watch + pets + aura/aspect watch + per-buff context + world-buff watch + healer drinking | Complete (batches 1–3) | Consumable tally, custom add/remove/list, uptime scoring, weapon flag on/off steps; pet rows + report exclusion, context gating (incl. the SHADOW_PROT instance default), world-buff line, drinking tag + coverage count steps | Weapon watch reads temporary weapon enchants only (GetWeaponEnchantInfo); solo with no other row, the reminder waits for a row or a group. The aura/aspect watch's positive path (a hunter/paladin who knows an aspect/aura spell) is not smoke-covered — the harness spellbook is a priest's/shaman's; toggle + edition gating are covered |
| Alerts | New-name alert, drop alert, post-combat flash, instance-entry reminder, group expiry warning, a sound per alert kind | Complete | Alert + flash steps; entry reminder fires-once step; expiry tally step (3 holders < 5 min); 1.10.0 per-kind sound step (save/change/master via `/br soundfor`) | #33 shipped in 1.15.0 as the fall alert (off by default, Unverified in game) |
| Stats & reporting | Cast stats + export, cast history, announce, ready-check report + auto-post, join digest, selftest, repeat offenders, Discord summary, death recap, post-wipe report | Complete (batches 1–4) | Announce/ready/digest/selftest steps; auto-post step (leader posts to PARTY); history record + resetcount-clear step; offenders fold-on-group-end step; stats export + Discord render steps; death-recap step (PLAYER_DEAD print + reprint); wipe step (controllable clock: single death = no report, 2-of-3 dead after 20 s = report) | — |
| Settings & QoL | Tabs UI, export/import, named profiles + share-one-profile, per-spec profiles, presets, auto profiles, scan throttle, settings search, setup wizard | Complete (batches 1–4) | Settings-fire-every-control step, export/import round-trip, profile + preset + auto-profile steps, throttle toggle + 25-player tick step, profile share/import round-trip, settings-search dim step, Quick Setup step (draft, Back, cancel, then apply) | — |
| Settings data safety | Versioned SavedVariables, migrations, corrupt-data repair | Complete | Migration fixture: legacy v2 save → v23; detached validation, valid nested values and position rescue, and preservation of newer or over-limit saves | Back up before testing downgrade/overflow recovery |
| Localisation | English and German keys, partial frFR, esES, ruRU, zhCN | Offline checked | `tools/localecheck.py` enforces German coverage; German setup runs the full trial run | Native-speaker review welcome |
| 1.15.38 audit follow-up | Incompatible-client guard, reviewed imports, more conservative cast eligibility, roster cleanup, bounded storage, viewport, and deterministic package | Offline checked | [32-item audit ledger](AUDIT_1.15.38.md) | [Windows package parity passed; Forever field pass pending](FOREVER_1.15.38_VALIDATION.md) |
| 1.16.0 audit follow-up | Incompatible-client guard, reviewed imports, more conservative cast eligibility, roster cleanup, bounded storage, viewport, and deterministic package | Offline checked | [32-item audit ledger](AUDIT_1.15.38.md) | [Release checks and pending Forever field pass](FOREVER_1.16.0_VALIDATION.md) |
| Readiness and forecasts | Confirmed expiry alerts, role/instance/wipe priority, player/focus debuffs, Personal checklist, status API, Quick Setup, minimap badges, and Lite mode | 1.15.37 (offline checked) | Lua 5.1 trial steps cover alternate aura expiry, pull cancellation, role/instance order, restricted aura data, solo checklist, API copies, and combat/Lite invalidation | Unverified in game; Soulwell and prospective boss-mechanic availability are not inferred |

## The 50-item program (SEAN approved 2026-10-25: add all 50)
Expand Down
8 changes: 4 additions & 4 deletions docs/RISK_MATRIX.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BuffRadar — Use-Case, Risk and Test Matrix

Started with 1.15.33 and updated for the 1.15.38 audit follow-up. Each row
Started with 1.15.33 and updated for the audit follow-up shipping in 1.16.0. Each row
ties a scenario to its mitigation and evidence. See the [audit ledger](AUDIT_1.15.38.md)
and [candidate matrix](FOREVER_1.15.38_VALIDATION.md) for new cases. Evidence names are trial-run steps in `tools/smoke51.py` unless
and [release matrix](FOREVER_1.16.0_VALIDATION.md) for new cases. Evidence names are trial-run steps in `tools/smoke51.py` unless
marked `coord:` (`tools/coordination51.py`) or `gate` (`tools/gate.sh` /
`tools/check.ps1`).

Expand Down Expand Up @@ -149,8 +149,8 @@ below. Keep the current Windows and in-game results with the tested ZIP hash.
throttling and real secret-value behaviour can't be reproduced offline. A
passing gate is evidence, not proof.
- **In-game verification:** releases through 1.15.33 are field-verified;
1.15.34–1.15.38 are Unverified in game. Windows package parity passed in
CI; see the [candidate matrix](FOREVER_1.15.38_VALIDATION.md).
1.15.34 and later remain Unverified in game. See the
[1.16.0 verification matrix](FOREVER_1.16.0_VALIDATION.md) for offline checks.
- **Fuzzing is sampled:** about 1,000 inputs per parser, 3,000 messages,
1,500 commands, 250 corrupt saves and 200 API-chaos rounds per setup. It
finds shallow-to-medium defects; it can't prove their absence. The
Expand Down
4 changes: 2 additions & 2 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ or copy its link in **Settings → Readiness → Feedback** (`/br feedback`).

| Status | Work |
| --- | --- |
| **1.15.38 candidate — offline checks complete** | Safer saves, reviews, cast eligibility and roster cleanup; deterministic Forever candidate. See the [audit ledger](AUDIT_1.15.38.md) and [verification matrix](FOREVER_1.15.38_VALIDATION.md). |
| **1.16.0 — offline release checks and field checklist** | Safer saves, reviews, cast eligibility, roster cleanup, and deterministic Forever ZIPs. See the [audit ledger](AUDIT_1.15.38.md) and [verification matrix](FOREVER_1.16.0_VALIDATION.md). |
| **1.15.37 — released; live verification pending** | Confirmed buff expiry forecasts, contextual priority, personal readiness, player/focus debuff watches, a read-only status API, Quick Setup, minimap status, quiet visuals, adaptive scans, and Lite mode. |
| **Next: field test in Forever** | Ship only after the applicable checks; Windows package bytes matched in CI. Walk the [release checklist](FOREVER_RELEASE_CHECKLIST.md) on the exact candidate. Check real casts, short viewports, a raid-sized roster, countdowns, chat delivery, combat aura visibility, and scan/memory diagnostics. |
| **Next: field test in Forever** | Walk the [release checklist](FOREVER_RELEASE_CHECKLIST.md) on the exact 1.16.0 ZIP. Check real casts, short viewports, a raid-sized roster, countdowns, chat delivery, combat aura visibility, and scan/memory diagnostics. |
| **Under consideration** | Shareable encounter presets after spell IDs and aura availability are confirmed, more options for placing the debuff strip, and community examples using the [status API](STATUS_API.md). |
| **Waiting on client data** | Confirming that a placed Soulwell is reachable and usable, and automatically predicting upcoming encounter mechanics. BuffRadar does not guess at data the client does not expose. |
Loading
Loading