Kelsidavis-WoWee/src/pipeline/wowee_events.cpp

236 lines
7.8 KiB
C++
Raw Normal View History

feat(pipeline): add WSEA (Wowee Seasonal Event) format Novel open replacement for Blizzard's GameEvents.dbc + the AzerothCore-style game_event / game_event_creature / game_event_gameobject SQL tables. The 31st open format added to the editor. Calendar-based content: holidays (Hallow's End, Winter's Veil), recurring promotional events (Children's Week, Lunar Festival, Brewfest), one-time anniversaries, and XP-bonus weekends. Each event has a start date, duration, optional recurrence (yearly / monthly / weekly), faction restriction, optional XP bonus, and a reward currency cross-reference into WTKN. Cross-references with previously-added formats: WSEA.entry.tokenIdReward -> WTKN.entry.tokenId (the seasonal currency the event hands out — Tricky Treats during Hallow's End, Brewfest Tokens during Brewfest, etc.) The yearly preset's tokenIdReward values (200/201/202/203) deliberately match WTKN.makeSeasonal's seasonal token ids so the demo content stack already wires together: WSEA yearly events grant WTKN tokens that vendors can charge in via WTRN.item.extendedCost. Format: • magic "WSEA", version 1, little-endian • per event: eventId / name / description / iconPath / announceMessage / startDate (Unix epoch seconds) / duration_seconds / recurrenceDays (0=one-shot, 365=yearly) / holidayKind / factionGroup / bonusXpPercent / tokenIdReward Enums: • HolidayKind (7): Combat / Collection / Racial / Anniversary / Fishing / Cosmetic / WorldEvent • FactionGroup (3): Both / Alliance / Horde API: WoweeEventLoader::save / load / exists / findById. Three preset emitters showcase typical event shapes: • makeStarter — 3 events covering Combat / Fishing / Anniversary kinds • makeYearly — 4 yearly holidays with full WTKN cross-refs (Hallow's End / Brewfest / Lunar Festival / Winter's Veil) • makeBonusWeekends — 3 monthly Fri-Sun bonus tiers (50% / 100% / 200% RAF-style) CLI added (5 flags, 614 documented total now): --gen-events / --gen-events-yearly / --gen-events-weekends --info-wsea / --validate-wsea Validator catches: eventId=0 + duplicates, empty name, unknown holidayKind / factionGroup, duration_seconds=0 (event never runs), duration > recurrence period (events would overlap themselves on next iteration), bonusXpPercent > 200 (very high — verify intentional).
2026-05-09 17:14:46 -07:00
#include "pipeline/wowee_events.hpp"
#include <cstdio>
#include <cstring>
#include <fstream>
namespace wowee {
namespace pipeline {
namespace {
constexpr char kMagic[4] = {'W', 'S', 'E', 'A'};
constexpr uint32_t kVersion = 1;
template <typename T>
void writePOD(std::ofstream& os, const T& v) {
os.write(reinterpret_cast<const char*>(&v), sizeof(T));
}
template <typename T>
bool readPOD(std::ifstream& is, T& v) {
is.read(reinterpret_cast<char*>(&v), sizeof(T));
return is.gcount() == static_cast<std::streamsize>(sizeof(T));
}
void writeStr(std::ofstream& os, const std::string& s) {
uint32_t n = static_cast<uint32_t>(s.size());
writePOD(os, n);
if (n > 0) os.write(s.data(), n);
}
bool readStr(std::ifstream& is, std::string& s) {
uint32_t n = 0;
if (!readPOD(is, n)) return false;
if (n > (1u << 20)) return false;
s.resize(n);
if (n > 0) {
is.read(s.data(), n);
if (is.gcount() != static_cast<std::streamsize>(n)) {
s.clear();
return false;
}
}
return true;
}
std::string normalizePath(std::string base) {
if (base.size() < 5 || base.substr(base.size() - 5) != ".wsea") {
base += ".wsea";
}
return base;
}
} // namespace
const WoweeEvent::Entry* WoweeEvent::findById(uint32_t eventId) const {
for (const auto& e : entries) if (e.eventId == eventId) return &e;
return nullptr;
}
const char* WoweeEvent::holidayKindName(uint8_t k) {
switch (k) {
case Combat: return "combat";
case Collection: return "collection";
case Racial: return "racial";
case Anniversary: return "anniversary";
case Fishing: return "fishing";
case Cosmetic: return "cosmetic";
case WorldEvent: return "world-event";
default: return "unknown";
}
}
const char* WoweeEvent::factionGroupName(uint8_t f) {
switch (f) {
case FactionBoth: return "both";
case FactionAlliance: return "alliance";
case FactionHorde: return "horde";
default: return "unknown";
}
}
bool WoweeEventLoader::save(const WoweeEvent& cat,
const std::string& basePath) {
std::ofstream os(normalizePath(basePath), std::ios::binary);
if (!os) return false;
os.write(kMagic, 4);
writePOD(os, kVersion);
writeStr(os, cat.name);
uint32_t entryCount = static_cast<uint32_t>(cat.entries.size());
writePOD(os, entryCount);
for (const auto& e : cat.entries) {
writePOD(os, e.eventId);
writeStr(os, e.name);
writeStr(os, e.description);
writeStr(os, e.iconPath);
writeStr(os, e.announceMessage);
writePOD(os, e.startDate);
writePOD(os, e.duration_seconds);
writePOD(os, e.recurrenceDays);
writePOD(os, e.holidayKind);
writePOD(os, e.factionGroup);
writePOD(os, e.bonusXpPercent);
uint8_t pad[3] = {0, 0, 0};
os.write(reinterpret_cast<const char*>(pad), 3);
writePOD(os, e.tokenIdReward);
}
return os.good();
}
WoweeEvent WoweeEventLoader::load(const std::string& basePath) {
WoweeEvent out;
std::ifstream is(normalizePath(basePath), std::ios::binary);
if (!is) return out;
char magic[4];
is.read(magic, 4);
if (std::memcmp(magic, kMagic, 4) != 0) return out;
uint32_t version = 0;
if (!readPOD(is, version) || version != kVersion) return out;
if (!readStr(is, out.name)) return out;
uint32_t entryCount = 0;
if (!readPOD(is, entryCount)) return out;
if (entryCount > (1u << 20)) return out;
out.entries.resize(entryCount);
for (auto& e : out.entries) {
if (!readPOD(is, e.eventId)) { out.entries.clear(); return out; }
if (!readStr(is, e.name) || !readStr(is, e.description) ||
!readStr(is, e.iconPath) || !readStr(is, e.announceMessage)) {
out.entries.clear(); return out;
}
if (!readPOD(is, e.startDate) ||
!readPOD(is, e.duration_seconds) ||
!readPOD(is, e.recurrenceDays) ||
!readPOD(is, e.holidayKind) ||
!readPOD(is, e.factionGroup) ||
!readPOD(is, e.bonusXpPercent)) {
out.entries.clear(); return out;
}
uint8_t pad[3];
is.read(reinterpret_cast<char*>(pad), 3);
if (is.gcount() != 3) { out.entries.clear(); return out; }
if (!readPOD(is, e.tokenIdReward)) {
out.entries.clear(); return out;
}
}
return out;
}
bool WoweeEventLoader::exists(const std::string& basePath) {
std::ifstream is(normalizePath(basePath), std::ios::binary);
return is.good();
}
WoweeEvent WoweeEventLoader::makeStarter(const std::string& catalogName) {
WoweeEvent c;
c.name = catalogName;
{
WoweeEvent::Entry e;
e.eventId = 1; e.name = "Brawl Week";
e.description = "Double honor gains in all PvP combat.";
e.holidayKind = WoweeEvent::Combat;
e.duration_seconds = 7 * 24 * 3600; // 1 week
e.bonusXpPercent = 200;
c.entries.push_back(e);
}
{
WoweeEvent::Entry e;
e.eventId = 2; e.name = "Stranglethorn Fishing Extravaganza";
e.description = "Catch the rare Tastyfish for prizes.";
e.holidayKind = WoweeEvent::Fishing;
e.duration_seconds = 4 * 3600; // 4 hours
e.recurrenceDays = 7; // weekly
c.entries.push_back(e);
}
{
WoweeEvent::Entry e;
e.eventId = 3; e.name = "Anniversary";
e.description = "Celebrate the server's launch anniversary.";
e.holidayKind = WoweeEvent::Anniversary;
e.duration_seconds = 3 * 24 * 3600; // 3 days
e.recurrenceDays = 365; // yearly
e.bonusXpPercent = 50;
c.entries.push_back(e);
}
return c;
}
WoweeEvent WoweeEventLoader::makeYearly(const std::string& catalogName) {
WoweeEvent c;
c.name = catalogName;
auto add = [&](uint32_t id, const char* name, uint8_t kind,
uint32_t durDays, uint32_t tokenId,
const char* announce) {
WoweeEvent::Entry e;
e.eventId = id; e.name = name;
e.holidayKind = kind;
e.duration_seconds = durDays * 24 * 3600;
e.recurrenceDays = 365;
e.tokenIdReward = tokenId;
e.announceMessage = announce;
c.entries.push_back(e);
};
// tokenIds (200/201/202/203) match WTKN.makeSeasonal.
add(100, "Hallow's End", WoweeEvent::Collection, 14, 200,
"The Headless Horseman rides! Tricky Treats await...");
add(101, "Brewfest", WoweeEvent::Cosmetic, 14, 201,
"Brewfest is here. Mount up and ride for the big kegs!");
add(102, "Lunar Festival", WoweeEvent::Anniversary, 14, 202,
"Visit the elders to receive Coins of Ancestry.");
add(103, "Winter's Veil", WoweeEvent::Cosmetic, 21, 203,
"Snow falls across the realm. Greatfather Winter awaits.");
return c;
}
WoweeEvent WoweeEventLoader::makeBonusWeekends(const std::string& catalogName) {
WoweeEvent c;
c.name = catalogName;
auto add = [&](uint32_t id, const char* name,
uint8_t bonus, const char* desc) {
WoweeEvent::Entry e;
e.eventId = id; e.name = name; e.description = desc;
e.holidayKind = WoweeEvent::Combat;
e.duration_seconds = 3 * 24 * 3600; // Fri-Sun
e.recurrenceDays = 30; // monthly
e.bonusXpPercent = bonus;
c.entries.push_back(e);
};
add(300, "Quest XP Bonus", 50, "+50% experience from quests.");
add(301, "Combat XP Bonus", 100, "Double experience from kills.");
add(302, "Refer-A-Friend", 200, "Triple experience while grouped with a recruit.");
return c;
}
} // namespace pipeline
} // namespace wowee