Update to Lumina 5 (new Excel parsing)

Dalamud.CorePlugin/Dalamud.CorePlugin.csproj

@@ -27,8 +27,8 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Lumina" Version="4.2.1" />
-        <PackageReference Include="Lumina.Excel" Version="7.0.1" />
+        <PackageReference Include="Lumina" Version="5.0.0" />
+        <PackageReference Include="Lumina.Excel" Version="7.0.2" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
         <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.333">
             <PrivateAssets>all</PrivateAssets>

Dalamud/Dalamud.csproj

@@ -71,8 +71,8 @@
         <PackageReference Include="goaaats.Reloaded.Hooks" Version="4.2.0-goat.4" />
         <PackageReference Include="goaaats.Reloaded.Assembler" Version="1.0.14-goat.2" />
         <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
-        <PackageReference Include="Lumina" Version="4.2.1" />
-        <PackageReference Include="Lumina.Excel" Version="7.0.1" />
+        <PackageReference Include="Lumina" Version="5.0.0" />
+        <PackageReference Include="Lumina.Excel" Version="7.0.2" />
         <PackageReference Include="Microsoft.Extensions.ObjectPool" Version="9.0.0-preview.1.24081.5" />
         <PackageReference Include="Microsoft.Windows.CsWin32" Version="0.3.46-beta">
           <PrivateAssets>all</PrivateAssets>

Dalamud/Data/DataManager.cs

@@ -11,6 +11,7 @@
 using Lumina;
 using Lumina.Data;
 using Lumina.Excel;
+
 using Newtonsoft.Json;
 using Serilog;
 
@@ -28,12 +29,15 @@ internal sealed class DataManager : IInternalDisposableService, IDataManager
 {
     private readonly Thread luminaResourceThread;
     private readonly CancellationTokenSource luminaCancellationTokenSource;
+    private readonly RsvResolver rsvResolver;
 
     [ServiceManager.ServiceConstructor]
     private DataManager(Dalamud dalamud)
     {
         this.Language = (ClientLanguage)dalamud.StartInfo.Language;
 
+        this.rsvResolver = new();
+
         try
         {
             Log.Verbose("Starting data load...");
@@ -44,11 +48,8 @@ private DataManager(Dalamud dalamud)
                 {
                     LoadMultithreaded = true,
                     CacheFileResources = true,
-#if NEVER // Lumina bug
                     PanicOnSheetChecksumMismatch = true,
-#else
-                    PanicOnSheetChecksumMismatch = false,
-#endif
+                    RsvResolver = this.rsvResolver.TryResolve,
                     DefaultExcelLanguage = this.Language.ToLumina(),
                 };
 
@@ -129,12 +130,12 @@ private DataManager(Dalamud dalamud)
     #region Lumina Wrappers
 
     /// <inheritdoc/>
-    public ExcelSheet<T>? GetExcelSheet<T>() where T : ExcelRow 
-        => this.Excel.GetSheet<T>();
+    public ExcelSheet<T> GetExcelSheet<T>(ClientLanguage? language = null, string? name = null) where T : struct, IExcelRow<T> 
+        => this.Excel.GetSheet<T>(language?.ToLumina(), name);
 
     /// <inheritdoc/>
-    public ExcelSheet<T>? GetExcelSheet<T>(ClientLanguage language) where T : ExcelRow 
-        => this.Excel.GetSheet<T>(language.ToLumina());
+    public SubrowExcelSheet<T> GetSubrowExcelSheet<T>(ClientLanguage? language = null, string? name = null) where T : struct, IExcelSubrow<T>
+        => this.Excel.GetSubrowSheet<T>(language?.ToLumina(), name);
 
     /// <inheritdoc/>
     public FileResource? GetFile(string path) 
@@ -170,6 +171,7 @@ void IInternalDisposableService.DisposeService()
     {
         this.luminaCancellationTokenSource.Cancel();
         this.GameData.Dispose();
+        this.rsvResolver.Dispose();
     }
 
     private class LauncherTroubleshootingInfo

Dalamud/Data/LuminaUtils.cs

@@ -0,0 +1,22 @@
+using Lumina.Excel;
+
+namespace Dalamud.Data;
+
+/// <summary>
+/// A helper class to easily resolve Lumina data within Dalamud.
+/// </summary>
+internal static class LuminaUtils
+{
+    private static ExcelModule Module => Service<DataManager>.Get().Excel;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RowRef{T}"/> class using the default <see cref="ExcelModule"/>.
+    /// </summary>
+    /// <typeparam name="T">The type of Lumina sheet to resolve.</typeparam>
+    /// <param name="rowId">The id of the row to resolve.</param>
+    /// <returns>A new <see cref="RowRef{T}"/> object.</returns>
+    public static RowRef<T> CreateRef<T>(uint rowId) where T : struct, IExcelRow<T>
+    {
+        return new(Module, rowId);
+    }
+}

Dalamud/Data/RsvResolver.cs

@@ -0,0 +1,51 @@
+using System.Collections.Generic;
+
+using Dalamud.Hooking;
+using Dalamud.Logging.Internal;
+using Dalamud.Memory;
+using FFXIVClientStructs.FFXIV.Client.LayoutEngine;
+using Lumina.Text.ReadOnly;
+
+namespace Dalamud.Data;
+
+/// <summary>
+/// Provides functionality for resolving RSV strings.
+/// </summary>
+internal sealed unsafe class RsvResolver : IDisposable
+{
+    private static readonly ModuleLog Log = new("RsvProvider");
+
+    private readonly Hook<LayoutWorld.Delegates.AddRsvString> addRsvStringHook;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RsvResolver"/> class.
+    /// </summary>
+    public RsvResolver()
+    {
+        this.addRsvStringHook = Hook<LayoutWorld.Delegates.AddRsvString>.FromAddress((nint)LayoutWorld.MemberFunctionPointers.AddRsvString, this.AddRsvStringDetour);
+
+        this.addRsvStringHook.Enable();
+    }
+
+    private Dictionary<ReadOnlySeString, ReadOnlySeString> Lookup { get; } = [];
+
+    /// <summary>Attemps to resolve an RSV string.</summary>
+    /// <inheritdoc cref="Lumina.Excel.ExcelModule.ResolveRsvDelegate"/>
+    public bool TryResolve(ReadOnlySeString rsvString, out ReadOnlySeString resolvedString) =>
+        this.Lookup.TryGetValue(rsvString, out resolvedString);
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        this.addRsvStringHook.Dispose();
+    }
+
+    private bool AddRsvStringDetour(LayoutWorld* @this, byte* rsvString, byte* resolvedString, nuint resolvedStringSize)
+    {
+        var rsv = new ReadOnlySeString(MemoryHelper.ReadRawNullTerminated((nint)rsvString));
+        var resolved = new ReadOnlySeString(new ReadOnlySpan<byte>(resolvedString, (int)resolvedStringSize).ToArray());
+        Log.Debug($"Resolving RSV \"{rsv}\" to \"{resolved}\".");
+        this.Lookup[rsv] = resolved;
+        return this.addRsvStringHook.Original(@this, rsvString, resolvedString, resolvedStringSize);
+    }
+}

Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs

@@ -1,6 +1,9 @@
-using Dalamud.Game.ClientState.Resolvers;
+using Dalamud.Data;
+
 using FFXIVClientStructs.FFXIV.Client.Game.UI;
 
+using Lumina.Excel;
+
 namespace Dalamud.Game.ClientState.Aetherytes;
 
 /// <summary>
@@ -56,7 +59,7 @@ public interface IAetheryteEntry
     /// <summary>
     /// Gets the Aetheryte data related to this aetheryte.
     /// </summary>
-    ExcelResolver<Lumina.Excel.GeneratedSheets.Aetheryte> AetheryteData { get; }
+    RowRef<Lumina.Excel.Sheets.Aetheryte> AetheryteData { get; }
 }
 
 /// <summary>
@@ -103,5 +106,5 @@ internal AetheryteEntry(TeleportInfo data)
     public bool IsApartment => this.data.IsApartment;
 
     /// <inheritdoc />
-    public ExcelResolver<Lumina.Excel.GeneratedSheets.Aetheryte> AetheryteData => new(this.AetheryteId);
+    public RowRef<Lumina.Excel.Sheets.Aetheryte> AetheryteData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.Aetheryte>(this.AetheryteId);
 }

Dalamud/Game/ClientState/Buddy/BuddyMember.cs

@@ -1,6 +1,8 @@
+using Dalamud.Data;
 using Dalamud.Game.ClientState.Objects;
 using Dalamud.Game.ClientState.Objects.Types;
-using Dalamud.Game.ClientState.Resolvers;
+
+using Lumina.Excel;
 
 namespace Dalamud.Game.ClientState.Buddy;
 
@@ -45,17 +47,17 @@ public interface IBuddyMember
     /// <summary>
     /// Gets the Mount data related to this buddy. It should only be used with companion buddies.
     /// </summary>
-    ExcelResolver<Lumina.Excel.GeneratedSheets.Mount> MountData { get; }
+    RowRef<Lumina.Excel.Sheets.Mount> MountData { get; }
 
     /// <summary>
     /// Gets the Pet data related to this buddy. It should only be used with pet buddies.
     /// </summary>
-    ExcelResolver<Lumina.Excel.GeneratedSheets.Pet> PetData { get; }
+    RowRef<Lumina.Excel.Sheets.Pet> PetData { get; }
 
     /// <summary>
     /// Gets the Trust data related to this buddy. It should only be used with battle buddies.
     /// </summary>
-    ExcelResolver<Lumina.Excel.GeneratedSheets.DawnGrowMember> TrustData { get; }
+    RowRef<Lumina.Excel.Sheets.DawnGrowMember> TrustData { get; }
 }
 
 /// <summary>
@@ -94,13 +96,13 @@ internal BuddyMember(IntPtr address)
     public uint DataID => this.Struct->DataId;
 
     /// <inheritdoc />
-    public ExcelResolver<Lumina.Excel.GeneratedSheets.Mount> MountData => new(this.DataID);
+    public RowRef<Lumina.Excel.Sheets.Mount> MountData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.Mount>(this.DataID);
 
     /// <inheritdoc />
-    public ExcelResolver<Lumina.Excel.GeneratedSheets.Pet> PetData => new(this.DataID);
+    public RowRef<Lumina.Excel.Sheets.Pet> PetData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.Pet>(this.DataID);
 
     /// <inheritdoc />
-    public ExcelResolver<Lumina.Excel.GeneratedSheets.DawnGrowMember> TrustData => new(this.DataID);
+    public RowRef<Lumina.Excel.Sheets.DawnGrowMember> TrustData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.DawnGrowMember>(this.DataID);
 
     private FFXIVClientStructs.FFXIV.Client.Game.UI.Buddy.BuddyMember* Struct => (FFXIVClientStructs.FFXIV.Client.Game.UI.Buddy.BuddyMember*)this.Address;
 }

Dalamud/Game/ClientState/ClientState.cs

@@ -19,7 +19,7 @@
 using FFXIVClientStructs.FFXIV.Client.UI;
 using FFXIVClientStructs.FFXIV.Client.UI.Agent;
 
-using Lumina.Excel.GeneratedSheets;
+using Lumina.Excel.Sheets;
 
 using Action = System.Action;
 

Dalamud/Game/ClientState/Fates/Fate.cs

@@ -1,10 +1,11 @@
 using System.Numerics;
 
 using Dalamud.Data;
-using Dalamud.Game.ClientState.Resolvers;
 using Dalamud.Game.Text.SeStringHandling;
 using Dalamud.Memory;
 
+using Lumina.Excel;
+
 namespace Dalamud.Game.ClientState.Fates;
 
 /// <summary>
@@ -20,7 +21,7 @@ public interface IFate : IEquatable<IFate>
     /// <summary>
     /// Gets game data linked to this Fate.
     /// </summary>
-    Lumina.Excel.GeneratedSheets.Fate GameData { get; }
+    RowRef<Lumina.Excel.Sheets.Fate> GameData { get; }
 
     /// <summary>
     /// Gets the time this <see cref="Fate"/> started.
@@ -105,7 +106,7 @@ public interface IFate : IEquatable<IFate>
     /// <summary>
     /// Gets the territory this <see cref="Fate"/> is located in.
     /// </summary>
-    ExcelResolver<Lumina.Excel.GeneratedSheets.TerritoryType> TerritoryType { get; }
+    RowRef<Lumina.Excel.Sheets.TerritoryType> TerritoryType { get; }
 
     /// <summary>
     /// Gets the address of this Fate in memory.
@@ -185,7 +186,7 @@ internal unsafe partial class Fate : IFate
     public ushort FateId => this.Struct->FateId;
 
     /// <inheritdoc/>
-    public Lumina.Excel.GeneratedSheets.Fate GameData => Service<DataManager>.Get().GetExcelSheet<Lumina.Excel.GeneratedSheets.Fate>().GetRow(this.FateId);
+    public RowRef<Lumina.Excel.Sheets.Fate> GameData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.Fate>(this.FateId);
 
     /// <inheritdoc/>
     public int StartTimeEpoch => this.Struct->StartTimeEpoch;
@@ -238,5 +239,5 @@ internal unsafe partial class Fate : IFate
     /// <summary>
     /// Gets the territory this <see cref="Fate"/> is located in.
     /// </summary>
-    public ExcelResolver<Lumina.Excel.GeneratedSheets.TerritoryType> TerritoryType => new(this.Struct->TerritoryId);
+    public RowRef<Lumina.Excel.Sheets.TerritoryType> TerritoryType => LuminaUtils.CreateRef<Lumina.Excel.Sheets.TerritoryType>(this.Struct->TerritoryId);
 }

Dalamud/Game/ClientState/JobGauge/Types/SMNGauge.cs

@@ -29,13 +29,13 @@ internal SMNGauge(IntPtr address)
 
     /// <summary>
     /// Gets the summon that will return after the current summon expires.
-    /// This maps to the <see cref="Lumina.Excel.GeneratedSheets.Pet"/> sheet.
+    /// This maps to the <see cref="Lumina.Excel.Sheets.Pet"/> sheet.
     /// </summary>
     public SummonPet ReturnSummon => (SummonPet)this.Struct->ReturnSummon;
 
     /// <summary>
     /// Gets the summon glam for the <see cref="ReturnSummon"/>.
-    /// This maps to the <see cref="Lumina.Excel.GeneratedSheets.PetMirage"/> sheet.
+    /// This maps to the <see cref="Lumina.Excel.Sheets.PetMirage"/> sheet.
     /// </summary>
     public PetGlam ReturnSummonGlam => (PetGlam)this.Struct->ReturnSummonGlam;
 

Dalamud/Game/ClientState/Objects/SubKinds/PlayerCharacter.cs

@@ -1,12 +1,8 @@
-using System.Numerics;
-
-using Dalamud.Game.ClientState.Objects.Enums;
+using Dalamud.Data;
 using Dalamud.Game.ClientState.Objects.Types;
-using Dalamud.Game.ClientState.Resolvers;
-using Dalamud.Game.ClientState.Statuses;
-using Dalamud.Game.Text.SeStringHandling;
 
-using Lumina.Excel.GeneratedSheets;
+using Lumina.Excel;
+using Lumina.Excel.Sheets;
 
 namespace Dalamud.Game.ClientState.Objects.SubKinds;
 
@@ -16,14 +12,14 @@ namespace Dalamud.Game.ClientState.Objects.SubKinds;
 public interface IPlayerCharacter : IBattleChara
 {
     /// <summary>
-    /// Gets the current <see cref="ExcelResolver{T}">world</see> of the character.
+    /// Gets the current <see cref="RowRef{T}">world</see> of the character.
     /// </summary>
-    ExcelResolver<World> CurrentWorld { get; }
+    RowRef<World> CurrentWorld { get; }
 
     /// <summary>
-    /// Gets the home <see cref="ExcelResolver{T}">world</see> of the character.
+    /// Gets the home <see cref="RowRef{T}">world</see> of the character.
     /// </summary>
-    ExcelResolver<World> HomeWorld { get; }
+    RowRef<World> HomeWorld { get; }
 }
 
 /// <summary>
@@ -42,10 +38,10 @@ internal PlayerCharacter(IntPtr address)
     }
 
     /// <inheritdoc/>
-    public ExcelResolver<World> CurrentWorld => new(this.Struct->CurrentWorld);
+    public RowRef<World> CurrentWorld => LuminaUtils.CreateRef<World>(this.Struct->CurrentWorld);
 
     /// <inheritdoc/>
-    public ExcelResolver<World> HomeWorld => new(this.Struct->HomeWorld);
+    public RowRef<World> HomeWorld => LuminaUtils.CreateRef<World>(this.Struct->HomeWorld);
 
     /// <summary>
     /// Gets the target actor ID of the PlayerCharacter.