From 16d004c742fbb0974a43cb2edfaba48c0702a7dd Mon Sep 17 00:00:00 2001 From: Kelsi Date: Sat, 9 May 2026 23:34:29 -0700 Subject: [PATCH] feat(editor): add WSPS JSON round-trip (--export/--import-wsps-json) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes the editing loop on the spell-proc-trigger catalog: dump a .wsps to JSON, hand-edit triggerSpellId / chance / PPM / internalCooldownMs / charges / procFlags (e.g. retune Windfury PPM from 20 to 18, add Critical to a proc's flag set so it fires only on crits, raise an internal cooldown to slow down spammy procs), re-import to a byte-identical binary. procFlags is dual-encoded — int bitfield OR pipe-separated label string ("DealtMeleeAutoAttack|DealtMeleeSpell"). The 13 flag labels match the canonical WoW proc-event taxonomy. Importer prefers the int form when both are present so unknown bits round-trip losslessly. Verified byte-identical round-trip on all three presets (weapon / aura / talent). CLI flag count 1046 -> 1048. --- tools/editor/cli_arg_required.cpp | 1 + tools/editor/cli_help.cpp | 4 + tools/editor/cli_spell_procs_catalog.cpp | 158 +++++++++++++++++++++++ 3 files changed, 163 insertions(+) diff --git a/tools/editor/cli_arg_required.cpp b/tools/editor/cli_arg_required.cpp index c88c630a..2fed736b 100644 --- a/tools/editor/cli_arg_required.cpp +++ b/tools/editor/cli_arg_required.cpp @@ -275,6 +275,7 @@ const char* const kArgRequired[] = { "--export-wtbr-json", "--import-wtbr-json", "--gen-sps", "--gen-sps-aura", "--gen-sps-talent", "--info-wsps", "--validate-wsps", + "--export-wsps-json", "--import-wsps-json", "--gen-weather-temperate", "--gen-weather-arctic", "--gen-weather-desert", "--gen-weather-stormy", "--gen-zone-atmosphere", diff --git a/tools/editor/cli_help.cpp b/tools/editor/cli_help.cpp index e8d47795..4ae84452 100644 --- a/tools/editor/cli_help.cpp +++ b/tools/editor/cli_help.cpp @@ -2009,6 +2009,10 @@ void printUsage(const char* argv0) { std::printf(" Print WSPS entries (id / triggerSpellId / fromSpellId / chance%% / PPM / ICD / charges / proc flags)\n"); std::printf(" --validate-wsps [--json]\n"); std::printf(" Static checks: id+name+triggerSpellId+procFlags required, no duplicate ids; warns on chance outside [0,1], procPpm<0, both chance+ppm set (PPM wins), neither set (never fires)\n"); + std::printf(" --export-wsps-json [out.json]\n"); + std::printf(" Export binary .wsps to a human-editable JSON sidecar (defaults to .wsps.json)\n"); + std::printf(" --import-wsps-json [out-base]\n"); + std::printf(" Import a .wsps.json sidecar back into binary .wsps (procFlags accepts int OR pipe-separated label string)\n"); std::printf(" --gen-weather-temperate [zoneName]\n"); std::printf(" Emit .wow weather schedule: clear-dominant + occasional rain + fog (forest / grassland)\n"); std::printf(" --gen-weather-arctic [zoneName]\n"); diff --git a/tools/editor/cli_spell_procs_catalog.cpp b/tools/editor/cli_spell_procs_catalog.cpp index d1d5a048..dfb5dcd0 100644 --- a/tools/editor/cli_spell_procs_catalog.cpp +++ b/tools/editor/cli_spell_procs_catalog.cpp @@ -5,6 +5,7 @@ #include "pipeline/wowee_spell_procs.hpp" #include +#include #include #include #include @@ -151,6 +152,157 @@ int handleInfo(int& i, int argc, char** argv) { return 0; } +int handleExportJson(int& i, int argc, char** argv) { + std::string base = argv[++i]; + std::string outPath; + if (parseOptArg(i, argc, argv)) outPath = argv[++i]; + base = stripWspsExt(base); + if (!wowee::pipeline::WoweeSpellProcLoader::exists(base)) { + std::fprintf(stderr, + "export-wsps-json: WSPS not found: %s.wsps\n", + base.c_str()); + return 1; + } + auto c = wowee::pipeline::WoweeSpellProcLoader::load(base); + if (outPath.empty()) outPath = base + ".wsps.json"; + nlohmann::json j; + j["catalog"] = c.name; + nlohmann::json arr = nlohmann::json::array(); + for (const auto& e : c.entries) { + std::string flagNames; + appendProcFlagNames(e.procFlags, flagNames); + nlohmann::json je; + je["procId"] = e.procId; + je["name"] = e.name; + je["description"] = e.description; + je["triggerSpellId"] = e.triggerSpellId; + je["procFromSpellId"] = e.procFromSpellId; + je["procChance"] = e.procChance; + je["procPpm"] = e.procPpm; + je["procFlags"] = e.procFlags; + je["procFlagsLabels"] = flagNames; + je["internalCooldownMs"] = e.internalCooldownMs; + je["charges"] = e.charges; + je["iconColorRGBA"] = e.iconColorRGBA; + arr.push_back(je); + } + j["entries"] = arr; + std::ofstream os(outPath); + if (!os) { + std::fprintf(stderr, + "export-wsps-json: failed to open %s for write\n", + outPath.c_str()); + return 1; + } + os << j.dump(2) << "\n"; + std::printf("Wrote %s\n", outPath.c_str()); + std::printf(" catalog : %s\n", c.name.c_str()); + std::printf(" procs : %zu\n", c.entries.size()); + return 0; +} + +uint32_t parseProcFlagsField(const nlohmann::json& jv) { + using F = wowee::pipeline::WoweeSpellProc; + if (jv.is_number_integer() || jv.is_number_unsigned()) + return jv.get(); + if (jv.is_string()) { + std::string s = jv.get(); + uint32_t out = 0; + size_t pos = 0; + while (pos < s.size()) { + size_t end = s.find('|', pos); + if (end == std::string::npos) end = s.size(); + std::string tok = s.substr(pos, end - pos); + for (auto& ch : tok) ch = static_cast(std::tolower(ch)); + if (tok == "dealtmeleeautoattack") out |= F::DealtMeleeAutoAttack; + else if (tok == "dealtmeleespell") out |= F::DealtMeleeSpell; + else if (tok == "takenmeleeautoattack") out |= F::TakenMeleeAutoAttack; + else if (tok == "takenmeleespell") out |= F::TakenMeleeSpell; + else if (tok == "dealtrangedautoattack") out |= F::DealtRangedAutoAttack; + else if (tok == "dealtrangedspell") out |= F::DealtRangedSpell; + else if (tok == "dealtspell") out |= F::DealtSpell; + else if (tok == "dealtspellheal") out |= F::DealtSpellHeal; + else if (tok == "takenspell") out |= F::TakenSpell; + else if (tok == "onkill") out |= F::OnKill; + else if (tok == "ondeath") out |= F::OnDeath; + else if (tok == "oncastfinished") out |= F::OnCastFinished; + else if (tok == "critical") out |= F::Critical; + pos = end + 1; + } + return out; + } + return 0; +} + +int handleImportJson(int& i, int argc, char** argv) { + std::string jsonPath = argv[++i]; + std::string outBase; + if (parseOptArg(i, argc, argv)) outBase = argv[++i]; + std::ifstream is(jsonPath); + if (!is) { + std::fprintf(stderr, + "import-wsps-json: failed to open %s\n", jsonPath.c_str()); + return 1; + } + nlohmann::json j; + try { + is >> j; + } catch (const std::exception& ex) { + std::fprintf(stderr, + "import-wsps-json: parse error in %s: %s\n", + jsonPath.c_str(), ex.what()); + return 1; + } + wowee::pipeline::WoweeSpellProc c; + if (j.contains("catalog") && j["catalog"].is_string()) + c.name = j["catalog"].get(); + if (j.contains("entries") && j["entries"].is_array()) { + for (const auto& je : j["entries"]) { + wowee::pipeline::WoweeSpellProc::Entry e; + if (je.contains("procId")) e.procId = je["procId"].get(); + if (je.contains("name")) e.name = je["name"].get(); + if (je.contains("description")) e.description = je["description"].get(); + if (je.contains("triggerSpellId")) e.triggerSpellId = je["triggerSpellId"].get(); + if (je.contains("procFromSpellId")) e.procFromSpellId = je["procFromSpellId"].get(); + if (je.contains("procChance")) e.procChance = je["procChance"].get(); + if (je.contains("procPpm")) e.procPpm = je["procPpm"].get(); + if (je.contains("procFlags")) + e.procFlags = parseProcFlagsField(je["procFlags"]); + else if (je.contains("procFlagsLabels")) + e.procFlags = parseProcFlagsField(je["procFlagsLabels"]); + if (je.contains("internalCooldownMs")) e.internalCooldownMs = je["internalCooldownMs"].get(); + if (je.contains("charges")) e.charges = je["charges"].get(); + if (je.contains("iconColorRGBA")) e.iconColorRGBA = je["iconColorRGBA"].get(); + c.entries.push_back(e); + } + } + if (outBase.empty()) { + outBase = jsonPath; + const std::string suffix1 = ".wsps.json"; + const std::string suffix2 = ".json"; + if (outBase.size() >= suffix1.size() && + outBase.compare(outBase.size() - suffix1.size(), + suffix1.size(), suffix1) == 0) { + outBase.resize(outBase.size() - suffix1.size()); + } else if (outBase.size() >= suffix2.size() && + outBase.compare(outBase.size() - suffix2.size(), + suffix2.size(), suffix2) == 0) { + outBase.resize(outBase.size() - suffix2.size()); + } + } + outBase = stripWspsExt(outBase); + if (!wowee::pipeline::WoweeSpellProcLoader::save(c, outBase)) { + std::fprintf(stderr, + "import-wsps-json: failed to save %s.wsps\n", + outBase.c_str()); + return 1; + } + std::printf("Wrote %s.wsps\n", outBase.c_str()); + std::printf(" catalog : %s\n", c.name.c_str()); + std::printf(" procs : %zu\n", c.entries.size()); + return 0; +} + int handleValidate(int& i, int argc, char** argv) { std::string base = argv[++i]; bool jsonOut = consumeJsonFlag(i, argc, argv); @@ -286,6 +438,12 @@ bool handleSpellProcsCatalog(int& i, int argc, char** argv, if (std::strcmp(argv[i], "--validate-wsps") == 0 && i + 1 < argc) { outRc = handleValidate(i, argc, argv); return true; } + if (std::strcmp(argv[i], "--export-wsps-json") == 0 && i + 1 < argc) { + outRc = handleExportJson(i, argc, argv); return true; + } + if (std::strcmp(argv[i], "--import-wsps-json") == 0 && i + 1 < argc) { + outRc = handleImportJson(i, argc, argv); return true; + } return false; }