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(pipeline): add WFAC (Wowee Faction Catalog) format

Browse source 
Novel open replacement for Blizzard's Faction.dbc +
FactionTemplate.dbc + the AzerothCore-style
reputation_reward / reputation_spillover SQL tables. The
17th open format added to the editor.

Combines the "displayable Faction" (player-facing name +
reputation thresholds for friendly/honored/revered/exalted)
with the "FactionTemplate matrix" (which factions are
hostile to which) into one entry. The runtime walks the
catalog to answer two questions:
  • "Will faction A attack faction B on sight?" -> enemy list
  • "What rep tier is the player with X?"      -> thresholds

Cross-references with previously-added formats:
  WCRT.entry.factionId       -> WFAC.entry.factionId
  WFAC.entry.parentFactionId -> WFAC.entry.factionId
  WFAC.entry.enemies[]       -> WFAC.entry.factionId
  WFAC.entry.friends[]       -> WFAC.entry.factionId

The starter preset's factionId 35 (Friendly) and 14
(Hostile) deliberately match the WCRT preset defaults, so
the demo content stack is consistent: WCRT.makeBandit's
factionId=14 has a real entry in WFAC.makeStarter that
declares it hostile to friendly NPCs (35) and players (1).

Format:
  • magic "WFAC", version 1, little-endian
  • per faction: factionId / parentFactionId / name /
    description / reputationFlags / baseReputation /
    7 ascending tier thresholds (hostile..exalted) /
    enemies[] / friends[]

Enums:
  • ReputationFlags: VisibleOnTab / AtWarDefault / Hidden /
                      NoReputation / IsHeader (group label)
  • Tier (canonical): Hated / Hostile / Unfriendly /
                       Neutral / Friendly / Honored /
                       Revered / Exalted

API: WoweeFactionLoader::save / load / exists / findById +
WoweeFaction::isHostile(a, b); presets makeStarter (3-faction
demo matching WCRT defaults), makeAlliance (header +
Stormwind / Darnassus / Ironforge with reciprocal friend
lists + Defias enemy), makeWildlife (4 beast factions, each
hostile to player but ignoring other beasts).

CLI added (5 flags, 514 documented total now):
  --gen-factions / --gen-factions-alliance / --gen-factions-wildlife
  --info-wfac / --validate-wfac

Validator catches: factionId=0 + duplicates, empty name,
threshold ordering violations (hostile must be < unfriendly
< neutral < ... < exalted), self-listed as enemy or friend,
faction in both enemies and friends (incoherent).
This commit is contained in:
Kelsi 2026-05-09 15:37:59 -07:00
parent 62e370545f
commit 4868f780cc
8 changed files with 700 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

268
tools/editor/cli_factions_catalog.cpp Normal file
View file

@ -0,0 +1,268 @@
#include "cli_factions_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_factions.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 stripWfacExt(std::string base) {
stripExt(base, ".wfac");
return base;
}
void appendRepFlagsStr(std::string& s, uint32_t flags) {
if (flags & wowee::pipeline::WoweeFaction::VisibleOnTab) s += "visible ";
if (flags & wowee::pipeline::WoweeFaction::AtWarDefault) s += "at-war ";
if (flags & wowee::pipeline::WoweeFaction::Hidden) s += "hidden ";
if (flags & wowee::pipeline::WoweeFaction::NoReputation) s += "no-rep ";
if (flags & wowee::pipeline::WoweeFaction::IsHeader) s += "header ";
if (s.empty()) s = "-";
else if (s.back() == ' ') s.pop_back();
}
bool saveOrError(const wowee::pipeline::WoweeFaction& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeFactionLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.wfac\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeFaction& c,
const std::string& base) {
std::printf("Wrote %s.wfac\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" factions : %zu\n", c.entries.size());
}
int handleGenStarter(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StarterFactions";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWfacExt(base);
auto c = wowee::pipeline::WoweeFactionLoader::makeStarter(name);
if (!saveOrError(c, base, "gen-factions")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenAlliance(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "AllianceFactions";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWfacExt(base);
auto c = wowee::pipeline::WoweeFactionLoader::makeAlliance(name);
if (!saveOrError(c, base, "gen-factions-alliance")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenWildlife(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "WildlifeFactions";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWfacExt(base);
auto c = wowee::pipeline::WoweeFactionLoader::makeWildlife(name);
if (!saveOrError(c, base, "gen-factions-wildlife")) 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 = stripWfacExt(base);
if (!wowee::pipeline::WoweeFactionLoader::exists(base)) {
std::fprintf(stderr, "WFAC not found: %s.wfac\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeFactionLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["wfac"] = base + ".wfac";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
std::string fs;
appendRepFlagsStr(fs, e.reputationFlags);
nlohmann::json je;
je["factionId"] = e.factionId;
je["parentFactionId"] = e.parentFactionId;
je["name"] = e.name;
je["description"] = e.description;
je["reputationFlags"] = e.reputationFlags;
je["reputationFlagsStr"] = fs;
je["baseReputation"] = e.baseReputation;
je["thresholdHostile"] = e.thresholdHostile;
je["thresholdUnfriendly"] = e.thresholdUnfriendly;
je["thresholdNeutral"] = e.thresholdNeutral;
je["thresholdFriendly"] = e.thresholdFriendly;
je["thresholdHonored"] = e.thresholdHonored;
je["thresholdRevered"] = e.thresholdRevered;
je["thresholdExalted"] = e.thresholdExalted;
je["enemies"] = e.enemies;
je["friends"] = e.friends;
arr.push_back(je);
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WFAC: %s.wfac\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" factions : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id parent flags enemies friends name\n");
for (const auto& e : c.entries) {
std::string fs;
appendRepFlagsStr(fs, e.reputationFlags);
std::printf(" %4u %4u %-12s %2zu %2zu %s\n",
e.factionId, e.parentFactionId, fs.c_str(),
e.enemies.size(), e.friends.size(),
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 = stripWfacExt(base);
if (!wowee::pipeline::WoweeFactionLoader::exists(base)) {
std::fprintf(stderr,
"validate-wfac: WFAC not found: %s.wfac\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeFactionLoader::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;
idsSeen.reserve(c.entries.size());
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.factionId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.factionId == 0) {
errors.push_back(ctx + ": factionId is 0");
}
if (e.name.empty()) {
errors.push_back(ctx + ": name is empty");
}
// Threshold ordering: hostile < unfriendly < neutral <
// friendly < honored < revered < exalted.
if (e.thresholdHostile >= e.thresholdUnfriendly ||
e.thresholdUnfriendly >= e.thresholdNeutral ||
e.thresholdNeutral >= e.thresholdFriendly ||
e.thresholdFriendly >= e.thresholdHonored ||
e.thresholdHonored >= e.thresholdRevered ||
e.thresholdRevered >= e.thresholdExalted) {
errors.push_back(ctx +
": reputation thresholds not strictly ascending "
"(hostile<unfriendly<neutral<friendly<honored<revered<exalted)");
}
// Self-relationship: a faction can't be its own enemy.
for (uint32_t en : e.enemies) {
if (en == e.factionId) {
errors.push_back(ctx + ": faction lists itself as enemy");
break;
}
}
for (uint32_t fr : e.friends) {
if (fr == e.factionId) {
errors.push_back(ctx + ": faction lists itself as friend");
break;
}
}
// A faction in both enemies AND friends is incoherent.
for (uint32_t en : e.enemies) {
for (uint32_t fr : e.friends) {
if (en == fr) {
errors.push_back(ctx +
": faction " + std::to_string(en) +
" appears in both enemies and friends");
break;
}
}
}
for (uint32_t prev : idsSeen) {
if (prev == e.factionId) {
errors.push_back(ctx + ": duplicate factionId");
break;
}
}
idsSeen.push_back(e.factionId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["wfac"] = base + ".wfac";
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-wfac: %s.wfac\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu factions, all factionIds 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 handleFactionsCatalog(int& i, int argc, char** argv, int& outRc) {
if (std::strcmp(argv[i], "--gen-factions") == 0 && i + 1 < argc) {
outRc = handleGenStarter(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-factions-alliance") == 0 && i + 1 < argc) {
outRc = handleGenAlliance(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-factions-wildlife") == 0 && i + 1 < argc) {
outRc = handleGenWildlife(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-wfac") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-wfac") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee