phaneron/Kelsidavis-WoWee
1
0
Fork 0
mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-05-11 11:33:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(pipeline): WSWP sound swap rules catalog (141st open format)

Browse source 
Novel format covering a need vanilla WoW lacked entirely:
priority-based sound substitution. Blizzard had no formal
mechanism for swapping a stock SoundEntry for a custom
replacement conditionally on zone/class/race/gender; the
closest equivalents were patch-level SoundEntries.dbc edits
with no condition support. Each WSWP entry binds one
(originalSoundId, condition) trigger to a replacementSoundId,
a priority index for tie-breaking (higher wins), and an
optional gain adjustment in 0.1 dB units (range ±30 dB
practical mixer limit).

Three presets covering common substitution scenarios:
  --gen-swp-bosses  3 raid-boss zone-only swaps (Onyxia roar
                    in Onyxia's Lair / Ragnaros emerge in
                    Molten Core +2dB / Nefarian shout in BWL).
                    Priority 100 — beats global rules
  --gen-swp-race    3 race-conditional voice swaps (BloodElf
                    priest / Tauren shaman / Undead warlock
                    cast voices). Priority 50
  --gen-swp-ui      3 always-on UI sound swaps (level-up /
                    quest-complete / mount-up) at priority
                    10 with +3dB gain (boss/race overrides
                    win the priority fight)

Validator catches: id+name+original+replacement required,
conditionKind 0..4, no duplicate ruleIds, no self-replacement
(orig==repl is a no-op slot), non-Always kinds require non-
zero conditionValue (kind without target = matches everything,
duplicating Always semantics). CRITICAL: no duplicate
(originalSoundId, conditionKind, conditionValue) trigger
triple — runtime would have two rules for the same trigger
without a tie-breaker. Warns on priorityIndex=0 (rule never
wins), |gainAdjustDb_x10| > 300 (clip risk), Always condition
with non-zero conditionValue (dead data ignored at runtime),
and same-priority within same originalSoundId (tie-break
undefined when both rules' conditions match simultaneously).

Format count 140 -> 141. CLI flag count 1463 -> 1470.
This commit is contained in:
Kelsi 2026-05-10 05:32:23 -07:00
parent a2f0055a4d
commit 8c36fc5274
10 changed files with 757 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
tools/editor/cli_help.cpp
View file

@ -2727,6 +2727,16 @@ void printUsage(const char* argv0) {
std::printf(" Export binary .wbrd to a human-editable JSON sidecar (defaults to <base>.wbrd.json; battlegroundName field is informational; battlegroundId int is authoritative)\n");
std::printf(" --import-wbrd-json <json-path> [out-base]\n");
std::printf(" Import a .wbrd.json sidecar back into binary .wbrd (battlegroundName ignored; bgId int authoritative — round-trips per-bracket reward tables byte-identical)\n");
std::printf(" --gen-swp-bosses <wswp-base> [name]\n");
std::printf(" Emit .wswp 3 raid-boss zone-only sound swaps (Onyxia roar in Onyxia's Lair, Ragnaros emerge in Molten Core, Nefarian shout in BWL — priority 100)\n");
std::printf(" --gen-swp-race <wswp-base> [name]\n");
std::printf(" Emit .wswp 3 race-conditional voice swaps (BloodElf priest cast / Tauren shaman cast / Undead warlock cast — priority 50)\n");
std::printf(" --gen-swp-ui <wswp-base> [name]\n");
std::printf(" Emit .wswp 3 always-on UI sound swaps (level-up / quest-complete / mount-up) with +3dB gain adjustment (priority 10 — boss/race overrides win)\n");
std::printf(" --info-wswp <wswp-base> [--json]\n");
std::printf(" Print WSWP entries (id / origSound / replSound / conditionKind+value / priority / gain dB / name)\n");
std::printf(" --validate-wswp <wswp-base> [--json]\n");
std::printf(" Static checks: id+name+originalSoundId+replacementSoundId required, conditionKind 0..4, no duplicate ruleIds, no self-replacement (orig==repl is no-op); CRITICAL: no duplicate (originalSoundId, conditionKind, conditionValue) trigger triple (runtime would have two rules for the same trigger), non-Always conditionKind requires non-zero conditionValue. Warns on priorityIndex=0 (effectively disabled), |gainAdjustDb_x10| > 300 (±30dB clip risk), Always condition with non-zero conditionValue (dead data), and same-priority within same originalSoundId (tie-break undefined when both conditions match)\n");
std::printf(" --catalog-pluck <wXXX-file> <id> [--json]\n");
std::printf(" Extract one entry by id from any registered catalog format. Auto-detects magic, dispatches to the per-format --info-* handler internally, then prints just the matching entry. Primary-key field is auto-detected (first *Id field, or first numeric)\n");
std::printf(" --catalog-find <directory> <id> [--magic <WXXX>] [--json]\n");