Kelsidavis-WoWee/tools/editor/cli_holidays_catalog.cpp
Kelsi 2666b976c9 feat(pipeline): add WHOL (Wowee Holiday) catalog
44th open format — replaces Holidays.dbc + HolidayDescriptions.dbc
+ HolidayNames.dbc plus the AzerothCore-style game_event SQL
tables. Defines time-gated world events: seasonal holidays
(Hallow's End / Brewfest / Winter Veil), weekly call-to-arms BG
bonuses, world-PvP windows (Wintergrasp), one-shot specials, and
recurring daily / weekly resets. Each holiday has a recurrence
rule (Annual / Monthly / WeeklyRecur / OneTime), a calendar
window (startMonth + startDay + durationHours), and optional
cross-refs to a feature creature, an intro quest, and a token /
item reward issued during the window.

Cross-references with prior formats — holidayQuestId points at
WQT.questId, bossCreatureId points at WCRT.creatureId,
itemRewardId points at WIT.itemId, and areaIdGate / mapIdGate
point at WMS.areaId / WMS.mapId.

CLI: --gen-holidays (3 seasonal starter), --gen-holidays-weekly
(3 weekly BG call-to-arms windows), --gen-holidays-special (3
world-PvP / lunar / children events), --info-whol, --validate-whol
with --json variants. Validator catches id=0/duplicates, kind /
recurrence out of range, durationHours=0, invalid month/day for
non-weekly recurrence, and calendar-only events (no quest +
boss + reward) as a warning.
2026-05-09 19:05:33 -07:00

255 lines
9.3 KiB
C++

#include "cli_holidays_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_holidays.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 stripWholExt(std::string base) {
stripExt(base, ".whol");
return base;
}
bool saveOrError(const wowee::pipeline::WoweeHoliday& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeHolidayLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.whol\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeHoliday& c,
const std::string& base) {
std::printf("Wrote %s.whol\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" holidays : %zu\n", c.entries.size());
}
int handleGenStarter(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StarterHolidays";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWholExt(base);
auto c = wowee::pipeline::WoweeHolidayLoader::makeStarter(name);
if (!saveOrError(c, base, "gen-holidays")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenWeekly(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "WeeklyHolidays";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWholExt(base);
auto c = wowee::pipeline::WoweeHolidayLoader::makeWeekly(name);
if (!saveOrError(c, base, "gen-holidays-weekly")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenSpecial(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "SpecialHolidays";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWholExt(base);
auto c = wowee::pipeline::WoweeHolidayLoader::makeSpecial(name);
if (!saveOrError(c, base, "gen-holidays-special")) 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 = stripWholExt(base);
if (!wowee::pipeline::WoweeHolidayLoader::exists(base)) {
std::fprintf(stderr, "WHOL not found: %s.whol\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeHolidayLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["whol"] = base + ".whol";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"holidayId", e.holidayId},
{"name", e.name},
{"description", e.description},
{"iconPath", e.iconPath},
{"holidayKind", e.holidayKind},
{"holidayKindName", wowee::pipeline::WoweeHoliday::holidayKindName(e.holidayKind)},
{"recurrence", e.recurrence},
{"recurrenceName", wowee::pipeline::WoweeHoliday::recurrenceName(e.recurrence)},
{"startMonth", e.startMonth},
{"startDay", e.startDay},
{"durationHours", e.durationHours},
{"holidayQuestId", e.holidayQuestId},
{"bossCreatureId", e.bossCreatureId},
{"itemRewardId", e.itemRewardId},
{"areaIdGate", e.areaIdGate},
{"mapIdGate", e.mapIdGate},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WHOL: %s.whol\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" holidays : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id kind recur start dur(h) quest boss item name\n");
for (const auto& e : c.entries) {
char start[16];
std::snprintf(start, sizeof(start), "%02u/%02u",
e.startMonth, e.startDay);
std::printf(" %4u %-9s %-8s %-7s %5u %5u %5u %5u %s\n",
e.holidayId,
wowee::pipeline::WoweeHoliday::holidayKindName(e.holidayKind),
wowee::pipeline::WoweeHoliday::recurrenceName(e.recurrence),
start, e.durationHours,
e.holidayQuestId, e.bossCreatureId,
e.itemRewardId, e.name.c_str());
}
return 0;
}
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWholExt(base);
if (!wowee::pipeline::WoweeHolidayLoader::exists(base)) {
std::fprintf(stderr,
"validate-whol: WHOL not found: %s.whol\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeHolidayLoader::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.holidayId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.holidayId == 0)
errors.push_back(ctx + ": holidayId is 0");
if (e.name.empty())
errors.push_back(ctx + ": name is empty");
if (e.holidayKind > wowee::pipeline::WoweeHoliday::Special) {
errors.push_back(ctx + ": holidayKind " +
std::to_string(e.holidayKind) + " not in 0..5");
}
if (e.recurrence > wowee::pipeline::WoweeHoliday::OneTime) {
errors.push_back(ctx + ": recurrence " +
std::to_string(e.recurrence) + " not in 0..3");
}
if (e.durationHours == 0) {
errors.push_back(ctx +
": durationHours=0 (holiday window has no length)");
}
// Annual / Monthly / OneTime require a real calendar
// start. WeeklyRecur is exempt — it triggers based on
// weekday rather than fixed date.
if (e.recurrence != wowee::pipeline::WoweeHoliday::WeeklyRecur) {
if (e.startMonth == 0 || e.startMonth > 12) {
errors.push_back(ctx + ": startMonth " +
std::to_string(e.startMonth) +
" not in 1..12 (required for non-weekly recurrence)");
}
if (e.startDay == 0 || e.startDay > 31) {
errors.push_back(ctx + ": startDay " +
std::to_string(e.startDay) + " not in 1..31");
}
}
// Holidays with no quest, no boss, AND no reward have
// no in-game presence beyond a calendar entry — useful
// for simple banner-only events but worth flagging.
if (e.holidayQuestId == 0 && e.bossCreatureId == 0 &&
e.itemRewardId == 0) {
warnings.push_back(ctx +
": no quest, boss, or reward — calendar-only event");
}
for (uint32_t prev : idsSeen) {
if (prev == e.holidayId) {
errors.push_back(ctx + ": duplicate holidayId");
break;
}
}
idsSeen.push_back(e.holidayId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["whol"] = base + ".whol";
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-whol: %s.whol\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu holidays, all holidayIds 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 handleHolidaysCatalog(int& i, int argc, char** argv, int& outRc) {
if (std::strcmp(argv[i], "--gen-holidays") == 0 && i + 1 < argc) {
outRc = handleGenStarter(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-holidays-weekly") == 0 && i + 1 < argc) {
outRc = handleGenWeekly(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-holidays-special") == 0 && i + 1 < argc) {
outRc = handleGenSpecial(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-whol") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-whol") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee