Update v2.3.5.4

Lunaretic · Lunaretic · commit d8e8f666dcec · 2021-04-16T18:56:38.000-04:00
diff --git a/xivModdingFramework/Cache/XivCache.cs b/xivModdingFramework/Cache/XivCache.cs
@@ -18,6 +18,8 @@
 using xivModdingFramework.Resources;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Cache
 {
 
@@ -145,9 +147,10 @@ public enum CacheRebuildReason
         /// <param name="gameDirectory"></param>
         /// <param name="language"></param>
         /// <param name="validateCache"></param>
-        public static void SetGameInfo(DirectoryInfo gameDirectory = null, XivLanguage language = XivLanguage.None, int dxMode = 11, bool validateCache = true, bool enableCacheWorker = true)
+        public static void SetGameInfo(DirectoryInfo gameDirectory = null, XivLanguage language = XivLanguage.None, int dxMode = 11, bool validateCache = true, bool enableCacheWorker = true,
+            DirectoryInfo luminaDirectory = null, bool useLumina = false)
         {
-            var gi = new GameInfo(gameDirectory, language, dxMode);
+            var gi = new GameInfo(gameDirectory, language, dxMode, luminaDirectory, useLumina);
             SetGameInfo(gi, enableCacheWorker);
         }
         public static void SetGameInfo(GameInfo gameInfo = null, bool enableCacheWorker = true)
diff --git a/xivModdingFramework/Cache/XivDependencyGraph.cs b/xivModdingFramework/Cache/XivDependencyGraph.cs
@@ -26,6 +26,8 @@
 using xivModdingFramework.Variants.FileTypes;
 using static xivModdingFramework.Cache.XivCache;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Cache
 {
 
diff --git a/xivModdingFramework/Exd/FileTypes/Ex.cs b/xivModdingFramework/Exd/FileTypes/Ex.cs
@@ -23,6 +23,8 @@
 using xivModdingFramework.Helpers;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Exd.FileTypes
 {
     /// <summary>
diff --git a/xivModdingFramework/General/CMP.cs b/xivModdingFramework/General/CMP.cs
@@ -40,7 +40,19 @@ internal static async Task ApplyRgspFile(string filePath, IndexFile index = null
             var _dat = new Dat(XivCache.GameInfo.GameDirectory);
             var rgspData = await _dat.GetType2Data(filePath, false, index, modlist);
 
-            var rgsp = new RacialGenderScalingParameter(rgspData);
+            await ApplyRgspFile(rgspData);
+        }
+
+        /// <summary>
+        /// Applies a custom .rgsp file to the main Human.CMP file.
+        /// </summary>
+        /// <param name="data"></param>
+        /// <param name="index"></param>
+        /// <param name="modlist"></param>
+        /// <returns></returns>
+        internal static async Task ApplyRgspFile(byte[] data, IndexFile index = null, ModList modlist = null)
+        {
+            var rgsp = new RacialGenderScalingParameter(data);
 
             await SetScalingParameter(rgsp, index, modlist);
         }
diff --git a/xivModdingFramework/General/GameInfo.cs b/xivModdingFramework/General/GameInfo.cs
@@ -30,6 +30,20 @@ public class GameInfo
         public DirectoryInfo GameDirectory { get; }
 
 
+        // These Lumina settings live here mostly for convenience, as they also should not be highly changeable data.
+        // In the future, it may make sense to move them into the SQL metadata cache, but for now this is a more known-stable place to keep them.
+
+        /// <summary>
+        /// Lumina output directory.
+        /// </summary>
+        public DirectoryInfo LuminaDirectory { get; }
+
+        /// <summary>
+        /// Should mod output be redirected to Lumina?
+        /// </summary>
+        public bool UseLumina { get; }
+
+
         /// <summary>
         /// The current version of the game.
         /// </summary>
@@ -49,11 +63,13 @@ public class GameInfo
         /// </summary>
         /// <param name="gameDirectory">The directory in which the game is installed.</param>
         /// <param name="xivLanguage">The language to use when parsing the game data.</param>
-        public GameInfo(DirectoryInfo gameDirectory, XivLanguage xivLanguage, int dxMode = 11)
+        public GameInfo(DirectoryInfo gameDirectory, XivLanguage xivLanguage, int dxMode = 11, DirectoryInfo luminaDirectory = null, bool useLumina = false)
         {
             GameDirectory = gameDirectory;
             GameLanguage  = xivLanguage;
             GameVersion   = GetGameVersion();
+            LuminaDirectory = luminaDirectory;
+            UseLumina = useLumina;
             DxMode = dxMode;
 
             if (!gameDirectory.FullName.Contains(Path.Combine("game", "sqpack", "ffxiv")))
diff --git a/xivModdingFramework/General/XivModelChara.cs b/xivModdingFramework/General/XivModelChara.cs
@@ -17,6 +17,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
+using xivModdingFramework.Cache;
 using xivModdingFramework.Exd.Enums;
 using xivModdingFramework.Exd.FileTypes;
 using xivModdingFramework.Helpers;
@@ -98,11 +99,25 @@ public static XivModelInfo GetModelInfo(Dictionary<int, byte[]> modelCharaEx, in
 
             // These are the offsets to relevant data
             // These will need to be changed if data gets added or removed with a patch
-            const int modelDataOffset = 4;
+            int startOffset = 4;
+            int modelDataOffset = 8;
+            if (XivCache.GameInfo.GameLanguage == Enums.XivLanguage.Chinese)
+            {
+                startOffset = 0;
+                modelDataOffset = 4;
+
+            } else if (XivCache.GameInfo.GameLanguage == Enums.XivLanguage.Korean)
+            { 
+                startOffset = 0;
+                modelDataOffset = 4;
+            }
 
             // Big Endian Byte Order 
             using (var br = new BinaryReaderBE(new MemoryStream(modelCharaEx[index])))
             {
+
+
+                br.BaseStream.Seek(startOffset, SeekOrigin.Begin);
                 xivModelInfo.PrimaryID = br.ReadInt16();
 
                 br.BaseStream.Seek(modelDataOffset, SeekOrigin.Begin);
diff --git a/xivModdingFramework/HUD/FileTypes/Uld.cs b/xivModdingFramework/HUD/FileTypes/Uld.cs
@@ -25,6 +25,8 @@
 using xivModdingFramework.Helpers;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.HUD.FileTypes
 {
     /// <summary>
diff --git a/xivModdingFramework/Helpers/ProblemChecker.cs b/xivModdingFramework/Helpers/ProblemChecker.cs
@@ -25,6 +25,8 @@
 using xivModdingFramework.Resources;
 using xivModdingFramework.Cache;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Helpers
 {
     public class ProblemChecker
diff --git a/xivModdingFramework/Items/Categories/Gear.cs b/xivModdingFramework/Items/Categories/Gear.cs
@@ -36,6 +36,8 @@
 using xivModdingFramework.Textures.Enums;
 using xivModdingFramework.Variants.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Items.Categories
 {
     /// <summary>
diff --git a/xivModdingFramework/Items/Categories/Housing.cs b/xivModdingFramework/Items/Categories/Housing.cs
@@ -33,6 +33,8 @@
 using xivModdingFramework.Resources;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Items.Categories
 {
     public class Housing
diff --git a/xivModdingFramework/Materials/FileTypes/Mtrl.cs b/xivModdingFramework/Materials/FileTypes/Mtrl.cs
@@ -38,6 +38,8 @@
 using xivModdingFramework.Textures.FileTypes;
 using xivModdingFramework.Variants.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Materials.FileTypes
 {
     /// <summary>
diff --git a/xivModdingFramework/Models/FileTypes/Eqp.cs b/xivModdingFramework/Models/FileTypes/Eqp.cs
@@ -17,6 +17,8 @@
 using xivModdingFramework.SqPack.DataContainers;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Models.FileTypes
 {
     public class Eqp
diff --git a/xivModdingFramework/Models/FileTypes/Mdl.cs b/xivModdingFramework/Models/FileTypes/Mdl.cs
@@ -60,6 +60,8 @@
 using xivModdingFramework.Mods.DataContainers;
 using xivModdingFramework.Mods.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Models.FileTypes
 {
     public class Mdl
diff --git a/xivModdingFramework/Models/FileTypes/Sklb.cs b/xivModdingFramework/Models/FileTypes/Sklb.cs
@@ -38,6 +38,8 @@
 using xivModdingFramework.Resources;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Models.FileTypes
 {
     /// <summary>
diff --git a/xivModdingFramework/Mods/FileTypes/ItemMetadata.cs b/xivModdingFramework/Mods/FileTypes/ItemMetadata.cs
@@ -20,6 +20,8 @@
 using xivModdingFramework.Variants.DataContainers;
 using xivModdingFramework.Variants.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Mods.FileTypes
 {
     /// <summary>
@@ -406,7 +408,7 @@ internal static async Task ApplyMetadata(ItemMetadata meta, IndexFile index = nu
                 await _eqp.SaveGimmickParameter(meta.Root.Info.PrimaryId, meta.GmpEntry, dummyItem, index, modlist);
             }
 
-            if (doSave)
+            if (doSave && !XivCache.GameInfo.UseLumina)
             {
                 await _index.SaveIndexFile(index);
                 await _modding.SaveModListAsync(modlist);
diff --git a/xivModdingFramework/Mods/FileTypes/TTMP.cs b/xivModdingFramework/Mods/FileTypes/TTMP.cs
@@ -34,6 +34,8 @@
 using xivModdingFramework.SqPack.DataContainers;
 using xivModdingFramework.SqPack.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Mods.FileTypes
 {
     public class TTMP
diff --git a/xivModdingFramework/Mods/Modding.cs b/xivModdingFramework/Mods/Modding.cs
@@ -39,6 +39,8 @@
 using xivModdingFramework.Variants.DataContainers;
 using xivModdingFramework.Variants.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Mods
 {
     /// <summary>
@@ -274,6 +276,11 @@ public async Task<XivModStatus> IsModEnabled(string internalPath, bool indexChec
         /// <param name="enable">The status of the mod</param>
         public async Task<bool> ToggleModStatus(string internalFilePath, bool enable)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             var index = new Index(_gameDirectory);
 
             if (string.IsNullOrEmpty(internalFilePath))
@@ -305,6 +312,11 @@ public async Task<bool> ToggleModStatus(string internalFilePath, bool enable)
         /// <param name="enable">The status of the mod</param>
         public async Task ToggleModPackStatus(string modPackName, bool enable)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             var index = new Index(_gameDirectory);
 
             var modList = GetModList();
@@ -346,6 +358,11 @@ public async Task ToggleModPackStatus(string modPackName, bool enable)
         /// <returns></returns>
         public async Task<bool> ToggleModUnsafe(bool enable, Mod mod, bool includeInternal, bool updateCache, IndexFile cachedIndex = null, ModList cachedModlist = null)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             if (mod == null) return false;
             if (string.IsNullOrEmpty(mod.name)) return false;
             if (string.IsNullOrEmpty(mod.fullPath)) return false;
@@ -444,12 +461,21 @@ public async Task<bool> ToggleModUnsafe(bool enable, Mod mod, bool includeIntern
         /// <param name="enable">The status to switch the mods to True if enable False if disable</param>
         public async Task ToggleAllMods(bool enable, IProgress<(int current, int total, string message)> progress = null)
         {
+            if(XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be toggled in Lumina mode.");
+            }
             var modList = await GetModListAsync();
             await ToggleMods(enable, modList.Mods.Select(x => x.fullPath), progress);
         }
 
         public async Task ToggleMods(bool enable, IEnumerable<string> filePaths, IProgress<(int current, int total, string message)> progress = null)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be toggled in Lumina mode.");
+            }
+
             var _index = new Index(_gameDirectory);
 
             var modList = await GetModListAsync();
@@ -623,6 +649,11 @@ public async Task<int> PurgeInvalidEmptyBlocks()
         /// <param name="modItemPath">The mod item path of the mod to delete</param>
         public async Task DeleteMod(string modItemPath, bool allowInternal = false, IndexFile index = null, ModList modList = null)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             var doSave = false;
             var _index = new Index(_gameDirectory);
             if (modList == null)
@@ -674,6 +705,11 @@ where mod.fullPath.Equals(modItemPath)
         /// <param name="modPackName">The name of the Mod Pack to be deleted</param>
         public async Task DeleteModPack(string modPackName)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             var modList = GetModList();
 
             var modPackItem = (from modPack in modList.ModPacks
@@ -714,6 +750,11 @@ where modPack.name.Equals(modPackName)
         /// <returns></returns>
         public async Task CleanUpModlist(IProgress<(int Current, int Total, string Message)> progressReporter = null)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             progressReporter?.Report((0, 0, "Loading Modlist file..."));
             var modlist = await GetModListAsync();
 
@@ -900,6 +941,11 @@ public async Task<long> GetTotalModDataSize()
         /// <returns></returns>
         public async Task<long> DefragmentModdedDats(IProgress<(int Current, int Total, string Message)> progressReporter = null)
         {
+            if (XivCache.GameInfo.UseLumina)
+            {
+                throw new Exception("TexTools mods cannot be altered in Lumina mode.");
+            }
+
             var modlist = await GetModListAsync();
             var _dat = new Dat(XivCache.GameInfo.GameDirectory);
             var _index = new Index(XivCache.GameInfo.GameDirectory);
diff --git a/xivModdingFramework/Mods/RootCloner.cs b/xivModdingFramework/Mods/RootCloner.cs
@@ -21,6 +21,8 @@
 using xivModdingFramework.Variants.DataContainers;
 using xivModdingFramework.Variants.FileTypes;
 
+using Index = xivModdingFramework.SqPack.FileTypes.Index;
+
 namespace xivModdingFramework.Mods
 {
     public static class RootCloner
@@ -50,6 +52,15 @@ public static async Task<Dictionary<string, string>> CloneRoot(XivDependencyRoot
                 throw new InvalidDataException("Cannot clone unsupported root.");
             }
 
+            if(XivCache.GameInfo.UseLumina)
+            {
+                // Using the root cloner with Lumina import mode enabled is unstable/not safe.
+                // ( The state of the game files in the TT system may not match the state of the 
+                // Lumina mod setup, and the modlist/etc. can get bashed as this function directly
+                // modifies the modlist during the cloning process. )
+                throw new Exception("Item Conversion cannot be used with Lumina import mode.");
+            }
+
 
             if (ProgressReporter != null)
             {
diff --git a/xivModdingFramework/SqPack/FileTypes/Dat.cs b/xivModdingFramework/SqPack/FileTypes/Dat.cs
diff --git a/xivModdingFramework/Textures/FileTypes/ATex.cs b/xivModdingFramework/Textures/FileTypes/ATex.cs
diff --git a/xivModdingFramework/Textures/FileTypes/Tex.cs b/xivModdingFramework/Textures/FileTypes/Tex.cs
diff --git a/xivModdingFramework/Variants/FileTypes/Imc.cs b/xivModdingFramework/Variants/FileTypes/Imc.cs
diff --git a/xivModdingFramework/xivModdingFramework.csproj b/xivModdingFramework/xivModdingFramework.csproj

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`using xivModdingFramework.Resources;`
`19`	`19`	`using xivModdingFramework.SqPack.FileTypes;`
`20`	`20`
	`21`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`22`	`+`
`21`	`23`	`namespace xivModdingFramework.Cache`
`22`	`24`	`{`
`23`	`25`
`@@ -145,9 +147,10 @@ public enum CacheRebuildReason`
`145`	`147`	`/// <param name="gameDirectory"></param>`
`146`	`148`	`/// <param name="language"></param>`
`147`	`149`	`/// <param name="validateCache"></param>`
`148`		`- public static void SetGameInfo(DirectoryInfo gameDirectory = null, XivLanguage language = XivLanguage.None, int dxMode = 11, bool validateCache = true, bool enableCacheWorker = true)`
	`150`	`+ public static void SetGameInfo(DirectoryInfo gameDirectory = null, XivLanguage language = XivLanguage.None, int dxMode = 11, bool validateCache = true, bool enableCacheWorker = true,`
	`151`	`+ DirectoryInfo luminaDirectory = null, bool useLumina = false)`
`149`	`152`	`{`
`150`		`- var gi = new GameInfo(gameDirectory, language, dxMode);`
	`153`	`+ var gi = new GameInfo(gameDirectory, language, dxMode, luminaDirectory, useLumina);`
`151`	`154`	`SetGameInfo(gi, enableCacheWorker);`
`152`	`155`	`}`
`153`	`156`	`public static void SetGameInfo(GameInfo gameInfo = null, bool enableCacheWorker = true)`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@`
`26`	`26`	`using xivModdingFramework.Variants.FileTypes;`
`27`	`27`	`using static xivModdingFramework.Cache.XivCache;`
`28`	`28`
	`29`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`30`	`+`
`29`	`31`	`namespace xivModdingFramework.Cache`
`30`	`32`	`{`
`31`	`33`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`using xivModdingFramework.Helpers;`
`24`	`24`	`using xivModdingFramework.SqPack.FileTypes;`
`25`	`25`
	`26`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`27`	`+`
`26`	`28`	`namespace xivModdingFramework.Exd.FileTypes`
`27`	`29`	`{`
`28`	`30`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`using xivModdingFramework.Helpers;`
`26`	`26`	`using xivModdingFramework.SqPack.FileTypes;`
`27`	`27`
	`28`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`29`	`+`
`28`	`30`	`namespace xivModdingFramework.HUD.FileTypes`
`29`	`31`	`{`
`30`	`32`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@`
`36`	`36`	`using xivModdingFramework.Textures.Enums;`
`37`	`37`	`using xivModdingFramework.Variants.FileTypes;`
`38`	`38`
	`39`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`40`	`+`
`39`	`41`	`namespace xivModdingFramework.Items.Categories`
`40`	`42`	`{`
`41`	`43`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,8 @@`
`33`	`33`	`using xivModdingFramework.Resources;`
`34`	`34`	`using xivModdingFramework.SqPack.FileTypes;`
`35`	`35`
	`36`	`+using Index = xivModdingFramework.SqPack.FileTypes.Index;`
	`37`	`+`
`36`	`38`	`namespace xivModdingFramework.Items.Categories`
`37`	`39`	`{`
`38`	`40`	`public class Housing`