fix(spells): load complete retail DAT catalog

Replace the incomplete 3,956-row production CSV with one immutable projection of all 6,266 records in portal.dat. Preserve retail formula targeting, shared Spellbook/MagicRuntime metadata ownership, and fail startup when the required SpellTable is absent.

Co-authored-by: OpenAI Codex <codex@openai.com>
This commit is contained in:
Erik 2026-07-15 21:17:13 +02:00
parent 09612f9981
commit 0eab7497c1
19 changed files with 633 additions and 114 deletions

View file

@ -0,0 +1,158 @@
using AcDream.App.Spells;
using AcDream.Core.Spells;
using DatReaderWriter;
using DatReaderWriter.DBObjs;
using DatReaderWriter.Enums;
using DatReaderWriter.Options;
using DatReaderWriter.Types;
using DatMagicSchool = DatReaderWriter.Enums.MagicSchool;
using DatSpellCategory = DatReaderWriter.Enums.SpellCategory;
using CoreSpellTable = AcDream.Core.Spells.SpellTable;
namespace AcDream.App.Tests.Spells;
public sealed class RetailSpellMetadataProjectorTests
{
[Fact]
public void Project_PreservesRetailFieldsAndDerivesPresentationMetadata()
{
var components = new SpellComponentTable();
components.Components.Add(10u, Component(ComponentType.Herb, "Malar"));
components.Components.Add(11u, Component(ComponentType.Powder, "Caza"));
components.Components.Add(12u, Component(ComponentType.Potion, "El"));
var source = new SpellBase
{
Name = "Incantation of Test",
Description = "A projected retail spell.",
Components = [0xC1u, 10u, 11u, 12u, 63u, 0x31u],
School = DatMagicSchool.WarMagic,
Icon = 0x06001234u,
Category = (DatSpellCategory)77u,
Bitfield = SpellIndex.Resistable | SpellIndex.Projectile | SpellIndex.FastCast,
BaseMana = 50u,
BaseRangeConstant = 40f,
BaseRangeMod = 0.25f,
Power = 400u,
SpellEconomyMod = -1f,
FormulaVersion = 3u,
ComponentLoss = 0.2f,
MetaSpellType = SpellType.Projectile,
MetaSpellId = 5000u,
CasterEffect = (PlayScript)6u,
TargetEffect = (PlayScript)7u,
FizzleEffect = (PlayScript)8u,
RecoveryInterval = 1.5,
RecoveryAmount = 2.5f,
DisplayOrder = 1234u,
NonComponentTargetType = ItemType.Creature,
ManaMod = 14u,
};
SpellMetadata actual = RetailSpellMetadataProjector.Project(
5000u, source, components);
Assert.Equal("Incantation of Test", actual.Name);
Assert.Equal("A projected retail spell.", actual.Description);
Assert.Equal("War Magic", actual.School);
Assert.Equal(AcDream.Core.Spells.MagicSchool.WarMagic, actual.SchoolId);
Assert.Equal(77u, actual.Family);
Assert.Equal(0x06001234u, actual.IconId);
Assert.Equal("Malar Cazael", actual.SpellWords);
Assert.Equal(8, actual.Generation);
Assert.Equal(0x10u, actual.TargetMask);
Assert.False(actual.IsUntargeted);
Assert.True(actual.IsProjectile);
Assert.True(actual.IsFastWindup);
Assert.True(actual.IsOffensive);
Assert.Equal(source.Components, actual.FormulaComponents);
Assert.Equal(3u, actual.FormulaVersion);
Assert.Equal(14u, actual.ManaModifier);
Assert.Equal((uint)ItemType.Creature, actual.NonComponentTargetType);
Assert.Equal(0x10u, actual.FormulaTargetType);
}
[Fact]
public void Load_EndOfRetailDat_ResolvesEveryLateLearnedSpellMissingFromCsv()
{
string? datDir = ResolveDatDir();
string? csvPath = ResolveRepoFile("docs", "research", "data", "spells.csv");
if (datDir is null || csvPath is null) return;
using var dats = new DatCollection(datDir, DatAccessType.Read);
MagicCatalog catalog = MagicCatalog.Load(dats);
CoreSpellTable legacy = CoreSpellTable.LoadFromCsv(csvPath);
Assert.Equal(6266, catalog.SpellTable.Count);
Assert.Equal(3956, legacy.Count);
uint[] lateSpellIds = catalog.SpellTable.SpellIds
.Where(id => !legacy.TryGet(id, out _))
.ToArray();
Assert.Equal(2310, lateSpellIds.Length);
var spellbook = new Spellbook(catalog.SpellTable);
foreach (uint spellId in lateSpellIds)
{
spellbook.OnSpellLearned(spellId);
Assert.True(spellbook.TryGetMetadata(spellId, out SpellMetadata metadata));
Assert.Equal(spellId, metadata.SpellId);
}
}
[Fact]
public void Load_EndOfRetailDat_UsesRetailFormulaTargetsInsteadOfLegacyExportMasks()
{
string? datDir = ResolveDatDir();
string? csvPath = ResolveRepoFile("docs", "research", "data", "spells.csv");
if (datDir is null || csvPath is null) return;
using var dats = new DatCollection(datDir, DatAccessType.Read);
MagicCatalog catalog = MagicCatalog.Load(dats);
CoreSpellTable legacy = CoreSpellTable.LoadFromCsv(csvPath);
var mismatches = new List<string>();
foreach (uint spellId in legacy.SpellIds)
{
if (!legacy.TryGet(spellId, out SpellMetadata oldSpell)
|| !catalog.SpellTable.TryGet(spellId, out SpellMetadata datSpell))
continue;
if (oldSpell.TargetMask != datSpell.TargetMask)
mismatches.Add(
$"{spellId}:{oldSpell.Name} csv=0x{oldSpell.TargetMask:X8} " +
$"dat=0x{datSpell.TargetMask:X8} formulaTarget=0x{datSpell.FormulaTargetType:X8} " +
$"formula=[{string.Join(',', datSpell.FormulaComponents)}]");
}
Assert.Equal(378, mismatches.Count);
Assert.Contains(mismatches, value => value.StartsWith("35:Blood Drinker I "));
Assert.Contains(mismatches, value => value.Contains("csv=0x00000101 dat=0x00000010"));
}
private static SpellComponentBase Component(ComponentType type, string text) => new()
{
Type = type,
Text = text,
};
private static string? ResolveDatDir()
{
string? fromEnv = System.Environment.GetEnvironmentVariable("ACDREAM_DAT_DIR");
if (!string.IsNullOrWhiteSpace(fromEnv) && Directory.Exists(fromEnv))
return fromEnv;
string fallback = Path.Combine(
System.Environment.GetFolderPath(System.Environment.SpecialFolder.UserProfile),
"Documents", "Asheron's Call");
return Directory.Exists(fallback) ? fallback : null;
}
private static string? ResolveRepoFile(params string[] parts)
{
var current = new DirectoryInfo(AppContext.BaseDirectory);
while (current is not null)
{
string candidate = Path.Combine([current.FullName, .. parts]);
if (File.Exists(candidate)) return candidate;
current = current.Parent;
}
return null;
}
}