phaneron/Kelsidavis-WoWee
1
0
Fork 0
mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-05-11 03:23:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(pipeline): add WTKN (Wowee Token catalog) format

Browse source 
Novel open replacement for Blizzard's Currency.dbc +
CurrencyCategory.dbc + CurrencyTypes.dbc + the AzerothCore-
style player_currency SQL tables. The 28th open format
added to the editor.

Defines secondary currency tokens beyond gold: Honor Points
(PvP), Arena Points (rated PvP), Marks of Honor (per
battleground), faction reputation tokens, holiday-event
currencies. Each token has a balance cap, optional weekly
cap (regenerating earnings limit), and a category for
grouping in the player's currency tab.

Cross-references:
  WTRN.item.extendedCost -> WTKN.entry.tokenId
                             (vendors can charge in tokens
                              instead of copper — when
                              extendedCost > 0 the runtime
                              looks up the matching token)

Format:
  • magic "WTKN", version 1, little-endian
  • per token: tokenId / name / description / iconPath /
    category / maxBalance / weeklyCap / flags

Enums:
  • Category (6): Misc / Pvp / Reputation / Crafting /
                   Seasonal / Holiday
  • Flags:        AccountWide / Tradeable / HiddenUntilEarned /
                   ResetsOnLogout / ConvertsToGold

API: WoweeTokenLoader::save / load / exists / findById.

Three preset emitters showcase typical token shapes:
  • makeStarter  — 3 tokens (Honor / Marks / Stormwind Guard
                    rep) covering Pvp + Reputation categories
  • makePvp      — full PvP set: Honor (75k) + Arena (5k +
                    weekly 1500) + 6 BG marks of honor for
                    classic + TBC + WotLK battlegrounds
  • makeSeasonal — 4 holiday tokens (Tricky Treats /
                    Brewfest / Coin of Ancestry / Stranger's
                    Gift) all flagged ResetsOnLogout to make
                    them event-bound

CLI added (5 flags, 592 documented total now):
  --gen-tokens / --gen-tokens-pvp / --gen-tokens-seasonal
  --info-wtkn / --validate-wtkn

Validator catches: tokenId=0 + duplicates, empty name,
unknown category, weeklyCap > maxBalance (cap unreachable),
ResetsOnLogout + AccountWide combo (incoherent — account
state survives logout by definition).
This commit is contained in:
Kelsi 2026-05-09 16:53:11 -07:00
parent 68812b6c41
commit b632554b5b
8 changed files with 606 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

235
src/pipeline/wowee_tokens.cpp Normal file
View file

@ -0,0 +1,235 @@
#include "pipeline/wowee_tokens.hpp"
#include <cstdio>
#include <cstring>
#include <fstream>
namespace wowee {
namespace pipeline {
namespace {
constexpr char kMagic[4] = {'W', 'T', 'K', 'N'};
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) != ".wtkn") {
base += ".wtkn";
}
return base;
}
} // namespace
const WoweeToken::Entry* WoweeToken::findById(uint32_t tokenId) const {
for (const auto& e : entries) if (e.tokenId == tokenId) return &e;
return nullptr;
}
const char* WoweeToken::categoryName(uint8_t c) {
switch (c) {
case Misc: return "misc";
case Pvp: return "pvp";
case Reputation: return "rep";
case Crafting: return "crafting";
case Seasonal: return "seasonal";
case Holiday: return "holiday";
default: return "unknown";
}
}
bool WoweeTokenLoader::save(const WoweeToken& 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.tokenId);
writeStr(os, e.name);
writeStr(os, e.description);
writeStr(os, e.iconPath);
writePOD(os, e.category);
uint8_t pad[3] = {0, 0, 0};
os.write(reinterpret_cast<const char*>(pad), 3);
writePOD(os, e.maxBalance);
writePOD(os, e.weeklyCap);
writePOD(os, e.flags);
}
return os.good();
}
WoweeToken WoweeTokenLoader::load(const std::string& basePath) {
WoweeToken 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.tokenId)) { out.entries.clear(); return out; }
if (!readStr(is, e.name) || !readStr(is, e.description) ||
!readStr(is, e.iconPath)) {
out.entries.clear(); return out;
}
if (!readPOD(is, e.category)) {
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.maxBalance) ||
!readPOD(is, e.weeklyCap) ||
!readPOD(is, e.flags)) {
out.entries.clear(); return out;
}
}
return out;
}
bool WoweeTokenLoader::exists(const std::string& basePath) {
std::ifstream is(normalizePath(basePath), std::ios::binary);
return is.good();
}
WoweeToken WoweeTokenLoader::makeStarter(const std::string& catalogName) {
WoweeToken c;
c.name = catalogName;
{
WoweeToken::Entry e;
e.tokenId = 1; e.name = "Honor Points";
e.description = "Earned by participating in PvP combat.";
e.category = WoweeToken::Pvp;
e.maxBalance = 75000;
c.entries.push_back(e);
}
{
WoweeToken::Entry e;
e.tokenId = 2; e.name = "Marks of Honor";
e.description = "Awarded for a battleground victory.";
e.category = WoweeToken::Pvp;
e.maxBalance = 100;
c.entries.push_back(e);
}
{
WoweeToken::Entry e;
e.tokenId = 3; e.name = "Stormwind Guard Token";
e.description = "Earned by serving the Stormwind militia.";
e.category = WoweeToken::Reputation;
e.maxBalance = 5000;
c.entries.push_back(e);
}
return c;
}
WoweeToken WoweeTokenLoader::makePvp(const std::string& catalogName) {
WoweeToken c;
c.name = catalogName;
{
WoweeToken::Entry e;
e.tokenId = 100; e.name = "Honor Points";
e.description = "Earned in any PvP combat.";
e.category = WoweeToken::Pvp;
e.maxBalance = 75000;
e.flags = WoweeToken::HiddenUntilEarned;
c.entries.push_back(e);
}
{
WoweeToken::Entry e;
e.tokenId = 101; e.name = "Arena Points";
e.description = "Awarded weekly based on arena rating.";
e.category = WoweeToken::Pvp;
e.maxBalance = 5000;
e.weeklyCap = 1500;
e.flags = WoweeToken::HiddenUntilEarned;
c.entries.push_back(e);
}
// Marks of Honor for 6 classic battlegrounds.
auto addMark = [&](uint32_t id, const char* bgName) {
WoweeToken::Entry e;
e.tokenId = id;
e.name = std::string("Mark of Honor: ") + bgName;
e.description =
std::string("Awarded for a victory in ") + bgName + ".";
e.category = WoweeToken::Pvp;
e.maxBalance = 100;
c.entries.push_back(e);
};
addMark(102, "Warsong Gulch");
addMark(103, "Arathi Basin");
addMark(104, "Alterac Valley");
addMark(105, "Eye of the Storm");
addMark(106, "Strand of the Ancients");
addMark(107, "Isle of Conquest");
return c;
}
WoweeToken WoweeTokenLoader::makeSeasonal(const std::string& catalogName) {
WoweeToken c;
c.name = catalogName;
auto addSeasonal = [&](uint32_t id, const char* name, const char* desc) {
WoweeToken::Entry e;
e.tokenId = id; e.name = name; e.description = desc;
e.category = WoweeToken::Holiday;
e.maxBalance = 1000;
// Seasonal tokens vanish when the event ends; flag
// ResetsOnLogout makes the runtime drop the balance
// on the next login if the event is no longer active.
e.flags = WoweeToken::ResetsOnLogout;
c.entries.push_back(e);
};
addSeasonal(200, "Tricky Treats",
"Hallow's End candy currency. Spent at Headless Horseman vendors.");
addSeasonal(201, "Brewfest Tokens",
"Brewfest event currency from boss runs and goblin races.");
addSeasonal(202, "Coin of Ancestry",
"Lunar Festival elder reward; spent on holiday gear.");
addSeasonal(203, "Stranger's Gift",
"Winter's Veil snowball-fight reward.");
return c;
}
} // namespace pipeline
} // namespace wowee