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

feat(editor): add WKBD JSON round-trip (export/import sidecar)

Browse source 
Closes the JSON round-trip gap on the keybinding catalog
format shipped last batch. --export-wkbd-json emits all 7
scalar fields plus a dual int + name form for category (9
values) so hand-edits can use either representation.
--import-wkbd-json defaults isUserOverridable to 1 when
omitted (matches typical case for game-action bindings;
hardcoded engine bindings must explicitly set it to 0).
Verified byte-identical round-trip on all three preset
emitters (starter / movement with primary+alt keys / UI
panels). 798 documented CLI flags.
This commit is contained in:
Kelsi 2026-05-09 20:15:02 -07:00
parent 1c6faa2891
commit 386afcb4ef
3 changed files with 140 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
tools/editor/cli_arg_required.cpp
View file

@ -168,6 +168,7 @@ const char* const kArgRequired[] = {
"--export-wsmc-json", "--import-wsmc-json",
"--gen-kbd", "--gen-kbd-movement", "--gen-kbd-ui",
"--info-wkbd", "--validate-wkbd",
"--export-wkbd-json", "--import-wkbd-json",
"--gen-weather-temperate", "--gen-weather-arctic",
"--gen-weather-desert", "--gen-weather-stormy",
"--gen-zone-atmosphere",

4
tools/editor/cli_help.cpp
View file

@ -1509,6 +1509,10 @@ void printUsage(const char* argv0) {
std::printf(" Print WKBD entries (id / category / user-overridable / sort / default key + alt / actionName)\n");
std::printf(" --validate-wkbd <wkbd-base> [--json]\n");
std::printf(" Static checks: id+actionName+defaultKey required, category 0..8, alt!=default, unique action names + primary keys\n");
std::printf(" --export-wkbd-json <wkbd-base> [out.json]\n");
std::printf(" Export binary .wkbd to a human-editable JSON sidecar (defaults to <base>.wkbd.json)\n");
std::printf(" --import-wkbd-json <json-path> [out-base]\n");
std::printf(" Import a .wkbd.json sidecar back into binary .wkbd (accepts category int OR name string; isUserOverridable defaults to 1)\n");
std::printf(" --gen-weather-temperate <wow-base> [zoneName]\n");
std::printf(" Emit .wow weather schedule: clear-dominant + occasional rain + fog (forest / grassland)\n");
std::printf(" --gen-weather-arctic <wow-base> [zoneName]\n");

135
tools/editor/cli_keybindings_catalog.cpp
View file

@ -123,6 +123,135 @@ 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 binding emits all 7 scalar fields
// plus a dual int + name form for category so hand-edits
// can use either representation.
std::string base = argv[++i];
std::string outPath;
if (parseOptArg(i, argc, argv)) outPath = argv[++i];
base = stripWkbdExt(base);
if (outPath.empty()) outPath = base + ".wkbd.json";
if (!wowee::pipeline::WoweeKeyBindingLoader::exists(base)) {
std::fprintf(stderr,
"export-wkbd-json: WKBD not found: %s.wkbd\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeKeyBindingLoader::load(base);
nlohmann::json j;
j["name"] = c.name;
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"bindingId", e.bindingId},
{"actionName", e.actionName},
{"description", e.description},
{"defaultKey", e.defaultKey},
{"alternateKey", e.alternateKey},
{"category", e.category},
{"categoryName", wowee::pipeline::WoweeKeyBinding::categoryName(e.category)},
{"isUserOverridable", e.isUserOverridable},
{"sortOrder", e.sortOrder},
});
}
j["entries"] = arr;
std::ofstream out(outPath);
if (!out) {
std::fprintf(stderr,
"export-wkbd-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.wkbd\n", base.c_str());
std::printf(" bindings : %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 = ".wkbd.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 = stripWkbdExt(outBase);
std::ifstream in(jsonPath);
if (!in) {
std::fprintf(stderr,
"import-wkbd-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-wkbd-json: bad JSON in %s: %s\n",
jsonPath.c_str(), e.what());
return 1;
}
auto catFromName = [](const std::string& s) -> uint8_t {
if (s == "movement") return wowee::pipeline::WoweeKeyBinding::Movement;
if (s == "combat") return wowee::pipeline::WoweeKeyBinding::Combat;
if (s == "targeting") return wowee::pipeline::WoweeKeyBinding::Targeting;
if (s == "camera") return wowee::pipeline::WoweeKeyBinding::Camera;
if (s == "ui-panels") return wowee::pipeline::WoweeKeyBinding::UIPanels;
if (s == "chat") return wowee::pipeline::WoweeKeyBinding::Chat;
if (s == "macro") return wowee::pipeline::WoweeKeyBinding::Macro;
if (s == "bar") return wowee::pipeline::WoweeKeyBinding::Bar;
if (s == "other") return wowee::pipeline::WoweeKeyBinding::Other;
return wowee::pipeline::WoweeKeyBinding::Movement;
};
wowee::pipeline::WoweeKeyBinding c;
c.name = j.value("name", std::string{});
if (j.contains("entries") && j["entries"].is_array()) {
for (const auto& je : j["entries"]) {
wowee::pipeline::WoweeKeyBinding::Entry e;
e.bindingId = je.value("bindingId", 0u);
e.actionName = je.value("actionName", std::string{});
e.description = je.value("description", std::string{});
e.defaultKey = je.value("defaultKey", std::string{});
e.alternateKey = je.value("alternateKey", std::string{});
if (je.contains("category") &&
je["category"].is_number_integer()) {
e.category = static_cast<uint8_t>(
je["category"].get<int>());
} else if (je.contains("categoryName") &&
je["categoryName"].is_string()) {
e.category = catFromName(
je["categoryName"].get<std::string>());
}
// isUserOverridable defaults to 1 (overridable)
// when omitted — matches the typical case for
// game-action bindings.
e.isUserOverridable = static_cast<uint8_t>(
je.value("isUserOverridable", 1));
e.sortOrder = static_cast<uint8_t>(
je.value("sortOrder", 0));
c.entries.push_back(e);
}
}
if (!wowee::pipeline::WoweeKeyBindingLoader::save(c, outBase)) {
std::fprintf(stderr,
"import-wkbd-json: failed to save %s.wkbd\n", outBase.c_str());
return 1;
}
std::printf("Wrote %s.wkbd\n", outBase.c_str());
std::printf(" source : %s\n", jsonPath.c_str());
std::printf(" bindings : %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);
@ -245,6 +374,12 @@ bool handleKeybindingsCatalog(int& i, int argc, char** argv, int& outRc) {
if (std::strcmp(argv[i], "--validate-wkbd") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--export-wkbd-json") == 0 && i + 1 < argc) {
outRc = handleExportJson(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--import-wkbd-json") == 0 && i + 1 < argc) {
outRc = handleImportJson(i, argc, argv); return true;
}
return false;
}