zone/OpenAssetTools
zone/OpenAssetTools
2
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-04-19 15:52:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #181 from diamante0018/iw5/dump-leaderboard

Browse Source 
feature: dump leaderboard definitions on IW4/IW5
This commit is contained in:
Jan 2024-05-19 12:27:02 +02:00 committed by GitHub
commit fb6a1b1e9d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
15 changed files with 468 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/SupportedAssetTypes.md
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 | ❌ | ❌ | |

6
src/Common/Game/IW4/IW4_Assets.h
View File

@ -2549,7 +2549,8 @@ namespace IW4
LBCOL_TYPE_PRESTIGE = 0x3,
LBCOL_TYPE_BIGNUMBER = 0x4,
LBCOL_TYPE_PERCENT = 0x5,
LBCOL_TYPE_COUNT = 0x6,
LBCOL_TYPE_COUNT
};
enum LbAggType
@ -2558,7 +2559,8 @@ namespace IW4
LBAGG_TYPE_MAX = 0x1,
LBAGG_TYPE_SUM = 0x2,
LBAGG_TYPE_LAST = 0x3,
LBAGG_TYPE_COUNT = 0x4,
LBAGG_TYPE_COUNT
};
struct LbColumnDef

29
src/Common/Game/IW5/IW5_Assets.h
View File

@ -4346,7 +4346,8 @@ namespace IW5
LBCOL_TYPE_BIGNUMBER = 0x4,
LBCOL_TYPE_PERCENT = 0x5,
LBCOL_TYPE_TIME_FULL = 0x6,
LBCOL_TYPE_COUNT = 0x7
LBCOL_TYPE_COUNT
};
enum LbAggType
@ -4355,7 +4356,8 @@ namespace IW5
LBAGG_TYPE_MAX = 0x1,
LBAGG_TYPE_SUM = 0x2,
LBAGG_TYPE_LAST = 0x3,
LBAGG_TYPE_COUNT = 0x4
LBAGG_TYPE_COUNT
};
struct LbColumnDef
@ -4377,7 +4379,22 @@ namespace IW5
LBUPDATE_TYPE_NORMAL = 0x0,
LBUPDATE_TYPE_RANK = 0x1,
LBUPDATE_TYPE_COMBINE = 0x2,
LBUPDATE_TYPE_COUNT = 0x3
LBUPDATE_TYPE_COUNT
};
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
@ -4417,7 +4434,8 @@ namespace IW5
DATA_ENUM_ARRAY = 0x7,
DATA_FLOAT = 0x8,
DATA_SHORT = 0x9,
DATA_COUNT = 0xA
DATA_COUNT
};
union StructuredDataTypeUnion
@ -4444,7 +4462,8 @@ namespace IW5
VALIDATION_DELTACLAMP = 0x4,
VALIDATION_DELTASTRICT = 0x5,
VALIDATION_XP = 0x6,
VALIDATION_COUNT = 0x7
VALIDATION_COUNT
};
struct StructuredDataStructProperty

58
src/ObjCommon/Game/IW4/Leaderboard/JsonLeaderboardDef.h Normal file
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 aggregationFunction;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonColumnDef, name, id, propertyId, hidden, statName, type, precision, aggregationFunction);
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

82
src/ObjCommon/Game/IW5/Leaderboard/JsonLeaderboardDef.h Normal file
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;
std::optional<int> propertyId;
std::optional<bool> hidden;
std::optional<std::string> statName;
LbColType type;
std::optional<int> precision;
LbAggType aggregationFunction;
std::optional<int> uiCalColX;
std::optional<int> uiCalColY;
};
NLOHMANN_DEFINE_TYPE_EXTENSION(JsonColumnDef, name, id, propertyId, hidden, statName, type, precision, aggregationFunction, 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

29
src/ObjWriting/Game/IW4/AssetDumpers/AssetDumperLeaderboardDef.cpp Normal file
View File

@ -0,0 +1,29 @@
#include "AssetDumperLeaderboardDef.h"
#include "Game/IW4/Leaderboard/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());
}

16
src/ObjWriting/Game/IW4/AssetDumpers/AssetDumperLeaderboardDef.h Normal file
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

83
src/ObjWriting/Game/IW4/Leaderboard/JsonLeaderboardDefWriter.cpp Normal file
View File

@ -0,0 +1,83 @@
#include "JsonLeaderboardDefWriter.h"
#include "Game/IW4/CommonIW4.h"
#include "Game/IW4/Leaderboard/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) const
{
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;
if (lbColumnDef.propertyId != 0)
jColumnDef.propertyId = lbColumnDef.propertyId;
if (lbColumnDef.hidden)
jColumnDef.hidden = lbColumnDef.hidden;
if (lbColumnDef.statName && lbColumnDef.statName[0])
jColumnDef.statName = lbColumnDef.statName;
jColumnDef.type = lbColumnDef.type;
if (lbColumnDef.precision != 0)
jColumnDef.precision = lbColumnDef.precision;
jColumnDef.aggregationFunction = lbColumnDef.agg;
}
static void CreateJsonLeaderboardDef(JsonLeaderboardDef& jLeaderboardDef, const LeaderboardDef& leaderboardDef)
{
jLeaderboardDef.id = leaderboardDef.id;
if (leaderboardDef.xpColId != 0)
jLeaderboardDef.xpColId = leaderboardDef.xpColId;
if (leaderboardDef.prestigeColId != 0)
jLeaderboardDef.prestigeColId = 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

11
src/ObjWriting/Game/IW4/Leaderboard/JsonLeaderboardDefWriter.h Normal file
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

3
src/ObjWriting/Game/IW4/ZoneDumperIW4.cpp
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)

29
src/ObjWriting/Game/IW5/AssetDumpers/AssetDumperLeaderboardDef.cpp Normal file
View File

@ -0,0 +1,29 @@
#include "AssetDumperLeaderboardDef.h"
#include "Game/IW5/Leaderboard/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());
}

16
src/ObjWriting/Game/IW5/AssetDumpers/AssetDumperLeaderboardDef.h Normal file
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

99
src/ObjWriting/Game/IW5/Leaderboard/JsonLeaderboardDefWriter.cpp Normal file
View File

@ -0,0 +1,99 @@
#include "JsonLeaderboardDefWriter.h"
#include "Game/IW5/CommonIW5.h"
#include "Game/IW5/Leaderboard/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) const
{
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;
if (lbColumnDef.propertyId != 0)
jColumnDef.propertyId = lbColumnDef.propertyId;
if (lbColumnDef.hidden)
jColumnDef.hidden = lbColumnDef.hidden;
if (lbColumnDef.statName && lbColumnDef.statName[0])
jColumnDef.statName = lbColumnDef.statName;
jColumnDef.type = lbColumnDef.type;
if (lbColumnDef.precision != 0)
jColumnDef.precision = lbColumnDef.precision;
jColumnDef.aggregationFunction = lbColumnDef.agg;
if (lbColumnDef.uiCalColX != 0 || lbColumnDef.uiCalColY != 0)
{
jColumnDef.uiCalColX = lbColumnDef.uiCalColX;
jColumnDef.uiCalColY = lbColumnDef.uiCalColY;
}
}
static void CreateJsonLeaderboardDef(JsonLeaderboardDef& jLeaderboardDef, const LeaderboardDef& leaderboardDef)
{
jLeaderboardDef.id = leaderboardDef.id;
if (leaderboardDef.xpColId != 0)
jLeaderboardDef.xpColId = leaderboardDef.xpColId;
if (leaderboardDef.prestigeColId != 0)
jLeaderboardDef.prestigeColId = 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 < TRK_COUNT; ++i)
{
const auto trackTypeMask = 1 << i;
if (leaderboardDef.trackTypes & trackTypeMask)
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

11
src/ObjWriting/Game/IW5/Leaderboard/JsonLeaderboardDefWriter.h Normal file
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

3
src/ObjWriting/Game/IW5/ZoneDumperIW5.cpp
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)