feat: dump leaderboard definitions on IW4/IW5

This commit is contained in:
6arelyFuture 2024-05-19 08:55:06 +02:00
parent 4139253aac
commit 7ba5a616cd
Signed by: Future
GPG Key ID: FA77F074E98D98A5
14 changed files with 423 additions and 4 deletions

View File

@ -71,7 +71,7 @@ The following section specify which assets are supported to be dumped to disk (u
| FxImpactTable | ❌ | ❌ | |
| RawFile | ✅ | ✅ | |
| StringTable | ✅ | ✅ | |
| LeaderboardDef | | ❌ | |
| LeaderboardDef | | ❌ | |
| StructuredDataDefSet | ✅ | ✅ | The format is custom due to lacking information about original format. |
| TracerDef | ✅ | ❌ | |
| VehicleDef | ✅ | ❌ | |
@ -116,7 +116,7 @@ The following section specify which assets are supported to be dumped to disk (u
| RawFile | ✅ | ✅ | |
| ScriptFile | ⁉️ | ⁉️ | Can only be dumped/loaded as binary. Editing is possible with [GSC-Tool](https://github.com/xensik/gsc-tool). |
| StringTable | ✅ | ✅ | |
| LeaderboardDef | | ❌ | |
| LeaderboardDef | | ❌ | |
| StructuredDataDefSet | ❌ | ❌ | |
| TracerDef | ❌ | ❌ | |
| VehicleDef | ❌ | ❌ | |

View File

@ -4380,6 +4380,19 @@ namespace IW5
LBUPDATE_TYPE_COUNT = 0x3
};
enum LbTrackType
{
TRK_ALLTIME = 0x0,
TRK_WEEKLY = 0x1,
TRK_MONTHLY = 0x2,
TRK_PRESTIGE_ALLTIME = 0x3,
TRK_PRESTIGE_WEEKLY = 0x4,
TRK_PRESTIGE_MONTHLY = 0x5,
TRK_DAILY = 0x6,
TRK_PRESTIGE_DAILY = 0x7,
TRK_COUNT
};
struct LeaderboardDef
{
const char* name;

View File

@ -0,0 +1,58 @@
#pragma once
#include "Game/IW4/IW4.h"
#include "Json/JsonCommon.h"
#include "Json/JsonExtension.h"
#include <memory>
#include <nlohmann/json.hpp>
#include <optional>
#include <string>
#include <vector>
namespace IW4
{
NLOHMANN_JSON_SERIALIZE_ENUM(LbColType,
{
{LBCOL_TYPE_NUMBER, "number" },
{LBCOL_TYPE_TIME, "time" },
{LBCOL_TYPE_LEVELXP, "levelxp" },
{LBCOL_TYPE_PRESTIGE, "prestige" },
{LBCOL_TYPE_BIGNUMBER, "bignumber"},
{LBCOL_TYPE_PERCENT, "percent" },
});
NLOHMANN_JSON_SERIALIZE_ENUM(LbAggType,
{
{LBAGG_TYPE_MIN, "min" },
{LBAGG_TYPE_MAX, "max" },
{LBAGG_TYPE_SUM, "sum" },
{LBAGG_TYPE_LAST, "last"},
});
class JsonColumnDef
{
public:
std::string name;
int id;
int propertyId;
bool hidden;
std::string statName;
LbColType type;
int precision;
LbAggType agg;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonColumnDef, name, id, propertyId, hidden, statName, type, precision, agg);
class JsonLeaderboardDef
{
public:
int id;
std::optional<int> xpColId;
std::optional<int> prestigeColId;
std::vector<JsonColumnDef> columns;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonLeaderboardDef, id, xpColId, prestigeColId, columns);
} // namespace IW4

View File

@ -0,0 +1,82 @@
#pragma once
#include "Game/IW5/IW5.h"
#include "Json/JsonCommon.h"
#include "Json/JsonExtension.h"
#include <memory>
#include <nlohmann/json.hpp>
#include <optional>
#include <string>
#include <vector>
namespace IW5
{
NLOHMANN_JSON_SERIALIZE_ENUM(LbColType,
{
{LBCOL_TYPE_NUMBER, "number" },
{LBCOL_TYPE_TIME, "time" },
{LBCOL_TYPE_LEVELXP, "levelxp" },
{LBCOL_TYPE_PRESTIGE, "prestige" },
{LBCOL_TYPE_BIGNUMBER, "bignumber"},
{LBCOL_TYPE_PERCENT, "percent" },
{LBCOL_TYPE_TIME_FULL, "time_full"},
});
NLOHMANN_JSON_SERIALIZE_ENUM(LbAggType,
{
{LBAGG_TYPE_MIN, "min" },
{LBAGG_TYPE_MAX, "max" },
{LBAGG_TYPE_SUM, "sum" },
{LBAGG_TYPE_LAST, "last"},
});
NLOHMANN_JSON_SERIALIZE_ENUM(LbUpdateType,
{
{LBUPDATE_TYPE_NORMAL, "normal" },
{LBUPDATE_TYPE_RANK, "rank" },
{LBUPDATE_TYPE_COMBINE, "combine"},
});
NLOHMANN_JSON_SERIALIZE_ENUM(LbTrackType,
{
{TRK_ALLTIME, "ALLTIME" },
{TRK_WEEKLY, "WEEKLY" },
{TRK_MONTHLY, "MONTHLY" },
{TRK_PRESTIGE_ALLTIME, "PRESTIGE_ALLTIME"},
{TRK_PRESTIGE_WEEKLY, "PRESTIGE_WEEKLY" },
{TRK_PRESTIGE_MONTHLY, "PRESTIGE_MONTHLY"},
{TRK_DAILY, "DAILY" },
{TRK_PRESTIGE_DAILY, "PRESTIGE_DAILY" },
});
class JsonColumnDef
{
public:
std::string name;
int id;
int propertyId;
bool hidden;
std::string statName;
LbColType type;
int precision;
LbAggType agg;
int uiCalColX;
int uiCalColY;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonColumnDef, name, id, propertyId, hidden, statName, type, precision, agg, uiCalColX, uiCalColY);
class JsonLeaderboardDef
{
public:
int id;
std::optional<int> xpColId;
std::optional<int> prestigeColId;
std::vector<JsonColumnDef> columns;
LbUpdateType updateType;
std::vector<LbTrackType> trackTypes;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonLeaderboardDef, id, xpColId, prestigeColId, columns, updateType, trackTypes);
} // namespace IW5

View File

@ -0,0 +1,29 @@
#include "AssetDumperLeaderboardDef.h"
#include "Game/IW4/LeaderboardDef/JsonLeaderboardDefWriter.h"
#include <format>
#include <ranges>
using namespace IW4;
std::string AssetDumperLeaderboardDef::GetFileNameForAsset(const std::string& assetName)
{
return std::format("leaderboards/{}.json", assetName);
}
bool AssetDumperLeaderboardDef::ShouldDump(XAssetInfo<LeaderboardDef>* asset)
{
return true;
}
void AssetDumperLeaderboardDef::DumpAsset(AssetDumpingContext& context, XAssetInfo<LeaderboardDef>* asset)
{
const auto assetFile = context.OpenAssetFile(GetFileNameForAsset(asset->m_name));
if (!assetFile)
return;
DumpLeaderboardDefAsJson(*assetFile, asset->Asset());
}

View File

@ -0,0 +1,16 @@
#pragma once
#include "Dumping/AbstractAssetDumper.h"
#include "Game/IW4/IW4.h"
namespace IW4
{
class AssetDumperLeaderboardDef final : public AbstractAssetDumper<LeaderboardDef>
{
static std::string GetFileNameForAsset(const std::string& assetName);
protected:
_NODISCARD bool ShouldDump(XAssetInfo<LeaderboardDef>* asset) override;
void DumpAsset(AssetDumpingContext& context, XAssetInfo<LeaderboardDef>* asset) override;
};
} // namespace IW4

View File

@ -0,0 +1,70 @@
#include "JsonLeaderboardDefWriter.h"
#include "Game/IW4/CommonIW4.h"
#include "Game/IW4/Json/JsonLeaderboardDef.h"
#include <iomanip>
#include <nlohmann/json.hpp>
using namespace nlohmann;
using namespace IW4;
namespace
{
class JsonDumper
{
public:
explicit JsonDumper(std::ostream& stream)
: m_stream(stream)
{
}
void Dump(const LeaderboardDef* leaderboardDef)
{
JsonLeaderboardDef jsonLeaderboardDef;
CreateJsonLeaderboardDef(jsonLeaderboardDef, *leaderboardDef);
json jRoot = jsonLeaderboardDef;
jRoot["_type"] = "leaderboard";
jRoot["_version"] = 1;
m_stream << std::setw(4) << jRoot << "\n";
}
private:
static void CreateJsonColumnDef(JsonColumnDef& jColumnDef, const LbColumnDef& lbColumnDef)
{
jColumnDef.name = lbColumnDef.name;
jColumnDef.id = lbColumnDef.id;
jColumnDef.propertyId = lbColumnDef.propertyId;
jColumnDef.hidden = lbColumnDef.hidden;
jColumnDef.statName = lbColumnDef.statName;
jColumnDef.type = lbColumnDef.type;
jColumnDef.precision = lbColumnDef.precision;
jColumnDef.agg = lbColumnDef.agg;
}
static void CreateJsonLeaderboardDef(JsonLeaderboardDef& jLeaderboardDef, const LeaderboardDef& leaderboardDef)
{
jLeaderboardDef.id = leaderboardDef.id;
jLeaderboardDef.xpColId = (leaderboardDef.xpColId < 0) ? std::nullopt : std::make_optional(leaderboardDef.xpColId);
jLeaderboardDef.prestigeColId = (leaderboardDef.prestigeColId < 0) ? std::nullopt : std::make_optional(leaderboardDef.prestigeColId);
jLeaderboardDef.columns.resize(leaderboardDef.columnCount);
for (auto i = 0; i < leaderboardDef.columnCount; ++i)
CreateJsonColumnDef(jLeaderboardDef.columns[i], leaderboardDef.columns[i]);
}
std::ostream& m_stream;
};
} // namespace
namespace IW4
{
void DumpLeaderboardDefAsJson(std::ostream& stream, const LeaderboardDef* leaderboardDef)
{
JsonDumper dumper(stream);
dumper.Dump(leaderboardDef);
}
} // namespace IW4

View File

@ -0,0 +1,11 @@
#pragma once
#include "Dumping/AssetDumpingContext.h"
#include "Game/IW4/IW4.h"
#include <ostream>
namespace IW4
{
void DumpLeaderboardDefAsJson(std::ostream& stream, const LeaderboardDef* leaderboardDef);
} // namespace IW4

View File

@ -3,6 +3,7 @@
#include "AssetDumpers/AssetDumperAddonMapEnts.h"
#include "AssetDumpers/AssetDumperGfxImage.h"
#include "AssetDumpers/AssetDumperGfxLightDef.h"
#include "AssetDumpers/AssetDumperLeaderboardDef.h"
#include "AssetDumpers/AssetDumperLoadedSound.h"
#include "AssetDumpers/AssetDumperLocalizeEntry.h"
#include "AssetDumpers/AssetDumperMaterial.h"
@ -73,7 +74,7 @@ bool ZoneDumper::DumpZone(AssetDumpingContext& context) const
// DUMP_ASSET_POOL(AssetDumperFxImpactTable, m_fx_impact_table, ASSET_TYPE_IMPACT_FX)
DUMP_ASSET_POOL(AssetDumperRawFile, m_raw_file, ASSET_TYPE_RAWFILE)
DUMP_ASSET_POOL(AssetDumperStringTable, m_string_table, ASSET_TYPE_STRINGTABLE)
// DUMP_ASSET_POOL(AssetDumperLeaderboardDef, m_leaderboard, ASSET_TYPE_LEADERBOARD)
DUMP_ASSET_POOL(AssetDumperLeaderboardDef, m_leaderboard, ASSET_TYPE_LEADERBOARD)
DUMP_ASSET_POOL(AssetDumperStructuredDataDefSet, m_structed_data_def_set, ASSET_TYPE_STRUCTURED_DATA_DEF)
DUMP_ASSET_POOL(AssetDumperTracer, m_tracer, ASSET_TYPE_TRACER)
DUMP_ASSET_POOL(AssetDumperVehicle, m_vehicle, ASSET_TYPE_VEHICLE)

View File

@ -0,0 +1,29 @@
#include "AssetDumperLeaderboardDef.h"
#include "Game/IW5/LeaderboardDef/JsonLeaderboardDefWriter.h"
#include <format>
#include <ranges>
using namespace IW5;
std::string AssetDumperLeaderboardDef::GetFileNameForAsset(const std::string& assetName)
{
return std::format("leaderboards/{}.json", assetName);
}
bool AssetDumperLeaderboardDef::ShouldDump(XAssetInfo<LeaderboardDef>* asset)
{
return true;
}
void AssetDumperLeaderboardDef::DumpAsset(AssetDumpingContext& context, XAssetInfo<LeaderboardDef>* asset)
{
const auto assetFile = context.OpenAssetFile(GetFileNameForAsset(asset->m_name));
if (!assetFile)
return;
DumpLeaderboardDefAsJson(*assetFile, asset->Asset());
}

View File

@ -0,0 +1,16 @@
#pragma once
#include "Dumping/AbstractAssetDumper.h"
#include "Game/IW5/IW5.h"
namespace IW5
{
class AssetDumperLeaderboardDef final : public AbstractAssetDumper<LeaderboardDef>
{
static std::string GetFileNameForAsset(const std::string& assetName);
protected:
_NODISCARD bool ShouldDump(XAssetInfo<LeaderboardDef>* asset) override;
void DumpAsset(AssetDumpingContext& context, XAssetInfo<LeaderboardDef>* asset) override;
};
} // namespace IW5

View File

@ -0,0 +1,82 @@
#include "JsonLeaderboardDefWriter.h"
#include "Game/IW5/CommonIW5.h"
#include "Game/IW5/Json/JsonLeaderboardDef.h"
#include <iomanip>
#include <nlohmann/json.hpp>
using namespace nlohmann;
using namespace IW5;
namespace
{
class JsonDumper
{
public:
explicit JsonDumper(std::ostream& stream)
: m_stream(stream)
{
}
void Dump(const LeaderboardDef* leaderboardDef)
{
JsonLeaderboardDef jsonLeaderboardDef;
CreateJsonLeaderboardDef(jsonLeaderboardDef, *leaderboardDef);
json jRoot = jsonLeaderboardDef;
jRoot["_type"] = "leaderboard";
jRoot["_version"] = 1;
m_stream << std::setw(4) << jRoot << "\n";
}
private:
static void CreateJsonColumnDef(JsonColumnDef& jColumnDef, const LbColumnDef& lbColumnDef)
{
jColumnDef.name = lbColumnDef.name;
jColumnDef.id = lbColumnDef.id;
jColumnDef.propertyId = lbColumnDef.propertyId;
jColumnDef.hidden = lbColumnDef.hidden;
jColumnDef.statName = lbColumnDef.statName;
jColumnDef.type = lbColumnDef.type;
jColumnDef.precision = lbColumnDef.precision;
jColumnDef.agg = lbColumnDef.agg;
jColumnDef.uiCalColX = lbColumnDef.uiCalColX;
jColumnDef.uiCalColY = lbColumnDef.uiCalColY;
}
static void CreateJsonLeaderboardDef(JsonLeaderboardDef& jLeaderboardDef, const LeaderboardDef& leaderboardDef)
{
jLeaderboardDef.id = leaderboardDef.id;
jLeaderboardDef.xpColId = (leaderboardDef.xpColId < 0) ? std::nullopt : std::make_optional(leaderboardDef.xpColId);
jLeaderboardDef.prestigeColId = (leaderboardDef.prestigeColId < 0) ? std::nullopt : std::make_optional(leaderboardDef.prestigeColId);
jLeaderboardDef.columns.resize(leaderboardDef.columnCount);
for (auto i = 0; i < leaderboardDef.columnCount; ++i)
CreateJsonColumnDef(jLeaderboardDef.columns[i], leaderboardDef.columns[i]);
jLeaderboardDef.updateType = leaderboardDef.updateType;
for (auto i = 0; i < LbTrackType::TRK_COUNT; ++i)
{
if ((leaderboardDef.trackTypes & (1 << i)) != 0)
{
jLeaderboardDef.trackTypes.emplace_back(static_cast<LbTrackType>(i));
}
}
}
std::ostream& m_stream;
};
} // namespace
namespace IW5
{
void DumpLeaderboardDefAsJson(std::ostream& stream, const LeaderboardDef* leaderboardDef)
{
JsonDumper dumper(stream);
dumper.Dump(leaderboardDef);
}
} // namespace IW5

View File

@ -0,0 +1,11 @@
#pragma once
#include "Dumping/AssetDumpingContext.h"
#include "Game/IW5/IW5.h"
#include <ostream>
namespace IW5
{
void DumpLeaderboardDefAsJson(std::ostream& stream, const LeaderboardDef* leaderboardDef);
} // namespace IW5

View File

@ -2,6 +2,7 @@
#include "AssetDumpers/AssetDumperAddonMapEnts.h"
#include "AssetDumpers/AssetDumperGfxImage.h"
#include "AssetDumpers/AssetDumperLeaderboardDef.h"
#include "AssetDumpers/AssetDumperLoadedSound.h"
#include "AssetDumpers/AssetDumperLocalizeEntry.h"
#include "AssetDumpers/AssetDumperMenuDef.h"
@ -68,7 +69,7 @@ bool ZoneDumper::DumpZone(AssetDumpingContext& context) const
DUMP_ASSET_POOL(AssetDumperRawFile, m_raw_file, ASSET_TYPE_RAWFILE)
DUMP_ASSET_POOL(AssetDumperScriptFile, m_script_file, ASSET_TYPE_SCRIPTFILE)
DUMP_ASSET_POOL(AssetDumperStringTable, m_string_table, ASSET_TYPE_STRINGTABLE)
// DUMP_ASSET_POOL(AssetDumperLeaderboardDef, m_leaderboard, ASSET_TYPE_LEADERBOARD)
DUMP_ASSET_POOL(AssetDumperLeaderboardDef, m_leaderboard, ASSET_TYPE_LEADERBOARD)
// DUMP_ASSET_POOL(AssetDumperStructuredDataDefSet, m_structed_data_def_set, ASSET_TYPE_STRUCTURED_DATA_DEF)
// DUMP_ASSET_POOL(AssetDumperTracerDef, m_tracer, ASSET_TYPE_TRACER)
// DUMP_ASSET_POOL(AssetDumperVehicleDef, m_vehicle, ASSET_TYPE_VEHICLE)