Kelsidavis-WoWee/tools/editor/cli_titles_catalog.cpp

353 lines
13 KiB
C++
Raw Normal View History

feat(pipeline): add WTIT (Wowee Title catalog) format Novel open replacement for Blizzard's CharTitles.dbc + the AzerothCore-style character_title SQL table. The 30th open format added to the editor. Defines the player-display titles awarded for completing achievements ("the Versatile"), reaching PvP ranks ("Sergeant Major" / "Stone Guard"), participating in raids ("Champion of the Naaru"), levelling a profession ("Master Locksmith"), or seasonal events ("Brewmaster", "the Hallowed"). Closes a long-standing gap: WACH.entry.titleReward has been a free-form string since batch 116 with no formal catalog to resolve against. WTIT systematizes those strings into a real catalog — the runtime resolves WACH.titleReward to a WTIT entry by name, then displays the titleId in the player title selector. Cross-references: WACH.entry.titleReward (string) ~= WTIT.entry.name (string match — runtime resolves achievement- granted titles by looking up matching WTIT entry by name) Format: • magic "WTIT", version 1, little-endian • per title: titleId / name / nameMale / nameFemale / iconPath / prefix (suffix vs prefix display) / category / sortOrder Enums: • Category (8): Achievement / Pvp / Raid / ClassTitle / Event / Profession / Lore / Custom API: WoweeTitleLoader::save / load / exists + WoweeTitle::findById / findByName. Three preset emitters showcase typical title catalogs: • makeStarter — 4 titles (Versatile / Sergeant / Champion / Hallowed) covering 4 categories • makePvp — 28-title classic Honor System ladder (14 Alliance ranks Private->Grand Marshal + 14 Horde ranks Scout->High Warlord) • makeAchievement — 8 achievement titles including "the Versatile" matching WACH.makeMeta's achievement 250 titleReward + capstone profession titles CLI added (5 flags, 608 documented total now): --gen-titles / --gen-titles-pvp / --gen-titles-achievement --info-wtit / --validate-wtit Validator catches: titleId=0 + duplicates, empty name, unknown category, gender variants set on only one side (causes mixed-gender display when the runtime falls back to canonical for the unset side).
2026-05-09 17:07:56 -07:00
#include "cli_titles_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_titles.hpp"
#include <nlohmann/json.hpp>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <string>
#include <vector>
namespace wowee {
namespace editor {
namespace cli {
namespace {
std::string stripWtitExt(std::string base) {
stripExt(base, ".wtit");
return base;
}
bool saveOrError(const wowee::pipeline::WoweeTitle& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeTitleLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.wtit\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeTitle& c,
const std::string& base) {
std::printf("Wrote %s.wtit\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" titles : %zu\n", c.entries.size());
}
int handleGenStarter(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StarterTitles";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWtitExt(base);
auto c = wowee::pipeline::WoweeTitleLoader::makeStarter(name);
if (!saveOrError(c, base, "gen-titles")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenPvp(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "PvpTitles";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWtitExt(base);
auto c = wowee::pipeline::WoweeTitleLoader::makePvp(name);
if (!saveOrError(c, base, "gen-titles-pvp")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenAchievement(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "AchievementTitles";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWtitExt(base);
auto c = wowee::pipeline::WoweeTitleLoader::makeAchievement(name);
if (!saveOrError(c, base, "gen-titles-achievement")) return 1;
printGenSummary(c, base);
return 0;
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWtitExt(base);
if (!wowee::pipeline::WoweeTitleLoader::exists(base)) {
std::fprintf(stderr, "WTIT not found: %s.wtit\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeTitleLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["wtit"] = base + ".wtit";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"titleId", e.titleId},
{"name", e.name},
{"nameMale", e.nameMale},
{"nameFemale", e.nameFemale},
{"iconPath", e.iconPath},
{"prefix", e.prefix},
{"prefixName", e.prefix ? "prefix" : "suffix"},
{"category", e.category},
{"categoryName", wowee::pipeline::WoweeTitle::categoryName(e.category)},
{"sortOrder", e.sortOrder},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WTIT: %s.wtit\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" titles : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id sort pos category name\n");
for (const auto& e : c.entries) {
std::printf(" %4u %4u %-6s %-12s %s\n",
e.titleId, e.sortOrder,
e.prefix ? "prefix" : "suffix",
wowee::pipeline::WoweeTitle::categoryName(e.category),
e.name.c_str());
}
return 0;
}
int handleExportJson(int& i, int argc, char** argv) {
// Mirrors the JSON pairs added for every other novel
// open format. Each title emits all 8 scalar fields
// plus dual int + name forms for category and prefix.
std::string base = argv[++i];
std::string outPath;
if (parseOptArg(i, argc, argv)) outPath = argv[++i];
base = stripWtitExt(base);
if (outPath.empty()) outPath = base + ".wtit.json";
if (!wowee::pipeline::WoweeTitleLoader::exists(base)) {
std::fprintf(stderr,
"export-wtit-json: WTIT not found: %s.wtit\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeTitleLoader::load(base);
nlohmann::json j;
j["name"] = c.name;
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"titleId", e.titleId},
{"name", e.name},
{"nameMale", e.nameMale},
{"nameFemale", e.nameFemale},
{"iconPath", e.iconPath},
{"prefix", e.prefix},
{"prefixName", e.prefix ? "prefix" : "suffix"},
{"category", e.category},
{"categoryName", wowee::pipeline::WoweeTitle::categoryName(e.category)},
{"sortOrder", e.sortOrder},
});
}
j["entries"] = arr;
std::ofstream out(outPath);
if (!out) {
std::fprintf(stderr,
"export-wtit-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.wtit\n", base.c_str());
std::printf(" titles : %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 = ".wtit.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 = stripWtitExt(outBase);
std::ifstream in(jsonPath);
if (!in) {
std::fprintf(stderr,
"import-wtit-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-wtit-json: bad JSON in %s: %s\n",
jsonPath.c_str(), e.what());
return 1;
}
auto categoryFromName = [](const std::string& s) -> uint8_t {
if (s == "achievement") return wowee::pipeline::WoweeTitle::Achievement;
if (s == "pvp") return wowee::pipeline::WoweeTitle::Pvp;
if (s == "raid") return wowee::pipeline::WoweeTitle::Raid;
if (s == "class") return wowee::pipeline::WoweeTitle::ClassTitle;
if (s == "event") return wowee::pipeline::WoweeTitle::Event;
if (s == "profession") return wowee::pipeline::WoweeTitle::Profession;
if (s == "lore") return wowee::pipeline::WoweeTitle::Lore;
if (s == "custom") return wowee::pipeline::WoweeTitle::Custom;
return wowee::pipeline::WoweeTitle::Achievement;
};
wowee::pipeline::WoweeTitle c;
c.name = j.value("name", std::string{});
if (j.contains("entries") && j["entries"].is_array()) {
for (const auto& je : j["entries"]) {
wowee::pipeline::WoweeTitle::Entry e;
e.titleId = je.value("titleId", 0u);
e.name = je.value("name", std::string{});
e.nameMale = je.value("nameMale", std::string{});
e.nameFemale = je.value("nameFemale", std::string{});
e.iconPath = je.value("iconPath", std::string{});
if (je.contains("prefix") && je["prefix"].is_number_integer()) {
e.prefix = static_cast<uint8_t>(je["prefix"].get<int>());
} else if (je.contains("prefixName") && je["prefixName"].is_string()) {
e.prefix = je["prefixName"].get<std::string>() == "prefix" ? 1 : 0;
}
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 = categoryFromName(je["categoryName"].get<std::string>());
}
e.sortOrder = static_cast<uint16_t>(je.value("sortOrder", 0));
c.entries.push_back(std::move(e));
}
}
if (!wowee::pipeline::WoweeTitleLoader::save(c, outBase)) {
std::fprintf(stderr,
"import-wtit-json: failed to save %s.wtit\n", outBase.c_str());
return 1;
}
std::printf("Wrote %s.wtit\n", outBase.c_str());
std::printf(" source : %s\n", jsonPath.c_str());
std::printf(" titles : %zu\n", c.entries.size());
return 0;
}
feat(pipeline): add WTIT (Wowee Title catalog) format Novel open replacement for Blizzard's CharTitles.dbc + the AzerothCore-style character_title SQL table. The 30th open format added to the editor. Defines the player-display titles awarded for completing achievements ("the Versatile"), reaching PvP ranks ("Sergeant Major" / "Stone Guard"), participating in raids ("Champion of the Naaru"), levelling a profession ("Master Locksmith"), or seasonal events ("Brewmaster", "the Hallowed"). Closes a long-standing gap: WACH.entry.titleReward has been a free-form string since batch 116 with no formal catalog to resolve against. WTIT systematizes those strings into a real catalog — the runtime resolves WACH.titleReward to a WTIT entry by name, then displays the titleId in the player title selector. Cross-references: WACH.entry.titleReward (string) ~= WTIT.entry.name (string match — runtime resolves achievement- granted titles by looking up matching WTIT entry by name) Format: • magic "WTIT", version 1, little-endian • per title: titleId / name / nameMale / nameFemale / iconPath / prefix (suffix vs prefix display) / category / sortOrder Enums: • Category (8): Achievement / Pvp / Raid / ClassTitle / Event / Profession / Lore / Custom API: WoweeTitleLoader::save / load / exists + WoweeTitle::findById / findByName. Three preset emitters showcase typical title catalogs: • makeStarter — 4 titles (Versatile / Sergeant / Champion / Hallowed) covering 4 categories • makePvp — 28-title classic Honor System ladder (14 Alliance ranks Private->Grand Marshal + 14 Horde ranks Scout->High Warlord) • makeAchievement — 8 achievement titles including "the Versatile" matching WACH.makeMeta's achievement 250 titleReward + capstone profession titles CLI added (5 flags, 608 documented total now): --gen-titles / --gen-titles-pvp / --gen-titles-achievement --info-wtit / --validate-wtit Validator catches: titleId=0 + duplicates, empty name, unknown category, gender variants set on only one side (causes mixed-gender display when the runtime falls back to canonical for the unset side).
2026-05-09 17:07:56 -07:00
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWtitExt(base);
if (!wowee::pipeline::WoweeTitleLoader::exists(base)) {
std::fprintf(stderr,
"validate-wtit: WTIT not found: %s.wtit\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeTitleLoader::load(base);
std::vector<std::string> errors;
std::vector<std::string> warnings;
if (c.entries.empty()) {
warnings.push_back("catalog has zero entries");
}
std::vector<uint32_t> idsSeen;
for (size_t k = 0; k < c.entries.size(); ++k) {
const auto& e = c.entries[k];
std::string ctx = "entry " + std::to_string(k) +
" (id=" + std::to_string(e.titleId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.titleId == 0) errors.push_back(ctx + ": titleId is 0");
if (e.name.empty()) errors.push_back(ctx + ": name is empty");
if (e.category > wowee::pipeline::WoweeTitle::Custom) {
errors.push_back(ctx + ": category " +
std::to_string(e.category) + " not in 0..7");
}
// If gender variants are set, both should be set (otherwise
// the runtime fall-back to canonical leaves one gender
// displaying the wrong form).
if (!e.nameMale.empty() && e.nameFemale.empty()) {
warnings.push_back(ctx +
": nameMale set but nameFemale empty (mixed-gender display)");
}
if (!e.nameFemale.empty() && e.nameMale.empty()) {
warnings.push_back(ctx +
": nameFemale set but nameMale empty (mixed-gender display)");
}
for (uint32_t prev : idsSeen) {
if (prev == e.titleId) {
errors.push_back(ctx + ": duplicate titleId");
break;
}
}
idsSeen.push_back(e.titleId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["wtit"] = base + ".wtit";
j["ok"] = ok;
j["errors"] = errors;
j["warnings"] = warnings;
std::printf("%s\n", j.dump(2).c_str());
return ok ? 0 : 1;
}
std::printf("validate-wtit: %s.wtit\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu titles, all titleIds unique\n",
c.entries.size());
return 0;
}
if (!warnings.empty()) {
std::printf(" warnings (%zu):\n", warnings.size());
for (const auto& w : warnings)
std::printf(" - %s\n", w.c_str());
}
if (!errors.empty()) {
std::printf(" ERRORS (%zu):\n", errors.size());
for (const auto& e : errors)
std::printf(" - %s\n", e.c_str());
}
return ok ? 0 : 1;
}
} // namespace
bool handleTitlesCatalog(int& i, int argc, char** argv, int& outRc) {
if (std::strcmp(argv[i], "--gen-titles") == 0 && i + 1 < argc) {
outRc = handleGenStarter(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-titles-pvp") == 0 && i + 1 < argc) {
outRc = handleGenPvp(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-titles-achievement") == 0 && i + 1 < argc) {
outRc = handleGenAchievement(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-wtit") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-wtit") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--export-wtit-json") == 0 && i + 1 < argc) {
outRc = handleExportJson(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--import-wtit-json") == 0 && i + 1 < argc) {
outRc = handleImportJson(i, argc, argv); return true;
}
feat(pipeline): add WTIT (Wowee Title catalog) format Novel open replacement for Blizzard's CharTitles.dbc + the AzerothCore-style character_title SQL table. The 30th open format added to the editor. Defines the player-display titles awarded for completing achievements ("the Versatile"), reaching PvP ranks ("Sergeant Major" / "Stone Guard"), participating in raids ("Champion of the Naaru"), levelling a profession ("Master Locksmith"), or seasonal events ("Brewmaster", "the Hallowed"). Closes a long-standing gap: WACH.entry.titleReward has been a free-form string since batch 116 with no formal catalog to resolve against. WTIT systematizes those strings into a real catalog — the runtime resolves WACH.titleReward to a WTIT entry by name, then displays the titleId in the player title selector. Cross-references: WACH.entry.titleReward (string) ~= WTIT.entry.name (string match — runtime resolves achievement- granted titles by looking up matching WTIT entry by name) Format: • magic "WTIT", version 1, little-endian • per title: titleId / name / nameMale / nameFemale / iconPath / prefix (suffix vs prefix display) / category / sortOrder Enums: • Category (8): Achievement / Pvp / Raid / ClassTitle / Event / Profession / Lore / Custom API: WoweeTitleLoader::save / load / exists + WoweeTitle::findById / findByName. Three preset emitters showcase typical title catalogs: • makeStarter — 4 titles (Versatile / Sergeant / Champion / Hallowed) covering 4 categories • makePvp — 28-title classic Honor System ladder (14 Alliance ranks Private->Grand Marshal + 14 Horde ranks Scout->High Warlord) • makeAchievement — 8 achievement titles including "the Versatile" matching WACH.makeMeta's achievement 250 titleReward + capstone profession titles CLI added (5 flags, 608 documented total now): --gen-titles / --gen-titles-pvp / --gen-titles-achievement --info-wtit / --validate-wtit Validator catches: titleId=0 + duplicates, empty name, unknown category, gender variants set on only one side (causes mixed-gender display when the runtime falls back to canonical for the unset side).
2026-05-09 17:07:56 -07:00
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee