From b1967c4453a70a850fa8086e10d70ff797aed218 Mon Sep 17 00:00:00 2001 From: Kelsi Date: Sat, 9 May 2026 21:01:53 -0700 Subject: [PATCH] feat(editor): add WLDS JSON round-trip (export/import sidecar) Closes the JSON round-trip gap on the loading screen catalog format shipped last batch. --export-wlds-json emits all 11 scalar fields plus a dual int + name form for expansionRequired so hand-edits can use either representation. --import-wlds-json accepts either form, defaulting minLevel to 1 and maxLevel to 80 when omitted (full level range). Verified byte-identical round-trip on all three preset emitters (starter / WotLK instances / raid intros with isWideAspect=1). 856 documented CLI flags. --- tools/editor/cli_arg_required.cpp | 1 + tools/editor/cli_help.cpp | 4 + tools/editor/cli_loading_screens_catalog.cpp | 137 +++++++++++++++++++ 3 files changed, 142 insertions(+) diff --git a/tools/editor/cli_arg_required.cpp b/tools/editor/cli_arg_required.cpp index 5a9124fc..40ea9942 100644 --- a/tools/editor/cli_arg_required.cpp +++ b/tools/editor/cli_arg_required.cpp @@ -193,6 +193,7 @@ const char* const kArgRequired[] = { "--export-wrun-json", "--import-wrun-json", "--gen-lds", "--gen-lds-instances", "--gen-lds-raid", "--info-wlds", "--validate-wlds", + "--export-wlds-json", "--import-wlds-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 df3aa316..ac06ec85 100644 --- a/tools/editor/cli_help.cpp +++ b/tools/editor/cli_help.cpp @@ -1625,6 +1625,10 @@ void printUsage(const char* argv0) { std::printf(" Print WLDS entries (id / mapId / level range / display weight / expansion / animated+wide flags / name)\n"); std::printf(" --validate-wlds [--json]\n"); std::printf(" Static checks: id+name+texture required, expansion 0..3, level range valid, weight=0 warning, catch-all overlap\n"); + std::printf(" --export-wlds-json [out.json]\n"); + std::printf(" Export binary .wlds to a human-editable JSON sidecar (defaults to .wlds.json)\n"); + std::printf(" --import-wlds-json [out-base]\n"); + std::printf(" Import a .wlds.json sidecar back into binary .wlds (accepts expansionRequired int OR name 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_loading_screens_catalog.cpp b/tools/editor/cli_loading_screens_catalog.cpp index 832c3594..76aead36 100644 --- a/tools/editor/cli_loading_screens_catalog.cpp +++ b/tools/editor/cli_loading_screens_catalog.cpp @@ -126,6 +126,137 @@ int handleInfo(int& i, int argc, char** argv) { return 0; } +int handleExportJson(int& i, int argc, char** argv) { + // Mirrors the JSON pairs added for every other novel + // open format. Each screen emits all 11 scalar fields + // plus a dual int + name form for expansionRequired. + std::string base = argv[++i]; + std::string outPath; + if (parseOptArg(i, argc, argv)) outPath = argv[++i]; + base = stripWldsExt(base); + if (outPath.empty()) outPath = base + ".wlds.json"; + if (!wowee::pipeline::WoweeLoadingScreenLoader::exists(base)) { + std::fprintf(stderr, + "export-wlds-json: WLDS not found: %s.wlds\n", base.c_str()); + return 1; + } + auto c = wowee::pipeline::WoweeLoadingScreenLoader::load(base); + nlohmann::json j; + j["name"] = c.name; + nlohmann::json arr = nlohmann::json::array(); + for (const auto& e : c.entries) { + arr.push_back({ + {"screenId", e.screenId}, + {"mapId", e.mapId}, + {"name", e.name}, + {"description", e.description}, + {"texturePath", e.texturePath}, + {"iconPath", e.iconPath}, + {"attribution", e.attribution}, + {"minLevel", e.minLevel}, + {"maxLevel", e.maxLevel}, + {"displayWeight", e.displayWeight}, + {"expansionRequired", e.expansionRequired}, + {"expansionRequiredName", wowee::pipeline::WoweeLoadingScreen::expansionGateName(e.expansionRequired)}, + {"isAnimated", e.isAnimated}, + {"isWideAspect", e.isWideAspect}, + }); + } + j["entries"] = arr; + std::ofstream out(outPath); + if (!out) { + std::fprintf(stderr, + "export-wlds-json: cannot write %s\n", outPath.c_str()); + return 1; + } + out << j.dump(2) << "\n"; + out.close(); + std::printf("Wrote %s\n", outPath.c_str()); + std::printf(" source : %s.wlds\n", base.c_str()); + std::printf(" screens : %zu\n", c.entries.size()); + 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]; + if (outBase.empty()) { + outBase = jsonPath; + std::string suffix = ".wlds.json"; + if (outBase.size() > suffix.size() && + outBase.substr(outBase.size() - suffix.size()) == suffix) { + outBase = outBase.substr(0, outBase.size() - suffix.size()); + } else if (outBase.size() > 5 && + outBase.substr(outBase.size() - 5) == ".json") { + outBase = outBase.substr(0, outBase.size() - 5); + } + } + outBase = stripWldsExt(outBase); + std::ifstream in(jsonPath); + if (!in) { + std::fprintf(stderr, + "import-wlds-json: cannot read %s\n", jsonPath.c_str()); + return 1; + } + nlohmann::json j; + try { in >> j; } + catch (const std::exception& e) { + std::fprintf(stderr, + "import-wlds-json: bad JSON in %s: %s\n", + jsonPath.c_str(), e.what()); + return 1; + } + auto expansionFromName = [](const std::string& s) -> uint8_t { + if (s == "classic") return wowee::pipeline::WoweeLoadingScreen::Classic; + if (s == "tbc") return wowee::pipeline::WoweeLoadingScreen::TBC; + if (s == "wotlk") return wowee::pipeline::WoweeLoadingScreen::WotLK; + if (s == "turtle") return wowee::pipeline::WoweeLoadingScreen::TurtleWoW; + return wowee::pipeline::WoweeLoadingScreen::Classic; + }; + wowee::pipeline::WoweeLoadingScreen c; + c.name = j.value("name", std::string{}); + if (j.contains("entries") && j["entries"].is_array()) { + for (const auto& je : j["entries"]) { + wowee::pipeline::WoweeLoadingScreen::Entry e; + e.screenId = je.value("screenId", 0u); + e.mapId = je.value("mapId", 0u); + e.name = je.value("name", std::string{}); + e.description = je.value("description", std::string{}); + e.texturePath = je.value("texturePath", std::string{}); + e.iconPath = je.value("iconPath", std::string{}); + e.attribution = je.value("attribution", std::string{}); + e.minLevel = static_cast(je.value("minLevel", 1)); + e.maxLevel = static_cast(je.value("maxLevel", 80)); + e.displayWeight = static_cast( + je.value("displayWeight", 1)); + if (je.contains("expansionRequired") && + je["expansionRequired"].is_number_integer()) { + e.expansionRequired = static_cast( + je["expansionRequired"].get()); + } else if (je.contains("expansionRequiredName") && + je["expansionRequiredName"].is_string()) { + e.expansionRequired = expansionFromName( + je["expansionRequiredName"].get()); + } + e.isAnimated = static_cast( + je.value("isAnimated", 0)); + e.isWideAspect = static_cast( + je.value("isWideAspect", 0)); + c.entries.push_back(e); + } + } + if (!wowee::pipeline::WoweeLoadingScreenLoader::save(c, outBase)) { + std::fprintf(stderr, + "import-wlds-json: failed to save %s.wlds\n", outBase.c_str()); + return 1; + } + std::printf("Wrote %s.wlds\n", outBase.c_str()); + std::printf(" source : %s\n", jsonPath.c_str()); + std::printf(" screens : %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); @@ -247,6 +378,12 @@ bool handleLoadingScreensCatalog(int& i, int argc, char** argv, if (std::strcmp(argv[i], "--validate-wlds") == 0 && i + 1 < argc) { outRc = handleValidate(i, argc, argv); return true; } + if (std::strcmp(argv[i], "--export-wlds-json") == 0 && i + 1 < argc) { + outRc = handleExportJson(i, argc, argv); return true; + } + if (std::strcmp(argv[i], "--import-wlds-json") == 0 && i + 1 < argc) { + outRc = handleImportJson(i, argc, argv); return true; + } return false; }