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

feat(editor): add WSCS (Skill Cost) open catalog format

Browse source 
Open replacement for Blizzard's SkillCostsData.dbc plus the
per-rank training cost tables. Defines the tiered progression of
trainable skills: each rank unlocks a skill range, requires a
minimum character level, and costs a fixed amount of gold to
learn.

The canonical 6-tier profession progression captured by the
default preset:
  Apprentice    skill 0-75     lvl 5    1s
  Journeyman    skill 50-150   lvl 10   5s
  Expert        skill 125-225  lvl 20   1g
  Artisan       skill 200-300  lvl 35   5g
  Master        skill 275-375  lvl 50   10g
  Grand Master  skill 350-450  lvl 65   25g

Same shape applies to weapon skills (free, level-gated, capped at
5x char level) and riding skills (canonical Vanilla / TBC / WotLK
gold costs from 90g Apprentice through 5000g Artisan flying down
to 1000g Cold Weather Flying).

Five costKind values cover the full training-skill space
(Profession / WeaponSkill / RidingSkill / ClassSkill / Misc).
Each entry's copperCost stores the cost in copper (1g = 10000c)
which the info renderer pretty-prints as "25g 0s 0c".

Cross-references back to WSKL — skill entries reference costId
here for the tiered training schedule. nextTrainable(currentSkill,
characterLevel) is the engine helper that returns the lowest-rank
tier a character qualifies for and hasn't capped yet — used by
trainer NPCs to populate their offered-skill list.

Three preset emitters: --gen-scs (6 profession tiers), --gen-scs-
weapon (5 weapon skill tiers), --gen-scs-riding (5 riding tiers
with canonical gold costs).

Validation enforces id+name presence, costKind 0..4, no duplicate
ids, min<max range; warns on:
  - requiredLevel > 80 (unreachable at WotLK cap)
  - RidingSkill with requiredLevel < 20 (Apprentice canonically
    unlocks at 20)
  - Profession kind with copperCost=0 (every standard tier costs
    at least a copper — usually a config bug)

Wired through the cross-format table; WSCS appears automatically
in all 15 cross-format utilities. Format count 84 -> 85; CLI
flag count 1010 -> 1015.
This commit is contained in:
Kelsi 2026-05-09 23:04:02 -07:00
parent a7057393eb
commit b10bc2be5d
10 changed files with 689 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
tools/editor/cli_arg_required.cpp
View file

@ -260,6 +260,8 @@ const char* const kArgRequired[] = {
"--gen-iqr", "--gen-iqr-server", "--gen-iqr-raid",
"--info-wiqr", "--validate-wiqr",
"--export-wiqr-json", "--import-wiqr-json",
"--gen-scs", "--gen-scs-weapon", "--gen-scs-riding",
"--info-wscs", "--validate-wscs",
"--gen-weather-temperate", "--gen-weather-arctic",
"--gen-weather-desert", "--gen-weather-stormy",
"--gen-zone-atmosphere",

2
tools/editor/cli_dispatch.cpp
View file

@ -126,6 +126,7 @@
#include "cli_spell_effect_types_catalog.hpp"
#include "cli_spell_aura_types_catalog.hpp"
#include "cli_item_qualities_catalog.hpp"
#include "cli_skill_costs_catalog.hpp"
#include "cli_quest_objective.hpp"
#include "cli_quest_reward.hpp"
#include "cli_clone.hpp"
@ -293,6 +294,7 @@ constexpr DispatchFn kDispatchTable[] = {
handleSpellEffectTypesCatalog,
handleSpellAuraTypesCatalog,
handleItemQualitiesCatalog,
handleSkillCostsCatalog,
handleQuestObjective,
handleQuestReward,
handleClone,

1
tools/editor/cli_format_table.cpp
View file

@ -87,6 +87,7 @@ constexpr FormatMagicEntry kFormats[] = {
{{'W','S','E','F'}, ".wsef", "spells", "--info-wsef", "Spell effect type catalog"},
{{'W','A','U','R'}, ".waur", "spells", "--info-waur", "Spell aura type catalog"},
{{'W','I','Q','R'}, ".wiqr", "items", "--info-wiqr", "Item quality tier catalog"},
{{'W','S','C','S'}, ".wscs", "skills", "--info-wscs", "Skill cost / training tier catalog"},
{{'W','F','A','C'}, ".wfac", "factions", nullptr, "Faction catalog"},
{{'W','L','C','K'}, ".wlck", "locks", nullptr, "Lock catalog"},
{{'W','S','K','L'}, ".wskl", "skills", nullptr, "Skill catalog"},

10
tools/editor/cli_help.cpp
View file

@ -1937,6 +1937,16 @@ void printUsage(const char* argv0) {
std::printf(" Export binary .wiqr to a human-editable JSON sidecar (defaults to <base>.wiqr.json). Colors as RGBA uint32, easy to paste hex values\n");
std::printf(" --import-wiqr-json <json-path> [out-base]\n");
std::printf(" Import a .wiqr.json sidecar back into binary .wiqr (canBeDisenchanted accepts bool OR int)\n");
std::printf(" --gen-scs <wscs-base> [name]\n");
std::printf(" Emit .wscs 6 canonical profession tiers (Apprentice/Journeyman/Expert/Artisan/Master/GrandMaster) with standard skill ranges and gold costs\n");
std::printf(" --gen-scs-weapon <wscs-base> [name]\n");
std::printf(" Emit .wscs 5 weapon skill tiers (Beginner/Trained/Skilled/Expert/Master) — free to train, level-gated, capped at 5x char level\n");
std::printf(" --gen-scs-riding <wscs-base> [name]\n");
std::printf(" Emit .wscs 5 riding skill tiers (Apprentice 60%% / Journeyman 100%% / Expert 150%% / Artisan 280%% / Cold Weather Flying) with canonical Vanilla/TBC/WotLK gold costs\n");
std::printf(" --info-wscs <wscs-base> [--json]\n");
std::printf(" Print WSCS entries (id / rank / kind / minSkill / maxSkill / required level / gold cost / name)\n");
std::printf(" --validate-wscs <wscs-base> [--json]\n");
std::printf(" Static checks: id+name required, costKind 0..4, no duplicate ids, min<max; warns on lvl>80, RidingSkill below lvl 20, Profession with cost=0\n");
std::printf(" --gen-weather-temperate <wow-base> [zoneName]\n");
std::printf(" Emit .wow weather schedule: clear-dominant + occasional rain + fog (forest / grassland)\n");
std::printf(" --gen-weather-arctic <wow-base> [zoneName]\n");

1
tools/editor/cli_list_formats.cpp
View file

@ -109,6 +109,7 @@ constexpr FormatRow kFormats[] = {
{"WSEF", ".wsef", "spells", "SpellEffect.Effect dispatch", "Spell effect type catalog"},
{"WAUR", ".waur", "spells", "SpellEffect.EffectAuraType", "Spell aura type catalog"},
{"WIQR", ".wiqr", "items", "Item quality tier colors+rules", "Item quality tier catalog"},
{"WSCS", ".wscs", "skills", "SkillCostsData.dbc + train tiers", "Skill cost / training tier catalog"},
// Additional pipeline catalogs without the alternating
// gen/info/validate CLI surface (loaded by the engine

265
tools/editor/cli_skill_costs_catalog.cpp Normal file
View file

@ -0,0 +1,265 @@
#include "cli_skill_costs_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_skill_costs.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 stripWscsExt(std::string base) {
stripExt(base, ".wscs");
return base;
}
bool saveOrError(const wowee::pipeline::WoweeSkillCost& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeSkillCostLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.wscs\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeSkillCost& c,
const std::string& base) {
std::printf("Wrote %s.wscs\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" tiers : %zu\n", c.entries.size());
}
int handleGenProfession(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "ProfessionSkillCosts";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWscsExt(base);
auto c = wowee::pipeline::WoweeSkillCostLoader::makeProfession(name);
if (!saveOrError(c, base, "gen-scs")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenWeapon(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "WeaponSkillCosts";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWscsExt(base);
auto c = wowee::pipeline::WoweeSkillCostLoader::makeWeapon(name);
if (!saveOrError(c, base, "gen-scs-weapon")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenRiding(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "RidingSkillCosts";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWscsExt(base);
auto c = wowee::pipeline::WoweeSkillCostLoader::makeRiding(name);
if (!saveOrError(c, base, "gen-scs-riding")) return 1;
printGenSummary(c, base);
return 0;
}
void formatGold(uint32_t copper, char* buf, size_t bufSize) {
uint32_t g = copper / 10000;
uint32_t s = (copper % 10000) / 100;
uint32_t cop = copper % 100;
if (g > 0) {
std::snprintf(buf, bufSize, "%ug %us %uc", g, s, cop);
} else if (s > 0) {
std::snprintf(buf, bufSize, "%us %uc", s, cop);
} else {
std::snprintf(buf, bufSize, "%uc", cop);
}
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWscsExt(base);
if (!wowee::pipeline::WoweeSkillCostLoader::exists(base)) {
std::fprintf(stderr, "WSCS not found: %s.wscs\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeSkillCostLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["wscs"] = base + ".wscs";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"costId", e.costId},
{"name", e.name},
{"description", e.description},
{"skillRankIndex", e.skillRankIndex},
{"minSkillToLearn", e.minSkillToLearn},
{"maxSkillUnlocked", e.maxSkillUnlocked},
{"requiredLevel", e.requiredLevel},
{"costKind", e.costKind},
{"costKindName", wowee::pipeline::WoweeSkillCost::costKindName(e.costKind)},
{"copperCost", e.copperCost},
{"iconColorRGBA", e.iconColorRGBA},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WSCS: %s.wscs\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" tiers : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id rank kind minSkill maxSkill lvl cost name\n");
for (const auto& e : c.entries) {
char goldBuf[32];
formatGold(e.copperCost, goldBuf, sizeof(goldBuf));
std::printf(" %4u %2u %-11s %5u %5u %3u %-13s %s\n",
e.costId, e.skillRankIndex,
wowee::pipeline::WoweeSkillCost::costKindName(e.costKind),
e.minSkillToLearn, e.maxSkillUnlocked,
e.requiredLevel, goldBuf,
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 = stripWscsExt(base);
if (!wowee::pipeline::WoweeSkillCostLoader::exists(base)) {
std::fprintf(stderr,
"validate-wscs: WSCS not found: %s.wscs\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeSkillCostLoader::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.costId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.costId == 0)
errors.push_back(ctx + ": costId is 0");
if (e.name.empty())
errors.push_back(ctx + ": name is empty");
if (e.costKind > wowee::pipeline::WoweeSkillCost::Misc) {
errors.push_back(ctx + ": costKind " +
std::to_string(e.costKind) + " not in 0..4");
}
if (e.minSkillToLearn >= e.maxSkillUnlocked) {
errors.push_back(ctx +
": minSkillToLearn " +
std::to_string(e.minSkillToLearn) +
" >= maxSkillUnlocked " +
std::to_string(e.maxSkillUnlocked) +
" — tier provides no skill range");
}
if (e.requiredLevel > 80) {
warnings.push_back(ctx +
": requiredLevel " +
std::to_string(e.requiredLevel) +
" > 80 — tier unreachable at WotLK cap");
}
// Riding skill at lvl < 20 is unusual (Apprentice
// requires lvl 20).
if (e.costKind == wowee::pipeline::WoweeSkillCost::RidingSkill &&
e.requiredLevel < 20) {
warnings.push_back(ctx +
": Riding skill with requiredLevel=" +
std::to_string(e.requiredLevel) +
" < 20 — canonical Apprentice Riding unlocks "
"at level 20");
}
// Profession with cost=0 is unusual — every standard
// profession tier costs at least a copper.
if (e.costKind == wowee::pipeline::WoweeSkillCost::Profession &&
e.copperCost == 0) {
warnings.push_back(ctx +
": Profession kind with copperCost=0 — "
"unusual, profession tiers normally cost "
"at least a copper");
}
for (uint32_t prev : idsSeen) {
if (prev == e.costId) {
errors.push_back(ctx + ": duplicate costId");
break;
}
}
idsSeen.push_back(e.costId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["wscs"] = base + ".wscs";
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-wscs: %s.wscs\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu tiers, all costIds 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 handleSkillCostsCatalog(int& i, int argc, char** argv,
int& outRc) {
if (std::strcmp(argv[i], "--gen-scs") == 0 && i + 1 < argc) {
outRc = handleGenProfession(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-scs-weapon") == 0 && i + 1 < argc) {
outRc = handleGenWeapon(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-scs-riding") == 0 && i + 1 < argc) {
outRc = handleGenRiding(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-wscs") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-wscs") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee

12
tools/editor/cli_skill_costs_catalog.hpp Normal file
View file

@ -0,0 +1,12 @@
#pragma once
namespace wowee {
namespace editor {
namespace cli {
bool handleSkillCostsCatalog(int& i, int argc, char** argv,
int& outRc);
} // namespace cli
} // namespace editor
} // namespace wowee