diff --git a/.editorconfig b/.editorconfig index f0328fd7..c645b573 100644 --- a/.editorconfig +++ b/.editorconfig @@ -3576,18 +3576,6 @@ resharper_xaml_xaml_xamarin_forms_data_type_and_binding_context_type_mismatched_ resharper_xaml_x_key_attribute_disallowed_highlighting=error resharper_xml_doc_comment_syntax_problem_highlighting=warning resharper_xunit_xunit_test_with_console_output_highlighting=warning -csharp_style_prefer_implicitly_typed_lambda_expression = true:suggestion -csharp_style_expression_bodied_methods = true:silent -csharp_style_prefer_tuple_swap = true:suggestion -csharp_style_prefer_unbound_generic_type_in_nameof = true:suggestion -csharp_style_prefer_utf8_string_literals = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_expression_bodied_constructors = true:silent -csharp_style_expression_bodied_operators = true:silent -csharp_style_deconstructed_variable_declaration = true:suggestion -csharp_style_unused_value_assignment_preference = discard_variable:suggestion -csharp_style_unused_value_expression_statement_preference = discard_variable:silent -csharp_style_expression_bodied_properties = true:silent [*.{cshtml,htm,html,proto,razor}] indent_style=tab diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1a61439e..b40b2538 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,15 +10,13 @@ jobs: build: runs-on: windows-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v2 with: submodules: recursive - name: Setup .NET - uses: actions/setup-dotnet@v5 + uses: actions/setup-dotnet@v1 with: - dotnet-version: | - 10.x.x - 9.x.x + dotnet-version: '8.x.x' - name: Restore dependencies run: dotnet restore - name: Download Dalamud @@ -31,7 +29,7 @@ jobs: - name: Archive run: Compress-Archive -Path Penumbra/bin/Release/* -DestinationPath Penumbra.zip - name: Upload a Build Artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v2.2.1 with: path: | ./Penumbra/bin/Release/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c72b4800..7c9e2909 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,20 +9,18 @@ jobs: build: runs-on: windows-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v2 with: submodules: recursive - name: Setup .NET - uses: actions/setup-dotnet@v5 + uses: actions/setup-dotnet@v1 with: - dotnet-version: | - 10.x.x - 9.x.x + dotnet-version: '8.x.x' - name: Restore dependencies run: dotnet restore - name: Download Dalamud run: | - Invoke-WebRequest -Uri https://goatcorp.github.io/dalamud-distrib/stg/latest.zip -OutFile latest.zip + Invoke-WebRequest -Uri https://goatcorp.github.io/dalamud-distrib/latest.zip -OutFile latest.zip Expand-Archive -Force latest.zip "$env:AppData\XIVLauncher\addon\Hooks\dev" - name: Build run: | @@ -39,7 +37,7 @@ jobs: - name: Archive run: Compress-Archive -Path Penumbra/bin/Release/* -DestinationPath Penumbra.zip - name: Upload a Build Artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v2.2.1 with: path: | ./Penumbra/bin/Release/* diff --git a/.github/workflows/test_release.yml b/.github/workflows/test_release.yml index c6b4e459..91361646 100644 --- a/.github/workflows/test_release.yml +++ b/.github/workflows/test_release.yml @@ -9,20 +9,18 @@ jobs: build: runs-on: windows-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v2 with: submodules: recursive - name: Setup .NET - uses: actions/setup-dotnet@v5 + uses: actions/setup-dotnet@v1 with: - dotnet-version: | - 10.x.x - 9.x.x + dotnet-version: '8.x.x' - name: Restore dependencies run: dotnet restore - name: Download Dalamud run: | - Invoke-WebRequest -Uri https://goatcorp.github.io/dalamud-distrib/stg/latest.zip -OutFile latest.zip + Invoke-WebRequest -Uri https://goatcorp.github.io/dalamud-distrib/latest.zip -OutFile latest.zip Expand-Archive -Force latest.zip "$env:AppData\XIVLauncher\addon\Hooks\dev" - name: Build run: | @@ -39,7 +37,7 @@ jobs: - name: Archive run: Compress-Archive -Path Penumbra/bin/Debug/* -DestinationPath Penumbra.zip - name: Upload a Build Artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v2.2.1 with: path: | ./Penumbra/bin/Debug/* diff --git a/OtterGui b/OtterGui index ff1e6543..1d936516 160000 --- a/OtterGui +++ b/OtterGui @@ -1 +1 @@ -Subproject commit ff1e6543845e3b8c53a5f8b240bc38faffb1b3bf +Subproject commit 1d9365164655a7cb38172e1311e15e19b1def6db diff --git a/Penumbra.Api b/Penumbra.Api index 52a3216a..69d106b4 160000 --- a/Penumbra.Api +++ b/Penumbra.Api @@ -1 +1 @@ -Subproject commit 52a3216a525592205198303df2844435e382cf87 +Subproject commit 69d106b457eb0f73d4b4caf1234da5631fd6fbf0 diff --git a/Penumbra.CrashHandler/Buffers/AnimationInvocationBuffer.cs b/Penumbra.CrashHandler/Buffers/AnimationInvocationBuffer.cs index 292be2ff..3446530a 100644 --- a/Penumbra.CrashHandler/Buffers/AnimationInvocationBuffer.cs +++ b/Penumbra.CrashHandler/Buffers/AnimationInvocationBuffer.cs @@ -1,6 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Text.Json.Nodes; +using System.Text.Json.Nodes; namespace Penumbra.CrashHandler.Buffers; @@ -57,10 +55,8 @@ internal sealed class AnimationInvocationBuffer : MemoryMappedBuffer, IAnimation accessor.Write(16, characterAddress); var span = GetSpan(accessor, 24, 16); collectionId.TryWriteBytes(span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); span = GetSpan(accessor, 40); WriteSpan(characterName, span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); } } diff --git a/Penumbra.CrashHandler/Buffers/CharacterBaseBuffer.cs b/Penumbra.CrashHandler/Buffers/CharacterBaseBuffer.cs index 89fea29d..4036455d 100644 --- a/Penumbra.CrashHandler/Buffers/CharacterBaseBuffer.cs +++ b/Penumbra.CrashHandler/Buffers/CharacterBaseBuffer.cs @@ -1,6 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Text.Json.Nodes; +using System.Text.Json.Nodes; namespace Penumbra.CrashHandler.Buffers; @@ -40,10 +38,8 @@ internal sealed class CharacterBaseBuffer : MemoryMappedBuffer, ICharacterBaseBu accessor.Write(12, characterAddress); var span = GetSpan(accessor, 20, 16); collectionId.TryWriteBytes(span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); span = GetSpan(accessor, 36); WriteSpan(characterName, span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); } } diff --git a/Penumbra.CrashHandler/Buffers/MemoryMappedBuffer.cs b/Penumbra.CrashHandler/Buffers/MemoryMappedBuffer.cs index e2ffcebe..a1b3de52 100644 --- a/Penumbra.CrashHandler/Buffers/MemoryMappedBuffer.cs +++ b/Penumbra.CrashHandler/Buffers/MemoryMappedBuffer.cs @@ -1,8 +1,5 @@ -using System; using System.Diagnostics.CodeAnalysis; -using System.IO; using System.IO.MemoryMappedFiles; -using System.Linq; using System.Numerics; using System.Text; diff --git a/Penumbra.CrashHandler/Buffers/ModdedFileBuffer.cs b/Penumbra.CrashHandler/Buffers/ModdedFileBuffer.cs index e4ee66d0..03f63ba4 100644 --- a/Penumbra.CrashHandler/Buffers/ModdedFileBuffer.cs +++ b/Penumbra.CrashHandler/Buffers/ModdedFileBuffer.cs @@ -1,6 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Text.Json.Nodes; +using System.Text.Json.Nodes; namespace Penumbra.CrashHandler.Buffers; @@ -46,16 +44,12 @@ internal sealed class ModdedFileBuffer : MemoryMappedBuffer, IModdedFileBufferWr accessor.Write(12, characterAddress); var span = GetSpan(accessor, 20, 16); collectionId.TryWriteBytes(span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); span = GetSpan(accessor, 36, 80); WriteSpan(characterName, span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); span = GetSpan(accessor, 116, 260); WriteSpan(requestedFileName, span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); span = GetSpan(accessor, 376); WriteSpan(actualFileName, span); - accessor.SafeMemoryMappedViewHandle.ReleasePointer(); } } diff --git a/Penumbra.CrashHandler/CrashData.cs b/Penumbra.CrashHandler/CrashData.cs index 55460548..cdac103f 100644 --- a/Penumbra.CrashHandler/CrashData.cs +++ b/Penumbra.CrashHandler/CrashData.cs @@ -1,5 +1,3 @@ -using System; -using System.Collections.Generic; using Penumbra.CrashHandler.Buffers; namespace Penumbra.CrashHandler; @@ -57,7 +55,7 @@ public class CrashData /// The last vfx function invoked before this crash data was generated. public VfxFuncInvokedEntry? LastVfxFuncInvoked - => LastVFXFuncsInvoked.Count == 0 ? default : LastVFXFuncsInvoked[0]; + => LastVfxFuncsInvoked.Count == 0 ? default : LastVfxFuncsInvoked[0]; /// A collection of the last few characters loaded before this crash data was generated. public List LastCharactersLoaded { get; set; } = []; @@ -66,5 +64,5 @@ public class CrashData public List LastModdedFilesLoaded { get; set; } = []; /// A collection of the last few vfx functions invoked before this crash data was generated. - public List LastVFXFuncsInvoked { get; set; } = []; + public List LastVfxFuncsInvoked { get; set; } = []; } diff --git a/Penumbra.CrashHandler/GameEventLogReader.cs b/Penumbra.CrashHandler/GameEventLogReader.cs index 8a7f53f8..1813a671 100644 --- a/Penumbra.CrashHandler/GameEventLogReader.cs +++ b/Penumbra.CrashHandler/GameEventLogReader.cs @@ -1,7 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text.Json.Nodes; +using System.Text.Json.Nodes; using Penumbra.CrashHandler.Buffers; namespace Penumbra.CrashHandler; diff --git a/Penumbra.CrashHandler/GameEventLogWriter.cs b/Penumbra.CrashHandler/GameEventLogWriter.cs index 915c59a2..e2c461f4 100644 --- a/Penumbra.CrashHandler/GameEventLogWriter.cs +++ b/Penumbra.CrashHandler/GameEventLogWriter.cs @@ -1,5 +1,4 @@ -using System; -using Penumbra.CrashHandler.Buffers; +using Penumbra.CrashHandler.Buffers; namespace Penumbra.CrashHandler; diff --git a/Penumbra.CrashHandler/Penumbra.CrashHandler.csproj b/Penumbra.CrashHandler/Penumbra.CrashHandler.csproj index e07bb745..c9f97fde 100644 --- a/Penumbra.CrashHandler/Penumbra.CrashHandler.csproj +++ b/Penumbra.CrashHandler/Penumbra.CrashHandler.csproj @@ -1,6 +1,20 @@ - + + Exe + net8.0-windows + preview + enable + x64 + enable + true + false + + + + $(appdata)\XIVLauncher\addon\Hooks\dev\ + $(HOME)/.xlcore/dalamud/Hooks/dev/ + $(DALAMUD_HOME)/ @@ -11,8 +25,4 @@ embedded - - false - - diff --git a/Penumbra.CrashHandler/Program.cs b/Penumbra.CrashHandler/Program.cs index 38c176a6..3bc461f7 100644 --- a/Penumbra.CrashHandler/Program.cs +++ b/Penumbra.CrashHandler/Program.cs @@ -1,6 +1,4 @@ -using System; -using System.Diagnostics; -using System.IO; +using System.Diagnostics; using System.Text.Json; namespace Penumbra.CrashHandler; diff --git a/Penumbra.CrashHandler/packages.lock.json b/Penumbra.CrashHandler/packages.lock.json deleted file mode 100644 index 0a160ea5..00000000 --- a/Penumbra.CrashHandler/packages.lock.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "version": 1, - "dependencies": { - "net10.0-windows7.0": { - "DotNet.ReproducibleBuilds": { - "type": "Direct", - "requested": "[1.2.39, )", - "resolved": "1.2.39", - "contentHash": "fcFN01tDTIQqDuTwr1jUQK/geofiwjG5DycJQOnC72i1SsLAk1ELe+apBOuZ11UMQG8YKFZG1FgvjZPbqHyatg==" - } - } - } -} \ No newline at end of file diff --git a/Penumbra.GameData b/Penumbra.GameData index 0e973ed6..f2cea65b 160000 --- a/Penumbra.GameData +++ b/Penumbra.GameData @@ -1 +1 @@ -Subproject commit 0e973ed6eace6afd31cd298f8c58f76fa8d5ef60 +Subproject commit f2cea65b83b2d6cb0d03339e8f76aed8102a41d5 diff --git a/Penumbra.String b/Penumbra.String index 9bd016fb..caa58c5c 160000 --- a/Penumbra.String +++ b/Penumbra.String @@ -1 +1 @@ -Subproject commit 9bd016fbef5fb2de467dd42165267fdd93cd9592 +Subproject commit caa58c5c92710e69ce07b9d736ebe2d228cb4488 diff --git a/Penumbra.sln b/Penumbra.sln index fbcd6080..78fa1543 100644 --- a/Penumbra.sln +++ b/Penumbra.sln @@ -8,11 +8,6 @@ EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{F89C9EAE-25C8-43BE-8108-5921E5A93502}" ProjectSection(SolutionItems) = preProject .editorconfig = .editorconfig - .github\workflows\build.yml = .github\workflows\build.yml - Penumbra\Penumbra.json = Penumbra\Penumbra.json - .github\workflows\release.yml = .github\workflows\release.yml - repo.json = repo.json - .github\workflows\test_release.yml = .github\workflows\test_release.yml EndProjectSection EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Penumbra.GameData", "Penumbra.GameData\Penumbra.GameData.csproj", "{EE551E87-FDB3-4612-B500-DC870C07C605}" @@ -23,76 +18,42 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Penumbra.Api", "Penumbra.Ap EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Penumbra.String", "Penumbra.String\Penumbra.String.csproj", "{5549BAFD-6357-4B1A-800C-75AC36E5B76D}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Penumbra.CrashHandler", "Penumbra.CrashHandler\Penumbra.CrashHandler.csproj", "{EE834491-A98F-4395-BE0D-6861AE5AD953}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Schemas", "Schemas", "{BFEA7504-1210-4F79-A7FE-BF03B6567E33}" - ProjectSection(SolutionItems) = preProject - schemas\default_mod.json = schemas\default_mod.json - schemas\group.json = schemas\group.json - schemas\local_mod_data-v3.json = schemas\local_mod_data-v3.json - schemas\mod_meta-v3.json = schemas\mod_meta-v3.json - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "structs", "structs", "{B03F276A-0572-4F62-AF86-EF62F6B80463}" - ProjectSection(SolutionItems) = preProject - schemas\structs\container.json = schemas\structs\container.json - schemas\structs\group_combining.json = schemas\structs\group_combining.json - schemas\structs\group_imc.json = schemas\structs\group_imc.json - schemas\structs\group_multi.json = schemas\structs\group_multi.json - schemas\structs\group_single.json = schemas\structs\group_single.json - schemas\structs\manipulation.json = schemas\structs\manipulation.json - schemas\structs\meta_atch.json = schemas\structs\meta_atch.json - schemas\structs\meta_atr.json = schemas\structs\meta_atr.json - schemas\structs\meta_enums.json = schemas\structs\meta_enums.json - schemas\structs\meta_eqdp.json = schemas\structs\meta_eqdp.json - schemas\structs\meta_eqp.json = schemas\structs\meta_eqp.json - schemas\structs\meta_est.json = schemas\structs\meta_est.json - schemas\structs\meta_geqp.json = schemas\structs\meta_geqp.json - schemas\structs\meta_gmp.json = schemas\structs\meta_gmp.json - schemas\structs\meta_imc.json = schemas\structs\meta_imc.json - schemas\structs\meta_rsp.json = schemas\structs\meta_rsp.json - schemas\structs\meta_shp.json = schemas\structs\meta_shp.json - schemas\structs\option.json = schemas\structs\option.json - EndProjectSection +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Penumbra.CrashHandler", "Penumbra.CrashHandler\Penumbra.CrashHandler.csproj", "{EE834491-A98F-4395-BE0D-6861AE5AD953}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|x64 = Debug|x64 - Release|x64 = Release|x64 + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.ActiveCfg = Debug|x64 - {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.Build.0 = Debug|x64 - {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.ActiveCfg = Release|x64 - {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.Build.0 = Release|x64 - {EE551E87-FDB3-4612-B500-DC870C07C605}.Debug|x64.ActiveCfg = Debug|x64 - {EE551E87-FDB3-4612-B500-DC870C07C605}.Debug|x64.Build.0 = Debug|x64 - {EE551E87-FDB3-4612-B500-DC870C07C605}.Release|x64.ActiveCfg = Release|x64 - {EE551E87-FDB3-4612-B500-DC870C07C605}.Release|x64.Build.0 = Release|x64 - {87750518-1A20-40B4-9FC1-22F906EFB290}.Debug|x64.ActiveCfg = Debug|x64 - {87750518-1A20-40B4-9FC1-22F906EFB290}.Debug|x64.Build.0 = Debug|x64 - {87750518-1A20-40B4-9FC1-22F906EFB290}.Release|x64.ActiveCfg = Release|x64 - {87750518-1A20-40B4-9FC1-22F906EFB290}.Release|x64.Build.0 = Release|x64 - {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Debug|x64.ActiveCfg = Debug|x64 - {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Debug|x64.Build.0 = Debug|x64 - {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Release|x64.ActiveCfg = Release|x64 - {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Release|x64.Build.0 = Release|x64 - {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Debug|x64.ActiveCfg = Debug|x64 - {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Debug|x64.Build.0 = Debug|x64 - {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Release|x64.ActiveCfg = Release|x64 - {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Release|x64.Build.0 = Release|x64 - {EE834491-A98F-4395-BE0D-6861AE5AD953}.Debug|x64.ActiveCfg = Debug|x64 - {EE834491-A98F-4395-BE0D-6861AE5AD953}.Debug|x64.Build.0 = Debug|x64 - {EE834491-A98F-4395-BE0D-6861AE5AD953}.Release|x64.ActiveCfg = Release|x64 - {EE834491-A98F-4395-BE0D-6861AE5AD953}.Release|x64.Build.0 = Release|x64 + {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|Any CPU.Build.0 = Release|Any CPU + {EE551E87-FDB3-4612-B500-DC870C07C605}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EE551E87-FDB3-4612-B500-DC870C07C605}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EE551E87-FDB3-4612-B500-DC870C07C605}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EE551E87-FDB3-4612-B500-DC870C07C605}.Release|Any CPU.Build.0 = Release|Any CPU + {87750518-1A20-40B4-9FC1-22F906EFB290}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {87750518-1A20-40B4-9FC1-22F906EFB290}.Debug|Any CPU.Build.0 = Debug|Any CPU + {87750518-1A20-40B4-9FC1-22F906EFB290}.Release|Any CPU.ActiveCfg = Release|Any CPU + {87750518-1A20-40B4-9FC1-22F906EFB290}.Release|Any CPU.Build.0 = Release|Any CPU + {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1FE4D8DF-B56A-464F-B39E-CDC0ED4167D4}.Release|Any CPU.Build.0 = Release|Any CPU + {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {5549BAFD-6357-4B1A-800C-75AC36E5B76D}.Release|Any CPU.Build.0 = Release|Any CPU + {EE834491-A98F-4395-BE0D-6861AE5AD953}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EE834491-A98F-4395-BE0D-6861AE5AD953}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EE834491-A98F-4395-BE0D-6861AE5AD953}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EE834491-A98F-4395-BE0D-6861AE5AD953}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {BFEA7504-1210-4F79-A7FE-BF03B6567E33} = {F89C9EAE-25C8-43BE-8108-5921E5A93502} - {B03F276A-0572-4F62-AF86-EF62F6B80463} = {BFEA7504-1210-4F79-A7FE-BF03B6567E33} - EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {B17E85B1-5F60-4440-9F9A-3DDE877E8CDF} EndGlobalSection diff --git a/Penumbra/Api/Api/CollectionApi.cs b/Penumbra/Api/Api/CollectionApi.cs index c40feb12..ff393aaf 100644 --- a/Penumbra/Api/Api/CollectionApi.cs +++ b/Penumbra/Api/Api/CollectionApi.cs @@ -2,14 +2,13 @@ using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Manager; -using Penumbra.Mods; namespace Penumbra.Api.Api; public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : IPenumbraApiCollection, IApiService { public Dictionary GetCollections() - => collections.Storage.ToDictionary(c => c.Identity.Id, c => c.Identity.Name); + => collections.Storage.ToDictionary(c => c.Id, c => c.Name); public List<(Guid Id, string Name)> GetCollectionsByIdentifier(string identifier) { @@ -18,33 +17,17 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : var list = new List<(Guid Id, string Name)>(4); if (Guid.TryParse(identifier, out var guid) && collections.Storage.ById(guid, out var collection) && collection != ModCollection.Empty) - list.Add((collection.Identity.Id, collection.Identity.Name)); + list.Add((collection.Id, collection.Name)); else if (identifier.Length >= 8) - list.AddRange(collections.Storage.Where(c => c.Identity.Identifier.StartsWith(identifier, StringComparison.OrdinalIgnoreCase)) - .Select(c => (c.Identity.Id, c.Identity.Name))); + list.AddRange(collections.Storage.Where(c => c.Identifier.StartsWith(identifier, StringComparison.OrdinalIgnoreCase)) + .Select(c => (c.Id, c.Name))); list.AddRange(collections.Storage - .Where(c => string.Equals(c.Identity.Name, identifier, StringComparison.OrdinalIgnoreCase) - && !list.Contains((c.Identity.Id, c.Identity.Name))) - .Select(c => (c.Identity.Id, c.Identity.Name))); + .Where(c => string.Equals(c.Name, identifier, StringComparison.OrdinalIgnoreCase) && !list.Contains((c.Id, c.Name))) + .Select(c => (c.Id, c.Name))); return list; } - public Func CheckCurrentChangedItemFunc() - { - var weakRef = new WeakReference(collections); - return s => - { - if (!weakRef.TryGetTarget(out var c)) - throw new ObjectDisposedException("The underlying collection storage of this IPC container was disposed."); - - if (!c.Active.Current.ChangedItems.TryGetValue(s, out var d)) - return []; - - return d.Item1.Select(m => (m is Mod mod ? mod.Identifier : string.Empty, m.Name.Text)).ToArray(); - }; - } - public Dictionary GetChangedItemsForCollection(Guid collectionId) { try @@ -53,7 +36,7 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : collection = ModCollection.Empty; if (collection.HasCache) - return collection.ChangedItems.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Item2?.ToInternalObject()); + return collection.ChangedItems.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Item2); Penumbra.Log.Warning($"Collection {collectionId} does not exist or is not loaded."); return []; @@ -71,7 +54,7 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : return null; var collection = collections.Active.ByType((CollectionType)type); - return collection == null ? null : (collection.Identity.Id, collection.Identity.Name); + return collection == null ? null : (collection.Id, collection.Name); } internal (Guid Id, string Name)? GetCollection(byte type) @@ -81,18 +64,17 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : { var id = helpers.AssociatedIdentifier(gameObjectIdx); if (!id.IsValid) - return (false, false, (collections.Active.Default.Identity.Id, collections.Active.Default.Identity.Name)); + return (false, false, (collections.Active.Default.Id, collections.Active.Default.Name)); if (collections.Active.Individuals.TryGetValue(id, out var collection)) - return (true, true, (collection.Identity.Id, collection.Identity.Name)); + return (true, true, (collection.Id, collection.Name)); helpers.AssociatedCollection(gameObjectIdx, out collection); - return (true, false, (collection.Identity.Id, collection.Identity.Name)); + return (true, false, (collection.Id, collection.Name)); } public Guid[] GetCollectionByName(string name) - => collections.Storage.Where(c => string.Equals(name, c.Identity.Name, StringComparison.OrdinalIgnoreCase)).Select(c => c.Identity.Id) - .ToArray(); + => collections.Storage.Where(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase)).Select(c => c.Id).ToArray(); public (PenumbraApiEc, (Guid Id, string Name)? OldCollection) SetCollection(ApiCollectionType type, Guid? collectionId, bool allowCreateNew, bool allowDelete) @@ -101,7 +83,7 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : return (PenumbraApiEc.InvalidArgument, null); var oldCollection = collections.Active.ByType((CollectionType)type); - var old = oldCollection != null ? (oldCollection.Identity.Id, oldCollection.Identity.Name) : new ValueTuple?(); + var old = oldCollection != null ? (oldCollection.Id, oldCollection.Name) : new ValueTuple?(); if (collectionId == null) { if (old == null) @@ -124,7 +106,7 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : collections.Active.CreateSpecialCollection((CollectionType)type); } - else if (old.Value.Item1 == collection.Identity.Id) + else if (old.Value.Item1 == collection.Id) { return (PenumbraApiEc.NothingChanged, old); } @@ -138,10 +120,10 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : { var id = helpers.AssociatedIdentifier(gameObjectIdx); if (!id.IsValid) - return (PenumbraApiEc.InvalidIdentifier, (collections.Active.Default.Identity.Id, collections.Active.Default.Identity.Name)); + return (PenumbraApiEc.InvalidIdentifier, (collections.Active.Default.Id, collections.Active.Default.Name)); var oldCollection = collections.Active.Individuals.TryGetValue(id, out var c) ? c : null; - var old = oldCollection != null ? (oldCollection.Identity.Id, oldCollection.Identity.Name) : new ValueTuple?(); + var old = oldCollection != null ? (oldCollection.Id, oldCollection.Name) : new ValueTuple?(); if (collectionId == null) { if (old == null) @@ -166,7 +148,7 @@ public class CollectionApi(CollectionManager collections, ApiHelpers helpers) : var ids = collections.Active.Individuals.GetGroup(id); collections.Active.CreateIndividualCollection(ids); } - else if (old.Value.Item1 == collection.Identity.Id) + else if (old.Value.Item1 == collection.Id) { return (PenumbraApiEc.NothingChanged, old); } diff --git a/Penumbra/Api/Api/EditingApi.cs b/Penumbra/Api/Api/EditingApi.cs index 5a1fc347..93345053 100644 --- a/Penumbra/Api/Api/EditingApi.cs +++ b/Penumbra/Api/Api/EditingApi.cs @@ -10,7 +10,6 @@ public class EditingApi(TextureManager textureManager) : IPenumbraApiEditing, IA => textureType switch { TextureType.Png => textureManager.SavePng(inputFile, outputFile), - TextureType.Targa => textureManager.SaveTga(inputFile, outputFile), TextureType.AsIsTex => textureManager.SaveAs(CombinedTexture.TextureSaveType.AsIs, mipMaps, true, inputFile, outputFile), TextureType.AsIsDds => textureManager.SaveAs(CombinedTexture.TextureSaveType.AsIs, mipMaps, false, inputFile, outputFile), TextureType.RgbaTex => textureManager.SaveAs(CombinedTexture.TextureSaveType.Bitmap, mipMaps, true, inputFile, outputFile), @@ -19,12 +18,6 @@ public class EditingApi(TextureManager textureManager) : IPenumbraApiEditing, IA TextureType.Bc3Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC3, mipMaps, false, inputFile, outputFile), TextureType.Bc7Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC7, mipMaps, true, inputFile, outputFile), TextureType.Bc7Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC7, mipMaps, false, inputFile, outputFile), - TextureType.Bc1Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC1, mipMaps, true, inputFile, outputFile), - TextureType.Bc1Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC1, mipMaps, false, inputFile, outputFile), - TextureType.Bc4Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC4, mipMaps, true, inputFile, outputFile), - TextureType.Bc4Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC4, mipMaps, false, inputFile, outputFile), - TextureType.Bc5Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC5, mipMaps, true, inputFile, outputFile), - TextureType.Bc5Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC5, mipMaps, false, inputFile, outputFile), _ => Task.FromException(new Exception($"Invalid input value {textureType}.")), }; @@ -33,7 +26,6 @@ public class EditingApi(TextureManager textureManager) : IPenumbraApiEditing, IA => textureType switch { TextureType.Png => textureManager.SavePng(new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Targa => textureManager.SaveTga(new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), TextureType.AsIsTex => textureManager.SaveAs(CombinedTexture.TextureSaveType.AsIs, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), TextureType.AsIsDds => textureManager.SaveAs(CombinedTexture.TextureSaveType.AsIs, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), TextureType.RgbaTex => textureManager.SaveAs(CombinedTexture.TextureSaveType.Bitmap, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), @@ -42,12 +34,6 @@ public class EditingApi(TextureManager textureManager) : IPenumbraApiEditing, IA TextureType.Bc3Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC3, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), TextureType.Bc7Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC7, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), TextureType.Bc7Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC7, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc1Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC1, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc1Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC1, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc4Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC4, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc4Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC4, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc5Tex => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC5, mipMaps, true, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), - TextureType.Bc5Dds => textureManager.SaveAs(CombinedTexture.TextureSaveType.BC5, mipMaps, false, new BaseImage(), outputFile, rgbaData, width, rgbaData.Length / 4 / width), _ => Task.FromException(new Exception($"Invalid input value {textureType}.")), }; // @formatter:on diff --git a/Penumbra/Api/Api/GameStateApi.cs b/Penumbra/Api/Api/GameStateApi.cs index 74cde3a0..becb55ee 100644 --- a/Penumbra/Api/Api/GameStateApi.cs +++ b/Penumbra/Api/Api/GameStateApi.cs @@ -2,8 +2,8 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Collections; -using Penumbra.Interop.Hooks.ResourceLoading; using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Structs; using Penumbra.Services; using Penumbra.String.Classes; @@ -14,27 +14,23 @@ public class GameStateApi : IPenumbraApiGameState, IApiService, IDisposable { private readonly CommunicatorService _communicator; private readonly CollectionResolver _collectionResolver; - private readonly DrawObjectState _drawObjectState; private readonly CutsceneService _cutsceneService; private readonly ResourceLoader _resourceLoader; public unsafe GameStateApi(CommunicatorService communicator, CollectionResolver collectionResolver, CutsceneService cutsceneService, - ResourceLoader resourceLoader, DrawObjectState drawObjectState) + ResourceLoader resourceLoader) { _communicator = communicator; _collectionResolver = collectionResolver; _cutsceneService = cutsceneService; _resourceLoader = resourceLoader; - _drawObjectState = drawObjectState; _resourceLoader.ResourceLoaded += OnResourceLoaded; - _resourceLoader.PapRequested += OnPapRequested; _communicator.CreatedCharacterBase.Subscribe(OnCreatedCharacterBase, Communication.CreatedCharacterBase.Priority.Api); } public unsafe void Dispose() { _resourceLoader.ResourceLoaded -= OnResourceLoaded; - _resourceLoader.PapRequested -= OnPapRequested; _communicator.CreatedCharacterBase.Unsubscribe(OnCreatedCharacterBase); } @@ -63,61 +59,24 @@ public class GameStateApi : IPenumbraApiGameState, IApiService, IDisposable public unsafe (nint GameObject, (Guid Id, string Name) Collection) GetDrawObjectInfo(nint drawObject) { var data = _collectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - return (data.AssociatedGameObject, (Id: data.ModCollection.Identity.Id, Name: data.ModCollection.Identity.Name)); + return (data.AssociatedGameObject, (data.ModCollection.Id, data.ModCollection.Name)); } public int GetCutsceneParentIndex(int actorIdx) => _cutsceneService.GetParentIndex(actorIdx); - public Func GetCutsceneParentIndexFunc() - { - var weakRef = new WeakReference(_cutsceneService); - return idx => - { - if (!weakRef.TryGetTarget(out var c)) - throw new ObjectDisposedException("The underlying cutscene state storage of this IPC container was disposed."); - - return c.GetParentIndex(idx); - }; - } - - public Func GetGameObjectFromDrawObjectFunc() - { - var weakRef = new WeakReference(_drawObjectState); - return model => - { - if (!weakRef.TryGetTarget(out var c)) - throw new ObjectDisposedException("The underlying draw object state storage of this IPC container was disposed."); - - return c.TryGetValue(model, out var data) ? data.Item1.Address : nint.Zero; - }; - } - public PenumbraApiEc SetCutsceneParentIndex(int copyIdx, int newParentIdx) => _cutsceneService.SetParentIndex(copyIdx, newParentIdx) - ? PenumbraApiEc.Success + ? PenumbraApiEc.Success : PenumbraApiEc.InvalidArgument; private unsafe void OnResourceLoaded(ResourceHandle* handle, Utf8GamePath originalPath, FullPath? manipulatedPath, ResolveData resolveData) { - if (resolveData.AssociatedGameObject != nint.Zero && GameObjectResourceResolved != null) - { - var original = originalPath.ToString(); - GameObjectResourceResolved.Invoke(resolveData.AssociatedGameObject, original, - manipulatedPath?.ToString() ?? original); - } - } - - private void OnPapRequested(Utf8GamePath originalPath, FullPath? manipulatedPath, ResolveData resolveData) - { - if (resolveData.AssociatedGameObject != nint.Zero && GameObjectResourceResolved != null) - { - var original = originalPath.ToString(); - GameObjectResourceResolved.Invoke(resolveData.AssociatedGameObject, original, - manipulatedPath?.ToString() ?? original); - } + if (resolveData.AssociatedGameObject != nint.Zero) + GameObjectResourceResolved?.Invoke(resolveData.AssociatedGameObject, originalPath.ToString(), + manipulatedPath?.ToString() ?? originalPath.ToString()); } private void OnCreatedCharacterBase(nint gameObject, ModCollection collection, nint drawObject) - => CreatedCharacterBase?.Invoke(gameObject, collection.Identity.Id, drawObject); + => CreatedCharacterBase?.Invoke(gameObject, collection.Id, drawObject); } diff --git a/Penumbra/Api/Api/IdentityChecker.cs b/Penumbra/Api/Api/IdentityChecker.cs deleted file mode 100644 index e090053e..00000000 --- a/Penumbra/Api/Api/IdentityChecker.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace Penumbra.Api.Api; - -public static class IdentityChecker -{ - public static bool Check(string identity) - => true; -} diff --git a/Penumbra/Api/Api/MetaApi.cs b/Penumbra/Api/Api/MetaApi.cs index 5cffc811..c467df58 100644 --- a/Penumbra/Api/Api/MetaApi.cs +++ b/Penumbra/Api/Api/MetaApi.cs @@ -1,544 +1,23 @@ -using Dalamud.Plugin.Services; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; using OtterGui; using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Files.AtchStructs; -using Penumbra.GameData.Files.Utility; -using Penumbra.GameData.Structs; using Penumbra.Interop.PathResolving; using Penumbra.Meta.Manipulations; namespace Penumbra.Api.Api; -public class MetaApi(IFramework framework, CollectionResolver collectionResolver, ApiHelpers helpers) - : IPenumbraApiMeta, IApiService +public class MetaApi(CollectionResolver collectionResolver, ApiHelpers helpers) : IPenumbraApiMeta, IApiService { public string GetPlayerMetaManipulations() { var collection = collectionResolver.PlayerCollection(); - return CompressMetaManipulations(collection); + var set = collection.MetaCache?.Manipulations.ToArray() ?? []; + return Functions.ToCompressedBase64(set, MetaManipulation.CurrentVersion); } public string GetMetaManipulations(int gameObjectIdx) { helpers.AssociatedCollection(gameObjectIdx, out var collection); - return CompressMetaManipulations(collection); - } - - public Task GetPlayerMetaManipulationsAsync() - { - return Task.Run(async () => - { - var playerCollection = await framework.RunOnFrameworkThread(collectionResolver.PlayerCollection).ConfigureAwait(false); - return CompressMetaManipulations(playerCollection); - }); - } - - public Task GetMetaManipulationsAsync(int gameObjectIdx) - { - return Task.Run(async () => - { - var playerCollection = await framework.RunOnFrameworkThread(() => - { - helpers.AssociatedCollection(gameObjectIdx, out var collection); - return collection; - }).ConfigureAwait(false); - return CompressMetaManipulations(playerCollection); - }); - } - - internal static string CompressMetaManipulations(ModCollection collection) - => CompressMetaManipulationsV1(collection); - - private static string CompressMetaManipulationsV0(ModCollection collection) - { - var array = new JArray(); - if (collection.MetaCache is { } cache) - { - MetaDictionary.SerializeTo(array, cache.GlobalEqp.Select(kvp => kvp.Key)); - MetaDictionary.SerializeTo(array, cache.Imc.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Eqp.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Eqdp.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Est.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Rsp.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Gmp.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Atch.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Shp.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - MetaDictionary.SerializeTo(array, cache.Atr.Select(kvp => new KeyValuePair(kvp.Key, kvp.Value.Entry))); - } - - return Functions.ToCompressedBase64(array, 0); - } - - private static unsafe string CompressMetaManipulationsV1(ModCollection? collection) - { - using var ms = new MemoryStream(); - ms.Capacity = 1024; - using (var zipStream = new GZipStream(ms, CompressionMode.Compress, true)) - { - zipStream.Write((byte)1); - zipStream.Write("META0001"u8); - if (collection?.MetaCache is not { } cache) - { - zipStream.Write(0); - zipStream.Write(0); - zipStream.Write(0); - zipStream.Write(0); - zipStream.Write(0); - zipStream.Write(0); - zipStream.Write(0); - } - else - { - WriteCache(zipStream, cache.Imc); - WriteCache(zipStream, cache.Eqp); - WriteCache(zipStream, cache.Eqdp); - WriteCache(zipStream, cache.Est); - WriteCache(zipStream, cache.Rsp); - WriteCache(zipStream, cache.Gmp); - cache.GlobalEqp.EnterReadLock(); - - try - { - zipStream.Write(cache.GlobalEqp.Count); - foreach (var (globalEqp, _) in cache.GlobalEqp) - zipStream.Write(new ReadOnlySpan(&globalEqp, sizeof(GlobalEqpManipulation))); - } - finally - { - cache.GlobalEqp.ExitReadLock(); - } - - WriteCache(zipStream, cache.Atch); - WriteCache(zipStream, cache.Shp); - WriteCache(zipStream, cache.Atr); - } - } - - ms.Flush(); - ms.Position = 0; - var data = ms.GetBuffer().AsSpan(0, (int)ms.Length); - return Convert.ToBase64String(data); - - void WriteCache(Stream stream, MetaCacheBase metaCache) - where TKey : unmanaged, IMetaIdentifier - where TValue : unmanaged - { - metaCache.EnterReadLock(); - try - { - stream.Write(metaCache.Count); - foreach (var (identifier, (_, value)) in metaCache) - { - stream.Write(identifier); - stream.Write(value); - } - } - finally - { - metaCache.ExitReadLock(); - } - } - } - - public const uint ImcKey = ((uint)'I' << 24) | ((uint)'M' << 16) | ((uint)'C' << 8); - public const uint EqpKey = ((uint)'E' << 24) | ((uint)'Q' << 16) | ((uint)'P' << 8); - public const uint EqdpKey = ((uint)'E' << 24) | ((uint)'Q' << 16) | ((uint)'D' << 8) | 'P'; - public const uint EstKey = ((uint)'E' << 24) | ((uint)'S' << 16) | ((uint)'T' << 8); - public const uint RspKey = ((uint)'R' << 24) | ((uint)'S' << 16) | ((uint)'P' << 8); - public const uint GmpKey = ((uint)'G' << 24) | ((uint)'M' << 16) | ((uint)'P' << 8); - public const uint GeqpKey = ((uint)'G' << 24) | ((uint)'E' << 16) | ((uint)'Q' << 8) | 'P'; - public const uint AtchKey = ((uint)'A' << 24) | ((uint)'T' << 16) | ((uint)'C' << 8) | 'H'; - public const uint ShpKey = ((uint)'S' << 24) | ((uint)'H' << 16) | ((uint)'P' << 8); - public const uint AtrKey = ((uint)'A' << 24) | ((uint)'T' << 16) | ((uint)'R' << 8); - - private static unsafe string CompressMetaManipulationsV2(ModCollection? collection) - { - using var ms = new MemoryStream(); - ms.Capacity = 1024; - using (var zipStream = new GZipStream(ms, CompressionMode.Compress, true)) - { - zipStream.Write((byte)2); - zipStream.Write("META0002"u8); - if (collection?.MetaCache is { } cache) - { - WriteCache(zipStream, cache.Imc, ImcKey); - WriteCache(zipStream, cache.Eqp, EqpKey); - WriteCache(zipStream, cache.Eqdp, EqdpKey); - WriteCache(zipStream, cache.Est, EstKey); - WriteCache(zipStream, cache.Rsp, RspKey); - WriteCache(zipStream, cache.Gmp, GmpKey); - cache.GlobalEqp.EnterReadLock(); - - try - { - if (cache.GlobalEqp.Count > 0) - { - zipStream.Write(GeqpKey); - zipStream.Write(cache.GlobalEqp.Count); - foreach (var (globalEqp, _) in cache.GlobalEqp) - zipStream.Write(new ReadOnlySpan(&globalEqp, sizeof(GlobalEqpManipulation))); - } - } - finally - { - cache.GlobalEqp.ExitReadLock(); - } - - WriteCache(zipStream, cache.Atch, AtchKey); - WriteCache(zipStream, cache.Shp, ShpKey); - WriteCache(zipStream, cache.Atr, AtrKey); - } - } - - ms.Flush(); - ms.Position = 0; - var data = ms.GetBuffer().AsSpan(0, (int)ms.Length); - return Convert.ToBase64String(data); - - void WriteCache(Stream stream, MetaCacheBase metaCache, uint label) - where TKey : unmanaged, IMetaIdentifier - where TValue : unmanaged - { - metaCache.EnterReadLock(); - try - { - if (metaCache.Count <= 0) - return; - - stream.Write(label); - stream.Write(metaCache.Count); - foreach (var (identifier, (_, value)) in metaCache) - { - stream.Write(identifier); - stream.Write(value); - } - } - finally - { - metaCache.ExitReadLock(); - } - } - } - - /// - /// Convert manipulations from a transmitted base64 string to actual manipulations. - /// The empty string is treated as an empty set. - /// Only returns true if all conversions are successful and distinct. - /// - internal static bool ConvertManips(string manipString, [NotNullWhen(true)] out MetaDictionary? manips, out byte version) - { - if (manipString.Length == 0) - { - manips = new MetaDictionary(); - version = byte.MaxValue; - return true; - } - - try - { - var bytes = Convert.FromBase64String(manipString); - using var compressedStream = new MemoryStream(bytes); - using var zipStream = new GZipStream(compressedStream, CompressionMode.Decompress); - using var resultStream = new MemoryStream(); - zipStream.CopyTo(resultStream); - resultStream.Flush(); - resultStream.Position = 0; - var data = resultStream.GetBuffer().AsSpan(0, (int)resultStream.Length); - version = data[0]; - data = data[1..]; - switch (version) - { - case 0: return ConvertManipsV0(data, out manips); - case 1: return ConvertManipsV1(data, out manips); - case 2: return ConvertManipsV2(data, out manips); - default: - Penumbra.Log.Debug($"Invalid version for manipulations: {version}."); - manips = null; - return false; - } - } - catch (Exception ex) - { - Penumbra.Log.Debug($"Error decompressing manipulations:\n{ex}"); - manips = null; - version = byte.MaxValue; - return false; - } - } - - private static bool ConvertManipsV2(ReadOnlySpan data, [NotNullWhen(true)] out MetaDictionary? manips) - { - if (!data.StartsWith("META0002"u8)) - { - Penumbra.Log.Debug("Invalid manipulations of version 2, does not start with valid prefix."); - manips = null; - return false; - } - - manips = new MetaDictionary(); - var r = new SpanBinaryReader(data[8..]); - while (r.Remaining > 4) - { - var prefix = r.ReadUInt32(); - var count = r.Remaining > 4 ? r.ReadInt32() : 0; - if (count is 0) - continue; - - switch (prefix) - { - case ImcKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case EqpKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case EqdpKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case EstKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case RspKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case GmpKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case GeqpKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier)) - return false; - } - - break; - case AtchKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case ShpKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - case AtrKey: - for (var i = 0; i < count; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - break; - } - } - - return true; - } - - private static bool ConvertManipsV1(ReadOnlySpan data, [NotNullWhen(true)] out MetaDictionary? manips) - { - if (!data.StartsWith("META0001"u8)) - { - Penumbra.Log.Debug($"Invalid manipulations of version 1, does not start with valid prefix."); - manips = null; - return false; - } - - manips = new MetaDictionary(); - var r = new SpanBinaryReader(data[8..]); - var imcCount = r.ReadInt32(); - for (var i = 0; i < imcCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var eqpCount = r.ReadInt32(); - for (var i = 0; i < eqpCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var eqdpCount = r.ReadInt32(); - for (var i = 0; i < eqdpCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var estCount = r.ReadInt32(); - for (var i = 0; i < estCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var rspCount = r.ReadInt32(); - for (var i = 0; i < rspCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var gmpCount = r.ReadInt32(); - for (var i = 0; i < gmpCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var globalEqpCount = r.ReadInt32(); - for (var i = 0; i < globalEqpCount; ++i) - { - var manip = r.Read(); - if (!manip.Validate() || !manips.TryAdd(manip)) - return false; - } - - // Atch was added after there were already some V1 around, so check for size here. - if (r.Position < r.Count) - { - var atchCount = r.ReadInt32(); - for (var i = 0; i < atchCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - // Shp and Atr was added later - if (r.Position < r.Count) - { - var shpCount = r.ReadInt32(); - for (var i = 0; i < shpCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - - var atrCount = r.ReadInt32(); - for (var i = 0; i < atrCount; ++i) - { - var identifier = r.Read(); - var value = r.Read(); - if (!identifier.Validate() || !manips.TryAdd(identifier, value)) - return false; - } - } - } - - return true; - } - - private static bool ConvertManipsV0(ReadOnlySpan data, [NotNullWhen(true)] out MetaDictionary? manips) - { - var json = Encoding.UTF8.GetString(data); - manips = JsonConvert.DeserializeObject(json); - return manips != null; - } - - internal void TestMetaManipulations() - { - var collection = collectionResolver.PlayerCollection(); - var dict = new MetaDictionary(collection.MetaCache); - var count = dict.Count; - - var watch = Stopwatch.StartNew(); - var v0 = CompressMetaManipulationsV0(collection); - var v0Time = watch.ElapsedMilliseconds; - - watch.Restart(); - var v1 = CompressMetaManipulationsV1(collection); - var v1Time = watch.ElapsedMilliseconds; - - watch.Restart(); - var v1Success = ConvertManips(v1, out var v1Roundtrip, out _); - var v1RoundtripTime = watch.ElapsedMilliseconds; - - watch.Restart(); - var v0Success = ConvertManips(v0, out var v0Roundtrip, out _); - var v0RoundtripTime = watch.ElapsedMilliseconds; - - Penumbra.Log.Information($"Version | Count | Time | Length | Success | ReCount | ReTime | Equal"); - Penumbra.Log.Information( - $"0 | {count} | {v0Time} | {v0.Length} | {v0Success} | {v0Roundtrip?.Count} | {v0RoundtripTime} | {v0Roundtrip?.Equals(dict)}"); - Penumbra.Log.Information( - $"1 | {count} | {v1Time} | {v1.Length} | {v1Success} | {v1Roundtrip?.Count} | {v1RoundtripTime} | {v0Roundtrip?.Equals(dict)}"); + var set = collection.MetaCache?.Manipulations.ToArray() ?? []; + return Functions.ToCompressedBase64(set, MetaManipulation.CurrentVersion); } } diff --git a/Penumbra/Api/Api/ModSettingsApi.cs b/Penumbra/Api/Api/ModSettingsApi.cs index d49c2904..56b80e63 100644 --- a/Penumbra/Api/Api/ModSettingsApi.cs +++ b/Penumbra/Api/Api/ModSettingsApi.cs @@ -1,4 +1,4 @@ -using OtterGui.Extensions; +using OtterGui; using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Api.Helpers; @@ -63,39 +63,13 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable return new AvailableModSettings(dict); } + public Dictionary? GetAvailableModSettingsBase(string modDirectory, string modName) + => _modManager.TryGetMod(modDirectory, modName, out var mod) + ? mod.Groups.ToDictionary(g => g.Name, g => (g.Options.Select(o => o.Name).ToArray(), (int)g.Type)) + : null; + public (PenumbraApiEc, (bool, int, Dictionary>, bool)?) GetCurrentModSettings(Guid collectionId, string modDirectory, string modName, bool ignoreInheritance) - { - var ret = GetCurrentModSettingsWithTemp(collectionId, modDirectory, modName, ignoreInheritance, true, 0); - if (ret.Item2 is null) - return (ret.Item1, null); - - return (ret.Item1, (ret.Item2.Value.Item1, ret.Item2.Value.Item2, ret.Item2.Value.Item3, ret.Item2.Value.Item4)); - } - - public PenumbraApiEc GetSettingsInAllCollections(string modDirectory, string modName, - out Dictionary>, bool, bool)> settings, - bool ignoreTemporaryCollections = false) - { - settings = []; - if (!_modManager.TryGetMod(modDirectory, modName, out var mod)) - return PenumbraApiEc.ModMissing; - - var collections = ignoreTemporaryCollections - ? _collectionManager.Storage.Where(c => c != ModCollection.Empty) - : _collectionManager.Storage.Where(c => c != ModCollection.Empty).Concat(_collectionManager.Temp.Values); - settings = []; - foreach (var collection in collections) - { - if (GetCurrentSettings(collection, mod, false, false, 0) is { } s) - settings.Add(collection.Identity.Id, s); - } - - return PenumbraApiEc.Success; - } - - public (PenumbraApiEc, (bool, int, Dictionary>, bool, bool)?) GetCurrentModSettingsWithTemp(Guid collectionId, - string modDirectory, string modName, bool ignoreInheritance, bool ignoreTemporary, int key) { if (!_modManager.TryGetMod(modDirectory, modName, out var mod)) return (PenumbraApiEc.ModMissing, null); @@ -103,32 +77,17 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable if (!_collectionManager.Storage.ById(collectionId, out var collection)) return (PenumbraApiEc.CollectionMissing, null); - if (collection.Identity.Id == Guid.Empty) + var settings = collection.Id == Guid.Empty + ? null + : ignoreInheritance + ? collection.Settings[mod.Index] + : collection[mod.Index].Settings; + if (settings == null) return (PenumbraApiEc.Success, null); - if (GetCurrentSettings(collection, mod, ignoreInheritance, ignoreTemporary, key) is { } settings) - return (PenumbraApiEc.Success, settings); - - return (PenumbraApiEc.Success, null); - } - - public (PenumbraApiEc, Dictionary>, bool, bool)>?) GetAllModSettings(Guid collectionId, - bool ignoreInheritance, bool ignoreTemporary, int key) - { - if (!_collectionManager.Storage.ById(collectionId, out var collection)) - return (PenumbraApiEc.CollectionMissing, null); - - if (collection.Identity.Id == Guid.Empty) - return (PenumbraApiEc.Success, []); - - var ret = new Dictionary>, bool, bool)>(_modManager.Count); - foreach (var mod in _modManager) - { - if (GetCurrentSettings(collection, mod, ignoreInheritance, ignoreTemporary, key) is { } settings) - ret[mod.Identifier] = settings; - } - - return (PenumbraApiEc.Success, ret); + var (enabled, priority, dict) = settings.ConvertToShareable(mod); + return (PenumbraApiEc.Success, + (enabled, priority.Value, dict, collection.Settings[mod.Index] == null)); } public PenumbraApiEc TryInheritMod(Guid collectionId, string modDirectory, string modName, bool inherit) @@ -201,11 +160,11 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable if (optionIdx < 0) return ApiHelpers.Return(PenumbraApiEc.OptionMissing, args); - var setting = mod.Groups[groupIdx].Behaviour switch + var setting = mod.Groups[groupIdx] switch { - GroupDrawBehaviour.MultiSelection => Setting.Multi(optionIdx), - GroupDrawBehaviour.SingleSelection => Setting.Single(optionIdx), - _ => Setting.Zero, + MultiModGroup => Setting.Multi(optionIdx), + SingleModGroup => Setting.Single(optionIdx), + _ => Setting.Zero, }; var ret = _collectionEditor.SetModSetting(collection, mod, groupIdx, setting) ? PenumbraApiEc.Success @@ -225,9 +184,36 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable if (!_modManager.TryGetMod(modDirectory, modName, out var mod)) return ApiHelpers.Return(PenumbraApiEc.ModMissing, args); - var settingSuccess = ConvertModSetting(mod, optionGroupName, optionNames, out var groupIdx, out var setting); - if (settingSuccess is not PenumbraApiEc.Success) - return ApiHelpers.Return(settingSuccess, args); + var groupIdx = mod.Groups.IndexOf(g => g.Name == optionGroupName); + if (groupIdx < 0) + return ApiHelpers.Return(PenumbraApiEc.OptionGroupMissing, args); + + var setting = Setting.Zero; + switch (mod.Groups[groupIdx]) + { + case SingleModGroup single: + { + var optionIdx = optionNames.Count == 0 ? -1 : single.OptionData.IndexOf(o => o.Name == optionNames[^1]); + if (optionIdx < 0) + return ApiHelpers.Return(PenumbraApiEc.OptionMissing, args); + + setting = Setting.Single(optionIdx); + break; + } + case MultiModGroup multi: + { + foreach (var name in optionNames) + { + var optionIdx = multi.OptionData.IndexOf(o => o.Mod.Name == name); + if (optionIdx < 0) + return ApiHelpers.Return(PenumbraApiEc.OptionMissing, args); + + setting |= Setting.Multi(optionIdx); + } + + break; + } + } var ret = _collectionEditor.SetModSetting(collection, mod, groupIdx, setting) ? PenumbraApiEc.Success @@ -252,38 +238,13 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable return ApiHelpers.Return(PenumbraApiEc.Success, args); } - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private (bool, int, Dictionary>, bool, bool)? GetCurrentSettings(ModCollection collection, Mod mod, - bool ignoreInheritance, bool ignoreTemporary, int key) - { - var settings = collection.Settings.Settings[mod.Index]; - if (!ignoreTemporary && settings.TempSettings is { } tempSettings && (tempSettings.Lock <= 0 || tempSettings.Lock == key)) - { - if (!tempSettings.ForceInherit) - return (tempSettings.Enabled, tempSettings.Priority.Value, tempSettings.ConvertToShareable(mod).Settings, - false, true); - if (!ignoreInheritance && collection.GetActualSettings(mod.Index).Settings is { } actualSettingsTemp) - return (actualSettingsTemp.Enabled, actualSettingsTemp.Priority.Value, - actualSettingsTemp.ConvertToShareable(mod).Settings, true, true); - } - - if (settings.Settings is { } ownSettings) - return (ownSettings.Enabled, ownSettings.Priority.Value, ownSettings.ConvertToShareable(mod).Settings, false, - false); - if (!ignoreInheritance && collection.GetInheritedSettings(mod.Index).Settings is { } actualSettings) - return (actualSettings.Enabled, actualSettings.Priority.Value, - actualSettings.ConvertToShareable(mod).Settings, true, false); - - return null; - } - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private void TriggerSettingEdited(Mod mod) { var collection = _collectionResolver.PlayerCollection(); - var (settings, parent) = collection.GetActualSettings(mod.Index); + var (settings, parent) = collection[mod.Index]; if (settings is { Enabled: true }) - ModSettingChanged?.Invoke(ModSettingChange.Edited, collection.Identity.Id, mod.Identifier, parent != collection); + ModSettingChanged?.Invoke(ModSettingChange.Edited, collection.Id, mod.Identifier, parent != collection); } private void OnModPathChange(ModPathChangeType type, Mod mod, DirectoryInfo? _1, DirectoryInfo? _2) @@ -293,10 +254,9 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable } private void OnModSettingChange(ModCollection collection, ModSettingChange type, Mod? mod, Setting _1, int _2, bool inherited) - => ModSettingChanged?.Invoke(type, collection.Identity.Id, mod?.ModPath.Name ?? string.Empty, inherited); + => ModSettingChanged?.Invoke(type, collection.Id, mod?.ModPath.Name ?? string.Empty, inherited); - private void OnModOptionEdited(ModOptionChangeType type, Mod mod, IModGroup? group, IModOption? option, IModDataContainer? container, - int moveIndex) + private void OnModOptionEdited(ModOptionChangeType type, Mod mod, IModGroup? group, IModOption? option, IModDataContainer? container, int moveIndex) { switch (type) { @@ -322,41 +282,4 @@ public class ModSettingsApi : IPenumbraApiModSettings, IApiService, IDisposable TriggerSettingEdited(mod); } - - public static PenumbraApiEc ConvertModSetting(Mod mod, string groupName, IReadOnlyList optionNames, out int groupIndex, - out Setting setting) - { - groupIndex = mod.Groups.IndexOf(g => g.Name.Equals(groupName, StringComparison.OrdinalIgnoreCase)); - setting = Setting.Zero; - if (groupIndex < 0) - return PenumbraApiEc.OptionGroupMissing; - - switch (mod.Groups[groupIndex]) - { - case { Behaviour: GroupDrawBehaviour.SingleSelection } single: - { - var optionIdx = optionNames.Count == 0 ? -1 : single.Options.IndexOf(o => o.Name == optionNames[^1]); - if (optionIdx < 0) - return PenumbraApiEc.OptionMissing; - - setting = Setting.Single(optionIdx); - break; - } - case { Behaviour: GroupDrawBehaviour.MultiSelection } multi: - { - foreach (var name in optionNames) - { - var optionIdx = multi.Options.IndexOf(o => o.Name == name); - if (optionIdx < 0) - return PenumbraApiEc.OptionMissing; - - setting |= Setting.Multi(optionIdx); - } - - break; - } - } - - return PenumbraApiEc.Success; - } } diff --git a/Penumbra/Api/Api/ModsApi.cs b/Penumbra/Api/Api/ModsApi.cs index 1f4f1cf4..c1e0c684 100644 --- a/Penumbra/Api/Api/ModsApi.cs +++ b/Penumbra/Api/Api/ModsApi.cs @@ -1,4 +1,3 @@ -using Newtonsoft.Json.Linq; using OtterGui.Compression; using OtterGui.Services; using Penumbra.Api.Enums; @@ -16,17 +15,15 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable private readonly ModImportManager _modImportManager; private readonly Configuration _config; private readonly ModFileSystem _modFileSystem; - private readonly MigrationManager _migrationManager; public ModsApi(ModManager modManager, ModImportManager modImportManager, Configuration config, ModFileSystem modFileSystem, - CommunicatorService communicator, MigrationManager migrationManager) + CommunicatorService communicator) { _modManager = modManager; _modImportManager = modImportManager; _config = config; _modFileSystem = modFileSystem; _communicator = communicator; - _migrationManager = migrationManager; _communicator.ModPathChanged.Subscribe(OnModPathChanged, ModPathChanged.Priority.ApiMods); } @@ -34,8 +31,12 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable { switch (type) { - case ModPathChangeType.Deleted when oldDirectory != null: ModDeleted?.Invoke(oldDirectory.Name); break; - case ModPathChangeType.Added when newDirectory != null: ModAdded?.Invoke(newDirectory.Name); break; + case ModPathChangeType.Deleted when oldDirectory != null: + ModDeleted?.Invoke(oldDirectory.Name); + break; + case ModPathChangeType.Added when newDirectory != null: + ModAdded?.Invoke(newDirectory.Name); + break; case ModPathChangeType.Moved when newDirectory != null && oldDirectory != null: ModMoved?.Invoke(oldDirectory.Name, newDirectory.Name); break; @@ -43,9 +44,7 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable } public void Dispose() - { - _communicator.ModPathChanged.Unsubscribe(OnModPathChanged); - } + => _communicator.ModPathChanged.Unsubscribe(OnModPathChanged); public Dictionary GetModList() => _modManager.ToDictionary(m => m.ModPath.Name, m => m.Name.Text); @@ -76,22 +75,13 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable if (!dir.Exists) return ApiHelpers.Return(PenumbraApiEc.FileMissing, args); - if (dir.Parent == null - || Path.TrimEndingDirectorySeparator(Path.GetFullPath(_modManager.BasePath.FullName)) - != Path.TrimEndingDirectorySeparator(Path.GetFullPath(dir.Parent.FullName))) + if (_modManager.BasePath.FullName != dir.Parent?.FullName) return ApiHelpers.Return(PenumbraApiEc.InvalidArgument, args); - _modManager.AddMod(dir, true); - if (_config.MigrateImportedModelsToV6) - { - _migrationManager.MigrateMdlDirectory(dir.FullName, false); - _migrationManager.Await(); - } - + _modManager.AddMod(dir); if (_config.UseFileSystemCompression) new FileCompactor(Penumbra.Log).StartMassCompact(dir.EnumerateFiles("*.*", SearchOption.AllDirectories), - CompressionAlgorithm.Xpress8K, false); - + CompressionAlgorithm.Xpress8K); return ApiHelpers.Return(PenumbraApiEc.Success, args); } @@ -108,28 +98,16 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable public event Action? ModAdded; public event Action? ModMoved; - public event Action? CreatingPcp - { - add => _communicator.PcpCreation.Subscribe(value!, PcpCreation.Priority.ModsApi); - remove => _communicator.PcpCreation.Unsubscribe(value!); - } - - public event Action? ParsingPcp - { - add => _communicator.PcpParsing.Subscribe(value!, PcpParsing.Priority.ModsApi); - remove => _communicator.PcpParsing.Unsubscribe(value!); - } - public (PenumbraApiEc, string, bool, bool) GetModPath(string modDirectory, string modName) { if (!_modManager.TryGetMod(modDirectory, modName, out var mod) - || !_modFileSystem.TryGetValue(mod, out var leaf)) + || !_modFileSystem.FindLeaf(mod, out var leaf)) return (PenumbraApiEc.ModMissing, string.Empty, false, false); var fullPath = leaf.FullName(); var isDefault = ModFileSystem.ModHasDefaultPath(mod, fullPath); - var isNameDefault = isDefault || ModFileSystem.ModHasDefaultPath(mod, leaf.Name); - return (PenumbraApiEc.Success, fullPath, !isDefault, !isNameDefault); + var isNameDefault = isDefault || ModFileSystem.ModHasDefaultPath(mod, leaf.Name); + return (PenumbraApiEc.Success, fullPath, !isDefault, !isNameDefault ); } public PenumbraApiEc SetModPath(string modDirectory, string modName, string newPath) @@ -138,7 +116,7 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable return PenumbraApiEc.InvalidArgument; if (!_modManager.TryGetMod(modDirectory, modName, out var mod) - || !_modFileSystem.TryGetValue(mod, out var leaf)) + || !_modFileSystem.FindLeaf(mod, out var leaf)) return PenumbraApiEc.ModMissing; try @@ -151,15 +129,4 @@ public class ModsApi : IPenumbraApiMods, IApiService, IDisposable return PenumbraApiEc.PathRenameFailed; } } - - public Dictionary GetChangedItems(string modDirectory, string modName) - => _modManager.TryGetMod(modDirectory, modName, out var mod) - ? mod.ChangedItems.ToDictionary(kvp => kvp.Key, kvp => kvp.Value?.ToInternalObject()) - : []; - - public IReadOnlyDictionary> GetChangedItemAdapterDictionary() - => new ModChangedItemAdapter(new WeakReference(_modManager)); - - public IReadOnlyList<(string ModDirectory, IReadOnlyDictionary ChangedItems)> GetChangedItemAdapterList() - => new ModChangedItemAdapter(new WeakReference(_modManager)); } diff --git a/Penumbra/Api/Api/PenumbraApi.cs b/Penumbra/Api/Api/PenumbraApi.cs index c4026c72..1d5b1537 100644 --- a/Penumbra/Api/Api/PenumbraApi.cs +++ b/Penumbra/Api/Api/PenumbraApi.cs @@ -16,16 +16,13 @@ public class PenumbraApi( TemporaryApi temporary, UiApi ui) : IDisposable, IApiService, IPenumbraApi { - public const int BreakingVersion = 5; - public const int FeatureVersion = 13; - public void Dispose() { Valid = false; } public (int Breaking, int Feature) ApiVersion - => (BreakingVersion, FeatureVersion); + => (5, 0); public bool Valid { get; private set; } = true; public IPenumbraApiCollection Collection { get; } = collection; diff --git a/Penumbra/Api/Api/PluginStateApi.cs b/Penumbra/Api/Api/PluginStateApi.cs index f74553d1..d69df448 100644 --- a/Penumbra/Api/Api/PluginStateApi.cs +++ b/Penumbra/Api/Api/PluginStateApi.cs @@ -1,38 +1,39 @@ -using System.Collections.Frozen; using Newtonsoft.Json; using OtterGui.Services; using Penumbra.Communication; -using Penumbra.Mods; using Penumbra.Services; namespace Penumbra.Api.Api; -public class PluginStateApi(Configuration config, CommunicatorService communicator) : IPenumbraApiPluginState, IApiService +public class PluginStateApi : IPenumbraApiPluginState, IApiService { + private readonly Configuration _config; + private readonly CommunicatorService _communicator; + + public PluginStateApi(Configuration config, CommunicatorService communicator) + { + _config = config; + _communicator = communicator; + } + public string GetModDirectory() - => config.ModDirectory; + => _config.ModDirectory; public string GetConfiguration() - => JsonConvert.SerializeObject(config, Formatting.Indented); + => JsonConvert.SerializeObject(_config, Formatting.Indented); public event Action? ModDirectoryChanged { - add => communicator.ModDirectoryChanged.Subscribe(value!, Communication.ModDirectoryChanged.Priority.Api); - remove => communicator.ModDirectoryChanged.Unsubscribe(value!); + add => _communicator.ModDirectoryChanged.Subscribe(value!, Communication.ModDirectoryChanged.Priority.Api); + remove => _communicator.ModDirectoryChanged.Unsubscribe(value!); } public bool GetEnabledState() - => config.EnableMods; + => _config.EnableMods; public event Action? EnabledChange { - add => communicator.EnabledChanged.Subscribe(value!, EnabledChanged.Priority.Api); - remove => communicator.EnabledChanged.Unsubscribe(value!); + add => _communicator.EnabledChanged.Subscribe(value!, EnabledChanged.Priority.Api); + remove => _communicator.EnabledChanged.Unsubscribe(value!); } - - public FrozenSet SupportedFeatures - => FeatureChecker.SupportedFeatures.ToFrozenSet(); - - public string[] CheckSupportedFeatures(IEnumerable requiredFeatures) - => requiredFeatures.Where(f => !FeatureChecker.Supported(f)).ToArray(); } diff --git a/Penumbra/Api/Api/RedrawApi.cs b/Penumbra/Api/Api/RedrawApi.cs index 08f1f9df..03b42493 100644 --- a/Penumbra/Api/Api/RedrawApi.cs +++ b/Penumbra/Api/Api/RedrawApi.cs @@ -1,57 +1,27 @@ using Dalamud.Game.ClientState.Objects.Types; -using Dalamud.Plugin.Services; using OtterGui.Services; using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Collections.Manager; -using Penumbra.GameData.Interop; using Penumbra.Interop.Services; -namespace Penumbra.Api.Api; - -public class RedrawApi(RedrawService redrawService, IFramework framework, CollectionManager collections, ObjectManager objects, ApiHelpers helpers) : IPenumbraApiRedraw, IApiService +namespace Penumbra.Api.Api; + +public class RedrawApi(RedrawService redrawService) : IPenumbraApiRedraw, IApiService { public void RedrawObject(int gameObjectIndex, RedrawType setting) - { - framework.RunOnFrameworkThread(() => redrawService.RedrawObject(gameObjectIndex, setting)); - } + => redrawService.RedrawObject(gameObjectIndex, setting); public void RedrawObject(string name, RedrawType setting) - { - framework.RunOnFrameworkThread(() => redrawService.RedrawObject(name, setting)); - } + => redrawService.RedrawObject(name, setting); - public void RedrawObject(IGameObject? gameObject, RedrawType setting) - { - framework.RunOnFrameworkThread(() => redrawService.RedrawObject(gameObject, setting)); - } + public void RedrawObject(GameObject? gameObject, RedrawType setting) + => redrawService.RedrawObject(gameObject, setting); public void RedrawAll(RedrawType setting) - { - framework.RunOnFrameworkThread(() => redrawService.RedrawAll(setting)); - } - - public void RedrawCollectionMembers(Guid collectionId, RedrawType setting) - { - - if (!collections.Storage.ById(collectionId, out var collection)) - collection = ModCollection.Empty; - framework.RunOnFrameworkThread(() => - { - foreach (var actor in objects.Objects) - { - helpers.AssociatedCollection(actor.ObjectIndex, out var modCollection); - if (collection == modCollection) - { - redrawService.RedrawObject(actor.ObjectIndex, setting); - } - } - }); - } + => redrawService.RedrawAll(setting); public event GameObjectRedrawnDelegate? GameObjectRedrawn { add => redrawService.GameObjectRedrawn += value; remove => redrawService.GameObjectRedrawn -= value; } -} +} diff --git a/Penumbra/Api/Api/ResolveApi.cs b/Penumbra/Api/Api/ResolveApi.cs index 00a0c86f..ec57eba7 100644 --- a/Penumbra/Api/Api/ResolveApi.cs +++ b/Penumbra/Api/Api/ResolveApi.cs @@ -1,6 +1,5 @@ using Dalamud.Plugin.Services; using OtterGui.Services; -using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.Interop.PathResolving; @@ -42,19 +41,6 @@ public class ResolveApi( return ret.Select(r => r.ToString()).ToArray(); } - public PenumbraApiEc ResolvePath(Guid collectionId, string gamePath, out string resolvedPath) - { - resolvedPath = gamePath; - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return PenumbraApiEc.CollectionMissing; - - if (!collection.HasCache) - return PenumbraApiEc.CollectionInactive; - - resolvedPath = ResolvePath(gamePath, modManager, collection); - return PenumbraApiEc.Success; - } - public string[] ReverseResolvePlayerPath(string moddedPath) { if (!config.EnableMods) @@ -78,26 +64,6 @@ public class ResolveApi( return (resolved, reverseResolved.Select(a => a.Select(p => p.ToString()).ToArray()).ToArray()); } - public PenumbraApiEc ResolvePaths(Guid collectionId, string[] forward, string[] reverse, out string[] resolvedForward, - out string[][] resolvedReverse) - { - resolvedForward = forward; - resolvedReverse = []; - if (!config.EnableMods) - return PenumbraApiEc.Success; - - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return PenumbraApiEc.CollectionMissing; - - if (!collection.HasCache) - return PenumbraApiEc.CollectionInactive; - - resolvedForward = forward.Select(p => ResolvePath(p, modManager, collection)).ToArray(); - var reverseResolved = collection.ReverseResolvePaths(reverse); - resolvedReverse = reverseResolved.Select(a => a.Select(p => p.ToString()).ToArray()).ToArray(); - return PenumbraApiEc.Success; - } - public async Task<(string[], string[][])> ResolvePlayerPathsAsync(string[] forward, string[] reverse) { if (!config.EnableMods) @@ -128,7 +94,7 @@ public class ResolveApi( if (!config.EnableMods) return path; - var gamePath = Utf8GamePath.FromString(path, out var p) ? p : Utf8GamePath.Empty; + var gamePath = Utf8GamePath.FromString(path, out var p, true) ? p : Utf8GamePath.Empty; var ret = collection.ResolvePath(gamePath); return ret?.ToString() ?? path; } diff --git a/Penumbra/Api/Api/ResourceTreeApi.cs b/Penumbra/Api/Api/ResourceTreeApi.cs index dcec99bf..6e9aaa48 100644 --- a/Penumbra/Api/Api/ResourceTreeApi.cs +++ b/Penumbra/Api/Api/ResourceTreeApi.cs @@ -12,7 +12,7 @@ public class ResourceTreeApi(ResourceTreeFactory resourceTreeFactory, ObjectMana { public Dictionary>?[] GetGameObjectResourcePaths(params ushort[] gameObjects) { - var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); + var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); var resourceTrees = resourceTreeFactory.FromCharacters(characters, 0); var pathDictionaries = ResourceTreeApiHelper.GetResourcePathDictionaries(resourceTrees); @@ -28,7 +28,7 @@ public class ResourceTreeApi(ResourceTreeFactory resourceTreeFactory, ObjectMana public GameResourceDict?[] GetGameObjectResourcesOfType(ResourceType type, bool withUiData, params ushort[] gameObjects) { - var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); + var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); var resourceTrees = resourceTreeFactory.FromCharacters(characters, withUiData ? ResourceTreeFactory.Flags.WithUiData : 0); var resDictionaries = ResourceTreeApiHelper.GetResourcesOfType(resourceTrees, type); @@ -45,7 +45,7 @@ public class ResourceTreeApi(ResourceTreeFactory resourceTreeFactory, ObjectMana public JObject?[] GetGameObjectResourceTrees(bool withUiData, params ushort[] gameObjects) { - var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); + var characters = gameObjects.Select(index => objects.GetDalamudObject((int)index)).OfType(); var resourceTrees = resourceTreeFactory.FromCharacters(characters, withUiData ? ResourceTreeFactory.Flags.WithUiData : 0); var resDictionary = ResourceTreeApiHelper.EncapsulateResourceTrees(resourceTrees); diff --git a/Penumbra/Api/Api/TemporaryApi.cs b/Penumbra/Api/Api/TemporaryApi.cs index 7567acd3..38d080cc 100644 --- a/Penumbra/Api/Api/TemporaryApi.cs +++ b/Penumbra/Api/Api/TemporaryApi.cs @@ -1,11 +1,10 @@ -using OtterGui.Log; +using OtterGui; using OtterGui.Services; using Penumbra.Api.Enums; -using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.GameData.Actors; using Penumbra.GameData.Interop; -using Penumbra.Mods.Manager; +using Penumbra.Meta.Manipulations; using Penumbra.Mods.Settings; using Penumbra.String.Classes; @@ -16,20 +15,10 @@ public class TemporaryApi( ObjectManager objects, ActorManager actors, CollectionManager collectionManager, - TempModManager tempMods, - ApiHelpers apiHelpers, - ModManager modManager) : IPenumbraApiTemporary, IApiService + TempModManager tempMods) : IPenumbraApiTemporary, IApiService { - public (PenumbraApiEc, Guid) CreateTemporaryCollection(string identity, string name) - { - if (!IdentityChecker.Check(identity)) - return (PenumbraApiEc.InvalidCredentials, Guid.Empty); - - var collection = tempCollections.CreateTemporaryCollection(name); - if (collection == Guid.Empty) - return (PenumbraApiEc.UnknownError, collection); - return (PenumbraApiEc.Success, collection); - } + public Guid CreateTemporaryCollection(string name) + => tempCollections.CreateTemporaryCollection(name); public PenumbraApiEc DeleteTemporaryCollection(Guid collectionId) => tempCollections.RemoveTemporaryCollection(collectionId) @@ -73,7 +62,7 @@ public class TemporaryApi( if (!ConvertPaths(paths, out var p)) return ApiHelpers.Return(PenumbraApiEc.InvalidGamePath, args); - if (!MetaApi.ConvertManips(manipString, out var m, out _)) + if (!ConvertManips(manipString, out var m)) return ApiHelpers.Return(PenumbraApiEc.InvalidManipulation, args); var ret = tempMods.Register(tag, null, p, m, new ModPriority(priority)) switch @@ -99,7 +88,7 @@ public class TemporaryApi( if (!ConvertPaths(paths, out var p)) return ApiHelpers.Return(PenumbraApiEc.InvalidGamePath, args); - if (!MetaApi.ConvertManips(manipString, out var m, out _)) + if (!ConvertManips(manipString, out var m)) return ApiHelpers.Return(PenumbraApiEc.InvalidManipulation, args); var ret = tempMods.Register(tag, collection, p, m, new ModPriority(priority)) switch @@ -138,177 +127,6 @@ public class TemporaryApi( return ApiHelpers.Return(ret, args); } - public (PenumbraApiEc, (bool, bool, int, Dictionary>)?, string) QueryTemporaryModSettings(Guid collectionId, - string modDirectory, string modName, int key) - { - var args = ApiHelpers.Args("CollectionId", collectionId, "ModDirectory", modDirectory, "ModName", modName); - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return (ApiHelpers.Return(PenumbraApiEc.CollectionMissing, args), null, string.Empty); - - return QueryTemporaryModSettings(args, collection, modDirectory, modName, key); - } - - public (PenumbraApiEc ErrorCode, (bool, bool, int, Dictionary>)? Settings, string Source) - QueryTemporaryModSettingsPlayer(int objectIndex, - string modDirectory, string modName, int key) - { - var args = ApiHelpers.Args("ObjectIndex", objectIndex, "ModDirectory", modDirectory, "ModName", modName); - if (!apiHelpers.AssociatedCollection(objectIndex, out var collection)) - return (ApiHelpers.Return(PenumbraApiEc.InvalidArgument, args), null, string.Empty); - - return QueryTemporaryModSettings(args, collection, modDirectory, modName, key); - } - - private (PenumbraApiEc ErrorCode, (bool, bool, int, Dictionary>)? Settings, string Source) QueryTemporaryModSettings( - in LazyString args, ModCollection collection, string modDirectory, string modName, int key) - { - if (!modManager.TryGetMod(modDirectory, modName, out var mod)) - return (ApiHelpers.Return(PenumbraApiEc.ModMissing, args), null, string.Empty); - - if (collection.Identity.Index <= 0) - return (ApiHelpers.Return(PenumbraApiEc.Success, args), null, string.Empty); - - var settings = collection.GetTempSettings(mod.Index); - if (settings == null) - return (ApiHelpers.Return(PenumbraApiEc.Success, args), null, string.Empty); - - if (settings.Lock > 0 && settings.Lock != key) - return (ApiHelpers.Return(PenumbraApiEc.TemporarySettingDisallowed, args), null, settings.Source); - - return (ApiHelpers.Return(PenumbraApiEc.Success, args), - (settings.ForceInherit, settings.Enabled, settings.Priority.Value, settings.ConvertToShareable(mod).Settings), settings.Source); - } - - - public PenumbraApiEc SetTemporaryModSettings(Guid collectionId, string modDirectory, string modName, bool inherit, bool enabled, - int priority, - IReadOnlyDictionary> options, string source, int key) - { - var args = ApiHelpers.Args("CollectionId", collectionId, "ModDirectory", modDirectory, "ModName", modName, "Inherit", inherit, - "Enabled", enabled, - "Priority", priority, "Options", options, "Source", source, "Key", key); - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.CollectionMissing, args); - - return SetTemporaryModSettings(args, collection, modDirectory, modName, inherit, enabled, priority, options, source, key); - } - - public PenumbraApiEc SetTemporaryModSettingsPlayer(int objectIndex, string modDirectory, string modName, bool inherit, bool enabled, - int priority, - IReadOnlyDictionary> options, string source, int key) - { - var args = ApiHelpers.Args("ObjectIndex", objectIndex, "ModDirectory", modDirectory, "ModName", modName, "Inherit", inherit, "Enabled", - enabled, - "Priority", priority, "Options", options, "Source", source, "Key", key); - if (!apiHelpers.AssociatedCollection(objectIndex, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.InvalidArgument, args); - - return SetTemporaryModSettings(args, collection, modDirectory, modName, inherit, enabled, priority, options, source, key); - } - - private PenumbraApiEc SetTemporaryModSettings(in LazyString args, ModCollection collection, string modDirectory, string modName, - bool inherit, bool enabled, int priority, IReadOnlyDictionary> options, string source, int key) - { - if (collection.Identity.Index <= 0) - return ApiHelpers.Return(PenumbraApiEc.TemporarySettingImpossible, args); - - if (!modManager.TryGetMod(modDirectory, modName, out var mod)) - return ApiHelpers.Return(PenumbraApiEc.ModMissing, args); - - if (!collectionManager.Editor.CanSetTemporarySettings(collection, mod, key)) - if (collection.GetTempSettings(mod.Index) is { Lock: > 0 } oldSettings && oldSettings.Lock != key) - return ApiHelpers.Return(PenumbraApiEc.TemporarySettingDisallowed, args); - - var newSettings = new TemporaryModSettings() - { - ForceInherit = inherit, - Enabled = enabled, - Priority = new ModPriority(priority), - Lock = key, - Source = source, - Settings = SettingList.Default(mod), - }; - - - foreach (var (groupName, optionNames) in options) - { - var ec = ModSettingsApi.ConvertModSetting(mod, groupName, optionNames, out var groupIdx, out var setting); - if (ec != PenumbraApiEc.Success) - return ApiHelpers.Return(ec, args); - - newSettings.Settings[groupIdx] = setting; - } - - if (collectionManager.Editor.SetTemporarySettings(collection, mod, newSettings, key)) - return ApiHelpers.Return(PenumbraApiEc.Success, args); - - // This should not happen since all error cases had been checked before. - return ApiHelpers.Return(PenumbraApiEc.UnknownError, args); - } - - public PenumbraApiEc RemoveTemporaryModSettings(Guid collectionId, string modDirectory, string modName, int key) - { - var args = ApiHelpers.Args("CollectionId", collectionId, "ModDirectory", modDirectory, "ModName", modName, "Key", key); - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.CollectionMissing, args); - - return RemoveTemporaryModSettings(args, collection, modDirectory, modName, key); - } - - public PenumbraApiEc RemoveTemporaryModSettingsPlayer(int objectIndex, string modDirectory, string modName, int key) - { - var args = ApiHelpers.Args("ObjectIndex", objectIndex, "ModDirectory", modDirectory, "ModName", modName, "Key", key); - if (!apiHelpers.AssociatedCollection(objectIndex, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.InvalidArgument, args); - - return RemoveTemporaryModSettings(args, collection, modDirectory, modName, key); - } - - private PenumbraApiEc RemoveTemporaryModSettings(in LazyString args, ModCollection collection, string modDirectory, string modName, int key) - { - if (collection.Identity.Index <= 0) - return ApiHelpers.Return(PenumbraApiEc.NothingChanged, args); - - if (!modManager.TryGetMod(modDirectory, modName, out var mod)) - return ApiHelpers.Return(PenumbraApiEc.ModMissing, args); - - if (collection.GetTempSettings(mod.Index) is null) - return ApiHelpers.Return(PenumbraApiEc.NothingChanged, args); - - if (!collectionManager.Editor.SetTemporarySettings(collection, mod, null, key)) - return ApiHelpers.Return(PenumbraApiEc.TemporarySettingDisallowed, args); - - return ApiHelpers.Return(PenumbraApiEc.Success, args); - } - - public PenumbraApiEc RemoveAllTemporaryModSettings(Guid collectionId, int key) - { - var args = ApiHelpers.Args("CollectionId", collectionId, "Key", key); - if (!collectionManager.Storage.ById(collectionId, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.CollectionMissing, args); - - return RemoveAllTemporaryModSettings(args, collection, key); - } - - public PenumbraApiEc RemoveAllTemporaryModSettingsPlayer(int objectIndex, int key) - { - var args = ApiHelpers.Args("ObjectIndex", objectIndex, "Key", key); - if (!apiHelpers.AssociatedCollection(objectIndex, out var collection)) - return ApiHelpers.Return(PenumbraApiEc.InvalidArgument, args); - - return RemoveAllTemporaryModSettings(args, collection, key); - } - - private PenumbraApiEc RemoveAllTemporaryModSettings(in LazyString args, ModCollection collection, int key) - { - if (collection.Identity.Index <= 0) - return ApiHelpers.Return(PenumbraApiEc.NothingChanged, args); - - var numRemoved = collectionManager.Editor.ClearTemporarySettings(collection, key); - return ApiHelpers.Return(numRemoved > 0 ? PenumbraApiEc.Success : PenumbraApiEc.NothingChanged, args); - } - - /// /// Convert a dictionary of strings to a dictionary of game paths to full paths. /// Only returns true if all paths can successfully be converted and added. @@ -319,7 +137,7 @@ public class TemporaryApi( paths = new Dictionary(redirections.Count); foreach (var (gString, fString) in redirections) { - if (!Utf8GamePath.FromString(gString, out var path)) + if (!Utf8GamePath.FromString(gString, out var path, false)) { paths = null; return false; @@ -335,4 +153,38 @@ public class TemporaryApi( return true; } + + /// + /// Convert manipulations from a transmitted base64 string to actual manipulations. + /// The empty string is treated as an empty set. + /// Only returns true if all conversions are successful and distinct. + /// + private static bool ConvertManips(string manipString, + [NotNullWhen(true)] out HashSet? manips) + { + if (manipString.Length == 0) + { + manips = []; + return true; + } + + if (Functions.FromCompressedBase64(manipString, out var manipArray) != MetaManipulation.CurrentVersion) + { + manips = null; + return false; + } + + manips = new HashSet(manipArray!.Length); + foreach (var manip in manipArray.Where(m => m.Validate())) + { + if (manips.Add(manip)) + continue; + + Penumbra.Log.Warning($"Manipulation {manip} {manip.EntryToString()} is invalid and was skipped."); + manips = null; + return false; + } + + return true; + } } diff --git a/Penumbra/Api/Api/UiApi.cs b/Penumbra/Api/Api/UiApi.cs index 6fb116f3..cf3cd8f2 100644 --- a/Penumbra/Api/Api/UiApi.cs +++ b/Penumbra/Api/Api/UiApi.cs @@ -1,28 +1,24 @@ using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Communication; -using Penumbra.GameData.Data; +using Penumbra.GameData.Enums; using Penumbra.Mods.Manager; using Penumbra.Services; using Penumbra.UI; -using Penumbra.UI.Integration; -using Penumbra.UI.Tabs; namespace Penumbra.Api.Api; public class UiApi : IPenumbraApiUi, IApiService, IDisposable { - private readonly CommunicatorService _communicator; - private readonly ConfigWindow _configWindow; - private readonly ModManager _modManager; - private readonly IntegrationSettingsRegistry _integrationSettings; + private readonly CommunicatorService _communicator; + private readonly ConfigWindow _configWindow; + private readonly ModManager _modManager; - public UiApi(CommunicatorService communicator, ConfigWindow configWindow, ModManager modManager, IntegrationSettingsRegistry integrationSettings) + public UiApi(CommunicatorService communicator, ConfigWindow configWindow, ModManager modManager) { - _communicator = communicator; - _configWindow = configWindow; - _modManager = modManager; - _integrationSettings = integrationSettings; + _communicator = communicator; + _configWindow = configWindow; + _modManager = modManager; _communicator.ChangedItemHover.Subscribe(OnChangedItemHover, ChangedItemHover.Priority.Default); _communicator.ChangedItemClick.Subscribe(OnChangedItemClick, ChangedItemClick.Priority.Default); } @@ -85,29 +81,21 @@ public class UiApi : IPenumbraApiUi, IApiService, IDisposable public void CloseMainWindow() => _configWindow.IsOpen = false; - private void OnChangedItemClick(MouseButton button, IIdentifiedObjectData data) + private void OnChangedItemClick(MouseButton button, object? data) { if (ChangedItemClicked == null) return; - var (type, id) = data.ToApiObject(); + var (type, id) = ChangedItemExtensions.ChangedItemToTypeAndId(data); ChangedItemClicked.Invoke(button, type, id); } - private void OnChangedItemHover(IIdentifiedObjectData data) + private void OnChangedItemHover(object? data) { if (ChangedItemTooltip == null) return; - var (type, id) = data.ToApiObject(); + var (type, id) = ChangedItemExtensions.ChangedItemToTypeAndId(data); ChangedItemTooltip.Invoke(type, id); } - - public PenumbraApiEc RegisterSettingsSection(Action draw) - => _integrationSettings.RegisterSection(draw); - - public PenumbraApiEc UnregisterSettingsSection(Action draw) - => _integrationSettings.UnregisterSection(draw) - ? PenumbraApiEc.Success - : PenumbraApiEc.NothingChanged; } diff --git a/Penumbra/Api/DalamudSubstitutionProvider.cs b/Penumbra/Api/DalamudSubstitutionProvider.cs index e10dc461..1c2cebcc 100644 --- a/Penumbra/Api/DalamudSubstitutionProvider.cs +++ b/Penumbra/Api/DalamudSubstitutionProvider.cs @@ -1,9 +1,9 @@ -using Dalamud.Interface; using Dalamud.Plugin.Services; using OtterGui.Services; using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.Communication; +using Penumbra.Mods; using Penumbra.Mods.Editor; using Penumbra.Services; using Penumbra.String.Classes; @@ -13,7 +13,6 @@ namespace Penumbra.Api; public class DalamudSubstitutionProvider : IDisposable, IApiService { private readonly ITextureSubstitutionProvider _substitution; - private readonly IUiBuilder _uiBuilder; private readonly ActiveCollectionData _activeCollectionData; private readonly Configuration _config; private readonly CommunicatorService _communicator; @@ -22,10 +21,9 @@ public class DalamudSubstitutionProvider : IDisposable, IApiService => _config.UseDalamudUiTextureRedirection; public DalamudSubstitutionProvider(ITextureSubstitutionProvider substitution, ActiveCollectionData activeCollectionData, - Configuration config, CommunicatorService communicator, IUiBuilder ui) + Configuration config, CommunicatorService communicator) { _substitution = substitution; - _uiBuilder = ui; _activeCollectionData = activeCollectionData; _config = config; _communicator = communicator; @@ -43,9 +41,6 @@ public class DalamudSubstitutionProvider : IDisposable, IApiService public void ResetSubstitutions(IEnumerable paths) { - if (!_uiBuilder.UiPrepared) - return; - var transformed = paths .Where(p => (p.Path.StartsWith("ui/"u8) || p.Path.StartsWith("common/font/"u8)) && p.Path.EndsWith(".tex"u8)) .Select(p => p.ToString()); @@ -96,7 +91,10 @@ public class DalamudSubstitutionProvider : IDisposable, IApiService case ResolvedFileChanged.Type.Added: case ResolvedFileChanged.Type.Removed: case ResolvedFileChanged.Type.Replaced: - ResetSubstitutions([key]); + ResetSubstitutions(new[] + { + key, + }); break; case ResolvedFileChanged.Type.FullRecomputeStart: case ResolvedFileChanged.Type.FullRecomputeFinished: @@ -129,7 +127,7 @@ public class DalamudSubstitutionProvider : IDisposable, IApiService try { - if (!Utf8GamePath.FromString(path, out var utf8Path)) + if (!Utf8GamePath.FromString(path, out var utf8Path, true)) return; var resolved = _activeCollectionData.Interface.ResolvePath(utf8Path); diff --git a/Penumbra/Api/HttpApi.cs b/Penumbra/Api/HttpApi.cs index 79348a88..859c46b4 100644 --- a/Penumbra/Api/HttpApi.cs +++ b/Penumbra/Api/HttpApi.cs @@ -1,11 +1,9 @@ -using Dalamud.Plugin.Services; using EmbedIO; using EmbedIO.Routing; using EmbedIO.WebApi; using OtterGui.Services; using Penumbra.Api.Api; using Penumbra.Api.Enums; -using Penumbra.Mods.Settings; namespace Penumbra.Api; @@ -14,28 +12,23 @@ public class HttpApi : IDisposable, IApiService private partial class Controller : WebApiController { // @formatter:off - [Route( HttpVerbs.Get, "/moddirectory" )] public partial string GetModDirectory(); - [Route( HttpVerbs.Get, "/mods" )] public partial object? GetMods(); - [Route( HttpVerbs.Post, "/redraw" )] public partial Task Redraw(); - [Route( HttpVerbs.Post, "/redrawAll" )] public partial Task RedrawAll(); - [Route( HttpVerbs.Post, "/reloadmod" )] public partial Task ReloadMod(); - [Route( HttpVerbs.Post, "/installmod" )] public partial Task InstallMod(); - [Route( HttpVerbs.Post, "/openwindow" )] public partial void OpenWindow(); - [Route( HttpVerbs.Post, "/focusmod" )] public partial Task FocusMod(); - [Route( HttpVerbs.Post, "/setmodsettings")] public partial Task SetModSettings(); + [Route( HttpVerbs.Get, "/mods" )] public partial object? GetMods(); + [Route( HttpVerbs.Post, "/redraw" )] public partial Task Redraw(); + [Route( HttpVerbs.Post, "/redrawAll" )] public partial void RedrawAll(); + [Route( HttpVerbs.Post, "/reloadmod" )] public partial Task ReloadMod(); + [Route( HttpVerbs.Post, "/installmod" )] public partial Task InstallMod(); + [Route( HttpVerbs.Post, "/openwindow" )] public partial void OpenWindow(); // @formatter:on } public const string Prefix = "http://localhost:42069/"; private readonly IPenumbraApi _api; - private readonly IFramework _framework; private WebServer? _server; - public HttpApi(Configuration config, IPenumbraApi api, IFramework framework) + public HttpApi(Configuration config, IPenumbraApi api) { - _api = api; - _framework = framework; + _api = api; if (config.EnableHttpApi) CreateWebServer(); } @@ -51,7 +44,7 @@ public class HttpApi : IDisposable, IApiService .WithUrlPrefix(Prefix) .WithMode(HttpListenerMode.EmbedIO)) .WithCors(Prefix) - .WithWebApi("/api", m => m.WithController(() => new Controller(_api, _framework))); + .WithWebApi("/api", m => m.WithController(() => new Controller(_api))); _server.StateChanged += (_, e) => Penumbra.Log.Information($"WebServer New State - {e.NewState}"); _server.RunAsync(); @@ -66,96 +59,60 @@ public class HttpApi : IDisposable, IApiService public void Dispose() => ShutdownWebServer(); - private partial class Controller(IPenumbraApi api, IFramework framework) + private partial class Controller { - public partial string GetModDirectory() - { - Penumbra.Log.Debug($"[HTTP] {nameof(GetModDirectory)} triggered."); - return api.PluginState.GetModDirectory(); - } + private readonly IPenumbraApi _api; + + public Controller(IPenumbraApi api) + => _api = api; public partial object? GetMods() { Penumbra.Log.Debug($"[HTTP] {nameof(GetMods)} triggered."); - return api.Mods.GetModList(); + return _api.Mods.GetModList(); } public async partial Task Redraw() { - var data = await HttpContext.GetRequestDataAsync().ConfigureAwait(false); - Penumbra.Log.Debug($"[HTTP] [{Environment.CurrentManagedThreadId}] {nameof(Redraw)} triggered with {data}."); - await framework.RunOnFrameworkThread(() => - { - if (data.ObjectTableIndex >= 0) - api.Redraw.RedrawObject(data.ObjectTableIndex, data.Type); - else - api.Redraw.RedrawAll(data.Type); - }).ConfigureAwait(false); + var data = await HttpContext.GetRequestDataAsync(); + Penumbra.Log.Debug($"[HTTP] {nameof(Redraw)} triggered with {data}."); + if (data.ObjectTableIndex >= 0) + _api.Redraw.RedrawObject(data.ObjectTableIndex, data.Type); + else + _api.Redraw.RedrawAll(data.Type); } - public async partial Task RedrawAll() + public partial void RedrawAll() { Penumbra.Log.Debug($"[HTTP] {nameof(RedrawAll)} triggered."); - await framework.RunOnFrameworkThread(() => { api.Redraw.RedrawAll(RedrawType.Redraw); }).ConfigureAwait(false); + _api.Redraw.RedrawAll(RedrawType.Redraw); } public async partial Task ReloadMod() { - var data = await HttpContext.GetRequestDataAsync().ConfigureAwait(false); + var data = await HttpContext.GetRequestDataAsync(); Penumbra.Log.Debug($"[HTTP] {nameof(ReloadMod)} triggered with {data}."); // Add the mod if it is not already loaded and if the directory name is given. // AddMod returns Success if the mod is already loaded. if (data.Path.Length != 0) - api.Mods.AddMod(data.Path); + _api.Mods.AddMod(data.Path); // Reload the mod by path or name, which will also remove no-longer existing mods. - api.Mods.ReloadMod(data.Path, data.Name); + _api.Mods.ReloadMod(data.Path, data.Name); } public async partial Task InstallMod() { - var data = await HttpContext.GetRequestDataAsync().ConfigureAwait(false); + var data = await HttpContext.GetRequestDataAsync(); Penumbra.Log.Debug($"[HTTP] {nameof(InstallMod)} triggered with {data}."); if (data.Path.Length != 0) - api.Mods.InstallMod(data.Path); + _api.Mods.InstallMod(data.Path); } public partial void OpenWindow() { Penumbra.Log.Debug($"[HTTP] {nameof(OpenWindow)} triggered."); - api.Ui.OpenMainWindow(TabType.Mods, string.Empty, string.Empty); - } - - public async partial Task FocusMod() - { - var data = await HttpContext.GetRequestDataAsync().ConfigureAwait(false); - Penumbra.Log.Debug($"[HTTP] {nameof(FocusMod)} triggered."); - if (data.Path.Length != 0) - api.Ui.OpenMainWindow(TabType.Mods, data.Path, data.Name); - } - - public async partial Task SetModSettings() - { - var data = await HttpContext.GetRequestDataAsync().ConfigureAwait(false); - Penumbra.Log.Debug($"[HTTP] {nameof(SetModSettings)} triggered."); - await framework.RunOnFrameworkThread(() => - { - var collection = data.CollectionId ?? api.Collection.GetCollection(ApiCollectionType.Current)!.Value.Id; - if (data.Inherit.HasValue) - { - api.ModSettings.TryInheritMod(collection, data.ModPath, data.ModName, data.Inherit.Value); - if (data.Inherit.Value) - return; - } - - if (data.State.HasValue) - api.ModSettings.TrySetMod(collection, data.ModPath, data.ModName, data.State.Value); - if (data.Priority.HasValue) - api.ModSettings.TrySetModPriority(collection, data.ModPath, data.ModName, data.Priority.Value); - foreach (var (group, settings) in data.Settings ?? []) - api.ModSettings.TrySetModSettings(collection, data.ModPath, data.ModName, group, settings); - } - ).ConfigureAwait(false); + _api.Ui.OpenMainWindow(TabType.Mods, string.Empty, string.Empty); } private record ModReloadData(string Path, string Name) @@ -165,13 +122,6 @@ public class HttpApi : IDisposable, IApiService { } } - private record ModFocusData(string Path, string Name) - { - public ModFocusData() - : this(string.Empty, string.Empty) - { } - } - private record ModInstallData(string Path) { public ModInstallData() @@ -185,19 +135,5 @@ public class HttpApi : IDisposable, IApiService : this(string.Empty, RedrawType.Redraw, -1) { } } - - private record SetModSettingsData( - Guid? CollectionId, - string ModPath, - string ModName, - bool? Inherit, - bool? State, - int? Priority, - Dictionary>? Settings) - { - public SetModSettingsData() - : this(null, string.Empty, string.Empty, null, null, null, null) - {} - } } } diff --git a/Penumbra/Api/IpcLaunchingProvider.cs b/Penumbra/Api/IpcLaunchingProvider.cs deleted file mode 100644 index ff851003..00000000 --- a/Penumbra/Api/IpcLaunchingProvider.cs +++ /dev/null @@ -1,28 +0,0 @@ -using Dalamud.Plugin; -using OtterGui.Log; -using OtterGui.Services; -using Penumbra.Api.Api; -using Serilog.Events; - -namespace Penumbra.Api; - -public sealed class IpcLaunchingProvider : IApiService -{ - public IpcLaunchingProvider(IDalamudPluginInterface pi, Logger log) - { - try - { - using var subscriber = log.MainLogger.IsEnabled(LogEventLevel.Debug) - ? IpcSubscribers.Launching.Subscriber(pi, - (major, minor) => log.Debug($"[IPC] Invoked Penumbra.Launching IPC with API Version {major}.{minor}.")) - : null; - - using var provider = IpcSubscribers.Launching.Provider(pi); - provider.Invoke(PenumbraApi.BreakingVersion, PenumbraApi.FeatureVersion); - } - catch (Exception ex) - { - log.Error($"[IPC] Could not invoke Penumbra.Launching IPC:\n{ex}"); - } - } -} diff --git a/Penumbra/Api/IpcProviders.cs b/Penumbra/Api/IpcProviders.cs index 7cbe29f6..ebf71176 100644 --- a/Penumbra/Api/IpcProviders.cs +++ b/Penumbra/Api/IpcProviders.cs @@ -2,8 +2,6 @@ using Dalamud.Plugin; using OtterGui.Services; using Penumbra.Api.Api; using Penumbra.Api.Helpers; -using Penumbra.Communication; -using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; namespace Penumbra.Api; @@ -11,13 +9,11 @@ public sealed class IpcProviders : IDisposable, IApiService { private readonly List _providers; - private readonly EventProvider _disposedProvider; - private readonly EventProvider _initializedProvider; - private readonly CharacterUtility _characterUtility; + private readonly EventProvider _disposedProvider; + private readonly EventProvider _initializedProvider; - public IpcProviders(IDalamudPluginInterface pi, IPenumbraApi api, CharacterUtility characterUtility) + public IpcProviders(DalamudPluginInterface pi, IPenumbraApi api) { - _characterUtility = characterUtility; _disposedProvider = IpcSubscribers.Disposed.Provider(pi); _initializedProvider = IpcSubscribers.Initialized.Provider(pi); _providers = @@ -29,7 +25,6 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.GetCollectionForObject.Provider(pi, api.Collection), IpcSubscribers.SetCollection.Provider(pi, api.Collection), IpcSubscribers.SetCollectionForObject.Provider(pi, api.Collection), - IpcSubscribers.CheckCurrentChangedItemFunc.Provider(pi, api.Collection), IpcSubscribers.ConvertTextureFile.Provider(pi, api.Editing), IpcSubscribers.ConvertTextureData.Provider(pi, api.Editing), @@ -40,8 +35,6 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.CreatingCharacterBase.Provider(pi, api.GameState), IpcSubscribers.CreatedCharacterBase.Provider(pi, api.GameState), IpcSubscribers.GameObjectResourcePathResolved.Provider(pi, api.GameState), - IpcSubscribers.GetCutsceneParentIndexFunc.Provider(pi, api.GameState), - IpcSubscribers.GetGameObjectFromDrawObjectFunc.Provider(pi, api.GameState), IpcSubscribers.GetPlayerMetaManipulations.Provider(pi, api.Meta), IpcSubscribers.GetMetaManipulations.Provider(pi, api.Meta), @@ -54,19 +47,11 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.ModDeleted.Provider(pi, api.Mods), IpcSubscribers.ModAdded.Provider(pi, api.Mods), IpcSubscribers.ModMoved.Provider(pi, api.Mods), - IpcSubscribers.CreatingPcp.Provider(pi, api.Mods), - IpcSubscribers.ParsingPcp.Provider(pi, api.Mods), IpcSubscribers.GetModPath.Provider(pi, api.Mods), IpcSubscribers.SetModPath.Provider(pi, api.Mods), - IpcSubscribers.GetChangedItems.Provider(pi, api.Mods), - IpcSubscribers.GetChangedItemAdapterDictionary.Provider(pi, api.Mods), - IpcSubscribers.GetChangedItemAdapterList.Provider(pi, api.Mods), IpcSubscribers.GetAvailableModSettings.Provider(pi, api.ModSettings), IpcSubscribers.GetCurrentModSettings.Provider(pi, api.ModSettings), - IpcSubscribers.GetCurrentModSettingsWithTemp.Provider(pi, api.ModSettings), - IpcSubscribers.GetAllModSettings.Provider(pi, api.ModSettings), - IpcSubscribers.GetSettingsInAllCollections.Provider(pi, api.ModSettings), IpcSubscribers.TryInheritMod.Provider(pi, api.ModSettings), IpcSubscribers.TrySetMod.Provider(pi, api.ModSettings), IpcSubscribers.TrySetModPriority.Provider(pi, api.ModSettings), @@ -77,19 +62,16 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.ApiVersion.Provider(pi, api), new FuncProvider<(int Major, int Minor)>(pi, "Penumbra.ApiVersions", () => api.ApiVersion), // backward compatibility - new FuncProvider(pi, "Penumbra.ApiVersion", () => api.ApiVersion.Breaking), // backward compatibility + new FuncProvider(pi, "Penumbra.ApiVersion", () => api.ApiVersion.Breaking), // backward compatibility IpcSubscribers.GetModDirectory.Provider(pi, api.PluginState), IpcSubscribers.GetConfiguration.Provider(pi, api.PluginState), IpcSubscribers.ModDirectoryChanged.Provider(pi, api.PluginState), IpcSubscribers.GetEnabledState.Provider(pi, api.PluginState), IpcSubscribers.EnabledChange.Provider(pi, api.PluginState), - IpcSubscribers.SupportedFeatures.Provider(pi, api.PluginState), - IpcSubscribers.CheckSupportedFeatures.Provider(pi, api.PluginState), IpcSubscribers.RedrawObject.Provider(pi, api.Redraw), IpcSubscribers.RedrawAll.Provider(pi, api.Redraw), IpcSubscribers.GameObjectRedrawn.Provider(pi, api.Redraw), - IpcSubscribers.RedrawCollectionMembers.Provider(pi, api.Redraw), IpcSubscribers.ResolveDefaultPath.Provider(pi, api.Resolve), IpcSubscribers.ResolveInterfacePath.Provider(pi, api.Resolve), @@ -99,8 +81,6 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.ReverseResolvePlayerPath.Provider(pi, api.Resolve), IpcSubscribers.ResolvePlayerPaths.Provider(pi, api.Resolve), IpcSubscribers.ResolvePlayerPathsAsync.Provider(pi, api.Resolve), - IpcSubscribers.ResolvePath.Provider(pi, api.Resolve), - IpcSubscribers.ResolvePaths.Provider(pi, api.Resolve), IpcSubscribers.GetGameObjectResourcePaths.Provider(pi, api.ResourceTree), IpcSubscribers.GetPlayerResourcePaths.Provider(pi, api.ResourceTree), @@ -116,14 +96,6 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.AddTemporaryMod.Provider(pi, api.Temporary), IpcSubscribers.RemoveTemporaryModAll.Provider(pi, api.Temporary), IpcSubscribers.RemoveTemporaryMod.Provider(pi, api.Temporary), - IpcSubscribers.SetTemporaryModSettings.Provider(pi, api.Temporary), - IpcSubscribers.SetTemporaryModSettingsPlayer.Provider(pi, api.Temporary), - IpcSubscribers.RemoveTemporaryModSettings.Provider(pi, api.Temporary), - IpcSubscribers.RemoveTemporaryModSettingsPlayer.Provider(pi, api.Temporary), - IpcSubscribers.RemoveAllTemporaryModSettings.Provider(pi, api.Temporary), - IpcSubscribers.RemoveAllTemporaryModSettingsPlayer.Provider(pi, api.Temporary), - IpcSubscribers.QueryTemporaryModSettings.Provider(pi, api.Temporary), - IpcSubscribers.QueryTemporaryModSettingsPlayer.Provider(pi, api.Temporary), IpcSubscribers.ChangedItemTooltip.Provider(pi, api.Ui), IpcSubscribers.ChangedItemClicked.Provider(pi, api.Ui), @@ -133,24 +105,12 @@ public sealed class IpcProviders : IDisposable, IApiService IpcSubscribers.PostSettingsDraw.Provider(pi, api.Ui), IpcSubscribers.OpenMainWindow.Provider(pi, api.Ui), IpcSubscribers.CloseMainWindow.Provider(pi, api.Ui), - IpcSubscribers.RegisterSettingsSection.Provider(pi, api.Ui), - IpcSubscribers.UnregisterSettingsSection.Provider(pi, api.Ui), ]; - if (_characterUtility.Ready) - _initializedProvider.Invoke(); - else - _characterUtility.LoadingFinished.Subscribe(OnCharacterUtilityReady, CharacterUtilityFinished.Priority.IpcProvider); - } - - private void OnCharacterUtilityReady() - { _initializedProvider.Invoke(); - _characterUtility.LoadingFinished.Unsubscribe(OnCharacterUtilityReady); } public void Dispose() { - _characterUtility.LoadingFinished.Unsubscribe(OnCharacterUtilityReady); foreach (var provider in _providers) provider.Dispose(); _providers.Clear(); diff --git a/Penumbra/Api/IpcTester/CollectionsIpcTester.cs b/Penumbra/Api/IpcTester/CollectionsIpcTester.cs index f033b7c3..2679bc69 100644 --- a/Penumbra/Api/IpcTester/CollectionsIpcTester.cs +++ b/Penumbra/Api/IpcTester/CollectionsIpcTester.cs @@ -1,26 +1,26 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; using Dalamud.Interface.Utility; using Dalamud.Plugin; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Api.IpcSubscribers; using Penumbra.Collections.Manager; -using Penumbra.GameData.Data; +using Penumbra.GameData.Enums; using ImGuiClip = OtterGui.ImGuiClip; namespace Penumbra.Api.IpcTester; -public class CollectionsIpcTester(IDalamudPluginInterface pi) : IUiService +public class CollectionsIpcTester(DalamudPluginInterface pi) : IUiService { private int _objectIdx; private string _collectionIdString = string.Empty; - private Guid? _collectionId; - private bool _allowCreation = true; - private bool _allowDeletion = true; - private ApiCollectionType _type = ApiCollectionType.Yourself; + private Guid? _collectionId = null; + private bool _allowCreation = true; + private bool _allowDeletion = true; + private ApiCollectionType _type = ApiCollectionType.Yourself; private Dictionary _collections = []; private (string, ChangedItemType, uint)[] _changedItems = []; @@ -116,15 +116,11 @@ public class CollectionsIpcTester(IDalamudPluginInterface pi) : IUiService var items = new GetChangedItemsForCollection(pi).Invoke(_collectionId.GetValueOrDefault(Guid.Empty)); _changedItems = items.Select(kvp => { - var (type, id) = kvp.Value.ToApiObject(); + var (type, id) = ChangedItemExtensions.ChangedItemToTypeAndId(kvp.Value); return (kvp.Key, type, id); }).ToArray(); ImGui.OpenPopup("Changed Item List"); } - IpcTester.DrawIntro(RedrawCollectionMembers.Label, "Redraw Collection Members"); - if (ImGui.Button("Redraw##ObjectCollection")) - new RedrawCollectionMembers(pi).Invoke(collectionList[0].Id, RedrawType.Redraw); - } private void DrawChangedItemPopup() @@ -134,9 +130,9 @@ public class CollectionsIpcTester(IDalamudPluginInterface pi) : IUiService if (!p) return; - using (var table = ImRaii.Table("##ChangedItems", 3, ImGuiTableFlags.SizingFixedFit)) + using (var t = ImRaii.Table("##ChangedItems", 3, ImGuiTableFlags.SizingFixedFit)) { - if (table) + if (t) ImGuiClip.ClippedDraw(_changedItems, t => { ImGuiUtil.DrawTableColumn(t.Item1); diff --git a/Penumbra/Api/IpcTester/EditingIpcTester.cs b/Penumbra/Api/IpcTester/EditingIpcTester.cs index d754cf90..94b1e4e8 100644 --- a/Penumbra/Api/IpcTester/EditingIpcTester.cs +++ b/Penumbra/Api/IpcTester/EditingIpcTester.cs @@ -1,5 +1,5 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Plugin; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Services; @@ -8,7 +8,7 @@ using Penumbra.Api.IpcSubscribers; namespace Penumbra.Api.IpcTester; -public class EditingIpcTester(IDalamudPluginInterface pi) : IUiService +public class EditingIpcTester(DalamudPluginInterface pi) : IUiService { private string _inputPath = string.Empty; private string _inputPath2 = string.Empty; diff --git a/Penumbra/Api/IpcTester/GameStateIpcTester.cs b/Penumbra/Api/IpcTester/GameStateIpcTester.cs index 38a09714..93806162 100644 --- a/Penumbra/Api/IpcTester/GameStateIpcTester.cs +++ b/Penumbra/Api/IpcTester/GameStateIpcTester.cs @@ -1,6 +1,6 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; using Dalamud.Plugin; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.Enums; @@ -12,7 +12,7 @@ namespace Penumbra.Api.IpcTester; public class GameStateIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; public readonly EventSubscriber CharacterBaseCreating; public readonly EventSubscriber CharacterBaseCreated; public readonly EventSubscriber GameObjectResourcePathResolved; @@ -30,7 +30,7 @@ public class GameStateIpcTester : IUiService, IDisposable private int _currentCutsceneParent; private PenumbraApiEc _cutsceneError = PenumbraApiEc.Success; - public GameStateIpcTester(IDalamudPluginInterface pi) + public GameStateIpcTester(DalamudPluginInterface pi) { _pi = pi; CharacterBaseCreating = IpcSubscribers.CreatingCharacterBase.Subscriber(pi, UpdateLastCreated); @@ -134,6 +134,7 @@ public class GameStateIpcTester : IUiService, IDisposable private static unsafe string GetObjectName(nint gameObject) { var obj = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)gameObject; - return obj != null && obj->Name[0] != 0 ? new ByteString(obj->Name).ToString() : "Unknown"; + var name = obj != null ? obj->Name : null; + return name != null && *name != 0 ? new ByteString(name).ToString() : "Unknown"; } } diff --git a/Penumbra/Api/IpcTester/IpcTester.cs b/Penumbra/Api/IpcTester/IpcTester.cs index b03d7e03..201e7068 100644 --- a/Penumbra/Api/IpcTester/IpcTester.cs +++ b/Penumbra/Api/IpcTester/IpcTester.cs @@ -1,6 +1,6 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.System.Framework; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Services; using Penumbra.Api.Api; diff --git a/Penumbra/Api/IpcTester/MetaIpcTester.cs b/Penumbra/Api/IpcTester/MetaIpcTester.cs index bee1981c..3fa7de7f 100644 --- a/Penumbra/Api/IpcTester/MetaIpcTester.cs +++ b/Penumbra/Api/IpcTester/MetaIpcTester.cs @@ -1,20 +1,14 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Plugin; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Api.Api; using Penumbra.Api.IpcSubscribers; -using Penumbra.Meta.Manipulations; namespace Penumbra.Api.IpcTester; -public class MetaIpcTester(IDalamudPluginInterface pi) : IUiService +public class MetaIpcTester(DalamudPluginInterface pi) : IUiService { - private int _gameObjectIndex; - private string _metaBase64 = string.Empty; - private MetaDictionary _metaDict = new(); - private byte _parsedVersion = byte.MaxValue; + private int _gameObjectIndex; public void Draw() { @@ -23,11 +17,6 @@ public class MetaIpcTester(IDalamudPluginInterface pi) : IUiService return; ImGui.InputInt("##metaIdx", ref _gameObjectIndex, 0, 0); - if (ImUtf8.InputText("##metaText"u8, ref _metaBase64, "Base64 Metadata..."u8)) - if (!MetaApi.ConvertManips(_metaBase64, out _metaDict!, out _parsedVersion)) - _metaDict ??= new MetaDictionary(); - - using var table = ImRaii.Table(string.Empty, 3, ImGuiTableFlags.SizingFixedFit); if (!table) return; @@ -45,8 +34,5 @@ public class MetaIpcTester(IDalamudPluginInterface pi) : IUiService var base64 = new GetMetaManipulations(pi).Invoke(_gameObjectIndex); ImGui.SetClipboardText(base64); } - - IpcTester.DrawIntro(string.Empty, "Parsed Data"); - ImUtf8.Text($"Version: {_parsedVersion}, Count: {_metaDict.Count}"); } } diff --git a/Penumbra/Api/IpcTester/ModSettingsIpcTester.cs b/Penumbra/Api/IpcTester/ModSettingsIpcTester.cs index 152efa45..b117d603 100644 --- a/Penumbra/Api/IpcTester/ModSettingsIpcTester.cs +++ b/Penumbra/Api/IpcTester/ModSettingsIpcTester.cs @@ -1,9 +1,8 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Plugin; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; using Penumbra.Api.Enums; using Penumbra.Api.Helpers; using Penumbra.Api.IpcSubscribers; @@ -13,7 +12,7 @@ namespace Penumbra.Api.IpcTester; public class ModSettingsIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; public readonly EventSubscriber SettingChanged; private PenumbraApiEc _lastSettingsError = PenumbraApiEc.Success; @@ -23,22 +22,18 @@ public class ModSettingsIpcTester : IUiService, IDisposable private bool _lastSettingChangeInherited; private DateTimeOffset _lastSettingChange; - private string _settingsModDirectory = string.Empty; - private string _settingsModName = string.Empty; - private Guid? _settingsCollection; - private string _settingsCollectionName = string.Empty; - private bool _settingsIgnoreInheritance; - private bool _settingsIgnoreTemporary; - private int _settingsKey; - private bool _settingsInherit; - private bool _settingsTemporary; - private bool _settingsEnabled; - private int _settingsPriority; - private IReadOnlyDictionary? _availableSettings; - private Dictionary>? _currentSettings; - private Dictionary>, bool, bool)>? _allSettings; + private string _settingsModDirectory = string.Empty; + private string _settingsModName = string.Empty; + private Guid? _settingsCollection; + private string _settingsCollectionName = string.Empty; + private bool _settingsIgnoreInheritance; + private bool _settingsInherit; + private bool _settingsEnabled; + private int _settingsPriority; + private IReadOnlyDictionary? _availableSettings; + private Dictionary>? _currentSettings; - public ModSettingsIpcTester(IDalamudPluginInterface pi) + public ModSettingsIpcTester(DalamudPluginInterface pi) { _pi = pi; SettingChanged = ModSettingChanged.Subscriber(pi, UpdateLastModSetting); @@ -59,9 +54,7 @@ public class ModSettingsIpcTester : IUiService, IDisposable ImGui.InputTextWithHint("##settingsDir", "Mod Directory Name...", ref _settingsModDirectory, 100); ImGui.InputTextWithHint("##settingsName", "Mod Name...", ref _settingsModName, 100); ImGuiUtil.GuidInput("##settingsCollection", "Collection...", string.Empty, ref _settingsCollection, ref _settingsCollectionName); - ImUtf8.Checkbox("Ignore Inheritance"u8, ref _settingsIgnoreInheritance); - ImUtf8.Checkbox("Ignore Temporary"u8, ref _settingsIgnoreTemporary); - ImUtf8.InputScalar("Key"u8, ref _settingsKey); + ImGui.Checkbox("Ignore Inheritance", ref _settingsIgnoreInheritance); var collection = _settingsCollection.GetValueOrDefault(Guid.Empty); using var table = ImRaii.Table(string.Empty, 3, ImGuiTableFlags.SizingFixedFit); @@ -90,11 +83,10 @@ public class ModSettingsIpcTester : IUiService, IDisposable _lastSettingsError = ret.Item1; if (ret.Item1 == PenumbraApiEc.Success) { - _settingsEnabled = ret.Item2?.Item1 ?? false; - _settingsInherit = ret.Item2?.Item4 ?? true; - _settingsTemporary = false; - _settingsPriority = ret.Item2?.Item2 ?? 0; - _currentSettings = ret.Item2?.Item3; + _settingsEnabled = ret.Item2?.Item1 ?? false; + _settingsInherit = ret.Item2?.Item4 ?? true; + _settingsPriority = ret.Item2?.Item2 ?? 0; + _currentSettings = ret.Item2?.Item3; } else { @@ -102,40 +94,6 @@ public class ModSettingsIpcTester : IUiService, IDisposable } } - IpcTester.DrawIntro(GetCurrentModSettingsWithTemp.Label, "Get Current Settings With Temp"); - if (ImGui.Button("Get##CurrentTemp")) - { - var ret = new GetCurrentModSettingsWithTemp(_pi) - .Invoke(collection, _settingsModDirectory, _settingsModName, _settingsIgnoreInheritance, _settingsIgnoreTemporary, _settingsKey); - _lastSettingsError = ret.Item1; - if (ret.Item1 == PenumbraApiEc.Success) - { - _settingsEnabled = ret.Item2?.Item1 ?? false; - _settingsInherit = ret.Item2?.Item4 ?? true; - _settingsTemporary = ret.Item2?.Item5 ?? false; - _settingsPriority = ret.Item2?.Item2 ?? 0; - _currentSettings = ret.Item2?.Item3; - } - else - { - _currentSettings = null; - } - } - - IpcTester.DrawIntro(GetAllModSettings.Label, "Get All Mod Settings"); - if (ImGui.Button("Get##All")) - { - var ret = new GetAllModSettings(_pi).Invoke(collection, _settingsIgnoreInheritance, _settingsIgnoreTemporary, _settingsKey); - _lastSettingsError = ret.Item1; - _allSettings = ret.Item2; - } - - if (_allSettings != null) - { - ImGui.SameLine(); - ImUtf8.Text($"{_allSettings.Count} Mods"); - } - IpcTester.DrawIntro(TryInheritMod.Label, "Inherit Mod"); ImGui.Checkbox("##inherit", ref _settingsInherit); ImGui.SameLine(); diff --git a/Penumbra/Api/IpcTester/ModsIpcTester.cs b/Penumbra/Api/IpcTester/ModsIpcTester.cs index 9ea53366..43f397e5 100644 --- a/Penumbra/Api/IpcTester/ModsIpcTester.cs +++ b/Penumbra/Api/IpcTester/ModsIpcTester.cs @@ -1,9 +1,8 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface.Utility; using Dalamud.Plugin; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; using Penumbra.Api.Enums; using Penumbra.Api.Helpers; using Penumbra.Api.IpcSubscribers; @@ -12,19 +11,18 @@ namespace Penumbra.Api.IpcTester; public class ModsIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; - private string _modDirectory = string.Empty; - private string _modName = string.Empty; - private string _pathInput = string.Empty; - private string _newInstallPath = string.Empty; - private PenumbraApiEc _lastReloadEc; - private PenumbraApiEc _lastAddEc; - private PenumbraApiEc _lastDeleteEc; - private PenumbraApiEc _lastSetPathEc; - private PenumbraApiEc _lastInstallEc; - private Dictionary _mods = []; - private Dictionary _changedItems = []; + private string _modDirectory = string.Empty; + private string _modName = string.Empty; + private string _pathInput = string.Empty; + private string _newInstallPath = string.Empty; + private PenumbraApiEc _lastReloadEc; + private PenumbraApiEc _lastAddEc; + private PenumbraApiEc _lastDeleteEc; + private PenumbraApiEc _lastSetPathEc; + private PenumbraApiEc _lastInstallEc; + private Dictionary _mods = []; public readonly EventSubscriber DeleteSubscriber; public readonly EventSubscriber AddSubscriber; @@ -38,7 +36,7 @@ public class ModsIpcTester : IUiService, IDisposable private string _lastMovedModFrom = string.Empty; private string _lastMovedModTo = string.Empty; - public ModsIpcTester(IDalamudPluginInterface pi) + public ModsIpcTester(DalamudPluginInterface pi) { _pi = pi; DeleteSubscriber = ModDeleted.Subscriber(pi, s => @@ -122,14 +120,6 @@ public class ModsIpcTester : IUiService, IDisposable ImGui.SameLine(); ImGui.TextUnformatted(_lastDeleteEc.ToString()); - IpcTester.DrawIntro(GetChangedItems.Label, "Get Changed Items"); - DrawChangedItemsPopup(); - if (ImUtf8.Button("Get##ChangedItems"u8)) - { - _changedItems = new GetChangedItems(_pi).Invoke(_modDirectory, _modName); - ImUtf8.OpenPopup("ChangedItems"u8); - } - IpcTester.DrawIntro(GetModPath.Label, "Current Path"); var (ec, path, def, nameDef) = new GetModPath(_pi).Invoke(_modDirectory, _modName); ImGui.TextUnformatted($"{path} ({(def ? "Custom" : "Default")} Path, {(nameDef ? "Custom" : "Default")} Name) [{ec}]"); @@ -167,18 +157,4 @@ public class ModsIpcTester : IUiService, IDisposable if (ImGui.Button("Close", -Vector2.UnitX) || !ImGui.IsWindowFocused()) ImGui.CloseCurrentPopup(); } - - private void DrawChangedItemsPopup() - { - ImGui.SetNextWindowSize(ImGuiHelpers.ScaledVector2(500, 500)); - using var p = ImUtf8.Popup("ChangedItems"u8); - if (!p) - return; - - foreach (var (name, data) in _changedItems) - ImUtf8.Text($"{name}: {data}"); - - if (ImUtf8.Button("Close"u8, -Vector2.UnitX) || !ImGui.IsWindowFocused()) - ImGui.CloseCurrentPopup(); - } } diff --git a/Penumbra/Api/IpcTester/PluginStateIpcTester.cs b/Penumbra/Api/IpcTester/PluginStateIpcTester.cs index 073305d0..984f17b1 100644 --- a/Penumbra/Api/IpcTester/PluginStateIpcTester.cs +++ b/Penumbra/Api/IpcTester/PluginStateIpcTester.cs @@ -1,11 +1,10 @@ using Dalamud.Interface; using Dalamud.Interface.Utility; using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; using Penumbra.Api.Helpers; using Penumbra.Api.IpcSubscribers; @@ -13,7 +12,7 @@ namespace Penumbra.Api.IpcTester; public class PluginStateIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; public readonly EventSubscriber ModDirectoryChanged; public readonly EventSubscriber Initialized; public readonly EventSubscriber Disposed; @@ -27,13 +26,10 @@ public class PluginStateIpcTester : IUiService, IDisposable private readonly List _initializedList = []; private readonly List _disposedList = []; - private string _requiredFeatureString = string.Empty; - private string[] _requiredFeatures = []; - private DateTimeOffset _lastEnabledChange = DateTimeOffset.UnixEpoch; private bool? _lastEnabledValue; - public PluginStateIpcTester(IDalamudPluginInterface pi) + public PluginStateIpcTester(DalamudPluginInterface pi) { _pi = pi; ModDirectoryChanged = IpcSubscribers.ModDirectoryChanged.Subscriber(pi, UpdateModDirectoryChanged); @@ -52,15 +48,12 @@ public class PluginStateIpcTester : IUiService, IDisposable EnabledChange.Dispose(); } - public void Draw() { using var _ = ImRaii.TreeNode("Plugin State"); if (!_) return; - if (ImUtf8.InputText("Required Features"u8, ref _requiredFeatureString)) - _requiredFeatures = _requiredFeatureString.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); using var table = ImRaii.Table(string.Empty, 3, ImGuiTableFlags.SizingFixedFit); if (!table) return; @@ -78,12 +71,6 @@ public class PluginStateIpcTester : IUiService, IDisposable IpcTester.DrawIntro(IpcSubscribers.EnabledChange.Label, "Last Change"); ImGui.TextUnformatted(_lastEnabledValue is { } v ? $"{_lastEnabledChange} (to {v})" : "Never"); - IpcTester.DrawIntro(SupportedFeatures.Label, "Supported Features"); - ImUtf8.Text(string.Join(", ", new SupportedFeatures(_pi).Invoke())); - - IpcTester.DrawIntro(CheckSupportedFeatures.Label, "Missing Features"); - ImUtf8.Text(string.Join(", ", new CheckSupportedFeatures(_pi).Invoke(_requiredFeatures))); - DrawConfigPopup(); IpcTester.DrawIntro(GetConfiguration.Label, "Configuration"); if (ImGui.Button("Get")) diff --git a/Penumbra/Api/IpcTester/RedrawingIpcTester.cs b/Penumbra/Api/IpcTester/RedrawingIpcTester.cs index 6b853ed2..801f0b97 100644 --- a/Penumbra/Api/IpcTester/RedrawingIpcTester.cs +++ b/Penumbra/Api/IpcTester/RedrawingIpcTester.cs @@ -1,6 +1,6 @@ using Dalamud.Plugin; using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.Enums; @@ -13,14 +13,14 @@ namespace Penumbra.Api.IpcTester; public class RedrawingIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; private readonly ObjectManager _objects; public readonly EventSubscriber Redrawn; private int _redrawIndex; private string _lastRedrawnString = "None"; - public RedrawingIpcTester(IDalamudPluginInterface pi, ObjectManager objects) + public RedrawingIpcTester(DalamudPluginInterface pi, ObjectManager objects) { _pi = pi; _objects = objects; diff --git a/Penumbra/Api/IpcTester/ResolveIpcTester.cs b/Penumbra/Api/IpcTester/ResolveIpcTester.cs index 9fc5bfc7..978ed8d6 100644 --- a/Penumbra/Api/IpcTester/ResolveIpcTester.cs +++ b/Penumbra/Api/IpcTester/ResolveIpcTester.cs @@ -1,5 +1,5 @@ using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.IpcSubscribers; @@ -7,7 +7,7 @@ using Penumbra.String.Classes; namespace Penumbra.Api.IpcTester; -public class ResolveIpcTester(IDalamudPluginInterface pi) : IUiService +public class ResolveIpcTester(DalamudPluginInterface pi) : IUiService { private string _currentResolvePath = string.Empty; private string _currentReversePath = string.Empty; diff --git a/Penumbra/Api/IpcTester/ResourceTreeIpcTester.cs b/Penumbra/Api/IpcTester/ResourceTreeIpcTester.cs index e6c8d52e..1f57fc9d 100644 --- a/Penumbra/Api/IpcTester/ResourceTreeIpcTester.cs +++ b/Penumbra/Api/IpcTester/ResourceTreeIpcTester.cs @@ -1,10 +1,9 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Game.ClientState.Objects.Enums; using Dalamud.Interface; using Dalamud.Interface.Utility; using Dalamud.Plugin; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.Enums; @@ -16,7 +15,7 @@ using Penumbra.GameData.Structs; namespace Penumbra.Api.IpcTester; -public class ResourceTreeIpcTester(IDalamudPluginInterface pi, ObjectManager objects) : IUiService +public class ResourceTreeIpcTester(DalamudPluginInterface pi, ObjectManager objects) : IUiService { private readonly Stopwatch _stopwatch = new(); diff --git a/Penumbra/Api/IpcTester/TemporaryIpcTester.cs b/Penumbra/Api/IpcTester/TemporaryIpcTester.cs index d46c5728..a8405eb2 100644 --- a/Penumbra/Api/IpcTester/TemporaryIpcTester.cs +++ b/Penumbra/Api/IpcTester/TemporaryIpcTester.cs @@ -1,15 +1,13 @@ using Dalamud.Interface; using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Api.Api; using Penumbra.Api.Enums; using Penumbra.Api.IpcSubscribers; using Penumbra.Collections.Manager; +using Penumbra.Meta.Manipulations; using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Services; @@ -17,7 +15,7 @@ using Penumbra.Services; namespace Penumbra.Api.IpcTester; public class TemporaryIpcTester( - IDalamudPluginInterface pi, + DalamudPluginInterface pi, ModManager modManager, CollectionManager collections, TempModManager tempMods, @@ -28,17 +26,13 @@ public class TemporaryIpcTester( { public Guid LastCreatedCollectionId = Guid.Empty; - private readonly bool _debug = Assembly.GetAssembly(typeof(TemporaryIpcTester))?.GetName().Version?.Major >= 9; - private Guid? _tempGuid; private string _tempCollectionName = string.Empty; private string _tempCollectionGuidName = string.Empty; private string _tempModName = string.Empty; - private string _modDirectory = string.Empty; private string _tempGamePath = "test/game/path.mtrl"; private string _tempFilePath = "test/success.mtrl"; private string _tempManipulation = string.Empty; - private string _identity = string.Empty; private PenumbraApiEc _lastTempError; private int _tempActorIndex; private bool _forceOverwrite; @@ -49,15 +43,13 @@ public class TemporaryIpcTester( if (!_) return; - ImGui.InputTextWithHint("##identity", "Identity...", ref _identity, 128); ImGui.InputTextWithHint("##tempCollection", "Collection Name...", ref _tempCollectionName, 128); ImGuiUtil.GuidInput("##guid", "Collection GUID...", string.Empty, ref _tempGuid, ref _tempCollectionGuidName); ImGui.InputInt("##tempActorIndex", ref _tempActorIndex, 0, 0); - ImGui.InputTextWithHint("##tempMod", "Temporary Mod Name...", ref _tempModName, 32); - ImGui.InputTextWithHint("##mod", "Existing Mod Name...", ref _modDirectory, 256); - ImGui.InputTextWithHint("##tempGame", "Game Path...", ref _tempGamePath, 256); - ImGui.InputTextWithHint("##tempFile", "File Path...", ref _tempFilePath, 256); - ImUtf8.InputText("##tempManip"u8, ref _tempManipulation, "Manipulation Base64 String..."u8); + ImGui.InputTextWithHint("##tempMod", "Temporary Mod Name...", ref _tempModName, 32); + ImGui.InputTextWithHint("##tempGame", "Game Path...", ref _tempGamePath, 256); + ImGui.InputTextWithHint("##tempFile", "File Path...", ref _tempFilePath, 256); + ImGui.InputTextWithHint("##tempManip", "Manipulation Base64 String...", ref _tempManipulation, 256); ImGui.Checkbox("Force Character Collection Overwrite", ref _forceOverwrite); using var table = ImRaii.Table(string.Empty, 3, ImGuiTableFlags.SizingFixedFit); @@ -75,7 +67,7 @@ public class TemporaryIpcTester( IpcTester.DrawIntro(CreateTemporaryCollection.Label, "Create Temporary Collection"); if (ImGui.Button("Create##Collection")) { - _lastTempError = new CreateTemporaryCollection(pi).Invoke(_identity, _tempCollectionName, out LastCreatedCollectionId); + LastCreatedCollectionId = new CreateTemporaryCollection(pi).Invoke(_tempCollectionName); if (_tempGuid == null) { _tempGuid = LastCreatedCollectionId; @@ -108,8 +100,9 @@ public class TemporaryIpcTester( !collections.Storage.ByName(_tempModName, out var copyCollection)) && copyCollection is { HasCache: true }) { - var files = copyCollection.ResolvedFiles.ToDictionary(kvp => kvp.Key.ToString(), kvp => kvp.Value.Path.ToString()); - var manips = MetaApi.CompressMetaManipulations(copyCollection); + var files = copyCollection.ResolvedFiles.ToDictionary(kvp => kvp.Key.ToString(), kvp => kvp.Value.Path.ToString()); + var manips = Functions.ToCompressedBase64(copyCollection.MetaCache?.Manipulations.ToArray() ?? Array.Empty(), + MetaManipulation.CurrentVersion); _lastTempError = new AddTemporaryMod(pi).Invoke(_tempModName, guid, files, manips, 999); } @@ -126,124 +119,15 @@ public class TemporaryIpcTester( IpcTester.DrawIntro(RemoveTemporaryModAll.Label, "Remove Temporary Mod from all Collections"); if (ImGui.Button("Remove##ModAll")) _lastTempError = new RemoveTemporaryModAll(pi).Invoke(_tempModName, int.MaxValue); - - IpcTester.DrawIntro(SetTemporaryModSettings.Label, "Set Temporary Mod Settings (to default) in specific Collection"); - if (ImUtf8.Button("Set##SetTemporary"u8)) - _lastTempError = new SetTemporaryModSettings(pi).Invoke(guid, _modDirectory, false, true, 1337, - new Dictionary>(), - "IPC Tester", 1337); - - IpcTester.DrawIntro(SetTemporaryModSettingsPlayer.Label, "Set Temporary Mod Settings (to default) in game object collection"); - if (ImUtf8.Button("Set##SetTemporaryPlayer"u8)) - _lastTempError = new SetTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, _modDirectory, false, true, 1337, - new Dictionary>(), - "IPC Tester", 1337); - - IpcTester.DrawIntro(RemoveTemporaryModSettings.Label, "Remove Temporary Mod Settings from specific Collection"); - if (ImUtf8.Button("Remove##RemoveTemporary"u8)) - _lastTempError = new RemoveTemporaryModSettings(pi).Invoke(guid, _modDirectory, 1337); - ImGui.SameLine(); - if (ImUtf8.Button("Remove (Wrong Key)##RemoveTemporary"u8)) - _lastTempError = new RemoveTemporaryModSettings(pi).Invoke(guid, _modDirectory, 1338); - - IpcTester.DrawIntro(RemoveTemporaryModSettingsPlayer.Label, "Remove Temporary Mod Settings from game object Collection"); - if (ImUtf8.Button("Remove##RemoveTemporaryPlayer"u8)) - _lastTempError = new RemoveTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, _modDirectory, 1337); - ImGui.SameLine(); - if (ImUtf8.Button("Remove (Wrong Key)##RemoveTemporaryPlayer"u8)) - _lastTempError = new RemoveTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, _modDirectory, 1338); - - IpcTester.DrawIntro(RemoveAllTemporaryModSettings.Label, "Remove All Temporary Mod Settings from specific Collection"); - if (ImUtf8.Button("Remove##RemoveAllTemporary"u8)) - _lastTempError = new RemoveAllTemporaryModSettings(pi).Invoke(guid, 1337); - ImGui.SameLine(); - if (ImUtf8.Button("Remove (Wrong Key)##RemoveAllTemporary"u8)) - _lastTempError = new RemoveAllTemporaryModSettings(pi).Invoke(guid, 1338); - - IpcTester.DrawIntro(RemoveAllTemporaryModSettingsPlayer.Label, "Remove All Temporary Mod Settings from game object Collection"); - if (ImUtf8.Button("Remove##RemoveAllTemporaryPlayer"u8)) - _lastTempError = new RemoveAllTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, 1337); - ImGui.SameLine(); - if (ImUtf8.Button("Remove (Wrong Key)##RemoveAllTemporaryPlayer"u8)) - _lastTempError = new RemoveAllTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, 1338); - - IpcTester.DrawIntro(QueryTemporaryModSettings.Label, "Query Temporary Mod Settings from specific Collection"); - ImUtf8.Button("Query##QueryTemporaryModSettings"u8); - if (ImGui.IsItemHovered()) - { - _lastTempError = new QueryTemporaryModSettings(pi).Invoke(guid, _modDirectory, out var settings, out var source, 1337); - DrawTooltip(settings, source); - } - - ImGui.SameLine(); - ImUtf8.Button("Query (Wrong Key)##RemoveAllTemporary"u8); - if (ImGui.IsItemHovered()) - { - _lastTempError = new QueryTemporaryModSettings(pi).Invoke(guid, _modDirectory, out var settings, out var source, 1338); - DrawTooltip(settings, source); - } - - IpcTester.DrawIntro(QueryTemporaryModSettingsPlayer.Label, "Query Temporary Mod Settings from game object Collection"); - ImUtf8.Button("Query##QueryTemporaryModSettingsPlayer"u8); - if (ImGui.IsItemHovered()) - { - _lastTempError = - new QueryTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, _modDirectory, out var settings, out var source, 1337); - DrawTooltip(settings, source); - } - - ImGui.SameLine(); - ImUtf8.Button("Query (Wrong Key)##RemoveAllTemporaryPlayer"u8); - if (ImGui.IsItemHovered()) - { - _lastTempError = - new QueryTemporaryModSettingsPlayer(pi).Invoke(_tempActorIndex, _modDirectory, out var settings, out var source, 1338); - DrawTooltip(settings, source); - } - - void DrawTooltip((bool ForceInherit, bool Enabled, int Priority, Dictionary> Settings)? settings, string source) - { - using var tt = ImUtf8.Tooltip(); - ImUtf8.Text($"Query returned {_lastTempError}"); - if (settings != null) - ImUtf8.Text($"Settings created by {(source.Length == 0 ? "Unknown Source" : source)}:"); - else - ImUtf8.Text(source.Length > 0 ? $"Locked by {source}." : "No settings exist."); - ImGui.Separator(); - if (settings == null) - { - - return; - } - - using (ImUtf8.Group()) - { - ImUtf8.Text("Force Inherit"u8); - ImUtf8.Text("Enabled"u8); - ImUtf8.Text("Priority"u8); - foreach (var group in settings.Value.Settings.Keys) - ImUtf8.Text(group); - } - - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.Text($"{settings.Value.ForceInherit}"); - ImUtf8.Text($"{settings.Value.Enabled}"); - ImUtf8.Text($"{settings.Value.Priority}"); - foreach (var group in settings.Value.Settings.Values) - ImUtf8.Text(string.Join("; ", group)); - } - } } public void DrawCollections() { - using var collTree = ImUtf8.TreeNode("Temporary Collections##TempCollections"u8); + using var collTree = ImRaii.TreeNode("Temporary Collections##TempCollections"); if (!collTree) return; - using var table = ImUtf8.Table("##collTree"u8, 6, ImGuiTableFlags.SizingFixedFit); + using var table = ImRaii.Table("##collTree", 6, ImGuiTableFlags.SizingFixedFit); if (!table) return; @@ -254,16 +138,16 @@ public class TemporaryIpcTester( var character = tempCollections.Collections.Where(p => p.Collection == collection).Select(p => p.DisplayName) .FirstOrDefault() ?? "Unknown"; - if (_debug && ImUtf8.Button("Save##Collection"u8)) + if (ImGui.Button("Save##Collection")) TemporaryMod.SaveTempCollection(config, saveService, modManager, collection, character); using (ImRaii.PushFont(UiBuilder.MonoFont)) { ImGui.TableNextColumn(); - ImGuiUtil.CopyOnClickSelectable(collection.Identity.Identifier); + ImGuiUtil.CopyOnClickSelectable(collection.Identifier); } - ImGuiUtil.DrawTableColumn(collection.Identity.Name); + ImGuiUtil.DrawTableColumn(collection.Name); ImGuiUtil.DrawTableColumn(collection.ResolvedFiles.Count.ToString()); ImGuiUtil.DrawTableColumn(collection.MetaCache?.Count.ToString() ?? "0"); ImGuiUtil.DrawTableColumn(string.Join(", ", @@ -284,7 +168,7 @@ public class TemporaryIpcTester( foreach (var mod in list) { ImGui.TableNextColumn(); - ImGui.TextUnformatted(mod.Name.Text); + ImGui.TextUnformatted(mod.Name); ImGui.TableNextColumn(); ImGui.TextUnformatted(mod.Priority.ToString()); ImGui.TableNextColumn(); @@ -303,8 +187,8 @@ public class TemporaryIpcTester( if (ImGui.IsItemHovered()) { using var tt = ImRaii.Tooltip(); - foreach (var identifier in mod.Default.Manipulations.Identifiers) - ImGui.TextUnformatted(identifier.ToString()); + foreach (var manip in mod.Default.Manipulations) + ImGui.TextUnformatted(manip.ToString()); } } } @@ -313,7 +197,7 @@ public class TemporaryIpcTester( { PrintList("All", tempMods.ModsForAllCollections); foreach (var (collection, list) in tempMods.Mods) - PrintList(collection.Identity.Name, list); + PrintList(collection.Name, list); } } } diff --git a/Penumbra/Api/IpcTester/UiIpcTester.cs b/Penumbra/Api/IpcTester/UiIpcTester.cs index 852339c9..a2c36938 100644 --- a/Penumbra/Api/IpcTester/UiIpcTester.cs +++ b/Penumbra/Api/IpcTester/UiIpcTester.cs @@ -1,5 +1,5 @@ using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Api.Enums; @@ -10,7 +10,7 @@ namespace Penumbra.Api.IpcTester; public class UiIpcTester : IUiService, IDisposable { - private readonly IDalamudPluginInterface _pi; + private readonly DalamudPluginInterface _pi; public readonly EventSubscriber PreSettingsTabBar; public readonly EventSubscriber PreSettingsPanel; public readonly EventSubscriber PostEnabled; @@ -28,7 +28,7 @@ public class UiIpcTester : IUiService, IDisposable private string _modName = string.Empty; private PenumbraApiEc _ec = PenumbraApiEc.Success; - public UiIpcTester(IDalamudPluginInterface pi) + public UiIpcTester(DalamudPluginInterface pi) { _pi = pi; PreSettingsTabBar = IpcSubscribers.PreSettingsTabBarDraw.Subscriber(pi, UpdateLastDrawnMod); diff --git a/Penumbra/Api/ModChangedItemAdapter.cs b/Penumbra/Api/ModChangedItemAdapter.cs deleted file mode 100644 index 8d2d473c..00000000 --- a/Penumbra/Api/ModChangedItemAdapter.cs +++ /dev/null @@ -1,103 +0,0 @@ -using Penumbra.GameData.Data; -using Penumbra.Mods.Manager; - -namespace Penumbra.Api; - -public sealed class ModChangedItemAdapter(WeakReference storage) - : IReadOnlyDictionary>, - IReadOnlyList<(string ModDirectory, IReadOnlyDictionary ChangedItems)> -{ - IEnumerator<(string ModDirectory, IReadOnlyDictionary ChangedItems)> - IEnumerable<(string ModDirectory, IReadOnlyDictionary ChangedItems)>.GetEnumerator() - => Storage.Select(m => (m.Identifier, (IReadOnlyDictionary)new ChangedItemDictionaryAdapter(m.ChangedItems))) - .GetEnumerator(); - - public IEnumerator>> GetEnumerator() - => Storage.Select(m => new KeyValuePair>(m.Identifier, - new ChangedItemDictionaryAdapter(m.ChangedItems))) - .GetEnumerator(); - - IEnumerator IEnumerable.GetEnumerator() - => GetEnumerator(); - - public int Count - => Storage.Count; - - public bool ContainsKey(string key) - => Storage.TryGetMod(key, string.Empty, out _); - - public bool TryGetValue(string key, [NotNullWhen(true)] out IReadOnlyDictionary? value) - { - if (Storage.TryGetMod(key, string.Empty, out var mod)) - { - value = new ChangedItemDictionaryAdapter(mod.ChangedItems); - return true; - } - - value = null; - return false; - } - - public IReadOnlyDictionary this[string key] - => TryGetValue(key, out var v) ? v : throw new KeyNotFoundException(); - - (string ModDirectory, IReadOnlyDictionary ChangedItems) - IReadOnlyList<(string ModDirectory, IReadOnlyDictionary ChangedItems)>.this[int index] - { - get - { - var m = Storage[index]; - return (m.Identifier, new ChangedItemDictionaryAdapter(m.ChangedItems)); - } - } - - public IEnumerable Keys - => Storage.Select(m => m.Identifier); - - public IEnumerable> Values - => Storage.Select(m => new ChangedItemDictionaryAdapter(m.ChangedItems)); - - private ModStorage Storage - { - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - get => storage.TryGetTarget(out var t) - ? t - : throw new ObjectDisposedException("The underlying mod storage of this IPC container was disposed."); - } - - private sealed class ChangedItemDictionaryAdapter(SortedList data) : IReadOnlyDictionary - { - public IEnumerator> GetEnumerator() - => data.Select(d => new KeyValuePair(d.Key, d.Value?.ToInternalObject())).GetEnumerator(); - - IEnumerator IEnumerable.GetEnumerator() - => GetEnumerator(); - - public int Count - => data.Count; - - public bool ContainsKey(string key) - => data.ContainsKey(key); - - public bool TryGetValue(string key, out object? value) - { - if (data.TryGetValue(key, out var v)) - { - value = v?.ToInternalObject(); - return true; - } - - value = null; - return false; - } - - public object? this[string key] - => data[key]?.ToInternalObject(); - - public IEnumerable Keys - => data.Keys; - - public IEnumerable Values - => data.Values.Select(v => v?.ToInternalObject()); - } -} diff --git a/Penumbra/Api/TempModManager.cs b/Penumbra/Api/TempModManager.cs index b3c6066a..aee2b447 100644 --- a/Penumbra/Api/TempModManager.cs +++ b/Penumbra/Api/TempModManager.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Meta.Manipulations; @@ -19,7 +18,7 @@ public enum RedirectResult FilteredGamePath = 3, } -public class TempModManager : IDisposable, IService +public class TempModManager : IDisposable { private readonly CommunicatorService _communicator; @@ -44,7 +43,7 @@ public class TempModManager : IDisposable, IService => _modsForAllCollections; public RedirectResult Register(string tag, ModCollection? collection, Dictionary dict, - MetaDictionary manips, ModPriority priority) + HashSet manips, ModPriority priority) { var mod = GetOrCreateMod(tag, collection, priority, out var created); Penumbra.Log.Verbose($"{(created ? "Created" : "Changed")} temporary Mod {mod.Name}."); @@ -85,13 +84,13 @@ public class TempModManager : IDisposable, IService { if (removed) { - Penumbra.Log.Verbose($"Removing temporary Mod {mod.Name} from {collection.Identity.AnonymizedName}."); + Penumbra.Log.Verbose($"Removing temporary Mod {mod.Name} from {collection.AnonymizedName}."); collection.Remove(mod); _communicator.ModSettingChanged.Invoke(collection, ModSettingChange.TemporaryMod, null, Setting.False, 0, false); } else { - Penumbra.Log.Verbose($"Adding {(created ? "new " : string.Empty)}temporary Mod {mod.Name} to {collection.Identity.AnonymizedName}."); + Penumbra.Log.Verbose($"Adding {(created ? "new " : string.Empty)}temporary Mod {mod.Name} to {collection.AnonymizedName}."); collection.Apply(mod, created); _communicator.ModSettingChanged.Invoke(collection, ModSettingChange.TemporaryMod, null, Setting.True, 0, false); } diff --git a/Penumbra/ChangedItemMode.cs b/Penumbra/ChangedItemMode.cs deleted file mode 100644 index ddb79ee0..00000000 --- a/Penumbra/ChangedItemMode.cs +++ /dev/null @@ -1,57 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Text; - -namespace Penumbra; - -public enum ChangedItemMode -{ - GroupedCollapsed, - GroupedExpanded, - Alphabetical, -} - -public static class ChangedItemModeExtensions -{ - public static ReadOnlySpan ToName(this ChangedItemMode mode) - => mode switch - { - ChangedItemMode.GroupedCollapsed => "Grouped (Collapsed)"u8, - ChangedItemMode.GroupedExpanded => "Grouped (Expanded)"u8, - ChangedItemMode.Alphabetical => "Alphabetical"u8, - _ => "Error"u8, - }; - - public static ReadOnlySpan ToTooltip(this ChangedItemMode mode) - => mode switch - { - ChangedItemMode.GroupedCollapsed => - "Display items as groups by their model and slot. Collapse those groups to a single item by default. Prefers items with more changes affecting them or configured items as the main item."u8, - ChangedItemMode.GroupedExpanded => - "Display items as groups by their model and slot. Expand those groups showing all items by default. Prefers items with more changes affecting them or configured items as the main item."u8, - ChangedItemMode.Alphabetical => "Display all changed items in a single list sorted alphabetically."u8, - _ => ""u8, - }; - - public static bool DrawCombo(ReadOnlySpan label, ChangedItemMode value, float width, Action setter) - { - ImGui.SetNextItemWidth(width); - using var combo = ImUtf8.Combo(label, value.ToName()); - if (!combo) - return false; - - var ret = false; - foreach (var newValue in Enum.GetValues()) - { - var selected = ImUtf8.Selectable(newValue.ToName(), newValue == value); - if (selected) - { - ret = true; - setter(newValue); - } - - ImUtf8.HoverTooltip(newValue.ToTooltip()); - } - - return ret; - } -} diff --git a/Penumbra/Collections/Cache/AtchCache.cs b/Penumbra/Collections/Cache/AtchCache.cs deleted file mode 100644 index 10990553..00000000 --- a/Penumbra/Collections/Cache/AtchCache.cs +++ /dev/null @@ -1,121 +0,0 @@ -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.AtchStructs; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Collections.Cache; - -public sealed class AtchCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) -{ - private readonly Dictionary)> _atchFiles = []; - - public bool HasFile(GenderRace gr) - => _atchFiles.ContainsKey(gr); - - public bool GetFile(GenderRace gr, [NotNullWhen(true)] out AtchFile? file) - { - if (!_atchFiles.TryGetValue(gr, out var p)) - { - file = null; - return false; - } - - file = p.Item1; - return true; - } - - public void Reset() - { - foreach (var (_, (_, set)) in _atchFiles) - set.Clear(); - - _atchFiles.Clear(); - Clear(); - } - - protected override void ApplyModInternal(AtchIdentifier identifier, AtchEntry entry) - { - Collection.Counters.IncrementAtch(); - ApplyFile(identifier, entry); - } - - private void ApplyFile(AtchIdentifier identifier, AtchEntry entry) - { - try - { - if (!_atchFiles.TryGetValue(identifier.GenderRace, out var pair)) - { - if (!Manager.AtchManager.AtchFileBase.TryGetValue(identifier.GenderRace, out var baseFile)) - throw new Exception($"Invalid Atch File for {identifier.GenderRace.ToName()} requested."); - - pair = (baseFile.Clone(), []); - } - - - if (!Apply(pair.Item1, identifier, entry)) - return; - - pair.Item2.Add(identifier); - _atchFiles[identifier.GenderRace] = pair; - } - catch (Exception e) - { - Penumbra.Log.Error($"Could not apply ATCH Manipulation {identifier}:\n{e}"); - } - } - - protected override void RevertModInternal(AtchIdentifier identifier) - { - Collection.Counters.IncrementAtch(); - if (!_atchFiles.TryGetValue(identifier.GenderRace, out var pair)) - return; - - if (!pair.Item2.Remove(identifier)) - return; - - if (pair.Item2.Count == 0) - { - _atchFiles.Remove(identifier.GenderRace); - return; - } - - var def = GetDefault(Manager, identifier); - if (def == null) - throw new Exception($"Reverting an .atch mod had no default value for the identifier to revert to."); - - Apply(pair.Item1, identifier, def.Value); - } - - public static AtchEntry? GetDefault(MetaFileManager manager, AtchIdentifier identifier) - { - if (!manager.AtchManager.AtchFileBase.TryGetValue(identifier.GenderRace, out var baseFile)) - return null; - - if (baseFile.Points.FirstOrDefault(p => p.Type == identifier.Type) is not { } point) - return null; - - if (point.Entries.Length <= identifier.EntryIndex) - return null; - - return point.Entries[identifier.EntryIndex]; - } - - public static bool Apply(AtchFile file, AtchIdentifier identifier, in AtchEntry entry) - { - if (file.Points.FirstOrDefault(p => p.Type == identifier.Type) is not { } point) - return false; - - if (point.Entries.Length <= identifier.EntryIndex) - return false; - - point.Entries[identifier.EntryIndex] = entry; - return true; - } - - protected override void Dispose(bool _) - { - Clear(); - _atchFiles.Clear(); - } -} diff --git a/Penumbra/Collections/Cache/AtrCache.cs b/Penumbra/Collections/Cache/AtrCache.cs deleted file mode 100644 index b017da32..00000000 --- a/Penumbra/Collections/Cache/AtrCache.cs +++ /dev/null @@ -1,65 +0,0 @@ -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Collections.Cache; - -public sealed class AtrCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) -{ - public bool ShouldBeDisabled(in ShapeAttributeString attribute, HumanSlot slot, PrimaryId id, GenderRace genderRace) - => DisabledCount > 0 && _atrData.TryGetValue(attribute, out var value) && value.CheckEntry(slot, id, genderRace) is false; - - public int EnabledCount { get; private set; } - public int DisabledCount { get; private set; } - - - internal IReadOnlyDictionary Data - => _atrData; - - private readonly Dictionary _atrData = []; - - public void Reset() - { - Clear(); - _atrData.Clear(); - DisabledCount = 0; - EnabledCount = 0; - } - - protected override void Dispose(bool _) - => Reset(); - - protected override void ApplyModInternal(AtrIdentifier identifier, AtrEntry entry) - { - if (!_atrData.TryGetValue(identifier.Attribute, out var value)) - { - value = []; - _atrData.Add(identifier.Attribute, value); - } - - if (value.TrySet(identifier.Slot, identifier.Id, identifier.GenderRaceCondition, entry.Value, out _)) - { - if (entry.Value) - ++EnabledCount; - else - ++DisabledCount; - } - } - - protected override void RevertModInternal(AtrIdentifier identifier) - { - if (!_atrData.TryGetValue(identifier.Attribute, out var value)) - return; - - if (value.TrySet(identifier.Slot, identifier.Id, identifier.GenderRaceCondition, null, out var which)) - { - if (which) - --EnabledCount; - else - --DisabledCount; - if (value.IsEmpty) - _atrData.Remove(identifier.Attribute); - } - } -} diff --git a/Penumbra/Collections/Cache/CmpCache.cs b/Penumbra/Collections/Cache/CmpCache.cs new file mode 100644 index 00000000..470cadd4 --- /dev/null +++ b/Penumbra/Collections/Cache/CmpCache.cs @@ -0,0 +1,56 @@ +using OtterGui.Filesystem; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; +using Penumbra.Meta; +using Penumbra.Meta.Files; +using Penumbra.Meta.Manipulations; + +namespace Penumbra.Collections.Cache; + +public struct CmpCache : IDisposable +{ + private CmpFile? _cmpFile = null; + private readonly List _cmpManipulations = new(); + + public CmpCache() + { } + + public void SetFiles(MetaFileManager manager) + => manager.SetFile(_cmpFile, MetaIndex.HumanCmp); + + public MetaList.MetaReverter TemporarilySetFiles(MetaFileManager manager) + => manager.TemporarilySetFile(_cmpFile, MetaIndex.HumanCmp); + + public void Reset() + { + if (_cmpFile == null) + return; + + _cmpFile.Reset(_cmpManipulations.Select(m => (m.SubRace, m.Attribute))); + _cmpManipulations.Clear(); + } + + public bool ApplyMod(MetaFileManager manager, RspManipulation manip) + { + _cmpManipulations.AddOrReplace(manip); + _cmpFile ??= new CmpFile(manager); + return manip.Apply(_cmpFile); + } + + public bool RevertMod(MetaFileManager manager, RspManipulation manip) + { + if (!_cmpManipulations.Remove(manip)) + return false; + + var def = CmpFile.GetDefault(manager, manip.SubRace, manip.Attribute); + manip = new RspManipulation(manip.SubRace, manip.Attribute, def); + return manip.Apply(_cmpFile!); + } + + public void Dispose() + { + _cmpFile?.Dispose(); + _cmpFile = null; + _cmpManipulations.Clear(); + } +} diff --git a/Penumbra/Collections/Cache/CollectionCache.cs b/Penumbra/Collections/Cache/CollectionCache.cs index 8294624b..4d8d0b4a 100644 --- a/Penumbra/Collections/Cache/CollectionCache.cs +++ b/Penumbra/Collections/Cache/CollectionCache.cs @@ -1,4 +1,4 @@ -using Dalamud.Interface.ImGuiNotification; +using OtterGui; using OtterGui.Classes; using Penumbra.Meta.Manipulations; using Penumbra.Mods; @@ -6,8 +6,6 @@ using Penumbra.Communication; using Penumbra.Mods.Editor; using Penumbra.String.Classes; using Penumbra.Util; -using Penumbra.GameData.Data; -using OtterGui.Extensions; namespace Penumbra.Collections.Cache; @@ -20,19 +18,19 @@ public record ModConflicts(IMod Mod2, List Conflicts, bool HasPriority, /// public sealed class CollectionCache : IDisposable { - private readonly CollectionCacheManager _manager; - private readonly ModCollection _collection; - public readonly CollectionModData ModData = new(); - private readonly SortedList, IIdentifiedObjectData)> _changedItems = []; - public readonly ConcurrentDictionary ResolvedFiles = new(); - public readonly CustomResourceCache CustomResources; - public readonly MetaCache Meta; - public readonly Dictionary> ConflictDict = []; + private readonly CollectionCacheManager _manager; + private readonly ModCollection _collection; + public readonly CollectionModData ModData = new(); + private readonly SortedList, object?)> _changedItems = []; + public readonly ConcurrentDictionary ResolvedFiles = new(); + public readonly CustomResourceCache CustomResources; + public readonly MetaCache Meta; + public readonly Dictionary> ConflictDict = []; public int Calculating = -1; public string AnonymizedName - => _collection.Identity.AnonymizedName; + => _collection.AnonymizedName; public IEnumerable> AllConflicts => ConflictDict.Values; @@ -43,7 +41,7 @@ public sealed class CollectionCache : IDisposable private int _changedItemsSaveCounter = -1; // Obtain currently changed items. Computes them if they haven't been computed before. - public IReadOnlyDictionary, IIdentifiedObjectData)> ChangedItems + public IReadOnlyDictionary, object?)> ChangedItems { get { @@ -127,6 +125,12 @@ public sealed class CollectionCache : IDisposable return ret; } + public void ForceFile(Utf8GamePath path, FullPath fullPath) + => _manager.AddChange(ChangeData.ForcedFile(this, path, fullPath)); + + public void RemovePath(Utf8GamePath path) + => _manager.AddChange(ChangeData.ForcedFile(this, path, FullPath.Empty)); + public void ReloadMod(IMod mod, bool addMetaChanges) => _manager.AddChange(ChangeData.ModReload(this, mod, addMetaChanges)); @@ -178,7 +182,7 @@ public sealed class CollectionCache : IDisposable var (paths, manipulations) = ModData.RemoveMod(mod); if (addMetaChanges) - _collection.Counters.IncrementChange(); + _collection.IncrementCounter(); foreach (var path in paths) { @@ -229,33 +233,15 @@ public sealed class CollectionCache : IDisposable foreach (var (path, file) in files.FileRedirections) AddFile(path, file, mod); - if (files.Manipulations.Count > 0) - { - foreach (var (identifier, entry) in files.Manipulations.Eqp) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Eqdp) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Est) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Gmp) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Rsp) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Imc) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Atch) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Shp) - AddManipulation(mod, identifier, entry); - foreach (var (identifier, entry) in files.Manipulations.Atr) - AddManipulation(mod, identifier, entry); - foreach (var identifier in files.Manipulations.GlobalEqp) - AddManipulation(mod, identifier, null!); - } + foreach (var manip in files.Manipulations) + AddManipulation(manip, mod); if (addMetaChanges) { - _collection.Counters.IncrementChange(); + _collection.IncrementCounter(); + if (mod.TotalManipulations > 0) + AddMetaFiles(false); + _manager.MetaFileManager.ApplyDefaultFiles(_collection); } } @@ -265,7 +251,7 @@ public sealed class CollectionCache : IDisposable if (mod.Index < 0) return mod.GetData(); - var settings = _collection.GetActualSettings(mod.Index).Settings; + var settings = _collection[mod.Index].Settings; return settings is not { Enabled: true } ? AppliedModData.Empty : mod.GetData(settings); @@ -279,24 +265,6 @@ public sealed class CollectionCache : IDisposable _manager.ResolvedFileChanged.Invoke(collection, type, key, value, old, mod); } - private static bool IsRedirectionSupported(Utf8GamePath path, IMod mod) - { - var ext = path.Extension().AsciiToLower().ToString(); - switch (ext) - { - case ".atch" or ".eqp" or ".eqdp" or ".est" or ".gmp" or ".cmp" or ".imc": - Penumbra.Messager.NotificationMessage( - $"Redirection of {ext} files for {mod.Name} is unsupported. This probably means that the mod is outdated and may not work correctly.\n\nPlease tell the mod creator to use the corresponding meta manipulations instead.", - NotificationType.Warning); - return false; - case ".lvb" or ".lgb" or ".sgb": - Penumbra.Messager.NotificationMessage($"Redirection of {ext} files for {mod.Name} is unsupported as this breaks the game.\n\nThis mod will probably not work correctly.", - NotificationType.Warning); - return false; - default: return true; - } - } - // Add a specific file redirection, handling potential conflicts. // For different mods, higher mod priority takes precedence before option group priority, // which takes precedence before option priority, which takes precedence before ordering. @@ -306,9 +274,6 @@ public sealed class CollectionCache : IDisposable if (!CheckFullPath(path, file)) return; - if (!IsRedirectionSupported(path, mod)) - return; - try { if (ResolvedFiles.TryAdd(path, new ModPath(mod, file))) @@ -368,9 +333,8 @@ public sealed class CollectionCache : IDisposable // Returns if the added mod takes priority before the existing mod. private bool AddConflict(object data, IMod addedMod, IMod existingMod) { - var addedPriority = addedMod.Index >= 0 ? _collection.GetActualSettings(addedMod.Index).Settings!.Priority : addedMod.Priority; - var existingPriority = - existingMod.Index >= 0 ? _collection.GetActualSettings(existingMod.Index).Settings!.Priority : existingMod.Priority; + var addedPriority = addedMod.Index >= 0 ? _collection[addedMod.Index].Settings!.Priority : addedMod.Priority; + var existingPriority = existingMod.Index >= 0 ? _collection[existingMod.Index].Settings!.Priority : existingMod.Priority; if (existingPriority < addedPriority) { @@ -378,7 +342,7 @@ public sealed class CollectionCache : IDisposable foreach (var conflict in tmpConflicts) { if (data is Utf8GamePath path && conflict.Conflicts.RemoveAll(p => p is Utf8GamePath x && x.Equals(path)) > 0 - || data is IMetaIdentifier meta && conflict.Conflicts.RemoveAll(m => m.Equals(meta)) > 0) + || data is MetaManipulation meta && conflict.Conflicts.RemoveAll(m => m is MetaManipulation x && x.Equals(meta)) > 0) AddConflict(data, addedMod, conflict.Mod2); } @@ -410,12 +374,12 @@ public sealed class CollectionCache : IDisposable // For different mods, higher mod priority takes precedence before option group priority, // which takes precedence before option priority, which takes precedence before ordering. // Inside the same mod, conflicts are not recorded. - private void AddManipulation(IMod mod, IMetaIdentifier identifier, object entry) + private void AddManipulation(MetaManipulation manip, IMod mod) { - if (!Meta.TryGetMod(identifier, out var existingMod)) + if (!Meta.TryGetValue(manip, out var existingMod)) { - Meta.ApplyMod(mod, identifier, entry); - ModData.AddManip(mod, identifier); + Meta.ApplyMod(manip, mod); + ModData.AddManip(mod, manip); return; } @@ -423,29 +387,34 @@ public sealed class CollectionCache : IDisposable if (mod == existingMod) return; - if (AddConflict(identifier, mod, existingMod)) + if (AddConflict(manip, mod, existingMod)) { - ModData.RemoveManip(existingMod, identifier); - Meta.ApplyMod(mod, identifier, entry); - ModData.AddManip(mod, identifier); + ModData.RemoveManip(existingMod, manip); + Meta.ApplyMod(manip, mod); + ModData.AddManip(mod, manip); } } + // Add all necessary meta file redirects. + public void AddMetaFiles(bool fromFullCompute) + => Meta.SetImcFiles(fromFullCompute); + + // Identify and record all manipulated objects for this entire collection. private void SetChangedItems() { - if (_changedItemsSaveCounter == _collection.Counters.Change) + if (_changedItemsSaveCounter == _collection.ChangeCounter) return; try { - _changedItemsSaveCounter = _collection.Counters.Change; + _changedItemsSaveCounter = _collection.ChangeCounter; _changedItems.Clear(); // Skip IMCs because they would result in far too many false-positive items, // since they are per set instead of per item-slot/item/variant. var identifier = _manager.MetaFileManager.Identifier; - var items = new SortedList(512); + var items = new SortedList(512); void AddItems(IMod mod) { @@ -454,9 +423,8 @@ public sealed class CollectionCache : IDisposable if (!_changedItems.TryGetValue(name, out var data)) _changedItems.Add(name, (new SingleArray(mod), obj)); else if (!data.Item1.Contains(mod)) - _changedItems[name] = (data.Item1.Append(mod), - obj is IdentifiedCounter x && data.Item2 is IdentifiedCounter y ? x + y : obj); - else if (obj is IdentifiedCounter x && data.Item2 is IdentifiedCounter y) + _changedItems[name] = (data.Item1.Append(mod), obj is int x && data.Item2 is int y ? x + y : obj); + else if (obj is int x && data.Item2 is int y) _changedItems[name] = (data.Item1, x + y); } @@ -469,9 +437,9 @@ public sealed class CollectionCache : IDisposable AddItems(modPath.Mod); } - foreach (var (manip, mod) in Meta.IdentifierSources) + foreach (var (manip, mod) in Meta) { - manip.AddChangedItems(identifier, items); + identifier.MetaChangedItems(items, manip); AddItems(mod); } diff --git a/Penumbra/Collections/Cache/CollectionCacheManager.cs b/Penumbra/Collections/Cache/CollectionCacheManager.cs index ec48e608..ae424b94 100644 --- a/Penumbra/Collections/Cache/CollectionCacheManager.cs +++ b/Penumbra/Collections/Cache/CollectionCacheManager.cs @@ -1,11 +1,10 @@ using Dalamud.Plugin.Services; using OtterGui.Classes; -using OtterGui.Services; using Penumbra.Api; using Penumbra.Api.Enums; using Penumbra.Collections.Manager; using Penumbra.Communication; -using Penumbra.Interop.Hooks.ResourceLoading; +using Penumbra.Interop.ResourceLoading; using Penumbra.Meta; using Penumbra.Mods; using Penumbra.Mods.Groups; @@ -18,7 +17,7 @@ using Penumbra.String.Classes; namespace Penumbra.Collections.Cache; -public class CollectionCacheManager : IDisposable, IService +public class CollectionCacheManager : IDisposable { private readonly FrameworkManager _framework; private readonly CommunicatorService _communicator; @@ -71,7 +70,7 @@ public class CollectionCacheManager : IDisposable, IService _communicator.ModDiscoveryFinished.Subscribe(OnModDiscoveryFinished, ModDiscoveryFinished.Priority.CollectionCacheManager); if (!MetaFileManager.CharacterUtility.Ready) - MetaFileManager.CharacterUtility.LoadingFinished.Subscribe(IncrementCounters, CharacterUtilityFinished.Priority.CollectionCacheManager); + MetaFileManager.CharacterUtility.LoadingFinished += IncrementCounters; } public void Dispose() @@ -83,13 +82,7 @@ public class CollectionCacheManager : IDisposable, IService _communicator.ModOptionChanged.Unsubscribe(OnModOptionChange); _communicator.ModSettingChanged.Unsubscribe(OnModSettingChange); _communicator.CollectionInheritanceChanged.Unsubscribe(OnCollectionInheritanceChange); - MetaFileManager.CharacterUtility.LoadingFinished.Unsubscribe(IncrementCounters); - - foreach (var collection in _storage) - { - collection._cache?.Dispose(); - collection._cache = null; - } + MetaFileManager.CharacterUtility.LoadingFinished -= IncrementCounters; } public void AddChange(CollectionCache.ChangeData data) @@ -114,16 +107,16 @@ public class CollectionCacheManager : IDisposable, IService /// Only creates a new cache, does not update an existing one. public bool CreateCache(ModCollection collection) { - if (collection.Identity.Index == ModCollection.Empty.Identity.Index) + if (collection.Index == ModCollection.Empty.Index) return false; if (collection._cache != null) return false; collection._cache = new CollectionCache(this, collection); - if (collection.Identity.Index > 0) + if (collection.Index > 0) Interlocked.Increment(ref _count); - Penumbra.Log.Verbose($"Created new cache for collection {collection.Identity.AnonymizedName}."); + Penumbra.Log.Verbose($"Created new cache for collection {collection.AnonymizedName}."); return true; } @@ -132,32 +125,32 @@ public class CollectionCacheManager : IDisposable, IService /// Does not create caches. /// public void CalculateEffectiveFileList(ModCollection collection) - => _framework.RegisterImportant(nameof(CalculateEffectiveFileList) + collection.Identity.Identifier, + => _framework.RegisterImportant(nameof(CalculateEffectiveFileList) + collection.Identifier, () => CalculateEffectiveFileListInternal(collection)); private void CalculateEffectiveFileListInternal(ModCollection collection) { // Skip the empty collection. - if (collection.Identity.Index == 0) + if (collection.Index == 0) return; - Penumbra.Log.Debug($"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.Identity.AnonymizedName}"); + Penumbra.Log.Debug($"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.AnonymizedName}"); if (!collection.HasCache) { Penumbra.Log.Error( - $"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.Identity.AnonymizedName} failed, no cache exists."); + $"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.AnonymizedName} failed, no cache exists."); } else if (collection._cache!.Calculating != -1) { Penumbra.Log.Error( - $"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.Identity.AnonymizedName} failed, already in calculation on [{collection._cache!.Calculating}]."); + $"[{Environment.CurrentManagedThreadId}] Recalculating effective file list for {collection.AnonymizedName} failed, already in calculation on [{collection._cache!.Calculating}]."); } else { FullRecalculation(collection); Penumbra.Log.Debug( - $"[{Environment.CurrentManagedThreadId}] Recalculation of effective file list for {collection.Identity.AnonymizedName} finished."); + $"[{Environment.CurrentManagedThreadId}] Recalculation of effective file list for {collection.AnonymizedName} finished."); } } @@ -171,7 +164,8 @@ public class CollectionCacheManager : IDisposable, IService try { ResolvedFileChanged.Invoke(collection, ResolvedFileChanged.Type.FullRecomputeStart, Utf8GamePath.Empty, FullPath.Empty, - FullPath.Empty, null); + FullPath.Empty, + null); cache.ResolvedFiles.Clear(); cache.Meta.Reset(); cache.ConflictDict.Clear(); @@ -186,7 +180,9 @@ public class CollectionCacheManager : IDisposable, IService foreach (var mod in _modStorage) cache.AddModSync(mod, false); - collection.Counters.IncrementChange(); + cache.AddMetaFiles(true); + + collection.IncrementCounter(); MetaFileManager.ApplyDefaultFiles(collection); ResolvedFileChanged.Invoke(collection, ResolvedFileChanged.Type.FullRecomputeFinished, Utf8GamePath.Empty, FullPath.Empty, @@ -212,7 +208,7 @@ public class CollectionCacheManager : IDisposable, IService else { RemoveCache(old); - if (type is not CollectionType.Inactive && newCollection != null && newCollection.Identity.Index != 0 && CreateCache(newCollection)) + if (type is not CollectionType.Inactive && newCollection != null && newCollection.Index != 0 && CreateCache(newCollection)) CalculateEffectiveFileList(newCollection); if (type is CollectionType.Default) @@ -230,11 +226,11 @@ public class CollectionCacheManager : IDisposable, IService { case ModPathChangeType.Deleted: case ModPathChangeType.StartingReload: - foreach (var collection in _storage.Where(c => c.HasCache && c.GetActualSettings(mod.Index).Settings?.Enabled == true)) + foreach (var collection in _storage.Where(c => c.HasCache && c[mod.Index].Settings?.Enabled == true)) collection._cache!.RemoveMod(mod, true); break; case ModPathChangeType.Moved: - foreach (var collection in _storage.Where(c => c.HasCache && c.GetActualSettings(mod.Index).Settings?.Enabled == true)) + foreach (var collection in _storage.Where(c => c.HasCache && c[mod.Index].Settings?.Enabled == true)) collection._cache!.ReloadMod(mod, true); break; } @@ -245,7 +241,7 @@ public class CollectionCacheManager : IDisposable, IService if (type is not (ModPathChangeType.Added or ModPathChangeType.Reloaded)) return; - foreach (var collection in _storage.Where(c => c.HasCache && c.GetActualSettings(mod.Index).Settings?.Enabled == true)) + foreach (var collection in _storage.Where(c => c.HasCache && c[mod.Index].Settings?.Enabled == true)) collection._cache!.AddMod(mod, true); } @@ -257,12 +253,12 @@ public class CollectionCacheManager : IDisposable, IService private void RemoveCache(ModCollection? collection) { if (collection != null - && collection.Identity.Index > ModCollection.Empty.Identity.Index - && collection.Identity.Index != _active.Default.Identity.Index - && collection.Identity.Index != _active.Interface.Identity.Index - && collection.Identity.Index != _active.Current.Identity.Index - && _active.SpecialAssignments.All(c => c.Value.Identity.Index != collection.Identity.Index) - && _active.Individuals.All(c => c.Collection.Identity.Index != collection.Identity.Index)) + && collection.Index > ModCollection.Empty.Index + && collection.Index != _active.Default.Index + && collection.Index != _active.Interface.Index + && collection.Index != _active.Current.Index + && _active.SpecialAssignments.All(c => c.Value.Index != collection.Index) + && _active.Individuals.All(c => c.Collection.Index != collection.Index)) ClearCache(collection); } @@ -272,7 +268,7 @@ public class CollectionCacheManager : IDisposable, IService { if (type is ModOptionChangeType.PrepareChange) { - foreach (var collection in _storage.Where(collection => collection.HasCache && collection.GetActualSettings(mod.Index).Settings is { Enabled: true })) + foreach (var collection in _storage.Where(collection => collection.HasCache && collection[mod.Index].Settings is { Enabled: true })) collection._cache!.RemoveMod(mod, false); return; @@ -283,7 +279,7 @@ public class CollectionCacheManager : IDisposable, IService if (!recomputeList) return; - foreach (var collection in _storage.Where(collection => collection.HasCache && collection.GetActualSettings(mod.Index).Settings is { Enabled: true })) + foreach (var collection in _storage.Where(collection => collection.HasCache && collection[mod.Index].Settings is { Enabled: true })) { if (justAdd) collection._cache!.AddMod(mod, true); @@ -296,8 +292,8 @@ public class CollectionCacheManager : IDisposable, IService private void IncrementCounters() { foreach (var collection in _storage.Where(c => c.HasCache)) - collection.Counters.IncrementChange(); - MetaFileManager.CharacterUtility.LoadingFinished.Unsubscribe(IncrementCounters); + collection.IncrementCounter(); + MetaFileManager.CharacterUtility.LoadingFinished -= IncrementCounters; } private void OnModSettingChange(ModCollection collection, ModSettingChange type, Mod? mod, Setting oldValue, int groupIdx, bool _) @@ -316,7 +312,7 @@ public class CollectionCacheManager : IDisposable, IService cache.AddMod(mod!, true); else if (oldValue == Setting.True) cache.RemoveMod(mod!, true); - else if (collection.GetActualSettings(mod!.Index).Settings?.Enabled == true) + else if (collection[mod!.Index].Settings?.Enabled == true) cache.ReloadMod(mod!, true); else cache.RemoveMod(mod!, true); @@ -328,13 +324,10 @@ public class CollectionCacheManager : IDisposable, IService break; case ModSettingChange.Setting: - if (collection.GetActualSettings(mod!.Index).Settings?.Enabled == true) - cache.ReloadMod(mod, true); + if (collection[mod!.Index].Settings?.Enabled == true) + cache.ReloadMod(mod!, true); break; - case ModSettingChange.TemporarySetting: - cache.ReloadMod(mod!, true); - break; case ModSettingChange.MultiInheritance: case ModSettingChange.MultiEnableState: FullRecalculation(collection); @@ -361,9 +354,9 @@ public class CollectionCacheManager : IDisposable, IService collection._cache!.Dispose(); collection._cache = null; - if (collection.Identity.Index > 0) + if (collection.Index > 0) Interlocked.Decrement(ref _count); - Penumbra.Log.Verbose($"Cleared cache of collection {collection.Identity.AnonymizedName}."); + Penumbra.Log.Verbose($"Cleared cache of collection {collection.AnonymizedName}."); } /// diff --git a/Penumbra/Collections/Cache/CollectionModData.cs b/Penumbra/Collections/Cache/CollectionModData.cs index 295191d2..d0a3bc76 100644 --- a/Penumbra/Collections/Cache/CollectionModData.cs +++ b/Penumbra/Collections/Cache/CollectionModData.cs @@ -9,12 +9,12 @@ namespace Penumbra.Collections.Cache; /// public class CollectionModData { - private readonly Dictionary, HashSet)> _data = new(); + private readonly Dictionary, HashSet)> _data = new(); - public IEnumerable<(IMod, IReadOnlySet, IReadOnlySet)> Data - => _data.Select(kvp => (kvp.Key, (IReadOnlySet)kvp.Value.Item1, (IReadOnlySet)kvp.Value.Item2)); + public IEnumerable<(IMod, IReadOnlySet, IReadOnlySet)> Data + => _data.Select(kvp => (kvp.Key, (IReadOnlySet)kvp.Value.Item1, (IReadOnlySet)kvp.Value.Item2)); - public (IReadOnlyCollection Paths, IReadOnlyCollection Manipulations) RemoveMod(IMod mod) + public (IReadOnlyCollection Paths, IReadOnlyCollection Manipulations) RemoveMod(IMod mod) { if (_data.Remove(mod, out var data)) return data; @@ -35,7 +35,7 @@ public class CollectionModData } } - public void AddManip(IMod mod, IMetaIdentifier manipulation) + public void AddManip(IMod mod, MetaManipulation manipulation) { if (_data.TryGetValue(mod, out var data)) { @@ -54,7 +54,7 @@ public class CollectionModData _data.Remove(mod); } - public void RemoveManip(IMod mod, IMetaIdentifier manip) + public void RemoveManip(IMod mod, MetaManipulation manip) { if (_data.TryGetValue(mod, out var data) && data.Item2.Remove(manip) && data.Item1.Count == 0 && data.Item2.Count == 0) _data.Remove(mod); diff --git a/Penumbra/Collections/Cache/CustomResourceCache.cs b/Penumbra/Collections/Cache/CustomResourceCache.cs index e63f8637..46c28393 100644 --- a/Penumbra/Collections/Cache/CustomResourceCache.cs +++ b/Penumbra/Collections/Cache/CustomResourceCache.cs @@ -1,6 +1,6 @@ using FFXIVClientStructs.FFXIV.Client.System.Resource; using Penumbra.Api.Enums; -using Penumbra.Interop.Hooks.ResourceLoading; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.SafeHandles; using Penumbra.String.Classes; diff --git a/Penumbra/Collections/Cache/EqdpCache.cs b/Penumbra/Collections/Cache/EqdpCache.cs index 5e0626cf..a0f27c23 100644 --- a/Penumbra/Collections/Cache/EqdpCache.cs +++ b/Penumbra/Collections/Cache/EqdpCache.cs @@ -1,54 +1,97 @@ +using OtterGui; +using OtterGui.Filesystem; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta; +using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Collections.Cache; -public sealed class EqdpCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) +public readonly struct EqdpCache : IDisposable { - private readonly Dictionary<(PrimaryId Id, GenderRace GenderRace, bool Accessory), (EqdpEntry Entry, EqdpEntry InverseMask)> _fullEntries = - []; + private readonly ExpandedEqdpFile?[] _eqdpFiles = new ExpandedEqdpFile[CharacterUtilityData.EqdpIndices.Length]; // TODO: female Hrothgar + private readonly List _eqdpManipulations = new(); - public EqdpEntry ApplyFullEntry(PrimaryId id, GenderRace genderRace, bool accessory, EqdpEntry originalEntry) - => _fullEntries.TryGetValue((id, genderRace, accessory), out var pair) - ? (originalEntry & pair.InverseMask) | pair.Entry - : originalEntry; + public EqdpCache() + { } + + public void SetFiles(MetaFileManager manager) + { + for (var i = 0; i < CharacterUtilityData.EqdpIndices.Length; ++i) + manager.SetFile(_eqdpFiles[i], CharacterUtilityData.EqdpIndices[i]); + } + + public void SetFile(MetaFileManager manager, MetaIndex index) + { + var i = CharacterUtilityData.EqdpIndices.IndexOf(index); + if (i != -1) + manager.SetFile(_eqdpFiles[i], index); + } + + public MetaList.MetaReverter? TemporarilySetFiles(MetaFileManager manager, GenderRace genderRace, bool accessory) + { + var idx = CharacterUtilityData.EqdpIdx(genderRace, accessory); + if (idx < 0) + { + Penumbra.Log.Warning($"Invalid Gender, Race or Accessory for EQDP file {genderRace}, {accessory}."); + return null; + } + + var i = CharacterUtilityData.EqdpIndices.IndexOf(idx); + if (i < 0) + { + Penumbra.Log.Warning($"Invalid Gender, Race or Accessory for EQDP file {genderRace}, {accessory}."); + return null; + } + + return manager.TemporarilySetFile(_eqdpFiles[i], idx); + } public void Reset() { - Clear(); - _fullEntries.Clear(); + foreach (var file in _eqdpFiles.OfType()) + { + var relevant = CharacterUtility.RelevantIndices[file.Index.Value]; + file.Reset(_eqdpManipulations.Where(m => m.FileIndex() == relevant).Select(m => (PrimaryId)m.SetId)); + } + + _eqdpManipulations.Clear(); } - protected override void ApplyModInternal(EqdpIdentifier identifier, EqdpEntry entry) + public bool ApplyMod(MetaFileManager manager, EqdpManipulation manip) { - var tuple = (identifier.SetId, identifier.GenderRace, identifier.Slot.IsAccessory()); - var mask = Eqdp.Mask(identifier.Slot); - var inverseMask = ~mask; - if (_fullEntries.TryGetValue(tuple, out var pair)) - pair = ((pair.Entry & inverseMask) | (entry & mask), pair.InverseMask & inverseMask); - else - pair = (entry & mask, inverseMask); - _fullEntries[tuple] = pair; + _eqdpManipulations.AddOrReplace(manip); + var file = _eqdpFiles[Array.IndexOf(CharacterUtilityData.EqdpIndices, manip.FileIndex())] ??= + new ExpandedEqdpFile(manager, Names.CombinedRace(manip.Gender, manip.Race), manip.Slot.IsAccessory()); // TODO: female Hrothgar + return manip.Apply(file); } - protected override void RevertModInternal(EqdpIdentifier identifier) + public bool RevertMod(MetaFileManager manager, EqdpManipulation manip) { - var tuple = (identifier.SetId, identifier.GenderRace, identifier.Slot.IsAccessory()); + if (!_eqdpManipulations.Remove(manip)) + return false; - if (!_fullEntries.Remove(tuple, out var pair)) - return; - - var mask = Eqdp.Mask(identifier.Slot); - var newMask = pair.InverseMask | mask; - if (newMask is not EqdpEntry.FullMask) - _fullEntries[tuple] = (pair.Entry & ~mask, newMask); + var def = ExpandedEqdpFile.GetDefault(manager, Names.CombinedRace(manip.Gender, manip.Race), manip.Slot.IsAccessory(), manip.SetId); + var file = _eqdpFiles[Array.IndexOf(CharacterUtilityData.EqdpIndices, manip.FileIndex())]!; + manip = new EqdpManipulation(def, manip.Slot, manip.Gender, manip.Race, manip.SetId); + return manip.Apply(file); } - protected override void Dispose(bool _) + public ExpandedEqdpFile? EqdpFile(GenderRace race, bool accessory) + => _eqdpFiles + [Array.IndexOf(CharacterUtilityData.EqdpIndices, CharacterUtilityData.EqdpIdx(race, accessory))]; // TODO: female Hrothgar + + public void Dispose() { - Clear(); - _fullEntries.Clear(); + for (var i = 0; i < _eqdpFiles.Length; ++i) + { + _eqdpFiles[i]?.Dispose(); + _eqdpFiles[i] = null; + } + + _eqdpManipulations.Clear(); } } diff --git a/Penumbra/Collections/Cache/EqpCache.cs b/Penumbra/Collections/Cache/EqpCache.cs index da1a1d44..972ee5a5 100644 --- a/Penumbra/Collections/Cache/EqpCache.cs +++ b/Penumbra/Collections/Cache/EqpCache.cs @@ -1,66 +1,60 @@ -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; +using OtterGui.Filesystem; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta; using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Collections.Cache; -public sealed class EqpCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) +public struct EqpCache : IDisposable { - public unsafe EqpEntry GetValues(CharacterArmor* armor) - { - var bodyEntry = GetSingleValue(armor[1].Set, EquipSlot.Body); - var headEntry = bodyEntry.HasFlag(EqpEntry.BodyShowHead) - ? GetSingleValue(armor[0].Set, EquipSlot.Head) - : GetSingleValue(armor[1].Set, EquipSlot.Head); - var handEntry = bodyEntry.HasFlag(EqpEntry.BodyShowHand) - ? GetSingleValue(armor[2].Set, EquipSlot.Hands) - : GetSingleValue(armor[1].Set, EquipSlot.Hands); - var (legsEntry, legsId) = bodyEntry.HasFlag(EqpEntry.BodyShowLeg) - ? (GetSingleValue(armor[3].Set, EquipSlot.Legs), 3) - : (GetSingleValue(armor[1].Set, EquipSlot.Legs), 1); - var footEntry = legsEntry.HasFlag(EqpEntry.LegsShowFoot) - ? GetSingleValue(armor[4].Set, EquipSlot.Feet) - : GetSingleValue(armor[legsId].Set, EquipSlot.Feet); + private ExpandedEqpFile? _eqpFile = null; + private readonly List _eqpManipulations = new(); - var combined = bodyEntry | headEntry | handEntry | legsEntry | footEntry; - return PostProcessFeet(PostProcessHands(combined)); - } + public EqpCache() + { } - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private EqpEntry GetSingleValue(PrimaryId id, EquipSlot slot) - => TryGetValue(new EqpIdentifier(id, slot), out var pair) ? pair.Entry : ExpandedEqpFile.GetDefault(Manager, id) & Eqp.Mask(slot); + public void SetFiles(MetaFileManager manager) + => manager.SetFile(_eqpFile, MetaIndex.Eqp); + + public static void ResetFiles(MetaFileManager manager) + => manager.SetFile(null, MetaIndex.Eqp); + + public MetaList.MetaReverter TemporarilySetFiles(MetaFileManager manager) + => manager.TemporarilySetFile(_eqpFile, MetaIndex.Eqp); public void Reset() - => Clear(); - - protected override void Dispose(bool _) - => Clear(); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static EqpEntry PostProcessHands(EqpEntry entry) { - if (!entry.HasFlag(EqpEntry.HandsHideForearm)) - return entry; + if (_eqpFile == null) + return; - var testFlag = entry.HasFlag(EqpEntry.HandsHideElbow) - ? entry.HasFlag(EqpEntry.BodyHideGlovesL) - : entry.HasFlag(EqpEntry.BodyHideGlovesM); - return testFlag - ? (entry | EqpEntry.BodyHideGloveCuffs) & ~EqpEntry.BodyHideGlovesS - : entry & ~(EqpEntry.BodyHideGloveCuffs | EqpEntry.BodyHideGlovesS); + _eqpFile.Reset(_eqpManipulations.Select(m => m.SetId)); + _eqpManipulations.Clear(); } - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static EqpEntry PostProcessFeet(EqpEntry entry) + public bool ApplyMod(MetaFileManager manager, EqpManipulation manip) { - if (!entry.HasFlag(EqpEntry.FeetHideCalf)) - return entry; + _eqpManipulations.AddOrReplace(manip); + _eqpFile ??= new ExpandedEqpFile(manager); + return manip.Apply(_eqpFile); + } - if (entry.HasFlag(EqpEntry.FeetHideKnee) || !entry.HasFlag(EqpEntry._20)) - return entry & ~(EqpEntry.LegsHideBootsS | EqpEntry.LegsHideBootsM); + public bool RevertMod(MetaFileManager manager, EqpManipulation manip) + { + var idx = _eqpManipulations.FindIndex(manip.Equals); + if (idx < 0) + return false; - return (entry | EqpEntry.LegsHideBootsM) & ~EqpEntry.LegsHideBootsS; + var def = ExpandedEqpFile.GetDefault(manager, manip.SetId); + manip = new EqpManipulation(def, manip.Slot, manip.SetId); + return manip.Apply(_eqpFile!); + } + + public void Dispose() + { + _eqpFile?.Dispose(); + _eqpFile = null; + _eqpManipulations.Clear(); } } diff --git a/Penumbra/Collections/Cache/EstCache.cs b/Penumbra/Collections/Cache/EstCache.cs index aff8beef..2552cd4a 100644 --- a/Penumbra/Collections/Cache/EstCache.cs +++ b/Penumbra/Collections/Cache/EstCache.cs @@ -1,19 +1,138 @@ +using OtterGui.Filesystem; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta; using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Collections.Cache; -public sealed class EstCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) +public struct EstCache : IDisposable { - public EstEntry GetEstEntry(EstIdentifier identifier) - => TryGetValue(identifier, out var entry) - ? entry.Entry - : EstFile.GetDefault(Manager, identifier); + private EstFile? _estFaceFile = null; + private EstFile? _estHairFile = null; + private EstFile? _estBodyFile = null; + private EstFile? _estHeadFile = null; + + private readonly List _estManipulations = new(); + + public EstCache() + { } + + public void SetFiles(MetaFileManager manager) + { + manager.SetFile(_estFaceFile, MetaIndex.FaceEst); + manager.SetFile(_estHairFile, MetaIndex.HairEst); + manager.SetFile(_estBodyFile, MetaIndex.BodyEst); + manager.SetFile(_estHeadFile, MetaIndex.HeadEst); + } + + public void SetFile(MetaFileManager manager, MetaIndex index) + { + switch (index) + { + case MetaIndex.FaceEst: + manager.SetFile(_estFaceFile, MetaIndex.FaceEst); + break; + case MetaIndex.HairEst: + manager.SetFile(_estHairFile, MetaIndex.HairEst); + break; + case MetaIndex.BodyEst: + manager.SetFile(_estBodyFile, MetaIndex.BodyEst); + break; + case MetaIndex.HeadEst: + manager.SetFile(_estHeadFile, MetaIndex.HeadEst); + break; + } + } + + public MetaList.MetaReverter TemporarilySetFiles(MetaFileManager manager, EstManipulation.EstType type) + { + var (file, idx) = type switch + { + EstManipulation.EstType.Face => (_estFaceFile, MetaIndex.FaceEst), + EstManipulation.EstType.Hair => (_estHairFile, MetaIndex.HairEst), + EstManipulation.EstType.Body => (_estBodyFile, MetaIndex.BodyEst), + EstManipulation.EstType.Head => (_estHeadFile, MetaIndex.HeadEst), + _ => (null, 0), + }; + + return manager.TemporarilySetFile(file, idx); + } + + private readonly EstFile? GetEstFile(EstManipulation.EstType type) + { + return type switch + { + EstManipulation.EstType.Face => _estFaceFile, + EstManipulation.EstType.Hair => _estHairFile, + EstManipulation.EstType.Body => _estBodyFile, + EstManipulation.EstType.Head => _estHeadFile, + _ => null, + }; + } + + internal ushort GetEstEntry(MetaFileManager manager, EstManipulation.EstType type, GenderRace genderRace, PrimaryId primaryId) + { + var file = GetEstFile(type); + return file != null + ? file[genderRace, primaryId.Id] + : EstFile.GetDefault(manager, type, genderRace, primaryId); + } public void Reset() - => Clear(); + { + _estFaceFile?.Reset(); + _estHairFile?.Reset(); + _estBodyFile?.Reset(); + _estHeadFile?.Reset(); + _estManipulations.Clear(); + } - protected override void Dispose(bool _) - => Clear(); + public bool ApplyMod(MetaFileManager manager, EstManipulation m) + { + _estManipulations.AddOrReplace(m); + var file = m.Slot switch + { + EstManipulation.EstType.Hair => _estHairFile ??= new EstFile(manager, EstManipulation.EstType.Hair), + EstManipulation.EstType.Face => _estFaceFile ??= new EstFile(manager, EstManipulation.EstType.Face), + EstManipulation.EstType.Body => _estBodyFile ??= new EstFile(manager, EstManipulation.EstType.Body), + EstManipulation.EstType.Head => _estHeadFile ??= new EstFile(manager, EstManipulation.EstType.Head), + _ => throw new ArgumentOutOfRangeException(), + }; + return m.Apply(file); + } + + public bool RevertMod(MetaFileManager manager, EstManipulation m) + { + if (!_estManipulations.Remove(m)) + return false; + + var def = EstFile.GetDefault(manager, m.Slot, Names.CombinedRace(m.Gender, m.Race), m.SetId); + var manip = new EstManipulation(m.Gender, m.Race, m.Slot, m.SetId, def); + var file = m.Slot switch + { + EstManipulation.EstType.Hair => _estHairFile!, + EstManipulation.EstType.Face => _estFaceFile!, + EstManipulation.EstType.Body => _estBodyFile!, + EstManipulation.EstType.Head => _estHeadFile!, + _ => throw new ArgumentOutOfRangeException(), + }; + return manip.Apply(file); + } + + public void Dispose() + { + _estFaceFile?.Dispose(); + _estHairFile?.Dispose(); + _estBodyFile?.Dispose(); + _estHeadFile?.Dispose(); + _estFaceFile = null; + _estHairFile = null; + _estBodyFile = null; + _estHeadFile = null; + _estManipulations.Clear(); + } } diff --git a/Penumbra/Collections/Cache/GmpCache.cs b/Penumbra/Collections/Cache/GmpCache.cs index 9170b871..0a713867 100644 --- a/Penumbra/Collections/Cache/GmpCache.cs +++ b/Penumbra/Collections/Cache/GmpCache.cs @@ -1,14 +1,56 @@ -using Penumbra.GameData.Structs; +using OtterGui.Filesystem; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta; +using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Collections.Cache; -public sealed class GmpCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) +public struct GmpCache : IDisposable { - public void Reset() - => Clear(); + private ExpandedGmpFile? _gmpFile = null; + private readonly List _gmpManipulations = new(); - protected override void Dispose(bool _) - => Clear(); + public GmpCache() + { } + + public void SetFiles(MetaFileManager manager) + => manager.SetFile(_gmpFile, MetaIndex.Gmp); + + public MetaList.MetaReverter TemporarilySetFiles(MetaFileManager manager) + => manager.TemporarilySetFile(_gmpFile, MetaIndex.Gmp); + + public void Reset() + { + if (_gmpFile == null) + return; + + _gmpFile.Reset(_gmpManipulations.Select(m => m.SetId)); + _gmpManipulations.Clear(); + } + + public bool ApplyMod(MetaFileManager manager, GmpManipulation manip) + { + _gmpManipulations.AddOrReplace(manip); + _gmpFile ??= new ExpandedGmpFile(manager); + return manip.Apply(_gmpFile); + } + + public bool RevertMod(MetaFileManager manager, GmpManipulation manip) + { + if (!_gmpManipulations.Remove(manip)) + return false; + + var def = ExpandedGmpFile.GetDefault(manager, manip.SetId); + manip = new GmpManipulation(def, manip.SetId); + return manip.Apply(_gmpFile!); + } + + public void Dispose() + { + _gmpFile?.Dispose(); + _gmpFile = null; + _gmpManipulations.Clear(); + } } diff --git a/Penumbra/Collections/Cache/ImcCache.cs b/Penumbra/Collections/Cache/ImcCache.cs index 461ffccc..843fe195 100644 --- a/Penumbra/Collections/Cache/ImcCache.cs +++ b/Penumbra/Collections/Cache/ImcCache.cs @@ -1,102 +1,123 @@ -using Penumbra.GameData.Structs; using Penumbra.Meta; using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; -using Penumbra.String; +using Penumbra.String.Classes; namespace Penumbra.Collections.Cache; -public sealed class ImcCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) +public readonly struct ImcCache : IDisposable { - private readonly Dictionary)> _imcFiles = []; + private readonly Dictionary _imcFiles = new(); + private readonly List<(ImcManipulation, ImcFile)> _imcManipulations = new(); - public bool HasFile(CiByteString path) - => _imcFiles.ContainsKey(path); + public ImcCache() + { } - public bool GetFile(CiByteString path, [NotNullWhen(true)] out ImcFile? file) + public void SetFiles(ModCollection collection, bool fromFullCompute) { - if (!_imcFiles.TryGetValue(path, out var p)) - { - file = null; - return false; - } - - file = p.Item1; - return true; + if (fromFullCompute) + foreach (var path in _imcFiles.Keys) + collection._cache!.ForceFileSync(path, CreateImcPath(collection, path)); + else + foreach (var path in _imcFiles.Keys) + collection._cache!.ForceFile(path, CreateImcPath(collection, path)); } - public void Reset() + public void Reset(ModCollection collection) { - foreach (var (_, (file, set)) in _imcFiles) + foreach (var (path, file) in _imcFiles) { + collection._cache!.RemovePath(path); file.Reset(); - set.Clear(); } - _imcFiles.Clear(); - Clear(); + _imcManipulations.Clear(); } - protected override void ApplyModInternal(ImcIdentifier identifier, ImcEntry entry) + public bool ApplyMod(MetaFileManager manager, ModCollection collection, ImcManipulation manip) { - Collection.Counters.IncrementImc(); - ApplyFile(identifier, entry); - } + if (!manip.Validate(true)) + return false; - private void ApplyFile(ImcIdentifier identifier, ImcEntry entry) - { - var path = identifier.GamePath().Path; + var idx = _imcManipulations.FindIndex(p => p.Item1.Equals(manip)); + if (idx < 0) + { + idx = _imcManipulations.Count; + _imcManipulations.Add((manip, null!)); + } + + var path = manip.GamePath(); try { - if (!_imcFiles.TryGetValue(path, out var pair)) - pair = (new ImcFile(Manager, identifier), []); + if (!_imcFiles.TryGetValue(path, out var file)) + file = new ImcFile(manager, manip); - if (!Apply(pair.Item1, identifier, entry)) - return; + _imcManipulations[idx] = (manip, file); + if (!manip.Apply(file)) + return false; - pair.Item2.Add(identifier); - _imcFiles[path] = pair; + _imcFiles[path] = file; + var fullPath = CreateImcPath(collection, path); + collection._cache!.ForceFile(path, fullPath); + + return true; } catch (ImcException e) { - Manager.ValidityChecker.ImcExceptions.Add(e); + manager.ValidityChecker.ImcExceptions.Add(e); Penumbra.Log.Error(e.ToString()); } catch (Exception e) { - Penumbra.Log.Error($"Could not apply IMC Manipulation {identifier}:\n{e}"); + Penumbra.Log.Error($"Could not apply IMC Manipulation {manip}:\n{e}"); } + + return false; } - protected override void RevertModInternal(ImcIdentifier identifier) + public bool RevertMod(MetaFileManager manager, ModCollection collection, ImcManipulation m) { - Collection.Counters.IncrementImc(); - var path = identifier.GamePath().Path; - if (!_imcFiles.TryGetValue(path, out var pair)) - return; + if (!m.Validate(false)) + return false; - if (!pair.Item2.Remove(identifier)) - return; + var idx = _imcManipulations.FindIndex(p => p.Item1.Equals(m)); + if (idx < 0) + return false; - if (pair.Item2.Count == 0) + var (_, file) = _imcManipulations[idx]; + _imcManipulations.RemoveAt(idx); + + if (_imcManipulations.All(p => !ReferenceEquals(p.Item2, file))) { - _imcFiles.Remove(path); - pair.Item1.Dispose(); - return; + _imcFiles.Remove(file.Path); + collection._cache!.ForceFile(file.Path, FullPath.Empty); + file.Dispose(); + return true; } - var def = ImcFile.GetDefault(Manager, pair.Item1.Path, identifier.EquipSlot, identifier.Variant, out _); - Apply(pair.Item1, identifier, def); + var def = ImcFile.GetDefault(manager, file.Path, m.EquipSlot, m.Variant.Id, out _); + var manip = m.Copy(def); + if (!manip.Apply(file)) + return false; + + var fullPath = CreateImcPath(collection, file.Path); + collection._cache!.ForceFile(file.Path, fullPath); + + return true; } - public static bool Apply(ImcFile file, ImcIdentifier identifier, ImcEntry entry) - => file.SetEntry(ImcFile.PartIndex(identifier.EquipSlot), identifier.Variant.Id, entry); - - protected override void Dispose(bool _) + public void Dispose() { - foreach (var (_, (file, _)) in _imcFiles) + foreach (var file in _imcFiles.Values) file.Dispose(); - Clear(); + _imcFiles.Clear(); + _imcManipulations.Clear(); } + + private static FullPath CreateImcPath(ModCollection collection, Utf8GamePath path) + => new($"|{collection.Id.OptimizedString()}_{collection.ChangeCounter}|{path}"); + + public bool GetImcFile(Utf8GamePath path, [NotNullWhen(true)] out ImcFile? file) + => _imcFiles.TryGetValue(path, out file); } diff --git a/Penumbra/Collections/Cache/MetaCache.cs b/Penumbra/Collections/Cache/MetaCache.cs index 011cdd23..f42b72fc 100644 --- a/Penumbra/Collections/Cache/MetaCache.cs +++ b/Penumbra/Collections/Cache/MetaCache.cs @@ -1,137 +1,246 @@ using Penumbra.GameData.Enums; -using Penumbra.GameData.Files.AtchStructs; using Penumbra.GameData.Structs; +using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Editor; +using Penumbra.String.Classes; namespace Penumbra.Collections.Cache; -public class MetaCache(MetaFileManager manager, ModCollection collection) +public class MetaCache : IDisposable, IEnumerable> { - public readonly EqpCache Eqp = new(manager, collection); - public readonly EqdpCache Eqdp = new(manager, collection); - public readonly EstCache Est = new(manager, collection); - public readonly GmpCache Gmp = new(manager, collection); - public readonly RspCache Rsp = new(manager, collection); - public readonly ImcCache Imc = new(manager, collection); - public readonly AtchCache Atch = new(manager, collection); - public readonly ShpCache Shp = new(manager, collection); - public readonly AtrCache Atr = new(manager, collection); - public readonly GlobalEqpCache GlobalEqp = new(); - public bool IsDisposed { get; private set; } + private readonly MetaFileManager _manager; + private readonly ModCollection _collection; + private readonly Dictionary _manipulations = new(); + private EqpCache _eqpCache = new(); + private readonly EqdpCache _eqdpCache = new(); + private EstCache _estCache = new(); + private GmpCache _gmpCache = new(); + private CmpCache _cmpCache = new(); + private readonly ImcCache _imcCache = new(); + private GlobalEqpCache _globalEqpCache = new(); + + public bool TryGetValue(MetaManipulation manip, [NotNullWhen(true)] out IMod? mod) + { + lock (_manipulations) + { + return _manipulations.TryGetValue(manip, out mod); + } + } public int Count - => Eqp.Count + Eqdp.Count + Est.Count + Gmp.Count + Rsp.Count + Imc.Count + Atch.Count + Shp.Count + Atr.Count + GlobalEqp.Count; + => _manipulations.Count; - public IEnumerable<(IMetaIdentifier, IMod)> IdentifierSources - => Eqp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source)) - .Concat(Eqdp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Est.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Gmp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Rsp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Imc.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Atch.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Shp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(Atr.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value.Source))) - .Concat(GlobalEqp.Select(kvp => ((IMetaIdentifier)kvp.Key, kvp.Value))); + public IReadOnlyCollection Manipulations + => _manipulations.Keys; + + public IEnumerator> GetEnumerator() + => _manipulations.GetEnumerator(); + + IEnumerator IEnumerable.GetEnumerator() + => GetEnumerator(); + + public MetaCache(MetaFileManager manager, ModCollection collection) + { + _manager = manager; + _collection = collection; + if (!_manager.CharacterUtility.Ready) + _manager.CharacterUtility.LoadingFinished += ApplyStoredManipulations; + } + + public void SetFiles() + { + _eqpCache.SetFiles(_manager); + _eqdpCache.SetFiles(_manager); + _estCache.SetFiles(_manager); + _gmpCache.SetFiles(_manager); + _cmpCache.SetFiles(_manager); + _imcCache.SetFiles(_collection, false); + } public void Reset() { - Eqp.Reset(); - Eqdp.Reset(); - Est.Reset(); - Gmp.Reset(); - Rsp.Reset(); - Imc.Reset(); - Atch.Reset(); - Shp.Reset(); - Atr.Reset(); - GlobalEqp.Clear(); + _eqpCache.Reset(); + _eqdpCache.Reset(); + _estCache.Reset(); + _gmpCache.Reset(); + _cmpCache.Reset(); + _imcCache.Reset(_collection); + _manipulations.Clear(); + _globalEqpCache.Clear(); } public void Dispose() { - if (IsDisposed) - return; - - IsDisposed = true; - Eqp.Dispose(); - Eqdp.Dispose(); - Est.Dispose(); - Gmp.Dispose(); - Rsp.Dispose(); - Imc.Dispose(); - Atch.Dispose(); - Shp.Dispose(); - Atr.Dispose(); + _manager.CharacterUtility.LoadingFinished -= ApplyStoredManipulations; + _eqpCache.Dispose(); + _eqdpCache.Dispose(); + _estCache.Dispose(); + _gmpCache.Dispose(); + _cmpCache.Dispose(); + _imcCache.Dispose(); + _manipulations.Clear(); } - public bool TryGetMod(IMetaIdentifier identifier, [NotNullWhen(true)] out IMod? mod) - { - mod = null; - return identifier switch - { - EqdpIdentifier i => Eqdp.TryGetValue(i, out var p) && Convert(p, out mod), - EqpIdentifier i => Eqp.TryGetValue(i, out var p) && Convert(p, out mod), - EstIdentifier i => Est.TryGetValue(i, out var p) && Convert(p, out mod), - GmpIdentifier i => Gmp.TryGetValue(i, out var p) && Convert(p, out mod), - ImcIdentifier i => Imc.TryGetValue(i, out var p) && Convert(p, out mod), - RspIdentifier i => Rsp.TryGetValue(i, out var p) && Convert(p, out mod), - AtchIdentifier i => Atch.TryGetValue(i, out var p) && Convert(p, out mod), - ShpIdentifier i => Shp.TryGetValue(i, out var p) && Convert(p, out mod), - AtrIdentifier i => Atr.TryGetValue(i, out var p) && Convert(p, out mod), - GlobalEqpManipulation i => GlobalEqp.TryGetValue(i, out mod), - _ => false, - }; - - static bool Convert((IMod, T) pair, out IMod mod) - { - mod = pair.Item1; - return true; - } - } - - public bool RevertMod(IMetaIdentifier identifier, [NotNullWhen(true)] out IMod? mod) - => identifier switch - { - EqdpIdentifier i => Eqdp.RevertMod(i, out mod), - EqpIdentifier i => Eqp.RevertMod(i, out mod), - EstIdentifier i => Est.RevertMod(i, out mod), - GmpIdentifier i => Gmp.RevertMod(i, out mod), - ImcIdentifier i => Imc.RevertMod(i, out mod), - RspIdentifier i => Rsp.RevertMod(i, out mod), - AtchIdentifier i => Atch.RevertMod(i, out mod), - ShpIdentifier i => Shp.RevertMod(i, out mod), - AtrIdentifier i => Atr.RevertMod(i, out mod), - GlobalEqpManipulation i => GlobalEqp.RevertMod(i, out mod), - _ => (mod = null) != null, - }; - - public bool ApplyMod(IMod mod, IMetaIdentifier identifier, object entry) - => identifier switch - { - EqdpIdentifier i when entry is EqdpEntry e => Eqdp.ApplyMod(mod, i, e), - EqdpIdentifier i when entry is EqdpEntryInternal e => Eqdp.ApplyMod(mod, i, e.ToEntry(i.Slot)), - EqpIdentifier i when entry is EqpEntry e => Eqp.ApplyMod(mod, i, e), - EqpIdentifier i when entry is EqpEntryInternal e => Eqp.ApplyMod(mod, i, e.ToEntry(i.Slot)), - EstIdentifier i when entry is EstEntry e => Est.ApplyMod(mod, i, e), - GmpIdentifier i when entry is GmpEntry e => Gmp.ApplyMod(mod, i, e), - ImcIdentifier i when entry is ImcEntry e => Imc.ApplyMod(mod, i, e), - RspIdentifier i when entry is RspEntry e => Rsp.ApplyMod(mod, i, e), - AtchIdentifier i when entry is AtchEntry e => Atch.ApplyMod(mod, i, e), - ShpIdentifier i when entry is ShpEntry e => Shp.ApplyMod(mod, i, e), - AtrIdentifier i when entry is AtrEntry e => Atr.ApplyMod(mod, i, e), - GlobalEqpManipulation i => GlobalEqp.ApplyMod(mod, i), - _ => false, - }; - ~MetaCache() => Dispose(); - internal EqdpEntry GetEqdpEntry(GenderRace race, bool accessory, PrimaryId primaryId) - => Eqdp.ApplyFullEntry(primaryId, race, accessory, Meta.Files.ExpandedEqdpFile.GetDefault(manager, race, accessory, primaryId)); + public bool ApplyMod(MetaManipulation manip, IMod mod) + { + lock (_manipulations) + { + if (_manipulations.ContainsKey(manip)) + _manipulations.Remove(manip); - internal EstEntry GetEstEntry(EstType type, GenderRace genderRace, PrimaryId primaryId) - => Est.GetEstEntry(new EstIdentifier(primaryId, type, genderRace)); + _manipulations[manip] = mod; + } + + if (manip.ManipulationType is MetaManipulation.Type.GlobalEqp) + return _globalEqpCache.Add(manip.GlobalEqp); + + if (!_manager.CharacterUtility.Ready) + return true; + + // Imc manipulations do not require character utility, + // but they do require the file space to be ready. + return manip.ManipulationType switch + { + MetaManipulation.Type.Eqp => _eqpCache.ApplyMod(_manager, manip.Eqp), + MetaManipulation.Type.Eqdp => _eqdpCache.ApplyMod(_manager, manip.Eqdp), + MetaManipulation.Type.Est => _estCache.ApplyMod(_manager, manip.Est), + MetaManipulation.Type.Gmp => _gmpCache.ApplyMod(_manager, manip.Gmp), + MetaManipulation.Type.Rsp => _cmpCache.ApplyMod(_manager, manip.Rsp), + MetaManipulation.Type.Imc => _imcCache.ApplyMod(_manager, _collection, manip.Imc), + MetaManipulation.Type.Unknown => false, + _ => false, + }; + } + + public bool RevertMod(MetaManipulation manip, [NotNullWhen(true)] out IMod? mod) + { + lock (_manipulations) + { + var ret = _manipulations.Remove(manip, out mod); + + if (manip.ManipulationType is MetaManipulation.Type.GlobalEqp) + return _globalEqpCache.Remove(manip.GlobalEqp); + + if (!_manager.CharacterUtility.Ready) + return ret; + } + + // Imc manipulations do not require character utility, + // but they do require the file space to be ready. + return manip.ManipulationType switch + { + MetaManipulation.Type.Eqp => _eqpCache.RevertMod(_manager, manip.Eqp), + MetaManipulation.Type.Eqdp => _eqdpCache.RevertMod(_manager, manip.Eqdp), + MetaManipulation.Type.Est => _estCache.RevertMod(_manager, manip.Est), + MetaManipulation.Type.Gmp => _gmpCache.RevertMod(_manager, manip.Gmp), + MetaManipulation.Type.Rsp => _cmpCache.RevertMod(_manager, manip.Rsp), + MetaManipulation.Type.Imc => _imcCache.RevertMod(_manager, _collection, manip.Imc), + MetaManipulation.Type.Unknown => false, + _ => false, + }; + } + + /// Set a single file. + public void SetFile(MetaIndex metaIndex) + { + switch (metaIndex) + { + case MetaIndex.Eqp: + _eqpCache.SetFiles(_manager); + break; + case MetaIndex.Gmp: + _gmpCache.SetFiles(_manager); + break; + case MetaIndex.HumanCmp: + _cmpCache.SetFiles(_manager); + break; + case MetaIndex.FaceEst: + case MetaIndex.HairEst: + case MetaIndex.HeadEst: + case MetaIndex.BodyEst: + _estCache.SetFile(_manager, metaIndex); + break; + default: + _eqdpCache.SetFile(_manager, metaIndex); + break; + } + } + + /// Set the currently relevant IMC files for the collection cache. + public void SetImcFiles(bool fromFullCompute) + => _imcCache.SetFiles(_collection, fromFullCompute); + + public MetaList.MetaReverter TemporarilySetEqpFile() + => _eqpCache.TemporarilySetFiles(_manager); + + public MetaList.MetaReverter? TemporarilySetEqdpFile(GenderRace genderRace, bool accessory) + => _eqdpCache.TemporarilySetFiles(_manager, genderRace, accessory); + + public MetaList.MetaReverter TemporarilySetGmpFile() + => _gmpCache.TemporarilySetFiles(_manager); + + public MetaList.MetaReverter TemporarilySetCmpFile() + => _cmpCache.TemporarilySetFiles(_manager); + + public MetaList.MetaReverter TemporarilySetEstFile(EstManipulation.EstType type) + => _estCache.TemporarilySetFiles(_manager, type); + + public unsafe EqpEntry ApplyGlobalEqp(EqpEntry baseEntry, CharacterArmor* armor) + => _globalEqpCache.Apply(baseEntry, armor); + + + /// Try to obtain a manipulated IMC file. + public bool GetImcFile(Utf8GamePath path, [NotNullWhen(true)] out Meta.Files.ImcFile? file) + => _imcCache.GetImcFile(path, out file); + + internal EqdpEntry GetEqdpEntry(GenderRace race, bool accessory, PrimaryId primaryId) + { + var eqdpFile = _eqdpCache.EqdpFile(race, accessory); + if (eqdpFile != null) + return primaryId.Id < eqdpFile.Count ? eqdpFile[primaryId] : default; + + return Meta.Files.ExpandedEqdpFile.GetDefault(_manager, race, accessory, primaryId); + } + + internal ushort GetEstEntry(EstManipulation.EstType type, GenderRace genderRace, PrimaryId primaryId) + => _estCache.GetEstEntry(_manager, type, genderRace, primaryId); + + /// Use this when CharacterUtility becomes ready. + private void ApplyStoredManipulations() + { + if (!_manager.CharacterUtility.Ready) + return; + + var loaded = 0; + lock (_manipulations) + { + foreach (var manip in Manipulations) + { + loaded += manip.ManipulationType switch + { + MetaManipulation.Type.Eqp => _eqpCache.ApplyMod(_manager, manip.Eqp), + MetaManipulation.Type.Eqdp => _eqdpCache.ApplyMod(_manager, manip.Eqdp), + MetaManipulation.Type.Est => _estCache.ApplyMod(_manager, manip.Est), + MetaManipulation.Type.Gmp => _gmpCache.ApplyMod(_manager, manip.Gmp), + MetaManipulation.Type.Rsp => _cmpCache.ApplyMod(_manager, manip.Rsp), + MetaManipulation.Type.Imc => _imcCache.ApplyMod(_manager, _collection, manip.Imc), + MetaManipulation.Type.GlobalEqp => false, + MetaManipulation.Type.Unknown => false, + _ => false, + } + ? 1 + : 0; + } + } + + _manager.ApplyDefaultFiles(_collection); + _manager.CharacterUtility.LoadingFinished -= ApplyStoredManipulations; + Penumbra.Log.Debug($"{_collection.AnonymizedName}: Loaded {loaded} delayed meta manipulations."); + } } diff --git a/Penumbra/Collections/Cache/MetaCacheBase.cs b/Penumbra/Collections/Cache/MetaCacheBase.cs deleted file mode 100644 index 98a87e3f..00000000 --- a/Penumbra/Collections/Cache/MetaCacheBase.cs +++ /dev/null @@ -1,47 +0,0 @@ -using OtterGui.Classes; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; - -namespace Penumbra.Collections.Cache; - -public abstract class MetaCacheBase(MetaFileManager manager, ModCollection collection) - : ReadWriteDictionary - where TIdentifier : unmanaged, IMetaIdentifier - where TEntry : unmanaged -{ - protected readonly MetaFileManager Manager = manager; - protected readonly ModCollection Collection = collection; - - public bool ApplyMod(IMod source, TIdentifier identifier, TEntry entry) - { - if (TryGetValue(identifier, out var pair) && pair.Source == source && EqualityComparer.Default.Equals(pair.Entry, entry)) - return false; - - this[identifier] = (source, entry); - - ApplyModInternal(identifier, entry); - return true; - } - - public bool RevertMod(TIdentifier identifier, [NotNullWhen(true)] out IMod? mod) - { - if (!Remove(identifier, out var pair)) - { - mod = null; - return false; - } - - mod = pair.Source; - - RevertModInternal(identifier); - return true; - } - - - protected virtual void ApplyModInternal(TIdentifier identifier, TEntry entry) - { } - - protected virtual void RevertModInternal(TIdentifier identifier) - { } -} diff --git a/Penumbra/Collections/Cache/RspCache.cs b/Penumbra/Collections/Cache/RspCache.cs deleted file mode 100644 index 064b1f44..00000000 --- a/Penumbra/Collections/Cache/RspCache.cs +++ /dev/null @@ -1,13 +0,0 @@ -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Collections.Cache; - -public sealed class RspCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) -{ - public void Reset() - => Clear(); - - protected override void Dispose(bool _) - => Clear(); -} diff --git a/Penumbra/Collections/Cache/ShapeAttributeHashSet.cs b/Penumbra/Collections/Cache/ShapeAttributeHashSet.cs deleted file mode 100644 index 4c61bdd2..00000000 --- a/Penumbra/Collections/Cache/ShapeAttributeHashSet.cs +++ /dev/null @@ -1,181 +0,0 @@ -using System.Collections.Frozen; -using OtterGui.Extensions; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; - -namespace Penumbra.Collections.Cache; - -public sealed class ShapeAttributeHashSet : Dictionary<(HumanSlot Slot, PrimaryId Id), ulong> -{ - public static readonly IReadOnlyList GenderRaceValues = - [ - GenderRace.Unknown, GenderRace.MidlanderMale, GenderRace.MidlanderFemale, GenderRace.HighlanderMale, GenderRace.HighlanderFemale, - GenderRace.ElezenMale, GenderRace.ElezenFemale, GenderRace.MiqoteMale, GenderRace.MiqoteFemale, GenderRace.RoegadynMale, - GenderRace.RoegadynFemale, GenderRace.LalafellMale, GenderRace.LalafellFemale, GenderRace.AuRaMale, GenderRace.AuRaFemale, - GenderRace.HrothgarMale, GenderRace.HrothgarFemale, GenderRace.VieraMale, GenderRace.VieraFemale, - ]; - - public static readonly FrozenDictionary GenderRaceIndices = - GenderRaceValues.WithIndex().ToFrozenDictionary(p => p.Value, p => p.Index); - - private readonly BitArray _allIds = new(2 * (ShapeAttributeManager.ModelSlotSize + 1) * GenderRaceValues.Count); - - public bool? this[HumanSlot slot] - => AllCheck(ToIndex(slot, 0)); - - public bool? this[GenderRace genderRace] - => ToIndex(HumanSlot.Unknown, genderRace, out var index) ? AllCheck(index) : null; - - public bool? this[HumanSlot slot, GenderRace genderRace] - => ToIndex(slot, genderRace, out var index) ? AllCheck(index) : null; - - public bool? All - => Convert(_allIds[2 * AllIndex], _allIds[2 * AllIndex + 1]); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private bool? AllCheck(int idx) - => Convert(_allIds[idx], _allIds[idx + 1]); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static int ToIndex(HumanSlot slot, int genderRaceIndex) - => 2 * (slot is HumanSlot.Unknown ? genderRaceIndex + AllIndex : genderRaceIndex + (int)slot * GenderRaceValues.Count); - - [MethodImpl(MethodImplOptions.AggressiveOptimization)] - public bool? CheckEntry(HumanSlot slot, PrimaryId id, GenderRace genderRace) - { - if (!GenderRaceIndices.TryGetValue(genderRace, out var index)) - return null; - - // Check for specific ID. - if (TryGetValue((slot, id), out var flags)) - { - // Check completely specified entry. - if (Convert(flags, 2 * index) is { } specified) - return specified; - - // Check any gender / race. - if (Convert(flags, 0) is { } anyGr) - return anyGr; - } - - // Check for specified gender / race and slot, but no ID. - if (AllCheck(ToIndex(slot, index)) is { } noIdButGr) - return noIdButGr; - - // Check for specified gender / race but no slot or ID. - if (AllCheck(ToIndex(HumanSlot.Unknown, index)) is { } noSlotButGr) - return noSlotButGr; - - // Check for specified slot but no gender / race or ID. - if (AllCheck(ToIndex(slot, 0)) is { } noGrButSlot) - return noGrButSlot; - - return All; - } - - public bool TrySet(HumanSlot slot, PrimaryId? id, GenderRace genderRace, bool? value, out bool which) - { - which = false; - if (!GenderRaceIndices.TryGetValue(genderRace, out var index)) - return false; - - if (!id.HasValue) - { - var slotIndex = ToIndex(slot, index); - var ret = false; - if (value is true) - { - if (!_allIds[slotIndex]) - ret = true; - _allIds[slotIndex] = true; - _allIds[slotIndex + 1] = false; - } - else if (value is false) - { - if (!_allIds[slotIndex + 1]) - ret = true; - _allIds[slotIndex] = false; - _allIds[slotIndex + 1] = true; - } - else - { - if (_allIds[slotIndex]) - { - which = true; - ret = true; - } - else if (_allIds[slotIndex + 1]) - { - which = false; - ret = true; - } - - _allIds[slotIndex] = false; - _allIds[slotIndex + 1] = false; - } - - return ret; - } - - if (TryGetValue((slot, id.Value), out var flags)) - { - index *= 2; - var newFlags = value switch - { - true => (flags | (1ul << index)) & ~(1ul << (index + 1)), - false => (flags & ~(1ul << index)) | (1ul << (index + 1)), - _ => flags & ~(1ul << index) & ~(1ul << (index + 1)), - }; - if (newFlags == flags) - return false; - - this[(slot, id.Value)] = newFlags; - which = (flags & (1ul << index)) is not 0; - return true; - } - - if (value is null) - return false; - - this[(slot, id.Value)] = 1ul << (2 * index + (value.Value ? 0 : 1)); - return true; - } - - public new void Clear() - { - base.Clear(); - _allIds.SetAll(false); - } - - public bool IsEmpty - => !_allIds.HasAnySet() && Count is 0; - - private static readonly int AllIndex = ShapeAttributeManager.ModelSlotSize * GenderRaceValues.Count; - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool ToIndex(HumanSlot slot, GenderRace genderRace, out int index) - { - if (!GenderRaceIndices.TryGetValue(genderRace, out index)) - return false; - - index = ToIndex(slot, index); - return true; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool? Convert(bool trueValue, bool falseValue) - => trueValue ? true : falseValue ? false : null; - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool? Convert(ulong mask, int idx) - { - mask >>= idx; - return (mask & 3) switch - { - 1 => true, - 2 => false, - _ => null, - }; - } -} diff --git a/Penumbra/Collections/Cache/ShpCache.cs b/Penumbra/Collections/Cache/ShpCache.cs deleted file mode 100644 index d8c3a036..00000000 --- a/Penumbra/Collections/Cache/ShpCache.cs +++ /dev/null @@ -1,106 +0,0 @@ -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Collections.Cache; - -public sealed class ShpCache(MetaFileManager manager, ModCollection collection) : MetaCacheBase(manager, collection) -{ - public bool ShouldBeEnabled(in ShapeAttributeString shape, HumanSlot slot, PrimaryId id, GenderRace genderRace) - => EnabledCount > 0 && _shpData.TryGetValue(shape, out var value) && value.CheckEntry(slot, id, genderRace) is true; - - public bool ShouldBeDisabled(in ShapeAttributeString shape, HumanSlot slot, PrimaryId id, GenderRace genderRace) - => DisabledCount > 0 && _shpData.TryGetValue(shape, out var value) && value.CheckEntry(slot, id, genderRace) is false; - - internal IReadOnlyDictionary State(ShapeConnectorCondition connector) - => connector switch - { - ShapeConnectorCondition.None => _shpData, - ShapeConnectorCondition.Wrists => _wristConnectors, - ShapeConnectorCondition.Waist => _waistConnectors, - ShapeConnectorCondition.Ankles => _ankleConnectors, - _ => [], - }; - - public int EnabledCount { get; private set; } - public int DisabledCount { get; private set; } - - private readonly Dictionary _shpData = []; - private readonly Dictionary _wristConnectors = []; - private readonly Dictionary _waistConnectors = []; - private readonly Dictionary _ankleConnectors = []; - - public void Reset() - { - Clear(); - _shpData.Clear(); - _wristConnectors.Clear(); - _waistConnectors.Clear(); - _ankleConnectors.Clear(); - EnabledCount = 0; - DisabledCount = 0; - } - - protected override void Dispose(bool _) - => Reset(); - - protected override void ApplyModInternal(ShpIdentifier identifier, ShpEntry entry) - { - switch (identifier.ConnectorCondition) - { - case ShapeConnectorCondition.None: Func(_shpData); break; - case ShapeConnectorCondition.Wrists: Func(_wristConnectors); break; - case ShapeConnectorCondition.Waist: Func(_waistConnectors); break; - case ShapeConnectorCondition.Ankles: Func(_ankleConnectors); break; - } - - return; - - void Func(Dictionary dict) - { - if (!dict.TryGetValue(identifier.Shape, out var value)) - { - value = []; - dict.Add(identifier.Shape, value); - } - - if (value.TrySet(identifier.Slot, identifier.Id, identifier.GenderRaceCondition, entry.Value, out _)) - { - if (entry.Value) - ++EnabledCount; - else - ++DisabledCount; - } - } - } - - protected override void RevertModInternal(ShpIdentifier identifier) - { - switch (identifier.ConnectorCondition) - { - case ShapeConnectorCondition.None: Func(_shpData); break; - case ShapeConnectorCondition.Wrists: Func(_wristConnectors); break; - case ShapeConnectorCondition.Waist: Func(_waistConnectors); break; - case ShapeConnectorCondition.Ankles: Func(_ankleConnectors); break; - } - - return; - - void Func(Dictionary dict) - { - if (!dict.TryGetValue(identifier.Shape, out var value)) - return; - - if (value.TrySet(identifier.Slot, identifier.Id, identifier.GenderRaceCondition, null, out var which)) - { - if (which) - --EnabledCount; - else - --DisabledCount; - if (value.IsEmpty) - dict.Remove(identifier.Shape); - } - } - } -} diff --git a/Penumbra/Collections/CollectionAutoSelector.cs b/Penumbra/Collections/CollectionAutoSelector.cs deleted file mode 100644 index f6e6bf72..00000000 --- a/Penumbra/Collections/CollectionAutoSelector.cs +++ /dev/null @@ -1,82 +0,0 @@ -using Dalamud.Plugin.Services; -using OtterGui.Services; -using Penumbra.Collections.Manager; -using Penumbra.GameData.Interop; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Collections; - -public sealed class CollectionAutoSelector : IService, IDisposable -{ - private readonly Configuration _config; - private readonly ActiveCollections _collections; - private readonly IClientState _clientState; - private readonly CollectionResolver _resolver; - private readonly ObjectManager _objects; - - public CollectionAutoSelector(Configuration config, ActiveCollections collections, IClientState clientState, CollectionResolver resolver, - ObjectManager objects) - { - _config = config; - _collections = collections; - _clientState = clientState; - _resolver = resolver; - _objects = objects; - - if (_config.AutoSelectCollection) - Attach(); - } - - public bool Disposed { get; private set; } - - public void SetAutomaticSelection(bool value) - { - _config.AutoSelectCollection = value; - if (value) - Attach(); - else - Detach(); - } - - private void Attach() - { - if (Disposed) - return; - - _clientState.Login += OnLogin; - Select(); - } - - private void OnLogin() - => Select(); - - private void Detach() - => _clientState.Login -= OnLogin; - - private void Select() - { - if (!_objects[0].IsCharacter) - return; - - var collection = _resolver.PlayerCollection(); - if (collection.Identity.Id == Guid.Empty) - { - Penumbra.Log.Debug($"Not setting current collection because character has no mods assigned."); - } - else - { - Penumbra.Log.Debug($"Setting current collection to {collection.Identity.Identifier} through automatic collection selection."); - _collections.SetCollection(collection, CollectionType.Current); - } - } - - - public void Dispose() - { - if (Disposed) - return; - - Disposed = true; - Detach(); - } -} diff --git a/Penumbra/Collections/CollectionCounters.cs b/Penumbra/Collections/CollectionCounters.cs deleted file mode 100644 index 6ca0d0a0..00000000 --- a/Penumbra/Collections/CollectionCounters.cs +++ /dev/null @@ -1,28 +0,0 @@ -namespace Penumbra.Collections; - -public struct CollectionCounters(int changeCounter) -{ - /// Count the number of changes of the effective file list. - public int Change { get; private set; } = changeCounter; - - /// Count the number of IMC-relevant changes of the effective file list. - public int Imc { get; private set; } - - /// Count the number of ATCH-relevant changes of the effective file list. - public int Atch { get; private set; } - - /// Increment the number of changes in the effective file list. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public int IncrementChange() - => ++Change; - - /// Increment the number of IMC-relevant changes in the effective file list. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public int IncrementImc() - => ++Imc; - - /// Increment the number of ATCH-relevant changes in the effective file list. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public int IncrementAtch() - => ++Atch; -} diff --git a/Penumbra/Collections/Manager/ActiveCollectionMigration.cs b/Penumbra/Collections/Manager/ActiveCollectionMigration.cs index b4af0998..2f9e9b15 100644 --- a/Penumbra/Collections/Manager/ActiveCollectionMigration.cs +++ b/Penumbra/Collections/Manager/ActiveCollectionMigration.cs @@ -1,4 +1,4 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using Newtonsoft.Json.Linq; using OtterGui.Classes; @@ -48,7 +48,7 @@ public static class ActiveCollectionMigration if (!storage.ByName(collectionName, out var collection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of <{player}>'s Collection {collectionName} is not available, reset to {ModCollection.Empty.Identity.Name}.", NotificationType.Warning); + $"Last choice of <{player}>'s Collection {collectionName} is not available, reset to {ModCollection.Empty.Name}.", NotificationType.Warning); dict.Add(player, ModCollection.Empty); } else diff --git a/Penumbra/Collections/Manager/ActiveCollections.cs b/Penumbra/Collections/Manager/ActiveCollections.cs index ffec7fd2..4e8ebe36 100644 --- a/Penumbra/Collections/Manager/ActiveCollections.cs +++ b/Penumbra/Collections/Manager/ActiveCollections.cs @@ -1,9 +1,8 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using Newtonsoft.Json.Linq; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.Communication; using Penumbra.GameData.Actors; using Penumbra.GameData.Enums; @@ -12,7 +11,7 @@ using Penumbra.UI; namespace Penumbra.Collections.Manager; -public class ActiveCollectionData : IService +public class ActiveCollectionData { public ModCollection Current { get; internal set; } = ModCollection.Empty; public ModCollection Default { get; internal set; } = ModCollection.Empty; @@ -21,7 +20,7 @@ public class ActiveCollectionData : IService public readonly ModCollection?[] SpecialCollections = new ModCollection?[Enum.GetValues().Length - 3]; } -public class ActiveCollections : ISavable, IDisposable, IService +public class ActiveCollections : ISavable, IDisposable { public const int Version = 2; @@ -219,7 +218,7 @@ public class ActiveCollections : ISavable, IDisposable, IService _ => null, }; - if (oldCollection == null || collection == oldCollection || collection.Identity.Index >= _storage.Count) + if (oldCollection == null || collection == oldCollection || collection.Index >= _storage.Count) return; switch (collectionType) @@ -262,13 +261,13 @@ public class ActiveCollections : ISavable, IDisposable, IService var jObj = new JObject { { nameof(Version), Version }, - { nameof(Default), Default.Identity.Id }, - { nameof(Interface), Interface.Identity.Id }, - { nameof(Current), Current.Identity.Id }, + { nameof(Default), Default.Id }, + { nameof(Interface), Interface.Id }, + { nameof(Current), Current.Id }, }; foreach (var (type, collection) in SpecialCollections.WithIndex().Where(p => p.Value != null) .Select(p => ((CollectionType)p.Index, p.Value!))) - jObj.Add(type.ToString(), collection.Identity.Id); + jObj.Add(type.ToString(), collection.Id); jObj.Add(nameof(Individuals), Individuals.ToJObject()); using var j = new JsonTextWriter(writer); @@ -282,7 +281,7 @@ public class ActiveCollections : ISavable, IDisposable, IService .Prepend(Interface) .Prepend(Default) .Concat(Individuals.Assignments.Select(kvp => kvp.Collection)) - .SelectMany(c => c.Inheritance.FlatHierarchy).Contains(Current); + .SelectMany(c => c.GetFlattenedInheritance()).Contains(Current); /// Save if any of the active collections is changed and set new collections to Current. private void OnCollectionChange(CollectionType collectionType, ModCollection? oldCollection, ModCollection? newCollection, string _3) @@ -300,7 +299,7 @@ public class ActiveCollections : ISavable, IDisposable, IService if (oldCollection == Interface) SetCollection(ModCollection.Empty, CollectionType.Interface); if (oldCollection == Current) - SetCollection(Default.Identity.Index > ModCollection.Empty.Identity.Index ? Default : _storage.DefaultNamed, CollectionType.Current); + SetCollection(Default.Index > ModCollection.Empty.Index ? Default : _storage.DefaultNamed, CollectionType.Current); for (var i = 0; i < SpecialCollections.Length; ++i) { @@ -325,11 +324,11 @@ public class ActiveCollections : ISavable, IDisposable, IService { var configChanged = false; // Load the default collection. If the name does not exist take the empty collection. - var defaultName = jObject[nameof(Default)]?.ToObject() ?? ModCollection.Empty.Identity.Name; + var defaultName = jObject[nameof(Default)]?.ToObject() ?? ModCollection.Empty.Name; if (!_storage.ByName(defaultName, out var defaultCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.DefaultCollection} {defaultName} is not available, reset to {ModCollection.Empty.Identity.Name}.", + $"Last choice of {TutorialService.DefaultCollection} {defaultName} is not available, reset to {ModCollection.Empty.Name}.", NotificationType.Warning); Default = ModCollection.Empty; configChanged = true; @@ -340,11 +339,11 @@ public class ActiveCollections : ISavable, IDisposable, IService } // Load the interface collection. If no string is set, use the name of whatever was set as Default. - var interfaceName = jObject[nameof(Interface)]?.ToObject() ?? Default.Identity.Name; + var interfaceName = jObject[nameof(Interface)]?.ToObject() ?? Default.Name; if (!_storage.ByName(interfaceName, out var interfaceCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.InterfaceCollection} {interfaceName} is not available, reset to {ModCollection.Empty.Identity.Name}.", + $"Last choice of {TutorialService.InterfaceCollection} {interfaceName} is not available, reset to {ModCollection.Empty.Name}.", NotificationType.Warning); Interface = ModCollection.Empty; configChanged = true; @@ -355,11 +354,11 @@ public class ActiveCollections : ISavable, IDisposable, IService } // Load the current collection. - var currentName = jObject[nameof(Current)]?.ToObject() ?? Default.Identity.Name; + var currentName = jObject[nameof(Current)]?.ToObject() ?? Default.Name; if (!_storage.ByName(currentName, out var currentCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.SelectedCollection} {currentName} is not available, reset to {ModCollectionIdentity.DefaultCollectionName}.", + $"Last choice of {TutorialService.SelectedCollection} {currentName} is not available, reset to {ModCollection.DefaultCollectionName}.", NotificationType.Warning); Current = _storage.DefaultNamed; configChanged = true; @@ -404,7 +403,7 @@ public class ActiveCollections : ISavable, IDisposable, IService if (!_storage.ById(defaultId, out var defaultCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.DefaultCollection} {defaultId} is not available, reset to {ModCollection.Empty.Identity.Name}.", + $"Last choice of {TutorialService.DefaultCollection} {defaultId} is not available, reset to {ModCollection.Empty.Name}.", NotificationType.Warning); Default = ModCollection.Empty; configChanged = true; @@ -415,11 +414,11 @@ public class ActiveCollections : ISavable, IDisposable, IService } // Load the interface collection. If no string is set, use the name of whatever was set as Default. - var interfaceId = jObject[nameof(Interface)]?.ToObject() ?? Default.Identity.Id; + var interfaceId = jObject[nameof(Interface)]?.ToObject() ?? Default.Id; if (!_storage.ById(interfaceId, out var interfaceCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.InterfaceCollection} {interfaceId} is not available, reset to {ModCollection.Empty.Identity.Name}.", + $"Last choice of {TutorialService.InterfaceCollection} {interfaceId} is not available, reset to {ModCollection.Empty.Name}.", NotificationType.Warning); Interface = ModCollection.Empty; configChanged = true; @@ -430,11 +429,11 @@ public class ActiveCollections : ISavable, IDisposable, IService } // Load the current collection. - var currentId = jObject[nameof(Current)]?.ToObject() ?? _storage.DefaultNamed.Identity.Id; + var currentId = jObject[nameof(Current)]?.ToObject() ?? _storage.DefaultNamed.Id; if (!_storage.ById(currentId, out var currentCollection)) { Penumbra.Messager.NotificationMessage( - $"Last choice of {TutorialService.SelectedCollection} {currentId} is not available, reset to {ModCollectionIdentity.DefaultCollectionName}.", + $"Last choice of {TutorialService.SelectedCollection} {currentId} is not available, reset to {ModCollection.DefaultCollectionName}.", NotificationType.Warning); Current = _storage.DefaultNamed; configChanged = true; @@ -587,7 +586,7 @@ public class ActiveCollections : ISavable, IDisposable, IService case IdentifierType.Player when id.HomeWorld != ushort.MaxValue: { var global = ByType(CollectionType.Individual, _actors.CreatePlayer(id.PlayerName, ushort.MaxValue)); - return (global != null ? global.Identity.Index : null) == checkAssignment.Identity.Index + return global?.Index == checkAssignment.Index ? "Assignment is redundant due to an identical Any-World assignment existing.\nYou can remove it." : string.Empty; } @@ -596,12 +595,12 @@ public class ActiveCollections : ISavable, IDisposable, IService { var global = ByType(CollectionType.Individual, _actors.CreateOwned(id.PlayerName, ushort.MaxValue, id.Kind, id.DataId)); - if ((global != null ? global.Identity.Index : null) == checkAssignment.Identity.Index) + if (global?.Index == checkAssignment.Index) return "Assignment is redundant due to an identical Any-World assignment existing.\nYou can remove it."; } var unowned = ByType(CollectionType.Individual, _actors.CreateNpc(id.Kind, id.DataId)); - return (unowned != null ? unowned.Identity.Index : null) == checkAssignment.Identity.Index + return unowned?.Index == checkAssignment.Index ? "Assignment is redundant due to an identical unowned NPC assignment existing.\nYou can remove it." : string.Empty; } @@ -617,7 +616,7 @@ public class ActiveCollections : ISavable, IDisposable, IService if (maleNpc == null) { maleNpc = Default; - if (maleNpc.Identity.Index != checkAssignment.Identity.Index) + if (maleNpc.Index != checkAssignment.Index) return string.Empty; collection1 = CollectionType.Default; @@ -626,7 +625,7 @@ public class ActiveCollections : ISavable, IDisposable, IService if (femaleNpc == null) { femaleNpc = Default; - if (femaleNpc.Identity.Index != checkAssignment.Identity.Index) + if (femaleNpc.Index != checkAssignment.Index) return string.Empty; collection2 = CollectionType.Default; @@ -646,7 +645,7 @@ public class ActiveCollections : ISavable, IDisposable, IService if (assignment == null) continue; - if (assignment.Identity.Index == checkAssignment.Identity.Index) + if (assignment.Index == checkAssignment.Index) return $"Assignment is currently redundant due to overwriting {parentType.ToName()} with an identical collection.\nYou can remove it."; } diff --git a/Penumbra/Collections/Manager/CollectionEditor.cs b/Penumbra/Collections/Manager/CollectionEditor.cs index f62eea3f..0243de1e 100644 --- a/Penumbra/Collections/Manager/CollectionEditor.cs +++ b/Penumbra/Collections/Manager/CollectionEditor.cs @@ -1,5 +1,4 @@ -using OtterGui.Extensions; -using OtterGui.Services; +using OtterGui; using Penumbra.Api.Enums; using Penumbra.Mods; using Penumbra.Mods.Manager; @@ -8,7 +7,7 @@ using Penumbra.Services; namespace Penumbra.Collections.Manager; -public class CollectionEditor(SaveService saveService, CommunicatorService communicator, ModStorage modStorage) : IService +public class CollectionEditor(SaveService saveService, CommunicatorService communicator, ModStorage modStorage) { /// Enable or disable the mod inheritance of mod idx. public bool SetModInheritance(ModCollection collection, Mod mod, bool inherit) @@ -26,12 +25,12 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu /// public bool SetModState(ModCollection collection, Mod mod, bool newValue) { - var oldValue = collection.GetInheritedSettings(mod.Index).Settings?.Enabled ?? false; + var oldValue = collection.Settings[mod.Index]?.Enabled ?? collection[mod.Index].Settings?.Enabled ?? false; if (newValue == oldValue) return false; var inheritance = FixInheritance(collection, mod, false); - collection.GetOwnSettings(mod.Index)!.Enabled = newValue; + ((List)collection.Settings)[mod.Index]!.Enabled = newValue; InvokeChange(collection, ModSettingChange.EnableState, mod, inheritance ? Setting.Indefinite : newValue ? Setting.False : Setting.True, 0); return true; @@ -55,13 +54,13 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu var changes = false; foreach (var mod in mods) { - var oldValue = collection.GetOwnSettings(mod.Index)?.Enabled; + var oldValue = collection.Settings[mod.Index]?.Enabled; if (newValue == oldValue) continue; FixInheritance(collection, mod, false); - collection.GetOwnSettings(mod.Index)!.Enabled = newValue; - changes = true; + ((List)collection.Settings)[mod.Index]!.Enabled = newValue; + changes = true; } if (!changes) @@ -76,64 +75,35 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu /// public bool SetModPriority(ModCollection collection, Mod mod, ModPriority newValue) { - var oldValue = collection.GetInheritedSettings(mod.Index).Settings?.Priority ?? ModPriority.Default; + var oldValue = collection.Settings[mod.Index]?.Priority ?? collection[mod.Index].Settings?.Priority ?? ModPriority.Default; if (newValue == oldValue) return false; var inheritance = FixInheritance(collection, mod, false); - collection.GetOwnSettings(mod.Index)!.Priority = newValue; + ((List)collection.Settings)[mod.Index]!.Priority = newValue; InvokeChange(collection, ModSettingChange.Priority, mod, inheritance ? Setting.Indefinite : oldValue.AsSetting, 0); return true; } /// /// Set a given setting group settingName of mod idx to newValue if it differs from the current value and fix it if necessary. - /// If the mod is currently inherited, stop the inheritance. + /// /// If the mod is currently inherited, stop the inheritance. /// public bool SetModSetting(ModCollection collection, Mod mod, int groupIdx, Setting newValue) { - var settings = collection.GetInheritedSettings(mod.Index).Settings?.Settings; + var settings = collection.Settings[mod.Index] != null + ? collection.Settings[mod.Index]!.Settings + : collection[mod.Index].Settings?.Settings; var oldValue = settings?[groupIdx] ?? mod.Groups[groupIdx].DefaultSettings; if (oldValue == newValue) return false; var inheritance = FixInheritance(collection, mod, false); - collection.GetOwnSettings(mod.Index)!.SetValue(mod, groupIdx, newValue); + ((List)collection.Settings)[mod.Index]!.SetValue(mod, groupIdx, newValue); InvokeChange(collection, ModSettingChange.Setting, mod, inheritance ? Setting.Indefinite : oldValue, groupIdx); return true; } - public bool SetTemporarySettings(ModCollection collection, Mod mod, TemporaryModSettings? settings, int key = 0) - { - key = settings?.Lock ?? key; - if (!CanSetTemporarySettings(collection, mod, key)) - return false; - - collection.Settings.SetTemporary(mod.Index, settings); - InvokeChange(collection, ModSettingChange.TemporarySetting, mod, Setting.Indefinite, 0); - return true; - } - - public int ClearTemporarySettings(ModCollection collection, int key = 0) - { - var numRemoved = 0; - for (var i = 0; i < collection.Settings.Count; ++i) - { - if (collection.GetTempSettings(i) is { } tempSettings - && tempSettings.Lock == key - && SetTemporarySettings(collection, modStorage[i], null, key)) - ++numRemoved; - } - - return numRemoved; - } - - public bool CanSetTemporarySettings(ModCollection collection, Mod mod, int key) - { - var old = collection.GetTempSettings(mod.Index); - return old is not { Lock: > 0 } || old.Lock == key; - } - /// Copy the settings of an existing (sourceMod != null) or stored (sourceName) mod to another mod, if they exist. public bool CopyModSettings(ModCollection collection, Mod? sourceMod, string sourceName, Mod? targetMod, string targetName) { @@ -144,10 +114,10 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu // If it does not exist, check unused settings. // If it does not exist and has no unused settings, also use null. ModSettings.SavedSettings? savedSettings = sourceMod != null - ? collection.GetOwnSettings(sourceMod.Index) is { } ownSettings - ? new ModSettings.SavedSettings(ownSettings, sourceMod) + ? collection.Settings[sourceMod.Index] != null + ? new ModSettings.SavedSettings(collection.Settings[sourceMod.Index]!, sourceMod) : null - : collection.Settings.Unused.TryGetValue(sourceName, out var s) + : collection.UnusedSettings.TryGetValue(sourceName, out var s) ? s : null; @@ -177,10 +147,10 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu // or remove any unused settings for the target if they are inheriting. if (savedSettings != null) { - ((Dictionary)collection.Settings.Unused)[targetName] = savedSettings.Value; + ((Dictionary)collection.UnusedSettings)[targetName] = savedSettings.Value; saveService.QueueSave(new ModCollectionSave(modStorage, collection)); } - else if (((Dictionary)collection.Settings.Unused).Remove(targetName)) + else if (((Dictionary)collection.UnusedSettings).Remove(targetName)) { saveService.QueueSave(new ModCollectionSave(modStorage, collection)); } @@ -195,12 +165,12 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu /// private static bool FixInheritance(ModCollection collection, Mod mod, bool inherit) { - var settings = collection.GetOwnSettings(mod.Index); + var settings = collection.Settings[mod.Index]; if (inherit == (settings == null)) return false; - var settings1 = inherit ? null : collection.GetInheritedSettings(mod.Index).Settings?.DeepCopy() ?? ModSettings.DefaultSettings(mod); - collection.Settings.Set(mod.Index, settings1); + ((List)collection.Settings)[mod.Index] = + inherit ? null : collection[mod.Index].Settings?.DeepCopy() ?? ModSettings.DefaultSettings(mod); return true; } @@ -208,18 +178,16 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private void InvokeChange(ModCollection changedCollection, ModSettingChange type, Mod? mod, Setting oldValue, int groupIdx) { - if (type is not ModSettingChange.TemporarySetting) - saveService.QueueSave(new ModCollectionSave(modStorage, changedCollection)); + saveService.QueueSave(new ModCollectionSave(modStorage, changedCollection)); communicator.ModSettingChanged.Invoke(changedCollection, type, mod, oldValue, groupIdx, false); - if (type is not ModSettingChange.TemporarySetting) - RecurseInheritors(changedCollection, type, mod, oldValue, groupIdx); + RecurseInheritors(changedCollection, type, mod, oldValue, groupIdx); } /// Trigger changes in all inherited collections. [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private void RecurseInheritors(ModCollection directParent, ModSettingChange type, Mod? mod, Setting oldValue, int groupIdx) { - foreach (var directInheritor in directParent.Inheritance.DirectlyInheritedBy) + foreach (var directInheritor in directParent.DirectParentOf) { switch (type) { @@ -228,7 +196,7 @@ public class CollectionEditor(SaveService saveService, CommunicatorService commu communicator.ModSettingChanged.Invoke(directInheritor, type, null, oldValue, groupIdx, true); break; default: - if (directInheritor.GetOwnSettings(mod!.Index) == null) + if (directInheritor.Settings[mod!.Index] == null) communicator.ModSettingChanged.Invoke(directInheritor, type, mod, oldValue, groupIdx, true); break; } diff --git a/Penumbra/Collections/Manager/CollectionManager.cs b/Penumbra/Collections/Manager/CollectionManager.cs index 85f5b957..e95617b1 100644 --- a/Penumbra/Collections/Manager/CollectionManager.cs +++ b/Penumbra/Collections/Manager/CollectionManager.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using Penumbra.Collections.Cache; namespace Penumbra.Collections.Manager; @@ -9,7 +8,7 @@ public class CollectionManager( InheritanceManager inheritances, CollectionCacheManager caches, TempCollectionManager temp, - CollectionEditor editor) : IService + CollectionEditor editor) { public readonly CollectionStorage Storage = storage; public readonly ActiveCollections Active = active; diff --git a/Penumbra/Collections/Manager/CollectionStorage.cs b/Penumbra/Collections/Manager/CollectionStorage.cs index 531b6333..de5d0a14 100644 --- a/Penumbra/Collections/Manager/CollectionStorage.cs +++ b/Penumbra/Collections/Manager/CollectionStorage.cs @@ -1,7 +1,6 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.Communication; using Penumbra.Mods; using Penumbra.Mods.Editor; @@ -14,67 +13,20 @@ using Penumbra.Services; namespace Penumbra.Collections.Manager; -/// A contiguously incrementing ID managed by the CollectionCreator. -public readonly record struct LocalCollectionId(int Id) : IAdditionOperators -{ - public static readonly LocalCollectionId Zero = new(0); - - public static LocalCollectionId operator +(LocalCollectionId left, int right) - => new(left.Id + right); -} - -public class CollectionStorage : IReadOnlyList, IDisposable, IService +public class CollectionStorage : IReadOnlyList, IDisposable { private readonly CommunicatorService _communicator; private readonly SaveService _saveService; private readonly ModStorage _modStorage; - public ModCollection Create(string name, int index, ModCollection? duplicate) - { - var newCollection = duplicate?.Duplicate(name, CurrentCollectionId, index) - ?? ModCollection.CreateEmpty(name, CurrentCollectionId, index, _modStorage.Count); - _collectionsByLocal[CurrentCollectionId] = newCollection; - CurrentCollectionId += 1; - return newCollection; - } - - public ModCollection CreateFromData(Guid id, string name, int version, Dictionary allSettings, - IReadOnlyList inheritances) - { - var newCollection = ModCollection.CreateFromData(_saveService, _modStorage, - new ModCollectionIdentity(id, CurrentCollectionId, name, Count), version, allSettings, inheritances); - _collectionsByLocal[CurrentCollectionId] = newCollection; - CurrentCollectionId += 1; - return newCollection; - } - - public ModCollection CreateTemporary(string name, int index, int globalChangeCounter) - { - var newCollection = ModCollection.CreateTemporary(name, CurrentCollectionId, index, globalChangeCounter); - _collectionsByLocal[CurrentCollectionId] = newCollection; - CurrentCollectionId += 1; - return newCollection; - } - - public void Delete(ModCollection collection) - => _collectionsByLocal.Remove(collection.Identity.LocalId); - /// The empty collection is always available at Index 0. private readonly List _collections = [ ModCollection.Empty, ]; - /// A list of all collections ever created still existing by their local id. - private readonly Dictionary - _collectionsByLocal = new() { [LocalCollectionId.Zero] = ModCollection.Empty }; - - public readonly ModCollection DefaultNamed; - /// Incremented by 1 because the empty collection gets Zero. - public LocalCollectionId CurrentCollectionId { get; private set; } = LocalCollectionId.Zero + 1; - /// Default enumeration skips the empty collection. public IEnumerator GetEnumerator() => _collections.Skip(1).GetEnumerator(); @@ -92,7 +44,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer public bool ByName(string name, [NotNullWhen(true)] out ModCollection? collection) { if (name.Length != 0) - return _collections.FindFirst(c => string.Equals(c.Identity.Name, name, StringComparison.OrdinalIgnoreCase), out collection); + return _collections.FindFirst(c => string.Equals(c.Name, name, StringComparison.OrdinalIgnoreCase), out collection); collection = ModCollection.Empty; return true; @@ -102,7 +54,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer public bool ById(Guid id, [NotNullWhen(true)] out ModCollection? collection) { if (id != Guid.Empty) - return _collections.FindFirst(c => c.Identity.Id == id, out collection); + return _collections.FindFirst(c => c.Id == id, out collection); collection = ModCollection.Empty; return true; @@ -117,10 +69,6 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer return ByName(identifier, out collection); } - /// Find a collection by its local ID if it still exists, otherwise returns the empty collection. - public ModCollection ByLocalId(LocalCollectionId localId) - => _collectionsByLocal.TryGetValue(localId, out var coll) ? coll : ModCollection.Empty; - public CollectionStorage(CommunicatorService communicator, SaveService saveService, ModStorage modStorage) { _communicator = communicator; @@ -152,13 +100,12 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer /// public bool AddCollection(string name, ModCollection? duplicate) { - if (name.Length == 0) - return false; - - var newCollection = Create(name, _collections.Count, duplicate); + var newCollection = duplicate?.Duplicate(name, _collections.Count) + ?? ModCollection.CreateEmpty(name, _collections.Count, _modStorage.Count); _collections.Add(newCollection); + _saveService.ImmediateSave(new ModCollectionSave(_modStorage, newCollection)); - Penumbra.Messager.NotificationMessage($"Created new collection {newCollection.Identity.AnonymizedName}.", NotificationType.Success, false); + Penumbra.Messager.NotificationMessage($"Created new collection {newCollection.AnonymizedName}.", NotificationType.Success, false); _communicator.CollectionChange.Invoke(CollectionType.Inactive, null, newCollection, string.Empty); return true; } @@ -168,48 +115,42 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer /// public bool RemoveCollection(ModCollection collection) { - if (collection.Identity.Index <= ModCollection.Empty.Identity.Index || collection.Identity.Index >= _collections.Count) + if (collection.Index <= ModCollection.Empty.Index || collection.Index >= _collections.Count) { Penumbra.Messager.NotificationMessage("Can not remove the empty collection.", NotificationType.Error, false); return false; } - if (collection.Identity.Index == DefaultNamed.Identity.Index) + if (collection.Index == DefaultNamed.Index) { Penumbra.Messager.NotificationMessage("Can not remove the default collection.", NotificationType.Error, false); return false; } - Delete(collection); _saveService.ImmediateDelete(new ModCollectionSave(_modStorage, collection)); - _collections.RemoveAt(collection.Identity.Index); + _collections.RemoveAt(collection.Index); // Update indices. - for (var i = collection.Identity.Index; i < Count; ++i) - _collections[i].Identity.Index = i; - _collectionsByLocal.Remove(collection.Identity.LocalId); + for (var i = collection.Index; i < Count; ++i) + _collections[i].Index = i; - Penumbra.Messager.NotificationMessage($"Deleted collection {collection.Identity.AnonymizedName}.", NotificationType.Success, false); + Penumbra.Messager.NotificationMessage($"Deleted collection {collection.AnonymizedName}.", NotificationType.Success, false); _communicator.CollectionChange.Invoke(CollectionType.Inactive, collection, null, string.Empty); return true; } /// Remove all settings for not currently-installed mods from the given collection. - public int CleanUnavailableSettings(ModCollection collection) + public void CleanUnavailableSettings(ModCollection collection) { - var count = collection.Settings.Unused.Count; - if (count > 0) - { - ((Dictionary)collection.Settings.Unused).Clear(); + var any = collection.UnusedSettings.Count > 0; + ((Dictionary)collection.UnusedSettings).Clear(); + if (any) _saveService.QueueSave(new ModCollectionSave(_modStorage, collection)); - } - - return count; } /// Remove a specific setting for not currently-installed mods from the given collection. public void CleanUnavailableSetting(ModCollection collection, string? setting) { - if (setting != null && ((Dictionary)collection.Settings.Unused).Remove(setting)) + if (setting != null && ((Dictionary)collection.UnusedSettings).Remove(setting)) _saveService.QueueSave(new ModCollectionSave(_modStorage, collection)); } @@ -239,7 +180,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer continue; } - var collection = CreateFromData(id, name, version, settings, inheritance); + var collection = ModCollection.CreateFromData(_saveService, _modStorage, id, name, version, Count, settings, inheritance); var correctName = _saveService.FileNames.CollectionFile(collection); if (file.FullName != correctName) try @@ -250,13 +191,13 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer { File.Move(file.FullName, correctName, false); Penumbra.Messager.NotificationMessage( - $"Collection {file.Name} does not correspond to {collection.Identity.Identifier}, renamed.", + $"Collection {file.Name} does not correspond to {collection.Identifier}, renamed.", NotificationType.Warning); } catch (Exception ex) { Penumbra.Messager.NotificationMessage( - $"Collection {file.Name} does not correspond to {collection.Identity.Identifier}, rename failed:\n{ex}", + $"Collection {file.Name} does not correspond to {collection.Identifier}, rename failed:\n{ex}", NotificationType.Warning); } } @@ -277,7 +218,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer catch (Exception e) { Penumbra.Messager.NotificationMessage(e, - $"Collection {file.Name} does not correspond to {collection.Identity.Identifier}, but could not rename.", + $"Collection {file.Name} does not correspond to {collection.Identifier}, but could not rename.", NotificationType.Error); } @@ -295,14 +236,14 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer /// private ModCollection SetDefaultNamedCollection() { - if (ByName(ModCollectionIdentity.DefaultCollectionName, out var collection)) + if (ByName(ModCollection.DefaultCollectionName, out var collection)) return collection; - if (AddCollection(ModCollectionIdentity.DefaultCollectionName, null)) + if (AddCollection(ModCollection.DefaultCollectionName, null)) return _collections[^1]; Penumbra.Messager.NotificationMessage( - $"Unknown problem creating a collection with the name {ModCollectionIdentity.DefaultCollectionName}, which is required to exist.", + $"Unknown problem creating a collection with the name {ModCollection.DefaultCollectionName}, which is required to exist.", NotificationType.Error); return Count > 1 ? _collections[1] : _collections[0]; } @@ -311,7 +252,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer private void OnModDiscoveryStarted() { foreach (var collection in this) - collection.Settings.PrepareModDiscovery(_modStorage); + collection.PrepareModDiscovery(_modStorage); } /// Restore all settings in all collections to mods. @@ -319,7 +260,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer { // Re-apply all mod settings. foreach (var collection in this) - collection.Settings.ApplyModSettings(collection, _saveService, _modStorage); + collection.ApplyModSettings(_saveService, _modStorage); } /// Add or remove a mod from all collections, or re-save all collections where the mod has settings. @@ -330,22 +271,21 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer { case ModPathChangeType.Added: foreach (var collection in this) - collection.Settings.AddMod(mod); + collection.AddMod(mod); break; case ModPathChangeType.Deleted: foreach (var collection in this) - collection.Settings.RemoveMod(mod); + collection.RemoveMod(mod); break; case ModPathChangeType.Moved: - foreach (var collection in this.Where(collection => collection.GetOwnSettings(mod.Index) != null)) + foreach (var collection in this.Where(collection => collection.Settings[mod.Index] != null)) _saveService.QueueSave(new ModCollectionSave(_modStorage, collection)); break; case ModPathChangeType.Reloaded: foreach (var collection in this) { - if (collection.GetOwnSettings(mod.Index)?.Settings.FixAll(mod) ?? false) + if (collection.Settings[mod.Index]?.Settings.FixAll(mod) ?? false) _saveService.QueueSave(new ModCollectionSave(_modStorage, collection)); - collection.Settings.SetTemporary(mod.Index, null); } break; @@ -353,8 +293,7 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer } /// Save all collections where the mod has settings and the change requires saving. - private void OnModOptionChange(ModOptionChangeType type, Mod mod, IModGroup? group, IModOption? option, IModDataContainer? container, - int movedToIdx) + private void OnModOptionChange(ModOptionChangeType type, Mod mod, IModGroup? group, IModOption? option, IModDataContainer? container, int movedToIdx) { type.HandlingInfo(out var requiresSaving, out _, out _); if (!requiresSaving) @@ -362,9 +301,8 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer foreach (var collection in this) { - if (collection.GetOwnSettings(mod.Index)?.HandleChanges(type, mod, group, option, movedToIdx) ?? false) + if (collection.Settings[mod.Index]?.HandleChanges(type, mod, group, option, movedToIdx) ?? false) _saveService.QueueSave(new ModCollectionSave(_modStorage, collection)); - collection.Settings.SetTemporary(mod.Index, null); } } @@ -376,9 +314,9 @@ public class CollectionStorage : IReadOnlyList, IDisposable, ISer foreach (var collection in this) { - var (settings, _) = collection.GetActualSettings(mod.Index); + var (settings, _) = collection[mod.Index]; if (settings is { Enabled: true }) - collection.Counters.IncrementChange(); + collection.IncrementCounter(); } } } diff --git a/Penumbra/Collections/Manager/IndividualCollections.Access.cs b/Penumbra/Collections/Manager/IndividualCollections.Access.cs index d0a70630..785f0013 100644 --- a/Penumbra/Collections/Manager/IndividualCollections.Access.cs +++ b/Penumbra/Collections/Manager/IndividualCollections.Access.cs @@ -48,7 +48,8 @@ public sealed partial class IndividualCollections : IReadOnlyList<(string Displa // Handle generic NPC var npcIdentifier = _actors.CreateIndividualUnchecked(IdentifierType.Npc, ByteString.Empty, - ushort.MaxValue, identifier.Kind, identifier.DataId); + ushort.MaxValue, + identifier.Kind, identifier.DataId); if (npcIdentifier.IsValid && _individuals.TryGetValue(npcIdentifier, out collection)) return true; @@ -57,7 +58,8 @@ public sealed partial class IndividualCollections : IReadOnlyList<(string Displa return false; identifier = _actors.CreateIndividualUnchecked(IdentifierType.Player, identifier.PlayerName, - identifier.HomeWorld.Id, ObjectKind.None, uint.MaxValue); + identifier.HomeWorld.Id, + ObjectKind.None, uint.MaxValue); return CheckWorlds(identifier, out collection); } case IdentifierType.Npc: return _individuals.TryGetValue(identifier, out collection); @@ -125,7 +127,7 @@ public sealed partial class IndividualCollections : IReadOnlyList<(string Displa } } - public bool TryGetCollection(IGameObject? gameObject, out ModCollection? collection) + public bool TryGetCollection(GameObject? gameObject, out ModCollection? collection) => TryGetCollection(_actors.FromObject(gameObject, true, false, false), out collection); public unsafe bool TryGetCollection(FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* gameObject, out ModCollection? collection) diff --git a/Penumbra/Collections/Manager/IndividualCollections.Files.cs b/Penumbra/Collections/Manager/IndividualCollections.Files.cs index 60e9fc5f..8a717b35 100644 --- a/Penumbra/Collections/Manager/IndividualCollections.Files.cs +++ b/Penumbra/Collections/Manager/IndividualCollections.Files.cs @@ -1,5 +1,5 @@ using Dalamud.Game.ClientState.Objects.Enums; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json.Linq; using OtterGui.Classes; using Penumbra.GameData.Actors; @@ -18,7 +18,7 @@ public partial class IndividualCollections foreach (var (name, identifiers, collection) in Assignments) { var tmp = identifiers[0].ToJson(); - tmp.Add("Collection", collection.Identity.Id); + tmp.Add("Collection", collection.Id); tmp.Add("Display", name); ret.Add(tmp); } @@ -182,7 +182,7 @@ public partial class IndividualCollections Penumbra.Log.Information($"Migrated {name} ({kind.ToName()}) to NPC Identifiers [{ids}]."); else Penumbra.Messager.NotificationMessage( - $"Could not migrate {name} ({collection.Identity.AnonymizedName}) which was assumed to be a {kind.ToName()} with IDs [{ids}], please look through your individual collections.", + $"Could not migrate {name} ({collection.AnonymizedName}) which was assumed to be a {kind.ToName()} with IDs [{ids}], please look through your individual collections.", NotificationType.Error); } // If it is not a valid NPC name, check if it can be a player name. @@ -192,16 +192,16 @@ public partial class IndividualCollections var shortName = string.Join(" ", name.Split().Select(n => $"{n[0]}.")); // Try to migrate the player name without logging full names. if (Add($"{name} ({_actors.Data.ToWorldName(identifier.HomeWorld)})", [identifier], collection)) - Penumbra.Log.Information($"Migrated {shortName} ({collection.Identity.AnonymizedName}) to Player Identifier."); + Penumbra.Log.Information($"Migrated {shortName} ({collection.AnonymizedName}) to Player Identifier."); else Penumbra.Messager.NotificationMessage( - $"Could not migrate {shortName} ({collection.Identity.AnonymizedName}), please look through your individual collections.", + $"Could not migrate {shortName} ({collection.AnonymizedName}), please look through your individual collections.", NotificationType.Error); } else { Penumbra.Messager.NotificationMessage( - $"Could not migrate {name} ({collection.Identity.AnonymizedName}), which can not be a player name nor is it a known NPC name, please look through your individual collections.", + $"Could not migrate {name} ({collection.AnonymizedName}), which can not be a player name nor is it a known NPC name, please look through your individual collections.", NotificationType.Error); } } diff --git a/Penumbra/Collections/Manager/InheritanceManager.cs b/Penumbra/Collections/Manager/InheritanceManager.cs index 34582677..6003b5f9 100644 --- a/Penumbra/Collections/Manager/InheritanceManager.cs +++ b/Penumbra/Collections/Manager/InheritanceManager.cs @@ -1,10 +1,12 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; +using OtterGui.Filesystem; using Penumbra.Communication; using Penumbra.Mods.Manager; using Penumbra.Services; +using Penumbra.UI.CollectionTab; +using Penumbra.Util; namespace Penumbra.Collections.Manager; @@ -13,7 +15,7 @@ namespace Penumbra.Collections.Manager; /// This is transitive, so a collection A inheriting from B also inherits from everything B inherits. /// Circular dependencies are resolved by distinctness. /// -public class InheritanceManager : IDisposable, IService +public class InheritanceManager : IDisposable { public enum ValidInheritance { @@ -62,10 +64,10 @@ public class InheritanceManager : IDisposable, IService if (ReferenceEquals(potentialParent, potentialInheritor)) return ValidInheritance.Self; - if (potentialInheritor.Inheritance.DirectlyInheritsFrom.Contains(potentialParent)) + if (potentialInheritor.DirectlyInheritsFrom.Contains(potentialParent)) return ValidInheritance.Contained; - if (potentialParent.Inheritance.FlatHierarchy.Any(c => ReferenceEquals(c, potentialInheritor))) + if (ModCollection.InheritedCollections(potentialParent).Any(c => ReferenceEquals(c, potentialInheritor))) return ValidInheritance.Circle; return ValidInheritance.Valid; @@ -82,23 +84,25 @@ public class InheritanceManager : IDisposable, IService /// Remove an existing inheritance from a collection. public void RemoveInheritance(ModCollection inheritor, int idx) { - var parent = inheritor.Inheritance.RemoveInheritanceAt(inheritor, idx); + var parent = inheritor.DirectlyInheritsFrom[idx]; + ((List)inheritor.DirectlyInheritsFrom).RemoveAt(idx); + ((List)parent.DirectParentOf).Remove(inheritor); _saveService.QueueSave(new ModCollectionSave(_modStorage, inheritor)); _communicator.CollectionInheritanceChanged.Invoke(inheritor, false); - RecurseInheritanceChanges(inheritor, true); - Penumbra.Log.Debug($"Removed {parent.Identity.AnonymizedName} from {inheritor.Identity.AnonymizedName} inheritances."); + RecurseInheritanceChanges(inheritor); + Penumbra.Log.Debug($"Removed {parent.AnonymizedName} from {inheritor.AnonymizedName} inheritances."); } /// Order in the inheritance list is relevant. public void MoveInheritance(ModCollection inheritor, int from, int to) { - if (!inheritor.Inheritance.MoveInheritance(inheritor, from, to)) + if (!((List)inheritor.DirectlyInheritsFrom).Move(from, to)) return; _saveService.QueueSave(new ModCollectionSave(_modStorage, inheritor)); _communicator.CollectionInheritanceChanged.Invoke(inheritor, false); - RecurseInheritanceChanges(inheritor, true); - Penumbra.Log.Debug($"Moved {inheritor.Identity.AnonymizedName}s inheritance {from} to {to}."); + RecurseInheritanceChanges(inheritor); + Penumbra.Log.Debug($"Moved {inheritor.AnonymizedName}s inheritance {from} to {to}."); } /// @@ -107,16 +111,16 @@ public class InheritanceManager : IDisposable, IService if (CheckValidInheritance(inheritor, parent) != ValidInheritance.Valid) return false; - inheritor.Inheritance.AddInheritance(inheritor, parent); + ((List)inheritor.DirectlyInheritsFrom).Add(parent); + ((List)parent.DirectParentOf).Add(inheritor); if (invokeEvent) { _saveService.QueueSave(new ModCollectionSave(_modStorage, inheritor)); _communicator.CollectionInheritanceChanged.Invoke(inheritor, false); + RecurseInheritanceChanges(inheritor); } - RecurseInheritanceChanges(inheritor, invokeEvent); - - Penumbra.Log.Debug($"Added {parent.Identity.AnonymizedName} to {inheritor.Identity.AnonymizedName} inheritances."); + Penumbra.Log.Debug($"Added {parent.AnonymizedName} to {inheritor.AnonymizedName} inheritances."); return true; } @@ -128,11 +132,11 @@ public class InheritanceManager : IDisposable, IService { foreach (var collection in _storage) { - if (collection.Inheritance.ConsumeNames() is not { } byName) + if (collection.InheritanceByName == null) continue; var changes = false; - foreach (var subCollectionName in byName) + foreach (var subCollectionName in collection.InheritanceByName) { if (Guid.TryParse(subCollectionName, out var guid) && _storage.ById(guid, out var subCollection)) { @@ -140,30 +144,26 @@ public class InheritanceManager : IDisposable, IService continue; changes = true; - Penumbra.Messager.NotificationMessage( - $"{collection.Identity.Name} can not inherit from {subCollection.Identity.Name}, removed.", - NotificationType.Warning); + Penumbra.Messager.NotificationMessage($"{collection.Name} can not inherit from {subCollection.Name}, removed.", NotificationType.Warning); } else if (_storage.ByName(subCollectionName, out subCollection)) { changes = true; - Penumbra.Log.Information($"Migrating inheritance for {collection.Identity.AnonymizedName} from name to GUID."); + Penumbra.Log.Information($"Migrating inheritance for {collection.AnonymizedName} from name to GUID."); if (AddInheritance(collection, subCollection, false)) continue; - Penumbra.Messager.NotificationMessage( - $"{collection.Identity.Name} can not inherit from {subCollection.Identity.Name}, removed.", - NotificationType.Warning); + Penumbra.Messager.NotificationMessage($"{collection.Name} can not inherit from {subCollection.Name}, removed.", NotificationType.Warning); } else { Penumbra.Messager.NotificationMessage( - $"Inherited collection {subCollectionName} for {collection.Identity.AnonymizedName} does not exist, it was removed.", - NotificationType.Warning); + $"Inherited collection {subCollectionName} for {collection.AnonymizedName} does not exist, it was removed.", NotificationType.Warning); changes = true; } } + collection.InheritanceByName = null; if (changes) _saveService.ImmediateSave(new ModCollectionSave(_modStorage, collection)); } @@ -176,22 +176,20 @@ public class InheritanceManager : IDisposable, IService foreach (var c in _storage) { - var inheritedIdx = c.Inheritance.DirectlyInheritsFrom.IndexOf(old); + var inheritedIdx = c.DirectlyInheritsFrom.IndexOf(old); if (inheritedIdx >= 0) RemoveInheritance(c, inheritedIdx); - c.Inheritance.RemoveChild(old); + ((List)c.DirectParentOf).Remove(old); } } - private void RecurseInheritanceChanges(ModCollection newInheritor, bool invokeEvent) + private void RecurseInheritanceChanges(ModCollection newInheritor) { - foreach (var inheritor in newInheritor.Inheritance.DirectlyInheritedBy) + foreach (var inheritor in newInheritor.DirectParentOf) { - ModCollectionInheritance.UpdateFlattenedInheritance(inheritor); - RecurseInheritanceChanges(inheritor, invokeEvent); - if (invokeEvent) - _communicator.CollectionInheritanceChanged.Invoke(inheritor, true); + _communicator.CollectionInheritanceChanged.Invoke(inheritor, true); + RecurseInheritanceChanges(inheritor); } } } diff --git a/Penumbra/Collections/Manager/ModCollectionMigration.cs b/Penumbra/Collections/Manager/ModCollectionMigration.cs index 7db375f7..fe61285d 100644 --- a/Penumbra/Collections/Manager/ModCollectionMigration.cs +++ b/Penumbra/Collections/Manager/ModCollectionMigration.cs @@ -26,12 +26,12 @@ internal static class ModCollectionMigration // Remove all completely defaulted settings from active and inactive mods. for (var i = 0; i < collection.Settings.Count; ++i) { - if (SettingIsDefaultV0(collection.GetOwnSettings(i))) - collection.Settings.SetAll(i, FullModSettings.Empty); + if (SettingIsDefaultV0(collection.Settings[i])) + ((List)collection.Settings)[i] = null; } - foreach (var (key, _) in collection.Settings.Unused.Where(kvp => SettingIsDefaultV0(kvp.Value)).ToList()) - collection.Settings.RemoveUnused(key); + foreach (var (key, _) in collection.UnusedSettings.Where(kvp => SettingIsDefaultV0(kvp.Value)).ToList()) + ((Dictionary)collection.UnusedSettings).Remove(key); return true; } diff --git a/Penumbra/Collections/Manager/TempCollectionManager.cs b/Penumbra/Collections/Manager/TempCollectionManager.cs index 9476e38c..de08c6a2 100644 --- a/Penumbra/Collections/Manager/TempCollectionManager.cs +++ b/Penumbra/Collections/Manager/TempCollectionManager.cs @@ -1,5 +1,4 @@ -using OtterGui.Extensions; -using OtterGui.Services; +using OtterGui; using Penumbra.Api; using Penumbra.Communication; using Penumbra.GameData.Actors; @@ -9,7 +8,7 @@ using Penumbra.String; namespace Penumbra.Collections.Manager; -public class TempCollectionManager : IDisposable, IService +public class TempCollectionManager : IDisposable { public int GlobalChangeCounter { get; private set; } public readonly IndividualCollections Collections; @@ -44,7 +43,7 @@ public class TempCollectionManager : IDisposable, IService => _customCollections.Values; public bool CollectionByName(string name, [NotNullWhen(true)] out ModCollection? collection) - => _customCollections.Values.FindFirst(c => string.Equals(name, c.Identity.Name, StringComparison.OrdinalIgnoreCase), out collection); + => _customCollections.Values.FindFirst(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase), out collection); public bool CollectionById(Guid id, [NotNullWhen(true)] out ModCollection? collection) => _customCollections.TryGetValue(id, out collection); @@ -53,13 +52,13 @@ public class TempCollectionManager : IDisposable, IService { if (GlobalChangeCounter == int.MaxValue) GlobalChangeCounter = 0; - var collection = _storage.CreateTemporary(name, ~Count, GlobalChangeCounter++); - Penumbra.Log.Debug($"Creating temporary collection {collection.Identity.Name} with {collection.Identity.Id}."); - if (_customCollections.TryAdd(collection.Identity.Id, collection)) + var collection = ModCollection.CreateTemporary(name, ~Count, GlobalChangeCounter++); + Penumbra.Log.Debug($"Creating temporary collection {collection.Name} with {collection.Id}."); + if (_customCollections.TryAdd(collection.Id, collection)) { // Temporary collection created. _communicator.CollectionChange.Invoke(CollectionType.Temporary, null, collection, string.Empty); - return collection.Identity.Id; + return collection.Id; } return Guid.Empty; @@ -73,9 +72,8 @@ public class TempCollectionManager : IDisposable, IService return false; } - _storage.Delete(collection); - Penumbra.Log.Debug($"Deleted temporary collection {collection.Identity.Id}."); - GlobalChangeCounter += Math.Max(collection.Counters.Change + 1 - GlobalChangeCounter, 0); + Penumbra.Log.Debug($"Deleted temporary collection {collection.Id}."); + GlobalChangeCounter += Math.Max(collection.ChangeCounter + 1 - GlobalChangeCounter, 0); for (var i = 0; i < Collections.Count; ++i) { if (Collections[i].Collection != collection) @@ -83,7 +81,7 @@ public class TempCollectionManager : IDisposable, IService // Temporary collection assignment removed. _communicator.CollectionChange.Invoke(CollectionType.Temporary, collection, null, Collections[i].DisplayName); - Penumbra.Log.Verbose($"Unassigned temporary collection {collection.Identity.Id} from {Collections[i].DisplayName}."); + Penumbra.Log.Verbose($"Unassigned temporary collection {collection.Id} from {Collections[i].DisplayName}."); Collections.Delete(i--); } @@ -96,7 +94,7 @@ public class TempCollectionManager : IDisposable, IService return false; // Temporary collection assignment added. - Penumbra.Log.Verbose($"Assigned temporary collection {collection.Identity.AnonymizedName} to {Collections.Last().DisplayName}."); + Penumbra.Log.Verbose($"Assigned temporary collection {collection.AnonymizedName} to {Collections.Last().DisplayName}."); _communicator.CollectionChange.Invoke(CollectionType.Temporary, null, collection, Collections.Last().DisplayName); return true; } @@ -127,6 +125,6 @@ public class TempCollectionManager : IDisposable, IService return false; var identifier = _actors.CreatePlayer(byteString, worldId); - return Collections.TryGetValue(identifier, out var collection) && RemoveTemporaryCollection(collection.Identity.Id); + return Collections.TryGetValue(identifier, out var collection) && RemoveTemporaryCollection(collection.Id); } } diff --git a/Penumbra/Collections/ModCollection.Cache.Access.cs b/Penumbra/Collections/ModCollection.Cache.Access.cs index 716b153e..3f3733e0 100644 --- a/Penumbra/Collections/ModCollection.Cache.Access.cs +++ b/Penumbra/Collections/ModCollection.Cache.Access.cs @@ -1,9 +1,14 @@ using OtterGui.Classes; +using Penumbra.GameData.Enums; using Penumbra.Mods; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; +using Penumbra.Meta.Manipulations; using Penumbra.String.Classes; using Penumbra.Collections.Cache; -using Penumbra.GameData.Data; +using Penumbra.Interop.Services; using Penumbra.Mods.Editor; +using Penumbra.GameData.Structs; namespace Penumbra.Collections; @@ -43,15 +48,74 @@ public partial class ModCollection internal MetaCache? MetaCache => _cache?.Meta; + public bool GetImcFile(Utf8GamePath path, [NotNullWhen(true)] out ImcFile? file) + { + if (_cache != null) + return _cache.Meta.GetImcFile(path, out file); + + file = null; + return false; + } + internal IReadOnlyDictionary ResolvedFiles => _cache?.ResolvedFiles ?? new ConcurrentDictionary(); - internal IReadOnlyDictionary, IIdentifiedObjectData)> ChangedItems - => _cache?.ChangedItems ?? new Dictionary, IIdentifiedObjectData)>(); + internal IReadOnlyDictionary, object?)> ChangedItems + => _cache?.ChangedItems ?? new Dictionary, object?)>(); internal IEnumerable> AllConflicts => _cache?.AllConflicts ?? Array.Empty>(); internal SingleArray Conflicts(Mod mod) => _cache?.Conflicts(mod) ?? new SingleArray(); + + public void SetFiles(CharacterUtility utility) + { + if (_cache == null) + { + utility.ResetAll(); + } + else + { + _cache.Meta.SetFiles(); + Penumbra.Log.Debug($"Set CharacterUtility resources for collection {Identifier}."); + } + } + + public void SetMetaFile(CharacterUtility utility, MetaIndex idx) + { + if (_cache == null) + utility.ResetResource(idx); + else + _cache.Meta.SetFile(idx); + } + + // Used for short periods of changed files. + public MetaList.MetaReverter? TemporarilySetEqdpFile(CharacterUtility utility, GenderRace genderRace, bool accessory) + { + if (_cache != null) + return _cache?.Meta.TemporarilySetEqdpFile(genderRace, accessory); + + var idx = CharacterUtilityData.EqdpIdx(genderRace, accessory); + return idx >= 0 ? utility.TemporarilyResetResource(idx) : null; + } + + public MetaList.MetaReverter TemporarilySetEqpFile(CharacterUtility utility) + => _cache?.Meta.TemporarilySetEqpFile() + ?? utility.TemporarilyResetResource(MetaIndex.Eqp); + + public MetaList.MetaReverter TemporarilySetGmpFile(CharacterUtility utility) + => _cache?.Meta.TemporarilySetGmpFile() + ?? utility.TemporarilyResetResource(MetaIndex.Gmp); + + public MetaList.MetaReverter TemporarilySetCmpFile(CharacterUtility utility) + => _cache?.Meta.TemporarilySetCmpFile() + ?? utility.TemporarilyResetResource(MetaIndex.HumanCmp); + + public MetaList.MetaReverter TemporarilySetEstFile(CharacterUtility utility, EstManipulation.EstType type) + => _cache?.Meta.TemporarilySetEstFile(type) + ?? utility.TemporarilyResetResource((MetaIndex)type); + + public unsafe EqpEntry ApplyGlobalEqp(EqpEntry baseEntry, CharacterArmor* armor) + => _cache?.Meta.ApplyGlobalEqp(baseEntry, armor) ?? baseEntry; } diff --git a/Penumbra/Collections/ModCollection.cs b/Penumbra/Collections/ModCollection.cs index 69f82458..4580e37a 100644 --- a/Penumbra/Collections/ModCollection.cs +++ b/Penumbra/Collections/ModCollection.cs @@ -1,3 +1,4 @@ +using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Collections.Manager; using Penumbra.Mods.Settings; @@ -12,129 +13,203 @@ namespace Penumbra.Collections; /// - Index is the collections index in the ModCollection.Manager /// - Settings has the same size as ModManager.Mods. /// - any change in settings or inheritance of the collection causes a Save. +/// - the name can not contain invalid path characters and has to be unique when lower-cased. /// public partial class ModCollection { - public const int CurrentVersion = 2; + public const int CurrentVersion = 2; + public const string DefaultCollectionName = "Default"; + public const string EmptyCollectionName = "None"; /// /// Create the always available Empty Collection that will always sit at index 0, /// can not be deleted and does never create a cache. /// - public static readonly ModCollection Empty = new(ModCollectionIdentity.Empty, 0, CurrentVersion, new ModSettingProvider(), - new ModCollectionInheritance()); + public static readonly ModCollection Empty = new(Guid.Empty, EmptyCollectionName, 0, 0, CurrentVersion, [], [], []); - public ModCollectionIdentity Identity; + /// The name of a collection. + public string Name { get; set; } + + public Guid Id { get; } + + public string Identifier + => Id.ToString(); + + public string ShortIdentifier + => Identifier[..8]; public override string ToString() - => Identity.ToString(); + => Name.Length > 0 ? Name : ShortIdentifier; - public readonly ModSettingProvider Settings; - public ModCollectionInheritance Inheritance; - public CollectionCounters Counters; + /// Get the first two letters of a collection name and its Index (or None if it is the empty collection). + public string AnonymizedName + => this == Empty ? Empty.Name : Name == DefaultCollectionName ? Name : ShortIdentifier; + /// The index of the collection is set and kept up-to-date by the CollectionManager. + public int Index { get; internal set; } - public ModSettings? GetOwnSettings(Index idx) + /// + /// Count the number of changes of the effective file list. + /// This is used for material and imc changes. + /// + public int ChangeCounter { get; private set; } + + /// Increment the number of changes in the effective file list. + public int IncrementCounter() + => ++ChangeCounter; + + /// + /// If a ModSetting is null, it can be inherited from other collections. + /// If no collection provides a setting for the mod, it is just disabled. + /// + public readonly IReadOnlyList Settings; + + /// Settings for deleted mods will be kept via the mods identifier (directory name). + public readonly IReadOnlyDictionary UnusedSettings; + + /// Inheritances stored before they can be applied. + public IReadOnlyList? InheritanceByName; + + /// Contains all direct parent collections this collection inherits settings from. + public readonly IReadOnlyList DirectlyInheritsFrom; + + /// Contains all direct child collections that inherit from this collection. + public readonly IReadOnlyList DirectParentOf = new List(); + + /// All inherited collections in application order without filtering for duplicates. + public static IEnumerable InheritedCollections(ModCollection collection) + => collection.DirectlyInheritsFrom.SelectMany(InheritedCollections).Prepend(collection); + + /// + /// Iterate over all collections inherited from in depth-first order. + /// Skip already visited collections to avoid circular dependencies. + /// + public IEnumerable GetFlattenedInheritance() + => InheritedCollections(this).Distinct(); + + /// + /// Obtain the actual settings for a given mod via index. + /// Also returns the collection the settings are taken from. + /// If no collection provides settings for this mod, this collection is returned together with null. + /// + public (ModSettings? Settings, ModCollection Collection) this[Index idx] { - if (Identity.Index <= 0) - return ModSettings.Empty; - - return Settings.Settings[idx].Settings; - } - - public TemporaryModSettings? GetTempSettings(Index idx) - { - if (Identity.Index <= 0) - return null; - - return Settings.Settings[idx].TempSettings; - } - - public (ModSettings? Settings, ModCollection Collection) GetInheritedSettings(Index idx) - { - if (Identity.Index <= 0) - return (ModSettings.Empty, this); - - foreach (var collection in Inheritance.FlatHierarchy) + get { - var settings = collection.Settings.Settings[idx].Settings; - if (settings != null) - return (settings, collection); + if (Index <= 0) + return (ModSettings.Empty, this); + + foreach (var collection in GetFlattenedInheritance()) + { + var settings = collection.Settings[idx]; + if (settings != null) + return (settings, collection); + } + + return (null, this); } - - return (null, this); - } - - public (ModSettings? Settings, ModCollection Collection) GetActualSettings(Index idx) - { - if (Identity.Index <= 0) - return (ModSettings.Empty, this); - - // Check temp settings. - var ownTempSettings = Settings.Settings[idx].Resolve(); - if (ownTempSettings != null) - return (ownTempSettings, this); - - // Ignore temp settings for inherited collections. - foreach (var collection in Inheritance.FlatHierarchy.Skip(1)) - { - var settings = collection.Settings.Settings[idx].Settings; - if (settings != null) - return (settings, collection); - } - - return (null, this); } /// Evaluates all settings along the whole inheritance tree. public IEnumerable ActualSettings - => Enumerable.Range(0, Settings.Count).Select(i => GetActualSettings(i).Settings); + => Enumerable.Range(0, Settings.Count).Select(i => this[i].Settings); /// /// Constructor for duplication. Deep copies all settings and parent collections and adds the new collection to their children lists. /// - public ModCollection Duplicate(string name, LocalCollectionId localId, int index) + public ModCollection Duplicate(string name, int index) { Debug.Assert(index > 0, "Collection duplicated with non-positive index."); - return new ModCollection(ModCollectionIdentity.New(name, localId, index), 0, CurrentVersion, Settings.Clone(), Inheritance.Clone()); + return new ModCollection(Guid.NewGuid(), name, index, 0, CurrentVersion, Settings.Select(s => s?.DeepCopy()).ToList(), + [.. DirectlyInheritsFrom], UnusedSettings.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.DeepCopy())); } /// Constructor for reading from files. - public static ModCollection CreateFromData(SaveService saver, ModStorage mods, ModCollectionIdentity identity, int version, + public static ModCollection CreateFromData(SaveService saver, ModStorage mods, Guid id, string name, int version, int index, Dictionary allSettings, IReadOnlyList inheritances) { - Debug.Assert(identity.Index > 0, "Collection read with non-positive index."); - var ret = new ModCollection(identity, 0, version, new ModSettingProvider(allSettings), new ModCollectionInheritance(inheritances)); - ret.Settings.ApplyModSettings(ret, saver, mods); + Debug.Assert(index > 0, "Collection read with non-positive index."); + var ret = new ModCollection(id, name, index, 0, version, [], [], allSettings) + { + InheritanceByName = inheritances, + }; + ret.ApplyModSettings(saver, mods); ModCollectionMigration.Migrate(saver, mods, version, ret); return ret; } /// Constructor for temporary collections. - public static ModCollection CreateTemporary(string name, LocalCollectionId localId, int index, int changeCounter) + public static ModCollection CreateTemporary(string name, int index, int changeCounter) { Debug.Assert(index < 0, "Temporary collection created with non-negative index."); - var ret = new ModCollection(ModCollectionIdentity.New(name, localId, index), changeCounter, CurrentVersion, new ModSettingProvider(), - new ModCollectionInheritance()); + var ret = new ModCollection(Guid.NewGuid(), name, index, changeCounter, CurrentVersion, [], [], []); return ret; } /// Constructor for empty collections. - public static ModCollection CreateEmpty(string name, LocalCollectionId localId, int index, int modCount) + public static ModCollection CreateEmpty(string name, int index, int modCount) { Debug.Assert(index >= 0, "Empty collection created with negative index."); - return new ModCollection(ModCollectionIdentity.New(name, localId, index), 0, CurrentVersion, ModSettingProvider.Empty(modCount), - new ModCollectionInheritance()); + return new ModCollection(Guid.NewGuid(), name, index, 0, CurrentVersion, Enumerable.Repeat((ModSettings?)null, modCount).ToList(), [], + []); } - private ModCollection(ModCollectionIdentity identity, int changeCounter, int version, ModSettingProvider settings, - ModCollectionInheritance inheritance) + /// Add settings for a new appended mod, by checking if the mod had settings from a previous deletion. + internal bool AddMod(Mod mod) { - Identity = identity; - Counters = new CollectionCounters(changeCounter); - Settings = settings; - Inheritance = inheritance; - ModCollectionInheritance.UpdateChildren(this); - ModCollectionInheritance.UpdateFlattenedInheritance(this); + if (UnusedSettings.TryGetValue(mod.ModPath.Name, out var save)) + { + var ret = save.ToSettings(mod, out var settings); + ((List)Settings).Add(settings); + ((Dictionary)UnusedSettings).Remove(mod.ModPath.Name); + return ret; + } + + ((List)Settings).Add(null); + return false; + } + + /// Move settings from the current mod list to the unused mod settings. + internal void RemoveMod(Mod mod) + { + var settings = Settings[mod.Index]; + if (settings != null) + ((Dictionary)UnusedSettings)[mod.ModPath.Name] = new ModSettings.SavedSettings(settings, mod); + + ((List)Settings).RemoveAt(mod.Index); + } + + /// Move all settings to unused settings for rediscovery. + internal void PrepareModDiscovery(ModStorage mods) + { + foreach (var (mod, setting) in mods.Zip(Settings).Where(s => s.Second != null)) + ((Dictionary)UnusedSettings)[mod.ModPath.Name] = new ModSettings.SavedSettings(setting!, mod); + + ((List)Settings).Clear(); + } + + /// + /// Apply all mod settings from unused settings to the current set of mods. + /// Also fixes invalid settings. + /// + internal void ApplyModSettings(SaveService saver, ModStorage mods) + { + ((List)Settings).Capacity = Math.Max(((List)Settings).Capacity, mods.Count); + if (mods.Aggregate(false, (current, mod) => current | AddMod(mod))) + saver.ImmediateSave(new ModCollectionSave(mods, this)); + } + + private ModCollection(Guid id, string name, int index, int changeCounter, int version, List appliedSettings, + List inheritsFrom, Dictionary settings) + { + Name = name; + Id = id; + Index = index; + ChangeCounter = changeCounter; + Settings = appliedSettings; + UnusedSettings = settings; + DirectlyInheritsFrom = inheritsFrom; + foreach (var c in DirectlyInheritsFrom) + ((List)c.DirectParentOf).Add(this); } } diff --git a/Penumbra/Collections/ModCollectionIdentity.cs b/Penumbra/Collections/ModCollectionIdentity.cs deleted file mode 100644 index 7050450c..00000000 --- a/Penumbra/Collections/ModCollectionIdentity.cs +++ /dev/null @@ -1,43 +0,0 @@ -using OtterGui; -using OtterGui.Extensions; -using Penumbra.Collections.Manager; - -namespace Penumbra.Collections; - -public struct ModCollectionIdentity(Guid id, LocalCollectionId localId) -{ - public const string DefaultCollectionName = "Default"; - public const string EmptyCollectionName = "None"; - - public static readonly ModCollectionIdentity Empty = new(Guid.Empty, LocalCollectionId.Zero, EmptyCollectionName, 0); - - public string Name { get; set; } = string.Empty; - public Guid Id { get; } = id; - public LocalCollectionId LocalId { get; } = localId; - - /// The index of the collection is set and kept up-to-date by the CollectionManager. - public int Index { get; internal set; } - - public string Identifier - => Id.ToString(); - - public string ShortIdentifier - => Id.ShortGuid(); - - /// Get the short identifier of a collection unless it is a well-known collection name. - public string AnonymizedName - => Id == Guid.Empty ? EmptyCollectionName : Name == DefaultCollectionName ? Name : ShortIdentifier; - - public override string ToString() - => Name.Length > 0 ? Name : ShortIdentifier; - - public ModCollectionIdentity(Guid id, LocalCollectionId localId, string name, int index) - : this(id, localId) - { - Name = name; - Index = index; - } - - public static ModCollectionIdentity New(string name, LocalCollectionId id, int index) - => new(Guid.NewGuid(), id, name, index); -} diff --git a/Penumbra/Collections/ModCollectionInheritance.cs b/Penumbra/Collections/ModCollectionInheritance.cs deleted file mode 100644 index 151ed7db..00000000 --- a/Penumbra/Collections/ModCollectionInheritance.cs +++ /dev/null @@ -1,92 +0,0 @@ -using OtterGui.Filesystem; - -namespace Penumbra.Collections; - -public struct ModCollectionInheritance -{ - public IReadOnlyList? InheritanceByName { get; private set; } - private readonly List _directlyInheritsFrom = []; - private readonly List _directlyInheritedBy = []; - private readonly List _flatHierarchy = []; - - public ModCollectionInheritance() - { } - - private ModCollectionInheritance(List inheritsFrom) - => _directlyInheritsFrom = [.. inheritsFrom]; - - public ModCollectionInheritance(IReadOnlyList byName) - => InheritanceByName = byName; - - public ModCollectionInheritance Clone() - => new(_directlyInheritsFrom); - - public IEnumerable Identifiers - => InheritanceByName ?? _directlyInheritsFrom.Select(c => c.Identity.Identifier); - - public IReadOnlyList? ConsumeNames() - { - var ret = InheritanceByName; - InheritanceByName = null; - return ret; - } - - public static void UpdateChildren(ModCollection parent) - { - foreach (var inheritance in parent.Inheritance.DirectlyInheritsFrom) - inheritance.Inheritance._directlyInheritedBy.Add(parent); - } - - public void AddInheritance(ModCollection inheritor, ModCollection newParent) - { - _directlyInheritsFrom.Add(newParent); - newParent.Inheritance._directlyInheritedBy.Add(inheritor); - UpdateFlattenedInheritance(inheritor); - } - - public ModCollection RemoveInheritanceAt(ModCollection inheritor, int idx) - { - var parent = DirectlyInheritsFrom[idx]; - _directlyInheritsFrom.RemoveAt(idx); - parent.Inheritance._directlyInheritedBy.Remove(parent); - UpdateFlattenedInheritance(inheritor); - return parent; - } - - public bool MoveInheritance(ModCollection inheritor, int from, int to) - { - if (!_directlyInheritsFrom.Move(from, to)) - return false; - - UpdateFlattenedInheritance(inheritor); - return true; - } - - public void RemoveChild(ModCollection child) - => _directlyInheritedBy.Remove(child); - - /// Contains all direct parent collections this collection inherits settings from. - public readonly IReadOnlyList DirectlyInheritsFrom - => _directlyInheritsFrom; - - /// Contains all direct child collections that inherit from this collection. - public readonly IReadOnlyList DirectlyInheritedBy - => _directlyInheritedBy; - - /// - /// Iterate over all collections inherited from in depth-first order. - /// Skip already visited collections to avoid circular dependencies. - /// - public readonly IReadOnlyList FlatHierarchy - => _flatHierarchy; - - public static void UpdateFlattenedInheritance(ModCollection parent) - { - parent.Inheritance._flatHierarchy.Clear(); - parent.Inheritance._flatHierarchy.AddRange(InheritedCollections(parent).Distinct()); - } - - /// All inherited collections in application order without filtering for duplicates. - private static IEnumerable InheritedCollections(ModCollection parent) - => parent.Inheritance.DirectlyInheritsFrom.SelectMany(InheritedCollections).Prepend(parent); -} diff --git a/Penumbra/Collections/ModCollectionSave.cs b/Penumbra/Collections/ModCollectionSave.cs index 4c41a28c..e6bb069b 100644 --- a/Penumbra/Collections/ModCollectionSave.cs +++ b/Penumbra/Collections/ModCollectionSave.cs @@ -15,7 +15,7 @@ internal readonly struct ModCollectionSave(ModStorage modStorage, ModCollection => fileNames.CollectionFile(modCollection); public string LogName(string _) - => modCollection.Identity.AnonymizedName; + => modCollection.AnonymizedName; public string TypeName => "Collection"; @@ -28,23 +28,23 @@ internal readonly struct ModCollectionSave(ModStorage modStorage, ModCollection j.WriteStartObject(); j.WritePropertyName("Version"); j.WriteValue(ModCollection.CurrentVersion); - j.WritePropertyName(nameof(ModCollectionIdentity.Id)); - j.WriteValue(modCollection.Identity.Identifier); - j.WritePropertyName(nameof(ModCollectionIdentity.Name)); - j.WriteValue(modCollection.Identity.Name); - j.WritePropertyName("Settings"); + j.WritePropertyName(nameof(ModCollection.Id)); + j.WriteValue(modCollection.Identifier); + j.WritePropertyName(nameof(ModCollection.Name)); + j.WriteValue(modCollection.Name); + j.WritePropertyName(nameof(ModCollection.Settings)); // Write all used and unused settings by mod directory name. j.WriteStartObject(); - var list = new List<(string, ModSettings.SavedSettings)>(modCollection.Settings.Count + modCollection.Settings.Unused.Count); + var list = new List<(string, ModSettings.SavedSettings)>(modCollection.Settings.Count + modCollection.UnusedSettings.Count); for (var i = 0; i < modCollection.Settings.Count; ++i) { - var settings = modCollection.GetOwnSettings(i); + var settings = modCollection.Settings[i]; if (settings != null) list.Add((modStorage[i].ModPath.Name, new ModSettings.SavedSettings(settings, modStorage[i]))); } - list.AddRange(modCollection.Settings.Unused.Select(kvp => (kvp.Key, kvp.Value))); + list.AddRange(modCollection.UnusedSettings.Select(kvp => (kvp.Key, kvp.Value))); list.Sort((a, b) => string.Compare(a.Item1, b.Item1, StringComparison.OrdinalIgnoreCase)); foreach (var (modDir, settings) in list) @@ -57,7 +57,7 @@ internal readonly struct ModCollectionSave(ModStorage modStorage, ModCollection // Inherit by collection name. j.WritePropertyName("Inheritance"); - x.Serialize(j, modCollection.Inheritance.Identifiers); + x.Serialize(j, modCollection.InheritanceByName ?? modCollection.DirectlyInheritsFrom.Select(c => c.Identifier)); j.WriteEndObject(); } @@ -79,10 +79,10 @@ internal readonly struct ModCollectionSave(ModStorage modStorage, ModCollection { var obj = JObject.Parse(File.ReadAllText(file.FullName)); version = obj["Version"]?.ToObject() ?? 0; - name = obj[nameof(ModCollectionIdentity.Name)]?.ToObject() ?? string.Empty; - id = obj[nameof(ModCollectionIdentity.Id)]?.ToObject() ?? (version == 1 ? Guid.NewGuid() : Guid.Empty); + name = obj[nameof(ModCollection.Name)]?.ToObject() ?? string.Empty; + id = obj[nameof(ModCollection.Id)]?.ToObject() ?? (version == 1 ? Guid.NewGuid() : Guid.Empty); // Custom deserialization that is converted with the constructor. - settings = obj["Settings"]?.ToObject>() ?? settings; + settings = obj[nameof(ModCollection.Settings)]?.ToObject>() ?? settings; inheritance = obj["Inheritance"]?.ToObject>() ?? inheritance; return true; } diff --git a/Penumbra/Collections/ModSettingProvider.cs b/Penumbra/Collections/ModSettingProvider.cs deleted file mode 100644 index 3bf2f949..00000000 --- a/Penumbra/Collections/ModSettingProvider.cs +++ /dev/null @@ -1,98 +0,0 @@ -using Penumbra.Mods; -using Penumbra.Mods.Manager; -using Penumbra.Mods.Settings; -using Penumbra.Services; - -namespace Penumbra.Collections; - -public readonly struct ModSettingProvider -{ - private ModSettingProvider(IEnumerable settings, Dictionary unusedSettings) - { - _settings = settings.Select(s => s.DeepCopy()).ToList(); - _unused = unusedSettings.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.DeepCopy()); - } - - public ModSettingProvider() - { } - - public static ModSettingProvider Empty(int count) - => new(Enumerable.Repeat(FullModSettings.Empty, count), []); - - public ModSettingProvider(Dictionary allSettings) - => _unused = allSettings; - - private readonly List _settings = []; - - /// Settings for deleted mods will be kept via the mods identifier (directory name). - private readonly Dictionary _unused = []; - - public int Count - => _settings.Count; - - public bool RemoveUnused(string key) - => _unused.Remove(key); - - internal void Set(Index index, ModSettings? settings) - => _settings[index] = _settings[index] with { Settings = settings }; - - internal void SetTemporary(Index index, TemporaryModSettings? settings) - => _settings[index] = _settings[index] with { TempSettings = settings }; - - internal void SetAll(Index index, FullModSettings settings) - => _settings[index] = settings; - - public IReadOnlyList Settings - => _settings; - - public IReadOnlyDictionary Unused - => _unused; - - public ModSettingProvider Clone() - => new(_settings, _unused); - - /// Add settings for a new appended mod, by checking if the mod had settings from a previous deletion. - internal bool AddMod(Mod mod) - { - if (_unused.Remove(mod.ModPath.Name, out var save)) - { - var ret = save.ToSettings(mod, out var settings); - _settings.Add(new FullModSettings(settings)); - return ret; - } - - _settings.Add(FullModSettings.Empty); - return false; - } - - /// Move settings from the current mod list to the unused mod settings. - internal void RemoveMod(Mod mod) - { - var settings = _settings[mod.Index]; - if (settings.Settings != null) - _unused[mod.ModPath.Name] = new ModSettings.SavedSettings(settings.Settings, mod); - - _settings.RemoveAt(mod.Index); - } - - /// Move all settings to unused settings for rediscovery. - internal void PrepareModDiscovery(ModStorage mods) - { - foreach (var (mod, setting) in mods.Zip(_settings).Where(s => s.Second.Settings != null)) - _unused[mod.ModPath.Name] = new ModSettings.SavedSettings(setting.Settings!, mod); - - _settings.Clear(); - } - - /// - /// Apply all mod settings from unused settings to the current set of mods. - /// Also fixes invalid settings. - /// - internal void ApplyModSettings(ModCollection parent, SaveService saver, ModStorage mods) - { - _settings.Capacity = Math.Max(_settings.Capacity, mods.Count); - var settings = this; - if (mods.Aggregate(false, (current, mod) => current | settings.AddMod(mod))) - saver.ImmediateSave(new ModCollectionSave(mods, parent)); - } -} diff --git a/Penumbra/Collections/ResolveData.cs b/Penumbra/Collections/ResolveData.cs index bda877ff..8fe160b3 100644 --- a/Penumbra/Collections/ResolveData.cs +++ b/Penumbra/Collections/ResolveData.cs @@ -23,7 +23,7 @@ public readonly struct ResolveData(ModCollection collection, nint gameObject) { } public override string ToString() - => ModCollection.Identity.Name; + => ModCollection.Name; } public static class ResolveDataExtensions diff --git a/Penumbra/CommandHandler.cs b/Penumbra/CommandHandler.cs index b5d307ef..4e1d6453 100644 --- a/Penumbra/CommandHandler.cs +++ b/Penumbra/CommandHandler.cs @@ -1,10 +1,8 @@ using Dalamud.Game.Command; using Dalamud.Game.Text.SeStringHandling; using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Api.Api; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -12,12 +10,12 @@ using Penumbra.GameData.Actors; using Penumbra.Interop.Services; using Penumbra.Mods; using Penumbra.Mods.Manager; +using Penumbra.Services; using Penumbra.UI; -using Penumbra.UI.Knowledge; namespace Penumbra; -public class CommandHandler : IDisposable, IApiService +public class CommandHandler : IDisposable { private const string CommandName = "/penumbra"; @@ -31,12 +29,11 @@ public class CommandHandler : IDisposable, IApiService private readonly CollectionManager _collectionManager; private readonly Penumbra _penumbra; private readonly CollectionEditor _collectionEditor; - private readonly KnowledgeWindow _knowledgeWindow; public CommandHandler(IFramework framework, ICommandManager commandManager, IChatGui chat, RedrawService redrawService, - Configuration config, ConfigWindow configWindow, ModManager modManager, CollectionManager collectionManager, ActorManager actors, - Penumbra penumbra, - CollectionEditor collectionEditor, KnowledgeWindow knowledgeWindow) + Configuration config, + ConfigWindow configWindow, ModManager modManager, CollectionManager collectionManager, ActorManager actors, Penumbra penumbra, + CollectionEditor collectionEditor) { _commandManager = commandManager; _redrawService = redrawService; @@ -48,7 +45,6 @@ public class CommandHandler : IDisposable, IApiService _chat = chat; _penumbra = penumbra; _collectionEditor = collectionEditor; - _knowledgeWindow = knowledgeWindow; framework.RunOnFrameworkThread(() => { if (_commandManager.Commands.ContainsKey(CommandName)) @@ -73,23 +69,21 @@ public class CommandHandler : IDisposable, IApiService var argumentList = arguments.Split(' ', 2); arguments = argumentList.Length == 2 ? argumentList[1] : string.Empty; - _ = argumentList[0].ToLowerInvariant() switch + var _ = argumentList[0].ToLowerInvariant() switch { - "window" => ToggleWindow(arguments), - "enable" => SetPenumbraState(arguments, true), - "disable" => SetPenumbraState(arguments, false), - "toggle" => SetPenumbraState(arguments, null), - "reload" => Reload(arguments), - "redraw" => Redraw(arguments), - "lockui" => SetUiLockState(arguments), - "size" => SetUiMinimumSize(arguments), - "debug" => SetDebug(arguments), - "collection" => SetCollection(arguments), - "mod" => SetMod(arguments), - "bulktag" => SetTag(arguments), - "clearsettings" => ClearSettings(arguments), - "knowledge" => HandleKnowledge(arguments), - _ => PrintHelp(argumentList[0]), + "window" => ToggleWindow(arguments), + "enable" => SetPenumbraState(arguments, true), + "disable" => SetPenumbraState(arguments, false), + "toggle" => SetPenumbraState(arguments, null), + "reload" => Reload(arguments), + "redraw" => Redraw(arguments), + "lockui" => SetUiLockState(arguments), + "size" => SetUiMinimumSize(arguments), + "debug" => SetDebug(arguments), + "collection" => SetCollection(arguments), + "mod" => SetMod(arguments), + "bulktag" => SetTag(arguments), + _ => PrintHelp(argumentList[0]), }; } @@ -127,21 +121,6 @@ public class CommandHandler : IDisposable, IApiService _chat.Print(new SeStringBuilder() .AddCommand("bulktag", "Change multiple mods settings based on their tags. Use without further parameters for more detailed help.") .BuiltString); - _chat.Print(new SeStringBuilder() - .AddCommand("clearsettings", - "Clear all temporary settings applied manually through Penumbra in the current or all collections. Use with 'all' parameter for all.") - .BuiltString); - return true; - } - - private bool ClearSettings(string arguments) - { - if (arguments.Trim().ToLowerInvariant() is "all") - foreach (var collection in _collectionManager.Storage) - _collectionEditor.ClearTemporarySettings(collection); - else - _collectionEditor.ClearTemporarySettings(_collectionManager.Active.Current); - return true; } @@ -325,7 +304,7 @@ public class CommandHandler : IDisposable, IApiService identifiers = _actors.FromUserString(split[2], false); } } - catch (ActorIdentifierFactory.IdentifierParseError e) + catch (ActorManager.IdentifierParseError e) { _chat.Print(new SeStringBuilder().AddText("The argument ").AddRed(split[2], true) .AddText($" could not be converted to an identifier. {e.Message}") @@ -342,7 +321,7 @@ public class CommandHandler : IDisposable, IApiService { _chat.Print(collection == null ? $"The {type.ToName()} Collection{(identifier.IsValid ? $" for {identifier}" : string.Empty)} is already unassigned" - : $"{collection.Identity.Name} already is the {type.ToName()} Collection{(identifier.IsValid ? $" for {identifier}." : ".")}"); + : $"{collection.Name} already is the {type.ToName()} Collection{(identifier.IsValid ? $" for {identifier}." : ".")}"); continue; } @@ -379,13 +358,13 @@ public class CommandHandler : IDisposable, IApiService } Print( - $"Removed {oldCollection.Identity.Name} as {type.ToName()} Collection assignment {(identifier.IsValid ? $" for {identifier}." : ".")}"); + $"Removed {oldCollection.Name} as {type.ToName()} Collection assignment {(identifier.IsValid ? $" for {identifier}." : ".")}"); anySuccess = true; continue; } _collectionManager.Active.SetCollection(collection!, type, individualIndex); - Print($"Assigned {collection!.Identity.Name} as {type.ToName()} Collection{(identifier.IsValid ? $" for {identifier}." : ".")}"); + Print($"Assigned {collection!.Name} as {type.ToName()} Collection{(identifier.IsValid ? $" for {identifier}." : ".")}"); } return anySuccess; @@ -396,18 +375,16 @@ public class CommandHandler : IDisposable, IApiService if (arguments.Length == 0) { var seString = new SeStringBuilder() - .AddText("Use with /penumbra mod ").AddBlue("[enable|disable|inherit|toggle|").AddGreen("setting").AddBlue("]").AddText(" ") - .AddYellow("[Collection Name]") + .AddText("Use with /penumbra mod ").AddBlue("[enable|disable|inherit|toggle]").AddText(" ").AddYellow("[Collection Name]") .AddText(" | ") - .AddPurple("[Mod Name or Mod Directory Name]") - .AddGreen(" <| [Option Group Name] | [Option1;Option2;...]>"); + .AddPurple("[Mod Name or Mod Directory Name]"); _chat.Print(seString.BuiltString); return true; } var split = arguments.Split(' ', 2, StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); var nameSplit = split.Length != 2 - ? [] + ? Array.Empty() : split[1].Split('|', 2, StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); if (nameSplit.Length != 2) { @@ -425,24 +402,6 @@ public class CommandHandler : IDisposable, IApiService if (!GetModCollection(nameSplit[0], out var collection) || collection == ModCollection.Empty) return false; - var groupName = string.Empty; - var optionNames = Array.Empty(); - if (state is 4) - { - var split2 = nameSplit[1].Split('|', 3, StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); - if (split2.Length < 2) - { - _chat.Print( - "Not enough arguments for changing settings provided. Please add a group name and a list of setting names - which can be empty for multi options."); - return false; - } - - nameSplit[1] = split2[0]; - groupName = split2[1]; - if (split2.Length == 3) - optionNames = split2[2].Split(';', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries); - } - if (!_modManager.TryGetMod(nameSplit[1], nameSplit[1], out var mod)) { _chat.Print(new SeStringBuilder().AddText("The mod ").AddRed(nameSplit[1], true).AddText(" does not exist.") @@ -450,35 +409,12 @@ public class CommandHandler : IDisposable, IApiService return false; } - if (state < 4) - { - if (HandleModState(state, collection!, mod)) - return true; - - _chat.Print(new SeStringBuilder().AddText("Mod ").AddPurple(mod.Name, true) - .AddText("already had the desired state in collection ") - .AddYellow(collection!.Identity.Name, true).AddText(".").BuiltString); - return false; - } - - switch (ModSettingsApi.ConvertModSetting(mod, groupName, optionNames, out var groupIndex, out var setting)) - { - case PenumbraApiEc.OptionGroupMissing: - _chat.Print(new SeStringBuilder().AddText("The mod ").AddRed(nameSplit[1], true).AddText(" has no group ") - .AddGreen(groupName, true).AddText(".").BuiltString); - return false; - case PenumbraApiEc.OptionMissing: - _chat.Print(new SeStringBuilder().AddText("Not all set options in the mod ").AddRed(nameSplit[1], true) - .AddText(" could be found in group ").AddGreen(groupName, true).AddText(".").BuiltString); - return false; - case PenumbraApiEc.Success: - _collectionEditor.SetModSetting(collection!, mod, groupIndex, setting); - Print(() => new SeStringBuilder().AddText("Changed settings of group ").AddGreen(groupName, true).AddText(" in mod ") - .AddPurple(mod.Name, true).AddText(" in collection ") - .AddYellow(collection!.Identity.Name, true).AddText(".").BuiltString); - return true; - } + if (HandleModState(state, collection!, mod)) + return true; + _chat.Print(new SeStringBuilder().AddText("Mod ").AddPurple(mod.Name, true) + .AddText("already had the desired state in collection ") + .AddYellow(collection!.Name, true).AddText(".").BuiltString); return false; } @@ -560,7 +496,7 @@ public class CommandHandler : IDisposable, IApiService changes |= HandleModState(state, collection!, mod); if (!changes) - Print(() => new SeStringBuilder().AddText("No mod states were changed in collection ").AddYellow(collection!.Identity.Name, true) + Print(() => new SeStringBuilder().AddText("No mod states were changed in collection ").AddYellow(collection!.Name, true) .AddText(".").BuiltString); return true; @@ -575,7 +511,7 @@ public class CommandHandler : IDisposable, IApiService return true; } - collection = string.Equals(lowerName, ModCollection.Empty.Identity.Name, StringComparison.OrdinalIgnoreCase) + collection = string.Equals(lowerName, ModCollection.Empty.Name, StringComparison.OrdinalIgnoreCase) ? ModCollection.Empty : _collectionManager.Storage.ByIdentifier(lowerName, out var c) ? c @@ -616,14 +552,12 @@ public class CommandHandler : IDisposable, IApiService "toggle" => 2, "inherit" => 3, "inherited" => 3, - "setting" => 4, - "settings" => 4, _ => -1, }; private bool HandleModState(int settingState, ModCollection collection, Mod mod) { - var settings = collection.GetOwnSettings(mod.Index); + var settings = collection.Settings[mod.Index]; switch (settingState) { case 0: @@ -631,7 +565,7 @@ public class CommandHandler : IDisposable, IApiService return false; Print(() => new SeStringBuilder().AddText("Enabled mod ").AddPurple(mod.Name, true).AddText(" in collection ") - .AddYellow(collection.Identity.Name, true) + .AddYellow(collection.Name, true) .AddText(".").BuiltString); return true; @@ -640,7 +574,7 @@ public class CommandHandler : IDisposable, IApiService return false; Print(() => new SeStringBuilder().AddText("Disabled mod ").AddPurple(mod.Name, true).AddText(" in collection ") - .AddYellow(collection.Identity.Name, true) + .AddYellow(collection.Name, true) .AddText(".").BuiltString); return true; @@ -651,7 +585,7 @@ public class CommandHandler : IDisposable, IApiService Print(() => new SeStringBuilder().AddText(setting ? "Enabled mod " : "Disabled mod ").AddPurple(mod.Name, true) .AddText(" in collection ") - .AddYellow(collection.Identity.Name, true) + .AddYellow(collection.Name, true) .AddText(".").BuiltString); return true; @@ -660,7 +594,7 @@ public class CommandHandler : IDisposable, IApiService return false; Print(() => new SeStringBuilder().AddText("Set mod ").AddPurple(mod.Name, true).AddText(" in collection ") - .AddYellow(collection.Identity.Name, true) + .AddYellow(collection.Name, true) .AddText(" to inherit.").BuiltString); return true; } @@ -685,10 +619,4 @@ public class CommandHandler : IDisposable, IApiService if (_config.PrintSuccessfulCommandsToChat) _chat.Print(text()); } - - private bool HandleKnowledge(string arguments) - { - _knowledgeWindow.Toggle(); - return true; - } } diff --git a/Penumbra/Communication/ChangedItemClick.cs b/Penumbra/Communication/ChangedItemClick.cs index 2d27f36a..554e2221 100644 --- a/Penumbra/Communication/ChangedItemClick.cs +++ b/Penumbra/Communication/ChangedItemClick.cs @@ -1,7 +1,6 @@ using OtterGui.Classes; using Penumbra.Api.Api; using Penumbra.Api.Enums; -using Penumbra.GameData.Data; namespace Penumbra.Communication; @@ -12,7 +11,7 @@ namespace Penumbra.Communication; /// Parameter is the clicked object data if any. /// /// -public sealed class ChangedItemClick() : EventWrapper(nameof(ChangedItemClick)) +public sealed class ChangedItemClick() : EventWrapper(nameof(ChangedItemClick)) { public enum Priority { diff --git a/Penumbra/Communication/ChangedItemHover.cs b/Penumbra/Communication/ChangedItemHover.cs index 92d770f7..2dcced35 100644 --- a/Penumbra/Communication/ChangedItemHover.cs +++ b/Penumbra/Communication/ChangedItemHover.cs @@ -1,6 +1,5 @@ using OtterGui.Classes; using Penumbra.Api.Api; -using Penumbra.GameData.Data; namespace Penumbra.Communication; @@ -10,7 +9,7 @@ namespace Penumbra.Communication; /// Parameter is the hovered object data if any. /// /// -public sealed class ChangedItemHover() : EventWrapper(nameof(ChangedItemHover)) +public sealed class ChangedItemHover() : EventWrapper(nameof(ChangedItemHover)) { public enum Priority { diff --git a/Penumbra/Communication/CharacterUtilityFinished.cs b/Penumbra/Communication/CharacterUtilityFinished.cs deleted file mode 100644 index fbeeb8a7..00000000 --- a/Penumbra/Communication/CharacterUtilityFinished.cs +++ /dev/null @@ -1,23 +0,0 @@ -using OtterGui.Classes; -using Penumbra.Api; -using Penumbra.Interop.Services; - -namespace Penumbra.Communication; - -/// -/// Triggered when the Character Utility becomes ready. -/// -public sealed class CharacterUtilityFinished() : EventWrapper(nameof(CharacterUtilityFinished)) -{ - public enum Priority - { - /// - OnFinishedLoading = int.MaxValue, - - /// - IpcProvider = int.MinValue, - - /// - CollectionCacheManager = 0, - } -} diff --git a/Penumbra/Communication/CollectionChange.cs b/Penumbra/Communication/CollectionChange.cs index 2788177d..95d4ac4d 100644 --- a/Penumbra/Communication/CollectionChange.cs +++ b/Penumbra/Communication/CollectionChange.cs @@ -46,8 +46,5 @@ public sealed class CollectionChange() /// ModFileSystemSelector = 0, - - /// - ModSelection = 10, } } diff --git a/Penumbra/Communication/CollectionInheritanceChanged.cs b/Penumbra/Communication/CollectionInheritanceChanged.cs index 30af2b20..dbcf9e4a 100644 --- a/Penumbra/Communication/CollectionInheritanceChanged.cs +++ b/Penumbra/Communication/CollectionInheritanceChanged.cs @@ -23,8 +23,5 @@ public sealed class CollectionInheritanceChanged() /// ModFileSystemSelector = 0, - - /// - ModSelection = 10, } } diff --git a/Penumbra/Communication/CreatingCharacterBase.cs b/Penumbra/Communication/CreatingCharacterBase.cs index 51d55868..8a906ca0 100644 --- a/Penumbra/Communication/CreatingCharacterBase.cs +++ b/Penumbra/Communication/CreatingCharacterBase.cs @@ -1,4 +1,5 @@ using OtterGui.Classes; +using Penumbra.Api; using Penumbra.Api.Api; using Penumbra.Services; @@ -18,7 +19,7 @@ public sealed class CreatingCharacterBase() { public enum Priority { - /// + /// Api = 0, /// diff --git a/Penumbra/Communication/ModPathChanged.cs b/Penumbra/Communication/ModPathChanged.cs index efe59482..1e4f8d36 100644 --- a/Penumbra/Communication/ModPathChanged.cs +++ b/Penumbra/Communication/ModPathChanged.cs @@ -3,7 +3,6 @@ using Penumbra.Api; using Penumbra.Api.Api; using Penumbra.Mods; using Penumbra.Mods.Manager; -using Penumbra.Services; namespace Penumbra.Communication; @@ -21,14 +20,11 @@ public sealed class ModPathChanged() { public enum Priority { - /// - PcpService = int.MinValue, - /// - ApiMods = int.MinValue + 1, + ApiMods = int.MinValue, /// - ApiModSettings = int.MinValue + 1, + ApiModSettings = int.MinValue, /// EphemeralConfig = -500, diff --git a/Penumbra/Communication/ModSettingChanged.cs b/Penumbra/Communication/ModSettingChanged.cs index d4bf00be..a7da345b 100644 --- a/Penumbra/Communication/ModSettingChanged.cs +++ b/Penumbra/Communication/ModSettingChanged.cs @@ -1,4 +1,5 @@ using OtterGui.Classes; +using Penumbra.Api; using Penumbra.Api.Api; using Penumbra.Api.Enums; using Penumbra.Collections; @@ -23,7 +24,7 @@ public sealed class ModSettingChanged() { public enum Priority { - /// + /// Api = int.MinValue, /// @@ -34,8 +35,5 @@ public sealed class ModSettingChanged() /// ModFileSystemSelector = 0, - - /// - ModSelection = 10, } } diff --git a/Penumbra/Communication/MtrlLoaded.cs b/Penumbra/Communication/MtrlShpkLoaded.cs similarity index 64% rename from Penumbra/Communication/MtrlLoaded.cs rename to Penumbra/Communication/MtrlShpkLoaded.cs index 224438e5..8aab0e0e 100644 --- a/Penumbra/Communication/MtrlLoaded.cs +++ b/Penumbra/Communication/MtrlShpkLoaded.cs @@ -6,11 +6,11 @@ namespace Penumbra.Communication; /// Parameter is the material resource handle for which the shader package has been loaded. /// Parameter is the associated game object. /// -public sealed class MtrlLoaded() : EventWrapper(nameof(MtrlLoaded)) +public sealed class MtrlShpkLoaded() : EventWrapper(nameof(MtrlShpkLoaded)) { public enum Priority { - /// + /// ShaderReplacementFixer = 0, } } diff --git a/Penumbra/Communication/PcpCreation.cs b/Penumbra/Communication/PcpCreation.cs deleted file mode 100644 index ca0cfcf6..00000000 --- a/Penumbra/Communication/PcpCreation.cs +++ /dev/null @@ -1,21 +0,0 @@ -using Newtonsoft.Json.Linq; -using OtterGui.Classes; - -namespace Penumbra.Communication; - -/// -/// Triggered when the character.json file for a .pcp file is written. -/// -/// Parameter is the JObject that gets written to file. -/// Parameter is the object index of the game object this is written for. -/// Parameter is the full path to the directory being set up for the PCP creation. -/// -/// -public sealed class PcpCreation() : EventWrapper(nameof(PcpCreation)) -{ - public enum Priority - { - /// - ModsApi = int.MinValue, - } -} diff --git a/Penumbra/Communication/PcpParsing.cs b/Penumbra/Communication/PcpParsing.cs deleted file mode 100644 index 95b78951..00000000 --- a/Penumbra/Communication/PcpParsing.cs +++ /dev/null @@ -1,21 +0,0 @@ -using Newtonsoft.Json.Linq; -using OtterGui.Classes; - -namespace Penumbra.Communication; - -/// -/// Triggered when the character.json file for a .pcp file is parsed and applied. -/// -/// Parameter is parsed JObject that contains the data. -/// Parameter is the identifier of the created mod. -/// Parameter is the GUID of the created collection. -/// -/// -public sealed class PcpParsing() : EventWrapper(nameof(PcpParsing)) -{ - public enum Priority - { - /// - ModsApi = int.MinValue, - } -} diff --git a/Penumbra/Communication/ResolvedFileChanged.cs b/Penumbra/Communication/ResolvedFileChanged.cs index 0c91a18b..75444340 100644 --- a/Penumbra/Communication/ResolvedFileChanged.cs +++ b/Penumbra/Communication/ResolvedFileChanged.cs @@ -1,5 +1,6 @@ using OtterGui.Classes; using Penumbra.Collections; +using Penumbra.Mods; using Penumbra.Mods.Editor; using Penumbra.String.Classes; @@ -32,8 +33,5 @@ public sealed class ResolvedFileChanged() { /// DalamudSubstitutionProvider = 0, - - /// - SchedulerResourceManagementService = 0, } } diff --git a/Penumbra/Configuration.cs b/Penumbra/Configuration.cs index 2991230e..b81e84d8 100644 --- a/Penumbra/Configuration.cs +++ b/Penumbra/Configuration.cs @@ -1,10 +1,9 @@ using Dalamud.Configuration; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Filesystem; -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Import.Structs; using Penumbra.Interop.Services; @@ -18,17 +17,8 @@ using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs; namespace Penumbra; -public record PcpSettings -{ - public bool CreateCollection { get; set; } = true; - public bool AssignCollection { get; set; } = true; - public bool AllowIpc { get; set; } = true; - public bool DisableHandling { get; set; } = false; - public string FolderName { get; set; } = "PCP"; -} - [Serializable] -public class Configuration : IPluginConfiguration, ISavable, IService +public class Configuration : IPluginConfiguration, ISavable { [JsonIgnore] private readonly SaveService _saveService; @@ -40,20 +30,9 @@ public class Configuration : IPluginConfiguration, ISavable, IService public ChangeLogDisplayType ChangeLogDisplayType { get; set; } = ChangeLogDisplayType.New; - public event Action? ModsEnabled; - - [JsonIgnore] - private bool _enableMods = true; - - public bool EnableMods - { - get => _enableMods; - set => SetField(ref _enableMods, value, ModsEnabled); - } - + public bool EnableMods { get; set; } = true; public string ModDirectory { get; set; } = string.Empty; public string ExportDirectory { get; set; } = string.Empty; - public string WatchDirectory { get; set; } = string.Empty; public bool? UseCrashHandler { get; set; } = null; public bool OpenWindowAtStart { get; set; } = false; @@ -62,28 +41,19 @@ public class Configuration : IPluginConfiguration, ISavable, IService public bool HideUiWhenUiHidden { get; set; } = false; public bool UseDalamudUiTextureRedirection { get; set; } = true; - public bool AutoSelectCollection { get; set; } = false; - - public bool ShowModsInLobby { get; set; } = true; - public bool UseCharacterCollectionInMainWindow { get; set; } = true; - public bool UseCharacterCollectionsInCards { get; set; } = true; - public bool UseCharacterCollectionInInspect { get; set; } = true; - public bool UseCharacterCollectionInTryOn { get; set; } = true; - public bool UseOwnerNameForCharacterCollection { get; set; } = true; - public bool UseNoModsInInspect { get; set; } = false; - public bool HideChangedItemFilters { get; set; } = false; - public bool ReplaceNonAsciiOnImport { get; set; } = false; - public bool HidePrioritiesInSelector { get; set; } = false; - public bool HideRedrawBar { get; set; } = false; - public bool HideMachinistOffhandFromChangedItems { get; set; } = true; - public bool DefaultTemporaryMode { get; set; } = false; - public bool EnableDirectoryWatch { get; set; } = false; - public bool EnableAutomaticModImport { get; set; } = false; - public bool EnableCustomShapes { get; set; } = true; - public PcpSettings PcpSettings = new(); - public RenameField ShowRename { get; set; } = RenameField.BothDataPrio; - public ChangedItemMode ChangedItemDisplay { get; set; } = ChangedItemMode.GroupedCollapsed; - public int OptionGroupCollapsibleMin { get; set; } = 5; + public bool UseCharacterCollectionInMainWindow { get; set; } = true; + public bool UseCharacterCollectionsInCards { get; set; } = true; + public bool UseCharacterCollectionInInspect { get; set; } = true; + public bool UseCharacterCollectionInTryOn { get; set; } = true; + public bool UseOwnerNameForCharacterCollection { get; set; } = true; + public bool UseNoModsInInspect { get; set; } = false; + public bool HideChangedItemFilters { get; set; } = false; + public bool ReplaceNonAsciiOnImport { get; set; } = false; + public bool HidePrioritiesInSelector { get; set; } = false; + public bool HideRedrawBar { get; set; } = false; + public bool HideMachinistOffhandFromChangedItems { get; set; } = true; + public RenameField ShowRename { get; set; } = RenameField.BothDataPrio; + public int OptionGroupCollapsibleMin { get; set; } = 5; public Vector2 MinimumSize = new(Constants.MinimumSizeX, Constants.MinimumSizeY); @@ -98,6 +68,9 @@ public class Configuration : IPluginConfiguration, ISavable, IService [JsonProperty(Order = int.MaxValue)] public ISortMode SortMode = ISortMode.FoldersFirst; + public bool ScaleModSelector { get; set; } = false; + public float ModSelectorAbsoluteSize { get; set; } = Constants.DefaultAbsoluteSize; + public int ModSelectorScaledSize { get; set; } = Constants.DefaultScaledSize; public bool OpenFoldersByDefault { get; set; } = false; public int SingleGroupRadioMax { get; set; } = 2; public string DefaultImportFolder { get; set; } = string.Empty; @@ -105,22 +78,15 @@ public class Configuration : IPluginConfiguration, ISavable, IService public string QuickMoveFolder2 { get; set; } = string.Empty; public string QuickMoveFolder3 { get; set; } = string.Empty; public DoubleModifier DeleteModModifier { get; set; } = new(ModifierHotkey.Control, ModifierHotkey.Shift); - public DoubleModifier IncognitoModifier { get; set; } = new(ModifierHotkey.Control); public bool PrintSuccessfulCommandsToChat { get; set; } = true; public bool AutoDeduplicateOnImport { get; set; } = true; - public bool AutoReduplicateUiOnImport { get; set; } = true; public bool UseFileSystemCompression { get; set; } = true; public bool EnableHttpApi { get; set; } = true; - public bool MigrateImportedModelsToV6 { get; set; } = true; - public bool MigrateImportedMaterialsToLegacy { get; set; } = true; - public string DefaultModImportPath { get; set; } = string.Empty; public bool AlwaysOpenDefaultImport { get; set; } = false; public bool KeepDefaultMetaChanges { get; set; } = false; public string DefaultModAuthor { get; set; } = DefaultTexToolsData.Author; - public bool EditRawTileTransforms { get; set; } = false; - public bool HdrRenderTargets { get; set; } = true; public Dictionary Colors { get; set; } = Enum.GetValues().ToDictionary(c => c, c => c.Data().DefaultColor); @@ -226,45 +192,4 @@ public class Configuration : IPluginConfiguration, ISavable, IService var serializer = new JsonSerializer { Formatting = Formatting.Indented }; serializer.Serialize(jWriter, this); } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool SetField(ref T field, T value, Action? @event, [CallerMemberName] string? propertyName = null) - { - if (EqualityComparer.Default.Equals(value)) - return false; - - var oldValue = field; - field = value; - try - { - @event?.Invoke(oldValue, field); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Error in subscribers updating configuration field {propertyName} from {oldValue} to {field}:\n{ex}"); - throw; - } - - return true; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool SetField(ref T field, T value, Action? @event, [CallerMemberName] string? propertyName = null) - { - if (EqualityComparer.Default.Equals(value)) - return false; - - field = value; - try - { - @event?.Invoke(field); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Error in subscribers updating configuration field {propertyName} to {field}:\n{ex}"); - throw; - } - - return true; - } } diff --git a/Penumbra/DebugConfiguration.cs b/Penumbra/DebugConfiguration.cs deleted file mode 100644 index 3f9e8207..00000000 --- a/Penumbra/DebugConfiguration.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace Penumbra; - -public class DebugConfiguration -{ - public static bool WriteImcBytesToLog = false; - public static bool UseSkinMaterialProcessing = true; -} diff --git a/Penumbra/Enums/ResourceTypeFlag.cs b/Penumbra/Enums/ResourceTypeFlag.cs index 920e9780..0cfc5469 100644 --- a/Penumbra/Enums/ResourceTypeFlag.cs +++ b/Penumbra/Enums/ResourceTypeFlag.cs @@ -60,13 +60,6 @@ public enum ResourceTypeFlag : ulong Uld = 0x0002_0000_0000_0000, Waoe = 0x0004_0000_0000_0000, Wtd = 0x0008_0000_0000_0000, - Bklb = 0x0010_0000_0000_0000, - Cutb = 0x0020_0000_0000_0000, - Eanb = 0x0040_0000_0000_0000, - Eslb = 0x0080_0000_0000_0000, - Fpeb = 0x0100_0000_0000_0000, - Kdb = 0x0200_0000_0000_0000, - Kdlb = 0x0400_0000_0000_0000, } [Flags] @@ -148,13 +141,6 @@ public static class ResourceExtensions ResourceType.Uld => ResourceTypeFlag.Uld, ResourceType.Waoe => ResourceTypeFlag.Waoe, ResourceType.Wtd => ResourceTypeFlag.Wtd, - ResourceType.Bklb => ResourceTypeFlag.Bklb, - ResourceType.Cutb => ResourceTypeFlag.Cutb, - ResourceType.Eanb => ResourceTypeFlag.Eanb, - ResourceType.Eslb => ResourceTypeFlag.Eslb, - ResourceType.Fpeb => ResourceTypeFlag.Fpeb, - ResourceType.Kdb => ResourceTypeFlag.Kdb , - ResourceType.Kdlb => ResourceTypeFlag.Kdlb, _ => 0, }; @@ -162,7 +148,7 @@ public static class ResourceExtensions => (type.ToFlag() & flags) != 0; public static ResourceCategoryFlag ToFlag(this ResourceCategory type) - => (ResourceCategory)((uint) type & 0x00FFFFFF) switch + => type switch { ResourceCategory.Common => ResourceCategoryFlag.Common, ResourceCategory.BgCommon => ResourceCategoryFlag.BgCommon, @@ -216,10 +202,10 @@ public static class ResourceExtensions }; } - public static ResourceType Type(CiByteString path) + public static ResourceType Type(ByteString path) { var extIdx = path.LastIndexOf((byte)'.'); - var ext = extIdx == -1 ? path : extIdx == path.Length - 1 ? CiByteString.Empty : path.Substring(extIdx + 1); + var ext = extIdx == -1 ? path : extIdx == path.Length - 1 ? ByteString.Empty : path.Substring(extIdx + 1); return ext.Length switch { @@ -231,7 +217,7 @@ public static class ResourceExtensions }; } - public static ResourceCategory Category(CiByteString path) + public static ResourceCategory Category(ByteString path) { if (path.Length < 3) return ResourceCategory.Debug; diff --git a/Penumbra/EphemeralConfig.cs b/Penumbra/EphemeralConfig.cs index ecb0218f..0a542d04 100644 --- a/Penumbra/EphemeralConfig.cs +++ b/Penumbra/EphemeralConfig.cs @@ -1,8 +1,6 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using OtterGui.Classes; -using OtterGui.FileSystem.Selector; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Communication; using Penumbra.Enums; @@ -16,7 +14,7 @@ using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs; namespace Penumbra; -public class EphemeralConfig : ISavable, IDisposable, IService +public class EphemeralConfig : ISavable, IDisposable { [JsonIgnore] private readonly SaveService _saveService; @@ -24,29 +22,24 @@ public class EphemeralConfig : ISavable, IDisposable, IService [JsonIgnore] private readonly ModPathChanged _modPathChanged; - public float CurrentModSelectorWidth { get; set; } = 200f; - public float ModSelectorMinimumScale { get; set; } = 0.1f; - public float ModSelectorMaximumScale { get; set; } = 0.5f; - - public int Version { get; set; } = Configuration.Constants.CurrentVersion; - public int LastSeenVersion { get; set; } = PenumbraChangelog.LastChangelogVersion; - public bool DebugSeparateWindow { get; set; } = false; - public int TutorialStep { get; set; } = 0; - public bool EnableResourceLogging { get; set; } = false; - public string ResourceLoggingFilter { get; set; } = string.Empty; - public bool EnableResourceWatcher { get; set; } = false; - public bool OnlyAddMatchingResources { get; set; } = true; - public ResourceTypeFlag ResourceWatcherResourceTypes { get; set; } = ResourceExtensions.AllResourceTypes; - public ResourceCategoryFlag ResourceWatcherResourceCategories { get; set; } = ResourceExtensions.AllResourceCategories; - public RecordType ResourceWatcherRecordTypes { get; set; } = ResourceWatcher.AllRecords; - public CollectionsTab.PanelMode CollectionPanel { get; set; } = CollectionsTab.PanelMode.SimpleAssignment; - public TabType SelectedTab { get; set; } = TabType.Settings; - public ChangedItemIconFlag ChangedItemFilter { get; set; } = ChangedItemFlagExtensions.DefaultFlags; - public bool FixMainWindow { get; set; } = false; - public string LastModPath { get; set; } = string.Empty; - public bool AdvancedEditingOpen { get; set; } = false; - public bool ForceRedrawOnFileChange { get; set; } = false; - public bool IncognitoMode { get; set; } = false; + public int Version { get; set; } = Configuration.Constants.CurrentVersion; + public int LastSeenVersion { get; set; } = PenumbraChangelog.LastChangelogVersion; + public bool DebugSeparateWindow { get; set; } = false; + public int TutorialStep { get; set; } = 0; + public bool EnableResourceLogging { get; set; } = false; + public string ResourceLoggingFilter { get; set; } = string.Empty; + public bool EnableResourceWatcher { get; set; } = false; + public bool OnlyAddMatchingResources { get; set; } = true; + public ResourceTypeFlag ResourceWatcherResourceTypes { get; set; } = ResourceExtensions.AllResourceTypes; + public ResourceCategoryFlag ResourceWatcherResourceCategories { get; set; } = ResourceExtensions.AllResourceCategories; + public RecordType ResourceWatcherRecordTypes { get; set; } = ResourceWatcher.AllRecords; + public CollectionsTab.PanelMode CollectionPanel { get; set; } = CollectionsTab.PanelMode.SimpleAssignment; + public TabType SelectedTab { get; set; } = TabType.Settings; + public ChangedItemDrawer.ChangedItemIcon ChangedItemFilter { get; set; } = ChangedItemDrawer.DefaultFlags; + public bool FixMainWindow { get; set; } = false; + public string LastModPath { get; set; } = string.Empty; + public bool AdvancedEditingOpen { get; set; } = false; + public bool ForceRedrawOnFileChange { get; set; } = false; /// /// Load the current configuration. diff --git a/Penumbra/GuidExtensions.cs b/Penumbra/GuidExtensions.cs new file mode 100644 index 00000000..fcbc8a3b --- /dev/null +++ b/Penumbra/GuidExtensions.cs @@ -0,0 +1,254 @@ +using System.Collections.Frozen; +using OtterGui; + +namespace Penumbra; + +public static class GuidExtensions +{ + private const string Chars = + "0123456789" + + "abcdefghij" + + "klmnopqrst" + + "uv"; + + private static ReadOnlySpan Bytes + => "0123456789abcdefghijklmnopqrstuv"u8; + + private static readonly FrozenDictionary + ReverseChars = Chars.WithIndex().ToFrozenDictionary(t => t.Value, t => (byte)t.Index); + + private static readonly FrozenDictionary ReverseBytes = + ReverseChars.ToFrozenDictionary(kvp => (byte)kvp.Key, kvp => kvp.Value); + + public static unsafe string OptimizedString(this Guid guid) + { + var bytes = stackalloc ulong[2]; + if (!guid.TryWriteBytes(new Span(bytes, 16))) + return guid.ToString("N"); + + var u1 = bytes[0]; + var u2 = bytes[1]; + Span text = + [ + Chars[(int)(u1 & 0x1F)], + Chars[(int)((u1 >> 5) & 0x1F)], + Chars[(int)((u1 >> 10) & 0x1F)], + Chars[(int)((u1 >> 15) & 0x1F)], + Chars[(int)((u1 >> 20) & 0x1F)], + Chars[(int)((u1 >> 25) & 0x1F)], + Chars[(int)((u1 >> 30) & 0x1F)], + Chars[(int)((u1 >> 35) & 0x1F)], + Chars[(int)((u1 >> 40) & 0x1F)], + Chars[(int)((u1 >> 45) & 0x1F)], + Chars[(int)((u1 >> 50) & 0x1F)], + Chars[(int)((u1 >> 55) & 0x1F)], + Chars[(int)((u1 >> 60) | ((u2 & 0x01) << 4))], + Chars[(int)((u2 >> 1) & 0x1F)], + Chars[(int)((u2 >> 6) & 0x1F)], + Chars[(int)((u2 >> 11) & 0x1F)], + Chars[(int)((u2 >> 16) & 0x1F)], + Chars[(int)((u2 >> 21) & 0x1F)], + Chars[(int)((u2 >> 26) & 0x1F)], + Chars[(int)((u2 >> 31) & 0x1F)], + Chars[(int)((u2 >> 36) & 0x1F)], + Chars[(int)((u2 >> 41) & 0x1F)], + Chars[(int)((u2 >> 46) & 0x1F)], + Chars[(int)((u2 >> 51) & 0x1F)], + Chars[(int)((u2 >> 56) & 0x1F)], + Chars[(int)((u2 >> 61) & 0x1F)], + ]; + return new string(text); + } + + public static unsafe bool FromOptimizedString(ReadOnlySpan text, out Guid guid) + { + if (text.Length != 26) + return Return(out guid); + + var bytes = stackalloc ulong[2]; + if (!ReverseChars.TryGetValue(text[0], out var b0)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[1], out var b1)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[2], out var b2)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[3], out var b3)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[4], out var b4)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[5], out var b5)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[6], out var b6)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[7], out var b7)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[8], out var b8)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[9], out var b9)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[10], out var b10)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[11], out var b11)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[12], out var b12)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[13], out var b13)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[14], out var b14)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[15], out var b15)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[16], out var b16)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[17], out var b17)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[18], out var b18)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[19], out var b19)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[20], out var b20)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[21], out var b21)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[22], out var b22)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[23], out var b23)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[24], out var b24)) + return Return(out guid); + if (!ReverseChars.TryGetValue(text[25], out var b25)) + return Return(out guid); + + bytes[0] = b0 + | ((ulong)b1 << 5) + | ((ulong)b2 << 10) + | ((ulong)b3 << 15) + | ((ulong)b4 << 20) + | ((ulong)b5 << 25) + | ((ulong)b6 << 30) + | ((ulong)b7 << 35) + | ((ulong)b8 << 40) + | ((ulong)b9 << 45) + | ((ulong)b10 << 50) + | ((ulong)b11 << 55) + | ((ulong)b12 << 60); + bytes[1] = ((ulong)b12 >> 4) + | ((ulong)b13 << 1) + | ((ulong)b14 << 6) + | ((ulong)b15 << 11) + | ((ulong)b16 << 16) + | ((ulong)b17 << 21) + | ((ulong)b18 << 26) + | ((ulong)b19 << 31) + | ((ulong)b20 << 36) + | ((ulong)b21 << 41) + | ((ulong)b22 << 46) + | ((ulong)b23 << 51) + | ((ulong)b24 << 56) + | ((ulong)b25 << 61); + guid = new Guid(new Span(bytes, 16)); + return true; + + static bool Return(out Guid guid) + { + guid = Guid.Empty; + return false; + } + } + + public static unsafe bool FromOptimizedString(ReadOnlySpan text, out Guid guid) + { + if (text.Length != 26) + return Return(out guid); + + var bytes = stackalloc ulong[2]; + if (!ReverseBytes.TryGetValue(text[0], out var b0)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[1], out var b1)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[2], out var b2)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[3], out var b3)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[4], out var b4)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[5], out var b5)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[6], out var b6)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[7], out var b7)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[8], out var b8)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[9], out var b9)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[10], out var b10)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[11], out var b11)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[12], out var b12)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[13], out var b13)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[14], out var b14)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[15], out var b15)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[16], out var b16)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[17], out var b17)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[18], out var b18)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[19], out var b19)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[20], out var b20)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[21], out var b21)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[22], out var b22)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[23], out var b23)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[24], out var b24)) + return Return(out guid); + if (!ReverseBytes.TryGetValue(text[25], out var b25)) + return Return(out guid); + + bytes[0] = b0 + | ((ulong)b1 << 5) + | ((ulong)b2 << 10) + | ((ulong)b3 << 15) + | ((ulong)b4 << 20) + | ((ulong)b5 << 25) + | ((ulong)b6 << 30) + | ((ulong)b7 << 35) + | ((ulong)b8 << 40) + | ((ulong)b9 << 45) + | ((ulong)b10 << 50) + | ((ulong)b11 << 55) + | ((ulong)b12 << 60); + bytes[1] = ((ulong)b12 >> 4) + | ((ulong)b13 << 1) + | ((ulong)b14 << 6) + | ((ulong)b15 << 11) + | ((ulong)b16 << 16) + | ((ulong)b17 << 21) + | ((ulong)b18 << 26) + | ((ulong)b19 << 31) + | ((ulong)b20 << 36) + | ((ulong)b21 << 41) + | ((ulong)b22 << 46) + | ((ulong)b23 << 51) + | ((ulong)b24 << 56) + | ((ulong)b25 << 61); + guid = new Guid(new Span(bytes, 16)); + return true; + + static bool Return(out Guid guid) + { + guid = Guid.Empty; + return false; + } + } +} diff --git a/Penumbra/Import/Models/Export/MaterialExporter.cs b/Penumbra/Import/Models/Export/MaterialExporter.cs index 0d91534e..5df9e1c1 100644 --- a/Penumbra/Import/Models/Export/MaterialExporter.cs +++ b/Penumbra/Import/Models/Export/MaterialExporter.cs @@ -1,7 +1,6 @@ using Lumina.Data.Parsing; using Penumbra.GameData.Files; using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.UI.AdvancedWindow.Materials; using SharpGLTF.Materials; using SixLabors.ImageSharp; using SixLabors.ImageSharp.Advanced; @@ -37,14 +36,12 @@ public class MaterialExporter return material.Mtrl.ShaderPackage.Name switch { // NOTE: this isn't particularly precise to game behavior (it has some fade around high opacity), but good enough for now. - "character.shpk" => BuildCharacter(material, name).WithAlpha(AlphaMode.MASK, 0.5f), - "characterlegacy.shpk" => BuildCharacter(material, name).WithAlpha(AlphaMode.MASK, 0.5f), - "characterglass.shpk" => BuildCharacter(material, name).WithAlpha(AlphaMode.BLEND), - "charactertattoo.shpk" => BuildCharacterTattoo(material, name), - "hair.shpk" => BuildHair(material, name), - "iris.shpk" => BuildIris(material, name), - "skin.shpk" => BuildSkin(material, name), - _ => BuildFallback(material, name, notifier), + "character.shpk" => BuildCharacter(material, name).WithAlpha(AlphaMode.MASK, 0.5f), + "characterglass.shpk" => BuildCharacter(material, name).WithAlpha(AlphaMode.BLEND), + "hair.shpk" => BuildHair(material, name), + "iris.shpk" => BuildIris(material, name), + "skin.shpk" => BuildSkin(material, name), + _ => BuildFallback(material, name, notifier), }; } @@ -52,65 +49,69 @@ public class MaterialExporter private static MaterialBuilder BuildCharacter(Material material, string name) { // Build the textures from the color table. - var table = new ColorTable(material.Mtrl.Table!); - var indexTexture = material.Textures[(TextureUsage)1449103320]; - var indexOperation = new ProcessCharacterIndexOperation(indexTexture, table); - ParallelRowIterator.IterateRows(ImageSharpConfiguration.Default, indexTexture.Bounds, in indexOperation); + var table = new LegacyColorTable(material.Mtrl.Table); - var normalTexture = material.Textures[TextureUsage.SamplerNormal]; - var normalOperation = new ProcessCharacterNormalOperation(normalTexture); - ParallelRowIterator.IterateRows(ImageSharpConfiguration.Default, normalTexture.Bounds, in normalOperation); + var normal = material.Textures[TextureUsage.SamplerNormal]; - // Merge in opacity from the normal. - var baseColor = indexOperation.BaseColor; - MultiplyOperation.Execute(baseColor, normalOperation.BaseColorOpacity); + var operation = new ProcessCharacterNormalOperation(normal, table); + ParallelRowIterator.IterateRows(ImageSharpConfiguration.Default, normal.Bounds, in operation); - // Check if a full diffuse is provided, and merge in if available. + // Check if full textures are provided, and merge in if available. + var baseColor = operation.BaseColor; if (material.Textures.TryGetValue(TextureUsage.SamplerDiffuse, out var diffuse)) { - MultiplyOperation.Execute(diffuse, indexOperation.BaseColor); + MultiplyOperation.Execute(diffuse, operation.BaseColor); baseColor = diffuse; } - var specular = indexOperation.Specular; + Image specular = operation.Specular; if (material.Textures.TryGetValue(TextureUsage.SamplerSpecular, out var specularTexture)) { - MultiplyOperation.Execute(specularTexture, indexOperation.Specular); + MultiplyOperation.Execute(specularTexture, operation.Specular); specular = specularTexture; } // Pull further information from the mask. if (material.Textures.TryGetValue(TextureUsage.SamplerMask, out var maskTexture)) { - var maskOperation = new ProcessCharacterMaskOperation(maskTexture); - ParallelRowIterator.IterateRows(ImageSharpConfiguration.Default, maskTexture.Bounds, in maskOperation); + // Extract the red channel for "ambient occlusion". + maskTexture.Mutate(context => context.Resize(baseColor.Width, baseColor.Height)); + maskTexture.ProcessPixelRows(baseColor, (maskAccessor, baseColorAccessor) => + { + for (var y = 0; y < maskAccessor.Height; y++) + { + var maskSpan = maskAccessor.GetRowSpan(y); + var baseColorSpan = baseColorAccessor.GetRowSpan(y); - // TODO: consider using the occusion gltf material property. - MultiplyOperation.Execute(baseColor, maskOperation.Occlusion); - - // Similar to base color's alpha, this is a pretty wasteful operation for a single channel. - MultiplyOperation.Execute(specular, maskOperation.SpecularFactor); + for (var x = 0; x < maskSpan.Length; x++) + baseColorSpan[x].FromVector4(baseColorSpan[x].ToVector4() * new Vector4(maskSpan[x].R / 255f)); + } + }); + // TODO: handle other textures stored in the mask? } // Specular extension puts colour on RGB and factor on A. We're already packing like that, so we can reuse the texture. var specularImage = BuildImage(specular, name, "specular"); return BuildSharedBase(material, name) - .WithBaseColor(BuildImage(baseColor, name, "basecolor")) - .WithNormal(BuildImage(normalOperation.Normal, name, "normal")) - .WithEmissive(BuildImage(indexOperation.Emissive, name, "emissive"), Vector3.One, 1) + .WithBaseColor(BuildImage(baseColor, name, "basecolor")) + .WithNormal(BuildImage(operation.Normal, name, "normal")) + .WithEmissive(BuildImage(operation.Emissive, name, "emissive"), Vector3.One, 1) .WithSpecularFactor(specularImage, 1) .WithSpecularColor(specularImage); } - private readonly struct ProcessCharacterIndexOperation(Image index, ColorTable table) : IRowOperation + // TODO: It feels a little silly to request the entire normal here when extracting the normal only needs some of the components. + // As a future refactor, it would be neat to accept a single-channel field here, and then do composition of other stuff later. + private readonly struct ProcessCharacterNormalOperation(Image normal, LegacyColorTable table) : IRowOperation { - public Image BaseColor { get; } = new(index.Width, index.Height); - public Image Specular { get; } = new(index.Width, index.Height); - public Image Emissive { get; } = new(index.Width, index.Height); + public Image Normal { get; } = normal.Clone(); + public Image BaseColor { get; } = new(normal.Width, normal.Height); + public Image Specular { get; } = new(normal.Width, normal.Height); + public Image Emissive { get; } = new(normal.Width, normal.Height); - private Buffer2D IndexBuffer - => index.Frames.RootFrame.PixelBuffer; + private Buffer2D NormalBuffer + => Normal.Frames.RootFrame.PixelBuffer; private Buffer2D BaseColorBuffer => BaseColor.Frames.RootFrame.PixelBuffer; @@ -123,96 +124,66 @@ public class MaterialExporter public void Invoke(int y) { - var indexSpan = IndexBuffer.DangerousGetRowSpan(y); + var normalSpan = NormalBuffer.DangerousGetRowSpan(y); var baseColorSpan = BaseColorBuffer.DangerousGetRowSpan(y); var specularSpan = SpecularBuffer.DangerousGetRowSpan(y); var emissiveSpan = EmissiveBuffer.DangerousGetRowSpan(y); - for (var x = 0; x < indexSpan.Length; x++) - { - ref var indexPixel = ref indexSpan[x]; - - // Calculate and fetch the color table rows being used for this pixel. - var tablePair = (int) Math.Round(indexPixel.R / 17f); - var rowBlend = 1.0f - indexPixel.G / 255f; - - var prevRow = table[tablePair * 2]; - var nextRow = table[Math.Min(tablePair * 2 + 1, ColorTable.NumRows)]; - - // Lerp between table row values to fetch final pixel values for each subtexture. - var lerpedDiffuse = Vector3.Lerp((Vector3)prevRow.DiffuseColor, (Vector3)nextRow.DiffuseColor, rowBlend); - baseColorSpan[x].FromVector4(new Vector4(MtrlTab.PseudoSqrtRgb(lerpedDiffuse), 1)); - - var lerpedSpecularColor = Vector3.Lerp((Vector3)prevRow.SpecularColor, (Vector3)nextRow.SpecularColor, rowBlend); - specularSpan[x].FromVector4(new Vector4(MtrlTab.PseudoSqrtRgb(lerpedSpecularColor), 1)); - - var lerpedEmissive = Vector3.Lerp((Vector3)prevRow.EmissiveColor, (Vector3)nextRow.EmissiveColor, rowBlend); - emissiveSpan[x].FromVector4(new Vector4(MtrlTab.PseudoSqrtRgb(lerpedEmissive), 1)); - } - } - } - - private readonly struct ProcessCharacterNormalOperation(Image normal) : IRowOperation - { - // TODO: Consider omitting the alpha channel here. - public Image Normal { get; } = normal.Clone(); - // TODO: We only really need the alpha here, however using A8 will result in the multiply later zeroing out the RGB channels. - public Image BaseColorOpacity { get; } = new(normal.Width, normal.Height); - - private Buffer2D NormalBuffer - => Normal.Frames.RootFrame.PixelBuffer; - - private Buffer2D BaseColorOpacityBuffer - => BaseColorOpacity.Frames.RootFrame.PixelBuffer; - - public void Invoke(int y) - { - var normalSpan = NormalBuffer.DangerousGetRowSpan(y); - var baseColorOpacitySpan = BaseColorOpacityBuffer.DangerousGetRowSpan(y); - for (var x = 0; x < normalSpan.Length; x++) { ref var normalPixel = ref normalSpan[x]; - baseColorOpacitySpan[x].FromVector4(Vector4.One); - baseColorOpacitySpan[x].A = normalPixel.B; + // Table row data (.a) + var tableRow = GetTableRowIndices(normalPixel.A / 255f); + var prevRow = table[tableRow.Previous]; + var nextRow = table[tableRow.Next]; + // Base colour (table, .b) + var lerpedDiffuse = Vector3.Lerp(prevRow.Diffuse, nextRow.Diffuse, tableRow.Weight); + baseColorSpan[x].FromVector4(new Vector4(lerpedDiffuse, 1)); + baseColorSpan[x].A = normalPixel.B; + + // Specular (table) + var lerpedSpecularColor = Vector3.Lerp(prevRow.Specular, nextRow.Specular, tableRow.Weight); + var lerpedSpecularFactor = float.Lerp(prevRow.SpecularStrength, nextRow.SpecularStrength, tableRow.Weight); + specularSpan[x].FromVector4(new Vector4(lerpedSpecularColor, lerpedSpecularFactor)); + + // Emissive (table) + var lerpedEmissive = Vector3.Lerp(prevRow.Emissive, nextRow.Emissive, tableRow.Weight); + emissiveSpan[x].FromVector4(new Vector4(lerpedEmissive, 1)); + + // Normal (.rg) + // TODO: we don't actually need alpha at all for normal, but _not_ using the existing rgba texture means I'll need a new one, with a new accessor. Think about it. normalPixel.B = byte.MaxValue; normalPixel.A = byte.MaxValue; } } } - private readonly struct ProcessCharacterMaskOperation(Image mask) : IRowOperation + private static TableRow GetTableRowIndices(float input) { - public Image Occlusion { get; } = new(mask.Width, mask.Height); - public Image SpecularFactor { get; } = new(mask.Width, mask.Height); + // These calculations are ported from character.shpk. + var smoothed = MathF.Floor(input * 7.5f % 1.0f * 2) + * (-input * 15 + MathF.Floor(input * 15 + 0.5f)) + + input * 15; - private Buffer2D MaskBuffer - => mask.Frames.RootFrame.PixelBuffer; + var stepped = MathF.Floor(smoothed + 0.5f); - private Buffer2D OcclusionBuffer - => Occlusion.Frames.RootFrame.PixelBuffer; - - private Buffer2D SpecularFactorBuffer - => SpecularFactor.Frames.RootFrame.PixelBuffer; - - public void Invoke(int y) + return new TableRow { - var maskSpan = MaskBuffer.DangerousGetRowSpan(y); - var occlusionSpan = OcclusionBuffer.DangerousGetRowSpan(y); - var specularFactorSpan = SpecularFactorBuffer.DangerousGetRowSpan(y); + Stepped = (int)stepped, + Previous = (int)MathF.Floor(smoothed), + Next = (int)MathF.Ceiling(smoothed), + Weight = smoothed % 1, + }; + } - for (var x = 0; x < maskSpan.Length; x++) - { - ref var maskPixel = ref maskSpan[x]; - - occlusionSpan[x].FromL8(new L8(maskPixel.B)); - - specularFactorSpan[x].FromVector4(Vector4.One); - specularFactorSpan[x].A = maskPixel.R; - } - } + private ref struct TableRow + { + public int Stepped; + public int Previous; + public int Next; + public float Weight; } private readonly struct MultiplyOperation @@ -246,37 +217,6 @@ public class MaterialExporter } } - private static readonly Vector4 DefaultTattooColor = new Vector4(38, 112, 102, 255) / new Vector4(255); - - private static MaterialBuilder BuildCharacterTattoo(Material material, string name) - { - var normal = material.Textures[TextureUsage.SamplerNormal]; - var baseColor = new Image(normal.Width, normal.Height); - - normal.ProcessPixelRows(baseColor, (normalAccessor, baseColorAccessor) => - { - for (var y = 0; y < normalAccessor.Height; y++) - { - var normalSpan = normalAccessor.GetRowSpan(y); - var baseColorSpan = baseColorAccessor.GetRowSpan(y); - - for (var x = 0; x < normalSpan.Length; x++) - { - baseColorSpan[x].FromVector4(DefaultTattooColor); - baseColorSpan[x].A = normalSpan[x].A; - - normalSpan[x].B = byte.MaxValue; - normalSpan[x].A = byte.MaxValue; - } - } - }); - - return BuildSharedBase(material, name) - .WithBaseColor(BuildImage(baseColor, name, "basecolor")) - .WithNormal(BuildImage(normal, name, "normal")) - .WithAlpha(AlphaMode.BLEND); - } - // TODO: These are hardcoded colours - I'm not keen on supporting highly customizable exports, but there's possibly some more sensible values to use here. private static readonly Vector4 DefaultHairColor = new Vector4(130, 64, 13, 255) / new Vector4(255); private static readonly Vector4 DefaultHighlightColor = new Vector4(77, 126, 240, 255) / new Vector4(255); @@ -289,7 +229,7 @@ public class MaterialExporter const uint valueFace = 0x6E5B8F10; var isFace = material.Mtrl.ShaderPackage.ShaderKeys - .Any(key => key is { Key: categoryHairType, Value: valueFace }); + .Any(key => key is { Category: categoryHairType, Value: valueFace }); var normal = material.Textures[TextureUsage.SamplerNormal]; var mask = material.Textures[TextureUsage.SamplerMask]; @@ -307,11 +247,10 @@ public class MaterialExporter for (var x = 0; x < normalSpan.Length; x++) { - var color = Vector4.Lerp(DefaultHairColor, DefaultHighlightColor, normalSpan[x].B / 255f); - baseColorSpan[x].FromVector4(color * new Vector4(maskSpan[x].A / 255f)); + var color = Vector4.Lerp(DefaultHairColor, DefaultHighlightColor, maskSpan[x].A / 255f); + baseColorSpan[x].FromVector4(color * new Vector4(maskSpan[x].R / 255f)); baseColorSpan[x].A = normalSpan[x].A; - normalSpan[x].B = byte.MaxValue; normalSpan[x].A = byte.MaxValue; } } @@ -329,23 +268,26 @@ public class MaterialExporter // NOTE: This is largely the same as the hair material, but is also missing a few features that would cause it to diverge. Keeping separate for now. private static MaterialBuilder BuildIris(Material material, string name) { - var normal = material.Textures[TextureUsage.SamplerNormal]; - var mask = material.Textures[TextureUsage.SamplerMask]; - var baseColor = material.Textures[TextureUsage.SamplerDiffuse]; + var normal = material.Textures[TextureUsage.SamplerNormal]; + var mask = material.Textures[TextureUsage.SamplerMask]; - mask.Mutate(context => context.Resize(baseColor.Width, baseColor.Height)); + mask.Mutate(context => context.Resize(normal.Width, normal.Height)); - baseColor.ProcessPixelRows(mask, (baseColorAccessor, maskAccessor) => + var baseColor = new Image(normal.Width, normal.Height); + normal.ProcessPixelRows(mask, baseColor, (normalAccessor, maskAccessor, baseColorAccessor) => { - for (var y = 0; y < baseColor.Height; y++) + for (var y = 0; y < normalAccessor.Height; y++) { - var baseColorSpan = baseColorAccessor.GetRowSpan(y); + var normalSpan = normalAccessor.GetRowSpan(y); var maskSpan = maskAccessor.GetRowSpan(y); + var baseColorSpan = baseColorAccessor.GetRowSpan(y); - for (var x = 0; x < baseColorSpan.Length; x++) + for (var x = 0; x < normalSpan.Length; x++) { - var eyeColor = Vector4.Lerp(Vector4.One, DefaultEyeColor, maskSpan[x].B / 255f); - baseColorSpan[x].FromVector4(baseColorSpan[x].ToVector4() * eyeColor); + baseColorSpan[x].FromVector4(DefaultEyeColor * new Vector4(maskSpan[x].R / 255f)); + baseColorSpan[x].A = normalSpan[x].A; + + normalSpan[x].A = byte.MaxValue; } } }); @@ -364,14 +306,28 @@ public class MaterialExporter // Face is the default for the skin shader, so a lack of skin type category is also correct. var isFace = !material.Mtrl.ShaderPackage.ShaderKeys - .Any(key => key.Key == categorySkinType && key.Value != valueFace); + .Any(key => key.Category == categorySkinType && key.Value != valueFace); // TODO: There's more nuance to skin than this, but this should be enough for a baseline reference. // TODO: Specular? var diffuse = material.Textures[TextureUsage.SamplerDiffuse]; var normal = material.Textures[TextureUsage.SamplerNormal]; - // The normal also stores the skin color influence (.b) and wetness mask (.a) - remove. + // Create a copy of the normal that's the same size as the diffuse for purposes of copying the opacity across. + var resizedNormal = normal.Clone(context => context.Resize(diffuse.Width, diffuse.Height)); + diffuse.ProcessPixelRows(resizedNormal, (diffuseAccessor, normalAccessor) => + { + for (var y = 0; y < diffuseAccessor.Height; y++) + { + var diffuseSpan = diffuseAccessor.GetRowSpan(y); + var normalSpan = normalAccessor.GetRowSpan(y); + + for (var x = 0; x < diffuseSpan.Length; x++) + diffuseSpan[x].A = normalSpan[x].B; + } + }); + + // Clear the blue channel out of the normal now that we're done with it. normal.ProcessPixelRows(normalAccessor => { for (var y = 0; y < normalAccessor.Height; y++) @@ -379,10 +335,7 @@ public class MaterialExporter var normalSpan = normalAccessor.GetRowSpan(y); for (var x = 0; x < normalSpan.Length; x++) - { normalSpan[x].B = byte.MaxValue; - normalSpan[x].A = byte.MaxValue; - } } }); diff --git a/Penumbra/Import/Models/Export/MeshExporter.cs b/Penumbra/Import/Models/Export/MeshExporter.cs index 6ea2b284..219a046e 100644 --- a/Penumbra/Import/Models/Export/MeshExporter.cs +++ b/Penumbra/Import/Models/Export/MeshExporter.cs @@ -1,12 +1,11 @@ using System.Collections.Immutable; -using System.Text.Json; -using System.Text.Json.Nodes; using Lumina.Extensions; -using OtterGui.Extensions; +using OtterGui; using Penumbra.GameData.Files; using Penumbra.GameData.Files.ModelStructs; using SharpGLTF.Geometry; using SharpGLTF.Geometry.VertexTypes; +using SharpGLTF.IO; using SharpGLTF.Materials; using SharpGLTF.Scenes; @@ -24,11 +23,11 @@ public class MeshExporter ? scene.AddSkinnedMesh(data.Mesh, Matrix4x4.Identity, [.. skeleton.Value.Joints]) : scene.AddRigidMesh(data.Mesh, Matrix4x4.Identity); - var node = new JsonObject(); + var extras = new Dictionary(data.Attributes.Length); foreach (var attribute in data.Attributes) - node[attribute] = true; + extras.Add(attribute, true); - instance.WithExtras(node); + instance.WithExtras(JsonContent.CreateFrom(extras)); } } } @@ -83,12 +82,9 @@ public class MeshExporter _boneIndexMap = BuildBoneIndexMap(skeleton.Value); var usages = _mdl.VertexDeclarations[_meshIndex].VertexElements - .GroupBy(ele => (MdlFile.VertexUsage)ele.Usage, ele => ele) .ToImmutableDictionary( - g => g.Key, - g => g.OrderBy(ele => ele.UsageIndex) // OrderBy UsageIndex is probably unnecessary as they're probably already be in order - .Select(ele => (MdlFile.VertexType)ele.Type) - .ToList() + element => (MdlFile.VertexUsage)element.Usage, + element => (MdlFile.VertexType)element.Type ); _geometryType = GetGeometryType(usages); @@ -114,7 +110,6 @@ public class MeshExporter var indexMap = new Dictionary(); // #TODO @ackwell maybe fix for V6 Models, I think this works fine. - foreach (var (xivBoneIndex, tableIndex) in xivBoneTable.BoneIndex.Take((int)xivBoneTable.BoneCount).WithIndex()) { var boneName = _mdl.Bones[xivBoneIndex]; @@ -238,7 +233,10 @@ public class MeshExporter // Named morph targets aren't part of the specification, however `MESH.extras.targetNames` // is a commonly-accepted means of providing the data. - meshBuilder.Extras = new JsonObject { ["targetNames"] = JsonSerializer.SerializeToNode(shapeNames) }; + meshBuilder.Extras = JsonContent.CreateFrom(new Dictionary() + { + { "targetNames", shapeNames }, + }); string[] attributes = []; var maxAttribute = 31 - BitOperations.LeadingZeroCount(attributeMask); @@ -281,22 +279,18 @@ public class MeshExporter var sortedElements = _mdl.VertexDeclarations[_meshIndex].VertexElements .OrderBy(element => element.Offset) + .Select(element => ((MdlFile.VertexUsage)element.Usage, element)) .ToList(); + var vertices = new List(); - var attributes = new Dictionary>(); + var attributes = new Dictionary(); for (var vertexIndex = 0; vertexIndex < XivMesh.VertexCount; vertexIndex++) { attributes.Clear(); - attributes = sortedElements - .GroupBy(element => element.Usage) - .ToDictionary( - x => (MdlFile.VertexUsage)x.Key, - x => x.OrderBy(ele => ele.UsageIndex) // Once again, OrderBy UsageIndex is probably unnecessary - .Select(ele => ReadVertexAttribute((MdlFile.VertexType)ele.Type, streams[ele.Stream])) - .ToList() - ); - + + foreach (var (usage, element) in sortedElements) + attributes[usage] = ReadVertexAttribute((MdlFile.VertexType)element.Type, streams[element.Stream]); var vertexGeometry = BuildVertexGeometry(attributes); var vertexMaterial = BuildVertexMaterial(attributes); @@ -318,16 +312,18 @@ public class MeshExporter MdlFile.VertexType.Single3 => new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()), MdlFile.VertexType.Single4 => new Vector4(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()), MdlFile.VertexType.UByte4 => reader.ReadBytes(4), - MdlFile.VertexType.NByte4 => new Vector4(reader.ReadByte() / 255f, reader.ReadByte() / 255f, reader.ReadByte() / 255f, reader.ReadByte() / 255f), + MdlFile.VertexType.NByte4 => new Vector4(reader.ReadByte() / 255f, reader.ReadByte() / 255f, reader.ReadByte() / 255f, + reader.ReadByte() / 255f), MdlFile.VertexType.Half2 => new Vector2((float)reader.ReadHalf(), (float)reader.ReadHalf()), - MdlFile.VertexType.Half4 => new Vector4((float)reader.ReadHalf(), (float)reader.ReadHalf(), (float)reader.ReadHalf(), (float)reader.ReadHalf()), - MdlFile.VertexType.UShort4 => reader.ReadBytes(8), + MdlFile.VertexType.Half4 => new Vector4((float)reader.ReadHalf(), (float)reader.ReadHalf(), (float)reader.ReadHalf(), + (float)reader.ReadHalf()), + var other => throw _notifier.Exception($"Unhandled vertex type {other}"), }; } /// Get the vertex geometry type for this mesh's vertex usages. - private Type GetGeometryType(IReadOnlyDictionary> usages) + private Type GetGeometryType(IReadOnlyDictionary usages) { if (!usages.ContainsKey(MdlFile.VertexUsage.Position)) throw _notifier.Exception("Mesh does not contain position vertex elements."); @@ -342,29 +338,29 @@ public class MeshExporter } /// Build a geometry vertex from a vertex's attributes. - private IVertexGeometry BuildVertexGeometry(IReadOnlyDictionary> attributes) + private IVertexGeometry BuildVertexGeometry(IReadOnlyDictionary attributes) { if (_geometryType == typeof(VertexPosition)) return new VertexPosition( - ToVector3(GetFirstSafe(attributes, MdlFile.VertexUsage.Position)) + ToVector3(attributes[MdlFile.VertexUsage.Position]) ); if (_geometryType == typeof(VertexPositionNormal)) return new VertexPositionNormal( - ToVector3(GetFirstSafe(attributes, MdlFile.VertexUsage.Position)), - ToVector3(GetFirstSafe(attributes, MdlFile.VertexUsage.Normal)) + ToVector3(attributes[MdlFile.VertexUsage.Position]), + ToVector3(attributes[MdlFile.VertexUsage.Normal]) ); if (_geometryType == typeof(VertexPositionNormalTangent)) { // (Bi)tangents are universally stored as ByteFloat4, which uses 0..1 to represent the full -1..1 range. // TODO: While this assumption is safe, it would be sensible to actually check. - var bitangent = ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.Tangent1)) * 2 - Vector4.One; - + var bitangent = ToVector4(attributes[MdlFile.VertexUsage.Tangent1]) * 2 - Vector4.One; + return new VertexPositionNormalTangent( - ToVector3(GetFirstSafe(attributes, MdlFile.VertexUsage.Position)), - ToVector3(GetFirstSafe(attributes, MdlFile.VertexUsage.Normal)), - bitangent.SanitizeTangent() + ToVector3(attributes[MdlFile.VertexUsage.Position]), + ToVector3(attributes[MdlFile.VertexUsage.Normal]), + bitangent ); } @@ -372,90 +368,60 @@ public class MeshExporter } /// Get the vertex material type for this mesh's vertex usages. - private Type GetMaterialType(IReadOnlyDictionary> usages) + private Type GetMaterialType(IReadOnlyDictionary usages) { var uvCount = 0; - if (usages.TryGetValue(MdlFile.VertexUsage.UV, out var list)) - { - foreach (var type in list) + if (usages.TryGetValue(MdlFile.VertexUsage.UV, out var type)) + uvCount = type switch { - uvCount += type switch - { - MdlFile.VertexType.Half2 => 1, - MdlFile.VertexType.Half4 => 2, - MdlFile.VertexType.Single2 => 1, - MdlFile.VertexType.Single4 => 2, - _ => throw _notifier.Exception($"Unexpected UV vertex type {type}."), - }; - } - } - - usages.TryGetValue(MdlFile.VertexUsage.Color, out var colours); - var nColors = colours?.Count ?? 0; + MdlFile.VertexType.Half2 => 1, + MdlFile.VertexType.Half4 => 2, + MdlFile.VertexType.Single2 => 1, + MdlFile.VertexType.Single4 => 2, + _ => throw _notifier.Exception($"Unexpected UV vertex type {type}."), + }; var materialUsages = ( uvCount, - nColors + usages.ContainsKey(MdlFile.VertexUsage.Color) ); return materialUsages switch { - (3, 2) => typeof(VertexTexture3Color2Ffxiv), - (3, 1) => typeof(VertexTexture3ColorFfxiv), - (3, 0) => typeof(VertexTexture3), - (2, 2) => typeof(VertexTexture2Color2Ffxiv), - (2, 1) => typeof(VertexTexture2ColorFfxiv), - (2, 0) => typeof(VertexTexture2), - (1, 2) => typeof(VertexTexture1Color2Ffxiv), - (1, 1) => typeof(VertexTexture1ColorFfxiv), - (1, 0) => typeof(VertexTexture1), - (0, 2) => typeof(VertexColor2Ffxiv), - (0, 1) => typeof(VertexColorFfxiv), - (0, 0) => typeof(VertexEmpty), + (2, true) => typeof(VertexTexture2ColorFfxiv), + (2, false) => typeof(VertexTexture2), + (1, true) => typeof(VertexTexture1ColorFfxiv), + (1, false) => typeof(VertexTexture1), + (0, true) => typeof(VertexColorFfxiv), + (0, false) => typeof(VertexEmpty), - _ => throw _notifier.Exception($"Unhandled UV/color count of {uvCount}/{nColors} encountered."), + _ => throw new Exception("Unreachable."), }; } /// Build a material vertex from a vertex's attributes. - private IVertexMaterial BuildVertexMaterial(IReadOnlyDictionary> attributes) + private IVertexMaterial BuildVertexMaterial(IReadOnlyDictionary attributes) { if (_materialType == typeof(VertexEmpty)) return new VertexEmpty(); if (_materialType == typeof(VertexColorFfxiv)) - return new VertexColorFfxiv(ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.Color))); - - if (_materialType == typeof(VertexColor2Ffxiv)) - { - var (color0, color1) = GetBothSafe(attributes, MdlFile.VertexUsage.Color); - return new VertexColor2Ffxiv(ToVector4(color0), ToVector4(color1)); - } + return new VertexColorFfxiv(ToVector4(attributes[MdlFile.VertexUsage.Color])); if (_materialType == typeof(VertexTexture1)) - return new VertexTexture1(ToVector2(GetFirstSafe(attributes, MdlFile.VertexUsage.UV))); + return new VertexTexture1(ToVector2(attributes[MdlFile.VertexUsage.UV])); if (_materialType == typeof(VertexTexture1ColorFfxiv)) return new VertexTexture1ColorFfxiv( - ToVector2(GetFirstSafe(attributes, MdlFile.VertexUsage.UV)), - ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.Color)) + ToVector2(attributes[MdlFile.VertexUsage.UV]), + ToVector4(attributes[MdlFile.VertexUsage.Color]) ); - if (_materialType == typeof(VertexTexture1Color2Ffxiv)) - { - var (color0, color1) = GetBothSafe(attributes, MdlFile.VertexUsage.Color); - return new VertexTexture1Color2Ffxiv( - ToVector2(GetFirstSafe(attributes, MdlFile.VertexUsage.UV)), - ToVector4(color0), - ToVector4(color1) - ); - } - // XIV packs two UVs into a single vec4 attribute. if (_materialType == typeof(VertexTexture2)) { - var uv = ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.UV)); + var uv = ToVector4(attributes[MdlFile.VertexUsage.UV]); return new VertexTexture2( new Vector2(uv.X, uv.Y), new Vector2(uv.Z, uv.W) @@ -464,63 +430,11 @@ public class MeshExporter if (_materialType == typeof(VertexTexture2ColorFfxiv)) { - var uv = ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.UV)); + var uv = ToVector4(attributes[MdlFile.VertexUsage.UV]); return new VertexTexture2ColorFfxiv( new Vector2(uv.X, uv.Y), new Vector2(uv.Z, uv.W), - ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.Color)) - ); - } - - if (_materialType == typeof(VertexTexture2Color2Ffxiv)) - { - var uv = ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.UV)); - var (color0, color1) = GetBothSafe(attributes, MdlFile.VertexUsage.Color); - - return new VertexTexture2Color2Ffxiv( - new Vector2(uv.X, uv.Y), - new Vector2(uv.Z, uv.W), - ToVector4(color0), - ToVector4(color1) - ); - } - - if (_materialType == typeof(VertexTexture3)) - { - // Not 100% sure about this - var uv0 = ToVector4(attributes[MdlFile.VertexUsage.UV][0]); - var uv1 = ToVector4(attributes[MdlFile.VertexUsage.UV][1]); - return new VertexTexture3( - new Vector2(uv0.X, uv0.Y), - new Vector2(uv0.Z, uv0.W), - new Vector2(uv1.X, uv1.Y) - ); - } - - if (_materialType == typeof(VertexTexture3ColorFfxiv)) - { - var uv0 = ToVector4(attributes[MdlFile.VertexUsage.UV][0]); - var uv1 = ToVector4(attributes[MdlFile.VertexUsage.UV][1]); - return new VertexTexture3ColorFfxiv( - new Vector2(uv0.X, uv0.Y), - new Vector2(uv0.Z, uv0.W), - new Vector2(uv1.X, uv1.Y), - ToVector4(GetFirstSafe(attributes, MdlFile.VertexUsage.Color)) - ); - } - - if (_materialType == typeof(VertexTexture3Color2Ffxiv)) - { - var uv0 = ToVector4(attributes[MdlFile.VertexUsage.UV][0]); - var uv1 = ToVector4(attributes[MdlFile.VertexUsage.UV][1]); - var (color0, color1) = GetBothSafe(attributes, MdlFile.VertexUsage.Color); - - return new VertexTexture3Color2Ffxiv( - new Vector2(uv0.X, uv0.Y), - new Vector2(uv0.Z, uv0.W), - new Vector2(uv1.X, uv1.Y), - ToVector4(color0), - ToVector4(color1) + ToVector4(attributes[MdlFile.VertexUsage.Color]) ); } @@ -528,35 +442,29 @@ public class MeshExporter } /// Get the vertex skinning type for this mesh's vertex usages. - private Type GetSkinningType(IReadOnlyDictionary> usages) + private static Type GetSkinningType(IReadOnlyDictionary usages) { if (usages.ContainsKey(MdlFile.VertexUsage.BlendWeights) && usages.ContainsKey(MdlFile.VertexUsage.BlendIndices)) - { - return GetFirstSafe(usages, MdlFile.VertexUsage.BlendWeights) == MdlFile.VertexType.UShort4 - ? typeof(VertexJoints8) - : typeof(VertexJoints4); - } + return typeof(VertexJoints4); return typeof(VertexEmpty); } /// Build a skinning vertex from a vertex's attributes. - private IVertexSkinning BuildVertexSkinning(IReadOnlyDictionary> attributes) + private IVertexSkinning BuildVertexSkinning(IReadOnlyDictionary attributes) { if (_skinningType == typeof(VertexEmpty)) return new VertexEmpty(); - if (_skinningType == typeof(VertexJoints4) || _skinningType == typeof(VertexJoints8)) + if (_skinningType == typeof(VertexJoints4)) { if (_boneIndexMap == null) throw _notifier.Exception("Tried to build skinned vertex but no bone mappings are available."); - var indiciesData = GetFirstSafe(attributes, MdlFile.VertexUsage.BlendIndices); - var weightsData = GetFirstSafe(attributes, MdlFile.VertexUsage.BlendWeights); - var indices = ToByteArray(indiciesData); - var weights = ToFloatArray(weightsData); - - var bindings = Enumerable.Range(0, indices.Length) + var indices = ToByteArray(attributes[MdlFile.VertexUsage.BlendIndices]); + var weights = ToVector4(attributes[MdlFile.VertexUsage.BlendWeights]); + + var bindings = Enumerable.Range(0, 4) .Select(bindingIndex => { // NOTE: I've not seen any files that throw this error that aren't completely broken. @@ -567,40 +475,12 @@ public class MeshExporter return (jointIndex, weights[bindingIndex]); }) .ToArray(); - - return bindings.Length switch - { - 4 => new VertexJoints4(bindings), - 8 => new VertexJoints8(bindings), - _ => throw _notifier.Exception($"Invalid number of bone bindings {bindings.Length}.") - }; + return new VertexJoints4(bindings); } throw _notifier.Exception($"Unknown skinning type {_skinningType}"); } - /// Check that the list has length 1 for any case where this is expected and return the one entry. - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private T GetFirstSafe(IReadOnlyDictionary> attributes, MdlFile.VertexUsage usage) - { - var list = attributes[usage]; - if (list.Count != 1) - throw _notifier.Exception($"Multiple usage indices encountered for {usage}."); - - return list[0]; - } - - /// Check that the list has length 2 for any case where this is expected and return both entries. - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private (T First, T Second) GetBothSafe(IReadOnlyDictionary> attributes, MdlFile.VertexUsage usage) - { - var list = attributes[usage]; - if (list.Count != 2) - throw _notifier.Exception($"{list.Count} usage indices encountered for {usage}, but expected 2."); - - return (list[0], list[1]); - } - /// Convert a vertex attribute value to a Vector2. Supported inputs are Vector2, Vector3, and Vector4. private static Vector2 ToVector2(object data) => data switch @@ -638,13 +518,4 @@ public class MeshExporter byte[] value => value, _ => throw new ArgumentOutOfRangeException($"Invalid byte[] input {data}"), }; - - private static float[] ToFloatArray(object data) - => data switch - { - byte[] value => value.Select(x => x / 255f).ToArray(), - Vector4 v4 => new[] { v4.X, v4.Y, v4.Z, v4.W }, - _ => throw new ArgumentOutOfRangeException($"Invalid float[] input {data}"), - }; } - diff --git a/Penumbra/Import/Models/Export/VertexFragment.cs b/Penumbra/Import/Models/Export/VertexFragment.cs index 463c59fc..7a82e994 100644 --- a/Penumbra/Import/Models/Export/VertexFragment.cs +++ b/Penumbra/Import/Models/Export/VertexFragment.cs @@ -1,5 +1,4 @@ using SharpGLTF.Geometry.VertexTypes; -using SharpGLTF.Memory; using SharpGLTF.Schema2; namespace Penumbra.Import.Models.Export; @@ -10,39 +9,37 @@ Realistically, it will need to stick around until transforms/mutations are built and there's reason to overhaul the export pipeline. */ -public struct VertexColorFfxiv(Vector4 ffxivColor) : IVertexCustom +public struct VertexColorFfxiv : IVertexCustom { - public IEnumerable> GetEncodingAttributes() - { - // NOTE: We only realistically require UNSIGNED_BYTE for this, however Blender 3.6 errors on that (fixed in 4.0). - yield return new KeyValuePair("_FFXIV_COLOR", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } + // NOTE: We only realistically require UNSIGNED_BYTE for this, however Blender 3.6 errors on that (fixed in 4.0). + [VertexAttribute("_FFXIV_COLOR", EncodingType.UNSIGNED_SHORT, true)] + public Vector4 FfxivColor; - public Vector4 FfxivColor = ffxivColor; + public int MaxColors => 0; - public int MaxColors - => 0; - - public int MaxTextCoords - => 0; + public int MaxTextCoords => 0; private static readonly string[] CustomNames = ["_FFXIV_COLOR"]; + public IEnumerable CustomAttributes => CustomNames; - public IEnumerable CustomAttributes - => CustomNames; + public VertexColorFfxiv(Vector4 ffxivColor) + { + FfxivColor = ffxivColor; + } public void Add(in VertexMaterialDelta delta) - { } + { + } public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, Vector2.Zero, Vector2.Zero); + => new VertexMaterialDelta(Vector4.Zero, Vector4.Zero, Vector2.Zero, Vector2.Zero); public Vector2 GetTexCoord(int index) => throw new ArgumentOutOfRangeException(nameof(index)); public void SetTexCoord(int setIndex, Vector2 coord) - { } + { + } public bool TryGetCustomAttribute(string attributeName, out object? value) { @@ -68,143 +65,37 @@ public struct VertexColorFfxiv(Vector4 ffxivColor) : IVertexCustom => throw new ArgumentOutOfRangeException(nameof(index)); public void SetColor(int setIndex, Vector4 color) - { } + { + } public void Validate() { - var components = new[] - { - FfxivColor.X, - FfxivColor.Y, - FfxivColor.Z, - FfxivColor.W, - }; + var components = new[] { FfxivColor.X, FfxivColor.Y, FfxivColor.Z, FfxivColor.W }; if (components.Any(component => component < 0 || component > 1)) throw new ArgumentOutOfRangeException(nameof(FfxivColor)); } } -public struct VertexColor2Ffxiv(Vector4 ffxivColor0, Vector4 ffxivColor1) : IVertexCustom +public struct VertexTexture1ColorFfxiv : IVertexCustom { - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("_FFXIV_COLOR_0", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - yield return new KeyValuePair("_FFXIV_COLOR_1", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } + [VertexAttribute("TEXCOORD_0")] + public Vector2 TexCoord0; - public Vector4 FfxivColor0 = ffxivColor0; - public Vector4 FfxivColor1 = ffxivColor1; + [VertexAttribute("_FFXIV_COLOR", EncodingType.UNSIGNED_SHORT, true)] + public Vector4 FfxivColor; - public int MaxColors - => 0; + public int MaxColors => 0; - public int MaxTextCoords - => 0; - - private static readonly string[] CustomNames = ["_FFXIV_COLOR_0", "_FFXIV_COLOR_1"]; - - public IEnumerable CustomAttributes - => CustomNames; - - public void Add(in VertexMaterialDelta delta) - { } - - public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, Vector2.Zero, Vector2.Zero); - - public Vector2 GetTexCoord(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetTexCoord(int setIndex, Vector2 coord) - { } - - public bool TryGetCustomAttribute(string attributeName, out object? value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0": - value = FfxivColor0; - return true; - - case "_FFXIV_COLOR_1": - value = FfxivColor1; - return true; - - default: - value = null; - return false; - } - } - - public void SetCustomAttribute(string attributeName, object value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0" when value is Vector4 valueVector4: - FfxivColor0 = valueVector4; - break; - case "_FFXIV_COLOR_1" when value is Vector4 valueVector4: - FfxivColor1 = valueVector4; - break; - } - } - - public Vector4 GetColor(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetColor(int setIndex, Vector4 color) - { } - - public void Validate() - { - var components = new[] - { - FfxivColor0.X, - FfxivColor0.Y, - FfxivColor0.Z, - FfxivColor0.W, - }; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor0)); - components = - [ - FfxivColor1.X, - FfxivColor1.Y, - FfxivColor1.Z, - FfxivColor1.W, - ]; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor1)); - } -} - - -public struct VertexTexture1ColorFfxiv(Vector2 texCoord0, Vector4 ffxivColor) : IVertexCustom -{ - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } - - public Vector2 TexCoord0 = texCoord0; - - public Vector4 FfxivColor = ffxivColor; - - public int MaxColors - => 0; - - public int MaxTextCoords - => 1; + public int MaxTextCoords => 1; private static readonly string[] CustomNames = ["_FFXIV_COLOR"]; + public IEnumerable CustomAttributes => CustomNames; - public IEnumerable CustomAttributes - => CustomNames; + public VertexTexture1ColorFfxiv(Vector2 texCoord0, Vector4 ffxivColor) + { + TexCoord0 = texCoord0; + FfxivColor = ffxivColor; + } public void Add(in VertexMaterialDelta delta) { @@ -212,7 +103,9 @@ public struct VertexTexture1ColorFfxiv(Vector2 texCoord0, Vector4 ffxivColor) : } public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), Vector2.Zero); + { + return new VertexMaterialDelta(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), Vector2.Zero); + } public Vector2 GetTexCoord(int index) => index switch @@ -223,10 +116,8 @@ public struct VertexTexture1ColorFfxiv(Vector2 texCoord0, Vector4 ffxivColor) : public void SetTexCoord(int setIndex, Vector2 coord) { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex >= 1) - throw new ArgumentOutOfRangeException(nameof(setIndex)); + if (setIndex == 0) TexCoord0 = coord; + if (setIndex >= 1) throw new ArgumentOutOfRangeException(nameof(setIndex)); } public bool TryGetCustomAttribute(string attributeName, out object? value) @@ -253,160 +144,41 @@ public struct VertexTexture1ColorFfxiv(Vector2 texCoord0, Vector4 ffxivColor) : => throw new ArgumentOutOfRangeException(nameof(index)); public void SetColor(int setIndex, Vector4 color) - { } + { + } public void Validate() { - var components = new[] - { - FfxivColor.X, - FfxivColor.Y, - FfxivColor.Z, - FfxivColor.W, - }; + var components = new[] { FfxivColor.X, FfxivColor.Y, FfxivColor.Z, FfxivColor.W }; if (components.Any(component => component < 0 || component > 1)) throw new ArgumentOutOfRangeException(nameof(FfxivColor)); } } -public struct VertexTexture1Color2Ffxiv(Vector2 texCoord0, Vector4 ffxivColor0, Vector4 ffxivColor1) : IVertexCustom +public struct VertexTexture2ColorFfxiv : IVertexCustom { - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR_0", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - yield return new KeyValuePair("_FFXIV_COLOR_1", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } + [VertexAttribute("TEXCOORD_0")] + public Vector2 TexCoord0; - public Vector2 TexCoord0 = texCoord0; + [VertexAttribute("TEXCOORD_1")] + public Vector2 TexCoord1; - public Vector4 FfxivColor0 = ffxivColor0; - public Vector4 FfxivColor1 = ffxivColor1; + [VertexAttribute("_FFXIV_COLOR", EncodingType.UNSIGNED_SHORT, true)] + public Vector4 FfxivColor; - public int MaxColors - => 0; + public int MaxColors => 0; - public int MaxTextCoords - => 1; - - private static readonly string[] CustomNames = ["_FFXIV_COLOR_0", "_FFXIV_COLOR_1"]; - - public IEnumerable CustomAttributes - => CustomNames; - - public void Add(in VertexMaterialDelta delta) - { - TexCoord0 += delta.TexCoord0Delta; - } - - public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), Vector2.Zero); - - public Vector2 GetTexCoord(int index) - => index switch - { - 0 => TexCoord0, - _ => throw new ArgumentOutOfRangeException(nameof(index)), - }; - - public void SetTexCoord(int setIndex, Vector2 coord) - { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex >= 1) - throw new ArgumentOutOfRangeException(nameof(setIndex)); - } - - public bool TryGetCustomAttribute(string attributeName, out object? value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0": - value = FfxivColor0; - return true; - - case "_FFXIV_COLOR_1": - value = FfxivColor1; - return true; - - default: - value = null; - return false; - } - } - - public void SetCustomAttribute(string attributeName, object value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0" when value is Vector4 valueVector4: - FfxivColor0 = valueVector4; - break; - case "_FFXIV_COLOR_1" when value is Vector4 valueVector4: - FfxivColor1 = valueVector4; - break; - } - } - - public Vector4 GetColor(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetColor(int setIndex, Vector4 color) - { } - - public void Validate() - { - var components = new[] - { - FfxivColor0.X, - FfxivColor0.Y, - FfxivColor0.Z, - FfxivColor0.W, - }; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor0)); - components = - [ - FfxivColor1.X, - FfxivColor1.Y, - FfxivColor1.Z, - FfxivColor1.W, - ]; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor1)); - } -} - - -public struct VertexTexture2ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vector4 ffxivColor) : IVertexCustom -{ - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("TEXCOORD_1", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } - - public Vector2 TexCoord0 = texCoord0; - public Vector2 TexCoord1 = texCoord1; - public Vector4 FfxivColor = ffxivColor; - - public int MaxColors - => 0; - - public int MaxTextCoords - => 2; + public int MaxTextCoords => 2; private static readonly string[] CustomNames = ["_FFXIV_COLOR"]; + public IEnumerable CustomAttributes => CustomNames; - public IEnumerable CustomAttributes - => CustomNames; + public VertexTexture2ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vector4 ffxivColor) + { + TexCoord0 = texCoord0; + TexCoord1 = texCoord1; + FfxivColor = ffxivColor; + } public void Add(in VertexMaterialDelta delta) { @@ -415,7 +187,9 @@ public struct VertexTexture2ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vec } public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), TexCoord1 - baseValue.GetTexCoord(1)); + { + return new VertexMaterialDelta(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), TexCoord1 - baseValue.GetTexCoord(1)); + } public Vector2 GetTexCoord(int index) => index switch @@ -427,12 +201,9 @@ public struct VertexTexture2ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vec public void SetTexCoord(int setIndex, Vector2 coord) { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex == 1) - TexCoord1 = coord; - if (setIndex >= 2) - throw new ArgumentOutOfRangeException(nameof(setIndex)); + if (setIndex == 0) TexCoord0 = coord; + if (setIndex == 1) TexCoord1 = coord; + if (setIndex >= 2) throw new ArgumentOutOfRangeException(nameof(setIndex)); } public bool TryGetCustomAttribute(string attributeName, out object? value) @@ -459,361 +230,13 @@ public struct VertexTexture2ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vec => throw new ArgumentOutOfRangeException(nameof(index)); public void SetColor(int setIndex, Vector4 color) - { } + { + } public void Validate() { - var components = new[] - { - FfxivColor.X, - FfxivColor.Y, - FfxivColor.Z, - FfxivColor.W, - }; + var components = new[] { FfxivColor.X, FfxivColor.Y, FfxivColor.Z, FfxivColor.W }; if (components.Any(component => component < 0 || component > 1)) throw new ArgumentOutOfRangeException(nameof(FfxivColor)); } } - -public struct VertexTexture2Color2Ffxiv(Vector2 texCoord0, Vector2 texCoord1, Vector4 ffxivColor0, Vector4 ffxivColor1) : IVertexCustom -{ - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("TEXCOORD_1", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR_0", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - yield return new KeyValuePair("_FFXIV_COLOR_1", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } - - public Vector2 TexCoord0 = texCoord0; - public Vector2 TexCoord1 = texCoord1; - public Vector4 FfxivColor0 = ffxivColor0; - public Vector4 FfxivColor1 = ffxivColor1; - - public int MaxColors - => 0; - - public int MaxTextCoords - => 2; - - private static readonly string[] CustomNames = ["_FFXIV_COLOR_0", "_FFXIV_COLOR_1"]; - - public IEnumerable CustomAttributes - => CustomNames; - - public void Add(in VertexMaterialDelta delta) - { - TexCoord0 += delta.TexCoord0Delta; - TexCoord1 += delta.TexCoord1Delta; - } - - public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), TexCoord1 - baseValue.GetTexCoord(1)); - - public Vector2 GetTexCoord(int index) - => index switch - { - 0 => TexCoord0, - 1 => TexCoord1, - _ => throw new ArgumentOutOfRangeException(nameof(index)), - }; - - public void SetTexCoord(int setIndex, Vector2 coord) - { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex == 1) - TexCoord1 = coord; - if (setIndex >= 2) - throw new ArgumentOutOfRangeException(nameof(setIndex)); - } - - public bool TryGetCustomAttribute(string attributeName, out object? value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0": - value = FfxivColor0; - return true; - - case "_FFXIV_COLOR_1": - value = FfxivColor1; - return true; - - default: - value = null; - return false; - } - } - - public void SetCustomAttribute(string attributeName, object value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0" when value is Vector4 valueVector4: - FfxivColor0 = valueVector4; - break; - case "_FFXIV_COLOR_1" when value is Vector4 valueVector4: - FfxivColor1 = valueVector4; - break; - } - } - - public Vector4 GetColor(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetColor(int setIndex, Vector4 color) - { } - - public void Validate() - { - var components = new[] - { - FfxivColor0.X, - FfxivColor0.Y, - FfxivColor0.Z, - FfxivColor0.W, - }; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor0)); - components = - [ - FfxivColor1.X, - FfxivColor1.Y, - FfxivColor1.Z, - FfxivColor1.W, - ]; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor1)); - } - -} - -public struct VertexTexture3ColorFfxiv(Vector2 texCoord0, Vector2 texCoord1, Vector2 texCoord2, Vector4 ffxivColor) - : IVertexCustom -{ - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("TEXCOORD_1", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("TEXCOORD_2", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } - - public Vector2 TexCoord0 = texCoord0; - public Vector2 TexCoord1 = texCoord1; - public Vector2 TexCoord2 = texCoord2; - public Vector4 FfxivColor = ffxivColor; - - public int MaxColors - => 0; - - public int MaxTextCoords - => 3; - - private static readonly string[] CustomNames = ["_FFXIV_COLOR"]; - - public IEnumerable CustomAttributes - => CustomNames; - - public void Add(in VertexMaterialDelta delta) - { - TexCoord0 += delta.TexCoord0Delta; - TexCoord1 += delta.TexCoord1Delta; - TexCoord2 += delta.TexCoord2Delta; - } - - public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), TexCoord1 - baseValue.GetTexCoord(1)); - - public Vector2 GetTexCoord(int index) - => index switch - { - 0 => TexCoord0, - 1 => TexCoord1, - 2 => TexCoord2, - _ => throw new ArgumentOutOfRangeException(nameof(index)), - }; - - public void SetTexCoord(int setIndex, Vector2 coord) - { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex == 1) - TexCoord1 = coord; - if (setIndex == 2) - TexCoord2 = coord; - if (setIndex >= 3) - throw new ArgumentOutOfRangeException(nameof(setIndex)); - } - - public bool TryGetCustomAttribute(string attributeName, out object? value) - { - switch (attributeName) - { - case "_FFXIV_COLOR": - value = FfxivColor; - return true; - - default: - value = null; - return false; - } - } - - public void SetCustomAttribute(string attributeName, object value) - { - if (attributeName == "_FFXIV_COLOR" && value is Vector4 valueVector4) - FfxivColor = valueVector4; - } - - public Vector4 GetColor(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetColor(int setIndex, Vector4 color) - { } - - public void Validate() - { - var components = new[] - { - FfxivColor.X, - FfxivColor.Y, - FfxivColor.Z, - FfxivColor.W, - }; - if (components.Any(component => component is < 0f or > 1f)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor)); - } -} - -public struct VertexTexture3Color2Ffxiv(Vector2 texCoord0, Vector2 texCoord1, Vector2 texCoord2, Vector4 ffxivColor0, Vector4 ffxivColor1) - : IVertexCustom -{ - public IEnumerable> GetEncodingAttributes() - { - yield return new KeyValuePair("TEXCOORD_0", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("TEXCOORD_1", - new AttributeFormat(DimensionType.VEC2, EncodingType.FLOAT, false)); - yield return new KeyValuePair("_FFXIV_COLOR_0", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - yield return new KeyValuePair("_FFXIV_COLOR_1", - new AttributeFormat(DimensionType.VEC4, EncodingType.UNSIGNED_SHORT, true)); - } - - public Vector2 TexCoord0 = texCoord0; - public Vector2 TexCoord1 = texCoord1; - public Vector2 TexCoord2 = texCoord2; - public Vector4 FfxivColor0 = ffxivColor0; - public Vector4 FfxivColor1 = ffxivColor1; - - public int MaxColors - => 0; - - public int MaxTextCoords - => 3; - - private static readonly string[] CustomNames = ["_FFXIV_COLOR_0", "_FFXIV_COLOR_1"]; - - public IEnumerable CustomAttributes - => CustomNames; - - public void Add(in VertexMaterialDelta delta) - { - TexCoord0 += delta.TexCoord0Delta; - TexCoord1 += delta.TexCoord1Delta; - TexCoord2 += delta.TexCoord2Delta; - } - - public VertexMaterialDelta Subtract(IVertexMaterial baseValue) - => new(Vector4.Zero, Vector4.Zero, TexCoord0 - baseValue.GetTexCoord(0), TexCoord1 - baseValue.GetTexCoord(1)); - - public Vector2 GetTexCoord(int index) - => index switch - { - 0 => TexCoord0, - 1 => TexCoord1, - 2 => TexCoord2, - _ => throw new ArgumentOutOfRangeException(nameof(index)), - }; - - public void SetTexCoord(int setIndex, Vector2 coord) - { - if (setIndex == 0) - TexCoord0 = coord; - if (setIndex == 1) - TexCoord1 = coord; - if (setIndex == 2) - TexCoord2 = coord; - if (setIndex >= 3) - throw new ArgumentOutOfRangeException(nameof(setIndex)); - } - - public bool TryGetCustomAttribute(string attributeName, out object? value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0": - value = FfxivColor0; - return true; - - case "_FFXIV_COLOR_1": - value = FfxivColor1; - return true; - - default: - value = null; - return false; - } - } - - public void SetCustomAttribute(string attributeName, object value) - { - switch (attributeName) - { - case "_FFXIV_COLOR_0" when value is Vector4 valueVector4: - FfxivColor0 = valueVector4; - break; - case "_FFXIV_COLOR_1" when value is Vector4 valueVector4: - FfxivColor1 = valueVector4; - break; - } - } - - public Vector4 GetColor(int index) - => throw new ArgumentOutOfRangeException(nameof(index)); - - public void SetColor(int setIndex, Vector4 color) - { } - - public void Validate() - { - var components = new[] - { - FfxivColor0.X, - FfxivColor0.Y, - FfxivColor0.Z, - FfxivColor0.W, - }; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor0)); - components = - [ - FfxivColor1.X, - FfxivColor1.Y, - FfxivColor1.Z, - FfxivColor1.W, - ]; - if (components.Any(component => component is < 0 or > 1)) - throw new ArgumentOutOfRangeException(nameof(FfxivColor1)); - } -} diff --git a/Penumbra/Import/Models/HavokConverter.cs b/Penumbra/Import/Models/HavokConverter.cs index e3797083..dc9d3e6a 100644 --- a/Penumbra/Import/Models/HavokConverter.cs +++ b/Penumbra/Import/Models/HavokConverter.cs @@ -1,7 +1,4 @@ -using FFXIVClientStructs.Havok.Common.Base.System.IO.OStream; -using FFXIVClientStructs.Havok.Common.Base.Types; -using FFXIVClientStructs.Havok.Common.Serialize.Resource; -using FFXIVClientStructs.Havok.Common.Serialize.Util; +using FFXIVClientStructs.Havok; namespace Penumbra.Import.Models; diff --git a/Penumbra/Import/Models/Import/MeshImporter.cs b/Penumbra/Import/Models/Import/MeshImporter.cs index 16fe2ca0..1df97907 100644 --- a/Penumbra/Import/Models/Import/MeshImporter.cs +++ b/Penumbra/Import/Models/Import/MeshImporter.cs @@ -1,5 +1,5 @@ using Lumina.Data.Parsing; -using OtterGui.Extensions; +using OtterGui; using Penumbra.GameData.Files.ModelStructs; using SharpGLTF.Schema2; @@ -194,34 +194,24 @@ public class MeshImporter(IEnumerable nodes, IoNotifier notifier) foreach (var (primitive, primitiveIndex) in node.Mesh.Primitives.WithIndex()) { // Per glTF specification, an asset with a skin MUST contain skinning attributes on its meshes. - var joints0Accessor = primitive.GetVertexAccessor("JOINTS_0")?.AsVector4Array(); - var weights0Accessor = primitive.GetVertexAccessor("WEIGHTS_0")?.AsVector4Array(); - var joints1Accessor = primitive.GetVertexAccessor("JOINTS_1")?.AsVector4Array(); - var weights1Accessor = primitive.GetVertexAccessor("WEIGHTS_1")?.AsVector4Array(); - - if (joints0Accessor == null || weights0Accessor == null) + var jointsAccessor = primitive.GetVertexAccessor("JOINTS_0")?.AsVector4Array(); + var weightsAccessor = primitive.GetVertexAccessor("WEIGHTS_0")?.AsVector4Array(); + + if (jointsAccessor == null || weightsAccessor == null) throw notifier.Exception($"Primitive {primitiveIndex} is skinned but does not contain skinning vertex attributes."); // Build a set of joints that are referenced by this mesh. - for (var i = 0; i < joints0Accessor.Count; i++) + for (var i = 0; i < jointsAccessor.Count; i++) { - var joints0 = joints0Accessor[i]; - var weights0 = weights0Accessor[i]; - var joints1 = joints1Accessor?[i]; - var weights1 = weights1Accessor?[i]; + var joints = jointsAccessor[i]; + var weights = weightsAccessor[i]; for (var index = 0; index < 4; index++) { // If a joint has absolutely no weight, we omit the bone entirely. - if (weights0[index] != 0) - { - usedJoints.Add((ushort)joints0[index]); - } + if (weights[index] == 0) + continue; - - if (joints1 != null && weights1 != null && weights1.Value[index] != 0) - { - usedJoints.Add((ushort)joints1.Value[index]); - } + usedJoints.Add((ushort)joints[index]); } } } diff --git a/Penumbra/Import/Models/Import/ModelImporter.cs b/Penumbra/Import/Models/Import/ModelImporter.cs index f4eefccc..a141d754 100644 --- a/Penumbra/Import/Models/Import/ModelImporter.cs +++ b/Penumbra/Import/Models/Import/ModelImporter.cs @@ -1,5 +1,5 @@ using Lumina.Data.Parsing; -using OtterGui.Extensions; +using OtterGui; using Penumbra.GameData.Files; using Penumbra.GameData.Files.ModelStructs; using SharpGLTF.Schema2; @@ -8,9 +8,6 @@ namespace Penumbra.Import.Models.Import; public partial class ModelImporter(ModelRoot model, IoNotifier notifier) { - public const int BoneLimit = 128; - public const int MaterialLimit = 10; - public static MdlFile Import(ModelRoot model, IoNotifier notifier) { var importer = new ModelImporter(model, notifier); @@ -211,9 +208,10 @@ public partial class ModelImporter(ModelRoot model, IoNotifier notifier) if (index >= 0) return (ushort)index; + // If there's already 4 materials, we can't add any more. // TODO: permit, with a warning to reduce, and validation in MdlTab. var count = _materials.Count; - if (count >= MaterialLimit) + if (count >= 4) return 0; _materials.Add(materialName); @@ -236,11 +234,11 @@ public partial class ModelImporter(ModelRoot model, IoNotifier notifier) boneIndices.Add((ushort)boneIndex); } - if (boneIndices.Count > BoneLimit) - throw notifier.Exception($"XIV does not support meshes weighted to a total of more than {BoneLimit} bones."); + if (boneIndices.Count > 64) + throw notifier.Exception("XIV does not support meshes weighted to a total of more than 64 bones."); - var boneIndicesArray = new ushort[BoneLimit]; - boneIndices.CopyTo(boneIndicesArray); + var boneIndicesArray = new ushort[64]; + Array.Copy(boneIndices.ToArray(), boneIndicesArray, boneIndices.Count); var boneTableIndex = _boneTables.Count; _boneTables.Add(new BoneTableStruct() diff --git a/Penumbra/Import/Models/Import/PrimitiveImporter.cs b/Penumbra/Import/Models/Import/PrimitiveImporter.cs index 57c7929f..5df7597e 100644 --- a/Penumbra/Import/Models/Import/PrimitiveImporter.cs +++ b/Penumbra/Import/Models/Import/PrimitiveImporter.cs @@ -1,5 +1,5 @@ using Lumina.Data.Parsing; -using OtterGui.Extensions; +using OtterGui; using SharpGLTF.Schema2; namespace Penumbra.Import.Models.Import; diff --git a/Penumbra/Import/Models/Import/SubMeshImporter.cs b/Penumbra/Import/Models/Import/SubMeshImporter.cs index 6aa46fb6..e81bb622 100644 --- a/Penumbra/Import/Models/Import/SubMeshImporter.cs +++ b/Penumbra/Import/Models/Import/SubMeshImporter.cs @@ -1,6 +1,6 @@ using System.Text.Json; using Lumina.Data.Parsing; -using OtterGui.Extensions; +using OtterGui; using SharpGLTF.Schema2; namespace Penumbra.Import.Models.Import; @@ -61,7 +61,7 @@ public class SubMeshImporter try { - _morphNames = node.Mesh.Extras["targetNames"].Deserialize>(); + _morphNames = node.Mesh.Extras.GetNode("targetNames").Deserialize>(); } catch { diff --git a/Penumbra/Import/Models/Import/VertexAttribute.cs b/Penumbra/Import/Models/Import/VertexAttribute.cs index 155fa833..a4651776 100644 --- a/Penumbra/Import/Models/Import/VertexAttribute.cs +++ b/Penumbra/Import/Models/Import/VertexAttribute.cs @@ -40,7 +40,6 @@ public class VertexAttribute MdlFile.VertexType.NByte4 => 4, MdlFile.VertexType.Half2 => 4, MdlFile.VertexType.Half4 => 8, - MdlFile.VertexType.UShort4 => 8, _ => throw new Exception($"Unhandled vertex type {(MdlFile.VertexType)Element.Type}"), }; @@ -122,120 +121,81 @@ public class VertexAttribute public static VertexAttribute? BlendWeight(Accessors accessors, IoNotifier notifier) { - if (!accessors.TryGetValue("WEIGHTS_0", out var weights0Accessor)) + if (!accessors.TryGetValue("WEIGHTS_0", out var accessor)) return null; if (!accessors.ContainsKey("JOINTS_0")) throw notifier.Exception("Mesh contained WEIGHTS_0 attribute but no corresponding JOINTS_0 attribute."); - if (accessors.TryGetValue("WEIGHTS_1", out var weights1Accessor)) - { - if (!accessors.ContainsKey("JOINTS_1")) - throw notifier.Exception("Mesh contained WEIGHTS_1 attribute but no corresponding JOINTS_1 attribute."); - } - var element = new MdlStructs.VertexElement() { Stream = 0, - Type = (byte)MdlFile.VertexType.UShort4, - Usage = (byte)MdlFile.VertexUsage.BlendWeights, + Type = (byte)MdlFile.VertexType.NByte4, + Usage = (byte)MdlFile.VertexUsage.BlendWeights, }; - var weights0 = weights0Accessor.AsVector4Array(); - var weights1 = weights1Accessor?.AsVector4Array(); + var values = accessor.AsVector4Array(); return new VertexAttribute( element, - index => BuildBlendWeights(weights0[index], weights1?[index] ?? Vector4.Zero) - ); - } - - private static byte[] BuildBlendWeights(Vector4 v1, Vector4 v2) - { - var originalData = BuildUshort4(v1, v2); - var byteValues = new byte[originalData.Length]; - for (var i = 0; i < originalData.Length; i++) - { - byteValues[i] = (byte)Math.Round(originalData[i] * 255f); - } - - // Blend weights are _very_ sensitive to float imprecision - a vertex sum being off - // by one, such as 256, is enough to cause a visible defect. To avoid this, we tweak - // the converted values to have the expected sum, preferencing values with minimal differences. - var adjustment = 255 - byteValues.Sum(value => value); - while (adjustment != 0) - { - var closestIndex = Enumerable.Range(0, byteValues.Length) - .Where(i => adjustment switch + index => { + // Blend weights are _very_ sensitive to float imprecision - a vertex sum being off + // by one, such as 256, is enough to cause a visible defect. To avoid this, we tweak + // the converted values to have the expected sum, preferencing values with minimal differences. + var originalValues = values[index]; + var byteValues = BuildNByte4(originalValues); + + var adjustment = 255 - byteValues.Select(value => (int)value).Sum(); + while (adjustment != 0) { - < 0 => byteValues[i] > 0, - > 0 => byteValues[i] < 255, - _ => true, - }) - .Select(index => (index, delta: Math.Abs(originalData[index] - (byteValues[index] * (1f / 255f))))) - .MinBy(x => x.delta) - .index; - byteValues[closestIndex] += (byte)Math.CopySign(1, adjustment); - adjustment = 255 - byteValues.Sum(value => value); - } - - return byteValues; + var convertedValues = byteValues.Select(value => value * (1f / 255f)).ToArray(); + var closestIndex = Enumerable.Range(0, 4) + .Select(index => (index, delta: Math.Abs(originalValues[index] - convertedValues[index]))) + .MinBy(x => x.delta) + .index; + byteValues[closestIndex] = (byte)(byteValues[closestIndex] + Math.CopySign(1, adjustment)); + adjustment = 255 - byteValues.Select(value => (int)value).Sum(); + } + + return byteValues; + } + ); } public static VertexAttribute? BlendIndex(Accessors accessors, IDictionary? boneMap, IoNotifier notifier) { - if (!accessors.TryGetValue("JOINTS_0", out var joints0Accessor)) + if (!accessors.TryGetValue("JOINTS_0", out var jointsAccessor)) return null; - if (!accessors.TryGetValue("WEIGHTS_0", out var weights0Accessor)) + if (!accessors.TryGetValue("WEIGHTS_0", out var weightsAccessor)) throw notifier.Exception("Mesh contained JOINTS_0 attribute but no corresponding WEIGHTS_0 attribute."); if (boneMap == null) throw notifier.Exception("Mesh contained JOINTS_0 attribute but no bone mapping was created."); - var joints0 = joints0Accessor.AsVector4Array(); - var weights0 = weights0Accessor.AsVector4Array(); - accessors.TryGetValue("JOINTS_1", out var joints1Accessor); - accessors.TryGetValue("WEIGHTS_1", out var weights1Accessor); - var element = new MdlStructs.VertexElement + var element = new MdlStructs.VertexElement() { Stream = 0, - Type = (byte)MdlFile.VertexType.UShort4, + Type = (byte)MdlFile.VertexType.UByte4, Usage = (byte)MdlFile.VertexUsage.BlendIndices, }; - var joints1 = joints1Accessor?.AsVector4Array(); - var weights1 = weights1Accessor?.AsVector4Array(); + var joints = jointsAccessor.AsVector4Array(); + var weights = weightsAccessor.AsVector4Array(); return new VertexAttribute( element, index => { - var gltfIndices0 = joints0[index]; - var gltfWeights0 = weights0[index]; - var gltfIndices1 = joints1?[index]; - var gltfWeights1 = weights1?[index]; - var v0 = new Vector4( - gltfWeights0.X == 0 ? 0 : boneMap[(ushort)gltfIndices0.X], - gltfWeights0.Y == 0 ? 0 : boneMap[(ushort)gltfIndices0.Y], - gltfWeights0.Z == 0 ? 0 : boneMap[(ushort)gltfIndices0.Z], - gltfWeights0.W == 0 ? 0 : boneMap[(ushort)gltfIndices0.W] - ); - - var v1 = Vector4.Zero; - if (gltfIndices1 != null && gltfWeights1 != null) - { - v1 = new Vector4( - gltfWeights1.Value.X == 0 ? 0 : boneMap[(ushort)gltfIndices1.Value.X], - gltfWeights1.Value.Y == 0 ? 0 : boneMap[(ushort)gltfIndices1.Value.Y], - gltfWeights1.Value.Z == 0 ? 0 : boneMap[(ushort)gltfIndices1.Value.Z], - gltfWeights1.Value.W == 0 ? 0 : boneMap[(ushort)gltfIndices1.Value.W] - ); - } + var gltfIndices = joints[index]; + var gltfWeights = weights[index]; - var byteValues = BuildUshort4(v0, v1); - - return byteValues.Select(x => (byte)x).ToArray(); + return BuildUByte4(new Vector4( + gltfWeights.X == 0 ? 0 : boneMap[(ushort)gltfIndices.X], + gltfWeights.Y == 0 ? 0 : boneMap[(ushort)gltfIndices.Y], + gltfWeights.Z == 0 ? 0 : boneMap[(ushort)gltfIndices.Z], + gltfWeights.W == 0 ? 0 : boneMap[(ushort)gltfIndices.W] + )); } ); } @@ -266,7 +226,7 @@ public class VertexAttribute var value = values[vertexIndex]; var delta = morphValues[morphIndex]?[vertexIndex]; - if (delta != null) + if (delta != null) value += delta.Value; return BuildSingle3(value); @@ -319,7 +279,7 @@ public class VertexAttribute var normals = normalAccessor.AsVector3Array(); var tangents = accessors.TryGetValue("TANGENT", out var accessor) - ? accessor.AsVector4Array().ToArray() + ? accessor.AsVector4Array() : CalculateTangents(accessors, indices, normals, notifier); if (tangents == null) @@ -523,11 +483,4 @@ public class VertexAttribute (byte)Math.Round(input.Z * 255f), (byte)Math.Round(input.W * 255f), ]; - - private static float[] BuildUshort4(Vector4 v0, Vector4 v1) => - new[] - { - v0.X, v0.Y, v0.Z, v0.W, - v1.X, v1.Y, v1.Z, v1.W, - }; } diff --git a/Penumbra/Import/Models/ModelExtensions.cs b/Penumbra/Import/Models/ModelExtensions.cs deleted file mode 100644 index 2edb3ca4..00000000 --- a/Penumbra/Import/Models/ModelExtensions.cs +++ /dev/null @@ -1,69 +0,0 @@ -namespace Penumbra.Import.Models; - -public static class ModelExtensions -{ - // https://github.com/vpenades/SharpGLTF/blob/2073cf3cd671f8ecca9667f9a8c7f04ed865d3ac/src/Shared/_Extensions.cs#L158 - private const float UnitLengthThresholdVec3 = 0.00674f; - private const float UnitLengthThresholdVec4 = 0.00769f; - - internal static bool _IsFinite(this float value) - { - return float.IsFinite(value); - } - - internal static bool _IsFinite(this Vector2 v) - { - return v.X._IsFinite() && v.Y._IsFinite(); - } - - internal static bool _IsFinite(this Vector3 v) - { - return v.X._IsFinite() && v.Y._IsFinite() && v.Z._IsFinite(); - } - - internal static bool _IsFinite(this in Vector4 v) - { - return v.X._IsFinite() && v.Y._IsFinite() && v.Z._IsFinite() && v.W._IsFinite(); - } - - internal static Boolean IsNormalized(this Vector3 normal) - { - if (!normal._IsFinite()) return false; - - return Math.Abs(normal.Length() - 1) <= UnitLengthThresholdVec3; - } - - internal static void ValidateNormal(this Vector3 normal, string msg) - { - if (!normal._IsFinite()) throw new NotFiniteNumberException($"{msg} is invalid."); - - if (!normal.IsNormalized()) throw new ArithmeticException($"{msg} is not unit length."); - } - - internal static void ValidateTangent(this Vector4 tangent, string msg) - { - if (tangent.W != 1 && tangent.W != -1) throw new ArithmeticException(msg); - - new Vector3(tangent.X, tangent.Y, tangent.Z).ValidateNormal(msg); - } - - internal static Vector3 SanitizeNormal(this Vector3 normal) - { - if (normal == Vector3.Zero) return Vector3.UnitX; - return normal.IsNormalized() ? normal : Vector3.Normalize(normal); - } - - internal static bool IsValidTangent(this Vector4 tangent) - { - if (tangent.W != 1 && tangent.W != -1) return false; - - return new Vector3(tangent.X, tangent.Y, tangent.Z).IsNormalized(); - } - - internal static Vector4 SanitizeTangent(this Vector4 tangent) - { - var n = new Vector3(tangent.X, tangent.Y, tangent.Z).SanitizeNormal(); - var s = float.IsNaN(tangent.W) ? 1 : tangent.W; - return new Vector4(n, s > 0 ? 1 : -1); - } -} diff --git a/Penumbra/Import/Models/ModelManager.cs b/Penumbra/Import/Models/ModelManager.cs index 6818ad64..485a76a7 100644 --- a/Penumbra/Import/Models/ModelManager.cs +++ b/Penumbra/Import/Models/ModelManager.cs @@ -1,7 +1,6 @@ using Dalamud.Plugin.Services; using Lumina.Data.Parsing; -using OtterGui.Extensions; -using OtterGui.Services; +using OtterGui; using OtterGui.Tasks; using Penumbra.Collections.Manager; using Penumbra.GameData; @@ -12,8 +11,6 @@ using Penumbra.GameData.Structs; using Penumbra.Import.Models.Export; using Penumbra.Import.Models.Import; using Penumbra.Import.Textures; -using Penumbra.Meta; -using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; using SharpGLTF.Scenes; using SixLabors.ImageSharp; @@ -24,8 +21,7 @@ namespace Penumbra.Import.Models; using Schema2 = SharpGLTF.Schema2; using LuminaMaterial = Lumina.Models.Materials.Material; -public sealed class ModelManager(IFramework framework, MetaFileManager metaFileManager, ActiveCollections collections, GamePathParser parser) - : SingleTaskQueue, IDisposable, IService +public sealed class ModelManager(IFramework framework, ActiveCollections collections, GamePathParser parser) : SingleTaskQueue, IDisposable { private readonly IFramework _framework = framework; @@ -41,8 +37,7 @@ public sealed class ModelManager(IFramework framework, MetaFileManager metaFileM _tasks.Clear(); } - public Task ExportToGltf(in ExportConfig config, MdlFile mdl, IEnumerable sklbPaths, Func read, - string outputPath) + public Task ExportToGltf(in ExportConfig config, MdlFile mdl, IEnumerable sklbPaths, Func read, string outputPath) => EnqueueWithResult( new ExportToGltfAction(this, config, mdl, sklbPaths, read, outputPath), action => action.Notifier @@ -57,55 +52,57 @@ public sealed class ModelManager(IFramework framework, MetaFileManager metaFileM /// Try to find the .sklb paths for a .mdl file. /// .mdl file to look up the skeletons for. /// Modified extra skeleton template parameters. - public string[] ResolveSklbsForMdl(string mdlPath, KeyValuePair[] estManipulations) + public string[] ResolveSklbsForMdl(string mdlPath, EstManipulation[] estManipulations) { var info = parser.GetFileInfo(mdlPath); if (info.FileType is not FileType.Model) return []; - var baseSkeleton = GamePaths.Sklb.Customization(info.GenderRace, "base", 1); + var baseSkeleton = GamePaths.Skeleton.Sklb.Path(info.GenderRace, "base", 1); return info.ObjectType switch { ObjectType.Equipment when info.EquipSlot.ToSlot() is EquipSlot.Body - => [baseSkeleton, ..ResolveEstSkeleton(EstType.Body, info, estManipulations)], + => [baseSkeleton, ..ResolveEstSkeleton(EstManipulation.EstType.Body, info, estManipulations)], ObjectType.Equipment when info.EquipSlot.ToSlot() is EquipSlot.Head - => [baseSkeleton, ..ResolveEstSkeleton(EstType.Head, info, estManipulations)], + => [baseSkeleton, ..ResolveEstSkeleton(EstManipulation.EstType.Head, info, estManipulations)], ObjectType.Equipment => [baseSkeleton], ObjectType.Accessory => [baseSkeleton], ObjectType.Character when info.BodySlot is BodySlot.Body or BodySlot.Tail => [baseSkeleton], ObjectType.Character when info.BodySlot is BodySlot.Hair - => [baseSkeleton, ..ResolveEstSkeleton(EstType.Hair, info, estManipulations)], + => [baseSkeleton, ..ResolveEstSkeleton(EstManipulation.EstType.Hair, info, estManipulations)], ObjectType.Character when info.BodySlot is BodySlot.Face or BodySlot.Ear - => [baseSkeleton, ..ResolveEstSkeleton(EstType.Face, info, estManipulations)], + => [baseSkeleton, ..ResolveEstSkeleton(EstManipulation.EstType.Face, info, estManipulations)], ObjectType.Character => throw new Exception($"Currently unsupported human model type \"{info.BodySlot}\"."), - ObjectType.DemiHuman => [GamePaths.Sklb.DemiHuman(info.PrimaryId)], - ObjectType.Monster => [GamePaths.Sklb.Monster(info.PrimaryId)], - ObjectType.Weapon => [GamePaths.Sklb.Weapon(info.PrimaryId)], + ObjectType.DemiHuman => [GamePaths.DemiHuman.Sklb.Path(info.PrimaryId)], + ObjectType.Monster => [GamePaths.Monster.Sklb.Path(info.PrimaryId)], + ObjectType.Weapon => [GamePaths.Weapon.Sklb.Path(info.PrimaryId)], _ => [], }; } - private string[] ResolveEstSkeleton(EstType type, GameObjectInfo info, KeyValuePair[] estManipulations) + private string[] ResolveEstSkeleton(EstManipulation.EstType type, GameObjectInfo info, EstManipulation[] estManipulations) { // Try to find an EST entry from the manipulations provided. + var (gender, race) = info.GenderRace.Split(); var modEst = estManipulations - .FirstOrNull( - est => est.Key.GenderRace == info.GenderRace - && est.Key.Slot == type - && est.Key.SetId == info.PrimaryId + .FirstOrNull(est => + est.Gender == gender + && est.Race == race + && est.Slot == type + && est.SetId == info.PrimaryId ); // Try to use an entry from provided manipulations, falling back to the current collection. - var targetId = modEst?.Value + var targetId = modEst?.Entry ?? collections.Current.MetaCache?.GetEstEntry(type, info.GenderRace, info.PrimaryId) - ?? EstFile.GetDefault(metaFileManager, type, info.GenderRace, info.PrimaryId); + ?? 0; // If there's no entries, we can assume that there's no additional skeleton. - if (targetId == EstEntry.Zero) + if (targetId == 0) return []; - return [GamePaths.Sklb.Customization(info.GenderRace, type.ToName(), targetId.AsId)]; + return [GamePaths.Skeleton.Sklb.Path(info.GenderRace, EstManipulation.ToName(type), targetId)]; } /// Try to resolve the absolute path to a .mtrl from the potentially-partial path provided by a model. @@ -137,7 +134,7 @@ public sealed class ModelManager(IFramework framework, MetaFileManager metaFileM var resolvedPath = info.ObjectType switch { - ObjectType.Character => GamePaths.Mtrl.Customization( + ObjectType.Character => GamePaths.Character.Mtrl.Path( info.GenderRace, info.BodySlot, info.PrimaryId, relativePath, out _, out _, info.Variant), _ => absolutePath, }; @@ -253,11 +250,9 @@ public sealed class ModelManager(IFramework framework, MetaFileManager metaFileM var path = manager.ResolveMtrlPath(relativePath, notifier); if (path == null) return null; - var bytes = read(path); if (bytes == null) return null; - var mtrl = new MtrlFile(bytes); return new MaterialExporter.Material diff --git a/Penumbra/Import/Models/SkeletonConverter.cs b/Penumbra/Import/Models/SkeletonConverter.cs index e180662d..25e74332 100644 --- a/Penumbra/Import/Models/SkeletonConverter.cs +++ b/Penumbra/Import/Models/SkeletonConverter.cs @@ -1,5 +1,5 @@ using System.Xml; -using OtterGui.Extensions; +using OtterGui; using Penumbra.Import.Models.Export; namespace Penumbra.Import.Models; diff --git a/Penumbra/Import/Structs/TexToolsStructs.cs b/Penumbra/Import/Structs/TexToolsStructs.cs index f5b5ef4a..bf3bccd8 100644 --- a/Penumbra/Import/Structs/TexToolsStructs.cs +++ b/Penumbra/Import/Structs/TexToolsStructs.cs @@ -26,7 +26,7 @@ public class SimpleMod public class ModPackPage { public int PageIndex = 0; - public ModGroup[] ModGroups = []; + public ModGroup[] ModGroups = Array.Empty(); } [Serializable] @@ -34,7 +34,7 @@ public class ModGroup { public string GroupName = string.Empty; public GroupType SelectionType = GroupType.Single; - public OptionList[] OptionList = []; + public OptionList[] OptionList = Array.Empty(); public string Description = string.Empty; } @@ -44,7 +44,7 @@ public class OptionList public string Name = string.Empty; public string Description = string.Empty; public string ImagePath = string.Empty; - public SimpleMod[] ModsJsons = []; + public SimpleMod[] ModsJsons = Array.Empty(); public string GroupName = string.Empty; public GroupType SelectionType = GroupType.Single; public bool IsChecked = false; @@ -59,8 +59,8 @@ public class ExtendedModPack public string Version = string.Empty; public string Description = DefaultTexToolsData.Description; public string Url = string.Empty; - public ModPackPage[] ModPackPages = []; - public SimpleMod[] SimpleModsList = []; + public ModPackPage[] ModPackPages = Array.Empty(); + public SimpleMod[] SimpleModsList = Array.Empty(); } [Serializable] @@ -72,5 +72,5 @@ public class SimpleModPack public string Version = string.Empty; public string Description = DefaultTexToolsData.Description; public string Url = string.Empty; - public SimpleMod[] SimpleModsList = []; + public SimpleMod[] SimpleModsList = Array.Empty(); } diff --git a/Penumbra/Import/TexToolsImport.cs b/Penumbra/Import/TexToolsImport.cs index 8e4fea41..bb006d8d 100644 --- a/Penumbra/Import/TexToolsImport.cs +++ b/Penumbra/Import/TexToolsImport.cs @@ -3,7 +3,6 @@ using OtterGui.Compression; using Penumbra.Import.Structs; using Penumbra.Mods.Editor; using Penumbra.Mods.Manager; -using Penumbra.Services; using FileMode = System.IO.FileMode; using ZipArchive = SharpCompress.Archives.Zip.ZipArchive; using ZipArchiveEntry = SharpCompress.Archives.Zip.ZipArchiveEntry; @@ -28,26 +27,24 @@ public partial class TexToolsImporter : IDisposable public ImporterState State { get; private set; } public readonly List<(FileInfo File, DirectoryInfo? Mod, Exception? Error)> ExtractedMods; - private readonly Configuration _config; - private readonly ModEditor _editor; - private readonly ModManager _modManager; - private readonly FileCompactor _compactor; - private readonly MigrationManager _migrationManager; + private readonly Configuration _config; + private readonly ModEditor _editor; + private readonly ModManager _modManager; + private readonly FileCompactor _compactor; public TexToolsImporter(int count, IEnumerable modPackFiles, Action handler, - Configuration config, ModEditor editor, ModManager modManager, FileCompactor compactor, MigrationManager migrationManager) + Configuration config, ModEditor editor, ModManager modManager, FileCompactor compactor) { - _baseDirectory = modManager.BasePath; - _tmpFile = Path.Combine(_baseDirectory.FullName, TempFileName); - _modPackFiles = modPackFiles; - _config = config; - _editor = editor; - _modManager = modManager; - _compactor = compactor; - _migrationManager = migrationManager; - _modPackCount = count; - ExtractedMods = new List<(FileInfo, DirectoryInfo?, Exception?)>(count); - _token = _cancellation.Token; + _baseDirectory = modManager.BasePath; + _tmpFile = Path.Combine(_baseDirectory.FullName, TempFileName); + _modPackFiles = modPackFiles; + _config = config; + _editor = editor; + _modManager = modManager; + _compactor = compactor; + _modPackCount = count; + ExtractedMods = new List<(FileInfo, DirectoryInfo?, Exception?)>(count); + _token = _cancellation.Token; Task.Run(ImportFiles, _token) .ContinueWith(_ => CloseStreams(), TaskScheduler.Default) .ContinueWith(_ => @@ -119,7 +116,7 @@ public partial class TexToolsImporter : IDisposable // Puts out warnings if extension does not correspond to data. private DirectoryInfo VerifyVersionAndImport(FileInfo modPackFile) { - if (modPackFile.Extension.ToLowerInvariant() is ".pmp" or ".pcp" or ".zip" or ".7z" or ".rar") + if (modPackFile.Extension.ToLowerInvariant() is ".pmp" or ".zip" or ".7z" or ".rar") return HandleRegularArchive(modPackFile); using var zfs = modPackFile.OpenRead(); @@ -148,7 +145,7 @@ public partial class TexToolsImporter : IDisposable // You can in no way rely on any file paths in TTMPs so we need to just do this, sorry private static ZipArchiveEntry? FindZipEntry(ZipArchive file, string fileName) - => file.Entries.FirstOrDefault(e => e is { IsDirectory: false, Key: not null } && e.Key.Contains(fileName)); + => file.Entries.FirstOrDefault(e => !e.IsDirectory && e.Key.Contains(fileName)); private static string GetStringFromZipEntry(ZipArchiveEntry entry, Encoding encoding) { diff --git a/Penumbra/Import/TexToolsImporter.Archives.cs b/Penumbra/Import/TexToolsImporter.Archives.cs index a80730bf..57313ab1 100644 --- a/Penumbra/Import/TexToolsImporter.Archives.cs +++ b/Penumbra/Import/TexToolsImporter.Archives.cs @@ -4,7 +4,6 @@ using Newtonsoft.Json.Linq; using OtterGui.Filesystem; using Penumbra.Import.Structs; using Penumbra.Mods; -using Penumbra.Services; using SharpCompress.Archives; using SharpCompress.Archives.Rar; using SharpCompress.Archives.SevenZip; @@ -16,12 +15,6 @@ namespace Penumbra.Import; public partial class TexToolsImporter { - private static readonly ExtractionOptions _extractionOptions = new() - { - ExtractFullPath = true, - Overwrite = true, - }; - /// /// Extract regular compressed archives that are folders containing penumbra-formatted mods. /// The mod has to either contain a meta.json at top level, or one folder deep. @@ -52,7 +45,11 @@ public partial class TexToolsImporter Penumbra.Log.Information($" -> Importing {archive.Type} Archive."); _currentModDirectory = ModCreator.CreateModFolder(_baseDirectory, Path.GetRandomFileName(), _config.ReplaceNonAsciiOnImport, true); - + var options = new ExtractionOptions() + { + ExtractFullPath = true, + Overwrite = true, + }; State = ImporterState.ExtractingModFiles; _currentFileIdx = 0; @@ -83,13 +80,13 @@ public partial class TexToolsImporter if (name.Length == 0) throw new Exception("Invalid mod archive: mod meta has no name."); - using var f = File.OpenWrite(Path.Combine(_currentModDirectory.FullName, reader.Entry.Key!)); + using var f = File.OpenWrite(Path.Combine(_currentModDirectory.FullName, reader.Entry.Key)); s.Seek(0, SeekOrigin.Begin); s.WriteTo(f); } else { - HandleFileMigrationsAndWrite(reader); + reader.WriteEntryToDirectory(_currentModDirectory.FullName, options); } ++_currentFileIdx; @@ -97,65 +94,26 @@ public partial class TexToolsImporter _token.ThrowIfCancellationRequested(); var oldName = _currentModDirectory.FullName; - - // Try renaming the folder three times because sometimes we get AccessDenied here for some unknown reason. - const int numTries = 3; - for (var i = 1;; ++i) + // Use either the top-level directory as the mods base name, or the (fixed for path) name in the json. + if (leadDir) { - // Use either the top-level directory as the mods base name, or the (fixed for path) name in the json. - try - { - if (leadDir) - { - _currentModDirectory = ModCreator.CreateModFolder(_baseDirectory, baseName, _config.ReplaceNonAsciiOnImport, false); - Directory.Move(Path.Combine(oldName, baseName), _currentModDirectory.FullName); - Directory.Delete(oldName); - } - else - { - _currentModDirectory = ModCreator.CreateModFolder(_baseDirectory, name, _config.ReplaceNonAsciiOnImport, false); - Directory.Move(oldName, _currentModDirectory.FullName); - } - } - catch (IOException io) - { - if (i == numTries) - throw; - - Penumbra.Log.Warning($"Error when renaming the extracted mod, try {i}/{numTries}: {io.Message}."); - continue; - } - - break; + _currentModDirectory = ModCreator.CreateModFolder(_baseDirectory, baseName, _config.ReplaceNonAsciiOnImport, false); + Directory.Move(Path.Combine(oldName, baseName), _currentModDirectory.FullName); + Directory.Delete(oldName); + } + else + { + _currentModDirectory = ModCreator.CreateModFolder(_baseDirectory, name, _config.ReplaceNonAsciiOnImport, false); + Directory.Move(oldName, _currentModDirectory.FullName); } _currentModDirectory.Refresh(); _modManager.Creator.SplitMultiGroups(_currentModDirectory); - _editor.ModNormalizer.NormalizeUi(_currentModDirectory); return _currentModDirectory; } - private void HandleFileMigrationsAndWrite(IReader reader) - { - switch (Path.GetExtension(reader.Entry.Key)) - { - case ".mdl": - _migrationManager.MigrateMdlDuringExtraction(reader, _currentModDirectory!.FullName, _extractionOptions); - break; - case ".mtrl": - _migrationManager.MigrateMtrlDuringExtraction(reader, _currentModDirectory!.FullName, _extractionOptions); - break; - case ".tex": - _migrationManager.FixMipMaps(reader, _currentModDirectory!.FullName, _extractionOptions); - break; - default: - reader.WriteEntryToDirectory(_currentModDirectory!.FullName, _extractionOptions); - break; - } - } - // Search the archive for the meta.json file which needs to exist. private static string FindArchiveModMeta(IArchive archive, out bool leadDir) { @@ -178,9 +136,13 @@ public partial class TexToolsImporter ret = directory; // Check that all other files are also contained in the top-level directory. - if (ret.IndexOfAny(['/', '\\']) >= 0 - || !archive.Entries.All(e - => e.Key != null && e.Key.StartsWith(ret) && (e.Key.Length == ret.Length || e.Key[ret.Length] is '/' or '\\'))) + if (ret.IndexOfAny(new[] + { + '/', + '\\', + }) + >= 0 + || !archive.Entries.All(e => e.Key.StartsWith(ret) && (e.Key.Length == ret.Length || e.Key[ret.Length] is '/' or '\\'))) throw new Exception( "Invalid mod archive: meta.json in wrong location. It needs to be either at root or one directory deep, in which all other files must be nested too."); } diff --git a/Penumbra/Import/TexToolsImporter.Gui.cs b/Penumbra/Import/TexToolsImporter.Gui.cs index 5cb99d72..78665f30 100644 --- a/Penumbra/Import/TexToolsImporter.Gui.cs +++ b/Penumbra/Import/TexToolsImporter.Gui.cs @@ -1,4 +1,4 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using Penumbra.Import.Structs; @@ -20,55 +20,47 @@ public partial class TexToolsImporter private string _currentOptionName = string.Empty; private string _currentFileName = string.Empty; - public bool DrawProgressInfo(Vector2 size) + public void DrawProgressInfo(Vector2 size) { if (_modPackCount == 0) { ImGuiUtil.Center("Nothing to extract."); - return true; } - - if (_modPackCount == _currentModPackIdx) + else if (_modPackCount == _currentModPackIdx) { DrawEndState(); - return true; } - - ImGui.NewLine(); - var percentage = (float)_currentModPackIdx / _modPackCount; - ImGui.ProgressBar(percentage, size, $"Mod {_currentModPackIdx + 1} / {_modPackCount}"); - ImGui.NewLine(); - ImGui.TextUnformatted(State == ImporterState.DeduplicatingFiles - ? $"Deduplicating {_currentModName}..." - : $"Extracting {_currentModName}..."); - - if (_currentNumOptions > 1) + else { ImGui.NewLine(); + var percentage = (float)_currentModPackIdx / _modPackCount; + ImGui.ProgressBar(percentage, size, $"Mod {_currentModPackIdx + 1} / {_modPackCount}"); ImGui.NewLine(); - if (_currentOptionIdx >= _currentNumOptions) - ImGui.ProgressBar(1f, size, $"Extracted {_currentNumOptions} Options"); + if (State == ImporterState.DeduplicatingFiles) + ImGui.TextUnformatted($"Deduplicating {_currentModName}..."); else - ImGui.ProgressBar(_currentOptionIdx / (float)_currentNumOptions, size, - $"Extracting Option {_currentOptionIdx + 1} / {_currentNumOptions}..."); + ImGui.TextUnformatted($"Extracting {_currentModName}..."); + if (_currentNumOptions > 1) + { + ImGui.NewLine(); + ImGui.NewLine(); + percentage = _currentNumOptions == 0 ? 1f : _currentOptionIdx / (float)_currentNumOptions; + ImGui.ProgressBar(percentage, size, $"Option {_currentOptionIdx + 1} / {_currentNumOptions}"); + ImGui.NewLine(); + if (State != ImporterState.DeduplicatingFiles) + ImGui.TextUnformatted( + $"Extracting option {(_currentGroupName.Length == 0 ? string.Empty : $"{_currentGroupName} - ")}{_currentOptionName}..."); + } + + ImGui.NewLine(); + ImGui.NewLine(); + percentage = _currentNumFiles == 0 ? 1f : _currentFileIdx / (float)_currentNumFiles; + ImGui.ProgressBar(percentage, size, $"File {_currentFileIdx + 1} / {_currentNumFiles}"); ImGui.NewLine(); if (State != ImporterState.DeduplicatingFiles) - ImGui.TextUnformatted( - $"Extracting Option {(_currentGroupName.Length == 0 ? string.Empty : $"{_currentGroupName} - ")}{_currentOptionName}..."); + ImGui.TextUnformatted($"Extracting file {_currentFileName}..."); } - - ImGui.NewLine(); - ImGui.NewLine(); - if (_currentFileIdx >= _currentNumFiles) - ImGui.ProgressBar(1f, size, $"Extracted {_currentNumFiles} Files"); - else - ImGui.ProgressBar(_currentFileIdx / (float)_currentNumFiles, size, $"Extracting File {_currentFileIdx + 1} / {_currentNumFiles}..."); - - ImGui.NewLine(); - if (State != ImporterState.DeduplicatingFiles) - ImGui.TextUnformatted($"Extracting File {_currentFileName}..."); - return false; } diff --git a/Penumbra/Import/TexToolsImporter.ModPack.cs b/Penumbra/Import/TexToolsImporter.ModPack.cs index fd9e50c0..2b45ecbe 100644 --- a/Penumbra/Import/TexToolsImporter.ModPack.cs +++ b/Penumbra/Import/TexToolsImporter.ModPack.cs @@ -1,5 +1,5 @@ using Newtonsoft.Json; -using OtterGui.Extensions; +using OtterGui; using Penumbra.Api.Enums; using Penumbra.Import.Structs; using Penumbra.Mods; @@ -151,7 +151,6 @@ public partial class TexToolsImporter _currentGroupName = string.Empty; _currentOptionName = "Default"; ExtractSimpleModList(_currentModDirectory, modList.SimpleModsList); - ++_currentOptionIdx; } // Iterate through all pages @@ -209,7 +208,6 @@ public partial class TexToolsImporter options.Insert(idx, MultiSubMod.WithoutGroup(option.Name, option.Description, ModPriority.Default)); if (option.IsChecked) defaultSettings = Setting.Single(idx); - ++_currentOptionIdx; } } @@ -255,14 +253,25 @@ public partial class TexToolsImporter extractedFile.Directory?.Create(); - data.Data = Path.GetExtension(extractedFile.FullName) switch - { - ".mdl" => _migrationManager.MigrateTtmpModel(extractedFile.FullName, data.Data), - ".mtrl" => _migrationManager.MigrateTtmpMaterial(extractedFile.FullName, data.Data), - ".tex" => _migrationManager.FixTtmpMipMaps(extractedFile.FullName, data.Data), - _ => data.Data, - }; + if (extractedFile.FullName.EndsWith(".mdl")) + ProcessMdl(data.Data); _compactor.WriteAllBytesAsync(extractedFile.FullName, data.Data, _token).Wait(_token); } + + private static void ProcessMdl(byte[] mdl) + { + const int modelHeaderLodOffset = 22; + + // Model file header LOD num + mdl[64] = 1; + + // Model header LOD num + var stackSize = BitConverter.ToUInt32(mdl, 4); + var runtimeBegin = stackSize + 0x44; + var stringsLengthOffset = runtimeBegin + 4; + var stringsLength = BitConverter.ToUInt32(mdl, (int)stringsLengthOffset); + var modelHeaderStart = stringsLengthOffset + stringsLength + 4; + mdl[modelHeaderStart + modelHeaderLodOffset] = 1; + } } diff --git a/Penumbra/Import/TexToolsMeta.Deserialization.cs b/Penumbra/Import/TexToolsMeta.Deserialization.cs index 7861a95b..f062ae25 100644 --- a/Penumbra/Import/TexToolsMeta.Deserialization.cs +++ b/Penumbra/Import/TexToolsMeta.Deserialization.cs @@ -2,6 +2,7 @@ using Lumina.Extensions; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Import.Structs; +using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Import; @@ -12,13 +13,15 @@ public partial class TexToolsMeta private void DeserializeEqpEntry(MetaFileInfo metaFileInfo, byte[]? data) { // Eqp can only be valid for equipment. - var mask = Eqp.Mask(metaFileInfo.EquipSlot); - if (data == null || mask == 0) + if (data == null || !metaFileInfo.EquipSlot.IsEquipment()) return; - var identifier = new EqpIdentifier(metaFileInfo.PrimaryId, metaFileInfo.EquipSlot); - var value = Eqp.FromSlotAndBytes(metaFileInfo.EquipSlot, data) & mask; - MetaManipulations.TryAdd(identifier, value); + var value = Eqp.FromSlotAndBytes(metaFileInfo.EquipSlot, data); + var def = new EqpManipulation(ExpandedEqpFile.GetDefault(_metaFileManager, metaFileInfo.PrimaryId), metaFileInfo.EquipSlot, + metaFileInfo.PrimaryId); + var manip = new EqpManipulation(value, metaFileInfo.EquipSlot, metaFileInfo.PrimaryId); + if (_keepDefault || def.Entry != manip.Entry) + MetaManipulations.Add(manip); } // Deserialize and check Eqdp Entries and add them to the list if they are non-default. @@ -37,10 +40,14 @@ public partial class TexToolsMeta if (!gr.IsValid() || !metaFileInfo.EquipSlot.IsEquipment() && !metaFileInfo.EquipSlot.IsAccessory()) continue; - var identifier = new EqdpIdentifier(metaFileInfo.PrimaryId, metaFileInfo.EquipSlot, gr); - var mask = Eqdp.Mask(metaFileInfo.EquipSlot); - var value = Eqdp.FromSlotAndBits(metaFileInfo.EquipSlot, (byteValue & 1) == 1, (byteValue & 2) == 2) & mask; - MetaManipulations.TryAdd(identifier, value); + var value = Eqdp.FromSlotAndBits(metaFileInfo.EquipSlot, (byteValue & 1) == 1, (byteValue & 2) == 2); + var def = new EqdpManipulation( + ExpandedEqdpFile.GetDefault(_metaFileManager, gr, metaFileInfo.EquipSlot.IsAccessory(), metaFileInfo.PrimaryId), + metaFileInfo.EquipSlot, + gr.Split().Item1, gr.Split().Item2, metaFileInfo.PrimaryId); + var manip = new EqdpManipulation(value, metaFileInfo.EquipSlot, gr.Split().Item1, gr.Split().Item2, metaFileInfo.PrimaryId); + if (_keepDefault || def.Entry != manip.Entry) + MetaManipulations.Add(manip); } } @@ -50,9 +57,10 @@ public partial class TexToolsMeta if (data == null) return; - var value = GmpEntry.FromTexToolsMeta(data.AsSpan(0, 5)); - var identifier = new GmpIdentifier(metaFileInfo.PrimaryId); - MetaManipulations.TryAdd(identifier, value); + var value = GmpEntry.FromTexToolsMeta(data.AsSpan(0, 5)); + var def = ExpandedGmpFile.GetDefault(_metaFileManager, metaFileInfo.PrimaryId); + if (_keepDefault || value != def) + MetaManipulations.Add(new GmpManipulation(value, metaFileInfo.PrimaryId)); } // Deserialize and check Est Entries and add them to the list if they are non-default. @@ -66,21 +74,22 @@ public partial class TexToolsMeta for (var i = 0; i < num; ++i) { var gr = (GenderRace)reader.ReadUInt16(); - var id = (PrimaryId)reader.ReadUInt16(); - var value = new EstEntry(reader.ReadUInt16()); + var id = reader.ReadUInt16(); + var value = reader.ReadUInt16(); var type = (metaFileInfo.SecondaryType, metaFileInfo.EquipSlot) switch { - (BodySlot.Face, _) => EstType.Face, - (BodySlot.Hair, _) => EstType.Hair, - (_, EquipSlot.Head) => EstType.Head, - (_, EquipSlot.Body) => EstType.Body, - _ => (EstType)0, + (BodySlot.Face, _) => EstManipulation.EstType.Face, + (BodySlot.Hair, _) => EstManipulation.EstType.Hair, + (_, EquipSlot.Head) => EstManipulation.EstType.Head, + (_, EquipSlot.Body) => EstManipulation.EstType.Body, + _ => (EstManipulation.EstType)0, }; if (!gr.IsValid() || type == 0) continue; - var identifier = new EstIdentifier(id, type, gr); - MetaManipulations.TryAdd(identifier, value); + var def = EstFile.GetDefault(_metaFileManager, type, gr, id); + if (_keepDefault || def != value) + MetaManipulations.Add(new EstManipulation(gr.Split().Item1, gr.Split().Item2, type, id, value)); } } @@ -98,12 +107,21 @@ public partial class TexToolsMeta ushort i = 0; try { - var identifier = new ImcIdentifier(metaFileInfo.PrimaryId, 0, metaFileInfo.PrimaryType, metaFileInfo.SecondaryId, - metaFileInfo.EquipSlot, metaFileInfo.SecondaryType); + var manip = new ImcManipulation(metaFileInfo.PrimaryType, metaFileInfo.SecondaryType, metaFileInfo.PrimaryId, + metaFileInfo.SecondaryId, i, metaFileInfo.EquipSlot, + new ImcEntry()); + var def = new ImcFile(_metaFileManager, manip); + var partIdx = ImcFile.PartIndex(manip.EquipSlot); // Gets turned to unknown for things without equip, and unknown turns to 0. foreach (var value in values) { - identifier = identifier with { Variant = (Variant)i }; - MetaManipulations.TryAdd(identifier, value); + if (_keepDefault || !value.Equals(def.GetEntry(partIdx, (Variant)i))) + { + var imc = new ImcManipulation(manip.ObjectType, manip.BodySlot, manip.PrimaryId, manip.SecondaryId, i, manip.EquipSlot, + value); + if (imc.Validate(true)) + MetaManipulations.Add(imc); + } + ++i; } } diff --git a/Penumbra/Import/TexToolsMeta.Export.cs b/Penumbra/Import/TexToolsMeta.Export.cs index 9cce60e3..03bdbd90 100644 --- a/Penumbra/Import/TexToolsMeta.Export.cs +++ b/Penumbra/Import/TexToolsMeta.Export.cs @@ -1,4 +1,3 @@ -using Penumbra.Collections.Cache; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Meta; @@ -9,7 +8,7 @@ namespace Penumbra.Import; public partial class TexToolsMeta { - public static void WriteTexToolsMeta(MetaFileManager manager, MetaDictionary manipulations, DirectoryInfo basePath) + public static void WriteTexToolsMeta(MetaFileManager manager, IEnumerable manipulations, DirectoryInfo basePath) { var files = ConvertToTexTools(manager, manipulations); @@ -28,81 +27,49 @@ public partial class TexToolsMeta } } - public static Dictionary ConvertToTexTools(MetaFileManager manager, MetaDictionary manips) + public static Dictionary ConvertToTexTools(MetaFileManager manager, IEnumerable manips) { var ret = new Dictionary(); - foreach (var group in manips.Rsp.GroupBy(ManipToPath)) + foreach (var group in manips.GroupBy(ManipToPath)) { if (group.Key.Length == 0) continue; - var bytes = WriteRgspFile(manager, group); + var bytes = group.Key.EndsWith(".rgsp") + ? WriteRgspFile(manager, group.Key, group) + : WriteMetaFile(manager, group.Key, group); if (bytes.Length == 0) continue; ret.Add(group.Key, bytes); } - foreach (var (file, dict) in SplitByFile(manips)) - { - var bytes = WriteMetaFile(manager, file, dict); - if (bytes.Length == 0) - continue; - - ret.Add(file, bytes); - } - return ret; } - private static Dictionary SplitByFile(MetaDictionary manips) + private static byte[] WriteRgspFile(MetaFileManager manager, string path, IEnumerable manips) { - var ret = new Dictionary(); - foreach (var (identifier, key) in manips.Imc) - GetDict(ManipToPath(identifier)).TryAdd(identifier, key); - - foreach (var (identifier, key) in manips.Eqp) - GetDict(ManipToPath(identifier)).TryAdd(identifier, key); - - foreach (var (identifier, key) in manips.Eqdp) - GetDict(ManipToPath(identifier)).TryAdd(identifier, key); - - foreach (var (identifier, key) in manips.Est) - GetDict(ManipToPath(identifier)).TryAdd(identifier, key); - - foreach (var (identifier, key) in manips.Gmp) - GetDict(ManipToPath(identifier)).TryAdd(identifier, key); - - ret.Remove(string.Empty); - - return ret; - - MetaDictionary GetDict(string path) - { - if (!ret.TryGetValue(path, out var dict)) - { - dict = new MetaDictionary(); - ret.Add(path, dict); - } - - return dict; - } - } - - private static byte[] WriteRgspFile(MetaFileManager manager, IEnumerable> manips) - { - var list = manips.GroupBy(m => m.Key.Attribute).ToDictionary(g => g.Key, g => g.Last()); + var list = manips.GroupBy(m => m.Rsp.Attribute).ToDictionary(m => m.Key, m => m.Last().Rsp); using var m = new MemoryStream(45); using var b = new BinaryWriter(m); // Version b.Write(byte.MaxValue); b.Write((ushort)2); - var race = list.First().Value.Key.SubRace; - var gender = list.First().Value.Key.Attribute.ToGender(); + var race = list.First().Value.SubRace; + var gender = list.First().Value.Attribute.ToGender(); b.Write((byte)(race - 1)); // offset by one due to Unknown b.Write((byte)(gender - 1)); // offset by one due to Unknown + void Add(params RspAttribute[] attributes) + { + foreach (var attribute in attributes) + { + var value = list.TryGetValue(attribute, out var tmp) ? tmp.Entry : CmpFile.GetDefault(manager, race, attribute); + b.Write(value); + } + } + if (gender == Gender.Male) { Add(RspAttribute.MaleMinSize, RspAttribute.MaleMaxSize, RspAttribute.MaleMinTail, RspAttribute.MaleMaxTail); @@ -115,24 +82,12 @@ public partial class TexToolsMeta } return m.GetBuffer(); - - void Add(params RspAttribute[] attributes) - { - foreach (var attribute in attributes) - { - var value = list.TryGetValue(attribute, out var tmp) ? tmp.Value : CmpFile.GetDefault(manager, race, attribute); - b.Write(value.Value); - } - } } - private static byte[] WriteMetaFile(MetaFileManager manager, string path, MetaDictionary manips) + private static byte[] WriteMetaFile(MetaFileManager manager, string path, IEnumerable manips) { - var headerCount = (manips.Imc.Count > 0 ? 1 : 0) - + (manips.Eqp.Count > 0 ? 1 : 0) - + (manips.Eqdp.Count > 0 ? 1 : 0) - + (manips.Est.Count > 0 ? 1 : 0) - + (manips.Gmp.Count > 0 ? 1 : 0); + var filteredManips = manips.GroupBy(m => m.ManipulationType).ToDictionary(p => p.Key, p => p.Select(x => x)); + using var m = new MemoryStream(); using var b = new BinaryWriter(m); @@ -146,7 +101,7 @@ public partial class TexToolsMeta b.Write((byte)0); // Number of Headers - b.Write((uint)headerCount); + b.Write((uint)filteredManips.Count); // Current TT Size of Headers b.Write((uint)12); @@ -154,44 +109,88 @@ public partial class TexToolsMeta var headerStart = b.BaseStream.Position + 4; b.Write((uint)headerStart); - var offset = (uint)(b.BaseStream.Position + 12 * manips.Count); - offset += WriteData(manager, b, offset, manips.Imc); - offset += WriteData(b, offset, manips.Eqdp); - offset += WriteData(b, offset, manips.Eqp); - offset += WriteData(b, offset, manips.Est); - offset += WriteData(b, offset, manips.Gmp); + var offset = (uint)(b.BaseStream.Position + 12 * filteredManips.Count); + foreach (var (header, data) in filteredManips) + { + b.Write((uint)header); + b.Write(offset); + + var size = WriteData(manager, b, offset, header, data); + b.Write(size); + offset += size; + } return m.ToArray(); } - private static uint WriteData(MetaFileManager manager, BinaryWriter b, uint offset, IReadOnlyDictionary manips) + private static uint WriteData(MetaFileManager manager, BinaryWriter b, uint offset, MetaManipulation.Type type, + IEnumerable manips) { - if (manips.Count == 0) - return 0; - - b.Write((uint)MetaManipulationType.Imc); - b.Write(offset); - var oldPos = b.BaseStream.Position; b.Seek((int)offset, SeekOrigin.Begin); - var refIdentifier = manips.First().Key; - var baseFile = new ImcFile(manager, refIdentifier); - foreach (var (identifier, entry) in manips) - ImcCache.Apply(baseFile, identifier, entry); - - var partIdx = refIdentifier.ObjectType is ObjectType.Equipment or ObjectType.Accessory - ? ImcFile.PartIndex(refIdentifier.EquipSlot) - : 0; - - for (var i = 0; i <= baseFile.Count; ++i) + switch (type) { - var entry = baseFile.GetEntry(partIdx, (Variant)i); - b.Write(entry.MaterialId); - b.Write(entry.DecalId); - b.Write(entry.AttributeAndSound); - b.Write(entry.VfxId); - b.Write(entry.MaterialAnimationId); + case MetaManipulation.Type.Imc: + var allManips = manips.ToList(); + var baseFile = new ImcFile(manager, allManips[0].Imc); + foreach (var manip in allManips) + manip.Imc.Apply(baseFile); + + var partIdx = allManips[0].Imc.ObjectType is ObjectType.Equipment or ObjectType.Accessory + ? ImcFile.PartIndex(allManips[0].Imc.EquipSlot) + : 0; + + for (var i = 0; i <= baseFile.Count; ++i) + { + var entry = baseFile.GetEntry(partIdx, (Variant)i); + b.Write(entry.MaterialId); + b.Write(entry.DecalId); + b.Write(entry.AttributeAndSound); + b.Write(entry.VfxId); + b.Write(entry.MaterialAnimationId); + } + + break; + case MetaManipulation.Type.Eqdp: + foreach (var manip in manips) + { + b.Write((uint)Names.CombinedRace(manip.Eqdp.Gender, manip.Eqdp.Race)); + var entry = (byte)(((uint)manip.Eqdp.Entry >> Eqdp.Offset(manip.Eqdp.Slot)) & 0x03); + b.Write(entry); + } + + break; + case MetaManipulation.Type.Eqp: + foreach (var manip in manips) + { + var bytes = BitConverter.GetBytes((ulong)manip.Eqp.Entry); + var (numBytes, byteOffset) = Eqp.BytesAndOffset(manip.Eqp.Slot); + for (var i = byteOffset; i < numBytes + byteOffset; ++i) + b.Write(bytes[i]); + } + + break; + case MetaManipulation.Type.Est: + foreach (var manip in manips) + { + b.Write((ushort)Names.CombinedRace(manip.Est.Gender, manip.Est.Race)); + b.Write(manip.Est.SetId.Id); + b.Write(manip.Est.Entry); + } + + break; + case MetaManipulation.Type.Gmp: + foreach (var manip in manips) + { + b.Write((uint)manip.Gmp.Entry.Value); + b.Write(manip.Gmp.Entry.UnknownTotal); + } + + break; + case MetaManipulation.Type.GlobalEqp: + // Not Supported + break; } var size = b.BaseStream.Position - offset; @@ -199,98 +198,19 @@ public partial class TexToolsMeta return (uint)size; } - private static uint WriteData(BinaryWriter b, uint offset, IReadOnlyDictionary manips) - { - if (manips.Count == 0) - return 0; - - b.Write((uint)MetaManipulationType.Eqdp); - b.Write(offset); - - var oldPos = b.BaseStream.Position; - b.Seek((int)offset, SeekOrigin.Begin); - - foreach (var (identifier, entry) in manips) + private static string ManipToPath(MetaManipulation manip) + => manip.ManipulationType switch { - b.Write((uint)identifier.GenderRace); - b.Write(entry.AsByte); - } + MetaManipulation.Type.Imc => ManipToPath(manip.Imc), + MetaManipulation.Type.Eqdp => ManipToPath(manip.Eqdp), + MetaManipulation.Type.Eqp => ManipToPath(manip.Eqp), + MetaManipulation.Type.Est => ManipToPath(manip.Est), + MetaManipulation.Type.Gmp => ManipToPath(manip.Gmp), + MetaManipulation.Type.Rsp => ManipToPath(manip.Rsp), + _ => string.Empty, + }; - var size = b.BaseStream.Position - offset; - b.Seek((int)oldPos, SeekOrigin.Begin); - return (uint)size; - } - - private static uint WriteData(BinaryWriter b, uint offset, - IReadOnlyDictionary manips) - { - if (manips.Count == 0) - return 0; - - b.Write((uint)MetaManipulationType.Imc); - b.Write(offset); - - var oldPos = b.BaseStream.Position; - b.Seek((int)offset, SeekOrigin.Begin); - - foreach (var (identifier, entry) in manips) - { - var numBytes = Eqp.BytesAndOffset(identifier.Slot).Item1; - for (var i = 0; i < numBytes; ++i) - b.Write((byte)(entry.Value >> (8 * i))); - } - - var size = b.BaseStream.Position - offset; - b.Seek((int)oldPos, SeekOrigin.Begin); - return (uint)size; - } - - private static uint WriteData(BinaryWriter b, uint offset, IReadOnlyDictionary manips) - { - if (manips.Count == 0) - return 0; - - b.Write((uint)MetaManipulationType.Imc); - b.Write(offset); - - var oldPos = b.BaseStream.Position; - b.Seek((int)offset, SeekOrigin.Begin); - - foreach (var (identifier, entry) in manips) - { - b.Write((ushort)identifier.GenderRace); - b.Write(identifier.SetId.Id); - b.Write(entry.Value); - } - - var size = b.BaseStream.Position - offset; - b.Seek((int)oldPos, SeekOrigin.Begin); - return (uint)size; - } - - private static uint WriteData(BinaryWriter b, uint offset, IReadOnlyDictionary manips) - { - if (manips.Count == 0) - return 0; - - b.Write((uint)MetaManipulationType.Imc); - b.Write(offset); - - var oldPos = b.BaseStream.Position; - b.Seek((int)offset, SeekOrigin.Begin); - - foreach (var entry in manips.Values) - { - b.Write((uint)entry.Value); - b.Write(entry.UnknownTotal); - } - - var size = b.BaseStream.Position - offset; - b.Seek((int)oldPos, SeekOrigin.Begin); - return (uint)size; - } - - private static string ManipToPath(ImcIdentifier manip) + private static string ManipToPath(ImcManipulation manip) { var path = manip.GamePath().ToString(); var replacement = manip.ObjectType switch @@ -304,33 +224,33 @@ public partial class TexToolsMeta return path.Replace(".imc", replacement); } - private static string ManipToPath(EqdpIdentifier manip) + private static string ManipToPath(EqdpManipulation manip) => manip.Slot.IsAccessory() - ? $"chara/accessory/a{manip.SetId.Id:D4}/a{manip.SetId.Id:D4}_{manip.Slot.ToSuffix()}.meta" - : $"chara/equipment/e{manip.SetId.Id:D4}/e{manip.SetId.Id:D4}_{manip.Slot.ToSuffix()}.meta"; + ? $"chara/accessory/a{manip.SetId:D4}/a{manip.SetId:D4}_{manip.Slot.ToSuffix()}.meta" + : $"chara/equipment/e{manip.SetId:D4}/e{manip.SetId:D4}_{manip.Slot.ToSuffix()}.meta"; - private static string ManipToPath(EqpIdentifier manip) + private static string ManipToPath(EqpManipulation manip) => manip.Slot.IsAccessory() - ? $"chara/accessory/a{manip.SetId.Id:D4}/a{manip.SetId.Id:D4}_{manip.Slot.ToSuffix()}.meta" - : $"chara/equipment/e{manip.SetId.Id:D4}/e{manip.SetId.Id:D4}_{manip.Slot.ToSuffix()}.meta"; + ? $"chara/accessory/a{manip.SetId:D4}/a{manip.SetId:D4}_{manip.Slot.ToSuffix()}.meta" + : $"chara/equipment/e{manip.SetId:D4}/e{manip.SetId:D4}_{manip.Slot.ToSuffix()}.meta"; - private static string ManipToPath(EstIdentifier manip) + private static string ManipToPath(EstManipulation manip) { var raceCode = Names.CombinedRace(manip.Gender, manip.Race).ToRaceCode(); return manip.Slot switch { - EstType.Hair => $"chara/human/c{raceCode}/obj/hair/h{manip.SetId.Id:D4}/c{raceCode}h{manip.SetId.Id:D4}_hir.meta", - EstType.Face => $"chara/human/c{raceCode}/obj/face/h{manip.SetId.Id:D4}/c{raceCode}f{manip.SetId.Id:D4}_fac.meta", - EstType.Body => $"chara/equipment/e{manip.SetId.Id:D4}/e{manip.SetId.Id:D4}_{EquipSlot.Body.ToSuffix()}.meta", - EstType.Head => $"chara/equipment/e{manip.SetId.Id:D4}/e{manip.SetId.Id:D4}_{EquipSlot.Head.ToSuffix()}.meta", - _ => throw new ArgumentOutOfRangeException(), + EstManipulation.EstType.Hair => $"chara/human/c{raceCode}/obj/hair/h{manip.SetId:D4}/c{raceCode}h{manip.SetId:D4}_hir.meta", + EstManipulation.EstType.Face => $"chara/human/c{raceCode}/obj/face/h{manip.SetId:D4}/c{raceCode}f{manip.SetId:D4}_fac.meta", + EstManipulation.EstType.Body => $"chara/equipment/e{manip.SetId:D4}/e{manip.SetId:D4}_{EquipSlot.Body.ToSuffix()}.meta", + EstManipulation.EstType.Head => $"chara/equipment/e{manip.SetId:D4}/e{manip.SetId:D4}_{EquipSlot.Head.ToSuffix()}.meta", + _ => throw new ArgumentOutOfRangeException(), }; } - private static string ManipToPath(GmpIdentifier manip) - => $"chara/equipment/e{manip.SetId.Id:D4}/e{manip.SetId.Id:D4}_{EquipSlot.Head.ToSuffix()}.meta"; + private static string ManipToPath(GmpManipulation manip) + => $"chara/equipment/e{manip.SetId:D4}/e{manip.SetId:D4}_{EquipSlot.Head.ToSuffix()}.meta"; - private static string ManipToPath(KeyValuePair manip) - => $"chara/xls/charamake/rgsp/{(int)manip.Key.SubRace - 1}-{(int)manip.Key.Attribute.ToGender() - 1}.rgsp"; + private static string ManipToPath(RspManipulation manip) + => $"chara/xls/charamake/rgsp/{(int)manip.SubRace - 1}-{(int)manip.Attribute.ToGender() - 1}.rgsp"; } diff --git a/Penumbra/Import/TexToolsMeta.Rgsp.cs b/Penumbra/Import/TexToolsMeta.Rgsp.cs index 77c70e6c..51faa175 100644 --- a/Penumbra/Import/TexToolsMeta.Rgsp.cs +++ b/Penumbra/Import/TexToolsMeta.Rgsp.cs @@ -1,5 +1,6 @@ using Penumbra.GameData.Enums; using Penumbra.Meta; +using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; namespace Penumbra.Import; @@ -7,7 +8,7 @@ namespace Penumbra.Import; public partial class TexToolsMeta { // Parse a single rgsp file. - public static TexToolsMeta FromRgspFile(MetaFileManager manager, string filePath, byte[] data) + public static TexToolsMeta FromRgspFile(MetaFileManager manager, string filePath, byte[] data, bool keepDefault) { if (data.Length != 45 && data.Length != 42) { @@ -41,6 +42,14 @@ public partial class TexToolsMeta return Invalid; } + // Add the given values to the manipulations if they are not default. + void Add(RspAttribute attribute, float value) + { + var def = CmpFile.GetDefault(manager, subRace, attribute); + if (keepDefault || value != def) + ret.MetaManipulations.Add(new RspManipulation(subRace, attribute, value)); + } + if (gender == 1) { Add(RspAttribute.FemaleMinSize, br.ReadSingle()); @@ -64,12 +73,5 @@ public partial class TexToolsMeta } return ret; - - // Add the given values to the manipulations if they are not default. - void Add(RspAttribute attribute, float value) - { - var identifier = new RspIdentifier(subRace, attribute); - ret.MetaManipulations.TryAdd(identifier, new RspEntry(value)); - } } } diff --git a/Penumbra/Import/TexToolsMeta.cs b/Penumbra/Import/TexToolsMeta.cs index f98eddbe..25e00bd7 100644 --- a/Penumbra/Import/TexToolsMeta.cs +++ b/Penumbra/Import/TexToolsMeta.cs @@ -1,3 +1,4 @@ +using Penumbra.GameData; using Penumbra.GameData.Data; using Penumbra.Import.Structs; using Penumbra.Meta; @@ -21,13 +22,17 @@ public partial class TexToolsMeta public static readonly TexToolsMeta Invalid = new(null!, string.Empty, 0); // The info class determines the files or table locations the changes need to apply to from the filename. - public readonly uint Version; - public readonly string FilePath; - public readonly MetaDictionary MetaManipulations = new(); + public readonly uint Version; + public readonly string FilePath; + public readonly List MetaManipulations = new(); + private readonly bool _keepDefault = false; + private readonly MetaFileManager _metaFileManager; - public TexToolsMeta(GamePathParser parser, byte[] data) + public TexToolsMeta(MetaFileManager metaFileManager, GamePathParser parser, byte[] data, bool keepDefault) { + _metaFileManager = metaFileManager; + _keepDefault = keepDefault; try { using var reader = new BinaryReader(new MemoryStream(data)); @@ -39,18 +44,18 @@ public partial class TexToolsMeta var headerStart = reader.ReadUInt32(); reader.BaseStream.Seek(headerStart, SeekOrigin.Begin); - List<(MetaManipulationType type, uint offset, int size)> entries = []; + List<(MetaManipulation.Type type, uint offset, int size)> entries = []; for (var i = 0; i < numHeaders; ++i) { var currentOffset = reader.BaseStream.Position; - var type = (MetaManipulationType)reader.ReadUInt32(); + var type = (MetaManipulation.Type)reader.ReadUInt32(); var offset = reader.ReadUInt32(); var size = reader.ReadInt32(); entries.Add((type, offset, size)); reader.BaseStream.Seek(currentOffset + headerSize, SeekOrigin.Begin); } - byte[]? ReadEntry(MetaManipulationType type) + byte[]? ReadEntry(MetaManipulation.Type type) { var idx = entries.FindIndex(t => t.type == type); if (idx < 0) @@ -60,11 +65,11 @@ public partial class TexToolsMeta return reader.ReadBytes(entries[idx].size); } - DeserializeEqpEntry(metaInfo, ReadEntry(MetaManipulationType.Eqp)); - DeserializeGmpEntry(metaInfo, ReadEntry(MetaManipulationType.Gmp)); - DeserializeEqdpEntries(metaInfo, ReadEntry(MetaManipulationType.Eqdp)); - DeserializeEstEntries(metaInfo, ReadEntry(MetaManipulationType.Est)); - DeserializeImcEntries(metaInfo, ReadEntry(MetaManipulationType.Imc)); + DeserializeEqpEntry(metaInfo, ReadEntry(MetaManipulation.Type.Eqp)); + DeserializeGmpEntry(metaInfo, ReadEntry(MetaManipulation.Type.Gmp)); + DeserializeEqdpEntries(metaInfo, ReadEntry(MetaManipulation.Type.Eqdp)); + DeserializeEstEntries(metaInfo, ReadEntry(MetaManipulation.Type.Est)); + DeserializeImcEntries(metaInfo, ReadEntry(MetaManipulation.Type.Imc)); } catch (Exception e) { @@ -75,6 +80,7 @@ public partial class TexToolsMeta private TexToolsMeta(MetaFileManager metaFileManager, string filePath, uint version) { + _metaFileManager = metaFileManager; FilePath = filePath; Version = version; } diff --git a/Penumbra/Import/Textures/BaseImage.cs b/Penumbra/Import/Textures/BaseImage.cs index eba2d8ba..a4a0e203 100644 --- a/Penumbra/Import/Textures/BaseImage.cs +++ b/Penumbra/Import/Textures/BaseImage.cs @@ -103,7 +103,7 @@ public readonly struct BaseImage : IDisposable { null => 0, ScratchImage s => s.Meta.MipLevels, - TexFile t => t.Header.MipCount, + TexFile t => t.Header.MipLevelsCount, _ => 1, }; } diff --git a/Penumbra/Import/Textures/CombinedTexture.Manipulation.cs b/Penumbra/Import/Textures/CombinedTexture.Manipulation.cs index 7a7e5888..2d131d71 100644 --- a/Penumbra/Import/Textures/CombinedTexture.Manipulation.cs +++ b/Penumbra/Import/Textures/CombinedTexture.Manipulation.cs @@ -1,4 +1,4 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; using OtterGui; using SixLabors.ImageSharp.PixelFormats; diff --git a/Penumbra/Import/Textures/CombinedTexture.cs b/Penumbra/Import/Textures/CombinedTexture.cs index f5f921be..98b87ac3 100644 --- a/Penumbra/Import/Textures/CombinedTexture.cs +++ b/Penumbra/Import/Textures/CombinedTexture.cs @@ -6,10 +6,7 @@ public partial class CombinedTexture : IDisposable { AsIs, Bitmap, - BC1, BC3, - BC4, - BC5, BC7, } @@ -58,14 +55,6 @@ public partial class CombinedTexture : IDisposable SaveTask = textures.SavePng(_current.BaseImage, path, _current.RgbaPixels, _current.TextureWrap!.Width, _current.TextureWrap!.Height); } - public void SaveAsTarga(TextureManager textures, string path) - { - if (!IsLoaded || _current == null) - return; - - SaveTask = textures.SaveTga(_current.BaseImage, path, _current.RgbaPixels, _current.TextureWrap!.Width, _current.TextureWrap!.Height); - } - private void SaveAs(TextureManager textures, string path, TextureSaveType type, bool mipMaps, bool writeTex) { if (!IsLoaded || _current == null) @@ -83,7 +72,6 @@ public partial class CombinedTexture : IDisposable ".tex" => TextureType.Tex, ".dds" => TextureType.Dds, ".png" => TextureType.Png, - ".tga" => TextureType.Targa, _ => TextureType.Unknown, }; @@ -97,9 +85,6 @@ public partial class CombinedTexture : IDisposable break; case TextureType.Png: SaveAsPng(textures, path); - break; - case TextureType.Targa: - SaveAsTarga(textures, path); break; default: throw new ArgumentException( diff --git a/Penumbra/Import/Textures/TexFileParser.cs b/Penumbra/Import/Textures/TexFileParser.cs index 04bbf5d8..6f854022 100644 --- a/Penumbra/Import/Textures/TexFileParser.cs +++ b/Penumbra/Import/Textures/TexFileParser.cs @@ -61,76 +61,6 @@ public static class TexFileParser return 13; } - public static unsafe void FixMipOffsets(long size, ref TexFile.TexHeader header, out long newSize) - { - var width = (uint)header.Width; - var height = (uint)header.Height; - var format = header.Format.ToDXGI(); - var bits = format.BitsPerPixel(); - var totalSize = 80u; - size -= totalSize; - var minSize = format.IsCompressed() ? 4u : 1u; - for (var i = 0; i < 13; ++i) - { - var requiredSize = (uint)((long)width * height * bits / 8); - if (requiredSize > size) - { - newSize = totalSize; - if (header.MipCount != i) - { - Penumbra.Log.Debug( - $"-- Mip Map Count in TEX header was {header.MipCount}, but file only contains data for {i} Mip Maps, fixed."); - FixLodOffsets(ref header, i); - } - - return; - } - - if (header.OffsetToSurface[i] != totalSize) - { - Penumbra.Log.Debug( - $"-- Mip Map Offset {i + 1} in TEX header was {header.OffsetToSurface[i]} but should be {totalSize}, fixed."); - header.OffsetToSurface[i] = totalSize; - } - - if (width == minSize && height == minSize) - { - ++i; - newSize = totalSize + requiredSize; - if (header.MipCount != i) - { - Penumbra.Log.Debug($"-- Reduced number of Mip Maps from {header.MipCount} to {i} due to minimum size constraints."); - FixLodOffsets(ref header, i); - } - - return; - } - - totalSize += requiredSize; - size -= requiredSize; - width = Math.Max(width / 2, minSize); - height = Math.Max(height / 2, minSize); - } - - newSize = totalSize; - if (header.MipCount != 13) - { - Penumbra.Log.Debug($"-- Mip Map Count in TEX header was {header.MipCount}, but maximum is 13, fixed."); - FixLodOffsets(ref header, 13); - } - - void FixLodOffsets(ref TexFile.TexHeader header, int index) - { - header.MipCount = index; - if (header.LodOffset[2] >= header.MipCount) - header.LodOffset[2] = (byte)(header.MipCount - 1); - if (header.LodOffset[1] >= header.MipCount) - header.LodOffset[1] = header.MipCount > 2 ? (byte)(header.MipCount - 2) : (byte)(header.MipCount - 1); - for (++index; index < 13; ++index) - header.OffsetToSurface[index] = 0; - } - } - private static unsafe void CopyData(ScratchImage image, BinaryReader r) { fixed (byte* ptr = image.Pixels) @@ -149,8 +79,8 @@ public static class TexFileParser w.Write(header.Width); w.Write(header.Height); w.Write(header.Depth); - w.Write((byte)(header.MipCount | (header.MipUnknownFlag ? 0x80 : 0))); - w.Write(header.ArraySize); + w.Write(header.MipLevelsCount); + w.Write((byte)0); // TODO Lumina Update unsafe { w.Write(header.LodOffset[0]); @@ -166,11 +96,11 @@ public static class TexFileParser var meta = scratch.Meta; var ret = new TexFile.TexHeader() { - Height = (ushort)meta.Height, - Width = (ushort)meta.Width, - Depth = (ushort)Math.Max(meta.Depth, 1), - MipCount = (byte)Math.Min(meta.MipLevels, 13), - Format = meta.Format.ToTexFormat(), + Height = (ushort)meta.Height, + Width = (ushort)meta.Width, + Depth = (ushort)Math.Max(meta.Depth, 1), + MipLevelsCount = (byte)Math.Min(meta.MipLevels, 13), + Format = meta.Format.ToTexFormat(), Type = meta.Dimension switch { _ when meta.IsCubeMap => TexFile.Attribute.TextureTypeCube, @@ -213,7 +143,7 @@ public static class TexFileParser Height = header.Height, Width = header.Width, Depth = Math.Max(header.Depth, (ushort)1), - MipLevels = header.MipCount, + MipLevels = header.MipLevelsCount, ArraySize = 1, Format = header.Format.ToDXGI(), Dimension = header.Type.ToDimension(), @@ -247,9 +177,7 @@ public static class TexFileParser DXGIFormat.BC1UNorm => TexFile.TextureFormat.BC1, DXGIFormat.BC2UNorm => TexFile.TextureFormat.BC2, DXGIFormat.BC3UNorm => TexFile.TextureFormat.BC3, - DXGIFormat.BC4UNorm => (TexFile.TextureFormat)0x6120, // TODO: upstream to Lumina DXGIFormat.BC5UNorm => TexFile.TextureFormat.BC5, - DXGIFormat.BC6HSF16 => (TexFile.TextureFormat)0x6330, // TODO: upstream to Lumina DXGIFormat.BC7UNorm => TexFile.TextureFormat.BC7, DXGIFormat.R16G16B16A16Typeless => TexFile.TextureFormat.D16, DXGIFormat.R24G8Typeless => TexFile.TextureFormat.D24S8, @@ -274,9 +202,7 @@ public static class TexFileParser TexFile.TextureFormat.BC1 => DXGIFormat.BC1UNorm, TexFile.TextureFormat.BC2 => DXGIFormat.BC2UNorm, TexFile.TextureFormat.BC3 => DXGIFormat.BC3UNorm, - (TexFile.TextureFormat)0x6120 => DXGIFormat.BC4UNorm, // TODO: upstream to Lumina TexFile.TextureFormat.BC5 => DXGIFormat.BC5UNorm, - (TexFile.TextureFormat)0x6330 => DXGIFormat.BC6HSF16, // TODO: upstream to Lumina TexFile.TextureFormat.BC7 => DXGIFormat.BC7UNorm, TexFile.TextureFormat.D16 => DXGIFormat.R16G16B16A16Typeless, TexFile.TextureFormat.D24S8 => DXGIFormat.R24G8Typeless, diff --git a/Penumbra/Import/Textures/Texture.cs b/Penumbra/Import/Textures/Texture.cs index ae0aabd9..c4d6dc56 100644 --- a/Penumbra/Import/Textures/Texture.cs +++ b/Penumbra/Import/Textures/Texture.cs @@ -1,4 +1,4 @@ -using Dalamud.Interface.Textures.TextureWraps; +using Dalamud.Interface.Internal; using OtterTex; namespace Penumbra.Import.Textures; @@ -10,21 +10,6 @@ public enum TextureType Tex, Png, Bitmap, - Targa, -} - -internal static class TextureTypeExtensions -{ - public static TextureType ReduceToBehaviour(this TextureType type) - => type switch - { - TextureType.Dds => TextureType.Dds, - TextureType.Tex => TextureType.Tex, - TextureType.Png => TextureType.Png, - TextureType.Bitmap => TextureType.Png, - TextureType.Targa => TextureType.Png, - _ => TextureType.Unknown, - }; } public sealed class Texture : IDisposable diff --git a/Penumbra/Import/Textures/TextureDrawer.cs b/Penumbra/Import/Textures/TextureDrawer.cs index 14203dff..427db92d 100644 --- a/Penumbra/Import/Textures/TextureDrawer.cs +++ b/Penumbra/Import/Textures/TextureDrawer.cs @@ -1,5 +1,5 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; +using ImGuiNET; using Lumina.Data.Files; using OtterGui; using OtterGui.Raii; @@ -18,9 +18,11 @@ public static class TextureDrawer { if (texture.TextureWrap != null) { - size = texture.TextureWrap.Size.Contain(size); + size = size.X < texture.TextureWrap.Width + ? size with { Y = texture.TextureWrap.Height * size.X / texture.TextureWrap.Width } + : new Vector2(texture.TextureWrap.Width, texture.TextureWrap.Height); - ImGui.Image(texture.TextureWrap.Handle, size); + ImGui.Image(texture.TextureWrap.ImGuiHandle, size); DrawData(texture); } else if (texture.LoadError != null) @@ -66,7 +68,7 @@ public static class TextureDrawer current.Load(textures, paths[0]); } - fileDialog.OpenFilePicker("Open Image...", "Textures{.png,.dds,.tex,.tga}", UpdatePath, 1, startPath, false); + fileDialog.OpenFilePicker("Open Image...", "Textures{.png,.dds,.tex}", UpdatePath, 1, startPath, false); } ImGui.SameLine(); @@ -103,7 +105,7 @@ public static class TextureDrawer ImGuiUtil.DrawTableColumn("Format"); ImGuiUtil.DrawTableColumn(t.Header.Format.ToString()); ImGuiUtil.DrawTableColumn("Mip Levels"); - ImGuiUtil.DrawTableColumn(t.Header.MipCount.ToString()); + ImGuiUtil.DrawTableColumn(t.Header.MipLevelsCount.ToString()); ImGuiUtil.DrawTableColumn("Data Size"); ImGuiUtil.DrawTableColumn($"{Functions.HumanReadableSize(t.ImageData.Length)} ({t.ImageData.Length} Bytes)"); break; diff --git a/Penumbra/Import/Textures/TextureManager.cs b/Penumbra/Import/Textures/TextureManager.cs index 177722ec..976bc179 100644 --- a/Penumbra/Import/Textures/TextureManager.cs +++ b/Penumbra/Import/Textures/TextureManager.cs @@ -1,30 +1,33 @@ using Dalamud.Interface; -using Dalamud.Interface.Textures; -using Dalamud.Interface.Textures.TextureWraps; +using Dalamud.Interface.Internal; using Dalamud.Plugin.Services; using Lumina.Data.Files; using OtterGui.Log; -using OtterGui.Services; using OtterGui.Tasks; using OtterTex; using SixLabors.ImageSharp; using SixLabors.ImageSharp.Formats.Png; -using SixLabors.ImageSharp.Formats.Tga; using SixLabors.ImageSharp.PixelFormats; -using TerraFX.Interop.DirectX; -using TerraFX.Interop.Windows; using Image = SixLabors.ImageSharp.Image; namespace Penumbra.Import.Textures; -public sealed class TextureManager(IDataManager gameData, Logger logger, ITextureProvider textureProvider, IUiBuilder uiBuilder) - : SingleTaskQueue, IDisposable, IService +public sealed class TextureManager : SingleTaskQueue, IDisposable { - private readonly Logger _logger = logger; + private readonly Logger _logger; + private readonly UiBuilder _uiBuilder; + private readonly IDataManager _gameData; - private readonly ConcurrentDictionary _tasks = new(); + private readonly ConcurrentDictionary _tasks = new(); private bool _disposed; + public TextureManager(UiBuilder uiBuilder, IDataManager gameData, Logger logger) + { + _uiBuilder = uiBuilder; + _gameData = gameData; + _logger = logger; + } + public IReadOnlyDictionary Tasks => _tasks; @@ -37,17 +40,10 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur } public Task SavePng(string input, string output) - => Enqueue(new SaveImageSharpAction(this, input, output, TextureType.Png)); + => Enqueue(new SavePngAction(this, input, output)); public Task SavePng(BaseImage image, string path, byte[]? rgba = null, int width = 0, int height = 0) - => Enqueue(new SaveImageSharpAction(this, image, path, TextureType.Png, rgba, width, height)); - - public Task SaveTga(string input, string output) - => Enqueue(new SaveImageSharpAction(this, input, output, TextureType.Targa)); - - public Task SaveTga(BaseImage image, string path, byte[]? rgba = null, int width = 0, int height = 0) - => Enqueue(new SaveImageSharpAction(this, image, path, TextureType.Targa, rgba, width, height)); - + => Enqueue(new SavePngAction(this, image, path, rgba, width, height)); public Task SaveAs(CombinedTexture.TextureSaveType type, bool mipMaps, bool asTex, string input, string output) => Enqueue(new SaveAsAction(this, type, mipMaps, asTex, input, output)); @@ -68,8 +64,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur { var token = new CancellationTokenSource(); var task = Enqueue(a, token.Token); - task.ContinueWith(_ => _tasks.TryRemove(a, out var unused), CancellationToken.None, TaskContinuationOptions.None, - TaskScheduler.Default); + task.ContinueWith(_ => _tasks.TryRemove(a, out var unused), CancellationToken.None, TaskContinuationOptions.None, TaskScheduler.Default); return (task, token); }).Item1; } @@ -77,65 +72,44 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur return t; } - private class SaveImageSharpAction : IAction + private class SavePngAction : IAction { private readonly TextureManager _textures; private readonly string _outputPath; private readonly ImageInputData _input; - private readonly TextureType _type; - public SaveImageSharpAction(TextureManager textures, string input, string output, TextureType type) + public SavePngAction(TextureManager textures, string input, string output) { _textures = textures; _input = new ImageInputData(input); _outputPath = output; - _type = type; - if (_type.ReduceToBehaviour() is not TextureType.Png) - throw new ArgumentOutOfRangeException(nameof(type), type, $"Can not save as {type} with ImageSharp."); } - public SaveImageSharpAction(TextureManager textures, BaseImage image, string path, TextureType type, byte[]? rgba = null, int width = 0, - int height = 0) + public SavePngAction(TextureManager textures, BaseImage image, string path, byte[]? rgba = null, int width = 0, int height = 0) { _textures = textures; _input = new ImageInputData(image, rgba, width, height); _outputPath = path; - _type = type; - if (_type.ReduceToBehaviour() is not TextureType.Png) - throw new ArgumentOutOfRangeException(nameof(type), type, $"Can not save as {type} with ImageSharp."); } public void Execute(CancellationToken cancel) { - _textures._logger.Information($"[{nameof(TextureManager)}] Saving {_input} as {_type} to {_outputPath}..."); + _textures._logger.Information($"[{nameof(TextureManager)}] Saving {_input} as .png to {_outputPath}..."); var (image, rgba, width, height) = _input.GetData(_textures); cancel.ThrowIfCancellationRequested(); - Image? data = null; + Image? png = null; if (image.Type is TextureType.Unknown) { if (rgba != null && width > 0 && height > 0) - data = ConvertToPng(rgba, width, height).AsPng!; + png = ConvertToPng(rgba, width, height).AsPng!; } else { - data = ConvertToPng(image, cancel, rgba).AsPng!; + png = ConvertToPng(image, cancel, rgba).AsPng!; } cancel.ThrowIfCancellationRequested(); - switch (_type) - { - case TextureType.Png: - data?.SaveAsync(_outputPath, new PngEncoder { CompressionLevel = PngCompressionLevel.NoCompression }, cancel) - .Wait(cancel); - return; - case TextureType.Targa: - data?.SaveAsync(_outputPath, new TgaEncoder - { - Compression = TgaCompression.None, - BitsPerPixel = TgaBitsPerPixel.Pixel32, - }, cancel).Wait(cancel); - return; - } + png?.SaveAsync(_outputPath, new PngEncoder() { CompressionLevel = PngCompressionLevel.NoCompression }, cancel).Wait(cancel); } public override string ToString() @@ -143,7 +117,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur public bool Equals(IAction? other) { - if (other is not SaveImageSharpAction rhs) + if (other is not SavePngAction rhs) return false; return string.Equals(_outputPath, rhs._outputPath, StringComparison.OrdinalIgnoreCase) && _input.Equals(rhs._input); @@ -197,23 +171,14 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur return; } - var imageTypeBehaviour = image.Type.ReduceToBehaviour(); var dds = _type switch { - CombinedTexture.TextureSaveType.AsIs when imageTypeBehaviour is TextureType.Png => ConvertToRgbaDds(image, _mipMaps, cancel, - rgba, width, height), - CombinedTexture.TextureSaveType.AsIs when imageTypeBehaviour is TextureType.Dds => AddMipMaps(image.AsDds!, _mipMaps), + CombinedTexture.TextureSaveType.AsIs when image.Type is TextureType.Png => ConvertToRgbaDds(image, _mipMaps, cancel, rgba, + width, height), + CombinedTexture.TextureSaveType.AsIs when image.Type is TextureType.Dds => AddMipMaps(image.AsDds!, _mipMaps), CombinedTexture.TextureSaveType.Bitmap => ConvertToRgbaDds(image, _mipMaps, cancel, rgba, width, height), - CombinedTexture.TextureSaveType.BC1 => _textures.ConvertToCompressedDds(image, _mipMaps, DXGIFormat.BC1UNorm, cancel, rgba, - width, height), - CombinedTexture.TextureSaveType.BC3 => _textures.ConvertToCompressedDds(image, _mipMaps, DXGIFormat.BC3UNorm, cancel, rgba, - width, height), - CombinedTexture.TextureSaveType.BC4 => _textures.ConvertToCompressedDds(image, _mipMaps, DXGIFormat.BC4UNorm, cancel, rgba, - width, height), - CombinedTexture.TextureSaveType.BC5 => _textures.ConvertToCompressedDds(image, _mipMaps, DXGIFormat.BC5UNorm, cancel, rgba, - width, height), - CombinedTexture.TextureSaveType.BC7 => _textures.ConvertToCompressedDds(image, _mipMaps, DXGIFormat.BC7UNorm, cancel, rgba, - width, height), + CombinedTexture.TextureSaveType.BC3 => ConvertToCompressedDds(image, _mipMaps, false, cancel, rgba, width, height), + CombinedTexture.TextureSaveType.BC7 => ConvertToCompressedDds(image, _mipMaps, true, cancel, rgba, width, height), _ => throw new Exception("Wrong save type."), }; @@ -252,16 +217,14 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur /// Load a texture wrap for a given image. public IDalamudTextureWrap LoadTextureWrap(byte[] rgba, int width, int height) - => textureProvider.CreateFromRaw(RawImageSpecification.Rgba32(width, height), rgba, "Penumbra.Texture"); + => _uiBuilder.LoadImageRaw(rgba, width, height, 4); /// Load any supported file from game data or drive depending on extension and if the path is rooted. public (BaseImage, TextureType) Load(string path) => Path.GetExtension(path).ToLowerInvariant() switch { ".dds" => (LoadDds(path), TextureType.Dds), - ".png" => (LoadImageSharp(path), TextureType.Png), - ".tga" => (LoadImageSharp(path), TextureType.Targa), - ".bmp" => (LoadImageSharp(path), TextureType.Bitmap), + ".png" => (LoadPng(path), TextureType.Png), ".tex" => (LoadTex(path), TextureType.Tex), _ => throw new Exception($"Extension {Path.GetExtension(path)} unknown."), }; @@ -277,17 +240,17 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur public BaseImage LoadDds(string path) => ScratchImage.LoadDDS(path); - /// Load a supported file type from drive using ImageSharp. - public BaseImage LoadImageSharp(string path) + /// Load a .png file from drive using ImageSharp. + public BaseImage LoadPng(string path) { using var stream = File.OpenRead(path); return Image.Load(stream); } - /// Convert an existing image to ImageSharp. Does not create a deep copy of an existing ImageSharp file and just returns the existing one. + /// Convert an existing image to .png. Does not create a deep copy of an existing .png and just returns the existing one. public static BaseImage ConvertToPng(BaseImage input, CancellationToken cancel, byte[]? rgba = null, int width = 0, int height = 0) { - switch (input.Type.ReduceToBehaviour()) + switch (input.Type) { case TextureType.Png: return input; case TextureType.Dds: @@ -304,7 +267,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur public static BaseImage ConvertToRgbaDds(BaseImage input, bool mipMaps, CancellationToken cancel, byte[]? rgba = null, int width = 0, int height = 0) { - switch (input.Type.ReduceToBehaviour()) + switch (input.Type) { case TextureType.Png: { @@ -331,10 +294,10 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur } /// Convert an existing image to a block compressed .dds. Does not create a deep copy of an existing dds of the correct format and just returns the existing one. - public BaseImage ConvertToCompressedDds(BaseImage input, bool mipMaps, DXGIFormat format, CancellationToken cancel, byte[]? rgba = null, + public static BaseImage ConvertToCompressedDds(BaseImage input, bool mipMaps, bool bc7, CancellationToken cancel, byte[]? rgba = null, int width = 0, int height = 0) { - switch (input.Type.ReduceToBehaviour()) + switch (input.Type) { case TextureType.Png: { @@ -342,12 +305,12 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur cancel.ThrowIfCancellationRequested(); var dds = ConvertToDds(rgba, width, height).AsDds!; cancel.ThrowIfCancellationRequested(); - return CreateCompressed(dds, mipMaps, format, cancel); + return CreateCompressed(dds, mipMaps, bc7, cancel); } case TextureType.Dds: { var scratch = input.AsDds!; - return CreateCompressed(scratch, mipMaps, format, cancel); + return CreateCompressed(scratch, mipMaps, bc7, cancel); } default: return new BaseImage(); } @@ -363,7 +326,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur } public bool GameFileExists(string path) - => gameData.FileExists(path); + => _gameData.FileExists(path); /// Add up to 13 mip maps to the input if mip maps is true, otherwise return input. public static ScratchImage AddMipMaps(ScratchImage input, bool mipMaps) @@ -395,8 +358,9 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur } /// Create a BC3 or BC7 block-compressed .dds from the input (optionally with mipmaps). Returns input (+ mipmaps) if it is already the correct format. - public unsafe ScratchImage CreateCompressed(ScratchImage input, bool mipMaps, DXGIFormat format, CancellationToken cancel) + public static ScratchImage CreateCompressed(ScratchImage input, bool mipMaps, bool bc7, CancellationToken cancel) { + var format = bc7 ? DXGIFormat.BC7UNorm : DXGIFormat.BC3UNorm; if (input.Meta.Format == format) return input; @@ -408,63 +372,6 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur input = AddMipMaps(input, mipMaps); cancel.ThrowIfCancellationRequested(); - // See https://github.com/microsoft/DirectXTex/wiki/Compress#parameters for the format condition. - if (format is DXGIFormat.BC6HUF16 or DXGIFormat.BC6HSF16 or DXGIFormat.BC7UNorm or DXGIFormat.BC7UNormSRGB) - { - ref var device = ref *(ID3D11Device*)uiBuilder.DeviceHandle; - IDXGIDevice* dxgiDevice; - Marshal.ThrowExceptionForHR(device.QueryInterface(TerraFX.Interop.Windows.Windows.__uuidof(), (void**)&dxgiDevice)); - - try - { - IDXGIAdapter* adapter = null; - Marshal.ThrowExceptionForHR(dxgiDevice->GetAdapter(&adapter)); - try - { - dxgiDevice->Release(); - dxgiDevice = null; - - ID3D11Device* deviceClone = null; - ID3D11DeviceContext* contextClone = null; - var featureLevel = device.GetFeatureLevel(); - Marshal.ThrowExceptionForHR(DirectX.D3D11CreateDevice( - adapter, - D3D_DRIVER_TYPE.D3D_DRIVER_TYPE_UNKNOWN, - HMODULE.NULL, - device.GetCreationFlags(), - &featureLevel, - 1, - D3D11.D3D11_SDK_VERSION, - &deviceClone, - null, - &contextClone)); - try - { - adapter->Release(); - adapter = null; - return input.Compress((nint)deviceClone, format, CompressFlags.Parallel); - } - finally - { - if (contextClone is not null) - contextClone->Release(); - if (deviceClone is not null) - deviceClone->Release(); - } - } - finally - { - if (adapter is not null) - adapter->Release(); - } - } - finally - { - if (dxgiDevice is not null) - dxgiDevice->Release(); - } - } - return input.Compress(format, CompressFlags.BC7Quick | CompressFlags.Parallel); } @@ -475,7 +382,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur if (Path.IsPathRooted(path)) return File.OpenRead(path); - var file = gameData.GetFile(path); + var file = _gameData.GetFile(path); return file != null ? new MemoryStream(file.Data) : throw new Exception($"Unable to obtain \"{path}\" from game files."); } @@ -508,7 +415,7 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur GC.KeepAlive(input); } - private readonly struct ImageInputData : IEquatable + private readonly struct ImageInputData { private readonly string? _inputPath; @@ -569,15 +476,11 @@ public sealed class TextureManager(IDataManager gameData, Logger logger, ITextur TextureType.Dds => $"Custom {_width} x {_height} {_image.Format} Image", TextureType.Tex => $"Custom {_width} x {_height} {_image.Format} Image", TextureType.Png => $"Custom {_width} x {_height} .png Image", - TextureType.Targa => $"Custom {_width} x {_height} .tga Image", TextureType.Bitmap => $"Custom {_width} x {_height} RGBA Image", _ => "Unknown Image", }; public override int GetHashCode() => _inputPath != null ? _inputPath.ToLowerInvariant().GetHashCode() : HashCode.Combine(_width, _height); - - public override bool Equals(object? obj) - => obj is ImageInputData o && Equals(o); } } diff --git a/Penumbra/Interop/CloudApi.cs b/Penumbra/Interop/CloudApi.cs deleted file mode 100644 index 603d4c9f..00000000 --- a/Penumbra/Interop/CloudApi.cs +++ /dev/null @@ -1,47 +0,0 @@ -namespace Penumbra.Interop; - -public static unsafe partial class CloudApi -{ - private const int CfSyncRootInfoBasic = 0; - - /// Determines whether a file or directory is cloud-synced using OneDrive or other providers that use the Cloud API. - /// Can be expensive. Callers should cache the result when relevant. - public static bool IsCloudSynced(string path) - { - var buffer = stackalloc long[1]; - int hr; - uint length; - try - { - hr = CfGetSyncRootInfoByPath(path, CfSyncRootInfoBasic, buffer, sizeof(long), out length); - } - catch (DllNotFoundException) - { - Penumbra.Log.Debug($"{nameof(CfGetSyncRootInfoByPath)} threw DllNotFoundException"); - return false; - } - catch (EntryPointNotFoundException) - { - Penumbra.Log.Debug($"{nameof(CfGetSyncRootInfoByPath)} threw EntryPointNotFoundException"); - return false; - } - - Penumbra.Log.Debug($"{nameof(CfGetSyncRootInfoByPath)} returned HRESULT 0x{hr:X8}"); - if (hr < 0) - return false; - - if (length != sizeof(long)) - { - Penumbra.Log.Debug($"Expected {nameof(CfGetSyncRootInfoByPath)} to return {sizeof(long)} bytes, got {length} bytes"); - return false; - } - - Penumbra.Log.Debug($"{nameof(CfGetSyncRootInfoByPath)} returned {{ SyncRootFileId = 0x{*buffer:X16} }}"); - - return true; - } - - [LibraryImport("cldapi.dll", StringMarshalling = StringMarshalling.Utf16)] - private static partial int CfGetSyncRootInfoByPath(string filePath, int infoClass, void* infoBuffer, uint infoBufferLength, - out uint returnedLength); -} diff --git a/Penumbra/Interop/GameState.cs b/Penumbra/Interop/GameState.cs index b5171244..7e7abcd8 100644 --- a/Penumbra/Interop/GameState.cs +++ b/Penumbra/Interop/GameState.cs @@ -11,8 +11,7 @@ public class GameState : IService { #region Last Game Object - private readonly ThreadLocal> _lastGameObject = new(() => new Queue()); - public readonly ThreadLocal CharacterAssociated = new(() => false); + private readonly ThreadLocal> _lastGameObject = new(() => new Queue()); public nint LastGameObject => _lastGameObject.IsValueCreated && _lastGameObject.Value!.Count > 0 ? _lastGameObject.Value.Peek() : nint.Zero; @@ -50,15 +49,15 @@ public class GameState : IService public void RestoreAnimationData(ResolveData old) => _animationLoadData.Value = old; - public readonly ThreadLocal InLoadActionTmb = new(() => false); - public readonly ThreadLocal SkipTmbCache = new(() => false); - #endregion #region Sound Data private readonly ThreadLocal _characterSoundData = new(() => ResolveData.Invalid, true); + public ResolveData SoundData + => _animationLoadData.Value; + [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] public ResolveData SetSoundData(ResolveData data) { diff --git a/Penumbra/Interop/Hooks/Animation/ApricotListenerSoundPlay.cs b/Penumbra/Interop/Hooks/Animation/ApricotListenerSoundPlay.cs index 8838971c..77927593 100644 --- a/Penumbra/Interop/Hooks/Animation/ApricotListenerSoundPlay.cs +++ b/Penumbra/Interop/Hooks/Animation/ApricotListenerSoundPlay.cs @@ -10,50 +10,32 @@ using Penumbra.Services; namespace Penumbra.Interop.Hooks.Animation; /// Called for some sound effects caused by animations or VFX. -/// Actual function got inlined. -public sealed unsafe class ApricotListenerSoundPlayCaller : FastHook +public sealed unsafe class ApricotListenerSoundPlay : FastHook { private readonly GameState _state; private readonly CollectionResolver _collectionResolver; private readonly CrashHandlerService _crashHandler; - public ApricotListenerSoundPlayCaller(HookManager hooks, GameState state, CollectionResolver collectionResolver, - CrashHandlerService crashHandler) + public ApricotListenerSoundPlay(HookManager hooks, GameState state, CollectionResolver collectionResolver, CrashHandlerService crashHandler) { _state = state; _collectionResolver = collectionResolver; _crashHandler = crashHandler; - Task = hooks.CreateHook("Apricot Listener Sound Play Caller", Sigs.ApricotListenerSoundPlayCaller, Detour, - !HookOverrides.Instance.Animation.ApricotListenerSoundPlayCaller); + Task = hooks.CreateHook("Apricot Listener Sound Play", Sigs.ApricotListenerSoundPlay, Detour, true); } - public delegate nint Delegate(nint a1, nint a2, float a3); + public delegate nint Delegate(nint a1, nint a2, nint a3, nint a4, nint a5, nint a6); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private nint Detour(nint a1, nint unused, float timeOffset) + private nint Detour(nint a1, nint a2, nint a3, nint a4, nint a5, nint a6) { - // Short-circuiting and sanity checks done by game. - var playTime = a1 == nint.Zero ? -1 : *(float*)(a1 + VolatileOffsets.ApricotListenerSoundPlayCaller.PlayTimeOffset); - if (playTime < 0) - return Task.Result.Original(a1, unused, timeOffset); + Penumbra.Log.Excessive($"[Apricot Listener Sound Play] Invoked on 0x{a1:X} with {a2}, {a3}, {a4}, {a5}, {a6}."); + if (a6 == nint.Zero) + return Task.Result.Original(a1, a2, a3, a4, a5, a6); - var someIntermediate = *(nint*)(a1 + VolatileOffsets.ApricotListenerSoundPlayCaller.SomeIntermediate); - var flags = someIntermediate == nint.Zero - ? (ushort)0 - : *(ushort*)(someIntermediate + VolatileOffsets.ApricotListenerSoundPlayCaller.Flags); - if (((flags >> VolatileOffsets.ApricotListenerSoundPlayCaller.BitShift) & 1) == 0) - return Task.Result.Original(a1, unused, timeOffset); - - Penumbra.Log.Excessive( - $"[Apricot Listener Sound Play Caller] Invoked on 0x{a1:X} with {unused}, {timeOffset}."); - // Fetch the IInstanceListenner (sixth argument to inlined call of SoundPlay) - var apricotIInstanceListenner = *(nint*)(someIntermediate + VolatileOffsets.ApricotListenerSoundPlayCaller.IInstanceListenner); - if (apricotIInstanceListenner == nint.Zero) - return Task.Result.Original(a1, unused, timeOffset); - - // In some cases we can obtain the associated caster via vfunc 1. + // a6 is some instance of Apricot.IInstanceListenner, in some cases we can obtain the associated caster via vfunc 1. + var gameObject = (*(delegate* unmanaged**)a6)[1](a6); var newData = ResolveData.Invalid; - var gameObject = (*(delegate* unmanaged**)apricotIInstanceListenner)[VolatileOffsets.ApricotListenerSoundPlayCaller.CasterVFunc](apricotIInstanceListenner); if (gameObject != null) { newData = _collectionResolver.IdentifyCollection(gameObject, true); @@ -63,14 +45,14 @@ public sealed unsafe class ApricotListenerSoundPlayCaller : FastHook("CharacterBase Load Animation", Sigs.CharacterBaseLoadAnimation, Detour, - !HookOverrides.Instance.Animation.CharacterBaseLoadAnimation); + Task = hooks.CreateHook("CharacterBase Load Animation", Sigs.CharacterBaseLoadAnimation, Detour, true); } public delegate void Delegate(DrawObject* drawBase); diff --git a/Penumbra/Interop/Hooks/Animation/Dismount.cs b/Penumbra/Interop/Hooks/Animation/Dismount.cs index 17151083..8085bcdb 100644 --- a/Penumbra/Interop/Hooks/Animation/Dismount.cs +++ b/Penumbra/Interop/Hooks/Animation/Dismount.cs @@ -1,4 +1,3 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Game.Object; using OtterGui.Services; using Penumbra.GameData; @@ -16,29 +15,29 @@ public sealed unsafe class Dismount : FastHook { _state = state; _collectionResolver = collectionResolver; - Task = hooks.CreateHook("Dismount", Sigs.Dismount, Detour, !HookOverrides.Instance.Animation.Dismount); + Task = hooks.CreateHook("Dismount", Sigs.Dismount, Detour, true); } - public delegate void Delegate(MountContainer* a1, nint a2); + public delegate void Delegate(nint a1, nint a2); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private void Detour(MountContainer* a1, nint a2) + private void Detour(nint a1, nint a2) { - Penumbra.Log.Excessive($"[Dismount] Invoked on 0x{(nint)a1:X} with {a2:X}."); - if (a1 == null) + Penumbra.Log.Excessive($"[Dismount] Invoked on {a1:X} with {a2:X}."); + if (a1 == nint.Zero) { Task.Result.Original(a1, a2); return; } - var gameObject = a1->OwnerObject; + var gameObject = *(GameObject**)(a1 + 8); if (gameObject == null) { Task.Result.Original(a1, a2); return; } - var last = _state.SetAnimationData(_collectionResolver.IdentifyCollection((GameObject*) gameObject, true)); + var last = _state.SetAnimationData(_collectionResolver.IdentifyCollection(gameObject, true)); Task.Result.Original(a1, a2); _state.RestoreAnimationData(last); } diff --git a/Penumbra/Interop/Hooks/Animation/GetCachedScheduleResource.cs b/Penumbra/Interop/Hooks/Animation/GetCachedScheduleResource.cs deleted file mode 100644 index 6ce1f899..00000000 --- a/Penumbra/Interop/Hooks/Animation/GetCachedScheduleResource.cs +++ /dev/null @@ -1,53 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Resource; -using JetBrains.Annotations; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.Interop.Structs; -using Penumbra.String; - -namespace Penumbra.Interop.Hooks.Animation; - -/// Load a cached TMB resource from SchedulerResourceManagement. -public sealed unsafe class GetCachedScheduleResource : FastHook -{ - private readonly GameState _state; - - public GetCachedScheduleResource(HookManager hooks, GameState state) - { - _state = state; - Task = hooks.CreateHook("Get Cached Schedule Resource", Sigs.GetCachedScheduleResource, Detour, - !HookOverrides.Instance.Animation.GetCachedScheduleResource); - } - - public delegate SchedulerResource* Delegate(SchedulerResourceManagement* a, ScheduleResourceLoadData* b, byte useMap); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private SchedulerResource* Detour(SchedulerResourceManagement* a, ScheduleResourceLoadData* b, byte c) - { - if (_state.SkipTmbCache.Value) - { - Penumbra.Log.Verbose( - $"[GetCachedScheduleResource] Called with 0x{(ulong)a:X}, {b->Id}, {new CiByteString(b->Path, MetaDataComputation.None)}, {c} from LoadActionTmb with forced skipping of cache, returning NULL."); - return null; - } - - var ret = Task.Result.Original(a, b, c); - Penumbra.Log.Excessive( - $"[GetCachedScheduleResource] Called with 0x{(ulong)a:X}, {b->Id}, {new CiByteString(b->Path, MetaDataComputation.None)}, {c}, returning 0x{(ulong)ret:X} ({(ret != null && Resource(ret) != null ? Resource(ret)->FileName().ToString() : "No Path")})."); - return ret; - } - - public struct ScheduleResourceLoadData - { - [UsedImplicitly] - public byte* Path; - - [UsedImplicitly] - public uint Id; - } - - - // #TODO: remove when fixed in CS. - public static ResourceHandle* Resource(SchedulerResource* r) - => ((ResourceHandle**)r)[3]; -} diff --git a/Penumbra/Interop/Hooks/Animation/LoadActionTmb.cs b/Penumbra/Interop/Hooks/Animation/LoadActionTmb.cs deleted file mode 100644 index 457465d2..00000000 --- a/Penumbra/Interop/Hooks/Animation/LoadActionTmb.cs +++ /dev/null @@ -1,55 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Resource; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.Interop.Services; -using Penumbra.String; - -namespace Penumbra.Interop.Hooks.Animation; - -/// Load a Action TMB. -public sealed unsafe class LoadActionTmb : FastHook -{ - private readonly GameState _state; - private readonly SchedulerResourceManagementService _scheduler; - - public LoadActionTmb(HookManager hooks, GameState state, SchedulerResourceManagementService scheduler) - { - _state = state; - _scheduler = scheduler; - Task = hooks.CreateHook("Load Action TMB", Sigs.LoadActionTmb, Detour, !HookOverrides.Instance.Animation.LoadActionTmb); - } - - public delegate SchedulerResource* Delegate(SchedulerResourceManagement* scheduler, - GetCachedScheduleResource.ScheduleResourceLoadData* loadData, nint b, byte c, byte d, byte e); - - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private SchedulerResource* Detour(SchedulerResourceManagement* scheduler, GetCachedScheduleResource.ScheduleResourceLoadData* loadData, - nint b, byte c, byte d, byte e) - { - _state.InLoadActionTmb.Value = true; - SchedulerResource* ret; - if (ShouldSkipCache(loadData)) - { - _state.SkipTmbCache.Value = true; - ret = Task.Result.Original(scheduler, loadData, b, c, d, 1); - Penumbra.Log.Verbose( - $"[LoadActionTMB] Called with 0x{(ulong)scheduler:X}, {loadData->Id}, {new CiByteString(loadData->Path, MetaDataComputation.None)}, 0x{b:X}, {c}, {d}, {e}, forced no-cache use, returned 0x{(ulong)ret:X} ({(ret != null && GetCachedScheduleResource.Resource(ret) != null ? GetCachedScheduleResource.Resource(ret)->FileName().ToString() : "No Path")})."); - _state.SkipTmbCache.Value = false; - } - else - { - ret = Task.Result.Original(scheduler, loadData, b, c, d, e); - Penumbra.Log.Excessive( - $"[LoadActionTMB] Called with 0x{(ulong)scheduler:X}, {loadData->Id}, {new CiByteString(loadData->Path)}, 0x{b:X}, {c}, {d}, {e}, returned 0x{(ulong)ret:X} ({(ret != null && GetCachedScheduleResource.Resource(ret) != null ? GetCachedScheduleResource.Resource(ret)->FileName().ToString() : "No Path")})."); - } - - _state.InLoadActionTmb.Value = false; - - return ret; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private bool ShouldSkipCache(GetCachedScheduleResource.ScheduleResourceLoadData* loadData) - => _scheduler.Contains(loadData->Id); -} diff --git a/Penumbra/Interop/Hooks/Animation/LoadAreaVfx.cs b/Penumbra/Interop/Hooks/Animation/LoadAreaVfx.cs index 29afd4ea..1a78d3b4 100644 --- a/Penumbra/Interop/Hooks/Animation/LoadAreaVfx.cs +++ b/Penumbra/Interop/Hooks/Animation/LoadAreaVfx.cs @@ -17,10 +17,10 @@ public sealed unsafe class LoadAreaVfx : FastHook public LoadAreaVfx(HookManager hooks, GameState state, CollectionResolver collectionResolver, CrashHandlerService crashHandler) { - _state = state; + _state = state; _collectionResolver = collectionResolver; - _crashHandler = crashHandler; - Task = hooks.CreateHook("Load Area VFX", Sigs.LoadAreaVfx, Detour, !HookOverrides.Instance.Animation.LoadAreaVfx); + _crashHandler = crashHandler; + Task = hooks.CreateHook("Load Area VFX", Sigs.LoadAreaVfx, Detour, true); } public delegate nint Delegate(uint vfxId, float* pos, GameObject* caster, float unk1, float unk2, byte unk3); @@ -29,12 +29,12 @@ public sealed unsafe class LoadAreaVfx : FastHook private nint Detour(uint vfxId, float* pos, GameObject* caster, float unk1, float unk2, byte unk3) { var newData = caster != null - ? _collectionResolver.IdentifyCollection(caster, true) - : ResolveData.Invalid; + ? _collectionResolver.IdentifyCollection(caster, true) + : ResolveData.Invalid; var last = _state.SetAnimationData(newData); _crashHandler.LogAnimation(newData.AssociatedGameObject, newData.ModCollection, AnimationInvocationType.LoadAreaVfx); - var ret = Task.Result.Original(vfxId, pos, caster, unk1, unk2, unk3); + var ret = Task.Result.Original(vfxId, pos, caster, unk1, unk2, unk3); Penumbra.Log.Excessive( $"[Load Area VFX] Invoked with {vfxId}, [{pos[0]} {pos[1]} {pos[2]}], 0x{(nint)caster:X}, {unk1}, {unk2}, {unk3} -> 0x{ret:X}."); _state.RestoreAnimationData(last); diff --git a/Penumbra/Interop/Hooks/Animation/LoadCharacterSound.cs b/Penumbra/Interop/Hooks/Animation/LoadCharacterSound.cs index 91b70ede..98454a77 100644 --- a/Penumbra/Interop/Hooks/Animation/LoadCharacterSound.cs +++ b/Penumbra/Interop/Hooks/Animation/LoadCharacterSound.cs @@ -1,4 +1,3 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Game.Object; using OtterGui.Services; using Penumbra.CrashHandler.Buffers; @@ -19,22 +18,22 @@ public sealed unsafe class LoadCharacterSound : FastHook("Load Character Sound", (nint)VfxContainer.MemberFunctionPointers.LoadCharacterSound, Detour, - !HookOverrides.Instance.Animation.LoadCharacterSound); + Task = hooks.CreateHook("Load Character Sound", + (nint)FFXIVClientStructs.FFXIV.Client.Game.Character.Character.VfxContainer.MemberFunctionPointers.LoadCharacterSound, Detour, + true); } - public delegate nint Delegate(VfxContainer* container, int unk1, int unk2, nint unk3, ulong unk4, int unk5, int unk6, ulong unk7); + public delegate nint Delegate(nint container, int unk1, int unk2, nint unk3, ulong unk4, int unk5, int unk6, ulong unk7); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private nint Detour(VfxContainer* container, int unk1, int unk2, nint unk3, ulong unk4, int unk5, int unk6, ulong unk7) + private nint Detour(nint container, int unk1, int unk2, nint unk3, ulong unk4, int unk5, int unk6, ulong unk7) { - var character = (GameObject*)container->OwnerObject; + var character = *(GameObject**)(container + 8); var newData = _collectionResolver.IdentifyCollection(character, true); var last = _state.SetSoundData(newData); _crashHandler.LogAnimation(newData.AssociatedGameObject, newData.ModCollection, AnimationInvocationType.LoadCharacterSound); var ret = Task.Result.Original(container, unk1, unk2, unk3, unk4, unk5, unk6, unk7); - Penumbra.Log.Excessive( - $"[Load Character Sound] Invoked with {(nint)container:X} {unk1} {unk2} {unk3} {unk4} {unk5} {unk6} {unk7} -> {ret}."); + Penumbra.Log.Excessive($"[Load Character Sound] Invoked with {container:X} {unk1} {unk2} {unk3} {unk4} {unk5} {unk6} {unk7} -> {ret}."); _state.RestoreSoundData(last); return ret; } diff --git a/Penumbra/Interop/Hooks/Animation/LoadCharacterVfx.cs b/Penumbra/Interop/Hooks/Animation/LoadCharacterVfx.cs index 9a57ca12..77aaa742 100644 --- a/Penumbra/Interop/Hooks/Animation/LoadCharacterVfx.cs +++ b/Penumbra/Interop/Hooks/Animation/LoadCharacterVfx.cs @@ -26,7 +26,7 @@ public sealed unsafe class LoadCharacterVfx : FastHook("Load Character VFX", Sigs.LoadCharacterVfx, Detour, !HookOverrides.Instance.Animation.LoadCharacterVfx); + Task = hooks.CreateHook("Load Character VFX", Sigs.LoadCharacterVfx, Detour, true); } public delegate nint Delegate(byte* vfxPath, VfxParams* vfxParams, byte unk1, byte unk2, float unk3, int unk4); diff --git a/Penumbra/Interop/Hooks/Animation/LoadTimelineResources.cs b/Penumbra/Interop/Hooks/Animation/LoadTimelineResources.cs index cdd82b95..018892a0 100644 --- a/Penumbra/Interop/Hooks/Animation/LoadTimelineResources.cs +++ b/Penumbra/Interop/Hooks/Animation/LoadTimelineResources.cs @@ -1,7 +1,6 @@ using Dalamud.Game.ClientState.Conditions; using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Game.Object; -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Base; using OtterGui.Services; using Penumbra.Collections; using Penumbra.GameData; @@ -26,44 +25,45 @@ public sealed unsafe class LoadTimelineResources : FastHook("Load Timeline Resources", Sigs.LoadTimelineResources, Detour, !HookOverrides.Instance.Animation.LoadTimelineResources); + _conditions = conditions; + _objects = objects; + _crashHandler = crashHandler; + Task = hooks.CreateHook("Load Timeline Resources", Sigs.LoadTimelineResources, Detour, true); } - public delegate ulong Delegate(SchedulerTimeline* timeline); + public delegate ulong Delegate(nint timeline); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private ulong Detour(SchedulerTimeline* timeline) + private ulong Detour(nint timeline) { - Penumbra.Log.Excessive($"[Load Timeline Resources] Invoked on {(nint)timeline:X}."); + Penumbra.Log.Excessive($"[Load Timeline Resources] Invoked on {timeline:X}."); // Do not check timeline loading in cutscenes. if (_conditions[ConditionFlag.OccupiedInCutSceneEvent] || _conditions[ConditionFlag.WatchingCutscene78]) return Task.Result.Original(timeline); var newData = GetDataFromTimeline(_objects, _collectionResolver, timeline); - var last = _state.SetAnimationData(newData); - + var last = _state.SetAnimationData(newData); + #if false // This is called far too often and spams the log too much. _crashHandler.LogAnimation(newData.AssociatedGameObject, newData.ModCollection, AnimationInvocationType.LoadTimelineResources); #endif - var ret = Task.Result.Original(timeline); + var ret = Task.Result.Original(timeline); _state.RestoreAnimationData(last); return ret; } /// Use timelines vfuncs to obtain the associated game object. - public static ResolveData GetDataFromTimeline(ObjectManager objects, CollectionResolver resolver, SchedulerTimeline* timeline) + public static ResolveData GetDataFromTimeline(ObjectManager objects, CollectionResolver resolver, nint timeline) { try { - if (timeline != null) + if (timeline != nint.Zero) { - var idx = timeline->GetOwningGameObjectIndex(); + var getGameObjectIdx = ((delegate* unmanaged**)timeline)[0][Offsets.GetGameObjectIdxVfunc]; + var idx = getGameObjectIdx(timeline); if (idx >= 0 && idx < objects.TotalCount) { var obj = objects[idx]; @@ -73,7 +73,7 @@ public sealed unsafe class LoadTimelineResources : FastHook { _state = state; _collectionResolver = collectionResolver; - Task = hooks.CreateHook("Play Footstep", Sigs.FootStepSound, Detour, !HookOverrides.Instance.Animation.PlayFootstep); + Task = hooks.CreateHook("Play Footstep", Sigs.FootStepSound, Detour, true); } public delegate void Delegate(GameObject* gameObject, int id, int unk); diff --git a/Penumbra/Interop/Hooks/Animation/ScheduleClipUpdate.cs b/Penumbra/Interop/Hooks/Animation/ScheduleClipUpdate.cs index dfbc615a..342ffc25 100644 --- a/Penumbra/Interop/Hooks/Animation/ScheduleClipUpdate.cs +++ b/Penumbra/Interop/Hooks/Animation/ScheduleClipUpdate.cs @@ -23,7 +23,7 @@ public sealed unsafe class ScheduleClipUpdate : FastHook("Schedule Clip Update", Sigs.ScheduleClipUpdate, Detour, !HookOverrides.Instance.Animation.ScheduleClipUpdate); + Task = hooks.CreateHook("Schedule Clip Update", Sigs.ScheduleClipUpdate, Detour, true); } public delegate void Delegate(ClipScheduler* x); diff --git a/Penumbra/Interop/Hooks/Animation/SomeActionLoad.cs b/Penumbra/Interop/Hooks/Animation/SomeActionLoad.cs index e1751261..6de3aeb0 100644 --- a/Penumbra/Interop/Hooks/Animation/SomeActionLoad.cs +++ b/Penumbra/Interop/Hooks/Animation/SomeActionLoad.cs @@ -1,4 +1,4 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; +using FFXIVClientStructs.FFXIV.Client.Game; using FFXIVClientStructs.FFXIV.Client.Game.Object; using OtterGui.Services; using Penumbra.CrashHandler.Buffers; @@ -20,15 +20,15 @@ public sealed unsafe class SomeActionLoad : FastHook _state = state; _collectionResolver = collectionResolver; _crashHandler = crashHandler; - Task = hooks.CreateHook("Some Action Load", Sigs.LoadSomeAction, Detour, !HookOverrides.Instance.Animation.SomeActionLoad); + Task = hooks.CreateHook("Some Action Load", Sigs.LoadSomeAction, Detour, true); } - public delegate void Delegate(TimelineContainer* timelineManager); + public delegate void Delegate(ActionTimelineManager* timelineManager); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private void Detour(TimelineContainer* timelineManager) + private void Detour(ActionTimelineManager* timelineManager) { - var newData = _collectionResolver.IdentifyCollection((GameObject*)timelineManager->OwnerObject, true); + var newData = _collectionResolver.IdentifyCollection((GameObject*)timelineManager->Parent, true); var last = _state.SetAnimationData(newData); Penumbra.Log.Excessive($"[Some Action Load] Invoked on 0x{(nint)timelineManager:X}."); _crashHandler.LogAnimation(newData.AssociatedGameObject, newData.ModCollection, AnimationInvocationType.ActionLoad); diff --git a/Penumbra/Interop/Hooks/Animation/SomeMountAnimation.cs b/Penumbra/Interop/Hooks/Animation/SomeMountAnimation.cs index 75f1240a..5dd8227d 100644 --- a/Penumbra/Interop/Hooks/Animation/SomeMountAnimation.cs +++ b/Penumbra/Interop/Hooks/Animation/SomeMountAnimation.cs @@ -15,7 +15,7 @@ public sealed unsafe class SomeMountAnimation : FastHook("Some Mount Animation", Sigs.UnkMountAnimation, Detour, !HookOverrides.Instance.Animation.SomeMountAnimation); + Task = hooks.CreateHook("Some Mount Animation", Sigs.UnkMountAnimation, Detour, true); } public delegate void Delegate(DrawObject* drawObject, uint unk1, byte unk2, uint unk3); diff --git a/Penumbra/Interop/Hooks/Animation/SomePapLoad.cs b/Penumbra/Interop/Hooks/Animation/SomePapLoad.cs index f19e4ce2..fad1f819 100644 --- a/Penumbra/Interop/Hooks/Animation/SomePapLoad.cs +++ b/Penumbra/Interop/Hooks/Animation/SomePapLoad.cs @@ -22,7 +22,7 @@ public sealed unsafe class SomePapLoad : FastHook _collectionResolver = collectionResolver; _objects = objects; _crashHandler = crashHandler; - Task = hooks.CreateHook("Some PAP Load", Sigs.LoadSomePap, Detour, !HookOverrides.Instance.Animation.SomePapLoad); + Task = hooks.CreateHook("Some PAP Load", Sigs.LoadSomePap, Detour, true); } public delegate void Delegate(nint a1, int a2, nint a3, int a4); @@ -31,7 +31,7 @@ public sealed unsafe class SomePapLoad : FastHook private void Detour(nint a1, int a2, nint a3, int a4) { Penumbra.Log.Excessive($"[Some PAP Load] Invoked on 0x{a1:X} with {a2}, {a3}, {a4}."); - var timelinePtr = a1 + VolatileOffsets.AnimationState.TimeLinePtr; + var timelinePtr = a1 + Offsets.TimeLinePtr; if (timelinePtr != nint.Zero) { var actorIdx = (int)(*(*(ulong**)timelinePtr + 1) >> 3); diff --git a/Penumbra/Interop/Hooks/Animation/SomeParasolAnimation.cs b/Penumbra/Interop/Hooks/Animation/SomeParasolAnimation.cs index 9df8d4eb..ab4a7201 100644 --- a/Penumbra/Interop/Hooks/Animation/SomeParasolAnimation.cs +++ b/Penumbra/Interop/Hooks/Animation/SomeParasolAnimation.cs @@ -15,7 +15,7 @@ public sealed unsafe class SomeParasolAnimation : FastHook("Some Parasol Animation", Sigs.UnkParasolAnimation, Detour, !HookOverrides.Instance.Animation.SomeParasolAnimation); + Task = hooks.CreateHook("Some Parasol Animation", Sigs.UnkParasolAnimation, Detour, true); } public delegate void Delegate(DrawObject* drawObject, int unk1); diff --git a/Penumbra/Interop/Hooks/DebugHook.cs b/Penumbra/Interop/Hooks/DebugHook.cs index fe9754f9..db14805c 100644 --- a/Penumbra/Interop/Hooks/DebugHook.cs +++ b/Penumbra/Interop/Hooks/DebugHook.cs @@ -1,6 +1,5 @@ using Dalamud.Hooking; using OtterGui.Services; -using Penumbra.Interop.Structs; namespace Penumbra.Interop.Hooks; @@ -32,13 +31,12 @@ public sealed unsafe class DebugHook : IHookService public bool Finished => _task?.IsCompletedSuccessfully ?? true; - private delegate nint Delegate(ResourceHandle* a, int b, int c); + private delegate void Delegate(nint a, int b, nint c, float* d); - private nint Detour(ResourceHandle* a, int b, int c) + private void Detour(nint a, int b, nint c, float* d) { - var ret = _task!.Result.Original(a, b, c); - Penumbra.Log.Information($"[Debug Hook] Results with 0x{(nint)a:X}, {b}, {c} -> 0x{ret:X}."); - return ret; + _task!.Result.Original(a, b, c, d); + Penumbra.Log.Information($"[Debug Hook] Results with 0x{a:X} {b} {c:X} {d[0]} {d[1]} {d[2]} {d[3]}."); } } #endif diff --git a/Penumbra/Interop/Hooks/HookSettings.cs b/Penumbra/Interop/Hooks/HookSettings.cs deleted file mode 100644 index bcff25d2..00000000 --- a/Penumbra/Interop/Hooks/HookSettings.cs +++ /dev/null @@ -1,155 +0,0 @@ -using Dalamud.Plugin; -using Newtonsoft.Json; - -namespace Penumbra.Interop.Hooks; - -public class HookOverrides -{ - [JsonIgnore] - public bool IsCustomLoaded { get; private set; } - - public static HookOverrides Instance = new(); - - public AnimationHooks Animation; - public MetaHooks Meta; - public ObjectHooks Objects; - public PostProcessingHooks PostProcessing; - public ResourceLoadingHooks ResourceLoading; - public ResourceHooks Resources; - - public HookOverrides Clone() - => new() - { - Animation = Animation, - Meta = Meta, - Objects = Objects, - PostProcessing = PostProcessing, - ResourceLoading = ResourceLoading, - Resources = Resources, - }; - - public struct AnimationHooks - { - public bool ApricotListenerSoundPlayCaller; - public bool CharacterBaseLoadAnimation; - public bool Dismount; - public bool LoadAreaVfx; - public bool LoadCharacterSound; - public bool LoadCharacterVfx; - public bool LoadTimelineResources; - public bool PlayFootstep; - public bool ScheduleClipUpdate; - public bool SomeActionLoad; - public bool SomeMountAnimation; - public bool SomePapLoad; - public bool SomeParasolAnimation; - public bool GetCachedScheduleResource; - public bool LoadActionTmb; - } - - public struct MetaHooks - { - public bool CalculateHeight; - public bool ChangeCustomize; - public bool EqdpAccessoryHook; - public bool EqdpEquipHook; - public bool EqpHook; - public bool EstHook; - public bool GmpHook; - public bool ModelLoadComplete; - public bool RspBustHook; - public bool RspHeightHook; - public bool RspSetupCharacter; - public bool RspTailHook; - public bool SetupVisor; - public bool UpdateModel; - public bool UpdateRender; - public bool AtchCaller1; - public bool AtchCaller2; - } - - public struct ObjectHooks - { - public bool CharacterBaseDestructor; - public bool CharacterDestructor; - public bool CopyCharacter; - public bool CreateCharacterBase; - public bool EnableDraw; - public bool WeaponReload; - public bool SetupPlayerNpc; - public bool ConstructCutsceneCharacter; - } - - public struct PostProcessingHooks - { - public bool HumanSetupScaling; - public bool HumanCreateDeformer; - public bool HumanOnRenderMaterial; - public bool ModelRendererOnRenderMaterial; - public bool ModelRendererUnkFunc; - public bool PrepareColorTable; - public bool RenderTargetManagerInitialize; - } - - public struct ResourceLoadingHooks - { - public bool CreateFileWHook; - public bool PapHooks; - public bool ReadSqPack; - public bool IncRef; - public bool DecRef; - public bool GetResourceSync; - public bool GetResourceAsync; - public bool UpdateResourceState; - public bool CheckFileState; - public bool TexResourceHandleOnLoad; - public bool LoadMdlFileExtern; - public bool SoundOnLoad; - } - - public struct ResourceHooks - { - public bool ApricotResourceLoad; - public bool LoadMtrl; - public bool LoadMtrlTex; - public bool ResolvePathHooks; - public bool ResourceHandleDestructor; - } - - public const string FileName = "HookOverrides.json"; - - public static HookOverrides LoadFile(IDalamudPluginInterface pi) - { - var path = Path.Combine(pi.GetPluginConfigDirectory(), FileName); - if (!File.Exists(path)) - return new HookOverrides(); - - try - { - var text = File.ReadAllText(path); - var ret = JsonConvert.DeserializeObject(text)!; - ret.IsCustomLoaded = true; - Penumbra.Log.Warning("A hook override file was loaded, some hooks may be disabled and Penumbra might not be working as expected."); - return ret; - } - catch (Exception ex) - { - Penumbra.Log.Error($"A hook override file was found at {path}, but could not be loaded:\n{ex}"); - return new HookOverrides(); - } - } - - public void Write(IDalamudPluginInterface pi) - { - var path = Path.Combine(pi.GetPluginConfigDirectory(), FileName); - try - { - var text = JsonConvert.SerializeObject(this, Formatting.Indented); - File.WriteAllText(path, text); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Could not write hook override file to {path}:\n{ex}"); - } - } -} diff --git a/Penumbra/Interop/Hooks/Meta/AtchCallerHook1.cs b/Penumbra/Interop/Hooks/Meta/AtchCallerHook1.cs deleted file mode 100644 index 2a3d7468..00000000 --- a/Penumbra/Interop/Hooks/Meta/AtchCallerHook1.cs +++ /dev/null @@ -1,38 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Interop; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class AtchCallerHook1 : FastHook, IDisposable -{ - public delegate void Delegate(DrawObjectData* data, uint slot, nint unk, Model playerModel); - - private readonly CollectionResolver _collectionResolver; - private readonly MetaState _metaState; - - public AtchCallerHook1(HookManager hooks, MetaState metaState, CollectionResolver collectionResolver) - { - _metaState = metaState; - _collectionResolver = collectionResolver; - Task = hooks.CreateHook("AtchCaller1", Sigs.AtchCaller1, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.AtchCaller1); - if (!HookOverrides.Instance.Meta.AtchCaller1) - _metaState.Config.ModsEnabled += Toggle; - } - - private void Detour(DrawObjectData* data, uint slot, nint unk, Model playerModel) - { - var collection = playerModel.Valid ? _collectionResolver.IdentifyCollection(playerModel.AsDrawObject, true) : _collectionResolver.DefaultCollection; - _metaState.AtchCollection.Push(collection); - Task.Result.Original(data, slot, unk, playerModel); - _metaState.AtchCollection.Pop(); - Penumbra.Log.Excessive( - $"[AtchCaller1] Invoked on 0x{(ulong)data:X} with {slot}, {unk:X}, 0x{playerModel.Address:X}, identified to {collection.ModCollection.Identity.AnonymizedName}."); - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/AtchCallerHook2.cs b/Penumbra/Interop/Hooks/Meta/AtchCallerHook2.cs deleted file mode 100644 index af38ce50..00000000 --- a/Penumbra/Interop/Hooks/Meta/AtchCallerHook2.cs +++ /dev/null @@ -1,38 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Interop; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class AtchCallerHook2 : FastHook, IDisposable -{ - public delegate void Delegate(DrawObjectData* data, uint slot, nint unk, Model playerModel, uint unk2); - - private readonly CollectionResolver _collectionResolver; - private readonly MetaState _metaState; - - public AtchCallerHook2(HookManager hooks, MetaState metaState, CollectionResolver collectionResolver) - { - _metaState = metaState; - _collectionResolver = collectionResolver; - Task = hooks.CreateHook("AtchCaller2", Sigs.AtchCaller2, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.AtchCaller2); - if (!HookOverrides.Instance.Meta.AtchCaller2) - _metaState.Config.ModsEnabled += Toggle; - } - - private void Detour(DrawObjectData* data, uint slot, nint unk, Model playerModel, uint unk2) - { - var collection = _collectionResolver.IdentifyCollection(playerModel.AsDrawObject, true); - _metaState.AtchCollection.Push(collection); - Task.Result.Original(data, slot, unk, playerModel, unk2); - _metaState.AtchCollection.Pop(); - Penumbra.Log.Excessive( - $"[AtchCaller2] Invoked on 0x{(ulong)data:X} with {slot}, {unk:X}, 0x{playerModel.Address:X}, {unk2}, identified to {collection.ModCollection.Identity.AnonymizedName}."); - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/CalculateHeight.cs b/Penumbra/Interop/Hooks/Meta/CalculateHeight.cs index 3dac17bd..2fd87f6e 100644 --- a/Penumbra/Interop/Hooks/Meta/CalculateHeight.cs +++ b/Penumbra/Interop/Hooks/Meta/CalculateHeight.cs @@ -1,7 +1,7 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Game.Object; using OtterGui.Services; using Penumbra.Interop.PathResolving; +using Character = FFXIVClientStructs.FFXIV.Client.Game.Character.Character; namespace Penumbra.Interop.Hooks.Meta; @@ -13,21 +13,19 @@ public sealed unsafe class CalculateHeight : FastHook public CalculateHeight(HookManager hooks, CollectionResolver collectionResolver, MetaState metaState) { _collectionResolver = collectionResolver; - _metaState = metaState; - Task = hooks.CreateHook("Calculate Height", (nint)ModelContainer.MemberFunctionPointers.CalculateHeight, Detour, - !HookOverrides.Instance.Meta.CalculateHeight); + _metaState = metaState; + Task = hooks.CreateHook("Calculate Height", (nint)Character.MemberFunctionPointers.CalculateHeight, Detour, true); } - public delegate float Delegate(ModelContainer* character); + public delegate ulong Delegate(Character* character); [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private float Detour(ModelContainer* container) + private ulong Detour(Character* character) { - var collection = _collectionResolver.IdentifyCollection((GameObject*)container->OwnerObject, true); - _metaState.RspCollection.Push(collection); - var ret = Task.Result.Original.Invoke(container); - Penumbra.Log.Excessive($"[Calculate Height] Invoked on {(nint)container:X} -> {ret}."); - _metaState.RspCollection.Pop(); + var collection = _collectionResolver.IdentifyCollection((GameObject*)character, true); + using var cmp = _metaState.ResolveRspData(collection.ModCollection); + var ret = Task.Result.Original.Invoke(character); + Penumbra.Log.Excessive($"[Calculate Height] Invoked on {(nint)character:X} -> {ret}."); return ret; } } diff --git a/Penumbra/Interop/Hooks/Meta/ChangeCustomize.cs b/Penumbra/Interop/Hooks/Meta/ChangeCustomize.cs index 523ae610..2f717491 100644 --- a/Penumbra/Interop/Hooks/Meta/ChangeCustomize.cs +++ b/Penumbra/Interop/Hooks/Meta/ChangeCustomize.cs @@ -1,12 +1,12 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; using Penumbra.Collections; -using Penumbra.GameData; -using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - +using Penumbra.GameData; +using Penumbra.GameData.Structs; +using Penumbra.Interop.PathResolving; + +namespace Penumbra.Interop.Hooks.Meta; + public sealed unsafe class ChangeCustomize : FastHook { private readonly CollectionResolver _collectionResolver; @@ -16,7 +16,7 @@ public sealed unsafe class ChangeCustomize : FastHook { _collectionResolver = collectionResolver; _metaState = metaState; - Task = hooks.CreateHook("Change Customize", Sigs.UpdateDrawData, Detour, !HookOverrides.Instance.Meta.ChangeCustomize); + Task = hooks.CreateHook("Change Customize", Sigs.ChangeCustomize, Detour, true); } public delegate bool Delegate(Human* human, CustomizeArray* data, byte skipEquipment); @@ -24,15 +24,13 @@ public sealed unsafe class ChangeCustomize : FastHook [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private bool Detour(Human* human, CustomizeArray* data, byte skipEquipment) { - var collection = _collectionResolver.IdentifyCollection((DrawObject*)human, true); - _metaState.CustomizeChangeCollection = collection; - _metaState.RspCollection.Push(collection); + _metaState.CustomizeChangeCollection = _collectionResolver.IdentifyCollection((DrawObject*)human, true); + using var cmp = _metaState.ResolveRspData(_metaState.CustomizeChangeCollection.ModCollection); using var decal1 = _metaState.ResolveDecal(_metaState.CustomizeChangeCollection, true); using var decal2 = _metaState.ResolveDecal(_metaState.CustomizeChangeCollection, false); var ret = Task.Result.Original.Invoke(human, data, skipEquipment); Penumbra.Log.Excessive($"[Change Customize] Invoked on {(nint)human:X} with {(nint)data:X}, {skipEquipment} -> {ret}."); _metaState.CustomizeChangeCollection = ResolveData.Invalid; - _metaState.RspCollection.Pop(); return ret; } -} +} diff --git a/Penumbra/Interop/Hooks/Meta/EqdpAccessoryHook.cs b/Penumbra/Interop/Hooks/Meta/EqdpAccessoryHook.cs deleted file mode 100644 index 43328600..00000000 --- a/Penumbra/Interop/Hooks/Meta/EqdpAccessoryHook.cs +++ /dev/null @@ -1,37 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class EqdpAccessoryHook : FastHook, IDisposable -{ - public delegate void Delegate(CharacterUtility* utility, EqdpEntry* entry, uint id, uint raceCode); - - private readonly MetaState _metaState; - - public EqdpAccessoryHook(HookManager hooks, MetaState metaState) - { - _metaState = metaState; - Task = hooks.CreateHook("GetEqdpAccessoryEntry", Sigs.GetEqdpAccessoryEntry, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.EqdpAccessoryHook); - if (!HookOverrides.Instance.Meta.EqdpAccessoryHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private void Detour(CharacterUtility* utility, EqdpEntry* entry, uint setId, uint raceCode) - { - Task.Result.Original(utility, entry, setId, raceCode); - if (_metaState.EqdpCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache }) - *entry = cache.Eqdp.ApplyFullEntry(new PrimaryId((ushort)setId), (GenderRace)raceCode, true, *entry); - Penumbra.Log.Excessive( - $"[GetEqdpAccessoryEntry] Invoked on 0x{(ulong)utility:X} with {setId}, {(GenderRace)raceCode}, returned {(ushort)*entry:B10}."); - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/EqdpEquipHook.cs b/Penumbra/Interop/Hooks/Meta/EqdpEquipHook.cs deleted file mode 100644 index fa0d5a29..00000000 --- a/Penumbra/Interop/Hooks/Meta/EqdpEquipHook.cs +++ /dev/null @@ -1,36 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class EqdpEquipHook : FastHook, IDisposable -{ - public delegate void Delegate(CharacterUtility* utility, EqdpEntry* entry, uint id, uint raceCode); - - private readonly MetaState _metaState; - - public EqdpEquipHook(HookManager hooks, MetaState metaState) - { - _metaState = metaState; - Task = hooks.CreateHook("GetEqdpEquipEntry", Sigs.GetEqdpEquipEntry, Detour, metaState.Config.EnableMods && !HookOverrides.Instance.Meta.EqdpEquipHook); - if (!HookOverrides.Instance.Meta.EqdpEquipHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private void Detour(CharacterUtility* utility, EqdpEntry* entry, uint setId, uint raceCode) - { - Task.Result.Original(utility, entry, setId, raceCode); - if (_metaState.EqdpCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache }) - *entry = cache.Eqdp.ApplyFullEntry(new PrimaryId((ushort)setId), (GenderRace)raceCode, false, *entry); - Penumbra.Log.Excessive( - $"[GetEqdpEquipEntry] Invoked on 0x{(ulong)utility:X} with {setId}, {(GenderRace)raceCode}, returned {(ushort)*entry:B10}."); - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/EqpHook.cs b/Penumbra/Interop/Hooks/Meta/EqpHook.cs index f35b922b..6663c211 100644 --- a/Penumbra/Interop/Hooks/Meta/EqpHook.cs +++ b/Penumbra/Interop/Hooks/Meta/EqpHook.cs @@ -1,12 +1,11 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; -using Penumbra.GameData; using Penumbra.GameData.Structs; using Penumbra.Interop.PathResolving; namespace Penumbra.Interop.Hooks.Meta; -public unsafe class EqpHook : FastHook, IDisposable +public unsafe class EqpHook : FastHook { public delegate void Delegate(CharacterUtility* utility, EqpEntry* flags, CharacterArmor* armor); @@ -15,18 +14,16 @@ public unsafe class EqpHook : FastHook, IDisposable public EqpHook(HookManager hooks, MetaState metaState) { _metaState = metaState; - Task = hooks.CreateHook("GetEqpFlags", Sigs.GetEqpEntry, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.EqpHook); - if (!HookOverrides.Instance.Meta.EqpHook) - _metaState.Config.ModsEnabled += Toggle; + Task = hooks.CreateHook("GetEqpFlags", "E8 ?? ?? ?? ?? 0F B6 44 24 ?? C0 E8", Detour, true); } private void Detour(CharacterUtility* utility, EqpEntry* flags, CharacterArmor* armor) { - if (_metaState.EqpCollection.TryPeek(out var collection) && collection is { Valid: true, ModCollection.MetaCache: { } cache }) + if (_metaState.EqpCollection.Valid) { - *flags = cache.Eqp.GetValues(armor); - *flags = cache.GlobalEqp.Apply(*flags, armor); + using var eqp = _metaState.ResolveEqpData(_metaState.EqpCollection.ModCollection); + Task.Result.Original(utility, flags, armor); + *flags = _metaState.EqpCollection.ModCollection.ApplyGlobalEqp(*flags, armor); } else { @@ -35,7 +32,4 @@ public unsafe class EqpHook : FastHook, IDisposable Penumbra.Log.Excessive($"[GetEqpFlags] Invoked on 0x{(nint)utility:X} with 0x{(ulong)armor:X}, returned 0x{(ulong)*flags:X16}."); } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; } diff --git a/Penumbra/Interop/Hooks/Meta/EstHook.cs b/Penumbra/Interop/Hooks/Meta/EstHook.cs deleted file mode 100644 index 8284eb69..00000000 --- a/Penumbra/Interop/Hooks/Meta/EstHook.cs +++ /dev/null @@ -1,63 +0,0 @@ -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.Structs; -using Penumbra.Meta.Manipulations; -using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class EstHook : FastHook, IDisposable -{ - public delegate EstEntry Delegate(ResourceHandle* estResource, uint id, uint genderRace); - - private readonly CharacterUtility _characterUtility; - private readonly MetaState _metaState; - - public EstHook(HookManager hooks, MetaState metaState, CharacterUtility characterUtility) - { - _metaState = metaState; - _characterUtility = characterUtility; - Task = hooks.CreateHook("FindEstEntry", Sigs.FindEstEntry, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.EstHook); - if (!HookOverrides.Instance.Meta.EstHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private EstEntry Detour(ResourceHandle* estResource, uint genderRace, uint id) - { - EstEntry ret; - if (_metaState.EstCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache } - && cache.Est.TryGetValue(Convert(estResource, genderRace, id), out var entry)) - ret = entry.Entry; - else - ret = Task.Result.Original(estResource, genderRace, id); - - Penumbra.Log.Excessive($"[FindEstEntry] Invoked with 0x{(nint)estResource:X}, {genderRace}, {id}, returned {ret.Value}."); - return ret; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private EstIdentifier Convert(ResourceHandle* estResource, uint genderRace, uint id) - { - var i = new PrimaryId((ushort)id); - var gr = (GenderRace)genderRace; - - if (estResource == _characterUtility.Address->BodyEstResource) - return new EstIdentifier(i, EstType.Body, gr); - if (estResource == _characterUtility.Address->HairEstResource) - return new EstIdentifier(i, EstType.Hair, gr); - if (estResource == _characterUtility.Address->FaceEstResource) - return new EstIdentifier(i, EstType.Face, gr); - if (estResource == _characterUtility.Address->HeadEstResource) - return new EstIdentifier(i, EstType.Head, gr); - - return new EstIdentifier(i, 0, gr); - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/GetEqpIndirect.cs b/Penumbra/Interop/Hooks/Meta/GetEqpIndirect.cs new file mode 100644 index 00000000..beae6acc --- /dev/null +++ b/Penumbra/Interop/Hooks/Meta/GetEqpIndirect.cs @@ -0,0 +1,36 @@ +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using OtterGui.Services; +using Penumbra.Collections; +using Penumbra.GameData; +using Penumbra.Interop.PathResolving; + +namespace Penumbra.Interop.Hooks.Meta; + +public sealed unsafe class GetEqpIndirect : FastHook +{ + private readonly CollectionResolver _collectionResolver; + private readonly MetaState _metaState; + + public GetEqpIndirect(HookManager hooks, CollectionResolver collectionResolver, MetaState metaState) + { + _collectionResolver = collectionResolver; + _metaState = metaState; + Task = hooks.CreateHook("Get EQP Indirect", Sigs.GetEqpIndirect, Detour, true); + } + + public delegate void Delegate(DrawObject* drawObject); + + [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] + private void Detour(DrawObject* drawObject) + { + // Shortcut because this is also called all the time. + // Same thing is checked at the beginning of the original function. + if ((*(byte*)((nint)drawObject + Offsets.GetEqpIndirectSkip1) & 1) == 0 || *(ulong*)((nint)drawObject + Offsets.GetEqpIndirectSkip2) == 0) + return; + + Penumbra.Log.Excessive($"[Get EQP Indirect] Invoked on {(nint)drawObject:X}."); + _metaState.EqpCollection = _collectionResolver.IdentifyCollection(drawObject, true); + Task.Result.Original(drawObject); + _metaState.EqpCollection = ResolveData.Invalid; + } +} diff --git a/Penumbra/Interop/Hooks/Meta/GetEqpIndirect2.cs b/Penumbra/Interop/Hooks/Meta/GetEqpIndirect2.cs new file mode 100644 index 00000000..89aaa9b0 --- /dev/null +++ b/Penumbra/Interop/Hooks/Meta/GetEqpIndirect2.cs @@ -0,0 +1,36 @@ +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using OtterGui.Services; +using Penumbra.Collections; +using Penumbra.GameData; +using Penumbra.Interop.PathResolving; + +namespace Penumbra.Interop.Hooks.Meta; + +public sealed unsafe class GetEqpIndirect2 : FastHook +{ + private readonly CollectionResolver _collectionResolver; + private readonly MetaState _metaState; + + public GetEqpIndirect2(HookManager hooks, CollectionResolver collectionResolver, MetaState metaState) + { + _collectionResolver = collectionResolver; + _metaState = metaState; + Task = hooks.CreateHook("Get EQP Indirect 2", Sigs.GetEqpIndirect2, Detour, true); + } + + public delegate void Delegate(DrawObject* drawObject); + + [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] + private void Detour(DrawObject* drawObject) + { + // Shortcut because this is also called all the time. + // Same thing is checked at the beginning of the original function. + if (((*(uint*)((nint)drawObject + Offsets.GetEqpIndirect2Skip) >> 0x12) & 1) == 0) + return; + + Penumbra.Log.Excessive($"[Get EQP Indirect 2] Invoked on {(nint)drawObject:X}."); + _metaState.EqpCollection = _collectionResolver.IdentifyCollection(drawObject, true); + Task.Result.Original(drawObject); + _metaState.EqpCollection = ResolveData.Invalid; + } +} diff --git a/Penumbra/Interop/Hooks/Meta/GmpHook.cs b/Penumbra/Interop/Hooks/Meta/GmpHook.cs deleted file mode 100644 index d656ebdb..00000000 --- a/Penumbra/Interop/Hooks/Meta/GmpHook.cs +++ /dev/null @@ -1,43 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using Lumina.Data.Parsing.Uld; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.Interop.PathResolving; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Interop.Hooks.Meta; - -public unsafe class GmpHook : FastHook, IDisposable -{ - public delegate ulong Delegate(CharacterUtility* characterUtility, ulong* outputEntry, ushort setId); - - private readonly MetaState _metaState; - - public GmpHook(HookManager hooks, MetaState metaState) - { - _metaState = metaState; - Task = hooks.CreateHook("GetGmpEntry", Sigs.GetGmpEntry, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.GmpHook); - if (!HookOverrides.Instance.Meta.GmpHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private ulong Detour(CharacterUtility* characterUtility, ulong* outputEntry, ushort setId) - { - ulong ret; - if (_metaState.GmpCollection.TryPeek(out var collection) - && collection.Collection is { Valid: true, ModCollection.MetaCache: { } cache } - && cache.Gmp.TryGetValue(new GmpIdentifier(collection.Id), out var entry)) - ret = (*outputEntry) = entry.Entry.Enabled ? entry.Entry.Value : 0ul; - else - ret = Task.Result.Original(characterUtility, outputEntry, setId); - - Penumbra.Log.Excessive( - $"[GetGmpFlags] Invoked on 0x{(ulong)characterUtility:X} for {setId} with 0x{(ulong)outputEntry:X} (={*outputEntry:X}), returned {ret:X10}."); - return ret; - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/ModelLoadComplete.cs b/Penumbra/Interop/Hooks/Meta/ModelLoadComplete.cs index 4b9b05b1..10c12594 100644 --- a/Penumbra/Interop/Hooks/Meta/ModelLoadComplete.cs +++ b/Penumbra/Interop/Hooks/Meta/ModelLoadComplete.cs @@ -1,5 +1,6 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; +using Penumbra.Collections; using Penumbra.Interop.PathResolving; namespace Penumbra.Interop.Hooks.Meta; @@ -13,7 +14,7 @@ public sealed unsafe class ModelLoadComplete : FastHook("Model Load Complete", vtables.HumanVTable[59], Detour, !HookOverrides.Instance.Meta.ModelLoadComplete); + Task = hooks.CreateHook("Model Load Complete", vtables.HumanVTable[58], Detour, true); } public delegate void Delegate(DrawObject* drawObject); @@ -22,11 +23,10 @@ public sealed unsafe class ModelLoadComplete : FastHook, IDisposable -{ - public delegate float* Delegate(nint cmpResource, float* storage, SubRace race, byte gender, byte bodyType, byte bustSize); - - private readonly MetaState _metaState; - private readonly MetaFileManager _metaFileManager; - - public RspBustHook(HookManager hooks, MetaState metaState, MetaFileManager metaFileManager) - { - _metaState = metaState; - _metaFileManager = metaFileManager; - Task = hooks.CreateHook("GetRspBust", Sigs.GetRspBust, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.RspBustHook); - if (!HookOverrides.Instance.Meta.RspBustHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private float* Detour(nint cmpResource, float* storage, SubRace clan, byte gender, byte bodyType, byte bustSize) - { - if (gender == 0) - { - storage[0] = 1f; - storage[1] = 1f; - storage[2] = 1f; - return storage; - } - - var ret = storage; - if (bodyType < 2 - && _metaState.RspCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache }) - { - var bustScale = bustSize / 100f; - var ptr = CmpFile.GetDefaults(_metaFileManager, clan, RspAttribute.BustMinX); - storage[0] = GetValue(0, RspAttribute.BustMinX, RspAttribute.BustMaxX); - storage[1] = GetValue(1, RspAttribute.BustMinY, RspAttribute.BustMaxY); - storage[2] = GetValue(2, RspAttribute.BustMinZ, RspAttribute.BustMaxZ); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - float GetValue(int dimension, RspAttribute min, RspAttribute max) - { - var minValue = cache.Rsp.TryGetValue(new RspIdentifier(clan, min), out var minEntry) - ? minEntry.Entry.Value - : (ptr + dimension)->Value; - var maxValue = cache.Rsp.TryGetValue(new RspIdentifier(clan, max), out var maxEntry) - ? maxEntry.Entry.Value - : (ptr + 3 + dimension)->Value; - return (maxValue - minValue) * bustScale + minValue; - } - } - else - { - ret = Task.Result.Original(cmpResource, storage, clan, gender, bodyType, bustSize); - } - - Penumbra.Log.Excessive( - $"[GetRspBust] Invoked on 0x{cmpResource:X} with {clan}, {(Gender)(gender + 1)}, {bodyType}, {bustSize}, returned {storage[0]}, {storage[1]}, {storage[2]}."); - return ret; - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/RspHeightHook.cs b/Penumbra/Interop/Hooks/Meta/RspHeightHook.cs deleted file mode 100644 index 49180d6e..00000000 --- a/Penumbra/Interop/Hooks/Meta/RspHeightHook.cs +++ /dev/null @@ -1,83 +0,0 @@ -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.GameData.Enums; -using Penumbra.Interop.PathResolving; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Interop.Hooks.Meta; - -public class RspHeightHook : FastHook, IDisposable -{ - public delegate float Delegate(nint cmpResource, SubRace clan, byte gender, byte bodyType, byte height); - - private readonly MetaState _metaState; - private readonly MetaFileManager _metaFileManager; - - public RspHeightHook(HookManager hooks, MetaState metaState, MetaFileManager metaFileManager) - { - _metaState = metaState; - _metaFileManager = metaFileManager; - Task = hooks.CreateHook("GetRspHeight", Sigs.GetRspHeight, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.RspHeightHook); - if (!HookOverrides.Instance.Meta.RspHeightHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private unsafe float Detour(nint cmpResource, SubRace clan, byte gender, byte bodyType, byte height) - { - float scale; - if (bodyType < 2 - && _metaState.RspCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache }) - { - // Special cases. - if (height == 0xFF) - return 1.0f; - - if (height > 100) - height = 0; - - var (minIdent, maxIdent) = gender == 0 - ? (new RspIdentifier(clan, RspAttribute.MaleMinSize), new RspIdentifier(clan, RspAttribute.MaleMaxSize)) - : (new RspIdentifier(clan, RspAttribute.FemaleMinSize), new RspIdentifier(clan, RspAttribute.FemaleMaxSize)); - - float minEntry, maxEntry; - if (cache.Rsp.TryGetValue(minIdent, out var min)) - { - minEntry = min.Entry.Value; - maxEntry = cache.Rsp.TryGetValue(maxIdent, out var max) - ? max.Entry.Value - : CmpFile.GetDefault(_metaFileManager, minIdent.SubRace, maxIdent.Attribute).Value; - } - else - { - var ptr = CmpFile.GetDefaults(_metaFileManager, minIdent.SubRace, minIdent.Attribute); - if (cache.Rsp.TryGetValue(maxIdent, out var max)) - { - minEntry = ptr->Value; - maxEntry = max.Entry.Value; - } - else - { - minEntry = ptr[0].Value; - maxEntry = ptr[1].Value; - } - } - - scale = (maxEntry - minEntry) * height / 100f + minEntry; - } - else - { - scale = Task.Result.Original(cmpResource, clan, gender, bodyType, height); - } - - Penumbra.Log.Excessive( - $"[GetRspHeight] Invoked on 0x{cmpResource:X} with {clan}, {(Gender)(gender + 1)}, {bodyType}, {height}, returned {scale}."); - return scale; - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/RspSetupCharacter.cs b/Penumbra/Interop/Hooks/Meta/RspSetupCharacter.cs index 952a2e29..8f8f1d78 100644 --- a/Penumbra/Interop/Hooks/Meta/RspSetupCharacter.cs +++ b/Penumbra/Interop/Hooks/Meta/RspSetupCharacter.cs @@ -1,6 +1,5 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; -using Penumbra.Collections; using Penumbra.GameData; using Penumbra.Interop.PathResolving; @@ -15,7 +14,7 @@ public sealed unsafe class RspSetupCharacter : FastHook("RSP Setup Character", Sigs.RspSetupCharacter, Detour, !HookOverrides.Instance.Meta.RspSetupCharacter); + Task = hooks.CreateHook("RSP Setup Character", Sigs.RspSetupCharacter, Detour, true); } public delegate void Delegate(DrawObject* drawObject, nint unk2, float unk3, nint unk4, byte unk5); @@ -31,9 +30,8 @@ public sealed unsafe class RspSetupCharacter : FastHook, IDisposable -{ - public delegate float Delegate(nint cmpResource, Race clan, byte gender, byte isSecondSubRace, byte bodyType, byte height); - - private readonly MetaState _metaState; - private readonly MetaFileManager _metaFileManager; - - public RspTailHook(HookManager hooks, MetaState metaState, MetaFileManager metaFileManager) - { - _metaState = metaState; - _metaFileManager = metaFileManager; - Task = hooks.CreateHook("GetRspTail", Sigs.GetRspTail, Detour, - metaState.Config.EnableMods && !HookOverrides.Instance.Meta.RspTailHook); - if (!HookOverrides.Instance.Meta.RspTailHook) - _metaState.Config.ModsEnabled += Toggle; - } - - private unsafe float Detour(nint cmpResource, Race race, byte gender, byte isSecondSubRace, byte bodyType, byte tailLength) - { - float scale; - if (bodyType < 2 - && _metaState.RspCollection.TryPeek(out var collection) - && collection is { Valid: true, ModCollection.MetaCache: { } cache }) - { - var clan = (SubRace)(((int)race - 1) * 2 + 1 + isSecondSubRace); - var (minIdent, maxIdent) = gender == 0 - ? (new RspIdentifier(clan, RspAttribute.MaleMinTail), new RspIdentifier(clan, RspAttribute.MaleMaxTail)) - : (new RspIdentifier(clan, RspAttribute.FemaleMinTail), new RspIdentifier(clan, RspAttribute.FemaleMaxTail)); - - float minEntry, maxEntry; - if (cache.Rsp.TryGetValue(minIdent, out var min)) - { - minEntry = min.Entry.Value; - maxEntry = cache.Rsp.TryGetValue(maxIdent, out var max) - ? max.Entry.Value - : CmpFile.GetDefault(_metaFileManager, minIdent.SubRace, maxIdent.Attribute).Value; - } - else - { - var ptr = CmpFile.GetDefaults(_metaFileManager, minIdent.SubRace, minIdent.Attribute); - if (cache.Rsp.TryGetValue(maxIdent, out var max)) - { - minEntry = ptr->Value; - maxEntry = max.Entry.Value; - } - else - { - minEntry = ptr[0].Value; - maxEntry = ptr[1].Value; - } - } - - scale = (maxEntry - minEntry) * tailLength / 100f + minEntry; - } - else - { - scale = Task.Result.Original(cmpResource, race, gender, isSecondSubRace, bodyType, tailLength); - } - - Penumbra.Log.Excessive( - $"[GetRspTail] Invoked on 0x{cmpResource:X} with {race}, {(Gender)(gender + 1)}, {isSecondSubRace == 1}, {bodyType}, {tailLength}, returned {scale}."); - return scale; - } - - public void Dispose() - => _metaState.Config.ModsEnabled -= Toggle; -} diff --git a/Penumbra/Interop/Hooks/Meta/SetupVisor.cs b/Penumbra/Interop/Hooks/Meta/SetupVisor.cs index 063a9462..e451f118 100644 --- a/Penumbra/Interop/Hooks/Meta/SetupVisor.cs +++ b/Penumbra/Interop/Hooks/Meta/SetupVisor.cs @@ -1,11 +1,10 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.GameData; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using OtterGui.Services; +using Penumbra.GameData; +using Penumbra.Interop.PathResolving; + +namespace Penumbra.Interop.Hooks.Meta; + /// /// GMP. This gets called every time when changing visor state, and it accesses the gmp file itself, /// but it only applies a changed gmp file after a redraw for some reason. @@ -19,7 +18,7 @@ public sealed unsafe class SetupVisor : FastHook { _collectionResolver = collectionResolver; _metaState = metaState; - Task = hooks.CreateHook("Setup Visor", Sigs.SetupVisor, Detour, !HookOverrides.Instance.Meta.SetupVisor); + Task = hooks.CreateHook("Setup Visor", Sigs.SetupVisor, Detour, true); } public delegate byte Delegate(DrawObject* drawObject, ushort modelId, byte visorState); @@ -27,11 +26,10 @@ public sealed unsafe class SetupVisor : FastHook [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private byte Detour(DrawObject* drawObject, ushort modelId, byte visorState) { - var collection = _collectionResolver.IdentifyCollection(drawObject, true); - _metaState.GmpCollection.Push((collection, modelId)); - var ret = Task.Result.Original.Invoke(drawObject, modelId, visorState); + var collection = _collectionResolver.IdentifyCollection(drawObject, true); + using var gmp = _metaState.ResolveGmpData(collection.ModCollection); + var ret = Task.Result.Original.Invoke(drawObject, modelId, visorState); Penumbra.Log.Excessive($"[Setup Visor] Invoked on {(nint)drawObject:X} with {modelId}, {visorState} -> {ret}."); - _metaState.GmpCollection.Pop(); return ret; } } diff --git a/Penumbra/Interop/Hooks/Meta/UpdateModel.cs b/Penumbra/Interop/Hooks/Meta/UpdateModel.cs index 9189ce3b..b0298ac7 100644 --- a/Penumbra/Interop/Hooks/Meta/UpdateModel.cs +++ b/Penumbra/Interop/Hooks/Meta/UpdateModel.cs @@ -15,7 +15,7 @@ public sealed unsafe class UpdateModel : FastHook { _collectionResolver = collectionResolver; _metaState = metaState; - Task = hooks.CreateHook("Update Model", Sigs.UpdateModel, Detour, !HookOverrides.Instance.Meta.UpdateModel); + Task = hooks.CreateHook("Update Model", Sigs.UpdateModel, Detour, true); } public delegate void Delegate(DrawObject* drawObject); @@ -25,15 +25,14 @@ public sealed unsafe class UpdateModel : FastHook { // Shortcut because this is called all the time. // Same thing is checked at the beginning of the original function. - if (*(int*)((nint)drawObject + VolatileOffsets.UpdateModel.ShortCircuit) == 0) + if (*(int*)((nint)drawObject + Offsets.UpdateModelSkip) == 0) return; Penumbra.Log.Excessive($"[Update Model] Invoked on {(nint)drawObject:X}."); - var collection = _collectionResolver.IdentifyCollection(drawObject, true); - _metaState.EqpCollection.Push(collection); - _metaState.EqdpCollection.Push(collection); + var collection = _collectionResolver.IdentifyCollection(drawObject, true); + using var eqdp = _metaState.ResolveEqdpData(collection.ModCollection, MetaState.GetDrawObjectGenderRace((nint)drawObject), true, true); + _metaState.EqpCollection = collection; Task.Result.Original(drawObject); - _metaState.EqpCollection.Pop(); - _metaState.EqdpCollection.Pop(); + _metaState.EqpCollection = ResolveData.Invalid; } } diff --git a/Penumbra/Interop/Hooks/Meta/UpdateRender.cs b/Penumbra/Interop/Hooks/Meta/UpdateRender.cs deleted file mode 100644 index ef0068b6..00000000 --- a/Penumbra/Interop/Hooks/Meta/UpdateRender.cs +++ /dev/null @@ -1,31 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Services; -using Penumbra.Interop.PathResolving; - -namespace Penumbra.Interop.Hooks.Meta; - -/// The actual function is inlined, so we need to hook its only callsite: Human.UpdateRender instead. -public sealed unsafe class UpdateRender : FastHook -{ - private readonly CollectionResolver _collectionResolver; - private readonly MetaState _metaState; - - public UpdateRender(HookManager hooks, CollectionResolver collectionResolver, MetaState metaState, CharacterBaseVTables vTables) - { - _collectionResolver = collectionResolver; - _metaState = metaState; - Task = hooks.CreateHook("Human.UpdateRender", vTables.HumanVTable[4], Detour, !HookOverrides.Instance.Meta.UpdateRender); - } - - public delegate void Delegate(DrawObject* drawObject); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private void Detour(DrawObject* drawObject) - { - Penumbra.Log.Excessive($"[Human.UpdateRender] Invoked on {(nint)drawObject:X}."); - var collection = _collectionResolver.IdentifyCollection(drawObject, true); - _metaState.EqpCollection.Push(collection); - Task.Result.Original(drawObject); - _metaState.EqpCollection.Pop(); - } -} diff --git a/Penumbra/Interop/Hooks/Objects/CharacterBaseDestructor.cs b/Penumbra/Interop/Hooks/Objects/CharacterBaseDestructor.cs index 2d8e60b2..e01a6550 100644 --- a/Penumbra/Interop/Hooks/Objects/CharacterBaseDestructor.cs +++ b/Penumbra/Interop/Hooks/Objects/CharacterBaseDestructor.cs @@ -2,6 +2,7 @@ using Dalamud.Hooking; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Classes; using OtterGui.Services; +using Penumbra.UI.AdvancedWindow; namespace Penumbra.Interop.Hooks.Objects; @@ -12,13 +13,13 @@ public sealed unsafe class CharacterBaseDestructor : EventWrapperPtr DrawObjectState = 0, - /// + /// MtrlTab = -1000, } public CharacterBaseDestructor(HookManager hooks) : base("Destroy CharacterBase") - => _task = hooks.CreateHook(Name, Address, Detour, !HookOverrides.Instance.Objects.CharacterBaseDestructor); + => _task = hooks.CreateHook(Name, Address, Detour, true); private readonly Task> _task; @@ -41,7 +42,7 @@ public sealed unsafe class CharacterBaseDestructor : EventWrapperPtr IdentifiedCollectionCache = 0, - - /// - DrawObjectState = 0, } public CharacterDestructor(HookManager hooks) : base("Character Destructor") - => _task = hooks.CreateHook(Name, Sigs.CharacterDestructor, Detour, !HookOverrides.Instance.Objects.CharacterDestructor); + => _task = hooks.CreateHook(Name, Sigs.CharacterDestructor, Detour, true); private readonly Task> _task; @@ -45,7 +42,7 @@ public sealed unsafe class CharacterDestructor : EventWrapperPtr, IHookService -{ - private readonly GameState _gameState; - private readonly ObjectManager _objects; - - public enum Priority - { - /// - CutsceneService = 0, - } - - public ConstructCutsceneCharacter(GameState gameState, HookManager hooks, ObjectManager objects) - : base("ConstructCutsceneCharacter") - { - _gameState = gameState; - _objects = objects; - _task = hooks.CreateHook(Name, Sigs.ConstructCutsceneCharacter, Detour, !HookOverrides.Instance.Objects.ConstructCutsceneCharacter); - } - - private readonly Task> _task; - - public delegate int Delegate(SetupPlayerNpc.SchedulerStruct* scheduler); - - public int Detour(SetupPlayerNpc.SchedulerStruct* scheduler) - { - // This is the function that actually creates the new game object - // and fills it into the object table at a free index etc. - var ret = _task.Result.Original(scheduler); - // Check for the copy state from SetupPlayerNpc. - if (_gameState.CharacterAssociated.Value) - { - // If the newly created character exists, invoke the event. - var character = _objects[ret + (int)ScreenActor.CutsceneStart].AsCharacter; - if (character != null) - { - Invoke(character); - Penumbra.Log.Verbose( - $"[{Name}] Created indirect copy of player character at 0x{(nint)character}, index {character->ObjectIndex}."); - } - _gameState.CharacterAssociated.Value = false; - } - - return ret; - } - - public IntPtr Address - => _task.Result.Address; - - public void Enable() - => _task.Result.Enable(); - - public void Disable() - => _task.Result.Disable(); - - public Task Awaiter - => _task; - - public bool Finished - => _task.IsCompletedSuccessfully; -} diff --git a/Penumbra/Interop/Hooks/Objects/CopyCharacter.cs b/Penumbra/Interop/Hooks/Objects/CopyCharacter.cs index bc18a7ad..7b730f84 100644 --- a/Penumbra/Interop/Hooks/Objects/CopyCharacter.cs +++ b/Penumbra/Interop/Hooks/Objects/CopyCharacter.cs @@ -9,18 +9,18 @@ public sealed unsafe class CopyCharacter : EventWrapperPtr + /// CutsceneService = 0, } public CopyCharacter(HookManager hooks) : base("Copy Character") - => _task = hooks.CreateHook(Name, Address, Detour, !HookOverrides.Instance.Objects.CopyCharacter); + => _task = hooks.CreateHook(Name, Address, Detour, true); private readonly Task> _task; public nint Address - => (nint)CharacterSetupContainer.MemberFunctionPointers.CopyFromCharacter; + => (nint)CharacterSetup.MemberFunctionPointers.CopyFromCharacter; public void Enable() => _task.Result.Enable(); @@ -34,11 +34,12 @@ public sealed unsafe class CopyCharacter : EventWrapperPtr _task.IsCompletedSuccessfully; - private delegate ulong Delegate(CharacterSetupContainer* target, Character* source, uint unk); + private delegate ulong Delegate(CharacterSetup* target, Character* source, uint unk); - private ulong Detour(CharacterSetupContainer* target, Character* source, uint unk) + private ulong Detour(CharacterSetup* target, Character* source, uint unk) { - var character = target->OwnerObject; + // TODO: update when CS updated. + var character = ((Character**)target)[1]; Penumbra.Log.Verbose($"[{Name}] Triggered with target: 0x{(nint)target:X}, source : 0x{(nint)source:X} unk: {unk}."); Invoke(character, source); return _task.Result.Original(target, source, unk); diff --git a/Penumbra/Interop/Hooks/Objects/CreateCharacterBase.cs b/Penumbra/Interop/Hooks/Objects/CreateCharacterBase.cs index e29876ac..299f312a 100644 --- a/Penumbra/Interop/Hooks/Objects/CreateCharacterBase.cs +++ b/Penumbra/Interop/Hooks/Objects/CreateCharacterBase.cs @@ -10,13 +10,13 @@ public sealed unsafe class CreateCharacterBase : EventWrapperPtr + /// MetaState = 0, } public CreateCharacterBase(HookManager hooks) : base("Create CharacterBase") - => _task = hooks.CreateHook(Name, Address, Detour, !HookOverrides.Instance.Objects.CreateCharacterBase); + => _task = hooks.CreateHook(Name, Address, Detour, true); private readonly Task> _task; @@ -64,10 +64,10 @@ public sealed unsafe class CreateCharacterBase : EventWrapperPtr + /// DrawObjectState = 0, - /// + /// MetaState = 0, } } diff --git a/Penumbra/Interop/Hooks/Objects/EnableDraw.cs b/Penumbra/Interop/Hooks/Objects/EnableDraw.cs index 979cb87c..267b4711 100644 --- a/Penumbra/Interop/Hooks/Objects/EnableDraw.cs +++ b/Penumbra/Interop/Hooks/Objects/EnableDraw.cs @@ -17,7 +17,7 @@ public sealed unsafe class EnableDraw : IHookService public EnableDraw(HookManager hooks, GameState state) { _state = state; - _task = hooks.CreateHook("Enable Draw", Sigs.EnableDraw, Detour, !HookOverrides.Instance.Objects.EnableDraw); + _task = hooks.CreateHook("Enable Draw", Sigs.EnableDraw, Detour, true); } private delegate void Delegate(GameObject* gameObject); @@ -26,7 +26,7 @@ public sealed unsafe class EnableDraw : IHookService private void Detour(GameObject* gameObject) { _state.QueueGameObject(gameObject); - Penumbra.Log.Excessive($"[Enable Draw] Invoked on 0x{(nint)gameObject:X} at {gameObject->ObjectIndex}."); + Penumbra.Log.Excessive($"[Enable Draw] Invoked on 0x{(nint)gameObject:X}."); _task.Result.Original.Invoke(gameObject); _state.DequeueGameObject(); } diff --git a/Penumbra/Interop/Hooks/Objects/SetupPlayerNpc.cs b/Penumbra/Interop/Hooks/Objects/SetupPlayerNpc.cs deleted file mode 100644 index 8f1226c3..00000000 --- a/Penumbra/Interop/Hooks/Objects/SetupPlayerNpc.cs +++ /dev/null @@ -1,55 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Game.Character; -using OtterGui.Services; -using Penumbra.GameData; - -namespace Penumbra.Interop.Hooks.Objects; - -public sealed unsafe class SetupPlayerNpc : FastHook -{ - private readonly GameState _gameState; - - public SetupPlayerNpc(GameState gameState, HookManager hooks) - { - _gameState = gameState; - Task = hooks.CreateHook("SetupPlayerNPC", Sigs.SetupPlayerNpc, Detour, - !HookOverrides.Instance.Objects.SetupPlayerNpc); - } - - public delegate SchedulerStruct* Delegate(byte* npcType, nint unk, NpcSetupData* setupData); - - public SchedulerStruct* Detour(byte* npcType, nint unk, NpcSetupData* setupData) - { - // This function actually seems to generate all NPC. - - // If an ENPC is being created, check the creation parameters. - // If CopyPlayerCustomize is true, the event NPC gets a timeline that copies its customize and glasses from the local player. - // Keep track of this, so we can associate the actor to be created for this with the player character, see ConstructCutsceneCharacter. - if (setupData->CopyPlayerCustomize && npcType != null && *npcType is 8) - _gameState.CharacterAssociated.Value = true; - - var ret = Task.Result.Original.Invoke(npcType, unk, setupData); - Penumbra.Log.Excessive( - $"[Setup Player NPC] Invoked for type {*npcType} with 0x{unk:X} and Copy Player Customize: {setupData->CopyPlayerCustomize}."); - return ret; - } - - [StructLayout(LayoutKind.Explicit)] - public struct NpcSetupData - { - [FieldOffset(0x0B)] - private byte _copyPlayerCustomize; - - public bool CopyPlayerCustomize - { - get => _copyPlayerCustomize != 0; - set => _copyPlayerCustomize = value ? (byte)1 : (byte)0; - } - } - - [StructLayout(LayoutKind.Explicit)] - public struct SchedulerStruct - { - public static Character* GetCharacter(SchedulerStruct* s) - => ((delegate* unmanaged**)s)[0][19](s); - } -} diff --git a/Penumbra/Interop/Hooks/Objects/WeaponReload.cs b/Penumbra/Interop/Hooks/Objects/WeaponReload.cs index 4231b027..31c6b883 100644 --- a/Penumbra/Interop/Hooks/Objects/WeaponReload.cs +++ b/Penumbra/Interop/Hooks/Objects/WeaponReload.cs @@ -16,7 +16,7 @@ public sealed unsafe class WeaponReload : EventWrapperPtr _task = hooks.CreateHook(Name, Address, Detour, !HookOverrides.Instance.Objects.WeaponReload); + => _task = hooks.CreateHook(Name, Address, Detour, true); private readonly Task> _task; @@ -35,14 +35,14 @@ public sealed unsafe class WeaponReload : EventWrapperPtr _task.IsCompletedSuccessfully; - private delegate void Delegate(DrawDataContainer* drawData, uint slot, ulong weapon, byte d, byte e, byte f, byte g, byte h); + private delegate void Delegate(DrawDataContainer* drawData, uint slot, ulong weapon, byte d, byte e, byte f, byte g); - private void Detour(DrawDataContainer* drawData, uint slot, ulong weapon, byte d, byte e, byte f, byte g, byte h) + private void Detour(DrawDataContainer* drawData, uint slot, ulong weapon, byte d, byte e, byte f, byte g) { - var gameObject = drawData->OwnerObject; - Penumbra.Log.Verbose($"[{Name}] Triggered with drawData: 0x{(nint)drawData:X}, {slot}, {weapon}, {d}, {e}, {f}, {g}, {h}."); + var gameObject = drawData->Parent; + Penumbra.Log.Verbose($"[{Name}] Triggered with drawData: 0x{(nint)drawData:X}, {slot}, {weapon}, {d}, {e}, {f}, {g}."); Invoke(drawData, gameObject, (CharacterWeapon*)(&weapon)); - _task.Result.Original(drawData, slot, weapon, d, e, f, g, h); + _task.Result.Original(drawData, slot, weapon, d, e, f, g); _postEvent.Invoke(drawData, gameObject); } diff --git a/Penumbra/Interop/Hooks/PostProcessing/AttributeHook.cs b/Penumbra/Interop/Hooks/PostProcessing/AttributeHook.cs deleted file mode 100644 index 00e5851f..00000000 --- a/Penumbra/Interop/Hooks/PostProcessing/AttributeHook.cs +++ /dev/null @@ -1,85 +0,0 @@ -using Dalamud.Hooking; -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.GameData; -using Penumbra.GameData.Interop; -using Penumbra.Interop.PathResolving; -using Penumbra.Meta; - -namespace Penumbra.Interop.Hooks.PostProcessing; - -/// -/// Triggered whenever a model recomputes its attribute masks. -/// -/// Parameter is the game object that recomputed its attributes. -/// Parameter is the draw object on which the recomputation was called. -/// Parameter is the collection associated with the game object. -/// Parameter is the slot that was recomputed. If this is Unknown, it is a general new update call. -/// -public sealed unsafe class AttributeHook : EventWrapper, IHookService -{ - public enum Priority - { - /// - ShapeAttributeManager = 0, - } - - private readonly CollectionResolver _resolver; - private readonly Configuration _config; - - public AttributeHook(HookManager hooks, Configuration config, CollectionResolver resolver) - : base("Update Model Attributes") - { - _config = config; - _resolver = resolver; - _task = hooks.CreateHook(Name, Sigs.UpdateAttributes, Detour, config.EnableCustomShapes); - } - - private readonly Task> _task; - - public nint Address - => _task.Result.Address; - - public void Enable() - => SetState(true); - - public void Disable() - => SetState(false); - - public void SetState(bool enabled) - { - if (_config.EnableCustomShapes == enabled) - return; - - _config.EnableCustomShapes = enabled; - _config.Save(); - if (enabled) - _task.Result.Enable(); - else - _task.Result.Disable(); - } - - - public Task Awaiter - => _task; - - public bool Finished - => _task.IsCompletedSuccessfully; - - private delegate void Delegate(Human* human); - - private void Detour(Human* human) - { - _task.Result.Original(human); - var resolveData = _resolver.IdentifyCollection((DrawObject*)human, true); - var identifiedActor = resolveData.AssociatedGameObject; - var identifiedCollection = resolveData.ModCollection; - Penumbra.Log.Excessive($"[{Name}] Invoked on 0x{(ulong)human:X} (0x{identifiedActor:X})."); - Invoke(identifiedActor, human, identifiedCollection); - } - - protected override void Dispose(bool disposing) - => _task.Result.Dispose(); -} diff --git a/Penumbra/Interop/Hooks/PostProcessing/HumanSetupScalingHook.cs b/Penumbra/Interop/Hooks/PostProcessing/HumanSetupScalingHook.cs deleted file mode 100644 index 870229d6..00000000 --- a/Penumbra/Interop/Hooks/PostProcessing/HumanSetupScalingHook.cs +++ /dev/null @@ -1,54 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Services; - -namespace Penumbra.Interop.Hooks.PostProcessing; - -// TODO: "SetupScaling" does not seem to only set up scaling -> find a better name? -public unsafe class HumanSetupScalingHook : FastHook -{ - private const int ReplacementCapacity = 2; - - public event EventDelegate? SetupReplacements; - - public HumanSetupScalingHook(HookManager hooks, CharacterBaseVTables vTables) - => Task = hooks.CreateHook("Human.SetupScaling", vTables.HumanVTable[58], Detour, - !HookOverrides.Instance.PostProcessing.HumanSetupScaling); - - private void Detour(CharacterBase* drawObject, uint slotIndex) - { - Span replacements = stackalloc Replacement[ReplacementCapacity]; - var numReplacements = 0; - IDisposable? pbdDisposable = null; - object? shpkLock = null; - var releaseLock = false; - - try - { - SetupReplacements?.Invoke(drawObject, slotIndex, replacements, ref numReplacements, ref pbdDisposable, ref shpkLock); - if (shpkLock != null) - { - Monitor.Enter(shpkLock); - releaseLock = true; - } - - for (var i = 0; i < numReplacements; ++i) - *(nint*)replacements[i].AddressToReplace = replacements[i].ValueToSet; - Task.Result.Original(drawObject, slotIndex); - } - finally - { - for (var i = numReplacements; i-- > 0;) - *(nint*)replacements[i].AddressToReplace = replacements[i].ValueToRestore; - if (releaseLock) - Monitor.Exit(shpkLock!); - pbdDisposable?.Dispose(); - } - } - - public delegate void Delegate(CharacterBase* drawObject, uint slotIndex); - - public delegate void EventDelegate(CharacterBase* drawObject, uint slotIndex, Span replacements, ref int numReplacements, - ref IDisposable? pbdDisposable, ref object? shpkLock); - - public readonly record struct Replacement(nint AddressToReplace, nint ValueToSet, nint ValueToRestore); -} diff --git a/Penumbra/Interop/Hooks/PostProcessing/RenderTargetHdrEnabler.cs b/Penumbra/Interop/Hooks/PostProcessing/RenderTargetHdrEnabler.cs deleted file mode 100644 index 653d9c1a..00000000 --- a/Penumbra/Interop/Hooks/PostProcessing/RenderTargetHdrEnabler.cs +++ /dev/null @@ -1,170 +0,0 @@ -using System.Collections.Immutable; -using Dalamud.Hooking; -using Dalamud.Plugin; -using Dalamud.Plugin.Services; -using Dalamud.Utility.Signatures; -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.Graphics.Render; -using OtterGui.Services; -using Penumbra.GameData; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Services; - -namespace Penumbra.Interop.Hooks.PostProcessing; - -public unsafe class RenderTargetHdrEnabler : IService, IDisposable -{ - /// This array must be sorted by CreationOrder ascending. - private static readonly ImmutableArray ForcedTextureConfigs = - [ - new ForcedTextureConfig(9, TextureFormat.R16G16B16A16_FLOAT, "Opaque Diffuse GBuffer"), - new ForcedTextureConfig(10, TextureFormat.R16G16B16A16_FLOAT, "Semitransparent Diffuse GBuffer"), - ]; - - private static readonly IComparer ForcedTextureConfigComparer - = Comparer.Create((lhs, rhs) => lhs.CreationOrder.CompareTo(rhs.CreationOrder)); - - private readonly Configuration _config; - private readonly Tuple _share; - private readonly ThreadLocal _textureIndices = new(() => new TextureIndices(-1, -1)); - - private readonly ThreadLocal?> _textures = new(() => null); - - public TextureReportRecord[]? TextureReport { get; private set; } - - private readonly Hook? _renderTargetManagerInitialize; - private readonly Hook? _createTexture2D; - - public RenderTargetHdrEnabler(IGameInteropProvider interop, Configuration config, IDalamudPluginInterface pi, - DalamudConfigService dalamudConfig, PeSigScanner peScanner) - { - _config = config; - if (peScanner.TryScanText(Sigs.RenderTargetManagerInitialize, out var initializeAddress) - && peScanner.TryScanText(Sigs.DeviceCreateTexture2D, out var createAddress)) - { - _renderTargetManagerInitialize = - interop.HookFromAddress(initializeAddress, RenderTargetManagerInitializeDetour); - _createTexture2D = interop.HookFromAddress(createAddress, CreateTexture2DDetour); - - if (config.HdrRenderTargets && !HookOverrides.Instance.PostProcessing.RenderTargetManagerInitialize) - _renderTargetManagerInitialize.Enable(); - } - - _share = pi.GetOrCreateData("Penumbra.RenderTargetHDR.V1", () => - { - bool? waitForPlugins = dalamudConfig.GetDalamudConfig(DalamudConfigService.WaitingForPluginsOption, out bool s) ? s : null; - return new Tuple(waitForPlugins, config.HdrRenderTargets, - !HookOverrides.Instance.PostProcessing.RenderTargetManagerInitialize, [0], [false]); - }); - ++_share.Item4[0]; - } - - public bool? FirstLaunchWaitForPluginsState - => _share.Item1; - - public bool FirstLaunchHdrState - => _share.Item2; - - public bool FirstLaunchHdrHookOverrideState - => _share.Item3; - - public int PenumbraReloadCount - => _share.Item4[0]; - - public bool HdrEnabledSuccess - => _share.Item5[0]; - - ~RenderTargetHdrEnabler() - => Dispose(false); - - - public static ForcedTextureConfig? GetForcedTextureConfig(int creationOrder) - { - var i = ForcedTextureConfigs.BinarySearch(new ForcedTextureConfig(creationOrder, 0, string.Empty), ForcedTextureConfigComparer); - return i >= 0 ? ForcedTextureConfigs[i] : null; - } - - public void Dispose() - { - Dispose(true); - GC.SuppressFinalize(this); - } - - private void Dispose(bool _) - { - _createTexture2D?.Dispose(); - _renderTargetManagerInitialize?.Dispose(); - } - - private nint RenderTargetManagerInitializeDetour(RenderTargetManager* @this) - { - _createTexture2D!.Enable(); - _share.Item5[0] = true; - _textureIndices.Value = new TextureIndices(0, 0); - _textures.Value = _config.DebugMode ? [] : null; - try - { - return _renderTargetManagerInitialize!.Original(@this); - } - finally - { - if (_textures.Value != null) - { - TextureReport = CreateTextureReport(@this, _textures.Value); - _textures.Value = null; - } - - _textureIndices.Value = new TextureIndices(-1, -1); - _createTexture2D.Disable(); - } - } - - private Texture* CreateTexture2DDetour( - Device* @this, int* size, byte mipLevel, uint textureFormat, uint flags, uint unk) - { - var originalTextureFormat = textureFormat; - var indices = _textureIndices.IsValueCreated ? _textureIndices.Value : new TextureIndices(-1, -1); - if (indices.ConfigIndex >= 0 - && indices.ConfigIndex < ForcedTextureConfigs.Length - && ForcedTextureConfigs[indices.ConfigIndex].CreationOrder == indices.CreationOrder) - { - var config = ForcedTextureConfigs[indices.ConfigIndex++]; - textureFormat = (uint)config.ForcedTextureFormat; - } - - if (indices.CreationOrder >= 0) - { - ++indices.CreationOrder; - _textureIndices.Value = indices; - } - - var texture = _createTexture2D!.Original(@this, size, mipLevel, textureFormat, flags, unk); - if (_textures.IsValueCreated) - _textures.Value?.Add((nint)texture, (indices.CreationOrder - 1, originalTextureFormat)); - return texture; - } - - private static TextureReportRecord[] CreateTextureReport(RenderTargetManager* renderTargetManager, - Dictionary textures) - { - var rtmTextures = new Span(renderTargetManager, sizeof(RenderTargetManager) / sizeof(nint)); - var report = new List(); - for (var i = 0; i < rtmTextures.Length; ++i) - { - if (textures.TryGetValue(rtmTextures[i], out var texture)) - report.Add(new TextureReportRecord(i * sizeof(nint), texture.TextureIndex, (TextureFormat)texture.TextureFormat)); - } - - return report.ToArray(); - } - - private delegate nint RenderTargetManagerInitializeFunc(RenderTargetManager* @this); - - private delegate Texture* CreateTexture2DFunc(Device* @this, int* size, byte mipLevel, uint textureFormat, uint flags, uint unk); - - private record struct TextureIndices(int CreationOrder, int ConfigIndex); - - public readonly record struct ForcedTextureConfig(int CreationOrder, TextureFormat ForcedTextureFormat, string Comment); - - public readonly record struct TextureReportRecord(nint Offset, int CreationOrder, TextureFormat OriginalTextureFormat); -} diff --git a/Penumbra/Interop/Hooks/PostProcessing/ShaderReplacementFixer.cs b/Penumbra/Interop/Hooks/PostProcessing/ShaderReplacementFixer.cs deleted file mode 100644 index b9c21556..00000000 --- a/Penumbra/Interop/Hooks/PostProcessing/ShaderReplacementFixer.cs +++ /dev/null @@ -1,565 +0,0 @@ -using Dalamud.Hooking; -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.Graphics.Render; -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; -using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Communication; -using Penumbra.GameData; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.Interop.Hooks.Resources; -using Penumbra.Interop.Structs; -using Penumbra.Services; -using Penumbra.String.Classes; -using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; -using CSModelRenderer = FFXIVClientStructs.FFXIV.Client.Graphics.Render.ModelRenderer; -using ModelRenderer = Penumbra.Interop.Services.ModelRenderer; - -namespace Penumbra.Interop.Hooks.PostProcessing; - -public sealed unsafe class ShaderReplacementFixer : IDisposable, IRequiredService -{ - public static ReadOnlySpan SkinShpkName - => "skin.shpk"u8; - - public static ReadOnlySpan CharacterStockingsShpkName - => "characterstockings.shpk"u8; - - public static ReadOnlySpan CharacterLegacyShpkName - => "characterlegacy.shpk"u8; - - public static ReadOnlySpan IrisShpkName - => "iris.shpk"u8; - - public static ReadOnlySpan CharacterGlassShpkName - => "characterglass.shpk"u8; - - public static ReadOnlySpan CharacterTransparencyShpkName - => "charactertransparency.shpk"u8; - - public static ReadOnlySpan CharacterTattooShpkName - => "charactertattoo.shpk"u8; - - public static ReadOnlySpan CharacterOcclusionShpkName - => "characterocclusion.shpk"u8; - - public static ReadOnlySpan HairMaskShpkName - => "hairmask.shpk"u8; - - private delegate nint CharacterBaseOnRenderMaterialDelegate(CharacterBase* drawObject, CSModelRenderer.OnRenderMaterialParams* param); - - private delegate nint ModelRendererOnRenderMaterialDelegate(CSModelRenderer* modelRenderer, ushort* outFlags, - CSModelRenderer.OnRenderModelParams* param, Material* material, uint materialIndex); - - private delegate void ModelRendererUnkFuncDelegate(CSModelRenderer* modelRenderer, ModelRendererStructs.UnkPayload* unkPayload, uint unk2, - uint unk3, uint unk4, uint unk5); - - private readonly Hook _humanOnRenderMaterialHook; - - private readonly Hook _modelRendererOnRenderMaterialHook; - - private readonly Hook _modelRendererUnkFuncHook; - - private readonly Hook _prepareColorTableHook; - - private readonly ResourceHandleDestructor _resourceHandleDestructor; - private readonly CommunicatorService _communicator; - private readonly HumanSetupScalingHook _humanSetupScalingHook; - - private readonly ModdedShaderPackageState _skinState; - private readonly ModdedShaderPackageState _characterStockingsState; - private readonly ModdedShaderPackageState _characterLegacyState; - private readonly ModdedShaderPackageState _irisState; - private readonly ModdedShaderPackageState _characterGlassState; - private readonly ModdedShaderPackageState _characterTransparencyState; - private readonly ModdedShaderPackageState _characterTattooState; - private readonly ModdedShaderPackageState _characterOcclusionState; - private readonly ModdedShaderPackageState _hairMaskState; - - public bool Enabled { get; internal set; } = true; - - public uint ModdedSkinShpkCount - => _skinState.MaterialCount; - - public uint ModdedCharacterStockingsShpkCount - => _characterStockingsState.MaterialCount; - - public uint ModdedCharacterLegacyShpkCount - => _characterLegacyState.MaterialCount; - - public uint ModdedIrisShpkCount - => _irisState.MaterialCount; - - public uint ModdedCharacterGlassShpkCount - => _characterGlassState.MaterialCount; - - public uint ModdedCharacterTransparencyShpkCount - => _characterTransparencyState.MaterialCount; - - public uint ModdedCharacterTattooShpkCount - => _characterTattooState.MaterialCount; - - public uint ModdedCharacterOcclusionShpkCount - => _characterOcclusionState.MaterialCount; - - public uint ModdedHairMaskShpkCount - => _hairMaskState.MaterialCount; - - public ShaderReplacementFixer(ResourceHandleDestructor resourceHandleDestructor, CharacterUtility utility, ModelRenderer modelRenderer, - CommunicatorService communicator, HookManager hooks, CharacterBaseVTables vTables, HumanSetupScalingHook humanSetupScalingHook) - { - _resourceHandleDestructor = resourceHandleDestructor; - _communicator = communicator; - _humanSetupScalingHook = humanSetupScalingHook; - - _skinState = new ModdedShaderPackageState( - () => (ShaderPackageResourceHandle**)&utility.Address->SkinShpkResource, - () => (ShaderPackageResourceHandle*)utility.DefaultSkinShpkResource); - _characterStockingsState = new ModdedShaderPackageState( - () => (ShaderPackageResourceHandle**)&utility.Address->CharacterStockingsShpkResource, - () => (ShaderPackageResourceHandle*)utility.DefaultCharacterStockingsShpkResource); - _characterLegacyState = new ModdedShaderPackageState( - () => (ShaderPackageResourceHandle**)&utility.Address->CharacterLegacyShpkResource, - () => (ShaderPackageResourceHandle*)utility.DefaultCharacterLegacyShpkResource); - _irisState = new ModdedShaderPackageState(() => modelRenderer.IrisShaderPackage, () => modelRenderer.DefaultIrisShaderPackage); - _characterGlassState = new ModdedShaderPackageState(() => modelRenderer.CharacterGlassShaderPackage, - () => modelRenderer.DefaultCharacterGlassShaderPackage); - _characterTransparencyState = new ModdedShaderPackageState(() => modelRenderer.CharacterTransparencyShaderPackage, - () => modelRenderer.DefaultCharacterTransparencyShaderPackage); - _characterTattooState = new ModdedShaderPackageState(() => modelRenderer.CharacterTattooShaderPackage, - () => modelRenderer.DefaultCharacterTattooShaderPackage); - _characterOcclusionState = new ModdedShaderPackageState(() => modelRenderer.CharacterOcclusionShaderPackage, - () => modelRenderer.DefaultCharacterOcclusionShaderPackage); - _hairMaskState = - new ModdedShaderPackageState(() => modelRenderer.HairMaskShaderPackage, () => modelRenderer.DefaultHairMaskShaderPackage); - - _humanSetupScalingHook.SetupReplacements += SetupHssReplacements; - _humanOnRenderMaterialHook = hooks.CreateHook("Human.OnRenderMaterial", vTables.HumanVTable[64], - OnRenderHumanMaterial, !HookOverrides.Instance.PostProcessing.HumanOnRenderMaterial).Result; - _modelRendererOnRenderMaterialHook = hooks.CreateHook("ModelRenderer.OnRenderMaterial", - Sigs.ModelRendererOnRenderMaterial, ModelRendererOnRenderMaterialDetour, - !HookOverrides.Instance.PostProcessing.ModelRendererOnRenderMaterial).Result; - _modelRendererUnkFuncHook = hooks.CreateHook("ModelRenderer.UnkFunc", - Sigs.ModelRendererUnkFunc, ModelRendererUnkFuncDetour, - !HookOverrides.Instance.PostProcessing.ModelRendererUnkFunc).Result; - _prepareColorTableHook = hooks.CreateHook( - "MaterialResourceHandle.PrepareColorTable", - Sigs.PrepareColorSet, PrepareColorTableDetour, - !HookOverrides.Instance.PostProcessing.PrepareColorTable).Result; - - _communicator.MtrlLoaded.Subscribe(OnMtrlLoaded, MtrlLoaded.Priority.ShaderReplacementFixer); - _resourceHandleDestructor.Subscribe(OnResourceHandleDestructor, ResourceHandleDestructor.Priority.ShaderReplacementFixer); - } - - public void Dispose() - { - _prepareColorTableHook.Dispose(); - _modelRendererUnkFuncHook.Dispose(); - _modelRendererOnRenderMaterialHook.Dispose(); - _humanOnRenderMaterialHook.Dispose(); - _humanSetupScalingHook.SetupReplacements -= SetupHssReplacements; - - _communicator.MtrlLoaded.Unsubscribe(OnMtrlLoaded); - _resourceHandleDestructor.Unsubscribe(OnResourceHandleDestructor); - - _hairMaskState.ClearMaterials(); - _characterOcclusionState.ClearMaterials(); - _characterTattooState.ClearMaterials(); - _characterTransparencyState.ClearMaterials(); - _characterGlassState.ClearMaterials(); - _irisState.ClearMaterials(); - _characterLegacyState.ClearMaterials(); - _characterStockingsState.ClearMaterials(); - _skinState.ClearMaterials(); - } - - public (ulong Skin, ulong CharacterStockings, ulong CharacterLegacy, ulong Iris, ulong CharacterGlass, ulong CharacterTransparency, ulong - CharacterTattoo, ulong CharacterOcclusion, ulong HairMask) GetAndResetSlowPathCallDeltas() - => (_skinState.GetAndResetSlowPathCallDelta(), - _characterStockingsState.GetAndResetSlowPathCallDelta(), - _characterLegacyState.GetAndResetSlowPathCallDelta(), - _irisState.GetAndResetSlowPathCallDelta(), - _characterGlassState.GetAndResetSlowPathCallDelta(), - _characterTransparencyState.GetAndResetSlowPathCallDelta(), - _characterTattooState.GetAndResetSlowPathCallDelta(), - _characterOcclusionState.GetAndResetSlowPathCallDelta(), - _hairMaskState.GetAndResetSlowPathCallDelta()); - - private void OnMtrlLoaded(nint mtrlResourceHandle, nint gameObject) - { - var mtrl = (MaterialResourceHandle*)mtrlResourceHandle; - var shpk = mtrl->ShaderPackageResourceHandle; - if (shpk == null) - return; - - var shpkName = mtrl->ShpkName.AsSpan(); - var shpkState = GetStateForHumanSetup(shpkName) - ?? GetStateForHumanRender(shpkName) - ?? GetStateForModelRendererRender(shpkName) - ?? GetStateForModelRendererUnk(shpkName) ?? GetStateForColorTable(shpkName); - - if (shpkState != null && shpk != shpkState.DefaultShaderPackage) - shpkState.TryAddMaterial(mtrlResourceHandle); - } - - private void OnResourceHandleDestructor(Structs.ResourceHandle* handle) - { - _skinState.TryRemoveMaterial(handle); - _characterStockingsState.TryRemoveMaterial(handle); - _characterLegacyState.TryRemoveMaterial(handle); - _irisState.TryRemoveMaterial(handle); - _characterGlassState.TryRemoveMaterial(handle); - _characterTransparencyState.TryRemoveMaterial(handle); - _characterTattooState.TryRemoveMaterial(handle); - _characterOcclusionState.TryRemoveMaterial(handle); - _hairMaskState.TryRemoveMaterial(handle); - } - - private ModdedShaderPackageState? GetStateForHumanSetup(MaterialResourceHandle* mtrlResource) - => mtrlResource == null ? null : GetStateForHumanSetup(mtrlResource->ShpkName.AsSpan()); - - private ModdedShaderPackageState? GetStateForHumanSetup(ReadOnlySpan shpkName) - => CharacterStockingsShpkName.SequenceEqual(shpkName) ? _characterStockingsState : null; - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private uint GetTotalMaterialCountForHumanSetup() - => _characterStockingsState.MaterialCount; - - private ModdedShaderPackageState? GetStateForHumanRender(MaterialResourceHandle* mtrlResource) - => mtrlResource == null ? null : GetStateForHumanRender(mtrlResource->ShpkName.AsSpan()); - - private ModdedShaderPackageState? GetStateForHumanRender(ReadOnlySpan shpkName) - => SkinShpkName.SequenceEqual(shpkName) ? _skinState : null; - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private uint GetTotalMaterialCountForHumanRender() - => _skinState.MaterialCount; - - private ModdedShaderPackageState? GetStateForModelRendererRender(MaterialResourceHandle* mtrlResource) - => mtrlResource == null ? null : GetStateForModelRendererRender(mtrlResource->ShpkName.AsSpan()); - - private ModdedShaderPackageState? GetStateForModelRendererRender(ReadOnlySpan shpkName) - { - if (CharacterGlassShpkName.SequenceEqual(shpkName)) - return _characterGlassState; - - if (CharacterTransparencyShpkName.SequenceEqual(shpkName)) - return _characterTransparencyState; - - if (CharacterTattooShpkName.SequenceEqual(shpkName)) - return _characterTattooState; - - if (HairMaskShpkName.SequenceEqual(shpkName)) - return _hairMaskState; - - return null; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private uint GetTotalMaterialCountForModelRendererRender() - => _characterGlassState.MaterialCount - + _characterTransparencyState.MaterialCount - + _characterTattooState.MaterialCount - + _hairMaskState.MaterialCount; - - private ModdedShaderPackageState? GetStateForModelRendererUnk(MaterialResourceHandle* mtrlResource) - => mtrlResource == null ? null : GetStateForModelRendererUnk(mtrlResource->ShpkName.AsSpan()); - - private ModdedShaderPackageState? GetStateForModelRendererUnk(ReadOnlySpan shpkName) - { - if (IrisShpkName.SequenceEqual(shpkName)) - return _irisState; - - if (CharacterOcclusionShpkName.SequenceEqual(shpkName)) - return _characterOcclusionState; - - if (CharacterStockingsShpkName.SequenceEqual(shpkName)) - return _characterStockingsState; - - return null; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private uint GetTotalMaterialCountForModelRendererUnk() - => _irisState.MaterialCount - + _characterOcclusionState.MaterialCount - + _characterStockingsState.MaterialCount; - - private ModdedShaderPackageState? GetStateForColorTable(ReadOnlySpan shpkName) - => CharacterLegacyShpkName.SequenceEqual(shpkName) ? _characterLegacyState : null; - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private uint GetTotalMaterialCountForColorTable() - => _characterLegacyState.MaterialCount; - - private void SetupHssReplacements(CharacterBase* drawObject, uint slotIndex, Span replacements, - ref int numReplacements, ref IDisposable? pbdDisposable, ref object? shpkLock) - { - // If we don't have any on-screen instances of modded characterstockings.shpk, we don't need the slow path at all. - if (!Enabled || GetTotalMaterialCountForHumanSetup() == 0) - return; - - var model = drawObject->Models[slotIndex]; - if (model == null) - return; - - MaterialResourceHandle* mtrlResource = null; - ModdedShaderPackageState? shpkState = null; - foreach (var material in model->MaterialsSpan) - { - if (material.Value == null) - continue; - - mtrlResource = material.Value->MaterialResourceHandle; - shpkState = GetStateForHumanSetup(mtrlResource); - // Despite this function being called with what designates a model (and therefore potentially many materials), - // we currently don't need to handle more than one modded ShPk. - if (shpkState != null) - break; - } - - if (shpkState == null || shpkState.MaterialCount == 0) - return; - - shpkState.IncrementSlowPathCallDelta(); - - // This is less performance-critical than the others, as this is called by the game only on draw object creation and slot update. - // There are still thread safety concerns as it might be called in other threads by plugins. - shpkLock = shpkState; - replacements[numReplacements++] = new HumanSetupScalingHook.Replacement((nint)shpkState.ShaderPackageReference, - (nint)mtrlResource->ShaderPackageResourceHandle, - (nint)shpkState.DefaultShaderPackage); - } - - private nint OnRenderHumanMaterial(CharacterBase* human, CSModelRenderer.OnRenderMaterialParams* param) - { - // If we don't have any on-screen instances of modded skin.shpk, we don't need the slow path at all. - if (!Enabled || GetTotalMaterialCountForHumanRender() == 0) - return _humanOnRenderMaterialHook.Original(human, param); - - var material = param->Model->Materials[param->MaterialIndex]; - var mtrlResource = material->MaterialResourceHandle; - var shpkState = GetStateForHumanRender(mtrlResource); - if (shpkState == null || shpkState.MaterialCount == 0) - return _humanOnRenderMaterialHook.Original(human, param); - - shpkState.IncrementSlowPathCallDelta(); - - // Performance considerations: - // - This function is called from several threads simultaneously, hence the need for synchronization in the swapping path ; - // - Function is called each frame for each material on screen, after culling, i.e. up to thousands of times a frame in crowded areas ; - // - Swapping path is taken up to hundreds of times a frame. - // At the time of writing, the lock doesn't seem to have a noticeable impact in either frame rate or CPU usage, but the swapping path shall still be avoided as much as possible. - lock (shpkState) - { - var shpkReference = shpkState.ShaderPackageReference; - try - { - *shpkReference = mtrlResource->ShaderPackageResourceHandle; - return _humanOnRenderMaterialHook.Original(human, param); - } - finally - { - *shpkReference = shpkState.DefaultShaderPackage; - } - } - } - - private nint ModelRendererOnRenderMaterialDetour(CSModelRenderer* modelRenderer, ushort* outFlags, - CSModelRenderer.OnRenderModelParams* param, Material* material, uint materialIndex) - { - // If we don't have any on-screen instances of modded characterglass.shpk or others, we don't need the slow path at all. - if (!Enabled || GetTotalMaterialCountForModelRendererRender() == 0) - return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); - - var mtrlResource = material->MaterialResourceHandle; - var shpkState = GetStateForModelRendererRender(mtrlResource); - if (shpkState == null || shpkState.MaterialCount == 0) - return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); - - shpkState.IncrementSlowPathCallDelta(); - - // Same performance considerations as OnRenderHumanMaterial. - lock (shpkState) - { - var shpkReference = shpkState.ShaderPackageReference; - try - { - *shpkReference = mtrlResource->ShaderPackageResourceHandle; - return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); - } - finally - { - *shpkReference = shpkState.DefaultShaderPackage; - } - } - } - - private void ModelRendererUnkFuncDetour(CSModelRenderer* modelRenderer, ModelRendererStructs.UnkPayload* unkPayload, uint unk2, uint unk3, - uint unk4, uint unk5) - { - if (!Enabled || GetTotalMaterialCountForModelRendererUnk() == 0) - { - _modelRendererUnkFuncHook.Original(modelRenderer, unkPayload, unk2, unk3, unk4, unk5); - return; - } - - var mtrlResource = GetMaterialResourceHandle(unkPayload); - var shpkState = GetStateForModelRendererUnk(mtrlResource); - if (shpkState == null || shpkState.MaterialCount == 0) - { - _modelRendererUnkFuncHook.Original(modelRenderer, unkPayload, unk2, unk3, unk4, unk5); - return; - } - - shpkState.IncrementSlowPathCallDelta(); - - // Same performance considerations as OnRenderHumanMaterial. - lock (shpkState) - { - var shpkReference = shpkState.ShaderPackageReference; - try - { - *shpkReference = mtrlResource->ShaderPackageResourceHandle; - _modelRendererUnkFuncHook.Original(modelRenderer, unkPayload, unk2, unk3, unk4, unk5); - } - finally - { - *shpkReference = shpkState.DefaultShaderPackage; - } - } - } - - private static MaterialResourceHandle* GetMaterialResourceHandle(ModelRendererStructs.UnkPayload* unkPayload) - { - // TODO ClientStructs-ify - var unkPointer = *(nint*)((nint)unkPayload->ModelResourceHandle + 0xE8) + unkPayload->UnkIndex * 0x24; - var materialIndex = *(ushort*)(unkPointer + 8); - var material = unkPayload->Params->Model->Materials[materialIndex]; - if (material == null) - return null; - - var mtrlResource = material->MaterialResourceHandle; - if (mtrlResource == null) - return null; - - if (mtrlResource->ShaderPackageResourceHandle == null) - { - Penumbra.Log.Warning("ShaderReplacementFixer found a MaterialResourceHandle with no shader package"); - return null; - } - - if (mtrlResource->ShaderPackageResourceHandle->ShaderPackage != unkPayload->ShaderWrapper->ShaderPackage) - { - Penumbra.Log.Warning( - $"ShaderReplacementFixer found a MaterialResourceHandle (0x{(nint)mtrlResource:X}) with an inconsistent shader package (got 0x{(nint)mtrlResource->ShaderPackageResourceHandle->ShaderPackage:X}, expected 0x{(nint)unkPayload->ShaderWrapper->ShaderPackage:X})"); - return null; - } - - return mtrlResource; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static int GetDataSetExpectedSize(uint dataFlags) - => (dataFlags & 4) != 0 - ? ColorTable.Size + ((dataFlags & 8) != 0 ? ColorDyeTable.Size : 0) - : 0; - - private Texture* PrepareColorTableDetour(MaterialResourceHandle* thisPtr, byte stain0Id, byte stain1Id) - { - if (thisPtr->DataSetSize < GetDataSetExpectedSize(thisPtr->DataFlags) && Utf8GamePath.IsRooted(thisPtr->FileName.AsSpan())) - Penumbra.Log.Warning( - $"Material at {thisPtr->FileName} has data set of size {thisPtr->DataSetSize} bytes, but should have at least {GetDataSetExpectedSize(thisPtr->DataFlags)} bytes. This may cause crashes due to access violations."); - - // If we don't have any on-screen instances of modded characterlegacy.shpk, we don't need the slow path at all. - if (!Enabled || GetTotalMaterialCountForColorTable() == 0) - return _prepareColorTableHook.Original(thisPtr, stain0Id, stain1Id); - - var material = thisPtr->Material; - if (material == null) - return _prepareColorTableHook.Original(thisPtr, stain0Id, stain1Id); - - var shpkState = GetStateForColorTable(thisPtr->ShpkName.AsSpan()); - if (shpkState == null || shpkState.MaterialCount == 0) - return _prepareColorTableHook.Original(thisPtr, stain0Id, stain1Id); - - shpkState.IncrementSlowPathCallDelta(); - - // Same performance considerations as HumanSetupScalingDetour. - lock (shpkState) - { - var shpkReference = shpkState.ShaderPackageReference; - try - { - *shpkReference = thisPtr->ShaderPackageResourceHandle; - return _prepareColorTableHook.Original(thisPtr, stain0Id, stain1Id); - } - finally - { - *shpkReference = shpkState.DefaultShaderPackage; - } - } - } - - private sealed class ModdedShaderPackageState(ShaderPackageReferenceGetter referenceGetter, DefaultShaderPackageGetter defaultGetter) - { - // MaterialResourceHandle set - private readonly ConcurrentSet _materials = new(); - - // ConcurrentDictionary.Count uses a lock in its current implementation. - private uint _materialCount; - private ulong _slowPathCallDelta; - - public uint MaterialCount - { - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - get => _materialCount; - } - - public ShaderPackageResourceHandle** ShaderPackageReference - { - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - get => referenceGetter(); - } - - public ShaderPackageResourceHandle* DefaultShaderPackage - { - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - get => defaultGetter(); - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public void TryAddMaterial(nint mtrlResourceHandle) - { - if (_materials.TryAdd(mtrlResourceHandle)) - Interlocked.Increment(ref _materialCount); - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public void TryRemoveMaterial(Structs.ResourceHandle* handle) - { - if (_materials.TryRemove((nint)handle)) - Interlocked.Decrement(ref _materialCount); - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public void ClearMaterials() - { - _materials.Clear(); - _materialCount = 0; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public void IncrementSlowPathCallDelta() - => Interlocked.Increment(ref _slowPathCallDelta); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public ulong GetAndResetSlowPathCallDelta() - => Interlocked.Exchange(ref _slowPathCallDelta, 0); - } - - private delegate ShaderPackageResourceHandle* DefaultShaderPackageGetter(); - - private delegate ShaderPackageResourceHandle** ShaderPackageReferenceGetter(); -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/MappedCodeReader.cs b/Penumbra/Interop/Hooks/ResourceLoading/MappedCodeReader.cs deleted file mode 100644 index de0014d2..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/MappedCodeReader.cs +++ /dev/null @@ -1,14 +0,0 @@ -using Iced.Intel; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -public class MappedCodeReader(UnmanagedMemoryAccessor data, long offset) : CodeReader -{ - public override int ReadByte() - { - if (offset >= data.Capacity) - return -1; - - return data.ReadByte(offset++); - } -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/PapHandler.cs b/Penumbra/Interop/Hooks/ResourceLoading/PapHandler.cs deleted file mode 100644 index 35ee86dc..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/PapHandler.cs +++ /dev/null @@ -1,33 +0,0 @@ -using Penumbra.GameData; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -public sealed class PapHandler(PeSigScanner sigScanner, PapRewriter.PapResourceHandlerPrototype papResourceHandler) : IDisposable -{ - private readonly PapRewriter _papRewriter = new(sigScanner, papResourceHandler); - - public void Enable() - { - if (HookOverrides.Instance.ResourceLoading.PapHooks) - return; - - ReadOnlySpan<(string Sig, string Name)> signatures = - [ - (Sigs.LoadAlwaysResidentMotionPacks, nameof(Sigs.LoadAlwaysResidentMotionPacks)), - (Sigs.LoadWeaponDependentResidentMotionPacks, nameof(Sigs.LoadWeaponDependentResidentMotionPacks)), - (Sigs.LoadInitialResidentMotionPacks, nameof(Sigs.LoadInitialResidentMotionPacks)), - (Sigs.LoadMotionPacks, nameof(Sigs.LoadMotionPacks)), - (Sigs.LoadMotionPacks2, nameof(Sigs.LoadMotionPacks2)), - (Sigs.LoadMigratoryMotionPack, nameof(Sigs.LoadMigratoryMotionPack)), - ]; - - var stopwatch = Stopwatch.StartNew(); - foreach (var (sig, name) in signatures) - _papRewriter.Rewrite(sig, name); - Penumbra.Log.Debug( - $"[PapHandler] Rewrote {signatures.Length} .pap functions for inlined GetResourceAsync in {stopwatch.ElapsedMilliseconds} ms."); - } - - public void Dispose() - => _papRewriter.Dispose(); -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/PapRewriter.cs b/Penumbra/Interop/Hooks/ResourceLoading/PapRewriter.cs deleted file mode 100644 index ff794d81..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/PapRewriter.cs +++ /dev/null @@ -1,215 +0,0 @@ -using System.Text.Unicode; -using Dalamud.Hooking; -using Iced.Intel; -using static Iced.Intel.AssemblerRegisters; -using OtterGui.Extensions; -using Penumbra.String.Classes; -using Swan; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -public sealed class PapRewriter(PeSigScanner sigScanner, PapRewriter.PapResourceHandlerPrototype papResourceHandler) : IDisposable -{ - public unsafe delegate int PapResourceHandlerPrototype(void* self, byte* path, int length); - - private readonly Dictionary _hooks = []; - private readonly Dictionary<(nint, Register, ulong), nint> _nativeAllocPaths = []; - private readonly List _nativeAllocCaves = []; - - public void Rewrite(string sig, string name) - { - if (!sigScanner.TryScanText(sig, out var address)) - throw new Exception($"Signature for {name} [{sig}] could not be found."); - - var funcInstructions = sigScanner.GetFunctionInstructions(address).ToArray(); - var hookPoints = ScanPapHookPoints(funcInstructions).ToList(); - - foreach (var hookPoint in hookPoints) - { - var stackAccesses = ScanStackAccesses(funcInstructions, hookPoint).ToList(); - var stringAllocation = NativeAllocPath( - address, hookPoint.MemoryBase, hookPoint.MemoryDisplacement64, - Utf8GamePath.MaxGamePathLength - ); - WriteToAlloc(stringAllocation, Utf8GamePath.MaxGamePathLength, name); - - // We'll need to grab our true hook point; the location where we can change the path at our leisure. - // This is going to be the first call instruction after our 'hookPoint', so, we'll find that. - // Pretty scuffed, this might need a refactoring at some point. - // We're doing it by skipping to our hookPoint's address in the list of instructions inside the function; then getting next CALL - var skipIndex = funcInstructions.IndexOf(instr => instr.IP == hookPoint.IP) + 1; - var detourPoint = funcInstructions.Skip(skipIndex) - .First(instr => instr.Mnemonic == Mnemonic.Call); - - // We'll also remove all the 'hookPoints' from 'stackAccesses'. - // We're handling the char *path redirection here, so we don't want this to hit the later code - foreach (var hp in hookPoints) - stackAccesses.RemoveAll(instr => instr.IP == hp.IP); - - var detourPointer = Marshal.GetFunctionPointerForDelegate(papResourceHandler); - var targetRegister = GetRegister64(hookPoint.Op0Register); - var hookAddress = new IntPtr((long)detourPoint.IP); - - var caveAllocation = NativeAllocCave(16); - var assembler = new Assembler(64); - assembler.mov(targetRegister, stringAllocation); // Move our char *path into the relevant register (rdx) - - // After this asm stub, we have a call to Crc32(); since r9 is a volatile, unused register, we can use it ourselves - // We're essentially storing the original 2 arguments ('this', 'path'), in case they get mangled in our call - // We technically don't need to save rdx ('path'), since it'll be stringLoc, but eh - assembler.mov(r9, caveAllocation); - assembler.mov(__qword_ptr[r9], rcx); - assembler.mov(__qword_ptr[r9 + 8], rdx); - - // We can use 'rax' here too since it's also volatile, and it'll be overwritten by Crc32()'s return anyway - assembler.mov(rax, detourPointer); - assembler.call(rax); - - // Do the reverse process and retrieve the stored stuff - assembler.mov(r9, caveAllocation); - assembler.mov(rcx, __qword_ptr[r9]); - assembler.mov(rdx, __qword_ptr[r9 + 8]); - - // Plop 'rax' (our return value, the path size) into r8, so it's the third argument for the subsequent Crc32() call - assembler.mov(r8, rax); - var hook = new AsmHook(hookAddress, AssembleToBytes(assembler), $"{name}.PapRedirection"); - - _hooks.Add(hookAddress, hook); - hook.Enable(); - - // Now we're adjusting every single reference to the stack allocated 'path' to our substantially bigger 'stringLoc' - UpdatePathAddresses(stackAccesses, stringAllocation, name); - } - } - - private void UpdatePathAddresses(IEnumerable stackAccesses, nint stringAllocation, string name) - { - foreach (var (stackAccess, index) in stackAccesses.WithIndex()) - { - var hookAddress = new IntPtr((long)stackAccess.IP + stackAccess.Length); - - // Hook already exists, means there's reuse of the same stack address across 2 GetResourceAsync; just skip - if (_hooks.ContainsKey(hookAddress)) - continue; - - var targetRegister = GetRegister64(stackAccess.Op0Register); - var assembler = new Assembler(64); - assembler.mov(targetRegister, stringAllocation); - var hook = new AsmHook(hookAddress, AssembleToBytes(assembler), $"{name}.PapStackAccess[{index}]"); - - _hooks.Add(hookAddress, hook); - hook.Enable(); - } - } - - private static AssemblerRegister64 GetRegister64(Register reg) - => reg switch - { - Register.RAX => rax, - Register.RCX => rcx, - Register.RDX => rdx, - Register.RBX => rbx, - Register.RSP => rsp, - Register.RBP => rbp, - Register.RSI => rsi, - Register.RDI => rdi, - Register.R8 => r8, - Register.R9 => r9, - Register.R10 => r10, - Register.R11 => r11, - Register.R12 => r12, - Register.R13 => r13, - Register.R14 => r14, - Register.R15 => r15, - _ => throw new ArgumentOutOfRangeException(nameof(reg), reg, "Unsupported register."), - }; - - private static byte[] AssembleToBytes(Assembler assembler) - { - using var stream = new MemoryStream(); - var writer = new StreamCodeWriter(stream); - assembler.Assemble(writer, 0); - return stream.ToArray(); - } - - private static IEnumerable ScanStackAccesses(IEnumerable instructions, Instruction hookPoint) - { - return instructions.Where(instr => - instr.Code == hookPoint.Code - && instr.Op0Kind == hookPoint.Op0Kind - && instr.Op1Kind == hookPoint.Op1Kind - && instr.MemoryBase == hookPoint.MemoryBase - && instr.MemoryDisplacement64 == hookPoint.MemoryDisplacement64) - .GroupBy(instr => instr.IP) - .Select(grp => grp.First()); - } - - // This is utterly fucked and hardcoded, but, again, it works - // Might be a neat idea for a more versatile kind of signature though - private static IEnumerable ScanPapHookPoints(Instruction[] funcInstructions) - { - for (var i = 0; i < funcInstructions.Length - 8; i++) - { - if (funcInstructions.AsSpan(i, 8) is - [ - { Code : Code.Lea_r64_m }, - { Code : Code.Lea_r64_m }, - { Mnemonic: Mnemonic.Call }, - { Code : Code.Lea_r64_m }, - { Mnemonic: Mnemonic.Call }, - { Code : Code.Lea_r64_m }, - .., - ] - ) - yield return funcInstructions[i]; - } - } - - private unsafe nint NativeAllocCave(nuint size) - { - var caveLoc = (nint)NativeMemory.Alloc(size); - _nativeAllocCaves.Add(caveLoc); - - return caveLoc; - } - - // This is a bit conked but, if we identify a path by: - // 1) The function it belongs to (starting address, 'funcAddress') - // 2) The stack register (not strictly necessary - should always be rbp - but abundance of caution, so I don't hit myself in the future) - // 3) The displacement on the stack - // Then we ensure we have a unique identifier for the specific variable location of that specific function - // This is useful because sometimes the stack address is reused within the same function for different GetResourceAsync calls - private unsafe nint NativeAllocPath(nint funcAddress, Register stackRegister, ulong stackDisplacement, nuint size) - => _nativeAllocPaths.GetOrAdd((funcAddress, stackRegister, stackDisplacement), _ => (nint)NativeMemory.Alloc(size)); - - private static unsafe void NativeFree(nint mem) - => NativeMemory.Free((void*)mem); - - public void Dispose() - { - foreach (var hook in _hooks.Values) - { - hook.Disable(); - hook.Dispose(); - } - - _hooks.Clear(); - - foreach (var mem in _nativeAllocCaves) - NativeFree(mem); - - _nativeAllocCaves.Clear(); - - foreach (var mem in _nativeAllocPaths.Values) - NativeFree(mem); - - _nativeAllocPaths.Clear(); - } - - [Conditional("DEBUG")] - private static unsafe void WriteToAlloc(nint alloc, int size, string name) - { - var span = new Span((void*)alloc, size); - Utf8.TryWrite(span, $"Penumbra.{name}\0", out _); - } -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/PeSigScanner.cs b/Penumbra/Interop/Hooks/ResourceLoading/PeSigScanner.cs deleted file mode 100644 index 620f3160..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/PeSigScanner.cs +++ /dev/null @@ -1,188 +0,0 @@ -using System.IO.MemoryMappedFiles; -using Iced.Intel; -using OtterGui.Services; -using PeNet; -using Decoder = Iced.Intel.Decoder; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -// A good chunk of this was blatantly stolen from Dalamud's SigScanner 'cause Winter could not be faffed, Winter will definitely not rewrite it later -public unsafe class PeSigScanner : IDisposable, IService -{ - private readonly MemoryMappedFile _file; - private readonly MemoryMappedViewAccessor _textSection; - - private readonly nint _moduleBaseAddress; - private readonly uint _textSectionVirtualAddress; - - public PeSigScanner() - { - var mainModule = Process.GetCurrentProcess().MainModule!; - var fileName = mainModule.FileName; - _moduleBaseAddress = mainModule.BaseAddress; - - if (fileName == null) - throw new Exception("Unable to obtain main module path. This should not happen."); - - _file = MemoryMappedFile.CreateFromFile(fileName, FileMode.Open, null, 0, MemoryMappedFileAccess.Read); - - using var fileStream = _file.CreateViewStream(0, 0, MemoryMappedFileAccess.Read); - var pe = new PeFile(fileStream); - - var textSection = pe.ImageSectionHeaders!.First(header => header.Name == ".text"); - - var textSectionStart = textSection.PointerToRawData; - var textSectionSize = textSection.SizeOfRawData; - _textSectionVirtualAddress = textSection.VirtualAddress; - - _textSection = _file.CreateViewAccessor(textSectionStart, textSectionSize, MemoryMappedFileAccess.Read); - } - - - private nint ScanText(string signature) - { - var scanRet = Scan(_textSection, signature); - if (*(byte*)scanRet is 0xE8 or 0xE9) - scanRet = ReadJmpCallSig(scanRet); - - return scanRet; - } - - private static nint ReadJmpCallSig(nint sigLocation) - { - var jumpOffset = *(int*)(sigLocation + 1); - return sigLocation + 5 + jumpOffset; - } - - public bool TryScanText(string signature, out nint result) - { - try - { - result = ScanText(signature); - return true; - } - catch (KeyNotFoundException) - { - result = nint.Zero; - return false; - } - } - - private nint Scan(MemoryMappedViewAccessor section, string signature) - { - var (needle, mask) = ParseSignature(signature); - - var index = IndexOf(section, needle, mask); - if (index < 0) - throw new KeyNotFoundException($"Can't find a signature of {signature}"); - - return (nint)(_moduleBaseAddress + index - section.PointerOffset + _textSectionVirtualAddress); - } - - private static (byte[] Needle, bool[] Mask) ParseSignature(string signature) - { - signature = signature.Replace(" ", string.Empty); - if (signature.Length % 2 != 0) - throw new ArgumentException("Signature without whitespaces must be divisible by two.", nameof(signature)); - - var needleLength = signature.Length / 2; - var needle = new byte[needleLength]; - var mask = new bool[needleLength]; - for (var i = 0; i < needleLength; i++) - { - var hexString = signature.Substring(i * 2, 2); - if (hexString is "??" or "**") - { - needle[i] = 0; - mask[i] = true; - continue; - } - - needle[i] = byte.Parse(hexString, NumberStyles.AllowHexSpecifier); - mask[i] = false; - } - - return (needle, mask); - } - - private static int IndexOf(MemoryMappedViewAccessor section, byte[] needle, bool[] mask) - { - if (needle.Length > section.Capacity) - return -1; - - var badShift = BuildBadCharTable(needle, mask); - var last = needle.Length - 1; - var offset = 0; - var maxOffset = section.Capacity - needle.Length; - - byte* buffer = null; - section.SafeMemoryMappedViewHandle.AcquirePointer(ref buffer); - try - { - while (offset <= maxOffset) - { - int position; - for (position = last; needle[position] == *(buffer + position + offset) || mask[position]; position--) - { - if (position == 0) - return offset; - } - - offset += badShift[*(buffer + offset + last)]; - } - } - finally - { - section.SafeMemoryMappedViewHandle.ReleasePointer(); - } - - return -1; - } - - - private static int[] BuildBadCharTable(byte[] needle, bool[] mask) - { - int idx; - var last = needle.Length - 1; - var badShift = new int[256]; - for (idx = last; idx > 0 && !mask[idx]; --idx) - { } - - var diff = last - idx; - if (diff == 0) - diff = 1; - - for (idx = 0; idx <= 255; ++idx) - badShift[idx] = diff; - for (idx = last - diff; idx < last; ++idx) - badShift[needle[idx]] = last - idx; - return badShift; - } - - // Detects function termination; this is done in a really stupid way that will possibly break if looked at wrong, but it'll work for now - // If this shits itself, go bother Winter to implement proper CFG + basic block detection - public IEnumerable GetFunctionInstructions(nint address) - { - var fileOffset = address - _textSectionVirtualAddress - _moduleBaseAddress; - - var codeReader = new MappedCodeReader(_textSection, fileOffset); - var decoder = Decoder.Create(64, codeReader, (ulong)address.ToInt64()); - - do - { - decoder.Decode(out var instr); - - // Yes, this is catastrophically bad, but it works for some cases okay - if (instr.Mnemonic == Mnemonic.Int3) - break; - - yield return instr; - } while (true); - } - - public void Dispose() - { - _textSection.Dispose(); - _file.Dispose(); - } -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/ResourceLoader.cs b/Penumbra/Interop/Hooks/ResourceLoading/ResourceLoader.cs deleted file mode 100644 index 6ddcbfda..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/ResourceLoader.cs +++ /dev/null @@ -1,382 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.System.Resource; -using OtterGui.Services; -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Interop.Hooks.Resources; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.SafeHandles; -using Penumbra.Interop.Structs; -using Penumbra.String; -using Penumbra.String.Classes; -using FileMode = Penumbra.Interop.Structs.FileMode; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -public unsafe class ResourceLoader : IDisposable, IService -{ - private readonly ResourceService _resources; - private readonly FileReadService _fileReadService; - private readonly RsfService _rsfService; - private readonly PapHandler _papHandler; - private readonly Configuration _config; - private readonly ResourceHandleDestructor _destructor; - - private readonly ConcurrentDictionary _ongoingLoads = []; - - private readonly ThreadLocal _resolvedData = new(() => ResolveData.Invalid); - public event Action? PapRequested; - - public IReadOnlyDictionary OngoingLoads - => _ongoingLoads; - - public ResourceLoader(ResourceService resources, FileReadService fileReadService, RsfService rsfService, Configuration config, PeSigScanner sigScanner, - ResourceHandleDestructor destructor) - { - _resources = resources; - _fileReadService = fileReadService; - _rsfService = rsfService; - _config = config; - _destructor = destructor; - ResetResolvePath(); - - _resources.ResourceRequested += ResourceHandler; - _resources.ResourceStateUpdating += ResourceStateUpdatingHandler; - _resources.ResourceStateUpdated += ResourceStateUpdatedHandler; - _resources.ResourceHandleIncRef += IncRefProtection; - _resources.ResourceHandleDecRef += DecRefProtection; - _fileReadService.ReadSqPack += ReadSqPackDetour; - _destructor.Subscribe(ResourceDestructorHandler, ResourceHandleDestructor.Priority.ResourceLoader); - - _papHandler = new PapHandler(sigScanner, PapResourceHandler); - _papHandler.Enable(); - } - - private int PapResourceHandler(void* self, byte* path, int length) - { - if (!_config.EnableMods || !Utf8GamePath.FromPointer(path, MetaDataComputation.CiCrc32, out var gamePath)) - return length; - - var resolvedData = _resolvedData.Value; - var (resolvedPath, data) = _incMode.Value - ? (null, ResolveData.Invalid) - : resolvedData.Valid - ? (resolvedData.ModCollection.ResolvePath(gamePath), resolvedData) - : ResolvePath(gamePath, ResourceCategory.Chara, ResourceType.Pap); - - - if (!resolvedPath.HasValue) - { - PapRequested?.Invoke(gamePath, null, data); - return length; - } - - PapRequested?.Invoke(gamePath, resolvedPath.Value, data); - NativeMemory.Copy(resolvedPath.Value.InternalName.Path, path, (nuint)resolvedPath.Value.InternalName.Length); - path[resolvedPath.Value.InternalName.Length] = 0; - return resolvedPath.Value.InternalName.Length; - } - - /// Load a resource for a given path and a specific collection. - public ResourceHandle* LoadResolvedResource(ResourceCategory category, ResourceType type, CiByteString path, ResolveData resolveData) - { - var previous = _resolvedData.Value; - _resolvedData.Value = resolveData; - try - { - return _resources.GetResource(category, type, path); - } - finally - { - _resolvedData.Value = previous; - } - } - - /// Load a resource for a given path and a specific collection. - public SafeResourceHandle LoadResolvedSafeResource(ResourceCategory category, ResourceType type, CiByteString path, ResolveData resolveData) - { - var previous = _resolvedData.Value; - _resolvedData.Value = resolveData; - try - { - return _resources.GetSafeResource(category, type, path); - } - finally - { - _resolvedData.Value = previous; - } - } - - /// The function to use to resolve a given path. - public Func ResolvePath = null!; - - /// Reset the ResolvePath function to always return null. - public void ResetResolvePath() - => ResolvePath = (_, _, _) => (null, ResolveData.Invalid); - - public delegate void ResourceLoadedDelegate(ResourceHandle* handle, Utf8GamePath originalPath, FullPath? manipulatedPath, - ResolveData resolveData); - - /// - /// Event fired whenever a resource is returned. - /// If the path was manipulated by penumbra, manipulatedPath will be the file path of the loaded resource. - /// resolveData is additional data returned by the current ResolvePath function which can contain the collection and associated game object. - /// - public event ResourceLoadedDelegate? ResourceLoaded; - - public delegate void FileLoadedDelegate(ResourceHandle* resource, CiByteString path, bool returnValue, bool custom, - ReadOnlySpan additionalData); - - /// - /// Event fired whenever a resource is newly loaded. - /// ReturnValue indicates the return value of the loading function (which does not imply that the resource was actually successfully loaded) - /// custom is true if the file was loaded from local files instead of the default SqPacks. - /// AdditionalData is either empty or the part of the path inside the leading pipes. - /// - public event FileLoadedDelegate? FileLoaded; - - public delegate void ResourceCompleteDelegate(ResourceHandle* resource, CiByteString path, Utf8GamePath originalPath, - ReadOnlySpan additionalData, bool isAsync); - - /// - /// Event fired just before a resource finishes loading. - /// must be checked to know whether the load was successful or not. - /// AdditionalData is either empty or the part of the path inside the leading pipes. - /// - public event ResourceCompleteDelegate? BeforeResourceComplete; - - /// - /// Event fired when a resource has finished loading. - /// must be checked to know whether the load was successful or not. - /// AdditionalData is either empty or the part of the path inside the leading pipes. - /// - public event ResourceCompleteDelegate? ResourceComplete; - - public void Dispose() - { - _resources.ResourceRequested -= ResourceHandler; - _resources.ResourceStateUpdating -= ResourceStateUpdatingHandler; - _resources.ResourceStateUpdated -= ResourceStateUpdatedHandler; - _resources.ResourceHandleIncRef -= IncRefProtection; - _resources.ResourceHandleDecRef -= DecRefProtection; - _fileReadService.ReadSqPack -= ReadSqPackDetour; - _destructor.Unsubscribe(ResourceDestructorHandler); - _papHandler.Dispose(); - } - - private void ResourceHandler(ref ResourceCategory category, ref ResourceType type, ref int hash, ref Utf8GamePath path, - Utf8GamePath original, GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue) - { - if (!_config.EnableMods || returnValue != null) - return; - - CompareHash(ComputeHash(path.Path, parameters), hash, path); - - // If no replacements are being made, we still want to be able to trigger the event. - var resolvedData = _resolvedData.Value; - var (resolvedPath, data) = _incMode.Value - ? (null, ResolveData.Invalid) - : resolvedData.Valid - ? (resolvedData.ModCollection.ResolvePath(path), resolvedData) - : ResolvePath(path, category, type); - - if (resolvedPath == null || !Utf8GamePath.FromByteString(resolvedPath.Value.InternalName, out var p)) - { - returnValue = _resources.GetOriginalResource(sync, category, type, hash, path.Path, original, parameters); - TrackResourceLoad(returnValue, original); - ResourceLoaded?.Invoke(returnValue, path, resolvedPath, data); - return; - } - - _rsfService.AddCrc(type, resolvedPath); - // Replace the hash and path with the correct one for the replacement. - hash = ComputeHash(resolvedPath.Value.InternalName, parameters); - var oldPath = path; - path = p; - returnValue = _resources.GetOriginalResource(sync, category, type, hash, path.Path, original, parameters); - TrackResourceLoad(returnValue, original); - ResourceLoaded?.Invoke(returnValue, oldPath, resolvedPath.Value, data); - } - - private void TrackResourceLoad(ResourceHandle* handle, Utf8GamePath original) - { - if (handle->UnkState == 2 && handle->LoadState >= LoadState.Success) - return; - - _ongoingLoads.TryAdd((nint)handle, original.Clone()); - } - - private void ResourceStateUpdatedHandler(ResourceHandle* handle, Utf8GamePath syncOriginal, (byte, LoadState) previousState, ref uint returnValue) - { - if (handle->UnkState != 2 || handle->LoadState < LoadState.Success || previousState is { Item1: 2, Item2: >= LoadState.Success }) - return; - - if (!_ongoingLoads.TryRemove((nint)handle, out var asyncOriginal)) - asyncOriginal = Utf8GamePath.Empty; - - var path = handle->CsHandle.FileName; - if (!syncOriginal.IsEmpty && !asyncOriginal.IsEmpty && !syncOriginal.Equals(asyncOriginal)) - Penumbra.Log.Warning($"[ResourceLoader] Resource original paths inconsistency: 0x{(nint)handle:X}, of path {path}, sync original {syncOriginal}, async original {asyncOriginal}."); - var original = !asyncOriginal.IsEmpty ? asyncOriginal : syncOriginal; - - Penumbra.Log.Excessive($"[ResourceLoader] Resource is complete: 0x{(nint)handle:X}, of path {path}, original {original}, state {previousState.Item1}:{previousState.Item2} -> {handle->UnkState}:{handle->LoadState}, sync: {asyncOriginal.IsEmpty}"); - if (PathDataHandler.Split(path.AsSpan(), out var actualPath, out var additionalData)) - ResourceComplete?.Invoke(handle, new CiByteString(actualPath), original, additionalData, !asyncOriginal.IsEmpty); - else - ResourceComplete?.Invoke(handle, path.AsByteString(), original, [], !asyncOriginal.IsEmpty); - } - - private void ResourceStateUpdatingHandler(ResourceHandle* handle, Utf8GamePath syncOriginal) - { - if (handle->UnkState != 1 || handle->LoadState != LoadState.Success) - return; - - if (!_ongoingLoads.TryGetValue((nint)handle, out var asyncOriginal)) - asyncOriginal = Utf8GamePath.Empty; - - var path = handle->CsHandle.FileName; - var original = asyncOriginal.IsEmpty ? syncOriginal : asyncOriginal; - - Penumbra.Log.Excessive($"[ResourceLoader] Resource is about to be complete: 0x{(nint)handle:X}, of path {path}, original {original}"); - if (PathDataHandler.Split(path.AsSpan(), out var actualPath, out var additionalData)) - BeforeResourceComplete?.Invoke(handle, new CiByteString(actualPath), original, additionalData, !asyncOriginal.IsEmpty); - else - BeforeResourceComplete?.Invoke(handle, path.AsByteString(), original, [], !asyncOriginal.IsEmpty); - } - - private void ReadSqPackDetour(SeFileDescriptor* fileDescriptor, ref int priority, ref bool isSync, ref byte? returnValue) - { - if (fileDescriptor->ResourceHandle == null) - { - Penumbra.Log.Verbose( - $"[ResourceLoader] Failure to load file from SqPack: invalid File Descriptor: {Marshal.PtrToStringUni((nint)(&fileDescriptor->Utf16FileName))}"); - return; - } - - if (!fileDescriptor->ResourceHandle->GamePath(out var gamePath) || gamePath.Length == 0) - { - Penumbra.Log.Error("[ResourceLoader] Failure to load file from SqPack: invalid path specified."); - return; - } - - // Paths starting with a '|' are handled separately to allow for special treatment. - // They are expected to also have a closing '|'. - if (!PathDataHandler.Split(gamePath.Path.Span, out var actualPath, out var data)) - { - returnValue = DefaultLoadResource(gamePath.Path, fileDescriptor, priority, isSync, []); - return; - } - - var path = CiByteString.FromSpanUnsafe(actualPath, gamePath.Path.IsNullTerminated, gamePath.Path.IsAsciiLowerCase, - gamePath.Path.IsAscii); - fileDescriptor->ResourceHandle->FileNameData = path.Path; - fileDescriptor->ResourceHandle->FileNameLength = path.Length; - returnValue = DefaultLoadResource(path, fileDescriptor, priority, isSync, data); - // Return original resource handle path so that they can be loaded separately. - fileDescriptor->ResourceHandle->FileNameData = gamePath.Path.Path; - fileDescriptor->ResourceHandle->FileNameLength = gamePath.Path.Length; - } - - - /// Load a resource by its path. If it is rooted, it will be loaded from the drive, otherwise from the SqPack. - private byte DefaultLoadResource(CiByteString gamePath, SeFileDescriptor* fileDescriptor, int priority, - bool isSync, ReadOnlySpan additionalData) - { - if (Utf8GamePath.IsRooted(gamePath)) - { - // Specify that we are loading unpacked files from the drive. - // We need to obtain the actual file path in UTF16 (Windows-Unicode) on two locations, - // but we write a pointer to the given string instead and use the CreateFileW hook to handle it, - // because otherwise we are limited to 260 characters. - fileDescriptor->FileMode = FileMode.LoadUnpackedResource; - - // Ensure that the file descriptor has its wchar_t array on aligned boundary even if it has to be odd. - var fd = stackalloc char[0x11 + 0x0B + 14]; - fileDescriptor->FileDescriptor = (byte*)fd + 1; - CreateFileWHook.WritePtr(fd + 0x11, gamePath.Path, gamePath.Length); - CreateFileWHook.WritePtr(&fileDescriptor->Utf16FileName, gamePath.Path, gamePath.Length); - - // Use the SE ReadFile function. - var ret = _fileReadService.ReadFile(fileDescriptor, priority, isSync); - FileLoaded?.Invoke(fileDescriptor->ResourceHandle, gamePath, ret != 0, true, additionalData); - return ret; - } - else - { - var ret = _fileReadService.ReadDefaultSqPack(fileDescriptor, priority, isSync); - FileLoaded?.Invoke(fileDescriptor->ResourceHandle, gamePath, ret != 0, false, additionalData); - return ret; - } - } - - /// - /// A resource with ref count 0 that gets incremented goes through GetResourceAsync again. - /// This means, that if the path determined from that is different than the resources path, - /// a different resource gets loaded or incremented, while the IncRef'd resource stays at 0. - /// This causes some problems and is hopefully prevented with this. - /// - private readonly ThreadLocal _incMode = new(() => false, true); - - /// - private void IncRefProtection(ResourceHandle* handle, ref nint? returnValue) - { - if (handle->RefCount != 0) - return; - - _incMode.Value = true; - returnValue = _resources.IncRef(handle); - _incMode.Value = false; - } - - /// - /// Catch weird errors with invalid decrements of the reference count. - /// - private static void DecRefProtection(ResourceHandle* handle, ref byte? returnValue) - { - if (handle->RefCount != 0) - return; - - try - { - Penumbra.Log.Error( - $"[ResourceLoader] Caught decrease of Reference Counter for {handle->FileName()} at 0x{(ulong)handle} below 0."); - } - catch - { - // ignored - } - - returnValue = 1; - } - - private void ResourceDestructorHandler(ResourceHandle* handle) - { - _ongoingLoads.TryRemove((nint)handle, out _); - } - - /// Compute the CRC32 hash for a given path together with potential resource parameters. - private static int ComputeHash(CiByteString path, GetResourceParameters* pGetResParams) - { - if (pGetResParams == null || !pGetResParams->IsPartialRead) - return path.Crc32; - - // When the game requests file only partially, crc32 includes that information, in format of: - // path/to/file.ext.hex_offset.hex_size - // ex) music/ex4/BGM_EX4_System_Title.scd.381adc.30000 - return CiByteString.Join( - (byte)'.', - path, - CiByteString.FromString(pGetResParams->SegmentOffset.ToString("x"), out var s1, MetaDataComputation.None) ? s1 : CiByteString.Empty, - CiByteString.FromString(pGetResParams->SegmentLength.ToString("x"), out var s2, MetaDataComputation.None) ? s2 : CiByteString.Empty - ).Crc32; - } - - /// - /// In Debug build, compare the hashes the game computes with those Penumbra computes to notice potential changes in the CRC32 algorithm or resource parameters. - /// - [Conditional("DEBUG")] - private static void CompareHash(int local, int game, Utf8GamePath path) - { - if (local != game) - Penumbra.Log.Warning($"[ResourceLoader] Hash function appears to have changed. Computed {local:X8} vs Game {game:X8} for {path}."); - } -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/RsfService.cs b/Penumbra/Interop/Hooks/ResourceLoading/RsfService.cs deleted file mode 100644 index e7f06f91..00000000 --- a/Penumbra/Interop/Hooks/ResourceLoading/RsfService.cs +++ /dev/null @@ -1,203 +0,0 @@ -using Dalamud.Hooking; -using Dalamud.Plugin.Services; -using Dalamud.Utility.Signatures; -using OtterGui.Services; -using Penumbra.Api.Enums; -using Penumbra.GameData; -using Penumbra.Interop.Structs; -using Penumbra.String.Classes; -using ResourceHandle = FFXIVClientStructs.FFXIV.Client.System.Resource.Handle.ResourceHandle; -using TextureResourceHandle = Penumbra.Interop.Structs.TextureResourceHandle; - -namespace Penumbra.Interop.Hooks.ResourceLoading; - -public unsafe class RsfService : IDisposable, IRequiredService -{ - /// - /// We need to be able to obtain the requested LoD level. - /// This replicates the LoD behavior of a textures OnLoad function. - /// - private readonly struct LodService - { - public LodService(IGameInteropProvider interop) - => interop.InitializeFromAttributes(this); - - [Signature(Sigs.LodConfig)] - private readonly nint _lodConfig = nint.Zero; - - public byte GetLod(TextureResourceHandle* handle) - { - if (handle->ChangeLod) - { - var config = *(byte*)_lodConfig + 0xE; - if (config == byte.MaxValue) - return 2; - } - - return 0; - } - } - - /// Custom ulong flag to signal our files as opposed to SE files. - public static readonly nint CustomFileFlag = new(0xDEADBEEF); - - private readonly LodService _lodService; - - public RsfService(IGameInteropProvider interop) - { - interop.InitializeFromAttributes(this); - _lodService = new LodService(interop); - if (!HookOverrides.Instance.ResourceLoading.CheckFileState) - _checkFileStateHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.LoadMdlFileExtern) - _loadMdlFileExternHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.TexResourceHandleOnLoad) - _textureOnLoadHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.SoundOnLoad) - _soundOnLoadHook.Enable(); - } - - /// Add CRC64 if the given file is a model or texture file and has an associated path. - public void AddCrc(ResourceType type, FullPath? path) - { - _ = type switch - { - ResourceType.Mdl when path.HasValue => _customFileCrc.TryAdd(path.Value.Crc64, ResourceType.Mdl), - ResourceType.Tex when path.HasValue => _customFileCrc.TryAdd(path.Value.Crc64, ResourceType.Tex), - ResourceType.Scd when path.HasValue => _customFileCrc.TryAdd(path.Value.Crc64, ResourceType.Scd), - _ => false, - }; - } - - public void Dispose() - { - _checkFileStateHook.Dispose(); - _loadMdlFileExternHook.Dispose(); - _textureOnLoadHook.Dispose(); - _soundOnLoadHook.Dispose(); - } - - /// - /// We need to keep a list of all CRC64 hash values of our replaced Mdl and Tex files, - /// i.e. CRC32 of filename in the lower bytes, CRC32 of parent path in the upper bytes. - /// - private readonly Dictionary _customFileCrc = []; - - public IReadOnlyDictionary CustomCache - => _customFileCrc; - - private delegate nint CheckFileStatePrototype(nint unk1, ulong crc64); - - [Signature(Sigs.CheckFileState, DetourName = nameof(CheckFileStateDetour))] - private readonly Hook _checkFileStateHook = null!; - - private readonly ThreadLocal _texReturnData = new(() => default); - private readonly ThreadLocal _scdReturnData = new(() => default); - - private delegate void UpdateCategoryDelegate(TextureResourceHandle* resourceHandle); - - [Signature(Sigs.TexHandleUpdateCategory)] - private readonly UpdateCategoryDelegate _updateCategory = null!; - - private delegate byte SoundOnLoadDelegate(ResourceHandle* handle, SeFileDescriptor* descriptor, byte unk); - - [Signature(Sigs.LoadScdFileLocal)] - private readonly delegate* unmanaged _loadScdFileLocal = null!; - - [Signature(Sigs.SoundOnLoad, DetourName = nameof(OnScdLoadDetour))] - private readonly Hook _soundOnLoadHook = null!; - - [Signature(Sigs.RsfServiceAddress, ScanType = ScanType.StaticAddress)] - private readonly nint* _rsfService = null; - - private byte OnScdLoadDetour(ResourceHandle* handle, SeFileDescriptor* descriptor, byte unk) - { - byte ret; - if (*_rsfService == nint.Zero) - { - Penumbra.Log.Debug( - $"Resource load of {handle->FileName} before FFXIV RSF-service was instantiated, workaround by setting pointer."); - *_rsfService = 1; - ret = _soundOnLoadHook.Original(handle, descriptor, unk); - *_rsfService = nint.Zero; - } - else - { - ret = _soundOnLoadHook.Original(handle, descriptor, unk); - } - - if (!_scdReturnData.Value) - return ret; - - // Function failed on a replaced scd, call local. - _scdReturnData.Value = false; - ret = _loadScdFileLocal(handle, descriptor, unk); - return ret; - } - - /// - /// The function that checks a files CRC64 to determine whether it is 'protected'. - /// We use it to check against our stored CRC64s and if it corresponds, we return the custom flag for models. - /// Since Dawntrail inlined the RSF function for textures, we can not use the flag method here. - /// Instead, we signal the caller that this will fail and let it call the local function after intentionally failing. - /// - private nint CheckFileStateDetour(nint ptr, ulong crc64) - { - if (_customFileCrc.TryGetValue(crc64, out var type)) - switch (type) - { - case ResourceType.Mdl: return CustomFileFlag; - case ResourceType.Tex: - _texReturnData.Value = true; - return nint.Zero; - case ResourceType.Scd: - _scdReturnData.Value = true; - return nint.Zero; - } - - var ret = _checkFileStateHook.Original(ptr, crc64); - Penumbra.Log.Excessive($"[CheckFileState] Called on 0x{ptr:X} with CRC {crc64:X16}, returned 0x{ret:X}."); - return ret; - } - - private delegate byte LoadTexFileLocalDelegate(TextureResourceHandle* handle, int unk1, SeFileDescriptor* unk2, bool unk3); - - /// We use the local functions for our own files in the extern hook. - [Signature(Sigs.LoadTexFileLocal)] - private readonly LoadTexFileLocalDelegate _loadTexFileLocal = null!; - - private delegate byte LoadMdlFileLocalPrototype(ResourceHandle* handle, nint unk1, bool unk2); - - /// We use the local functions for our own files in the extern hook. - [Signature(Sigs.LoadMdlFileLocal)] - private readonly LoadMdlFileLocalPrototype _loadMdlFileLocal = null!; - - private delegate byte TexResourceHandleOnLoadPrototype(TextureResourceHandle* handle, SeFileDescriptor* descriptor, byte unk2); - - [Signature(Sigs.TexHandleOnLoad, DetourName = nameof(OnTexLoadDetour))] - private readonly Hook _textureOnLoadHook = null!; - - private byte OnTexLoadDetour(TextureResourceHandle* handle, SeFileDescriptor* descriptor, byte unk2) - { - var ret = _textureOnLoadHook.Original(handle, descriptor, unk2); - if (!_texReturnData.Value) - return ret; - - // Function failed on a replaced texture, call local. - _texReturnData.Value = false; - ret = _loadTexFileLocal(handle, _lodService.GetLod(handle), descriptor, unk2 != 0); - _updateCategory(handle); - return ret; - } - - private delegate byte LoadMdlFileExternPrototype(ResourceHandle* handle, nint unk1, bool unk2, nint unk3); - - [Signature(Sigs.LoadMdlFileExtern, DetourName = nameof(LoadMdlFileExternDetour))] - private readonly Hook _loadMdlFileExternHook = null!; - - /// We hook the extern functions to just return the local one if given the custom flag as last argument. - private byte LoadMdlFileExternDetour(ResourceHandle* resourceHandle, nint unk1, bool unk2, nint ptr) - => ptr.Equals(CustomFileFlag) - ? _loadMdlFileLocal.Invoke(resourceHandle, unk1, unk2) - : _loadMdlFileExternHook.Original(resourceHandle, unk1, unk2, ptr); -} diff --git a/Penumbra/Interop/Hooks/Resources/ApricotResourceLoad.cs b/Penumbra/Interop/Hooks/Resources/ApricotResourceLoad.cs index 40860b0b..2e5698a3 100644 --- a/Penumbra/Interop/Hooks/Resources/ApricotResourceLoad.cs +++ b/Penumbra/Interop/Hooks/Resources/ApricotResourceLoad.cs @@ -11,8 +11,7 @@ public sealed unsafe class ApricotResourceLoad : FastHook("Load Apricot Resource", Sigs.ApricotResourceLoad, Detour, - !HookOverrides.Instance.Resources.ApricotResourceLoad); + Task = hooks.CreateHook("Load Apricot Resource", Sigs.ApricotResourceLoad, Detour, true); } public delegate byte Delegate(ResourceHandle* handle, nint unk1, byte unk2); diff --git a/Penumbra/Interop/Hooks/Resources/LoadMtrl.cs b/Penumbra/Interop/Hooks/Resources/LoadMtrlShpk.cs similarity index 52% rename from Penumbra/Interop/Hooks/Resources/LoadMtrl.cs rename to Penumbra/Interop/Hooks/Resources/LoadMtrlShpk.cs index f56177e4..5ef3bf37 100644 --- a/Penumbra/Interop/Hooks/Resources/LoadMtrl.cs +++ b/Penumbra/Interop/Hooks/Resources/LoadMtrlShpk.cs @@ -5,28 +5,28 @@ using Penumbra.Services; namespace Penumbra.Interop.Hooks.Resources; -public sealed unsafe class LoadMtrl : FastHook +public sealed unsafe class LoadMtrlShpk : FastHook { private readonly GameState _gameState; private readonly CommunicatorService _communicator; - public LoadMtrl(HookManager hooks, GameState gameState, CommunicatorService communicator) + public LoadMtrlShpk(HookManager hooks, GameState gameState, CommunicatorService communicator) { - _gameState = gameState; + _gameState = gameState; _communicator = communicator; - Task = hooks.CreateHook("Load Material", Sigs.LoadMtrl, Detour, !HookOverrides.Instance.Resources.LoadMtrl); + Task = hooks.CreateHook("Load Material Shaders", Sigs.LoadMtrlShpk, Detour, true); } - public delegate byte Delegate(MaterialResourceHandle* mtrlResourceHandle, void* unk1, byte unk2); + public delegate byte Delegate(MaterialResourceHandle* mtrlResourceHandle); - private byte Detour(MaterialResourceHandle* handle, void* unk1, byte unk2) + private byte Detour(MaterialResourceHandle* handle) { var last = _gameState.MtrlData.Value; var mtrlData = _gameState.LoadSubFileHelper((nint)handle); _gameState.MtrlData.Value = mtrlData; - var ret = Task.Result.Original(handle, unk1, unk2); + var ret = Task.Result.Original(handle); _gameState.MtrlData.Value = last; - _communicator.MtrlLoaded.Invoke((nint)handle, mtrlData.AssociatedGameObject); + _communicator.MtrlShpkLoaded.Invoke((nint)handle, mtrlData.AssociatedGameObject); return ret; } } diff --git a/Penumbra/Interop/Hooks/Resources/LoadMtrlTex.cs b/Penumbra/Interop/Hooks/Resources/LoadMtrlTex.cs index 1866e859..14a011ea 100644 --- a/Penumbra/Interop/Hooks/Resources/LoadMtrlTex.cs +++ b/Penumbra/Interop/Hooks/Resources/LoadMtrlTex.cs @@ -4,7 +4,6 @@ using Penumbra.GameData; namespace Penumbra.Interop.Hooks.Resources; -// TODO check if this is still needed, as our hooked function is called by LoadMtrl's hooked function public sealed unsafe class LoadMtrlTex : FastHook { private readonly GameState _gameState; @@ -12,7 +11,7 @@ public sealed unsafe class LoadMtrlTex : FastHook public LoadMtrlTex(HookManager hooks, GameState gameState) { _gameState = gameState; - Task = hooks.CreateHook("Load Material Textures", Sigs.LoadMtrlTex, Detour, !HookOverrides.Instance.Resources.LoadMtrlTex); + Task = hooks.CreateHook("Load Material Textures", Sigs.LoadMtrlTex, Detour, true); } public delegate byte Delegate(MaterialResourceHandle* mtrlResourceHandle); diff --git a/Penumbra/Interop/Hooks/Resources/ResolvePathHooksBase.cs b/Penumbra/Interop/Hooks/Resources/ResolvePathHooksBase.cs index db39889e..4e24ba39 100644 --- a/Penumbra/Interop/Hooks/Resources/ResolvePathHooksBase.cs +++ b/Penumbra/Interop/Hooks/Resources/ResolvePathHooksBase.cs @@ -1,13 +1,11 @@ using System.Text.Unicode; using Dalamud.Hooking; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using OtterGui.Classes; using OtterGui.Services; using Penumbra.Collections; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; using Penumbra.Interop.PathResolving; -using Penumbra.Interop.Processing; -using static FFXIVClientStructs.FFXIV.Client.Game.Character.ActionEffectHandler; +using Penumbra.Meta.Manipulations; namespace Penumbra.Interop.Hooks.Resources; @@ -23,7 +21,6 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable private delegate nint NamedResolveDelegate(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex, nint name); private delegate nint PerSlotResolveDelegate(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex); private delegate nint SingleResolveDelegate(nint drawObject, nint pathBuffer, nint pathBufferSize); - private delegate nint SkeletonVFuncDelegate(nint drawObject, int estType, nint unk); private delegate nint TmbResolveDelegate(nint drawObject, nint pathBuffer, nint pathBufferSize, nint timelineName); @@ -36,17 +33,12 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable private readonly Hook _resolveMPapPathHook; private readonly Hook _resolveMdlPathHook; private readonly Hook _resolveMtrlPathHook; - private readonly Hook _resolveSkinMtrlPathHook; private readonly Hook _resolvePapPathHook; - private readonly Hook _resolveKdbPathHook; private readonly Hook _resolvePhybPathHook; - private readonly Hook _resolveBnmbPathHook; private readonly Hook _resolveSklbPathHook; private readonly Hook _resolveSkpPathHook; private readonly Hook _resolveTmbPathHook; private readonly Hook _resolveVfxPathHook; - private readonly Hook? _vFunc81Hook; - private readonly Hook? _vFunc83Hook; private readonly PathState _parent; @@ -54,28 +46,20 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable { _parent = parent; // @formatter:off - _resolveSklbPathHook = Create($"{name}.{nameof(ResolveSklb)}", hooks, vTable[76], type, ResolveSklb, ResolveSklbHuman); - _resolveMdlPathHook = Create($"{name}.{nameof(ResolveMdl)}", hooks, vTable[77], type, ResolveMdl, ResolveMdlHuman); - _resolveSkpPathHook = Create($"{name}.{nameof(ResolveSkp)}", hooks, vTable[78], type, ResolveSkp, ResolveSkpHuman); - _resolvePhybPathHook = Create($"{name}.{nameof(ResolvePhyb)}", hooks, vTable[79], type, ResolvePhyb, ResolvePhybHuman); - _resolveKdbPathHook = Create($"{name}.{nameof(ResolveKdb)}", hooks, vTable[80], type, ResolveKdb, ResolveKdbHuman); - _vFunc81Hook = Create( $"{name}.{nameof(VFunc81)}", hooks, vTable[81], type, null, VFunc81); - _resolveBnmbPathHook = Create($"{name}.{nameof(ResolveBnmb)}", hooks, vTable[82], type, ResolveBnmb, ResolveBnmbHuman); - _vFunc83Hook = Create( $"{name}.{nameof(VFunc83)}", hooks, vTable[83], type, null, VFunc83); - _resolvePapPathHook = Create( $"{name}.{nameof(ResolvePap)}", hooks, vTable[84], type, ResolvePap, ResolvePapHuman); - _resolveTmbPathHook = Create( $"{name}.{nameof(ResolveTmb)}", hooks, vTable[85], ResolveTmb); - _resolveMPapPathHook = Create( $"{name}.{nameof(ResolveMPap)}", hooks, vTable[87], ResolveMPap); - _resolveImcPathHook = Create($"{name}.{nameof(ResolveImc)}", hooks, vTable[89], ResolveImc); - _resolveMtrlPathHook = Create( $"{name}.{nameof(ResolveMtrl)}", hooks, vTable[90], ResolveMtrl); - _resolveSkinMtrlPathHook = Create($"{name}.{nameof(ResolveSkinMtrl)}", hooks, vTable[91], ResolveSkinMtrl); - _resolveDecalPathHook = Create($"{name}.{nameof(ResolveDecal)}", hooks, vTable[92], ResolveDecal); - _resolveVfxPathHook = Create( $"{name}.{nameof(ResolveVfx)}", hooks, vTable[93], type, ResolveVfx, ResolveVfxHuman); - _resolveEidPathHook = Create( $"{name}.{nameof(ResolveEid)}", hooks, vTable[94], ResolveEid); - - + _resolveDecalPathHook = Create($"{name}.{nameof(ResolveDecal)}", hooks, vTable[83], ResolveDecal); + _resolveEidPathHook = Create( $"{name}.{nameof(ResolveEid)}", hooks, vTable[85], ResolveEid); + _resolveImcPathHook = Create($"{name}.{nameof(ResolveImc)}", hooks, vTable[81], ResolveImc); + _resolveMPapPathHook = Create( $"{name}.{nameof(ResolveMPap)}", hooks, vTable[79], ResolveMPap); + _resolveMdlPathHook = Create($"{name}.{nameof(ResolveMdl)}", hooks, vTable[73], type, ResolveMdl, ResolveMdlHuman); + _resolveMtrlPathHook = Create( $"{name}.{nameof(ResolveMtrl)}", hooks, vTable[82], ResolveMtrl); + _resolvePapPathHook = Create( $"{name}.{nameof(ResolvePap)}", hooks, vTable[76], type, ResolvePap, ResolvePapHuman); + _resolvePhybPathHook = Create($"{name}.{nameof(ResolvePhyb)}", hooks, vTable[75], type, ResolvePhyb, ResolvePhybHuman); + _resolveSklbPathHook = Create($"{name}.{nameof(ResolveSklb)}", hooks, vTable[72], type, ResolveSklb, ResolveSklbHuman); + _resolveSkpPathHook = Create($"{name}.{nameof(ResolveSkp)}", hooks, vTable[74], type, ResolveSkp, ResolveSkpHuman); + _resolveTmbPathHook = Create( $"{name}.{nameof(ResolveTmb)}", hooks, vTable[77], ResolveTmb); + _resolveVfxPathHook = Create( $"{name}.{nameof(ResolveVfx)}", hooks, vTable[84], type, ResolveVfx, ResolveVfxHuman); // @formatter:on - if (!HookOverrides.Instance.Resources.ResolvePathHooks) - Enable(); + Enable(); } public void Enable() @@ -86,17 +70,12 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable _resolveMPapPathHook.Enable(); _resolveMdlPathHook.Enable(); _resolveMtrlPathHook.Enable(); - _resolveSkinMtrlPathHook.Enable(); _resolvePapPathHook.Enable(); - _resolveKdbPathHook.Enable(); _resolvePhybPathHook.Enable(); - _resolveBnmbPathHook.Enable(); _resolveSklbPathHook.Enable(); _resolveSkpPathHook.Enable(); _resolveTmbPathHook.Enable(); _resolveVfxPathHook.Enable(); - _vFunc81Hook?.Enable(); - _vFunc83Hook?.Enable(); } public void Disable() @@ -107,17 +86,12 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable _resolveMPapPathHook.Disable(); _resolveMdlPathHook.Disable(); _resolveMtrlPathHook.Disable(); - _resolveSkinMtrlPathHook.Disable(); _resolvePapPathHook.Disable(); - _resolveKdbPathHook.Disable(); _resolvePhybPathHook.Disable(); - _resolveBnmbPathHook.Disable(); _resolveSklbPathHook.Disable(); _resolveSkpPathHook.Disable(); _resolveTmbPathHook.Disable(); _resolveVfxPathHook.Disable(); - _vFunc81Hook?.Disable(); - _vFunc83Hook?.Disable(); } public void Dispose() @@ -128,17 +102,12 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable _resolveMPapPathHook.Dispose(); _resolveMdlPathHook.Dispose(); _resolveMtrlPathHook.Dispose(); - _resolveSkinMtrlPathHook.Dispose(); _resolvePapPathHook.Dispose(); - _resolveKdbPathHook.Dispose(); _resolvePhybPathHook.Dispose(); - _resolveBnmbPathHook.Dispose(); _resolveSklbPathHook.Dispose(); _resolveSkpPathHook.Dispose(); _resolveTmbPathHook.Dispose(); _resolveVfxPathHook.Dispose(); - _vFunc81Hook?.Dispose(); - _vFunc83Hook?.Dispose(); } private nint ResolveDecal(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex) @@ -159,27 +128,12 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable private nint ResolveMtrl(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex, nint mtrlFileName) => ResolvePath(drawObject, _resolveMtrlPathHook.Original(drawObject, pathBuffer, pathBufferSize, slotIndex, mtrlFileName)); - private nint ResolveSkinMtrl(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex) - { - var finalPathBuffer = _resolveSkinMtrlPathHook.Original(drawObject, pathBuffer, pathBufferSize, slotIndex); - if (DebugConfiguration.UseSkinMaterialProcessing && finalPathBuffer != nint.Zero && finalPathBuffer == pathBuffer) - SkinMtrlPathEarlyProcessing.Process(new Span((void*)pathBuffer, (int)pathBufferSize), (CharacterBase*)drawObject, slotIndex); - - return ResolvePath(drawObject, finalPathBuffer); - } - private nint ResolvePap(nint drawObject, nint pathBuffer, nint pathBufferSize, uint unkAnimationIndex, nint animationName) => ResolvePath(drawObject, _resolvePapPathHook.Original(drawObject, pathBuffer, pathBufferSize, unkAnimationIndex, animationName)); - private nint ResolveKdb(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) - => ResolvePath(drawObject, _resolveKdbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - private nint ResolvePhyb(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) => ResolvePath(drawObject, _resolvePhybPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - private nint ResolveBnmb(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) - => ResolvePath(drawObject, _resolveBnmbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - private nint ResolveSklb(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) => ResolvePath(drawObject, _resolveSklbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); @@ -195,150 +149,84 @@ public sealed unsafe class ResolvePathHooksBase : IDisposable private nint ResolveMdlHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - if (slotIndex < 10) - _parent.MetaState.EqdpCollection.Push(collection); - - var ret = ResolvePath(collection, _resolveMdlPathHook.Original(drawObject, pathBuffer, pathBufferSize, slotIndex)); - if (slotIndex < 10) - _parent.MetaState.EqdpCollection.Pop(); - - return ret; + var data = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); + using var eqdp = slotIndex > 9 || _parent.InInternalResolve + ? DisposableContainer.Empty + : _parent.MetaState.ResolveEqdpData(data.ModCollection, MetaState.GetHumanGenderRace(drawObject), slotIndex < 5, slotIndex > 4); + return ResolvePath(data, _resolveMdlPathHook.Original(drawObject, pathBuffer, pathBufferSize, slotIndex)); } private nint ResolvePapHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint unkAnimationIndex, nint animationName) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, - _resolvePapPathHook.Original(drawObject, pathBuffer, pathBufferSize, unkAnimationIndex, animationName)); - _parent.MetaState.EstCollection.Pop(); - return ret; - } - - private nint ResolveKdbHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) - { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, _resolveKdbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - _parent.MetaState.EstCollection.Pop(); - return ret; + using var est = GetEstChanges(drawObject, out var data); + return ResolvePath(data, _resolvePapPathHook.Original(drawObject, pathBuffer, pathBufferSize, unkAnimationIndex, animationName)); } private nint ResolvePhybHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, _resolvePhybPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - _parent.MetaState.EstCollection.Pop(); - return ret; - } - - private nint ResolveBnmbHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) - { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, _resolveBnmbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - _parent.MetaState.EstCollection.Pop(); - return ret; + using var est = GetEstChanges(drawObject, out var data); + return ResolvePath(data, _resolvePhybPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); } private nint ResolveSklbHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, _resolveSklbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - _parent.MetaState.EstCollection.Pop(); - return ret; + using var est = GetEstChanges(drawObject, out var data); + return ResolvePath(data, _resolveSklbPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); } private nint ResolveSkpHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint partialSkeletonIndex) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = ResolvePath(collection, _resolveSkpPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); - _parent.MetaState.EstCollection.Pop(); - return ret; + using var est = GetEstChanges(drawObject, out var data); + return ResolvePath(data, _resolveSkpPathHook.Original(drawObject, pathBuffer, pathBufferSize, partialSkeletonIndex)); } private nint ResolveVfxHuman(nint drawObject, nint pathBuffer, nint pathBufferSize, uint slotIndex, nint unkOutParam) { - switch (slotIndex) - { - case <= 4: return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - case <= 10: - { - // Enable vfxs for accessories - var changedEquipData = (ChangedEquipData*)((Human*)drawObject)->ChangedEquipData; - if (changedEquipData == null) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); + if (slotIndex <= 4) + return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - ref var slot = ref changedEquipData[slotIndex]; + var changedEquipData = ((Human*)drawObject)->ChangedEquipData; + // Enable vfxs for accessories + if (changedEquipData == null) + return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - if (slot.Model == 0 || slot.Variant == 0 || slot.VfxId == 0) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); + var slot = (ushort*)(changedEquipData + 12 * (nint)slotIndex); + var model = slot[0]; + var variant = slot[1]; + var vfxId = slot[4]; - if (!Utf8.TryWrite(new Span((void*)pathBuffer, (int)pathBufferSize), - $"chara/accessory/a{slot.Model.Id:D4}/vfx/eff/va{slot.VfxId:D4}.avfx\0", - out _)) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); + if (model == 0 || variant == 0 || vfxId == 0) + return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - *(ulong*)unkOutParam = 4; - return ResolvePath(drawObject, pathBuffer); - } - case 16: - { - // Enable vfxs for glasses - var changedEquipData = (ChangedEquipData*)((Human*)drawObject)->ChangedEquipData; - if (changedEquipData == null) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); + if (!Utf8.TryWrite(new Span((void*)pathBuffer, (int)pathBufferSize), $"chara/accessory/a{model:D4}/vfx/eff/va{vfxId:D4}.avfx\0", + out _)) + return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - ref var slot = ref changedEquipData[slotIndex - 6]; - - if (slot.BonusModel == 0 || slot.BonusVariant == 0 || slot.VfxId == 0) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - if (!Utf8.TryWrite(new Span((void*)pathBuffer, (int)pathBufferSize), - $"chara/equipment/e{slot.BonusModel.Id:D4}/vfx/eff/ve{slot.VfxId:D4}.avfx\0", - out _)) - return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - - *(ulong*)unkOutParam = 4; - return ResolvePath(drawObject, pathBuffer); - } - default: return ResolveVfx(drawObject, pathBuffer, pathBufferSize, slotIndex, unkOutParam); - } + *(ulong*)unkOutParam = 4; + return ResolvePath(drawObject, pathBuffer); } - private nint VFunc81(nint drawObject, int estType, nint unk) + private DisposableContainer GetEstChanges(nint drawObject, out ResolveData data) { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = _vFunc81Hook!.Original(drawObject, estType, unk); - _parent.MetaState.EstCollection.Pop(); - return ret; + data = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); + if (_parent.InInternalResolve) + return DisposableContainer.Empty; + + return new DisposableContainer(data.ModCollection.TemporarilySetEstFile(_parent.CharacterUtility, EstManipulation.EstType.Face), + data.ModCollection.TemporarilySetEstFile(_parent.CharacterUtility, EstManipulation.EstType.Body), + data.ModCollection.TemporarilySetEstFile(_parent.CharacterUtility, EstManipulation.EstType.Hair), + data.ModCollection.TemporarilySetEstFile(_parent.CharacterUtility, EstManipulation.EstType.Head)); } - private nint VFunc83(nint drawObject, int estType, nint unk) - { - var collection = _parent.CollectionResolver.IdentifyCollection((DrawObject*)drawObject, true); - _parent.MetaState.EstCollection.Push(collection); - var ret = _vFunc83Hook!.Original(drawObject, estType, unk); - _parent.MetaState.EstCollection.Pop(); - return ret; - } [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - [return: NotNullIfNotNull(nameof(other))] - private static Hook? Create(string name, HookManager hooks, nint address, Type type, T? other, T human) where T : Delegate + private static Hook Create(string name, HookManager hooks, nint address, Type type, T other, T human) where T : Delegate { var del = type switch { Type.Human => human, _ => other, }; - if (del == null) - return null; - return hooks.CreateHook(name, address, del).Result; } diff --git a/Penumbra/Interop/Hooks/Resources/ResourceHandleDestructor.cs b/Penumbra/Interop/Hooks/Resources/ResourceHandleDestructor.cs index 0e04029b..5ddb7eaa 100644 --- a/Penumbra/Interop/Hooks/Resources/ResourceHandleDestructor.cs +++ b/Penumbra/Interop/Hooks/Resources/ResourceHandleDestructor.cs @@ -3,7 +3,6 @@ using OtterGui.Classes; using OtterGui.Services; using Penumbra.GameData; using Penumbra.Interop.Structs; -using Penumbra.UI.ResourceWatcher; namespace Penumbra.Interop.Hooks.Resources; @@ -14,20 +13,13 @@ public sealed unsafe class ResourceHandleDestructor : EventWrapperPtr SubfileHelper, - /// + /// ShaderReplacementFixer, - - /// - ResourceLoader, - - /// - ResourceWatcher, } public ResourceHandleDestructor(HookManager hooks) : base("Destroy ResourceHandle") - => _task = hooks.CreateHook(Name, Sigs.ResourceHandleDestructor, Detour, - !HookOverrides.Instance.Resources.ResourceHandleDestructor); + => _task = hooks.CreateHook(Name, Sigs.ResourceHandleDestructor, Detour, true); private readonly Task> _task; diff --git a/Penumbra/Interop/MaterialPreview/LiveColorTablePreviewer.cs b/Penumbra/Interop/MaterialPreview/LiveColorTablePreviewer.cs index 0415fc9d..8e75a895 100644 --- a/Penumbra/Interop/MaterialPreview/LiveColorTablePreviewer.cs +++ b/Penumbra/Interop/MaterialPreview/LiveColorTablePreviewer.cs @@ -1,6 +1,5 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using Penumbra.GameData.Interop; using Penumbra.Interop.SafeHandles; @@ -8,6 +7,10 @@ namespace Penumbra.Interop.MaterialPreview; public sealed unsafe class LiveColorTablePreviewer : LiveMaterialPreviewerBase { + public const int TextureWidth = 4; + public const int TextureHeight = GameData.Files.MaterialStructs.LegacyColorTable.NumUsedRows; + public const int TextureLength = TextureWidth * TextureHeight * 4; + private readonly IFramework _framework; private readonly Texture** _colorTableTexture; @@ -15,9 +18,6 @@ public sealed unsafe class LiveColorTablePreviewer : LiveMaterialPreviewerBase private bool _updatePending; - public int Width { get; } - public int Height { get; } - public Half[] ColorTable { get; } public LiveColorTablePreviewer(ObjectManager objects, IFramework framework, MaterialInfo materialInfo) @@ -33,24 +33,18 @@ public sealed unsafe class LiveColorTablePreviewer : LiveMaterialPreviewerBase if (colorSetTextures == null) throw new InvalidOperationException("Draw object doesn't have color table textures"); - _colorTableTexture = colorSetTextures + (MaterialInfo.ModelSlot * CharacterBase.MaterialsPerSlot + MaterialInfo.MaterialSlot); - + _colorTableTexture = colorSetTextures + (MaterialInfo.ModelSlot * 4 + MaterialInfo.MaterialSlot); _originalColorTableTexture = new SafeTextureHandle(*_colorTableTexture, true); - if (_originalColorTableTexture.Texture == null) + if (_originalColorTableTexture == null) throw new InvalidOperationException("Material doesn't have a color table"); - Width = (int)_originalColorTableTexture.Texture->ActualWidth; - Height = (int)_originalColorTableTexture.Texture->ActualHeight; - ColorTable = new Half[Width * Height * 4]; + ColorTable = new Half[TextureLength]; _updatePending = true; framework.Update += OnFrameworkUpdate; } - public Span GetColorRow(int i) - => ColorTable.AsSpan().Slice(Width * 4 * i, Width * 4); - protected override void Clear(bool disposing, bool reset) { _framework.Update -= OnFrameworkUpdate; @@ -80,13 +74,11 @@ public sealed unsafe class LiveColorTablePreviewer : LiveMaterialPreviewerBase return; var textureSize = stackalloc int[2]; - textureSize[0] = Width; - textureSize[1] = Height; + textureSize[0] = TextureWidth; + textureSize[1] = TextureHeight; using var texture = - new SafeTextureHandle( - Device.Instance()->CreateTexture2D(textureSize, 1, TextureFormat.R16G16B16A16_FLOAT, - TextureFlags.TextureNoSwizzle | TextureFlags.Immutable | TextureFlags.Managed, 7), false); + new SafeTextureHandle(Device.Instance()->CreateTexture2D(textureSize, 1, 0x2460, 0x80000804, 7), false); if (texture.IsInvalid) return; @@ -112,6 +104,6 @@ public sealed unsafe class LiveColorTablePreviewer : LiveMaterialPreviewerBase if (colorSetTextures == null) return false; - return _colorTableTexture == colorSetTextures + (MaterialInfo.ModelSlot * CharacterBase.MaterialsPerSlot + MaterialInfo.MaterialSlot); + return _colorTableTexture == colorSetTextures + (MaterialInfo.ModelSlot * 4 + MaterialInfo.MaterialSlot); } } diff --git a/Penumbra/Interop/MaterialPreview/LiveMaterialPreviewer.cs b/Penumbra/Interop/MaterialPreview/LiveMaterialPreviewer.cs index 60762ac7..0556fdc4 100644 --- a/Penumbra/Interop/MaterialPreview/LiveMaterialPreviewer.cs +++ b/Penumbra/Interop/MaterialPreview/LiveMaterialPreviewer.cs @@ -7,9 +7,9 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase { private readonly ShaderPackage* _shaderPackage; - private readonly uint _originalShPkFlags; - private readonly byte[] _originalMaterialParameter; - private readonly uint[] _originalSamplerFlags; + private readonly uint _originalShPkFlags; + private readonly float[] _originalMaterialParameter; + private readonly uint[] _originalSamplerFlags; public LiveMaterialPreviewer(ObjectManager objects, MaterialInfo materialInfo) : base(objects, materialInfo) @@ -28,7 +28,7 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase _originalShPkFlags = Material->ShaderFlags; - _originalMaterialParameter = Material->MaterialParameterCBuffer->TryGetBuffer().ToArray(); + _originalMaterialParameter = Material->MaterialParameterCBuffer->TryGetBuffer().ToArray(); _originalSamplerFlags = new uint[Material->TextureCount]; for (var i = 0; i < _originalSamplerFlags.Length; ++i) @@ -43,7 +43,7 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase return; Material->ShaderFlags = _originalShPkFlags; - var materialParameter = Material->MaterialParameterCBuffer->TryGetBuffer(); + var materialParameter = Material->MaterialParameterCBuffer->TryGetBuffer(); if (!materialParameter.IsEmpty) _originalMaterialParameter.AsSpan().CopyTo(materialParameter); @@ -59,7 +59,7 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase Material->ShaderFlags = shPkFlags; } - public void SetMaterialParameter(uint parameterCrc, Index offset, ReadOnlySpan value) + public void SetMaterialParameter(uint parameterCrc, Index offset, Span value) { if (!CheckValidity()) return; @@ -68,7 +68,7 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase if (constantBuffer == null) return; - var buffer = constantBuffer->TryGetBuffer(); + var buffer = constantBuffer->TryGetBuffer(); if (buffer.IsEmpty) return; @@ -78,10 +78,12 @@ public sealed unsafe class LiveMaterialPreviewer : LiveMaterialPreviewerBase if (parameter.CRC != parameterCrc) continue; - if (parameter.Offset + parameter.Size > buffer.Length) + if ((parameter.Offset & 0x3) != 0 + || (parameter.Size & 0x3) != 0 + || (parameter.Offset + parameter.Size) >> 2 > buffer.Length) return; - value.TryCopyTo(buffer.Slice(parameter.Offset, parameter.Size)[offset..]); + value.TryCopyTo(buffer.Slice(parameter.Offset >> 2, parameter.Size >> 2)[offset..]); return; } } diff --git a/Penumbra/Interop/MaterialPreview/MaterialInfo.cs b/Penumbra/Interop/MaterialPreview/MaterialInfo.cs index a9fb46ff..61e7c764 100644 --- a/Penumbra/Interop/MaterialPreview/MaterialInfo.cs +++ b/Penumbra/Interop/MaterialPreview/MaterialInfo.cs @@ -3,9 +3,8 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Render; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using Penumbra.GameData.Interop; using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceTree; using Penumbra.String; -using static Penumbra.Interop.Structs.StructExtensions; using Model = Penumbra.GameData.Interop.Model; namespace Penumbra.Interop.MaterialPreview; @@ -49,10 +48,7 @@ public readonly record struct MaterialInfo(ObjectIndex ObjectIndex, DrawObjectTy public static unsafe List FindMaterials(IEnumerable gameObjects, string materialPath) { - var needle = CiByteString.FromString(materialPath.Replace('\\', '/'), out var m, - MetaDataComputation.CiCrc32 | MetaDataComputation.Crc32) - ? m - : CiByteString.Empty; + var needle = ByteString.FromString(materialPath.Replace('\\', '/'), out var m, true) ? m : ByteString.Empty; var result = new List(Enum.GetValues().Length); foreach (var objectPtr in gameObjects) @@ -82,12 +78,8 @@ public readonly record struct MaterialInfo(ObjectIndex ObjectIndex, DrawObjectTy continue; var mtrlHandle = material->MaterialResourceHandle; - if (mtrlHandle == null) - continue; - - PathDataHandler.Split(mtrlHandle->FileName.AsSpan(), out var path, out _); - var fileName = CiByteString.FromSpanUnsafe(path, true); - if (fileName == needle) + var path = ResolveContext.GetResourceHandlePath(&mtrlHandle->ResourceHandle); + if (path == needle) result.Add(new MaterialInfo(index, type, i, j)); } } diff --git a/Penumbra/Interop/PathResolving/CollectionResolver.cs b/Penumbra/Interop/PathResolving/CollectionResolver.cs index 136393d4..aea58304 100644 --- a/Penumbra/Interop/PathResolving/CollectionResolver.cs +++ b/Penumbra/Interop/PathResolving/CollectionResolver.cs @@ -1,7 +1,5 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using FFXIVClientStructs.FFXIV.Client.UI.Agent; -using OtterGui.Extensions; using OtterGui.Services; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -9,8 +7,6 @@ using Penumbra.GameData.Actors; using Penumbra.GameData.DataContainers; using Penumbra.GameData.Enums; using Penumbra.GameData.Interop; -using Penumbra.GameData.Structs; -using Penumbra.String; using Penumbra.Util; using Character = FFXIVClientStructs.FFXIV.Client.Game.Character.Character; using GameObject = FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject; @@ -63,11 +59,10 @@ public sealed unsafe class CollectionResolver( try { - // Login screen reuses the same actors and can not be cached. - if (LoginScreen(gameObject, out var data)) + if (useCache && cache.TryGetValue(gameObject, out var data)) return data; - if (useCache && cache.TryGetValue(gameObject, out data)) + if (LoginScreen(gameObject, out data)) return data; if (Aesthetician(gameObject, out data)) @@ -89,25 +84,24 @@ public sealed unsafe class CollectionResolver( /// Identify the correct collection for a draw object. public ResolveData IdentifyCollection(DrawObject* drawObject, bool useCache) { - if (drawObject is null) - return DefaultCollection; - - Actor obj = drawObjectState.TryGetValue(drawObject, out var gameObject) + var obj = (GameObject*)(drawObjectState.TryGetValue((nint)drawObject, out var gameObject) ? gameObject.Item1 - : drawObjectState.LastGameObject; - return IdentifyCollection(obj.AsObject, useCache); + : drawObjectState.LastGameObject); + return IdentifyCollection(obj, useCache); } - /// Get the default collection. - public ResolveData DefaultCollection - => collectionManager.Active.Default.ToResolveData(); - /// Return whether the given ModelChara id refers to a human-type model. public bool IsModelHuman(uint modelCharaId) => humanModels.IsHuman(modelCharaId); + /// Return whether the given character has a human model. + public bool IsModelHuman(Character* character) + => character != null && IsModelHuman((uint)character->CharacterData.ModelCharaId); + /// - /// Used if on the Login screen. + /// Used if on the Login screen. Names are populated after actors are drawn, + /// so it is not possible to fetch names from the ui list. + /// Actors are also not named. So use Yourself > Players > Racial > Default. /// private bool LoginScreen(GameObject* gameObject, out ResolveData ret) { @@ -119,57 +113,23 @@ public sealed unsafe class CollectionResolver( return false; } - if (!config.ShowModsInLobby) - { - ret = ModCollection.Empty.ToResolveData(gameObject); - return true; - } - - var notYetReady = false; - var lobby = AgentLobby.Instance(); - var characterList = CharaSelectCharacterList.Instance(); - if (lobby != null && characterList != null) - { - // The lobby uses the first 8 cutscene actors. - var idx = gameObject->ObjectIndex - ObjectIndex.CutsceneStart.Index; - if (characterList->CharacterMapping.FindFirst(m => m.ClientObjectIndex == idx, out var mapping) - && lobby->LobbyData.CharaSelectEntries.FindFirst(e => e.Value->ContentId == mapping.ContentId, out var charaEntry)) - { - var item = charaEntry.Value; - var identifier = actors.CreatePlayer(new ByteString(item->Name), item->HomeWorldId); - Penumbra.Log.Excessive( - $"Identified {identifier.Incognito(null)} in cutscene for actor {idx + 200} at 0x{(ulong)gameObject:X} of race {(gameObject->IsCharacter() ? ((Character*)gameObject)->DrawData.CustomizeData.Race.ToString() : "Unknown")}."); - if (identifier.IsValid && CollectionByIdentifier(identifier) is { } coll) - { - // Do not add this to caches because game objects are reused for different draw objects. - ret = coll.ToResolveData(gameObject); - return true; - } - } - } - + var notYetReady = false; var collection = collectionManager.Active.ByType(CollectionType.Yourself) ?? CollectionByAttributes(gameObject, ref notYetReady) ?? collectionManager.Active.Default; - ret = collection.ToResolveData(gameObject); + ret = notYetReady ? collection.ToResolveData(gameObject) : cache.Set(collection, ActorIdentifier.Invalid, gameObject); return true; } /// Used if at the aesthetician. The relevant actor is yourself, so use player collection when possible. private bool Aesthetician(GameObject* gameObject, out ResolveData ret) { - if (gameGui.GetAddonByName("ScreenLog") != nint.Zero) + if (gameGui.GetAddonByName("ScreenLog") != IntPtr.Zero) { ret = ResolveData.Invalid; return false; } - if (!config.ShowModsInLobby) - { - ret = ModCollection.Empty.ToResolveData(gameObject); - return true; - } - var player = actors.GetCurrentPlayer(); var notYetReady = false; var collection = (player.IsValid ? CollectionByIdentifier(player) : null) @@ -206,24 +166,10 @@ public sealed unsafe class CollectionResolver( /// Check both temporary and permanent character collections. Temporary first. private ModCollection? CollectionByIdentifier(ActorIdentifier identifier) - { - if (tempCollections.Collections.TryGetCollection(identifier, out var collection)) - return collection; - - // Always inherit ownership for temporary collections. - if (identifier.Type is IdentifierType.Owned) - { - var playerIdentifier = actors.CreateIndividualUnchecked(IdentifierType.Player, identifier.PlayerName, - identifier.HomeWorld.Id, ObjectKind.None, uint.MaxValue); - if (tempCollections.Collections.TryGetCollection(playerIdentifier, out collection)) - return collection; - } - - if (collectionManager.Active.Individuals.TryGetCollection(identifier, out collection)) - return collection; - - return null; - } + => tempCollections.Collections.TryGetCollection(identifier, out var collection) + || collectionManager.Active.Individuals.TryGetCollection(identifier, out collection) + ? collection + : null; /// Check for the Yourself collection. private ModCollection? CheckYourself(ActorIdentifier identifier, Actor actor) @@ -240,14 +186,11 @@ public sealed unsafe class CollectionResolver( private ModCollection? CollectionByAttributes(Actor actor, ref bool notYetReady) { if (!actor.IsCharacter) - { - Penumbra.Log.Excessive($"Actor to be identified was not yet a Character."); - notYetReady = true; return null; - } // Only handle human models. - if (!IsModelHuman((uint)actor.AsCharacter->ModelContainer.ModelCharaId)) + + if (!IsModelHuman((uint)actor.AsCharacter->CharacterData.ModelCharaId)) return null; if (actor.Customize->Data[0] == 0) diff --git a/Penumbra/Interop/PathResolving/CutsceneService.cs b/Penumbra/Interop/PathResolving/CutsceneService.cs index 97e64f84..93fee11e 100644 --- a/Penumbra/Interop/PathResolving/CutsceneService.cs +++ b/Penumbra/Interop/PathResolving/CutsceneService.cs @@ -1,6 +1,6 @@ -using Dalamud.Game.ClientState.Objects.Types; using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Game.Character; +using FFXIVClientStructs.FFXIV.Client.Game.Object; using OtterGui.Services; using Penumbra.GameData.Enums; using Penumbra.GameData.Interop; @@ -9,33 +9,30 @@ using Penumbra.String; namespace Penumbra.Interop.PathResolving; -public sealed class CutsceneService : IRequiredService, IDisposable +public sealed class CutsceneService : IService, IDisposable { public const int CutsceneStartIdx = (int)ScreenActor.CutsceneStart; public const int CutsceneEndIdx = (int)ScreenActor.CutsceneEnd; public const int CutsceneSlots = CutsceneEndIdx - CutsceneStartIdx; - private readonly ObjectManager _objects; - private readonly CopyCharacter _copyCharacter; - private readonly CharacterDestructor _characterDestructor; - private readonly ConstructCutsceneCharacter _constructCutsceneCharacter; - private readonly short[] _copiedCharacters = Enumerable.Repeat((short)-1, CutsceneSlots).ToArray(); + private readonly ObjectManager _objects; + private readonly CopyCharacter _copyCharacter; + private readonly CharacterDestructor _characterDestructor; + private readonly short[] _copiedCharacters = Enumerable.Repeat((short)-1, CutsceneSlots).ToArray(); - public IEnumerable> Actors + public IEnumerable> Actors => Enumerable.Range(CutsceneStartIdx, CutsceneSlots) .Where(i => _objects[i].Valid) .Select(i => KeyValuePair.Create(i, this[i] ?? _objects.GetDalamudObject(i)!)); public unsafe CutsceneService(ObjectManager objects, CopyCharacter copyCharacter, CharacterDestructor characterDestructor, - ConstructCutsceneCharacter constructCutsceneCharacter, IClientState clientState) + IClientState clientState) { - _objects = objects; - _copyCharacter = copyCharacter; - _characterDestructor = characterDestructor; - _constructCutsceneCharacter = constructCutsceneCharacter; + _objects = objects; + _copyCharacter = copyCharacter; + _characterDestructor = characterDestructor; _copyCharacter.Subscribe(OnCharacterCopy, CopyCharacter.Priority.CutsceneService); _characterDestructor.Subscribe(OnCharacterDestructor, CharacterDestructor.Priority.CutsceneService); - _constructCutsceneCharacter.Subscribe(OnSetupPlayerNpc, ConstructCutsceneCharacter.Priority.CutsceneService); if (clientState.IsGPosing) RecoverGPoseActors(); } @@ -46,7 +43,7 @@ public sealed class CutsceneService : IRequiredService, IDisposable /// Does not check for valid input index. /// Returns null if no connected actor is set or the actor does not exist anymore. /// - private IGameObject? this[int idx] + private Dalamud.Game.ClientState.Objects.Types.GameObject? this[int idx] { get { @@ -75,7 +72,6 @@ public sealed class CutsceneService : IRequiredService, IDisposable return false; _copiedCharacters[copyIdx - CutsceneStartIdx] = (short)parentIdx; - _objects.InvokeRequiredUpdates(); return true; } @@ -91,7 +87,6 @@ public sealed class CutsceneService : IRequiredService, IDisposable { _copyCharacter.Unsubscribe(OnCharacterCopy); _characterDestructor.Unsubscribe(OnCharacterDestructor); - _constructCutsceneCharacter.Unsubscribe(OnSetupPlayerNpc); } private unsafe void OnCharacterDestructor(Character* character) @@ -129,15 +124,6 @@ public sealed class CutsceneService : IRequiredService, IDisposable _copiedCharacters[idx] = (short)(source != null ? source->GameObject.ObjectIndex : -1); } - private unsafe void OnSetupPlayerNpc(Character* npc) - { - if (npc == null || npc->ObjectIndex is < CutsceneStartIdx or >= CutsceneEndIdx) - return; - - var idx = npc->GameObject.ObjectIndex - CutsceneStartIdx; - _copiedCharacters[idx] = 0; - } - /// Try to recover GPose actors on reloads into a running game. /// This is not 100% accurate due to world IDs, minions etc., but will be mostly sane. private void RecoverGPoseActors() diff --git a/Penumbra/Interop/PathResolving/DrawObjectState.cs b/Penumbra/Interop/PathResolving/DrawObjectState.cs index 6f3e457c..2a9ec7a9 100644 --- a/Penumbra/Interop/PathResolving/DrawObjectState.cs +++ b/Penumbra/Interop/PathResolving/DrawObjectState.cs @@ -1,4 +1,3 @@ -using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Services; @@ -9,42 +8,38 @@ using Penumbra.Interop.Hooks.Objects; namespace Penumbra.Interop.PathResolving; -public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary, IService +public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary, IService { private readonly ObjectManager _objects; private readonly CreateCharacterBase _createCharacterBase; private readonly WeaponReload _weaponReload; private readonly CharacterBaseDestructor _characterBaseDestructor; - private readonly CharacterDestructor _characterDestructor; private readonly GameState _gameState; - private readonly Dictionary _drawObjectToGameObject = []; + private readonly Dictionary _drawObjectToGameObject = []; public nint LastGameObject => _gameState.LastGameObject; public unsafe DrawObjectState(ObjectManager objects, CreateCharacterBase createCharacterBase, WeaponReload weaponReload, - CharacterBaseDestructor characterBaseDestructor, GameState gameState, IFramework framework, CharacterDestructor characterDestructor) + CharacterBaseDestructor characterBaseDestructor, GameState gameState) { _objects = objects; _createCharacterBase = createCharacterBase; _weaponReload = weaponReload; _characterBaseDestructor = characterBaseDestructor; _gameState = gameState; - _characterDestructor = characterDestructor; - framework.RunOnFrameworkThread(InitializeDrawObjects); - _weaponReload.Subscribe(OnWeaponReloading, WeaponReload.Priority.DrawObjectState); _weaponReload.Subscribe(OnWeaponReloaded, WeaponReload.PostEvent.Priority.DrawObjectState); _createCharacterBase.Subscribe(OnCharacterBaseCreated, CreateCharacterBase.PostEvent.Priority.DrawObjectState); _characterBaseDestructor.Subscribe(OnCharacterBaseDestructor, CharacterBaseDestructor.Priority.DrawObjectState); - _characterDestructor.Subscribe(OnCharacterDestructor, CharacterDestructor.Priority.DrawObjectState); + InitializeDrawObjects(); } - public bool ContainsKey(Model key) + public bool ContainsKey(nint key) => _drawObjectToGameObject.ContainsKey(key); - public IEnumerator> GetEnumerator() + public IEnumerator> GetEnumerator() => _drawObjectToGameObject.GetEnumerator(); IEnumerator IEnumerable.GetEnumerator() @@ -53,28 +48,16 @@ public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary _drawObjectToGameObject.Count; - public bool TryGetValue(Model drawObject, out (Actor, ObjectIndex, bool) gameObject) - { - if (!_drawObjectToGameObject.TryGetValue(drawObject, out gameObject)) - return false; + public bool TryGetValue(nint drawObject, out (nint, bool) gameObject) + => _drawObjectToGameObject.TryGetValue(drawObject, out gameObject); - var currentObject = _objects[gameObject.Item2]; - if (currentObject != gameObject.Item1) - { - Penumbra.Log.Warning($"[DrawObjectState] Stored association {drawObject} -> {gameObject.Item1} has index {gameObject.Item2}, which resolves to {currentObject}."); - return false; - } - - return true; - } - - public (Actor, ObjectIndex, bool) this[Model key] + public (nint, bool) this[nint key] => _drawObjectToGameObject[key]; - public IEnumerable Keys + public IEnumerable Keys => _drawObjectToGameObject.Keys; - public IEnumerable<(Actor, ObjectIndex, bool)> Values + public IEnumerable<(nint, bool)> Values => _drawObjectToGameObject.Values; public unsafe void Dispose() @@ -83,37 +66,6 @@ public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary - /// Seems like sometimes the draw object of a game object is destroyed in frames after the original game object is already destroyed. - /// So protect against outdated game object pointers in the dictionary. - /// - private unsafe void OnCharacterDestructor(Character* a) - { - if (a is null) - return; - - var character = (nint)a; - var delete = stackalloc nint[5]; - var current = 0; - foreach (var (drawObject, (gameObject, _, _)) in _drawObjectToGameObject) - { - if (gameObject != character) - continue; - - delete[current++] = drawObject; - if (current is 4) - break; - } - - for (var ptr = delete; *ptr != nint.Zero; ++ptr) - { - _drawObjectToGameObject.Remove(*ptr, out var pair); - Penumbra.Log.Excessive( - $"[DrawObjectState] Removed draw object 0x{*ptr:X} -> 0x{(nint)a:X} (actual: 0x{pair.GameObject.Address:X}, {pair.IsChild})."); - } } private unsafe void OnWeaponReloading(DrawDataContainer* _, Character* character, CharacterWeapon* _2) @@ -131,9 +83,9 @@ public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary @@ -142,19 +94,19 @@ public sealed class DrawObjectState : IDisposable, IReadOnlyDictionary private unsafe void InitializeDrawObjects() { - foreach (var actor in _objects) - { + foreach(var actor in _objects) + { if (actor is { IsCharacter: true, Model.Valid: true }) IterateDrawObjectTree((Object*)actor.Model.Address, actor, false, false); } } - private unsafe void IterateDrawObjectTree(Object* drawObject, Actor gameObject, bool isChild, bool iterate) + private unsafe void IterateDrawObjectTree(Object* drawObject, nint gameObject, bool isChild, bool iterate) { if (drawObject == null) return; - _drawObjectToGameObject[drawObject] = (gameObject, gameObject.Index, isChild); + _drawObjectToGameObject[(nint)drawObject] = (gameObject, isChild); IterateDrawObjectTree(drawObject->ChildObject, gameObject, true, true); if (!iterate) return; diff --git a/Penumbra/Interop/PathResolving/IdentifiedCollectionCache.cs b/Penumbra/Interop/PathResolving/IdentifiedCollectionCache.cs index eeff7eee..32090f7c 100644 --- a/Penumbra/Interop/PathResolving/IdentifiedCollectionCache.cs +++ b/Penumbra/Interop/PathResolving/IdentifiedCollectionCache.cs @@ -1,7 +1,6 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Game.Object; -using OtterGui.Services; using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.Communication; @@ -11,8 +10,7 @@ using Penumbra.Services; namespace Penumbra.Interop.PathResolving; -public unsafe class IdentifiedCollectionCache : IDisposable, IEnumerable<(nint Address, ActorIdentifier Identifier, ModCollection Collection)>, - IService +public unsafe class IdentifiedCollectionCache : IDisposable, IEnumerable<(nint Address, ActorIdentifier Identifier, ModCollection Collection)> { private readonly CommunicatorService _communicator; private readonly CharacterDestructor _characterDestructor; diff --git a/Penumbra/Interop/PathResolving/MetaState.cs b/Penumbra/Interop/PathResolving/MetaState.cs index eeae77cc..6fa5c263 100644 --- a/Penumbra/Interop/PathResolving/MetaState.cs +++ b/Penumbra/Interop/PathResolving/MetaState.cs @@ -1,15 +1,16 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using OtterGui.Classes; -using OtterGui.Services; using Penumbra.Collections; using Penumbra.Api.Enums; +using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Services; using Penumbra.Services; using Penumbra.String.Classes; +using ObjectType = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.ObjectType; using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; using Penumbra.Interop.Hooks.Objects; -using Penumbra.Interop.Hooks.ResourceLoading; namespace Penumbra.Interop.PathResolving; @@ -17,7 +18,7 @@ namespace Penumbra.Interop.PathResolving; // GetSlotEqpData seems to be the only function using the EQP table. // It is only called by CheckSlotsForUnload (called by UpdateModels), // SetupModelAttributes (called by UpdateModels and OnModelLoadComplete) -// and an unnamed function called by UpdateRender. +// and a unnamed function called by UpdateRender. // It seems to be enough to change the EQP entries for UpdateModels. // GetEqdpDataFor[Adults|Children|Other] seem to be the only functions using the EQDP tables. @@ -34,25 +35,18 @@ namespace Penumbra.Interop.PathResolving; // they all are called by many functions, but the most relevant seem to be Human.SetupFromCharacterData, which is only called by CharacterBase.Create, // ChangeCustomize and RspSetupCharacter, which is hooked here, as well as Character.CalculateHeight. -// GMP Entries seem to be only used by "48 8B ?? 53 55 57 48 83 ?? ?? 48 8B", which is SetupVisor. -public sealed unsafe class MetaState : IDisposable, IService +// GMP Entries seem to be only used by "48 8B ?? 53 55 57 48 83 ?? ?? 48 8B", which has a DrawObject as its first parameter. +public sealed unsafe class MetaState : IDisposable { - public readonly Configuration Config; + private readonly Configuration _config; private readonly CommunicatorService _communicator; private readonly CollectionResolver _collectionResolver; private readonly ResourceLoader _resources; private readonly CharacterUtility _characterUtility; private readonly CreateCharacterBase _createCharacterBase; - public ResolveData CustomizeChangeCollection = ResolveData.Invalid; - public readonly Stack EqpCollection = []; - public readonly Stack EqdpCollection = []; - public readonly Stack EstCollection = []; - public readonly Stack RspCollection = []; - public readonly Stack AtchCollection = []; - - public readonly Stack<(ResolveData Collection, PrimaryId Id)> GmpCollection = []; - + public ResolveData CustomizeChangeCollection = ResolveData.Invalid; + public ResolveData EqpCollection = ResolveData.Invalid; private ResolveData _lastCreatedCollection = ResolveData.Invalid; private DisposableContainer _characterBaseCreateMetaChanges = DisposableContainer.Empty; @@ -65,7 +59,7 @@ public sealed unsafe class MetaState : IDisposable, IService _resources = resources; _createCharacterBase = createCharacterBase; _characterUtility = characterUtility; - Config = config; + _config = config; _createCharacterBase.Subscribe(OnCreatingCharacterBase, CreateCharacterBase.Priority.MetaState); _createCharacterBase.Subscribe(OnCharacterBaseCreated, CreateCharacterBase.PostEvent.Priority.MetaState); } @@ -84,8 +78,47 @@ public sealed unsafe class MetaState : IDisposable, IService return false; } + public DisposableContainer ResolveEqdpData(ModCollection collection, GenderRace race, bool equipment, bool accessory) + => (equipment, accessory) switch + { + (true, true) => new DisposableContainer(race.Dependencies().SelectMany(r => new[] + { + collection.TemporarilySetEqdpFile(_characterUtility, r, false), + collection.TemporarilySetEqdpFile(_characterUtility, r, true), + })), + (true, false) => new DisposableContainer(race.Dependencies() + .Select(r => collection.TemporarilySetEqdpFile(_characterUtility, r, false))), + (false, true) => new DisposableContainer(race.Dependencies() + .Select(r => collection.TemporarilySetEqdpFile(_characterUtility, r, true))), + _ => DisposableContainer.Empty, + }; + + public MetaList.MetaReverter ResolveEqpData(ModCollection collection) + => collection.TemporarilySetEqpFile(_characterUtility); + + public MetaList.MetaReverter ResolveGmpData(ModCollection collection) + => collection.TemporarilySetGmpFile(_characterUtility); + + public MetaList.MetaReverter ResolveRspData(ModCollection collection) + => collection.TemporarilySetCmpFile(_characterUtility); + public DecalReverter ResolveDecal(ResolveData resolve, bool which) - => new(Config, _characterUtility, _resources, resolve, which); + => new(_config, _characterUtility, _resources, resolve, which); + + public static GenderRace GetHumanGenderRace(nint human) + => (GenderRace)((Human*)human)->RaceSexId; + + public static GenderRace GetDrawObjectGenderRace(nint drawObject) + { + var draw = (DrawObject*)drawObject; + if (draw->Object.GetObjectType() != ObjectType.CharacterBase) + return GenderRace.Unknown; + + var c = (CharacterBase*)drawObject; + return c->GetModelType() == CharacterBase.ModelType.Human + ? GetHumanGenderRace(drawObject) + : GenderRace.Unknown; + } public void Dispose() { @@ -98,13 +131,13 @@ public sealed unsafe class MetaState : IDisposable, IService _lastCreatedCollection = _collectionResolver.IdentifyLastGameObjectCollection(true); if (_lastCreatedCollection.Valid && _lastCreatedCollection.AssociatedGameObject != nint.Zero) _communicator.CreatingCharacterBase.Invoke(_lastCreatedCollection.AssociatedGameObject, - _lastCreatedCollection.ModCollection.Identity.Id, (nint)modelCharaId, (nint)customize, (nint)equipData); + _lastCreatedCollection.ModCollection.Id, (nint)modelCharaId, (nint)customize, (nint)equipData); - var decal = new DecalReverter(Config, _characterUtility, _resources, _lastCreatedCollection, + var decal = new DecalReverter(_config, _characterUtility, _resources, _lastCreatedCollection, UsesDecal(*(uint*)modelCharaId, (nint)customize)); - RspCollection.Push(_lastCreatedCollection); + var cmp = _lastCreatedCollection.ModCollection.TemporarilySetCmpFile(_characterUtility); _characterBaseCreateMetaChanges.Dispose(); // Should always be empty. - _characterBaseCreateMetaChanges = new DisposableContainer(decal); + _characterBaseCreateMetaChanges = new DisposableContainer(decal, cmp); } private void OnCharacterBaseCreated(ModelCharaId _1, CustomizeArray* _2, CharacterArmor* _3, CharacterBase* drawObject) @@ -114,7 +147,6 @@ public sealed unsafe class MetaState : IDisposable, IService if (_lastCreatedCollection.Valid && _lastCreatedCollection.AssociatedGameObject != nint.Zero && drawObject != null) _communicator.CreatedCharacterBase.Invoke(_lastCreatedCollection.AssociatedGameObject, _lastCreatedCollection.ModCollection, (nint)drawObject); - RspCollection.Pop(); _lastCreatedCollection = ResolveData.Invalid; } diff --git a/Penumbra/Interop/PathResolving/PathDataHandler.cs b/Penumbra/Interop/PathResolving/PathDataHandler.cs deleted file mode 100644 index e0c235a2..00000000 --- a/Penumbra/Interop/PathResolving/PathDataHandler.cs +++ /dev/null @@ -1,167 +0,0 @@ -using Penumbra.Collections; -using Penumbra.Collections.Manager; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.PathResolving; - -public static class PathDataHandler -{ - public static readonly ushort Discriminator = (ushort)(Environment.TickCount >> 12); - private static readonly string DiscriminatorString = $"{Discriminator:X4}"; - private const int MinimumLength = 8; - - /// Additional Data encoded in a path. - /// The local ID of the collection. - /// The change counter of that collection when this file was loaded. - /// The CRC32 of the originally requested path, only used for materials. - /// A discriminator to differ between multiple loads of Penumbra. - public readonly record struct AdditionalPathData( - LocalCollectionId Collection, - int ChangeCounter, - int OriginalPathCrc32, - ushort Discriminator) - { - public static readonly AdditionalPathData Invalid = new(LocalCollectionId.Zero, 0, 0, PathDataHandler.Discriminator); - - /// Any collection but the empty collection can appear. In particular, they can be negative for temporary collections. - public bool Valid - => Collection.Id != 0; - } - - /// Create the encoding path for an IMC file. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static FullPath CreateImc(CiByteString path, ModCollection collection) - => new($"|{collection.Identity.LocalId.Id}_{collection.Counters.Imc}_{DiscriminatorString}|{path}"); - - /// Create the encoding path for a TMB file. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static FullPath CreateTmb(CiByteString path, ModCollection collection) - => CreateBase(path, collection); - - /// Create the encoding path for an AVFX file. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static FullPath CreateAvfx(CiByteString path, ModCollection collection) - => CreateBase(path, collection); - - /// Create the encoding path for an ATCH file. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static FullPath CreateAtch(CiByteString path, ModCollection collection) - => new($"|{collection.Identity.LocalId.Id}_{collection.Counters.Atch}_{DiscriminatorString}|{path}"); - - /// Create the encoding path for a MTRL file. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static FullPath CreateMtrl(CiByteString path, ModCollection collection, Utf8GamePath originalPath) - => new($"|{collection.Identity.LocalId.Id}_{collection.Counters.Change}_{originalPath.Path.Crc32:X8}_{DiscriminatorString}|{path}"); - - /// The base function shared by most file types. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static FullPath CreateBase(CiByteString path, ModCollection collection) - => new($"|{collection.Identity.LocalId.Id}_{collection.Counters.Change}_{DiscriminatorString}|{path}"); - - /// Read an additional data blurb and parse it into usable data for all file types but Materials. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static bool Read(ReadOnlySpan additionalData, out AdditionalPathData data) - => ReadBase(additionalData, out data, out _); - - /// Read an additional data blurb and parse it into usable data for Materials. - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static bool ReadMtrl(ReadOnlySpan additionalData, out AdditionalPathData data) - { - if (!ReadBase(additionalData, out data, out var remaining)) - return false; - - if (!int.TryParse(remaining, out var crc32)) - return false; - - data = data with { OriginalPathCrc32 = crc32 }; - return true; - } - - /// Parse the common attributes of an additional data blurb and return remaining data if there is any. - private static bool ReadBase(ReadOnlySpan additionalData, out AdditionalPathData data, out ReadOnlySpan remainingData) - { - data = AdditionalPathData.Invalid; - remainingData = []; - - // At least (\d_\d_\x\x\x\x) - if (additionalData.Length < MinimumLength) - return false; - - // Fetch discriminator, constant length. - var discriminatorSpan = additionalData[^4..]; - if (!ushort.TryParse(discriminatorSpan, NumberStyles.HexNumber, CultureInfo.CurrentCulture, out var discriminator)) - return false; - - additionalData = additionalData[..^5]; - var collectionSplit = additionalData.IndexOf((byte)'_'); - if (collectionSplit == -1) - return false; - - var collectionSpan = additionalData[..collectionSplit]; - additionalData = additionalData[(collectionSplit + 1)..]; - - if (!int.TryParse(collectionSpan, out var id)) - return false; - - var changeCounterSpan = additionalData; - var changeCounterSplit = additionalData.IndexOf((byte)'_'); - if (changeCounterSplit != -1) - { - changeCounterSpan = additionalData[..changeCounterSplit]; - remainingData = additionalData[(changeCounterSplit + 1)..]; - } - - if (!int.TryParse(changeCounterSpan, out var changeCounter)) - return false; - - data = new AdditionalPathData(new LocalCollectionId(id), changeCounter, 0, discriminator); - return true; - } - - /// Split a given span into the actual path and the additional data blurb. Returns true if a blurb exists. - public static bool Split(ReadOnlySpan text, out ReadOnlySpan path, out ReadOnlySpan data) - { - if (text.IsEmpty || text[0] is not (byte)'|') - { - path = text; - data = []; - return false; - } - - var endIdx = text[1..].IndexOf((byte)'|'); - if (endIdx++ < 0) - { - path = text; - data = []; - return false; - } - - data = text.Slice(1, endIdx - 1); - path = ++endIdx == text.Length ? [] : text[endIdx..]; - return true; - } - - /// - public static bool Split(ReadOnlySpan text, out ReadOnlySpan path, out ReadOnlySpan data) - { - if (text.Length == 0 || text[0] is not '|') - { - path = text; - data = []; - return false; - } - - var endIdx = text[1..].IndexOf('|'); - if (endIdx++ < 0) - { - path = text; - data = []; - return false; - } - - data = text.Slice(1, endIdx - 1); - path = ++endIdx >= text.Length ? [] : text[endIdx..]; - return true; - } -} diff --git a/Penumbra/Interop/PathResolving/PathResolver.cs b/Penumbra/Interop/PathResolving/PathResolver.cs index ec421304..5c3d8d19 100644 --- a/Penumbra/Interop/PathResolving/PathResolver.cs +++ b/Penumbra/Interop/PathResolving/PathResolver.cs @@ -1,46 +1,52 @@ +using System.Runtime; using FFXIVClientStructs.FFXIV.Client.System.Resource; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Manager; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Interop.Processing; +using Penumbra.Interop.ResourceLoading; +using Penumbra.Interop.Structs; +using Penumbra.String; using Penumbra.String.Classes; using Penumbra.Util; namespace Penumbra.Interop.PathResolving; -public class PathResolver : IDisposable, IService +public class PathResolver : IDisposable { - private readonly PerformanceTracker _performance; - private readonly Configuration _config; - private readonly CollectionManager _collectionManager; - private readonly ResourceLoader _loader; + private readonly PerformanceTracker _performance; + private readonly Configuration _config; + private readonly CollectionManager _collectionManager; + private readonly TempCollectionManager _tempCollections; + private readonly ResourceLoader _loader; - private readonly SubfileHelper _subfileHelper; - private readonly PathState _pathState; - private readonly MetaState _metaState; - private readonly GameState _gameState; - private readonly CollectionResolver _collectionResolver; - private readonly GamePathPreProcessService _preprocessor; + private readonly SubfileHelper _subfileHelper; + private readonly PathState _pathState; + private readonly MetaState _metaState; + private readonly GameState _gameState; + private readonly CollectionResolver _collectionResolver; - public PathResolver(PerformanceTracker performance, Configuration config, CollectionManager collectionManager, ResourceLoader loader, - SubfileHelper subfileHelper, PathState pathState, MetaState metaState, CollectionResolver collectionResolver, GameState gameState, - GamePathPreProcessService preprocessor) + public unsafe PathResolver(PerformanceTracker performance, Configuration config, CollectionManager collectionManager, + TempCollectionManager tempCollections, ResourceLoader loader, SubfileHelper subfileHelper, + PathState pathState, MetaState metaState, CollectionResolver collectionResolver, GameState gameState) { - _performance = performance; - _config = config; - _collectionManager = collectionManager; - _subfileHelper = subfileHelper; - _pathState = pathState; - _metaState = metaState; - _gameState = gameState; - _preprocessor = preprocessor; - _collectionResolver = collectionResolver; - _loader = loader; - _loader.ResolvePath = ResolvePath; + _performance = performance; + _config = config; + _collectionManager = collectionManager; + _tempCollections = tempCollections; + _subfileHelper = subfileHelper; + _pathState = pathState; + _metaState = metaState; + _gameState = gameState; + _collectionResolver = collectionResolver; + _loader = loader; + _loader.ResolvePath = ResolvePath; + _loader.FileLoaded += ImcLoadResource; } + /// Obtain a temporary or permanent collection by name. + public bool CollectionById(Guid id, [NotNullWhen(true)] out ModCollection? collection) + => _tempCollections.CollectionById(id, out collection) || _collectionManager.Storage.ById(id, out collection); + /// Try to resolve the given game path to the replaced path. public (FullPath?, ResolveData) ResolvePath(Utf8GamePath path, ResourceCategory category, ResourceType resourceType) { @@ -48,54 +54,40 @@ public class PathResolver : IDisposable, IService if (!_config.EnableMods) return (null, ResolveData.Invalid); - return resourceType switch - { - // Do not allow manipulating layers to prevent very obvious cheating and softlocks. - ResourceType.Lvb or ResourceType.Lgb or ResourceType.Sgb => (null, ResolveData.Invalid), - // Prevent .atch loading to prevent crashes on outdated .atch files. - ResourceType.Atch => ResolveAtch(path), - // These are manipulated through Meta Edits instead. - ResourceType.Eqp or ResourceType.Eqdp or ResourceType.Est or ResourceType.Gmp or ResourceType.Cmp => (null, ResolveData.Invalid), - - _ => category switch - { - // Only Interface collection. - ResourceCategory.Ui => ResolveUi(path), - // Never allow changing scripts. - ResourceCategory.UiScript => (null, ResolveData.Invalid), - ResourceCategory.GameScript => (null, ResolveData.Invalid), - // Use actual resolving. - ResourceCategory.Chara => Resolve(path, resourceType), - ResourceCategory.Shader => ResolveShader(path, resourceType), - ResourceCategory.Vfx => Resolve(path, resourceType), - ResourceCategory.Sound => Resolve(path, resourceType), - // EXD Modding in general should probably be prohibited but is currently used for fan translations. - // We prevent WebURL specifically because it technically allows launching arbitrary programs / to execute arbitrary code. - ResourceCategory.Exd => path.Path.StartsWith("exd/weburl"u8) ? (null, ResolveData.Invalid) : DefaultResolver(path), - // None of these files are ever associated with specific characters, - // always use the default resolver for now, - // except that common/font is conceptually more UI. - ResourceCategory.Common => path.Path.StartsWith("common/font"u8) ? ResolveUi(path) : DefaultResolver(path), - ResourceCategory.BgCommon => DefaultResolver(path), - ResourceCategory.Bg => DefaultResolver(path), - ResourceCategory.Cut => DefaultResolver(path), - ResourceCategory.Music => DefaultResolver(path), - _ => DefaultResolver(path), - } - }; - } - - /// Replacing the characterstockings.shpk or the characterocclusion.shpk files currently causes crashes, so we just entirely prevent that. - private (FullPath?, ResolveData) ResolveShader(Utf8GamePath gamePath, ResourceType type) - { - if (type is not ResourceType.Shpk) - return Resolve(gamePath, type); - - if (gamePath.Path.EndsWith("occlusion.shpk"u8) - || gamePath.Path.EndsWith("stockings.shpk"u8)) + // Do not allow manipulating layers to prevent very obvious cheating and softlocks. + if (resourceType is ResourceType.Lvb or ResourceType.Lgb or ResourceType.Sgb) return (null, ResolveData.Invalid); - return Resolve(gamePath, type); + path = path.ToLower(); + return category switch + { + // Only Interface collection. + ResourceCategory.Ui => ResolveUi(path), + // Never allow changing scripts. + ResourceCategory.UiScript => (null, ResolveData.Invalid), + ResourceCategory.GameScript => (null, ResolveData.Invalid), + // Use actual resolving. + ResourceCategory.Chara => Resolve(path, resourceType), + ResourceCategory.Shader => Resolve(path, resourceType), + ResourceCategory.Vfx => Resolve(path, resourceType), + ResourceCategory.Sound => Resolve(path, resourceType), + // EXD Modding in general should probably be prohibited but is currently used for fan translations. + // We prevent WebURL specifically because it technically allows launching arbitrary programs / to execute arbitrary code. + ResourceCategory.Exd => path.Path.StartsWith("exd/weburl"u8) + ? (null, ResolveData.Invalid) + : DefaultResolver(path), + // None of these files are ever associated with specific characters, + // always use the default resolver for now, + // except that common/font is conceptually more UI. + ResourceCategory.Common => path.Path.StartsWith("common/font"u8) + ? ResolveUi(path) + : DefaultResolver(path), + ResourceCategory.BgCommon => DefaultResolver(path), + ResourceCategory.Bg => DefaultResolver(path), + ResourceCategory.Cut => DefaultResolver(path), + ResourceCategory.Music => DefaultResolver(path), + _ => DefaultResolver(path), + }; } public (FullPath?, ResolveData) Resolve(Utf8GamePath gamePath, ResourceType type) @@ -121,12 +113,14 @@ public class PathResolver : IDisposable, IService // so that the functions loading tex and shpk can find that path and use its collection. // We also need to handle defaulted materials against a non-default collection. var path = resolved == null ? gamePath.Path : resolved.Value.InternalName; - return _preprocessor.PreProcess(resolveData, path, nonDefault, type, resolved, gamePath); + SubfileHelper.HandleCollection(resolveData, path, nonDefault, type, resolved, out var pair); + return pair; } - public void Dispose() + public unsafe void Dispose() { _loader.ResetResolvePath(); + _loader.FileLoaded -= ImcLoadResource; } /// Use the default method of path replacement. @@ -136,14 +130,28 @@ public class PathResolver : IDisposable, IService return (resolved, _collectionManager.Active.Default.ToResolveData()); } + /// After loading an IMC file, replace its contents with the modded IMC file. + private unsafe void ImcLoadResource(ResourceHandle* resource, ByteString path, bool returnValue, bool custom, ByteString additionalData) + { + if (resource->FileType != ResourceType.Imc) + return; + + var lastUnderscore = additionalData.LastIndexOf((byte)'_'); + var idString = lastUnderscore == -1 ? additionalData : additionalData.Substring(0, lastUnderscore); + if (Utf8GamePath.FromByteString(path, out var gamePath) + && GuidExtensions.FromOptimizedString(idString.Span, out var id) + && CollectionById(id, out var collection) + && collection.HasCache + && collection.GetImcFile(gamePath, out var file)) + { + file.Replace(resource); + Penumbra.Log.Verbose( + $"[ResourceLoader] Loaded {gamePath} from file and replaced with IMC from collection {collection.AnonymizedName}."); + } + } + /// Resolve a path from the interface collection. private (FullPath?, ResolveData) ResolveUi(Utf8GamePath path) => (_collectionManager.Active.Interface.ResolvePath(path), _collectionManager.Active.Interface.ToResolveData()); - - public (FullPath?, ResolveData) ResolveAtch(Utf8GamePath gamePath) - { - _metaState.AtchCollection.TryPeek(out var resolveData); - return _preprocessor.PreProcess(resolveData, gamePath.Path, false, ResourceType.Atch, null, gamePath); - } } diff --git a/Penumbra/Interop/PathResolving/PathState.cs b/Penumbra/Interop/PathResolving/PathState.cs index 60a61408..f4218e9c 100644 --- a/Penumbra/Interop/PathResolving/PathState.cs +++ b/Penumbra/Interop/PathResolving/PathState.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using Penumbra.Collections; using Penumbra.Interop.Services; using Penumbra.String; @@ -6,7 +5,7 @@ using Penumbra.String; namespace Penumbra.Interop.PathResolving; public sealed class PathState(CollectionResolver collectionResolver, MetaState metaState, CharacterUtility characterUtility) - : IDisposable, IService + : IDisposable { public readonly CollectionResolver CollectionResolver = collectionResolver; public readonly MetaState MetaState = metaState; @@ -28,7 +27,7 @@ public sealed class PathState(CollectionResolver collectionResolver, MetaState m _internalResolve.Dispose(); } - public bool Consume(CiByteString _, out ResolveData collection) + public bool Consume(ByteString _, out ResolveData collection) { if (_resolveData.IsValueCreated) { diff --git a/Penumbra/Interop/PathResolving/SubfileHelper.cs b/Penumbra/Interop/PathResolving/SubfileHelper.cs index 836cf731..844baaa9 100644 --- a/Penumbra/Interop/PathResolving/SubfileHelper.cs +++ b/Penumbra/Interop/PathResolving/SubfileHelper.cs @@ -1,9 +1,9 @@ -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Collections; -using Penumbra.Interop.Hooks.ResourceLoading; using Penumbra.Interop.Hooks.Resources; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Structs; +using Penumbra.String; using Penumbra.String.Classes; namespace Penumbra.Interop.PathResolving; @@ -13,7 +13,7 @@ namespace Penumbra.Interop.PathResolving; /// Those are loaded synchronously. /// Thus, we need to ensure the correct files are loaded when a material is loaded. /// -public sealed unsafe class SubfileHelper : IDisposable, IReadOnlyCollection>, IService +public sealed unsafe class SubfileHelper : IDisposable, IReadOnlyCollection> { private readonly GameState _gameState; private readonly ResourceLoader _loader; @@ -66,6 +66,24 @@ public sealed unsafe class SubfileHelper : IDisposable, IReadOnlyCollection Materials, TMB, and AVFX need to be set per collection so they can load their sub files independently from each other. + public static void HandleCollection(ResolveData resolveData, ByteString path, bool nonDefault, ResourceType type, FullPath? resolved, + out (FullPath?, ResolveData) data) + { + if (nonDefault) + switch (type) + { + case ResourceType.Mtrl: + case ResourceType.Avfx: + case ResourceType.Tmb: + var fullPath = new FullPath($"|{resolveData.ModCollection.Id.OptimizedString()}_{resolveData.ModCollection.ChangeCounter}|{path}"); + data = (fullPath, resolveData); + return; + } + + data = (resolved, resolveData); + } + public void Dispose() { _loader.ResourceLoaded -= SubfileContainerRequested; diff --git a/Penumbra/Interop/ProcessThreadApi.cs b/Penumbra/Interop/ProcessThreadApi.cs deleted file mode 100644 index 5ee213d9..00000000 --- a/Penumbra/Interop/ProcessThreadApi.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace Penumbra.Interop; - -public static partial class ProcessThreadApi -{ - [LibraryImport("kernel32.dll")] - public static partial uint GetCurrentThreadId(); -} diff --git a/Penumbra/Interop/Processing/AtchFilePostProcessor.cs b/Penumbra/Interop/Processing/AtchFilePostProcessor.cs deleted file mode 100644 index e4fab022..00000000 --- a/Penumbra/Interop/Processing/AtchFilePostProcessor.cs +++ /dev/null @@ -1,43 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections.Manager; -using Penumbra.GameData.Enums; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.Structs; -using Penumbra.Meta.Files; -using Penumbra.String; - -namespace Penumbra.Interop.Processing; - -public sealed class AtchFilePostProcessor(CollectionStorage collections, XivFileAllocator allocator) - : IFilePostProcessor -{ - private readonly IFileAllocator _allocator = allocator; - - public ResourceType Type - => ResourceType.Atch; - - public unsafe void PostProcess(ResourceHandle* resource, CiByteString originalGamePath, ReadOnlySpan additionalData) - { - if (!PathDataHandler.Read(additionalData, out var data) || data.Discriminator != PathDataHandler.Discriminator) - return; - - var collection = collections.ByLocalId(data.Collection); - if (collection.MetaCache is not { } cache) - return; - - if (!AtchPathPreProcessor.TryGetAtchGenderRace(originalGamePath, out var gr)) - return; - - if (!collection.MetaCache.Atch.GetFile(gr, out var file)) - return; - - using var bytes = file.Write(); - var length = (int)bytes.Position; - var alloc = _allocator.Allocate(length, 1); - bytes.GetBuffer().AsSpan(0, length).CopyTo(new Span(alloc, length)); - var (oldData, oldLength) = resource->GetData(); - _allocator.Release((void*)oldData, oldLength); - resource->SetData((nint)alloc, length); - Penumbra.Log.Information($"Post-Processed {originalGamePath} on resource 0x{(nint)resource:X} with {collection} for {gr.ToName()}."); - } -} diff --git a/Penumbra/Interop/Processing/AtchPathPreProcessor.cs b/Penumbra/Interop/Processing/AtchPathPreProcessor.cs deleted file mode 100644 index 428826bc..00000000 --- a/Penumbra/Interop/Processing/AtchPathPreProcessor.cs +++ /dev/null @@ -1,44 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.GameData.Enums; -using Penumbra.Interop.PathResolving; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public sealed class AtchPathPreProcessor : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Atch; - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath _, bool nonDefault, FullPath? resolved) - { - if (!resolveData.Valid) - return resolved; - - if (!TryGetAtchGenderRace(path, out var gr)) - return resolved; - - Penumbra.Log.Excessive($"Pre-Processed {path} with {resolveData.ModCollection} for {gr.ToName()}."); - if (resolveData.ModCollection.MetaCache?.Atch.GetFile(gr, out var file) == true) - return PathDataHandler.CreateAtch(path, resolveData.ModCollection); - - return resolved; - } - - public static bool TryGetAtchGenderRace(CiByteString originalGamePath, out GenderRace genderRace) - { - if (originalGamePath[^6] != '1' - || originalGamePath[^7] != '0' - || !ushort.TryParse(originalGamePath.Span[^9..^7], out var grInt) - || grInt > 18) - { - genderRace = GenderRace.Unknown; - return false; - } - - genderRace = (GenderRace)(grInt * 100 + 1); - return true; - } -} diff --git a/Penumbra/Interop/Processing/AvfxPathPreProcessor.cs b/Penumbra/Interop/Processing/AvfxPathPreProcessor.cs deleted file mode 100644 index 2194354a..00000000 --- a/Penumbra/Interop/Processing/AvfxPathPreProcessor.cs +++ /dev/null @@ -1,16 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Interop.PathResolving; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public sealed class AvfxPathPreProcessor : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Avfx; - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath _, bool nonDefault, FullPath? resolved) - => nonDefault ? PathDataHandler.CreateAvfx(path, resolveData.ModCollection) : resolved; -} diff --git a/Penumbra/Interop/Processing/FilePostProcessService.cs b/Penumbra/Interop/Processing/FilePostProcessService.cs deleted file mode 100644 index 71340178..00000000 --- a/Penumbra/Interop/Processing/FilePostProcessService.cs +++ /dev/null @@ -1,40 +0,0 @@ -using System.Collections.Frozen; -using OtterGui.Services; -using Penumbra.Api.Enums; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Interop.Structs; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public interface IFilePostProcessor : IService -{ - public ResourceType Type { get; } - public unsafe void PostProcess(ResourceHandle* resource, CiByteString originalGamePath, ReadOnlySpan additionalData); -} - -public unsafe class FilePostProcessService : IRequiredService, IDisposable -{ - private readonly ResourceLoader _resourceLoader; - private readonly FrozenDictionary _processors; - - public FilePostProcessService(ResourceLoader resourceLoader, ServiceManager services) - { - _resourceLoader = resourceLoader; - _processors = services.GetServicesImplementing().ToFrozenDictionary(s => s.Type, s => s); - _resourceLoader.BeforeResourceComplete += OnBeforeResourceComplete; - } - - public void Dispose() - { - _resourceLoader.BeforeResourceComplete -= OnBeforeResourceComplete; - } - - private void OnBeforeResourceComplete(ResourceHandle* resource, CiByteString path, Utf8GamePath original, - ReadOnlySpan additionalData, bool isAsync) - { - if (_processors.TryGetValue(resource->FileType, out var processor)) - processor.PostProcess(resource, original.Path, additionalData); - } -} diff --git a/Penumbra/Interop/Processing/GamePathPreProcessService.cs b/Penumbra/Interop/Processing/GamePathPreProcessService.cs deleted file mode 100644 index 875eb254..00000000 --- a/Penumbra/Interop/Processing/GamePathPreProcessService.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.Collections.Frozen; -using OtterGui.Services; -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public interface IPathPreProcessor : IService -{ - public ResourceType Type { get; } - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath originalGamePath, bool nonDefault, FullPath? resolved); -} - -public class GamePathPreProcessService : IService -{ - private readonly FrozenDictionary _processors; - - public GamePathPreProcessService(ServiceManager services) - { - _processors = services.GetServicesImplementing().ToFrozenDictionary(s => s.Type, s => s); - } - - - public (FullPath? Path, ResolveData Data) PreProcess(ResolveData resolveData, CiByteString path, bool nonDefault, ResourceType type, - FullPath? resolved, Utf8GamePath originalPath) - { - if (!_processors.TryGetValue(type, out var processor)) - return (resolved, resolveData); - - resolved = processor.PreProcess(resolveData, path, originalPath, nonDefault, resolved); - return (resolved, resolveData); - } -} diff --git a/Penumbra/Interop/Processing/ImcFilePostProcessor.cs b/Penumbra/Interop/Processing/ImcFilePostProcessor.cs deleted file mode 100644 index 949baaa3..00000000 --- a/Penumbra/Interop/Processing/ImcFilePostProcessor.cs +++ /dev/null @@ -1,30 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections.Manager; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.Structs; -using Penumbra.String; - -namespace Penumbra.Interop.Processing; - -public sealed class ImcFilePostProcessor(CollectionStorage collections) : IFilePostProcessor -{ - public ResourceType Type - => ResourceType.Imc; - - public unsafe void PostProcess(ResourceHandle* resource, CiByteString originalGamePath, ReadOnlySpan additionalData) - { - if (!PathDataHandler.Read(additionalData, out var data) || data.Discriminator != PathDataHandler.Discriminator) - return; - - var collection = collections.ByLocalId(data.Collection); - if (collection.MetaCache is not { } cache) - return; - - if (!cache.Imc.GetFile(originalGamePath, out var file)) - return; - - file.Replace(resource); - Penumbra.Log.Verbose( - $"[ResourceLoader] Loaded {originalGamePath} from file and replaced with IMC from collection {collection.Identity.AnonymizedName}."); - } -} diff --git a/Penumbra/Interop/Processing/ImcPathPreProcessor.cs b/Penumbra/Interop/Processing/ImcPathPreProcessor.cs deleted file mode 100644 index 7030dd8d..00000000 --- a/Penumbra/Interop/Processing/ImcPathPreProcessor.cs +++ /dev/null @@ -1,18 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Interop.PathResolving; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public sealed class ImcPathPreProcessor : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Imc; - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath originalGamePath, bool _, FullPath? resolved) - => resolveData.ModCollection.MetaCache?.Imc.HasFile(originalGamePath.Path) ?? false - ? PathDataHandler.CreateImc(path, resolveData.ModCollection) - : resolved; -} diff --git a/Penumbra/Interop/Processing/MaterialFilePostProcessor.cs b/Penumbra/Interop/Processing/MaterialFilePostProcessor.cs deleted file mode 100644 index 26956845..00000000 --- a/Penumbra/Interop/Processing/MaterialFilePostProcessor.cs +++ /dev/null @@ -1,18 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.Structs; -using Penumbra.String; - -namespace Penumbra.Interop.Processing; - -public sealed class MaterialFilePostProcessor //: IFilePostProcessor -{ - public ResourceType Type - => ResourceType.Mtrl; - - public unsafe void PostProcess(ResourceHandle* resource, CiByteString originalGamePath, ReadOnlySpan additionalData) - { - if (!PathDataHandler.ReadMtrl(additionalData, out var data)) - return; - } -} diff --git a/Penumbra/Interop/Processing/MtrlPathPreProcessor.cs b/Penumbra/Interop/Processing/MtrlPathPreProcessor.cs deleted file mode 100644 index 603781ed..00000000 --- a/Penumbra/Interop/Processing/MtrlPathPreProcessor.cs +++ /dev/null @@ -1,16 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Interop.PathResolving; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public sealed class MtrlPathPreProcessor : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Mtrl; - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath originalGamePath, bool nonDefault, FullPath? resolved) - => nonDefault ? PathDataHandler.CreateMtrl(path, resolveData.ModCollection, originalGamePath) : resolved; -} diff --git a/Penumbra/Interop/Processing/PbdFilePostProcessor.cs b/Penumbra/Interop/Processing/PbdFilePostProcessor.cs deleted file mode 100644 index 674500cd..00000000 --- a/Penumbra/Interop/Processing/PbdFilePostProcessor.cs +++ /dev/null @@ -1,119 +0,0 @@ -using Dalamud.Game; -using Dalamud.Plugin.Services; -using Penumbra.Api.Enums; -using Penumbra.GameData; -using Penumbra.GameData.Data; -using Penumbra.Interop.Structs; -using Penumbra.Meta.Files; -using Penumbra.String; - -namespace Penumbra.Interop.Processing; - -public sealed class PbdFilePostProcessor : IFilePostProcessor -{ - private readonly IFileAllocator _allocator; - private byte[] _epbdData; - private unsafe delegate* unmanaged _loadEpbdData; - - public ResourceType Type - => ResourceType.Pbd; - - public unsafe PbdFilePostProcessor(IDataManager dataManager, XivFileAllocator allocator, ISigScanner scanner) - { - _allocator = allocator; - _epbdData = SetEpbdData(dataManager); - _loadEpbdData = (delegate* unmanaged)scanner.ScanText(Sigs.LoadEpbdData); - } - - public unsafe void PostProcess(ResourceHandle* resource, CiByteString originalGamePath, ReadOnlySpan additionalData) - { - if (_epbdData.Length is 0) - return; - - if (resource->LoadState is not LoadState.Success) - { - Penumbra.Log.Warning($"[ResourceLoader] Requested PBD at {resource->FileName()} failed load ({resource->LoadState})."); - return; - } - - var (data, length) = resource->GetData(); - if (length is 0 || data == nint.Zero) - { - Penumbra.Log.Warning($"[ResourceLoader] Requested PBD at {resource->FileName()} succeeded load but has no data."); - return; - } - - var span = new ReadOnlySpan((void*)data, (int)resource->FileSize); - var reader = new PackReader(span); - if (reader.HasData) - { - Penumbra.Log.Excessive($"[ResourceLoader] Successfully loaded PBD at {resource->FileName()} with EPBD data."); - return; - } - - var newData = AppendData(span); - fixed (byte* ptr = newData) - { - // Set the appended data and the actual file size, then re-load the EPBD data via game function call. - if (resource->SetData((nint)ptr, newData.Length)) - { - resource->FileSize = (uint)newData.Length; - resource->CsHandle.FileSize2 = (uint)newData.Length; - resource->CsHandle.FileSize3 = (uint)newData.Length; - _loadEpbdData(resource); - // Free original data. - _allocator.Release((void*)data, length); - Penumbra.Log.Debug($"[ResourceLoader] Loaded {resource->FileName()} from file and appended default EPBD data."); - } - else - { - Penumbra.Log.Warning( - $"[ResourceLoader] Failed to append EPBD data to custom PBD at {resource->FileName()}."); - } - } - } - - /// Combine the given data with the default PBD data using the game's file allocator. - private unsafe ReadOnlySpan AppendData(ReadOnlySpan data) - { - // offset has to be set, otherwise not called. - var newLength = data.Length + _epbdData.Length; - var memory = _allocator.Allocate(newLength); - var span = new Span(memory, newLength); - data.CopyTo(span); - _epbdData.CopyTo(span[data.Length..]); - return span; - } - - /// Fetch the default EPBD data from the .pbd file of the game's installation. - private static byte[] SetEpbdData(IDataManager dataManager) - { - try - { - var file = dataManager.GetFile(GamePaths.Pbd.Path); - if (file is null || file.Data.Length is 0) - { - Penumbra.Log.Warning("Default PBD file has no data."); - return []; - } - - ReadOnlySpan span = file.Data; - var reader = new PackReader(span); - if (!reader.HasData) - { - Penumbra.Log.Warning("Default PBD file has no EPBD section."); - return []; - } - - var offset = span.Length - (int)reader.PackLength; - var ret = span[offset..]; - Penumbra.Log.Verbose($"Default PBD file has EPBD section of length {ret.Length} at offset {offset}."); - return ret.ToArray(); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Unknown error getting default EPBD data:\n{ex}"); - return []; - } - } -} diff --git a/Penumbra/Interop/Processing/ShpkPathPreProcessor.cs b/Penumbra/Interop/Processing/ShpkPathPreProcessor.cs deleted file mode 100644 index ddd59121..00000000 --- a/Penumbra/Interop/Processing/ShpkPathPreProcessor.cs +++ /dev/null @@ -1,89 +0,0 @@ -using System.IO.MemoryMappedFiles; -using FFXIVClientStructs.FFXIV.Client.System.Resource; -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.Utility; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Mods.Manager; -using Penumbra.Services; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -/// -/// Path pre-processor for shader packages that reverts redirects to known invalid files, as bad ShPks can crash the game. -/// -public sealed class ShpkPathPreProcessor(ResourceManagerService resourceManager, MessageService messager, ModManager modManager) - : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Shpk; - - public unsafe FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath originalGamePath, bool nonDefault, - FullPath? resolved) - { - messager.CleanTaggedMessages(false); - - if (!resolved.HasValue) - return null; - - // Skip the sanity check for game files. We are not considering the case where the user has modified game file: it's at their own risk. - var resolvedPath = resolved.Value; - if (!resolvedPath.IsRooted) - return resolvedPath; - - // If the ShPk is already loaded, it means that it already passed the sanity check. - var existingResource = - resourceManager.FindResource(ResourceCategory.Shader, ResourceType.Shpk, unchecked((uint)resolvedPath.InternalName.Crc32)); - if (existingResource != null) - return resolvedPath; - - var checkResult = SanityCheck(resolvedPath.FullName); - if (checkResult == SanityCheckResult.Success) - return resolvedPath; - - messager.PrintFileWarning(modManager, resolvedPath.FullName, originalGamePath, WarningMessageComplement(checkResult)); - - return null; - } - - internal static SanityCheckResult SanityCheck(string path) - { - try - { - using var file = MmioMemoryManager.CreateFromFile(path, access: MemoryMappedFileAccess.Read); - var bytes = file.GetSpan(); - - return ShpkFile.FastIsObsolete(bytes) - ? SanityCheckResult.Obsolete - : SanityCheckResult.Success; - } - catch (FileNotFoundException) - { - return SanityCheckResult.NotFound; - } - catch (IOException) - { - return SanityCheckResult.IoError; - } - } - - private static string WarningMessageComplement(SanityCheckResult result) - => result switch - { - SanityCheckResult.IoError => "Cannot read the modded file.", - SanityCheckResult.NotFound => "The modded file does not exist.", - SanityCheckResult.Obsolete => "This mod is not compatible with Dawntrail post patch 7.2. Get an updated version, if possible, or disable it.", - _ => string.Empty, - }; - - internal enum SanityCheckResult - { - Success, - IoError, - NotFound, - Obsolete, - } -} diff --git a/Penumbra/Interop/Processing/SkinMtrlPathEarlyProcessing.cs b/Penumbra/Interop/Processing/SkinMtrlPathEarlyProcessing.cs deleted file mode 100644 index bd066d83..00000000 --- a/Penumbra/Interop/Processing/SkinMtrlPathEarlyProcessing.cs +++ /dev/null @@ -1,63 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; - -namespace Penumbra.Interop.Processing; - -public static unsafe class SkinMtrlPathEarlyProcessing -{ - public static void Process(Span path, CharacterBase* character, uint slotIndex) - { - var end = path.IndexOf(MaterialExtension()); - if (end < 0) - return; - - var suffixPos = path[..end].LastIndexOf((byte)'_'); - if (suffixPos < 0) - return; - - var handle = GetModelResourceHandle(character, slotIndex); - if (handle == null) - return; - - var skinSuffix = GetSkinSuffix(handle); - if (skinSuffix.IsEmpty || skinSuffix.Length > path.Length - suffixPos - 7) - return; - - ++suffixPos; - skinSuffix.CopyTo(path[suffixPos..]); - suffixPos += skinSuffix.Length; - MaterialExtension().CopyTo(path[suffixPos..]); - return; - - static ReadOnlySpan MaterialExtension() - => ".mtrl\0"u8; - } - - private static ModelResourceHandle* GetModelResourceHandle(CharacterBase* character, uint slotIndex) - { - if (character is null) - return null; - - if (character->PerSlotStagingArea is not null) - { - var handle = character->PerSlotStagingArea[slotIndex].ModelResourceHandle; - if (handle != null) - return handle; - } - - var model = character->Models[slotIndex]; - return model is null ? null : model->ModelResourceHandle; - } - - private static ReadOnlySpan GetSkinSuffix(ModelResourceHandle* handle) - { - foreach (var (attribute, _) in handle->Attributes) - { - var attributeSpan = attribute.AsSpan(); - if (attributeSpan.Length > 12 && attributeSpan[..11].SequenceEqual("skin_suffix"u8) && attributeSpan[11] is (byte)'=' or (byte)'_') - return attributeSpan[12..]; - } - - return []; - } -} diff --git a/Penumbra/Interop/Processing/TmbPathPreProcessor.cs b/Penumbra/Interop/Processing/TmbPathPreProcessor.cs deleted file mode 100644 index 0a7aa16f..00000000 --- a/Penumbra/Interop/Processing/TmbPathPreProcessor.cs +++ /dev/null @@ -1,16 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Interop.PathResolving; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Processing; - -public sealed class TmbPathPreProcessor : IPathPreProcessor -{ - public ResourceType Type - => ResourceType.Tmb; - - public FullPath? PreProcess(ResolveData resolveData, CiByteString path, Utf8GamePath _, bool nonDefault, FullPath? resolved) - => nonDefault ? PathDataHandler.CreateTmb(path, resolveData.ModCollection) : resolved; -} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/CreateFileWHook.cs b/Penumbra/Interop/ResourceLoading/CreateFileWHook.cs similarity index 95% rename from Penumbra/Interop/Hooks/ResourceLoading/CreateFileWHook.cs rename to Penumbra/Interop/ResourceLoading/CreateFileWHook.cs index a9a5f41d..8a5e779b 100644 --- a/Penumbra/Interop/Hooks/ResourceLoading/CreateFileWHook.cs +++ b/Penumbra/Interop/ResourceLoading/CreateFileWHook.cs @@ -1,26 +1,24 @@ using Dalamud.Hooking; using Dalamud.Plugin.Services; -using OtterGui.Services; using Penumbra.String; using Penumbra.String.Classes; using Penumbra.String.Functions; -namespace Penumbra.Interop.Hooks.ResourceLoading; +namespace Penumbra.Interop.ResourceLoading; /// /// To allow XIV to load files of arbitrary path length, /// we use the fixed size buffers of their formats to only store pointers to the actual path instead. /// Then we translate the stored pointer to the path in CreateFileW, if the prefix matches. /// -public unsafe class CreateFileWHook : IDisposable, IRequiredService +public unsafe class CreateFileWHook : IDisposable { public const int Size = 28; public CreateFileWHook(IGameInteropProvider interop) { _createFileWHook = interop.HookFromImport(null, "KERNEL32.dll", "CreateFileW", 0, CreateFileWDetour); - if (!HookOverrides.Instance.ResourceLoading.CreateFileWHook) - _createFileWHook.Enable(); + _createFileWHook.Enable(); } /// @@ -102,7 +100,7 @@ public unsafe class CreateFileWHook : IDisposable, IRequiredService { // Use static storage. var ptr = WriteFileName(name); - Penumbra.Log.Excessive($"[ResourceHooks] Calling CreateFileWDetour with {CiByteString.FromSpanUnsafe(name, false)}."); + Penumbra.Log.Excessive($"[ResourceHooks] Calling CreateFileWDetour with {ByteString.FromSpanUnsafe(name, false)}."); return _createFileWHook.OriginalDisposeSafe(ptr, access, shareMode, security, creation, flags, template); } diff --git a/Penumbra/Interop/Hooks/ResourceLoading/FileReadService.cs b/Penumbra/Interop/ResourceLoading/FileReadService.cs similarity index 87% rename from Penumbra/Interop/Hooks/ResourceLoading/FileReadService.cs rename to Penumbra/Interop/ResourceLoading/FileReadService.cs index d8801b81..64442771 100644 --- a/Penumbra/Interop/Hooks/ResourceLoading/FileReadService.cs +++ b/Penumbra/Interop/ResourceLoading/FileReadService.cs @@ -1,22 +1,20 @@ using Dalamud.Hooking; using Dalamud.Plugin.Services; using Dalamud.Utility.Signatures; -using OtterGui.Services; using Penumbra.GameData; using Penumbra.Interop.Structs; using Penumbra.Util; -namespace Penumbra.Interop.Hooks.ResourceLoading; +namespace Penumbra.Interop.ResourceLoading; -public unsafe class FileReadService : IDisposable, IRequiredService +public unsafe class FileReadService : IDisposable { public FileReadService(PerformanceTracker performance, ResourceManagerService resourceManager, IGameInteropProvider interop) { _resourceManager = resourceManager; - _performance = performance; + _performance = performance; interop.InitializeFromAttributes(this); - if (!HookOverrides.Instance.ResourceLoading.ReadSqPack) - _readSqPackHook.Enable(); + _readSqPackHook.Enable(); } /// Invoked when a file is supposed to be read from SqPack. @@ -50,7 +48,7 @@ public unsafe class FileReadService : IDisposable, IRequiredService _readSqPackHook.Dispose(); } - private readonly PerformanceTracker _performance; + private readonly PerformanceTracker _performance; private readonly ResourceManagerService _resourceManager; private delegate byte ReadSqPackPrototype(nint resourceManager, SeFileDescriptor* pFileDesc, int priority, bool isSync); @@ -61,10 +59,10 @@ public unsafe class FileReadService : IDisposable, IRequiredService private byte ReadSqPackDetour(nint resourceManager, SeFileDescriptor* fileDescriptor, int priority, bool isSync) { using var performance = _performance.Measure(PerformanceType.ReadSqPack); - byte? ret = null; + byte? ret = null; _lastFileThreadResourceManager.Value = resourceManager; ReadSqPack?.Invoke(fileDescriptor, ref priority, ref isSync, ref ret); - _lastFileThreadResourceManager.Value = nint.Zero; + _lastFileThreadResourceManager.Value = IntPtr.Zero; return ret ?? _readSqPackHook.Original(resourceManager, fileDescriptor, priority, isSync); } @@ -83,7 +81,7 @@ public unsafe class FileReadService : IDisposable, IRequiredService /// So we keep track of them per thread and use them. /// private nint GetResourceManager() - => !_lastFileThreadResourceManager.IsValueCreated || _lastFileThreadResourceManager.Value == nint.Zero + => !_lastFileThreadResourceManager.IsValueCreated || _lastFileThreadResourceManager.Value == IntPtr.Zero ? (nint)_resourceManager.ResourceManager : _lastFileThreadResourceManager.Value; } diff --git a/Penumbra/Interop/ResourceLoading/ResourceLoader.cs b/Penumbra/Interop/ResourceLoading/ResourceLoader.cs new file mode 100644 index 00000000..6c2c83b3 --- /dev/null +++ b/Penumbra/Interop/ResourceLoading/ResourceLoader.cs @@ -0,0 +1,261 @@ +using FFXIVClientStructs.FFXIV.Client.System.Resource; +using Penumbra.Api.Enums; +using Penumbra.Collections; +using Penumbra.Interop.SafeHandles; +using Penumbra.Interop.Structs; +using Penumbra.String; +using Penumbra.String.Classes; +using FileMode = Penumbra.Interop.Structs.FileMode; + +namespace Penumbra.Interop.ResourceLoading; + +public unsafe class ResourceLoader : IDisposable +{ + private readonly ResourceService _resources; + private readonly FileReadService _fileReadService; + private readonly TexMdlService _texMdlService; + + private ResolveData _resolvedData = ResolveData.Invalid; + + public ResourceLoader(ResourceService resources, FileReadService fileReadService, TexMdlService texMdlService, + CreateFileWHook _) + { + _resources = resources; + _fileReadService = fileReadService; + _texMdlService = texMdlService; + ResetResolvePath(); + + _resources.ResourceRequested += ResourceHandler; + _resources.ResourceHandleIncRef += IncRefProtection; + _resources.ResourceHandleDecRef += DecRefProtection; + _fileReadService.ReadSqPack += ReadSqPackDetour; + } + + /// Load a resource for a given path and a specific collection. + public ResourceHandle* LoadResolvedResource(ResourceCategory category, ResourceType type, ByteString path, ResolveData resolveData) + { + _resolvedData = resolveData; + var ret = _resources.GetResource(category, type, path); + _resolvedData = ResolveData.Invalid; + return ret; + } + + /// Load a resource for a given path and a specific collection. + public SafeResourceHandle LoadResolvedSafeResource(ResourceCategory category, ResourceType type, ByteString path, ResolveData resolveData) + { + _resolvedData = resolveData; + var ret = _resources.GetSafeResource(category, type, path); + _resolvedData = ResolveData.Invalid; + return ret; + } + + /// The function to use to resolve a given path. + public Func ResolvePath = null!; + + /// Reset the ResolvePath function to always return null. + public void ResetResolvePath() + => ResolvePath = (_1, _2, _3) => (null, ResolveData.Invalid); + + public delegate void ResourceLoadedDelegate(ResourceHandle* handle, Utf8GamePath originalPath, FullPath? manipulatedPath, + ResolveData resolveData); + + /// + /// Event fired whenever a resource is returned. + /// If the path was manipulated by penumbra, manipulatedPath will be the file path of the loaded resource. + /// resolveData is additional data returned by the current ResolvePath function which can contain the collection and associated game object. + /// + public event ResourceLoadedDelegate? ResourceLoaded; + + public delegate void FileLoadedDelegate(ResourceHandle* resource, ByteString path, bool returnValue, bool custom, + ByteString additionalData); + + /// + /// Event fired whenever a resource is newly loaded. + /// ReturnValue indicates the return value of the loading function (which does not imply that the resource was actually successfully loaded) + /// custom is true if the file was loaded from local files instead of the default SqPacks. + /// AdditionalData is either empty or the part of the path inside the leading pipes. + /// + public event FileLoadedDelegate? FileLoaded; + + public void Dispose() + { + _resources.ResourceRequested -= ResourceHandler; + _resources.ResourceHandleIncRef -= IncRefProtection; + _resources.ResourceHandleDecRef -= DecRefProtection; + _fileReadService.ReadSqPack -= ReadSqPackDetour; + } + + private void ResourceHandler(ref ResourceCategory category, ref ResourceType type, ref int hash, ref Utf8GamePath path, + Utf8GamePath original, GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue) + { + if (returnValue != null) + return; + + CompareHash(ComputeHash(path.Path, parameters), hash, path); + + // If no replacements are being made, we still want to be able to trigger the event. + var (resolvedPath, data) = _incMode.Value + ? (null, ResolveData.Invalid) + : _resolvedData.Valid + ? (_resolvedData.ModCollection.ResolvePath(path), _resolvedData) + : ResolvePath(path, category, type); + + if (resolvedPath == null || !Utf8GamePath.FromByteString(resolvedPath.Value.InternalName, out var p)) + { + returnValue = _resources.GetOriginalResource(sync, category, type, hash, path.Path, parameters); + ResourceLoaded?.Invoke(returnValue, path, resolvedPath, data); + return; + } + + _texMdlService.AddCrc(type, resolvedPath); + // Replace the hash and path with the correct one for the replacement. + hash = ComputeHash(resolvedPath.Value.InternalName, parameters); + var oldPath = path; + path = p; + returnValue = _resources.GetOriginalResource(sync, category, type, hash, path.Path, parameters); + ResourceLoaded?.Invoke(returnValue, oldPath, resolvedPath.Value, data); + } + + private void ReadSqPackDetour(SeFileDescriptor* fileDescriptor, ref int priority, ref bool isSync, ref byte? returnValue) + { + if (fileDescriptor->ResourceHandle == null) + { + Penumbra.Log.Error("[ResourceLoader] Failure to load file from SqPack: invalid File Descriptor."); + return; + } + + if (!fileDescriptor->ResourceHandle->GamePath(out var gamePath) || gamePath.Length == 0) + { + Penumbra.Log.Error("[ResourceLoader] Failure to load file from SqPack: invalid path specified."); + return; + } + + // Paths starting with a '|' are handled separately to allow for special treatment. + // They are expected to also have a closing '|'. + if (gamePath.Path[0] != (byte)'|') + { + returnValue = DefaultLoadResource(gamePath.Path, fileDescriptor, priority, isSync, ByteString.Empty); + return; + } + + // Split the path into the special-treatment part (between the first and second '|') + // and the actual path. + var split = gamePath.Path.Split((byte)'|', 3, false); + fileDescriptor->ResourceHandle->FileNameData = split[2].Path; + fileDescriptor->ResourceHandle->FileNameLength = split[2].Length; + MtrlForceSync(fileDescriptor, ref isSync); + returnValue = DefaultLoadResource(split[2], fileDescriptor, priority, isSync, split[1]); + // Return original resource handle path so that they can be loaded separately. + fileDescriptor->ResourceHandle->FileNameData = gamePath.Path.Path; + fileDescriptor->ResourceHandle->FileNameLength = gamePath.Path.Length; + } + + + /// Load a resource by its path. If it is rooted, it will be loaded from the drive, otherwise from the SqPack. + private byte DefaultLoadResource(ByteString gamePath, SeFileDescriptor* fileDescriptor, int priority, + bool isSync, ByteString additionalData) + { + if (Utf8GamePath.IsRooted(gamePath)) + { + // Specify that we are loading unpacked files from the drive. + // We need to obtain the actual file path in UTF16 (Windows-Unicode) on two locations, + // but we write a pointer to the given string instead and use the CreateFileW hook to handle it, + // because otherwise we are limited to 260 characters. + fileDescriptor->FileMode = FileMode.LoadUnpackedResource; + + // Ensure that the file descriptor has its wchar_t array on aligned boundary even if it has to be odd. + var fd = stackalloc char[0x11 + 0x0B + 14]; + fileDescriptor->FileDescriptor = (byte*)fd + 1; + CreateFileWHook.WritePtr(fd + 0x11, gamePath.Path, gamePath.Length); + CreateFileWHook.WritePtr(&fileDescriptor->Utf16FileName, gamePath.Path, gamePath.Length); + + // Use the SE ReadFile function. + var ret = _fileReadService.ReadFile(fileDescriptor, priority, isSync); + FileLoaded?.Invoke(fileDescriptor->ResourceHandle, gamePath, ret != 0, true, additionalData); + return ret; + } + else + { + var ret = _fileReadService.ReadDefaultSqPack(fileDescriptor, priority, isSync); + FileLoaded?.Invoke(fileDescriptor->ResourceHandle, gamePath, ret != 0, false, additionalData); + return ret; + } + } + + /// Special handling for materials. + private static void MtrlForceSync(SeFileDescriptor* fileDescriptor, ref bool isSync) + { + // Force isSync = true for Materials. I don't really understand why, + // or where the difference even comes from. + // Was called with True on my client and with false on other peoples clients, + // which caused problems. + isSync |= fileDescriptor->ResourceHandle->FileType is ResourceType.Mtrl; + } + + /// + /// A resource with ref count 0 that gets incremented goes through GetResourceAsync again. + /// This means, that if the path determined from that is different than the resources path, + /// a different resource gets loaded or incremented, while the IncRef'd resource stays at 0. + /// This causes some problems and is hopefully prevented with this. + /// + private readonly ThreadLocal _incMode = new(() => false, true); + + /// + private void IncRefProtection(ResourceHandle* handle, ref nint? returnValue) + { + if (handle->RefCount != 0) + return; + + _incMode.Value = true; + returnValue = _resources.IncRef(handle); + _incMode.Value = false; + } + + /// + /// Catch weird errors with invalid decrements of the reference count. + /// + private void DecRefProtection(ResourceHandle* handle, ref byte? returnValue) + { + if (handle->RefCount != 0) + return; + + try + { + Penumbra.Log.Error( + $"[ResourceLoader] Caught decrease of Reference Counter for {handle->FileName()} at 0x{(ulong)handle} below 0."); + } + catch + { + // ignored + } + + returnValue = 1; + } + + /// Compute the CRC32 hash for a given path together with potential resource parameters. + private static int ComputeHash(ByteString path, GetResourceParameters* pGetResParams) + { + if (pGetResParams == null || !pGetResParams->IsPartialRead) + return path.Crc32; + + // When the game requests file only partially, crc32 includes that information, in format of: + // path/to/file.ext.hex_offset.hex_size + // ex) music/ex4/BGM_EX4_System_Title.scd.381adc.30000 + return ByteString.Join( + (byte)'.', + path, + ByteString.FromStringUnsafe(pGetResParams->SegmentOffset.ToString("x"), true), + ByteString.FromStringUnsafe(pGetResParams->SegmentLength.ToString("x"), true) + ).Crc32; + } + + /// + /// In Debug build, compare the hashes the game computes with those Penumbra computes to notice potential changes in the CRC32 algorithm or resource parameters. + /// + [Conditional("DEBUG")] + private static void CompareHash(int local, int game, Utf8GamePath path) + { + if (local != game) + Penumbra.Log.Warning($"[ResourceLoader] Hash function appears to have changed. Computed {local:X8} vs Game {game:X8} for {path}."); + } +} diff --git a/Penumbra/Interop/Hooks/ResourceLoading/ResourceManagerService.cs b/Penumbra/Interop/ResourceLoading/ResourceManagerService.cs similarity index 74% rename from Penumbra/Interop/Hooks/ResourceLoading/ResourceManagerService.cs rename to Penumbra/Interop/ResourceLoading/ResourceManagerService.cs index 1bff80ba..a087a659 100644 --- a/Penumbra/Interop/Hooks/ResourceLoading/ResourceManagerService.cs +++ b/Penumbra/Interop/ResourceLoading/ResourceManagerService.cs @@ -4,13 +4,12 @@ using FFXIVClientStructs.FFXIV.Client.System.Resource; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; using FFXIVClientStructs.Interop; using FFXIVClientStructs.STD; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.GameData; -namespace Penumbra.Interop.Hooks.ResourceLoading; +namespace Penumbra.Interop.ResourceLoading; -public unsafe class ResourceManagerService : IRequiredService +public unsafe class ResourceManagerService { public ResourceManagerService(IGameInteropProvider interop) => interop.InitializeFromAttributes(this); @@ -23,10 +22,10 @@ public unsafe class ResourceManagerService : IRequiredService public ResourceHandle* FindResource(ResourceCategory cat, ResourceType ext, uint crc32) { ref var manager = ref *ResourceManager; - var catIdx = (uint)cat >> 0x18; + var catIdx = (uint)cat >> 0x18; cat = (ResourceCategory)(ushort)cat; - ref var category = ref manager.ResourceGraph->Containers[(int)cat]; - var extMap = FindInMap(category.CategoryMaps[(int)catIdx].Value, (uint)ext); + ref var category = ref manager.ResourceGraph->ContainerArraySpan[(int)cat]; + var extMap = FindInMap(category.CategoryMapsSpan[(int)catIdx].Value, (uint)ext); if (extMap == null) return null; @@ -44,10 +43,10 @@ public unsafe class ResourceManagerService : IRequiredService ref var manager = ref *ResourceManager; foreach (var resourceType in Enum.GetValues().SkipLast(1)) { - ref var graph = ref manager.ResourceGraph->Containers[(int)resourceType]; + ref var graph = ref manager.ResourceGraph->ContainerArraySpan[(int)resourceType]; for (var i = 0; i < 20; ++i) { - var map = graph.CategoryMaps[i]; + var map = graph.CategoryMapsSpan[i]; if (map.Value != null) action(resourceType, map, i); } @@ -79,10 +78,25 @@ public unsafe class ResourceManagerService : IRequiredService where TKey : unmanaged, IComparable where TValue : unmanaged { - if (map == null) + if (map == null || map->Count == 0) return null; - return map->TryGetValuePointer(key, out var val) ? val : null; + var node = map->Head->Parent; + while (!node->IsNil) + { + switch (key.CompareTo(node->KeyValuePair.Item1)) + { + case 0: return &node->KeyValuePair.Item2; + case < 0: + node = node->Left; + break; + default: + node = node->Right; + break; + } + } + + return null; } // Iterate in tree-order through a map, applying action to each KeyValuePair. @@ -90,10 +104,10 @@ public unsafe class ResourceManagerService : IRequiredService where TKey : unmanaged where TValue : unmanaged { - if (map == null) + if (map == null || map->Count == 0) return; - foreach (var (key, value) in *map) - action(key, value); + for (var node = map->SmallestValue; !node->IsNil; node = node->Next()) + action(node->KeyValuePair.Item1, node->KeyValuePair.Item2); } } diff --git a/Penumbra/Interop/Hooks/ResourceLoading/ResourceService.cs b/Penumbra/Interop/ResourceLoading/ResourceService.cs similarity index 59% rename from Penumbra/Interop/Hooks/ResourceLoading/ResourceService.cs rename to Penumbra/Interop/ResourceLoading/ResourceService.cs index 1a40accc..e3338e6c 100644 --- a/Penumbra/Interop/Hooks/ResourceLoading/ResourceService.cs +++ b/Penumbra/Interop/ResourceLoading/ResourceService.cs @@ -1,9 +1,7 @@ using Dalamud.Hooking; -using Dalamud.Interface.Windowing; using Dalamud.Plugin.Services; using Dalamud.Utility.Signatures; using FFXIVClientStructs.FFXIV.Client.System.Resource; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.GameData; using Penumbra.Interop.SafeHandles; @@ -13,56 +11,48 @@ using Penumbra.String.Classes; using Penumbra.Util; using CSResourceHandle = FFXIVClientStructs.FFXIV.Client.System.Resource.Handle.ResourceHandle; -namespace Penumbra.Interop.Hooks.ResourceLoading; +namespace Penumbra.Interop.ResourceLoading; -public unsafe class ResourceService : IDisposable, IRequiredService +public unsafe class ResourceService : IDisposable { private readonly PerformanceTracker _performance; private readonly ResourceManagerService _resourceManager; - private readonly ThreadLocal _currentGetResourcePath = new(() => Utf8GamePath.Empty); - public ResourceService(PerformanceTracker performance, ResourceManagerService resourceManager, IGameInteropProvider interop) { _performance = performance; _resourceManager = resourceManager; interop.InitializeFromAttributes(this); + _getResourceSyncHook.Enable(); + _getResourceAsyncHook.Enable(); + _resourceHandleDestructorHook.Enable(); _incRefHook = interop.HookFromAddress( (nint)CSResourceHandle.MemberFunctionPointers.IncRef, ResourceHandleIncRefDetour); + _incRefHook.Enable(); _decRefHook = interop.HookFromAddress( (nint)CSResourceHandle.MemberFunctionPointers.DecRef, ResourceHandleDecRefDetour); - if (!HookOverrides.Instance.ResourceLoading.GetResourceSync) - _getResourceSyncHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.GetResourceAsync) - _getResourceAsyncHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.UpdateResourceState) - _updateResourceStateHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.IncRef) - _incRefHook.Enable(); - if (!HookOverrides.Instance.ResourceLoading.DecRef) - _decRefHook.Enable(); + _decRefHook.Enable(); } - public ResourceHandle* GetResource(ResourceCategory category, ResourceType type, CiByteString path) + public ResourceHandle* GetResource(ResourceCategory category, ResourceType type, ByteString path) { var hash = path.Crc32; return GetResourceHandler(true, (ResourceManager*)_resourceManager.ResourceManagerAddress, - &category, &type, &hash, path.Path, null, 0, 0, 0); + &category, &type, &hash, path.Path, null, false); } - public SafeResourceHandle GetSafeResource(ResourceCategory category, ResourceType type, CiByteString path) + public SafeResourceHandle GetSafeResource(ResourceCategory category, ResourceType type, ByteString path) => new((CSResourceHandle*)GetResource(category, type, path), false); public void Dispose() { _getResourceSyncHook.Dispose(); _getResourceAsyncHook.Dispose(); - _updateResourceStateHook.Dispose(); + _resourceHandleDestructorHook.Dispose(); _incRefHook.Dispose(); _decRefHook.Dispose(); - _currentGetResourcePath.Dispose(); } #region GetResource @@ -76,18 +66,18 @@ public unsafe class ResourceService : IDisposable, IRequiredService /// Whether to request the resource synchronously or asynchronously. /// The returned resource handle. If this is not null, calling original will be skipped. public delegate void GetResourcePreDelegate(ref ResourceCategory category, ref ResourceType type, ref int hash, ref Utf8GamePath path, - Utf8GamePath original, GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue); + Utf8GamePath original, + GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue); /// /// Subscribers should be exception-safe. public event GetResourcePreDelegate? ResourceRequested; private delegate ResourceHandle* GetResourceSyncPrototype(ResourceManager* resourceManager, ResourceCategory* pCategoryId, - ResourceType* pResourceType, int* pResourceHash, byte* pPath, GetResourceParameters* pGetResParams, nint unk7, uint unk8); + ResourceType* pResourceType, int* pResourceHash, byte* pPath, GetResourceParameters* pGetResParams); private delegate ResourceHandle* GetResourceAsyncPrototype(ResourceManager* resourceManager, ResourceCategory* pCategoryId, - ResourceType* pResourceType, int* pResourceHash, byte* pPath, GetResourceParameters* pGetResParams, byte isUnknown, nint unk8, - uint unk9); + ResourceType* pResourceType, int* pResourceHash, byte* pPath, GetResourceParameters* pGetResParams, bool isUnknown); [Signature(Sigs.GetResourceSync, DetourName = nameof(GetResourceSyncDetour))] private readonly Hook _getResourceSyncHook = null!; @@ -96,115 +86,50 @@ public unsafe class ResourceService : IDisposable, IRequiredService private readonly Hook _getResourceAsyncHook = null!; private ResourceHandle* GetResourceSyncDetour(ResourceManager* resourceManager, ResourceCategory* categoryId, ResourceType* resourceType, - int* resourceHash, byte* path, GetResourceParameters* pGetResParams, nint unk8, uint unk9) - => GetResourceHandler(true, resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, 0, unk8, unk9); + int* resourceHash, byte* path, GetResourceParameters* pGetResParams) + => GetResourceHandler(true, resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, false); private ResourceHandle* GetResourceAsyncDetour(ResourceManager* resourceManager, ResourceCategory* categoryId, ResourceType* resourceType, - int* resourceHash, byte* path, GetResourceParameters* pGetResParams, byte isUnk, nint unk8, uint unk9) - => GetResourceHandler(false, resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, isUnk, unk8, unk9); + int* resourceHash, byte* path, GetResourceParameters* pGetResParams, bool isUnk) + => GetResourceHandler(false, resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, isUnk); /// /// Resources can be obtained synchronously and asynchronously. We need to change behaviour in both cases. /// Both work basically the same, so we can reduce the main work to one function used by both hooks. /// private ResourceHandle* GetResourceHandler(bool isSync, ResourceManager* resourceManager, ResourceCategory* categoryId, - ResourceType* resourceType, int* resourceHash, byte* path, GetResourceParameters* pGetResParams, byte isUnk, nint unk8, uint unk9) + ResourceType* resourceType, int* resourceHash, byte* path, GetResourceParameters* pGetResParams, bool isUnk) { using var performance = _performance.Measure(PerformanceType.GetResourceHandler); - if (!Utf8GamePath.FromPointer(path, MetaDataComputation.CiCrc32, out var gamePath)) + if (!Utf8GamePath.FromPointer(path, out var gamePath)) { Penumbra.Log.Error("[ResourceService] Could not create GamePath from resource path."); return isSync - ? _getResourceSyncHook.Original(resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, unk8, unk9) - : _getResourceAsyncHook.Original(resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, isUnk, unk8, - unk9); + ? _getResourceSyncHook.Original(resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams) + : _getResourceAsyncHook.Original(resourceManager, categoryId, resourceType, resourceHash, path, pGetResParams, isUnk); } - if (gamePath.IsEmpty) - { - Penumbra.Log.Error($"[ResourceService] Empty resource path requested with category {*categoryId}, type {*resourceType}, hash {*resourceHash}."); - return null; - } - - var original = gamePath; ResourceHandle* returnValue = null; - ResourceRequested?.Invoke(ref *categoryId, ref *resourceType, ref *resourceHash, ref gamePath, original, pGetResParams, ref isSync, + ResourceRequested?.Invoke(ref *categoryId, ref *resourceType, ref *resourceHash, ref gamePath, gamePath, pGetResParams, ref isSync, ref returnValue); if (returnValue != null) return returnValue; - return GetOriginalResource(isSync, *categoryId, *resourceType, *resourceHash, gamePath.Path, original, pGetResParams, isUnk, unk8, - unk9); + return GetOriginalResource(isSync, *categoryId, *resourceType, *resourceHash, gamePath.Path, pGetResParams, isUnk); } /// Call the original GetResource function. - public ResourceHandle* GetOriginalResource(bool sync, ResourceCategory categoryId, ResourceType type, int hash, CiByteString path, - Utf8GamePath original, - GetResourceParameters* resourceParameters = null, byte unk = 0, nint unk8 = 0, uint unk9 = 0) - { - var previous = _currentGetResourcePath.Value; - try - { - _currentGetResourcePath.Value = original; - return sync - ? _getResourceSyncHook.OriginalDisposeSafe(_resourceManager.ResourceManager, &categoryId, &type, &hash, path.Path, - resourceParameters, unk8, unk9) - : _getResourceAsyncHook.OriginalDisposeSafe(_resourceManager.ResourceManager, &categoryId, &type, &hash, path.Path, - resourceParameters, unk, unk8, unk9); - } - finally - { - _currentGetResourcePath.Value = previous; - } - } + public ResourceHandle* GetOriginalResource(bool sync, ResourceCategory categoryId, ResourceType type, int hash, ByteString path, + GetResourceParameters* resourceParameters = null, bool unk = false) + => sync + ? _getResourceSyncHook.OriginalDisposeSafe(_resourceManager.ResourceManager, &categoryId, &type, &hash, path.Path, + resourceParameters) + : _getResourceAsyncHook.OriginalDisposeSafe(_resourceManager.ResourceManager, &categoryId, &type, &hash, path.Path, + resourceParameters, unk); #endregion - private delegate nint ResourceHandlePrototype(ResourceHandle* handle); - - #region UpdateResourceState - - /// Invoked before a resource state is updated. - /// The resource handle. - /// The original game path of the resource, if loaded synchronously. - public delegate void ResourceStateUpdatingDelegate(ResourceHandle* handle, Utf8GamePath syncOriginal); - - /// Invoked after a resource state is updated. - /// The resource handle. - /// The original game path of the resource, if loaded synchronously. - /// The previous state of the resource. - /// The return value to use. - public delegate void ResourceStateUpdatedDelegate(ResourceHandle* handle, Utf8GamePath syncOriginal, - (byte UnkState, LoadState LoadState) previousState, ref uint returnValue); - - /// - /// - /// Subscribers should be exception-safe. - /// - public event ResourceStateUpdatingDelegate? ResourceStateUpdating; - - /// - /// - /// Subscribers should be exception-safe. - /// - public event ResourceStateUpdatedDelegate? ResourceStateUpdated; - - private delegate uint UpdateResourceStatePrototype(ResourceHandle* handle, byte offFileThread); - - [Signature(Sigs.UpdateResourceState, DetourName = nameof(UpdateResourceStateDetour))] - private readonly Hook _updateResourceStateHook = null!; - - private uint UpdateResourceStateDetour(ResourceHandle* handle, byte offFileThread) - { - var previousState = (handle->UnkState, handle->LoadState); - var syncOriginal = _currentGetResourcePath.IsValueCreated ? _currentGetResourcePath.Value : Utf8GamePath.Empty; - ResourceStateUpdating?.Invoke(handle, syncOriginal); - var ret = _updateResourceStateHook.OriginalDisposeSafe(handle, offFileThread); - ResourceStateUpdated?.Invoke(handle, syncOriginal, previousState, ref ret); - return ret; - } - - #endregion + private delegate IntPtr ResourceHandlePrototype(ResourceHandle* handle); #region IncRef @@ -266,4 +191,27 @@ public unsafe class ResourceService : IDisposable, IRequiredService } #endregion + + #region Destructor + + /// Invoked before a resource handle is destructed. + /// The resource handle. + public delegate void ResourceHandleDtorDelegate(ResourceHandle* handle); + + /// + /// + /// Subscribers should be exception-safe. + /// + public event ResourceHandleDtorDelegate? ResourceHandleDestructor; + + [Signature(Sigs.ResourceHandleDestructor, DetourName = nameof(ResourceHandleDestructorDetour))] + private readonly Hook _resourceHandleDestructorHook = null!; + + private nint ResourceHandleDestructorDetour(ResourceHandle* handle) + { + ResourceHandleDestructor?.Invoke(handle); + return _resourceHandleDestructorHook.OriginalDisposeSafe(handle); + } + + #endregion } diff --git a/Penumbra/Interop/ResourceLoading/TexMdlService.cs b/Penumbra/Interop/ResourceLoading/TexMdlService.cs new file mode 100644 index 00000000..b9279f54 --- /dev/null +++ b/Penumbra/Interop/ResourceLoading/TexMdlService.cs @@ -0,0 +1,99 @@ +using Dalamud.Hooking; +using Dalamud.Plugin.Services; +using Dalamud.Utility.Signatures; +using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; +using Penumbra.Api.Enums; +using Penumbra.GameData; +using Penumbra.String.Classes; + +namespace Penumbra.Interop.ResourceLoading; + +public unsafe class TexMdlService : IDisposable +{ + /// Custom ulong flag to signal our files as opposed to SE files. + public static readonly IntPtr CustomFileFlag = new(0xDEADBEEF); + + /// + /// We need to keep a list of all CRC64 hash values of our replaced Mdl and Tex files, + /// i.e. CRC32 of filename in the lower bytes, CRC32 of parent path in the upper bytes. + /// + public IReadOnlySet CustomFileCrc + => _customFileCrc; + + public TexMdlService(IGameInteropProvider interop) + { + interop.InitializeFromAttributes(this); + _checkFileStateHook.Enable(); + _loadTexFileExternHook.Enable(); + _loadMdlFileExternHook.Enable(); + } + + /// Add CRC64 if the given file is a model or texture file and has an associated path. + public void AddCrc(ResourceType type, FullPath? path) + { + if (path.HasValue && type is ResourceType.Mdl or ResourceType.Tex) + _customFileCrc.Add(path.Value.Crc64); + } + + /// Add a fixed CRC64 value. + public void AddCrc(ulong crc64) + => _customFileCrc.Add(crc64); + + public void Dispose() + { + _checkFileStateHook.Dispose(); + _loadTexFileExternHook.Dispose(); + _loadMdlFileExternHook.Dispose(); + } + + private readonly HashSet _customFileCrc = new(); + + private delegate IntPtr CheckFileStatePrototype(IntPtr unk1, ulong crc64); + + [Signature(Sigs.CheckFileState, DetourName = nameof(CheckFileStateDetour))] + private readonly Hook _checkFileStateHook = null!; + + /// + /// The function that checks a files CRC64 to determine whether it is 'protected'. + /// We use it to check against our stored CRC64s and if it corresponds, we return the custom flag. + /// + private IntPtr CheckFileStateDetour(IntPtr ptr, ulong crc64) + => _customFileCrc.Contains(crc64) ? CustomFileFlag : _checkFileStateHook.Original(ptr, crc64); + + + private delegate byte LoadTexFileLocalDelegate(ResourceHandle* handle, int unk1, IntPtr unk2, bool unk3); + + /// We use the local functions for our own files in the extern hook. + [Signature(Sigs.LoadTexFileLocal)] + private readonly LoadTexFileLocalDelegate _loadTexFileLocal = null!; + + private delegate byte LoadMdlFileLocalPrototype(ResourceHandle* handle, IntPtr unk1, bool unk2); + + /// We use the local functions for our own files in the extern hook. + [Signature(Sigs.LoadMdlFileLocal)] + private readonly LoadMdlFileLocalPrototype _loadMdlFileLocal = null!; + + + private delegate byte LoadTexFileExternPrototype(ResourceHandle* handle, int unk1, IntPtr unk2, bool unk3, IntPtr unk4); + + [Signature(Sigs.LoadTexFileExtern, DetourName = nameof(LoadTexFileExternDetour))] + private readonly Hook _loadTexFileExternHook = null!; + + /// We hook the extern functions to just return the local one if given the custom flag as last argument. + private byte LoadTexFileExternDetour(ResourceHandle* resourceHandle, int unk1, IntPtr unk2, bool unk3, IntPtr ptr) + => ptr.Equals(CustomFileFlag) + ? _loadTexFileLocal.Invoke(resourceHandle, unk1, unk2, unk3) + : _loadTexFileExternHook.Original(resourceHandle, unk1, unk2, unk3, ptr); + + public delegate byte LoadMdlFileExternPrototype(ResourceHandle* handle, IntPtr unk1, bool unk2, IntPtr unk3); + + + [Signature(Sigs.LoadMdlFileExtern, DetourName = nameof(LoadMdlFileExternDetour))] + private readonly Hook _loadMdlFileExternHook = null!; + + /// We hook the extern functions to just return the local one if given the custom flag as last argument. + private byte LoadMdlFileExternDetour(ResourceHandle* resourceHandle, IntPtr unk1, bool unk2, IntPtr ptr) + => ptr.Equals(CustomFileFlag) + ? _loadMdlFileLocal.Invoke(resourceHandle, unk1, unk2) + : _loadMdlFileExternHook.Original(resourceHandle, unk1, unk2, ptr); +} diff --git a/Penumbra/Interop/ResourceTree/ResolveContext.PathResolution.cs b/Penumbra/Interop/ResourceTree/ResolveContext.PathResolution.cs index c204f141..d5b4fa39 100644 --- a/Penumbra/Interop/ResourceTree/ResolveContext.PathResolution.cs +++ b/Penumbra/Interop/ResourceTree/ResolveContext.PathResolution.cs @@ -1,6 +1,5 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; -using OtterGui.Text.HelperObjects; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; @@ -9,65 +8,53 @@ using Penumbra.Meta.Manipulations; using Penumbra.String; using Penumbra.String.Classes; using static Penumbra.Interop.Structs.StructExtensions; -using CharaBase = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase; using ModelType = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase.ModelType; namespace Penumbra.Interop.ResourceTree; internal partial record ResolveContext { - private static bool IsEquipmentOrAccessorySlot(uint slotIndex) - => slotIndex is < 10 or 16 or 17; - - private static bool IsEquipmentSlot(uint slotIndex) - => slotIndex is < 5 or 16 or 17; - - private unsafe Variant Variant - => ModelType switch - { - ModelType.Monster => (byte)((Monster*)CharacterBase)->Variant, - _ => Equipment.Variant, - }; - private Utf8GamePath ResolveModelPath() { // Correctness: // Resolving a model path through the game's code can use EQDP metadata for human equipment models. return ModelType switch { - ModelType.Human when IsEquipmentOrAccessorySlot(SlotIndex) => ResolveEquipmentModelPath(), - _ => ResolveModelPathNative(), + ModelType.Human when SlotIndex < 10 => ResolveEquipmentModelPath(), + _ => ResolveModelPathNative(), }; } private Utf8GamePath ResolveEquipmentModelPath() { - var path = IsEquipmentSlot(SlotIndex) - ? GamePaths.Mdl.Equipment(Equipment.Set, ResolveModelRaceCode(), SlotIndex.ToEquipSlot()) - : GamePaths.Mdl.Accessory(Equipment.Set, ResolveModelRaceCode(), SlotIndex.ToEquipSlot()); + var path = SlotIndex < 5 + ? GamePaths.Equipment.Mdl.Path(Equipment.Set, ResolveModelRaceCode(), Slot) + : GamePaths.Accessory.Mdl.Path(Equipment.Set, ResolveModelRaceCode(), Slot); return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; } private GenderRace ResolveModelRaceCode() - => ResolveEqdpRaceCode(SlotIndex, Equipment.Set); + => ResolveEqdpRaceCode(Slot, Equipment.Set); - private unsafe GenderRace ResolveEqdpRaceCode(uint slotIndex, PrimaryId primaryId) + private unsafe GenderRace ResolveEqdpRaceCode(EquipSlot slot, PrimaryId primaryId) { - if (!IsEquipmentOrAccessorySlot(slotIndex) || ModelType != ModelType.Human) + var slotIndex = slot.ToIndex(); + if (slotIndex >= 10 || ModelType != ModelType.Human) return GenderRace.MidlanderMale; var characterRaceCode = (GenderRace)((Human*)CharacterBase)->RaceSexId; if (characterRaceCode == GenderRace.MidlanderMale) return GenderRace.MidlanderMale; - var accessory = !IsEquipmentSlot(slotIndex); + var accessory = slotIndex >= 5; if ((ushort)characterRaceCode % 10 != 1 && accessory) return GenderRace.MidlanderMale; var metaCache = Global.Collection.MetaCache; - var entry = metaCache?.GetEqdpEntry(characterRaceCode, accessory, primaryId) - ?? ExpandedEqdpFile.GetDefault(Global.MetaFileManager, characterRaceCode, accessory, primaryId); - var slot = slotIndex.ToEquipSlot(); + if (metaCache == null) + return GenderRace.MidlanderMale; + + var entry = metaCache.GetEqdpEntry(characterRaceCode, accessory, primaryId); if (entry.ToBits(slot).Item2) return characterRaceCode; @@ -75,8 +62,7 @@ internal partial record ResolveContext if (fallbackRaceCode == GenderRace.MidlanderMale) return GenderRace.MidlanderMale; - entry = metaCache?.GetEqdpEntry(fallbackRaceCode, accessory, primaryId) - ?? ExpandedEqdpFile.GetDefault(Global.MetaFileManager, fallbackRaceCode, accessory, primaryId); + entry = metaCache.GetEqdpEntry(fallbackRaceCode, accessory, primaryId); if (entry.ToBits(slot).Item2) return fallbackRaceCode; @@ -95,25 +81,24 @@ internal partial record ResolveContext // Resolving a material path through the game's code can dereference null pointers for materials that involve IMC metadata. return ModelType switch { - ModelType.Human when IsEquipmentOrAccessorySlot(SlotIndex) && mtrlFileName[8] != (byte)'b' - => ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName), - ModelType.DemiHuman => ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName), - ModelType.Weapon => ResolveWeaponMaterialPath(modelPath, imc, mtrlFileName), - ModelType.Monster => ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName), - _ => ResolveMaterialPathNative(mtrlFileName), + ModelType.Human when SlotIndex < 10 && mtrlFileName[8] != (byte)'b' => ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName), + ModelType.DemiHuman => ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName), + ModelType.Weapon => ResolveWeaponMaterialPath(modelPath, imc, mtrlFileName), + ModelType.Monster => ResolveMonsterMaterialPath(modelPath, imc, mtrlFileName), + _ => ResolveMaterialPathNative(mtrlFileName), }; } [SkipLocalsInit] private unsafe Utf8GamePath ResolveEquipmentMaterialPath(Utf8GamePath modelPath, ResourceHandle* imc, byte* mtrlFileName) { - var variant = ResolveImcData(imc).MaterialId; + var variant = ResolveMaterialVariant(imc, Equipment.Variant); var fileName = MemoryMarshal.CreateReadOnlySpanFromNullTerminated(mtrlFileName); - Span pathBuffer = stackalloc byte[CharaBase.PathBufferSize]; - pathBuffer = AssembleMaterialPath(pathBuffer, modelPath.Path.Span, variant, fileName); + Span pathBuffer = stackalloc byte[260]; + pathBuffer = AssembleMaterialPath(pathBuffer, modelPath.Path.Span, variant, fileName); - return Utf8GamePath.FromSpan(pathBuffer, MetaDataComputation.None, out var path) ? path.Clone() : Utf8GamePath.Empty; + return Utf8GamePath.FromSpan(pathBuffer, out var path) ? path.Clone() : Utf8GamePath.Empty; } [SkipLocalsInit] @@ -122,46 +107,66 @@ internal partial record ResolveContext var setIdHigh = Equipment.Set.Id / 100; // All MCH (20??) weapons' materials C are one and the same if (setIdHigh is 20 && mtrlFileName[14] == (byte)'c') - return Utf8GamePath.FromString(GamePaths.Mtrl.Weapon(2001, 1, 1, "c"), out var path) ? path : Utf8GamePath.Empty; + return Utf8GamePath.FromString(GamePaths.Weapon.Mtrl.Path(2001, 1, 1, "c"), out var path) ? path : Utf8GamePath.Empty; - // Some offhands share materials with the corresponding mainhand - if (ItemData.AdaptOffhandImc(Equipment.Set, out var mirroredSetId)) + // MNK (03??, 16??), NIN (18??) and DNC (26??) offhands share materials with the corresponding mainhand + if (setIdHigh is 3 or 16 or 18 or 26) { - var variant = ResolveImcData(imc).MaterialId; - var fileName = MemoryMarshal.CreateReadOnlySpanFromNullTerminated(mtrlFileName); + var setIdLow = Equipment.Set.Id % 100; + if (setIdLow > 50) + { + var variant = ResolveMaterialVariant(imc, Equipment.Variant); + var fileName = MemoryMarshal.CreateReadOnlySpanFromNullTerminated(mtrlFileName); - Span mirroredFileName = stackalloc byte[32]; - mirroredFileName = mirroredFileName[..fileName.Length]; - fileName.CopyTo(mirroredFileName); - WriteZeroPaddedNumber(mirroredFileName[4..8], mirroredSetId.Id); + var mirroredSetId = (ushort)(Equipment.Set.Id - 50); - Span pathBuffer = stackalloc byte[CharaBase.PathBufferSize]; - pathBuffer = AssembleMaterialPath(pathBuffer, modelPath.Path.Span, variant, mirroredFileName); + Span mirroredFileName = stackalloc byte[32]; + mirroredFileName = mirroredFileName[..fileName.Length]; + fileName.CopyTo(mirroredFileName); + WriteZeroPaddedNumber(mirroredFileName[4..8], mirroredSetId); - var weaponPosition = pathBuffer.IndexOf("/weapon/w"u8); - if (weaponPosition >= 0) - WriteZeroPaddedNumber(pathBuffer[(weaponPosition + 9)..(weaponPosition + 13)], mirroredSetId.Id); + Span pathBuffer = stackalloc byte[260]; + pathBuffer = AssembleMaterialPath(pathBuffer, modelPath.Path.Span, variant, mirroredFileName); - return Utf8GamePath.FromSpan(pathBuffer, MetaDataComputation.None, out var path) ? path.Clone() : Utf8GamePath.Empty; + var weaponPosition = pathBuffer.IndexOf("/weapon/w"u8); + if (weaponPosition >= 0) + WriteZeroPaddedNumber(pathBuffer[(weaponPosition + 9)..(weaponPosition + 13)], mirroredSetId); + + return Utf8GamePath.FromSpan(pathBuffer, out var path) ? path.Clone() : Utf8GamePath.Empty; + } } return ResolveEquipmentMaterialPath(modelPath, imc, mtrlFileName); } - private unsafe ImcEntry ResolveImcData(ResourceHandle* imc) + private unsafe Utf8GamePath ResolveMonsterMaterialPath(Utf8GamePath modelPath, ResourceHandle* imc, byte* mtrlFileName) + { + var variant = ResolveMaterialVariant(imc, (byte)((Monster*)CharacterBase)->Variant); + var fileName = MemoryMarshal.CreateReadOnlySpanFromNullTerminated(mtrlFileName); + + Span pathBuffer = stackalloc byte[260]; + pathBuffer = AssembleMaterialPath(pathBuffer, modelPath.Path.Span, variant, fileName); + + return Utf8GamePath.FromSpan(pathBuffer, out var path) ? path.Clone() : Utf8GamePath.Empty; + } + + private unsafe byte ResolveMaterialVariant(ResourceHandle* imc, Variant variant) { var imcFileData = imc->GetDataSpan(); if (imcFileData.IsEmpty) { - Penumbra.Log.Warning($"IMC resource handle with path {imc->FileName.AsByteString()} doesn't have a valid data span"); - return default; + Penumbra.Log.Warning($"IMC resource handle with path {GetResourceHandlePath(imc, false)} doesn't have a valid data span"); + return variant.Id; } - return ImcFile.GetEntry(imcFileData, SlotIndex.ToEquipSlot(), Variant, out _); + var entry = ImcFile.GetEntry(imcFileData, Slot, variant, out var exists); + if (!exists) + return variant.Id; + + return entry.MaterialId; } - private static Span AssembleMaterialPath(Span materialPathBuffer, ReadOnlySpan modelPath, byte variant, - ReadOnlySpan mtrlFileName) + private static Span AssembleMaterialPath(Span materialPathBuffer, ReadOnlySpan modelPath, byte variant, ReadOnlySpan mtrlFileName) { var modelPosition = modelPath.IndexOf("/model/"u8); if (modelPosition < 0) @@ -169,46 +174,36 @@ internal partial record ResolveContext var baseDirectory = modelPath[..modelPosition]; - var writer = new SpanTextWriter(materialPathBuffer); - writer.Append(baseDirectory); - writer.Append("/material/v"u8); - WriteZeroPaddedNumber(ref writer, 4, variant); - writer.Append((byte)'/'); - writer.Append(mtrlFileName); - writer.EnsureNullTerminated(); + baseDirectory.CopyTo(materialPathBuffer); + "/material/v"u8.CopyTo(materialPathBuffer[baseDirectory.Length..]); + WriteZeroPaddedNumber(materialPathBuffer.Slice(baseDirectory.Length + 11, 4), variant); + materialPathBuffer[baseDirectory.Length + 15] = (byte)'/'; + mtrlFileName.CopyTo(materialPathBuffer[(baseDirectory.Length + 16)..]); - return materialPathBuffer[..writer.Position]; - } - - private static void WriteZeroPaddedNumber(ref SpanTextWriter writer, int width, ushort number) - { - WriteZeroPaddedNumber(writer.GetRemainingSpan()[..width], number); - writer.Advance(width); + return materialPathBuffer[..(baseDirectory.Length + 16 + mtrlFileName.Length)]; } private static void WriteZeroPaddedNumber(Span destination, ushort number) { for (var i = destination.Length; i-- > 0;) { - destination[i] = (byte)('0' + number % 10); - number /= 10; + destination[i] = (byte)('0' + number % 10); + number /= 10; } } private unsafe Utf8GamePath ResolveMaterialPathNative(byte* mtrlFileName) { - CiByteString? path; + ByteString? path; try { path = CharacterBase->ResolveMtrlPathAsByteString(SlotIndex, mtrlFileName); } catch (AccessViolationException) { - Penumbra.Log.Error( - $"Access violation during attempt to resolve material path\nDraw object: {(nint)CharacterBase:X} (of type {ModelType})\nSlot index: {SlotIndex}\nMaterial file name: {(nint)mtrlFileName:X} ({new string((sbyte*)mtrlFileName)})"); + Penumbra.Log.Error($"Access violation during attempt to resolve material path\nDraw object: {(nint)CharacterBase:X} (of type {ModelType})\nSlot index: {SlotIndex}\nMaterial file name: {(nint)mtrlFileName:X} ({new string((sbyte*)mtrlFileName)})"); return Utf8GamePath.Empty; } - return Utf8GamePath.FromByteString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; } @@ -230,7 +225,7 @@ internal partial record ResolveContext if (set == 0) return Utf8GamePath.Empty; - var path = GamePaths.Sklb.Customization(raceCode, slot, set); + var path = GamePaths.Skeleton.Sklb.Path(raceCode, slot, set); return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; } @@ -240,40 +235,45 @@ internal partial record ResolveContext var characterRaceCode = (GenderRace)human->RaceSexId; switch (partialSkeletonIndex) { - case 0: return (characterRaceCode, "base", 1); + case 0: + return (characterRaceCode, "base", 1); case 1: var faceId = human->FaceId; var tribe = human->Customize[(int)Dalamud.Game.ClientState.Objects.Enums.CustomizeIndex.Tribe]; var modelType = human->Customize[(int)Dalamud.Game.ClientState.Objects.Enums.CustomizeIndex.ModelType]; if (faceId < 201) + { faceId -= tribe switch { - 0xB when modelType is 4 => 100, + 0xB when modelType == 4 => 100, 0xE | 0xF => 100, _ => 0, }; - return ResolveHumanExtraSkeletonData(characterRaceCode, EstType.Face, faceId); - case 2: return ResolveHumanExtraSkeletonData(characterRaceCode, EstType.Hair, human->HairId); - case 3: return ResolveHumanEquipmentSkeletonData(EquipSlot.Head, EstType.Head); - case 4: return ResolveHumanEquipmentSkeletonData(EquipSlot.Body, EstType.Body); - default: return (0, string.Empty, 0); + } + return ResolveHumanExtraSkeletonData(characterRaceCode, EstManipulation.EstType.Face, faceId); + case 2: + return ResolveHumanExtraSkeletonData(characterRaceCode, EstManipulation.EstType.Hair, human->HairId); + case 3: + return ResolveHumanEquipmentSkeletonData(EquipSlot.Head, EstManipulation.EstType.Head); + case 4: + return ResolveHumanEquipmentSkeletonData(EquipSlot.Body, EstManipulation.EstType.Body); + default: + return (0, string.Empty, 0); } } - private unsafe (GenderRace RaceCode, string Slot, PrimaryId Set) ResolveHumanEquipmentSkeletonData(EquipSlot slot, EstType type) + private unsafe (GenderRace RaceCode, string Slot, PrimaryId Set) ResolveHumanEquipmentSkeletonData(EquipSlot slot, EstManipulation.EstType type) { var human = (Human*)CharacterBase; var equipment = ((CharacterArmor*)&human->Head)[slot.ToIndex()]; - return ResolveHumanExtraSkeletonData(ResolveEqdpRaceCode(slot.ToIndex(), equipment.Set), type, equipment.Set); + return ResolveHumanExtraSkeletonData(ResolveEqdpRaceCode(slot, equipment.Set), type, equipment.Set); } - private (GenderRace RaceCode, string Slot, PrimaryId Set) ResolveHumanExtraSkeletonData(GenderRace raceCode, EstType type, - PrimaryId primary) + private (GenderRace RaceCode, string Slot, PrimaryId Set) ResolveHumanExtraSkeletonData(GenderRace raceCode, EstManipulation.EstType type, PrimaryId primary) { - var metaCache = Global.Collection.MetaCache; - var skeletonSet = metaCache?.GetEstEntry(type, raceCode, primary) - ?? EstFile.GetDefault(Global.MetaFileManager, type, raceCode, primary); - return (raceCode, type.ToName(), skeletonSet.AsId); + var metaCache = Global.Collection.MetaCache; + var skeletonSet = metaCache?.GetEstEntry(type, raceCode, primary) ?? default; + return (raceCode, EstManipulation.ToName(type), skeletonSet); } private unsafe Utf8GamePath ResolveSkeletonPathNative(uint partialSkeletonIndex) @@ -297,10 +297,10 @@ internal partial record ResolveContext private Utf8GamePath ResolveHumanSkeletonParameterPath(uint partialSkeletonIndex) { var (raceCode, slot, set) = ResolveHumanSkeletonData(partialSkeletonIndex); - if (set.Id is 0) + if (set == 0) return Utf8GamePath.Empty; - var path = GamePaths.Skp.Customization(raceCode, slot, set); + var path = GamePaths.Skeleton.Skp.Path(raceCode, slot, set); return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; } @@ -309,80 +309,4 @@ internal partial record ResolveContext var path = CharacterBase->ResolveSkpPathAsByteString(partialSkeletonIndex); return Utf8GamePath.FromByteString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; } - - private Utf8GamePath ResolvePhysicsModulePath(uint partialSkeletonIndex) - { - // Correctness and Safety: - // Resolving a physics module path through the game's code can use EST metadata for human skeletons. - // Additionally, it can dereference null pointers for human equipment skeletons. - return ModelType switch - { - ModelType.Human => ResolveHumanPhysicsModulePath(partialSkeletonIndex), - _ => ResolvePhysicsModulePathNative(partialSkeletonIndex), - }; - } - - private Utf8GamePath ResolveHumanPhysicsModulePath(uint partialSkeletonIndex) - { - var (raceCode, slot, set) = ResolveHumanSkeletonData(partialSkeletonIndex); - if (set.Id is 0) - return Utf8GamePath.Empty; - - var path = GamePaths.Phyb.Customization(raceCode, slot, set); - return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } - - private unsafe Utf8GamePath ResolvePhysicsModulePathNative(uint partialSkeletonIndex) - { - var path = CharacterBase->ResolvePhybPathAsByteString(partialSkeletonIndex); - return Utf8GamePath.FromByteString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } - - private Utf8GamePath ResolveKineDriverModulePath(uint partialSkeletonIndex) - { - // Correctness and Safety: - // Resolving a KineDriver module path through the game's code can use EST metadata for human skeletons. - // Additionally, it can dereference null pointers for human equipment skeletons. - return ModelType switch - { - ModelType.Human => ResolveHumanKineDriverModulePath(partialSkeletonIndex), - _ => ResolveKineDriverModulePathNative(partialSkeletonIndex), - }; - } - - private Utf8GamePath ResolveHumanKineDriverModulePath(uint partialSkeletonIndex) - { - var (raceCode, slot, set) = ResolveHumanSkeletonData(partialSkeletonIndex); - if (set.Id is 0) - return Utf8GamePath.Empty; - - var path = GamePaths.Kdb.Customization(raceCode, slot, set); - return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } - - private unsafe Utf8GamePath ResolveKineDriverModulePathNative(uint partialSkeletonIndex) - { - var path = CharacterBase->ResolveKdbPathAsByteString(partialSkeletonIndex); - return Utf8GamePath.FromByteString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } - - private unsafe Utf8GamePath ResolveMaterialAnimationPath(ResourceHandle* imc) - { - var animation = ResolveImcData(imc).MaterialAnimationId; - if (animation is 0) - return Utf8GamePath.Empty; - - var path = CharacterBase->ResolveMaterialPapPathAsByteString(SlotIndex, animation); - return Utf8GamePath.FromByteString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } - - private unsafe Utf8GamePath ResolveDecalPath(ResourceHandle* imc) - { - var decal = ResolveImcData(imc).DecalId; - if (decal is 0) - return Utf8GamePath.Empty; - - var path = GamePaths.Tex.EquipDecal(decal); - return Utf8GamePath.FromString(path, out var gamePath) ? gamePath : Utf8GamePath.Empty; - } } diff --git a/Penumbra/Interop/ResourceTree/ResolveContext.cs b/Penumbra/Interop/ResourceTree/ResolveContext.cs index 501bbc56..615ef2b0 100644 --- a/Penumbra/Interop/ResourceTree/ResolveContext.cs +++ b/Penumbra/Interop/ResourceTree/ResolveContext.cs @@ -1,71 +1,64 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; using FFXIVClientStructs.FFXIV.Client.Graphics.Render; +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; using FFXIVClientStructs.Interop; -using OtterGui.Extensions; -using OtterGui.Text.HelperObjects; +using OtterGui; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; -using Penumbra.Interop.Hooks.PostProcessing; -using Penumbra.Interop.PathResolving; -using Penumbra.Meta; +using Penumbra.Interop.Services; using Penumbra.String; using Penumbra.String.Classes; using Penumbra.UI; using static Penumbra.Interop.Structs.StructExtensions; -using CharaBase = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase; +using ModelType = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase.ModelType; namespace Penumbra.Interop.ResourceTree; -internal record GlobalResolveContext( - MetaFileManager MetaFileManager, - ObjectIdentification Identifier, - ModCollection Collection, - TreeBuildCache TreeBuildCache, - bool WithUiData) +internal record GlobalResolveContext(ObjectIdentification Identifier, ModCollection Collection, TreeBuildCache TreeBuildCache, bool WithUiData) { public readonly Dictionary<(Utf8GamePath, nint), ResourceNode> Nodes = new(128); - public unsafe ResolveContext CreateContext(CharaBase* characterBase, uint slotIndex = 0xFFFFFFFFu, - FullEquipType slot = FullEquipType.Unknown, CharacterArmor equipment = default, SecondaryId secondaryId = default) + public unsafe ResolveContext CreateContext(CharacterBase* characterBase, uint slotIndex = 0xFFFFFFFFu, + EquipSlot slot = EquipSlot.Unknown, CharacterArmor equipment = default, SecondaryId secondaryId = default) => new(this, characterBase, slotIndex, slot, equipment, secondaryId); } internal unsafe partial record ResolveContext( GlobalResolveContext Global, - Pointer CharacterBasePointer, + Pointer CharacterBasePointer, uint SlotIndex, - FullEquipType Slot, + EquipSlot Slot, CharacterArmor Equipment, SecondaryId SecondaryId) { - public CharaBase* CharacterBase + public CharacterBase* CharacterBase => CharacterBasePointer.Value; - private static readonly CiByteString ShpkPrefix = CiByteString.FromSpanUnsafe("shader/sm5/shpk"u8, true, true, true); + private static readonly ByteString ShpkPrefix = ByteString.FromSpanUnsafe("shader/sm5/shpk"u8, true, true, true); - private CharaBase.ModelType ModelType + private ModelType ModelType => CharacterBase->GetModelType(); - private ResourceNode? CreateNodeFromShpk(ShaderPackageResourceHandle* resourceHandle, CiByteString gamePath) + private ResourceNode? CreateNodeFromShpk(ShaderPackageResourceHandle* resourceHandle, ByteString gamePath) { - if (resourceHandle is null) + if (resourceHandle == null) return null; if (gamePath.IsEmpty) return null; - if (!Utf8GamePath.FromByteString(CiByteString.Join((byte)'/', ShpkPrefix, gamePath), out var path)) + if (!Utf8GamePath.FromByteString(ByteString.Join((byte)'/', ShpkPrefix, gamePath), out var path, false)) return null; - return GetOrCreateNode(ResourceType.Shpk, (nint)resourceHandle->ShaderPackage, (ResourceHandle*)resourceHandle, path); + return GetOrCreateNode(ResourceType.Shpk, (nint)resourceHandle->ShaderPackage, &resourceHandle->ResourceHandle, path); } [SkipLocalsInit] - private ResourceNode? CreateNodeFromTex(TextureResourceHandle* resourceHandle, CiByteString gamePath, bool dx11) + private ResourceNode? CreateNodeFromTex(TextureResourceHandle* resourceHandle, ByteString gamePath, bool dx11) { - if (resourceHandle is null) + if (resourceHandle == null) return null; Utf8GamePath path; @@ -75,16 +68,13 @@ internal unsafe partial record ResolveContext( if (lastDirectorySeparator == -1 || lastDirectorySeparator > gamePath.Length - 3) return null; - Span prefixed = stackalloc byte[CharaBase.PathBufferSize]; + Span prefixed = stackalloc byte[260]; + gamePath.Span[..(lastDirectorySeparator + 1)].CopyTo(prefixed); + prefixed[lastDirectorySeparator + 1] = (byte)'-'; + prefixed[lastDirectorySeparator + 2] = (byte)'-'; + gamePath.Span[(lastDirectorySeparator + 1)..].CopyTo(prefixed[(lastDirectorySeparator + 3)..]); - var writer = new SpanTextWriter(prefixed); - writer.Append(gamePath.Span[..(lastDirectorySeparator + 1)]); - writer.Append((byte)'-'); - writer.Append((byte)'-'); - writer.Append(gamePath.Span[(lastDirectorySeparator + 1)..]); - writer.EnsureNullTerminated(); - - if (!Utf8GamePath.FromSpan(prefixed[..(gamePath.Length + 2)], MetaDataComputation.None, out var tmp)) + if (!Utf8GamePath.FromSpan(prefixed[..(gamePath.Length + 2)], out var tmp)) return null; path = tmp.Clone(); @@ -105,7 +95,7 @@ internal unsafe partial record ResolveContext( private ResourceNode GetOrCreateNode(ResourceType type, nint objectAddress, ResourceHandle* resourceHandle, Utf8GamePath gamePath) { - if (resourceHandle is null) + if (resourceHandle == null) throw new ArgumentNullException(nameof(resourceHandle)); if (Global.Nodes.TryGetValue((gamePath, (nint)resourceHandle), out var cached)) @@ -117,21 +107,15 @@ internal unsafe partial record ResolveContext( private ResourceNode CreateNode(ResourceType type, nint objectAddress, ResourceHandle* resourceHandle, Utf8GamePath gamePath, bool autoAdd = true) { - if (resourceHandle is null) + if (resourceHandle == null) throw new ArgumentNullException(nameof(resourceHandle)); - var fileName = (ReadOnlySpan)resourceHandle->FileName.AsSpan(); - var additionalData = CiByteString.Empty; - if (PathDataHandler.Split(fileName, out fileName, out var data)) - additionalData = CiByteString.FromSpanUnsafe(data, false).Clone(); - - var fullPath = Utf8GamePath.FromSpan(fileName, MetaDataComputation.None, out var p) ? new FullPath(p.Clone()) : FullPath.Empty; + var fullPath = Utf8GamePath.FromByteString(GetResourceHandlePath(resourceHandle), out var p) ? new FullPath(p) : FullPath.Empty; var node = new ResourceNode(type, objectAddress, (nint)resourceHandle, GetResourceHandleLength(resourceHandle), this) { - GamePath = gamePath, - FullPath = fullPath, - AdditionalData = additionalData, + GamePath = gamePath, + FullPath = fullPath, }; if (autoAdd) Global.Nodes.Add((gamePath, (nint)resourceHandle), node); @@ -141,7 +125,7 @@ internal unsafe partial record ResolveContext( public ResourceNode? CreateNodeFromEid(ResourceHandle* eid) { - if (eid is null) + if (eid == null) return null; if (!Utf8GamePath.FromByteString(CharacterBase->ResolveEidPathAsByteString(), out var path)) @@ -152,7 +136,7 @@ internal unsafe partial record ResolveContext( public ResourceNode? CreateNodeFromImc(ResourceHandle* imc) { - if (imc is null) + if (imc == null) return null; if (!Utf8GamePath.FromByteString(CharacterBase->ResolveImcPathAsByteString(SlotIndex), out var path)) @@ -163,7 +147,7 @@ internal unsafe partial record ResolveContext( public ResourceNode? CreateNodeFromPbd(ResourceHandle* pbd) { - if (pbd is null) + if (pbd == null) return null; return GetOrCreateNode(ResourceType.Pbd, 0, pbd, PreBoneDeformerReplacer.PreBoneDeformerPath); @@ -171,7 +155,7 @@ internal unsafe partial record ResolveContext( public ResourceNode? CreateNodeFromTex(TextureResourceHandle* tex, string gamePath) { - if (tex is null) + if (tex == null) return null; if (!Utf8GamePath.FromString(gamePath, out var path)) @@ -180,18 +164,9 @@ internal unsafe partial record ResolveContext( return GetOrCreateNode(ResourceType.Tex, (nint)tex->Texture, &tex->ResourceHandle, path); } - public ResourceNode? CreateNodeFromTex(TextureResourceHandle* tex, Utf8GamePath gamePath) + public ResourceNode? CreateNodeFromModel(Model* mdl, ResourceHandle* imc) { - if (tex is null) - return null; - - return GetOrCreateNode(ResourceType.Tex, (nint)tex->Texture, &tex->ResourceHandle, gamePath); - } - - public ResourceNode? CreateNodeFromModel(Model* mdl, ResourceHandle* imc, TextureResourceHandle* decalHandle, - MaterialResourceHandle* skinMtrlHandle, ResourceHandle* mpapHandle) - { - if (mdl is null || mdl->ModelResourceHandle is null) + if (mdl == null || mdl->ModelResourceHandle == null) return null; var mdlResource = mdl->ModelResourceHandle; @@ -206,12 +181,12 @@ internal unsafe partial record ResolveContext( for (var i = 0; i < mdl->MaterialCount; i++) { var mtrl = mdl->Materials[i]; - if (mtrl is null) + if (mtrl == null) continue; var mtrlFileName = mdlResource->GetMaterialFileNameBySlot((uint)i); var mtrlNode = CreateNodeFromMaterial(mtrl, ResolveMaterialPath(path, imc, mtrlFileName)); - if (mtrlNode is not null) + if (mtrlNode != null) { if (Global.WithUiData) mtrlNode.FallbackName = $"Material #{i}"; @@ -219,18 +194,6 @@ internal unsafe partial record ResolveContext( } } - if (skinMtrlHandle is not null - && Utf8GamePath.FromByteString(CharacterBase->ResolveSkinMtrlPathAsByteString(SlotIndex), out var skinMtrlPath) - && CreateNodeFromMaterial(skinMtrlHandle->Material, skinMtrlPath) is - { } skinMaaterialNode) - node.Children.Add(skinMaaterialNode); - - if (CreateNodeFromDecal(decalHandle, imc) is { } decalNode) - node.Children.Add(decalNode); - - if (CreateNodeFromMaterialPap(mpapHandle, imc) is { } mpapNode) - node.Children.Add(mpapNode); - Global.Nodes.Add((path, (nint)mdl->ModelResourceHandle), node); return node; @@ -238,29 +201,29 @@ internal unsafe partial record ResolveContext( private ResourceNode? CreateNodeFromMaterial(Material* mtrl, Utf8GamePath path) { - if (mtrl is null || mtrl->MaterialResourceHandle is null) + if (mtrl == null || mtrl->MaterialResourceHandle == null) return null; var resource = mtrl->MaterialResourceHandle; if (Global.Nodes.TryGetValue((path, (nint)resource), out var cached)) return cached; - var node = CreateNode(ResourceType.Mtrl, (nint)mtrl, (ResourceHandle*)resource, path, false); - var shpkNode = CreateNodeFromShpk(resource->ShaderPackageResourceHandle, new CiByteString(resource->ShpkName.Value)); - if (shpkNode is not null) + var node = CreateNode(ResourceType.Mtrl, (nint)mtrl, &resource->ResourceHandle, path, false); + var shpkNode = CreateNodeFromShpk(resource->ShaderPackageResourceHandle, new ByteString(resource->ShpkName)); + if (shpkNode != null) { if (Global.WithUiData) shpkNode.Name = "Shader Package"; node.Children.Add(shpkNode); } - var shpkNames = Global.WithUiData && shpkNode is not null ? Global.TreeBuildCache.ReadShaderPackageNames(shpkNode.FullPath) : null; - var shpk = Global.WithUiData && shpkNode is not null ? (ShaderPackage*)shpkNode.ObjectAddress : null; + var shpkFile = Global.WithUiData && shpkNode != null ? Global.TreeBuildCache.ReadShaderPackage(shpkNode.FullPath) : null; + var shpk = Global.WithUiData && shpkNode != null ? (ShaderPackage*)shpkNode.ObjectAddress : null; var alreadyProcessedSamplerIds = new HashSet(); for (var i = 0; i < resource->TextureCount; i++) { - var texNode = CreateNodeFromTex(resource->Textures[i].TextureResourceHandle, new CiByteString(resource->TexturePath(i).Value), + var texNode = CreateNodeFromTex(resource->Textures[i].TextureResourceHandle, new ByteString(resource->TexturePath(i)), resource->Textures[i].IsDX11); if (texNode == null) continue; @@ -268,7 +231,7 @@ internal unsafe partial record ResolveContext( if (Global.WithUiData) { string? name = null; - if (shpk is not null) + if (shpk != null) { var index = GetTextureIndex(mtrl, resource->Textures[i].Flags, alreadyProcessedSamplerIds); var samplerId = index != 0x001F @@ -277,14 +240,9 @@ internal unsafe partial record ResolveContext( if (samplerId.HasValue) { alreadyProcessedSamplerIds.Add(samplerId.Value); - var textureCrc = GetTextureCrcById(shpk, samplerId.Value); - if (textureCrc.HasValue) - { - if (shpkNames != null && shpkNames.TryGetValue(textureCrc.Value, out var samplerName)) - name = samplerName.Value; - else - name = $"Texture 0x{textureCrc.Value:X8}"; - } + var samplerCrc = GetSamplerCrcById(shpk, samplerId.Value); + if (samplerCrc.HasValue) + name = shpkFile?.GetSamplerById(samplerCrc.Value)?.Name ?? $"Texture 0x{samplerCrc.Value:X8}"; } } @@ -299,9 +257,9 @@ internal unsafe partial record ResolveContext( return node; - static uint? GetTextureCrcById(ShaderPackage* shpk, uint id) - => shpk->TexturesSpan.FindFirst(t => t.Id == id, out var t) - ? t.CRC + static uint? GetSamplerCrcById(ShaderPackage* shpk, uint id) + => shpk->SamplersSpan.FindFirst(s => s.Id == id, out var s) + ? s.CRC : null; static uint? GetTextureSamplerId(Material* mtrl, TextureResourceHandle* handle, HashSet alreadyVisitedSamplerIds) @@ -322,59 +280,9 @@ internal unsafe partial record ResolveContext( } } - public ResourceNode? CreateNodeFromDecal(TextureResourceHandle* decalHandle, ResourceHandle* imc) + public ResourceNode? CreateNodeFromPartialSkeleton(PartialSkeleton* sklb, uint partialSkeletonIndex) { - if (decalHandle is null) - return null; - - var path = ResolveDecalPath(imc); - if (path.IsEmpty) - return null; - - var node = CreateNodeFromTex(decalHandle, path)!; - if (Global.WithUiData) - node.FallbackName = "Decal"; - - return node; - } - - public ResourceNode? CreateNodeFromMaterialPap(ResourceHandle* mpapHandle, ResourceHandle* imc) - { - if (mpapHandle is null) - return null; - - var path = ResolveMaterialAnimationPath(imc); - if (path.IsEmpty) - return null; - - if (Global.Nodes.TryGetValue((path, (nint)mpapHandle), out var cached)) - return cached; - - var node = CreateNode(ResourceType.Pap, 0, mpapHandle, path); - if (Global.WithUiData) - node.FallbackName = "Material Animation"; - - return node; - } - - public ResourceNode? CreateNodeFromMaterialSklb(SkeletonResourceHandle* sklbHandle) - { - if (sklbHandle is null) - return null; - - if (Global.Nodes.TryGetValue((GamePaths.Sklb.MaterialAnimationSkeletonUtf8, (nint)sklbHandle), out var cached)) - return cached; - - var node = CreateNode(ResourceType.Sklb, 0, (ResourceHandle*)sklbHandle, GamePaths.Sklb.MaterialAnimationSkeletonUtf8); - node.ForceInternal = true; - - return node; - } - - public ResourceNode? CreateNodeFromPartialSkeleton(PartialSkeleton* sklb, ResourceHandle* phybHandle, ResourceHandle* kdbHandle, - uint partialSkeletonIndex) - { - if (sklb is null || sklb->SkeletonResourceHandle is null) + if (sklb == null || sklb->SkeletonResourceHandle == null) return null; var path = ResolveSkeletonPath(partialSkeletonIndex); @@ -382,13 +290,10 @@ internal unsafe partial record ResolveContext( if (Global.Nodes.TryGetValue((path, (nint)sklb->SkeletonResourceHandle), out var cached)) return cached; - var node = CreateNode(ResourceType.Sklb, (nint)sklb, (ResourceHandle*)sklb->SkeletonResourceHandle, path, false); - if (CreateParameterNodeFromPartialSkeleton(sklb, partialSkeletonIndex) is { } skpNode) + var node = CreateNode(ResourceType.Sklb, (nint)sklb, (ResourceHandle*)sklb->SkeletonResourceHandle, path, false); + var skpNode = CreateParameterNodeFromPartialSkeleton(sklb, partialSkeletonIndex); + if (skpNode != null) node.Children.Add(skpNode); - if (CreateNodeFromPhyb(phybHandle, partialSkeletonIndex) is { } phybNode) - node.Children.Add(phybNode); - if (CreateNodeFromKdb(kdbHandle, partialSkeletonIndex) is { } kdbNode) - node.Children.Add(kdbNode); Global.Nodes.Add((path, (nint)sklb->SkeletonResourceHandle), node); return node; @@ -396,7 +301,7 @@ internal unsafe partial record ResolveContext( private ResourceNode? CreateParameterNodeFromPartialSkeleton(PartialSkeleton* sklb, uint partialSkeletonIndex) { - if (sklb is null || sklb->SkeletonParameterResourceHandle is null) + if (sklb == null || sklb->SkeletonParameterResourceHandle == null) return null; var path = ResolveSkeletonParameterPath(partialSkeletonIndex); @@ -412,87 +317,79 @@ internal unsafe partial record ResolveContext( return node; } - private ResourceNode? CreateNodeFromPhyb(ResourceHandle* phybHandle, uint partialSkeletonIndex) - { - if (phybHandle is null) - return null; - - var path = ResolvePhysicsModulePath(partialSkeletonIndex); - - if (Global.Nodes.TryGetValue((path, (nint)phybHandle), out var cached)) - return cached; - - var node = CreateNode(ResourceType.Phyb, 0, phybHandle, path, false); - if (Global.WithUiData) - node.FallbackName = "Physics Module"; - Global.Nodes.Add((path, (nint)phybHandle), node); - - return node; - } - - private ResourceNode? CreateNodeFromKdb(ResourceHandle* kdbHandle, uint partialSkeletonIndex) - { - if (kdbHandle is null) - return null; - - var path = ResolveKineDriverModulePath(partialSkeletonIndex); - - if (Global.Nodes.TryGetValue((path, (nint)kdbHandle), out var cached)) - return cached; - - var node = CreateNode(ResourceType.Kdb, 0, kdbHandle, path, false); - if (Global.WithUiData) - node.FallbackName = "KineDriver Module"; - Global.Nodes.Add((path, (nint)kdbHandle), node); - - return node; - } - internal ResourceNode.UiData GuessModelUiData(Utf8GamePath gamePath) { - var path = gamePath.Path.Split((byte)'/'); + var path = gamePath.ToString().Split('/', StringSplitOptions.RemoveEmptyEntries); // Weapons intentionally left out. - var isEquipment = path.Count >= 2 - && path[0].Span.SequenceEqual("chara"u8) - && (path[1].Span.SequenceEqual("accessory"u8) || path[1].Span.SequenceEqual("equipment"u8)); + var isEquipment = SafeGet(path, 0) == "chara" && SafeGet(path, 1) is "accessory" or "equipment"; if (isEquipment) foreach (var item in Global.Identifier.Identify(Equipment.Set, 0, Equipment.Variant, Slot.ToSlot())) { - var name = item.Name; - if (Slot is FullEquipType.Finger) - name = SlotIndex switch + var name = Slot switch { - 8 => "R: " + name, - 9 => "L: " + name, - _ => name, - }; - return new ResourceNode.UiData(name, item.Type.GetCategoryIcon().ToFlag()); + EquipSlot.RFinger => "R: ", + EquipSlot.LFinger => "L: ", + _ => string.Empty, + } + + item.Name; + return new ResourceNode.UiData(name, ChangedItemDrawer.GetCategoryIcon(item.Name, item)); } var dataFromPath = GuessUiDataFromPath(gamePath); - if (dataFromPath.Name is not null) + if (dataFromPath.Name != null) return dataFromPath; return isEquipment - ? new ResourceNode.UiData(Slot.ToName(), Slot.GetCategoryIcon().ToFlag()) - : new ResourceNode.UiData(null, ChangedItemIconFlag.Unknown); + ? new ResourceNode.UiData(Slot.ToName(), ChangedItemDrawer.GetCategoryIcon(Slot.ToSlot())) + : new ResourceNode.UiData(null, ChangedItemDrawer.ChangedItemIcon.Unknown); } internal ResourceNode.UiData GuessUiDataFromPath(Utf8GamePath gamePath) { - const string customization = "Customization: "; foreach (var obj in Global.Identifier.Identify(gamePath.ToString())) { var name = obj.Key; - if (name.StartsWith(customization)) - name = name.AsSpan(14).Trim().ToString(); - if (name is not "Unknown") - return new ResourceNode.UiData(name, obj.Value.GetIcon().ToFlag()); + if (name.StartsWith("Customization:")) + name = name[14..].Trim(); + if (name != "Unknown") + return new ResourceNode.UiData(name, ChangedItemDrawer.GetCategoryIcon(obj.Key, obj.Value)); } - return new ResourceNode.UiData(null, ChangedItemIconFlag.Unknown); + return new ResourceNode.UiData(null, ChangedItemDrawer.ChangedItemIcon.Unknown); + } + + private static string? SafeGet(ReadOnlySpan array, Index index) + { + var i = index.GetOffset(array.Length); + return i >= 0 && i < array.Length ? array[i] : null; + } + + internal static ByteString GetResourceHandlePath(ResourceHandle* handle, bool stripPrefix = true) + { + if (handle == null) + return ByteString.Empty; + + var name = handle->FileName.AsByteString(); + if (name.IsEmpty) + return ByteString.Empty; + + if (stripPrefix && name[0] == (byte)'|') + { + var pos = name.IndexOf((byte)'|', 1); + if (pos < 0) + return ByteString.Empty; + + name = name.Substring(pos + 1); + } + + return name; } private static ulong GetResourceHandleLength(ResourceHandle* handle) - => handle is null ? 0ul : handle->GetLength(); + { + if (handle == null) + return 0; + + return handle->GetLength(); + } } diff --git a/Penumbra/Interop/ResourceTree/ResourceNode.cs b/Penumbra/Interop/ResourceTree/ResourceNode.cs index 08dee818..7ec75893 100644 --- a/Penumbra/Interop/ResourceTree/ResourceNode.cs +++ b/Penumbra/Interop/ResourceTree/ResourceNode.cs @@ -1,31 +1,23 @@ using Penumbra.Api.Enums; -using Penumbra.Mods; -using Penumbra.String; using Penumbra.String.Classes; -using Penumbra.UI; +using ChangedItemIcon = Penumbra.UI.ChangedItemDrawer.ChangedItemIcon; namespace Penumbra.Interop.ResourceTree; public class ResourceNode : ICloneable { - public string? Name; - public string? FallbackName; - public ChangedItemIconFlag IconFlag; - public readonly ResourceType Type; - public readonly nint ObjectAddress; - public readonly nint ResourceHandle; - public Utf8GamePath[] PossibleGamePaths; - public FullPath FullPath; - public PathStatus FullPathStatus; - public bool ForceInternal; - public bool ForceProtected; - public string? ModName; - public readonly WeakReference Mod = new(null!); - public string? ModRelativePath; - public CiByteString AdditionalData; - public readonly ulong Length; - public readonly List Children; - internal ResolveContext? ResolveContext; + public string? Name; + public string? FallbackName; + public ChangedItemIcon Icon; + public ChangedItemIcon DescendentIcons; + public readonly ResourceType Type; + public readonly nint ObjectAddress; + public readonly nint ResourceHandle; + public Utf8GamePath[] PossibleGamePaths; + public FullPath FullPath; + public readonly ulong Length; + public readonly List Children; + internal ResolveContext? ResolveContext; public Utf8GamePath GamePath { @@ -33,29 +25,21 @@ public class ResourceNode : ICloneable set { if (value.IsEmpty) - PossibleGamePaths = []; + PossibleGamePaths = Array.Empty(); else - PossibleGamePaths = [value]; + PossibleGamePaths = new[] { value }; } } - /// Whether to treat the file as internal (hide from user unless debug mode is on). public bool Internal - => ForceInternal || Type is ResourceType.Eid or ResourceType.Imc; - - /// Whether to treat the file as protected (require holding the Mod Deletion Modifier to make a quick import). - public bool Protected - => ForceProtected - || Internal - || Type is ResourceType.Shpk or ResourceType.Sklb or ResourceType.Skp or ResourceType.Phyb or ResourceType.Kdb or ResourceType.Pbd; + => Type is ResourceType.Eid or ResourceType.Imc; internal ResourceNode(ResourceType type, nint objectAddress, nint resourceHandle, ulong length, ResolveContext? resolveContext) { Type = type; ObjectAddress = objectAddress; ResourceHandle = resourceHandle; - PossibleGamePaths = []; - AdditionalData = CiByteString.Empty; + PossibleGamePaths = Array.Empty(); Length = length; Children = new List(); ResolveContext = resolveContext; @@ -65,19 +49,13 @@ public class ResourceNode : ICloneable { Name = other.Name; FallbackName = other.FallbackName; - IconFlag = other.IconFlag; + Icon = other.Icon; + DescendentIcons = other.DescendentIcons; Type = other.Type; ObjectAddress = other.ObjectAddress; ResourceHandle = other.ResourceHandle; PossibleGamePaths = other.PossibleGamePaths; FullPath = other.FullPath; - FullPathStatus = other.FullPathStatus; - ModName = other.ModName; - Mod = other.Mod; - ModRelativePath = other.ModRelativePath; - AdditionalData = other.AdditionalData; - ForceInternal = other.ForceInternal; - ForceProtected = other.ForceProtected; Length = other.Length; Children = other.Children; ResolveContext = other.ResolveContext; @@ -98,8 +76,8 @@ public class ResourceNode : ICloneable public void SetUiData(UiData uiData) { - Name = uiData.Name; - IconFlag = uiData.IconFlag; + Name = uiData.Name; + Icon = uiData.Icon; } public void PrependName(string prefix) @@ -108,16 +86,9 @@ public class ResourceNode : ICloneable Name = prefix + Name; } - public readonly record struct UiData(string? Name, ChangedItemIconFlag IconFlag) + public readonly record struct UiData(string? Name, ChangedItemIcon Icon) { - public UiData PrependName(string prefix) - => Name == null ? this : this with { Name = prefix + Name }; - } - - public enum PathStatus : byte - { - Valid, - NonExistent, - External, + public readonly UiData PrependName(string prefix) + => Name == null ? this : new UiData(prefix + Name, Icon); } } diff --git a/Penumbra/Interop/ResourceTree/ResourceTree.cs b/Penumbra/Interop/ResourceTree/ResourceTree.cs index 1ebfe53d..dac86e44 100644 --- a/Penumbra/Interop/ResourceTree/ResourceTree.cs +++ b/Penumbra/Interop/ResourceTree/ResourceTree.cs @@ -1,50 +1,48 @@ using FFXIVClientStructs.FFXIV.Client.Game.Character; -using FFXIVClientStructs.FFXIV.Client.Graphics.Physics; using FFXIVClientStructs.FFXIV.Client.Graphics.Render; using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; -using FFXIVClientStructs.Interop; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; -using Penumbra.Interop.Hooks.PostProcessing; +using Penumbra.Interop.Services; using Penumbra.UI; using CustomizeData = FFXIVClientStructs.FFXIV.Client.Game.Character.CustomizeData; using CustomizeIndex = Dalamud.Game.ClientState.Objects.Enums.CustomizeIndex; -using ModelType = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase.ModelType; -using ResourceHandle = FFXIVClientStructs.FFXIV.Client.System.Resource.Handle.ResourceHandle; namespace Penumbra.Interop.ResourceTree; -public class ResourceTree( - string name, - string anonymizedName, - int gameObjectIndex, - nint gameObjectAddress, - nint drawObjectAddress, - bool localPlayerRelated, - bool playerRelated, - bool networked, - string collectionName, - string anonymizedCollectionName) +public class ResourceTree { - public readonly string Name = name; - public readonly string AnonymizedName = anonymizedName; - public readonly int GameObjectIndex = gameObjectIndex; - public readonly nint GameObjectAddress = gameObjectAddress; - public readonly nint DrawObjectAddress = drawObjectAddress; - public readonly bool LocalPlayerRelated = localPlayerRelated; - public readonly bool PlayerRelated = playerRelated; - public readonly bool Networked = networked; - public readonly string CollectionName = collectionName; - public readonly string AnonymizedCollectionName = anonymizedCollectionName; - public readonly List Nodes = []; - public readonly HashSet FlatNodes = []; + public readonly string Name; + public readonly int GameObjectIndex; + public readonly nint GameObjectAddress; + public readonly nint DrawObjectAddress; + public readonly bool LocalPlayerRelated; + public readonly bool PlayerRelated; + public readonly bool Networked; + public readonly string CollectionName; + public readonly List Nodes; + public readonly HashSet FlatNodes; public int ModelId; public CustomizeData CustomizeData; public GenderRace RaceCode; + public ResourceTree(string name, int gameObjectIndex, nint gameObjectAddress, nint drawObjectAddress, bool localPlayerRelated, bool playerRelated, bool networked, string collectionName) + { + Name = name; + GameObjectIndex = gameObjectIndex; + GameObjectAddress = gameObjectAddress; + DrawObjectAddress = drawObjectAddress; + LocalPlayerRelated = localPlayerRelated; + Networked = networked; + PlayerRelated = playerRelated; + CollectionName = collectionName; + Nodes = new List(); + FlatNodes = new HashSet(); + } + public void ProcessPostfix(Action action) { foreach (var node in Nodes) @@ -56,64 +54,37 @@ public class ResourceTree( var character = (Character*)GameObjectAddress; var model = (CharacterBase*)DrawObjectAddress; var modelType = model->GetModelType(); - var human = modelType == ModelType.Human ? (Human*)model : null; + var human = modelType == CharacterBase.ModelType.Human ? (Human*)model : null; var equipment = modelType switch { - ModelType.Human => new ReadOnlySpan(&human->Head, 12), - ModelType.DemiHuman => new ReadOnlySpan( - Unsafe.AsPointer(ref character->DrawData.EquipmentModelIds[0]), 10), - _ => [], + CharacterBase.ModelType.Human => new ReadOnlySpan(&human->Head, 10), + CharacterBase.ModelType.DemiHuman => new ReadOnlySpan(&character->DrawData.Head, 10), + _ => ReadOnlySpan.Empty, }; - ModelId = character->ModelContainer.ModelCharaId; + ModelId = character->CharacterData.ModelCharaId; CustomizeData = character->DrawData.CustomizeData; - RaceCode = human is not null ? (GenderRace)human->RaceSexId : GenderRace.Unknown; + RaceCode = human != null ? (GenderRace)human->RaceSexId : GenderRace.Unknown; var genericContext = globalContext.CreateContext(model); - var mpapArrayPtr = model->MaterialAnimationPacks; - var mpapArray = mpapArrayPtr is not null ? new ReadOnlySpan>(mpapArrayPtr, model->SlotCount) : []; - var skinMtrlArray = modelType switch + for (var i = 0; i < model->SlotCount; ++i) { - ModelType.Human => ((Human*) model)->SlotSkinMaterials, - _ => [], - }; - var decalArray = modelType switch - { - ModelType.Human => human->SlotDecals, - ModelType.DemiHuman => ((Demihuman*)model)->SlotDecals, - ModelType.Weapon => [((Weapon*)model)->Decal], - ModelType.Monster => [((Monster*)model)->Decal], - _ => [], - }; + var slotContext = i < equipment.Length + ? globalContext.CreateContext(model, (uint)i, ((uint)i).ToEquipSlot(), equipment[i]) + : globalContext.CreateContext(model, (uint)i); - for (var i = 0u; i < model->SlotCount; ++i) - { - var slotContext = modelType switch - { - ModelType.Human => i switch - { - < 10 => globalContext.CreateContext(model, i, i.ToEquipSlot().ToEquipType(), equipment[(int)i]), - 16 => globalContext.CreateContext(model, i, FullEquipType.Glasses, equipment[10]), - 17 => globalContext.CreateContext(model, i, FullEquipType.Unknown, equipment[11]), - _ => globalContext.CreateContext(model, i), - }, - _ => i < equipment.Length - ? globalContext.CreateContext(model, i, i.ToEquipSlot().ToEquipType(), equipment[(int)i]) - : globalContext.CreateContext(model, i), - }; - - var imc = (ResourceHandle*)model->IMCArray[i]; - if (slotContext.CreateNodeFromImc(imc) is { } imcNode) + var imc = (ResourceHandle*)model->IMCArray[i]; + var imcNode = slotContext.CreateNodeFromImc(imc); + if (imcNode != null) { if (globalContext.WithUiData) imcNode.FallbackName = $"IMC #{i}"; Nodes.Add(imcNode); } - var mdl = model->Models[i]; - if (slotContext.CreateNodeFromModel(mdl, imc, i < decalArray.Length ? decalArray[(int)i].Value : null, - i < skinMtrlArray.Length ? skinMtrlArray[(int)i].Value : null, i < mpapArray.Length ? mpapArray[(int)i].Value : null) is - { } mdlNode) + var mdl = model->Models[i]; + var mdlNode = slotContext.CreateNodeFromModel(mdl, imc); + if (mdlNode != null) { if (globalContext.WithUiData) mdlNode.FallbackName = $"Model #{i}"; @@ -121,12 +92,11 @@ public class ResourceTree( } } - AddSkeleton(Nodes, genericContext, model); - AddMaterialAnimationSkeleton(Nodes, genericContext, model->MaterialAnimationSkeleton); + AddSkeleton(Nodes, genericContext, model->EID, model->Skeleton); AddWeapons(globalContext, model); - if (human is not null) + if (human != null) AddHumanResources(globalContext, human); } @@ -136,41 +106,37 @@ public class ResourceTree( var weaponNodes = new List(); foreach (var baseSubObject in model->DrawObject.Object.ChildObjects) { - if (baseSubObject->GetObjectType() is not FFXIVClientStructs.FFXIV.Client.Graphics.Scene.ObjectType.CharacterBase) + if (baseSubObject->GetObjectType() != FFXIVClientStructs.FFXIV.Client.Graphics.Scene.ObjectType.CharacterBase) continue; - var subObject = (CharacterBase*)baseSubObject; - if (subObject->GetModelType() is not ModelType.Weapon) + if (subObject->GetModelType() != CharacterBase.ModelType.Weapon) continue; - - var weapon = (Weapon*)subObject; + var weapon = (Weapon*)subObject; // This way to tell apart MainHand and OffHand is not always accurate, but seems good enough for what we're doing with it. - var slot = weaponIndex > 0 ? FullEquipType.UnknownOffhand : FullEquipType.UnknownMainhand; - var equipment = new CharacterArmor(weapon->ModelSetId, (byte)weapon->Variant, new StainIds(weapon->Stain0, weapon->Stain1)); + var slot = weaponIndex > 0 ? EquipSlot.OffHand : EquipSlot.MainHand; + var equipment = new CharacterArmor(weapon->ModelSetId, (byte)weapon->Variant, (byte)weapon->ModelUnknown); var weaponType = weapon->SecondaryId; var genericContext = globalContext.CreateContext(subObject, 0xFFFFFFFFu, slot, equipment, weaponType); - var mpapArrayPtr = subObject->MaterialAnimationPacks; - var mpapArray = mpapArrayPtr is not null ? new ReadOnlySpan>(mpapArrayPtr, subObject->SlotCount) : []; - for (var i = 0; i < subObject->SlotCount; ++i) { var slotContext = globalContext.CreateContext(subObject, (uint)i, slot, equipment, weaponType); - var imc = (ResourceHandle*)subObject->IMCArray[i]; - if (slotContext.CreateNodeFromImc(imc) is { } imcNode) + var imc = (ResourceHandle*)subObject->IMCArray[i]; + var imcNode = slotContext.CreateNodeFromImc(imc); + if (imcNode != null) { if (globalContext.WithUiData) imcNode.FallbackName = $"Weapon #{weaponIndex}, IMC #{i}"; weaponNodes.Add(imcNode); } - var mdl = subObject->Models[i]; - if (slotContext.CreateNodeFromModel(mdl, imc, weapon->Decal, null, i < mpapArray.Length ? mpapArray[i].Value : null) is - { } mdlNode) + var mdl = subObject->Models[i]; + var mdlNode = slotContext.CreateNodeFromModel(mdl, imc); + if (mdlNode != null) { if (globalContext.WithUiData) mdlNode.FallbackName = $"Weapon #{weaponIndex}, Model #{i}"; @@ -178,13 +144,10 @@ public class ResourceTree( } } - AddSkeleton(weaponNodes, genericContext, subObject, $"Weapon #{weaponIndex}, "); - AddMaterialAnimationSkeleton(weaponNodes, genericContext, subObject->MaterialAnimationSkeleton, - $"Weapon #{weaponIndex}, "); + AddSkeleton(weaponNodes, genericContext, subObject->EID, subObject->Skeleton, $"Weapon #{weaponIndex}, "); ++weaponIndex; } - Nodes.InsertRange(0, weaponNodes); } @@ -193,59 +156,55 @@ public class ResourceTree( var genericContext = globalContext.CreateContext(&human->CharacterBase); var cache = globalContext.Collection._cache; - if (cache is not null - && cache.CustomResources.TryGetValue(PreBoneDeformerReplacer.PreBoneDeformerPath, out var pbdHandle) - && genericContext.CreateNodeFromPbd(pbdHandle.ResourceHandle) is { } pbdNode) + if (cache != null && cache.CustomResources.TryGetValue(PreBoneDeformerReplacer.PreBoneDeformerPath, out var pbdHandle)) { - if (globalContext.WithUiData) + var pbdNode = genericContext.CreateNodeFromPbd(pbdHandle.ResourceHandle); + if (pbdNode != null) { - pbdNode = pbdNode.Clone(); - pbdNode.FallbackName = "Racial Deformer"; - pbdNode.IconFlag = ChangedItemIconFlag.Customization; + if (globalContext.WithUiData) + { + pbdNode = pbdNode.Clone(); + pbdNode.FallbackName = "Racial Deformer"; + pbdNode.Icon = ChangedItemDrawer.ChangedItemIcon.Customization; + } + Nodes.Add(pbdNode); } - - Nodes.Add(pbdNode); } var decalId = (byte)(human->Customize[(int)CustomizeIndex.Facepaint] & 0x7F); - var decalPath = decalId is not 0 - ? GamePaths.Tex.FaceDecal(decalId) - : GamePaths.Tex.Transparent; - if (genericContext.CreateNodeFromTex(human->Decal, decalPath) is { } decalNode) + var decalPath = decalId != 0 + ? GamePaths.Human.Decal.FaceDecalPath(decalId) + : GamePaths.Tex.TransparentPath; + var decalNode = genericContext.CreateNodeFromTex(human->Decal, decalPath); + if (decalNode != null) { if (globalContext.WithUiData) { - decalNode = decalNode.Clone(); + decalNode = decalNode.Clone(); decalNode.FallbackName = "Face Decal"; - decalNode.IconFlag = ChangedItemIconFlag.Customization; + decalNode.Icon = ChangedItemDrawer.ChangedItemIcon.Customization; } - Nodes.Add(decalNode); } var hasLegacyDecal = (human->Customize[(int)CustomizeIndex.FaceFeatures] & 0x80) != 0; var legacyDecalPath = hasLegacyDecal - ? GamePaths.Tex.LegacyDecal - : GamePaths.Tex.Transparent; - if (genericContext.CreateNodeFromTex(human->LegacyBodyDecal, legacyDecalPath) is { } legacyDecalNode) + ? GamePaths.Human.Decal.LegacyDecalPath + : GamePaths.Tex.TransparentPath; + var legacyDecalNode = genericContext.CreateNodeFromTex(human->LegacyBodyDecal, legacyDecalPath); + if (legacyDecalNode != null) { - legacyDecalNode.ForceProtected = !hasLegacyDecal; if (globalContext.WithUiData) { - legacyDecalNode = legacyDecalNode.Clone(); + legacyDecalNode = legacyDecalNode.Clone(); legacyDecalNode.FallbackName = "Legacy Body Decal"; - legacyDecalNode.IconFlag = ChangedItemIconFlag.Customization; + legacyDecalNode.Icon = ChangedItemDrawer.ChangedItemIcon.Customization; } - Nodes.Add(legacyDecalNode); } } - private unsafe void AddSkeleton(List nodes, ResolveContext context, CharacterBase* model, string prefix = "") - => AddSkeleton(nodes, context, model->EID, model->Skeleton, model->BonePhysicsModule, model->BoneKineDriverModule, prefix); - - private unsafe void AddSkeleton(List nodes, ResolveContext context, void* eid, Skeleton* skeleton, BonePhysicsModule* physics, - BoneKineDriverModule* kineDriver, string prefix = "") + private unsafe void AddSkeleton(List nodes, ResolveContext context, void* eid, Skeleton* skeleton, string prefix = "") { var eidNode = context.CreateNodeFromEid((ResourceHandle*)eid); if (eidNode != null) @@ -260,9 +219,8 @@ public class ResourceTree( for (var i = 0; i < skeleton->PartialSkeletonCount; ++i) { - var phybHandle = physics != null ? physics->BonePhysicsResourceHandles[i] : null; - var kdbHandle = kineDriver != null ? kineDriver->PartialSkeletonEntries[i].KineDriverResourceHandle : null; - if (context.CreateNodeFromPartialSkeleton(&skeleton->PartialSkeletons[i], phybHandle, kdbHandle, (uint)i) is { } sklbNode) + var sklbNode = context.CreateNodeFromPartialSkeleton(&skeleton->PartialSkeletons[i], (uint)i); + if (sklbNode != null) { if (context.Global.WithUiData) sklbNode.FallbackName = $"{prefix}Skeleton #{i}"; @@ -270,16 +228,4 @@ public class ResourceTree( } } } - - private unsafe void AddMaterialAnimationSkeleton(List nodes, ResolveContext context, SkeletonResourceHandle* sklbHandle, - string prefix = "") - { - var sklbNode = context.CreateNodeFromMaterialSklb(sklbHandle); - if (sklbNode is null) - return; - - if (context.Global.WithUiData) - sklbNode.FallbackName = $"{prefix}Material Animation Skeleton"; - nodes.Add(sklbNode); - } } diff --git a/Penumbra/Interop/ResourceTree/ResourceTreeApiHelper.cs b/Penumbra/Interop/ResourceTree/ResourceTreeApiHelper.cs index 48690e98..0d1e3abc 100644 --- a/Penumbra/Interop/ResourceTree/ResourceTreeApiHelper.cs +++ b/Penumbra/Interop/ResourceTree/ResourceTreeApiHelper.cs @@ -10,7 +10,7 @@ namespace Penumbra.Interop.ResourceTree; internal static class ResourceTreeApiHelper { public static Dictionary>> GetResourcePathDictionaries( - IEnumerable<(ICharacter, ResourceTree)> resourceTrees) + IEnumerable<(Character, ResourceTree)> resourceTrees) { var pathDictionaries = new Dictionary>>(4); @@ -47,7 +47,7 @@ internal static class ResourceTreeApiHelper } } - public static Dictionary GetResourcesOfType(IEnumerable<(ICharacter, ResourceTree)> resourceTrees, + public static Dictionary GetResourcesOfType(IEnumerable<(Character, ResourceTree)> resourceTrees, ResourceType type) { var resDictionaries = new Dictionary(4); @@ -67,14 +67,14 @@ internal static class ResourceTreeApiHelper continue; var fullPath = node.FullPath.ToPath(); - resDictionary.Add(node.ResourceHandle, (fullPath, node.Name ?? string.Empty, (uint)node.IconFlag.ToApiIcon())); + resDictionary.Add(node.ResourceHandle, (fullPath, node.Name ?? string.Empty, (uint)ChangedItemDrawer.ToApiIcon(node.Icon))); } } return resDictionaries; } - public static Dictionary EncapsulateResourceTrees(IEnumerable<(ICharacter, ResourceTree)> resourceTrees) + public static Dictionary EncapsulateResourceTrees(IEnumerable<(Character, ResourceTree)> resourceTrees) { var resDictionary = new Dictionary(4); foreach (var (gameObject, resourceTree) in resourceTrees) @@ -106,7 +106,7 @@ internal static class ResourceTreeApiHelper var ret = new JObject { [nameof(ResourceNodeDto.Type)] = new JValue(node.Type), - [nameof(ResourceNodeDto.Icon)] = new JValue(node.IconFlag.ToApiIcon()), + [nameof(ResourceNodeDto.Icon)] = new JValue(ChangedItemDrawer.ToApiIcon(node.Icon)), [nameof(ResourceNodeDto.Name)] = node.Name, [nameof(ResourceNodeDto.GamePath)] = node.GamePath.Equals(Utf8GamePath.Empty) ? null : node.GamePath.ToString(), [nameof(ResourceNodeDto.ActualPath)] = node.FullPath.ToString(), diff --git a/Penumbra/Interop/ResourceTree/ResourceTreeFactory.cs b/Penumbra/Interop/ResourceTree/ResourceTreeFactory.cs index 49194c3a..ae7187f0 100644 --- a/Penumbra/Interop/ResourceTree/ResourceTreeFactory.cs +++ b/Penumbra/Interop/ResourceTree/ResourceTreeFactory.cs @@ -1,15 +1,11 @@ -using Dalamud.Game.ClientState.Objects.Types; using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Game.Object; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.GameData.Actors; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Interop; using Penumbra.Interop.PathResolving; -using Penumbra.Meta; -using Penumbra.Mods.Manager; using Penumbra.String.Classes; namespace Penumbra.Interop.ResourceTree; @@ -17,41 +13,26 @@ namespace Penumbra.Interop.ResourceTree; public class ResourceTreeFactory( IDataManager gameData, ObjectManager objects, - MetaFileManager metaFileManager, CollectionResolver resolver, - ObjectIdentification objectIdentifier, + ObjectIdentification identifier, Configuration config, ActorManager actors, - PathState pathState, - IFramework framework, - ModManager modManager) : IService + PathState pathState) { - private static readonly string ParentDirectoryPrefix = $"..{Path.DirectorySeparatorChar}"; - private TreeBuildCache CreateTreeBuildCache() - => new(framework.IsInFrameworkUpdateThread ? objects : null, gameData, actors); + => new(objects, gameData, actors); - private TreeBuildCache CreateTreeBuildCache(Flags flags) - => !framework.IsInFrameworkUpdateThread && flags.HasFlag(Flags.PopulateObjectTableData) - ? framework.RunOnFrameworkThread(CreateTreeBuildCache).Result - : CreateTreeBuildCache(); + public IEnumerable GetLocalPlayerRelatedCharacters() + { + var cache = CreateTreeBuildCache(); + return cache.GetLocalPlayerRelatedCharacters(); + } - public IEnumerable GetLocalPlayerRelatedCharacters() - => framework.RunOnFrameworkThread(() => - { - var cache = CreateTreeBuildCache(); - return cache.GetLocalPlayerRelatedCharacters(); - }).Result; - - public IEnumerable<(ICharacter Character, ResourceTree ResourceTree)> FromObjectTable( + public IEnumerable<(Dalamud.Game.ClientState.Objects.Types.Character Character, ResourceTree ResourceTree)> FromObjectTable( Flags flags) { - var (cache, characters) = framework.RunOnFrameworkThread(() => - { - var cache = CreateTreeBuildCache(); - var characters = ((flags & Flags.LocalPlayerRelatedOnly) != 0 ? cache.GetLocalPlayerRelatedCharacters() : cache.GetCharacters()).ToArray(); - return (cache, characters); - }).Result; + var cache = CreateTreeBuildCache(); + var characters = (flags & Flags.LocalPlayerRelatedOnly) != 0 ? cache.GetLocalPlayerRelatedCharacters() : cache.GetCharacters(); foreach (var character in characters) { @@ -61,10 +42,10 @@ public class ResourceTreeFactory( } } - public IEnumerable<(ICharacter Character, ResourceTree ResourceTree)> FromCharacters( - IEnumerable characters, Flags flags) + public IEnumerable<(Dalamud.Game.ClientState.Objects.Types.Character Character, ResourceTree ResourceTree)> FromCharacters( + IEnumerable characters, Flags flags) { - var cache = CreateTreeBuildCache(flags); + var cache = CreateTreeBuildCache(); foreach (var character in characters) { var tree = FromCharacter(character, cache, flags); @@ -73,10 +54,10 @@ public class ResourceTreeFactory( } } - public ResourceTree? FromCharacter(ICharacter character, Flags flags) - => FromCharacter(character, CreateTreeBuildCache(flags), flags); + public ResourceTree? FromCharacter(Dalamud.Game.ClientState.Objects.Types.Character character, Flags flags) + => FromCharacter(character, CreateTreeBuildCache(), flags); - private unsafe ResourceTree? FromCharacter(ICharacter character, TreeBuildCache cache, Flags flags) + private unsafe ResourceTree? FromCharacter(Dalamud.Game.ClientState.Objects.Types.Character character, TreeBuildCache cache, Flags flags) { if (!character.IsValid()) return null; @@ -91,11 +72,11 @@ public class ResourceTreeFactory( return null; var localPlayerRelated = cache.IsLocalPlayerRelated(character); - var (name, anonymizedName, related) = GetCharacterName((GameObject*)character.Address); - var networked = character.EntityId != 0xE0000000; - var tree = new ResourceTree(name, anonymizedName, character.ObjectIndex, (nint)gameObjStruct, (nint)drawObjStruct, localPlayerRelated, related, - networked, collectionResolveData.ModCollection.Identity.Name, collectionResolveData.ModCollection.Identity.AnonymizedName); - var globalContext = new GlobalResolveContext(metaFileManager, objectIdentifier, collectionResolveData.ModCollection, + var (name, related) = GetCharacterName(character, cache); + var networked = character.ObjectId != Dalamud.Game.ClientState.Objects.Types.GameObject.InvalidGameObjectId; + var tree = new ResourceTree(name, character.ObjectIndex, (nint)gameObjStruct, (nint)drawObjStruct, localPlayerRelated, related, + networked, collectionResolveData.ModCollection.Name); + var globalContext = new GlobalResolveContext(identifier, collectionResolveData.ModCollection, cache, (flags & Flags.WithUiData) != 0); using (var _ = pathState.EnterInternalResolve()) { @@ -108,10 +89,7 @@ public class ResourceTreeFactory( // This is currently unneeded as we can resolve all paths by querying the draw object: // ResolveGamePaths(tree, collectionResolveData.ModCollection); if (globalContext.WithUiData) - { ResolveUiData(tree); - ResolveModData(tree); - } FilterFullPaths(tree, (flags & Flags.RedactExternalPaths) != 0 ? config.ModDirectory : null); Cleanup(tree); @@ -138,48 +116,33 @@ public class ResourceTreeFactory( { if (node.Name == parent?.Name) node.Name = null; - }); - } - private void ResolveModData(ResourceTree tree) - { - foreach (var node in tree.FlatNodes) - { - if (node.FullPath.IsRooted && modManager.TryIdentifyPath(node.FullPath.FullName, out var mod, out var relativePath)) - { - node.ModName = mod.Name; - node.Mod.SetTarget(mod); - node.ModRelativePath = relativePath; - } - } + if (parent != null) + parent.DescendentIcons |= node.Icon | node.DescendentIcons; + }); } private static void FilterFullPaths(ResourceTree tree, string? onlyWithinPath) { - foreach (var node in tree.FlatNodes) - { - node.FullPathStatus = GetPathStatus(node.FullPath, onlyWithinPath); - if (node.FullPathStatus != ResourceNode.PathStatus.Valid) - node.FullPath = FullPath.Empty; - } - - return; - - static ResourceNode.PathStatus GetPathStatus(FullPath fullPath, string? onlyWithinPath) + static bool ShallKeepPath(FullPath fullPath, string? onlyWithinPath) { if (!fullPath.IsRooted) - return ResourceNode.PathStatus.Valid; + return true; if (onlyWithinPath != null) { var relPath = Path.GetRelativePath(onlyWithinPath, fullPath.FullName); - if (relPath == ".." || relPath.StartsWith(ParentDirectoryPrefix) || Path.IsPathRooted(relPath)) - return ResourceNode.PathStatus.External; + if (relPath != "." && (relPath.StartsWith('.') || Path.IsPathRooted(relPath))) + return false; } - return fullPath.Exists - ? ResourceNode.PathStatus.Valid - : ResourceNode.PathStatus.NonExistent; + return fullPath.Exists; + } + + foreach (var node in tree.FlatNodes) + { + if (!ShallKeepPath(node.FullPath, onlyWithinPath)) + node.FullPath = FullPath.Empty; } } @@ -194,37 +157,33 @@ public class ResourceTreeFactory( } } - private unsafe (string Name, string AnonymizedName, bool PlayerRelated) GetCharacterName(GameObject* character) + private unsafe (string Name, bool PlayerRelated) GetCharacterName(Dalamud.Game.ClientState.Objects.Types.Character character, + TreeBuildCache cache) { - var identifier = actors.FromObject(character, out var owner, true, false, false); - var identifierStr = identifier.ToString(); - return (identifierStr, identifier.Incognito(identifierStr), IsPlayerRelated(identifier, owner)); - } - - private unsafe bool IsPlayerRelated(GameObject* character) - { - if (character is null) - return false; - - var identifier = actors.FromObject(character, out var owner, true, false, false); - return IsPlayerRelated(identifier, owner); - } - - private unsafe bool IsPlayerRelated(ActorIdentifier identifier, Actor owner) - => identifier.Type switch + var identifier = actors.FromObject((GameObject*)character.Address, out var owner, true, false, false); + switch (identifier.Type) { - IdentifierType.Player => true, - IdentifierType.Owned => IsPlayerRelated(owner.AsObject), - _ => false, - }; + case IdentifierType.Player: return (identifier.PlayerName.ToString(), true); + case IdentifierType.Owned: + var ownerChara = objects.Objects.CreateObjectReference(owner) as Dalamud.Game.ClientState.Objects.Types.Character; + if (ownerChara != null) + { + var ownerName = GetCharacterName(ownerChara, cache); + return ($"[{ownerName.Name}] {character.Name} ({identifier.Kind.ToName()})", ownerName.PlayerRelated); + } + + break; + } + + return ($"{character.Name} ({identifier.Kind.ToName()})", false); + } [Flags] public enum Flags { - RedactExternalPaths = 1, - WithUiData = 2, - LocalPlayerRelatedOnly = 4, - WithOwnership = 8, - PopulateObjectTableData = 16, + RedactExternalPaths = 1, + WithUiData = 2, + LocalPlayerRelatedOnly = 4, + WithOwnership = 8, } } diff --git a/Penumbra/Interop/ResourceTree/TreeBuildCache.cs b/Penumbra/Interop/ResourceTree/TreeBuildCache.cs index c0114412..2798002a 100644 --- a/Penumbra/Interop/ResourceTree/TreeBuildCache.cs +++ b/Penumbra/Interop/ResourceTree/TreeBuildCache.cs @@ -1,26 +1,22 @@ -using System.IO.MemoryMappedFiles; using Dalamud.Game.ClientState.Objects.Types; using Dalamud.Plugin.Services; using Penumbra.GameData.Actors; using Penumbra.GameData.Enums; using Penumbra.GameData.Files; -using Penumbra.GameData.Files.ShaderStructs; -using Penumbra.GameData.Files.Utility; using Penumbra.GameData.Interop; using Penumbra.GameData.Structs; using Penumbra.String.Classes; namespace Penumbra.Interop.ResourceTree; -internal readonly struct TreeBuildCache(ObjectManager? objects, IDataManager dataManager, ActorManager actors) +internal readonly struct TreeBuildCache(ObjectManager objects, IDataManager dataManager, ActorManager actors) { - private readonly Dictionary?> _shaderPackageNames = []; + private readonly Dictionary _shaderPackages = []; - private readonly IGameObject? _player = objects?.GetDalamudObject(0); - - public unsafe bool IsLocalPlayerRelated(ICharacter character) + public unsafe bool IsLocalPlayerRelated(Character character) { - if (_player is null) + var player = objects.GetDalamudObject(0); + if (player == null) return false; var gameObject = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)character.Address; @@ -29,35 +25,36 @@ internal readonly struct TreeBuildCache(ObjectManager? objects, IDataManager dat return actualIndex switch { < 2 => true, - < (int)ScreenActor.CutsceneStart => gameObject->OwnerId == _player.EntityId, + < (int)ScreenActor.CutsceneStart => gameObject->OwnerID == player.ObjectId, _ => false, }; } - public IEnumerable GetCharacters() - => objects is not null ? objects.Objects.OfType() : []; + public IEnumerable GetCharacters() + => objects.Objects.OfType(); - public IEnumerable GetLocalPlayerRelatedCharacters() + public IEnumerable GetLocalPlayerRelatedCharacters() { - if (_player is null) + var player = objects.GetDalamudObject(0); + if (player == null) yield break; - yield return (ICharacter)_player; + yield return (Character)player; - var minion = objects!.GetDalamudObject(1); - if (minion is not null) - yield return (ICharacter)minion; + var minion = objects.GetDalamudObject(1); + if (minion != null) + yield return (Character)minion; - var playerId = _player.EntityId; + var playerId = player.ObjectId; for (var i = 2; i < ObjectIndex.CutsceneStart.Index; i += 2) { - if (objects.GetDalamudObject(i) is ICharacter owned && owned.OwnerId == playerId) + if (objects.GetDalamudObject(i) is Character owned && owned.OwnerId == playerId) yield return owned; } for (var i = ObjectIndex.CutsceneStart.Index; i < ObjectIndex.CharacterScreen.Index; ++i) { - var character = objects.GetDalamudObject((int) i) as ICharacter; + var character = objects.GetDalamudObject((int) i) as Character; if (character == null) continue; @@ -71,10 +68,10 @@ internal readonly struct TreeBuildCache(ObjectManager? objects, IDataManager dat } /// Try to read a shpk file from the given path and cache it on success. - public IReadOnlyDictionary? ReadShaderPackageNames(FullPath path) - => ReadFile(dataManager, path, _shaderPackageNames, bytes => ShpkFile.FastExtractNames(bytes.Span)); + public ShpkFile? ReadShaderPackage(FullPath path) + => ReadFile(dataManager, path, _shaderPackages, bytes => new ShpkFile(bytes)); - private static T? ReadFile(IDataManager dataManager, FullPath path, Dictionary cache, Func, T> parseFile) + private static T? ReadFile(IDataManager dataManager, FullPath path, Dictionary cache, Func parseFile) where T : class { if (path.FullName.Length == 0) @@ -89,8 +86,7 @@ internal readonly struct TreeBuildCache(ObjectManager? objects, IDataManager dat { if (path.IsRooted) { - using var mmFile = MmioMemoryManager.CreateFromFile(pathStr, access: MemoryMappedFileAccess.Read); - parsed = parseFile(mmFile.Memory); + parsed = parseFile(File.ReadAllBytes(pathStr)); } else { diff --git a/Penumbra/Interop/Services/CharacterUtility.cs b/Penumbra/Interop/Services/CharacterUtility.cs index 0add9d46..da04bf90 100644 --- a/Penumbra/Interop/Services/CharacterUtility.cs +++ b/Penumbra/Interop/Services/CharacterUtility.cs @@ -1,13 +1,12 @@ using Dalamud.Plugin.Services; using Dalamud.Utility.Signatures; -using OtterGui.Services; -using Penumbra.Communication; +using Penumbra.Collections.Manager; using Penumbra.GameData; using Penumbra.Interop.Structs; namespace Penumbra.Interop.Services; -public unsafe class CharacterUtility : IDisposable, IRequiredService +public unsafe class CharacterUtility : IDisposable { public record struct InternalIndex(int Value); @@ -27,16 +26,12 @@ public unsafe class CharacterUtility : IDisposable, IRequiredService public CharacterUtilityData* Address => *_characterUtilityAddress; - public bool Ready { get; private set; } - - public readonly CharacterUtilityFinished LoadingFinished = new(); - - public nint DefaultHumanPbdResource { get; private set; } - public nint DefaultTransparentResource { get; private set; } - public nint DefaultDecalResource { get; private set; } - public nint DefaultSkinShpkResource { get; private set; } - public nint DefaultCharacterStockingsShpkResource { get; private set; } - public nint DefaultCharacterLegacyShpkResource { get; private set; } + public bool Ready { get; private set; } + public event Action LoadingFinished; + public nint DefaultHumanPbdResource { get; private set; } + public nint DefaultTransparentResource { get; private set; } + public nint DefaultDecalResource { get; private set; } + public nint DefaultSkinShpkResource { get; private set; } /// /// The relevant indices depend on which meta manipulations we allow for. @@ -52,25 +47,30 @@ public unsafe class CharacterUtility : IDisposable, IRequiredService private readonly MetaList[] _lists; + public IReadOnlyList Lists + => _lists; + public (nint Address, int Size) DefaultResource(InternalIndex idx) => _lists[idx.Value].DefaultResource; - private readonly IFramework _framework; + private readonly IFramework _framework; + public readonly ActiveCollectionData Active; - public CharacterUtility(IFramework framework, IGameInteropProvider interop) + public CharacterUtility(IFramework framework, IGameInteropProvider interop, ActiveCollectionData active) { interop.InitializeFromAttributes(this); _lists = Enumerable.Range(0, RelevantIndices.Length) - .Select(idx => new MetaList(new InternalIndex(idx))) + .Select(idx => new MetaList(this, new InternalIndex(idx))) .ToArray(); _framework = framework; - LoadingFinished.Subscribe(() => Penumbra.Log.Debug("Loading of CharacterUtility finished."), CharacterUtilityFinished.Priority.OnFinishedLoading); + Active = active; + LoadingFinished += () => Penumbra.Log.Debug("Loading of CharacterUtility finished."); LoadDefaultResources(null!); if (!Ready) _framework.Update += LoadDefaultResources; } - /// We store the default data of the resources, so we can always restore them. + /// We store the default data of the resources so we can always restore them. private void LoadDefaultResources(object _) { if (Address == null) @@ -113,18 +113,6 @@ public unsafe class CharacterUtility : IDisposable, IRequiredService anyMissing |= DefaultSkinShpkResource == nint.Zero; } - if (DefaultCharacterStockingsShpkResource == nint.Zero) - { - DefaultCharacterStockingsShpkResource = (nint)Address->CharacterStockingsShpkResource; - anyMissing |= DefaultCharacterStockingsShpkResource == nint.Zero; - } - - if (DefaultCharacterLegacyShpkResource == nint.Zero) - { - DefaultCharacterLegacyShpkResource = (nint)Address->CharacterLegacyShpkResource; - anyMissing |= DefaultCharacterLegacyShpkResource == nint.Zero; - } - if (anyMissing) return; @@ -133,18 +121,47 @@ public unsafe class CharacterUtility : IDisposable, IRequiredService LoadingFinished.Invoke(); } + public void SetResource(MetaIndex resourceIdx, nint data, int length) + { + var idx = ReverseIndices[(int)resourceIdx]; + var list = _lists[idx.Value]; + list.SetResource(data, length); + } + + public void ResetResource(MetaIndex resourceIdx) + { + var idx = ReverseIndices[(int)resourceIdx]; + var list = _lists[idx.Value]; + list.ResetResource(); + } + + public MetaList.MetaReverter TemporarilySetResource(MetaIndex resourceIdx, nint data, int length) + { + var idx = ReverseIndices[(int)resourceIdx]; + var list = _lists[idx.Value]; + return list.TemporarilySetResource(data, length); + } + + public MetaList.MetaReverter TemporarilyResetResource(MetaIndex resourceIdx) + { + var idx = ReverseIndices[(int)resourceIdx]; + var list = _lists[idx.Value]; + return list.TemporarilyResetResource(); + } + /// Return all relevant resources to the default resource. public void ResetAll() { if (!Ready) return; - Address->HumanPbdResource = (ResourceHandle*)DefaultHumanPbdResource; - Address->TransparentTexResource = (TextureResourceHandle*)DefaultTransparentResource; - Address->DecalTexResource = (TextureResourceHandle*)DefaultDecalResource; - Address->SkinShpkResource = (ResourceHandle*)DefaultSkinShpkResource; - Address->CharacterStockingsShpkResource = (ResourceHandle*)DefaultCharacterStockingsShpkResource; - Address->CharacterLegacyShpkResource = (ResourceHandle*)DefaultCharacterLegacyShpkResource; + foreach (var list in _lists) + list.Dispose(); + + Address->HumanPbdResource = (ResourceHandle*)DefaultHumanPbdResource; + Address->TransparentTexResource = (TextureResourceHandle*)DefaultTransparentResource; + Address->DecalTexResource = (TextureResourceHandle*)DefaultDecalResource; + Address->SkinShpkResource = (ResourceHandle*)DefaultSkinShpkResource; } public void Dispose() diff --git a/Penumbra/Interop/Services/DecalReverter.cs b/Penumbra/Interop/Services/DecalReverter.cs index 3d5d7845..17d8d2e0 100644 --- a/Penumbra/Interop/Services/DecalReverter.cs +++ b/Penumbra/Interop/Services/DecalReverter.cs @@ -1,8 +1,7 @@ using FFXIVClientStructs.FFXIV.Client.System.Resource; using Penumbra.Api.Enums; using Penumbra.Collections; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.String; +using Penumbra.Interop.ResourceLoading; using Penumbra.String.Classes; namespace Penumbra.Interop.Services; @@ -10,10 +9,10 @@ namespace Penumbra.Interop.Services; public sealed unsafe class DecalReverter : IDisposable { public static readonly Utf8GamePath DecalPath = - Utf8GamePath.FromSpan("chara/common/texture/decal_equip/_stigma.tex"u8, MetaDataComputation.All, out var p) ? p : Utf8GamePath.Empty; + Utf8GamePath.FromSpan("chara/common/texture/decal_equip/_stigma.tex"u8, out var p) ? p : Utf8GamePath.Empty; public static readonly Utf8GamePath TransparentPath = - Utf8GamePath.FromSpan("chara/common/texture/transparent.tex"u8, MetaDataComputation.All, out var p) ? p : Utf8GamePath.Empty; + Utf8GamePath.FromSpan("chara/common/texture/transparent.tex"u8, out var p) ? p : Utf8GamePath.Empty; private readonly CharacterUtility _utility; private readonly Structs.TextureResourceHandle* _decal; diff --git a/Penumbra/Interop/Services/FontReloader.cs b/Penumbra/Interop/Services/FontReloader.cs index 3a2c7022..2f4a3cfd 100644 --- a/Penumbra/Interop/Services/FontReloader.cs +++ b/Penumbra/Interop/Services/FontReloader.cs @@ -1,7 +1,6 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.System.Framework; using FFXIVClientStructs.FFXIV.Component.GUI; -using OtterGui.Services; using Penumbra.GameData; namespace Penumbra.Interop.Services; @@ -10,7 +9,7 @@ namespace Penumbra.Interop.Services; /// Handle font reloading via game functions. /// May cause a interface flicker while reloading. /// -public unsafe class FontReloader : IService +public unsafe class FontReloader { public bool Valid => _reloadFontsFunc != null; @@ -34,7 +33,7 @@ public unsafe class FontReloader : IService if (framework == null) return; - var uiModule = framework->GetUIModule(); + var uiModule = framework->GetUiModule(); if (uiModule == null) return; @@ -43,7 +42,7 @@ public unsafe class FontReloader : IService return; _atkModule = &atkModule->AtkModule; - _reloadFontsFunc = ((delegate* unmanaged*)_atkModule->VirtualTable)[VolatileOffsets.FontReloader.ReloadFontsVFunc]; + _reloadFontsFunc = ((delegate* unmanaged*)_atkModule->vtbl)[Offsets.ReloadFontsVfunc]; }); } } diff --git a/Penumbra/Interop/Services/MetaList.cs b/Penumbra/Interop/Services/MetaList.cs index 839c289e..e956040b 100644 --- a/Penumbra/Interop/Services/MetaList.cs +++ b/Penumbra/Interop/Services/MetaList.cs @@ -2,14 +2,26 @@ using Penumbra.Interop.Structs; namespace Penumbra.Interop.Services; -public class MetaList(CharacterUtility.InternalIndex index) +public unsafe class MetaList : IDisposable { - public readonly CharacterUtility.InternalIndex Index = index; - public readonly MetaIndex GlobalMetaIndex = CharacterUtility.RelevantIndices[index.Value]; + private readonly CharacterUtility _utility; + private readonly LinkedList _entries = new(); + public readonly CharacterUtility.InternalIndex Index; + public readonly MetaIndex GlobalMetaIndex; + + public IReadOnlyCollection Entries + => _entries; private nint _defaultResourceData = nint.Zero; - private int _defaultResourceSize; - public bool Ready { get; private set; } + private int _defaultResourceSize = 0; + public bool Ready { get; private set; } = false; + + public MetaList(CharacterUtility utility, CharacterUtility.InternalIndex index) + { + _utility = utility; + Index = index; + GlobalMetaIndex = CharacterUtility.RelevantIndices[index.Value]; + } public void SetDefaultResource(nint data, int size) { @@ -19,8 +31,127 @@ public class MetaList(CharacterUtility.InternalIndex index) _defaultResourceData = data; _defaultResourceSize = size; Ready = _defaultResourceData != nint.Zero && size != 0; + if (_entries.Count <= 0) + return; + + var first = _entries.First!.Value; + SetResource(first.Data, first.Length); } public (nint Address, int Size) DefaultResource => (_defaultResourceData, _defaultResourceSize); + + public MetaReverter TemporarilySetResource(nint data, int length) + { + Penumbra.Log.Excessive($"Temporarily set resource {GlobalMetaIndex} to 0x{(ulong)data:X} ({length} bytes)."); + var reverter = new MetaReverter(this, data, length); + _entries.AddFirst(reverter); + SetResourceInternal(data, length); + return reverter; + } + + public MetaReverter TemporarilyResetResource() + { + Penumbra.Log.Excessive( + $"Temporarily reset resource {GlobalMetaIndex} to default at 0x{_defaultResourceData:X} ({_defaultResourceSize} bytes)."); + var reverter = new MetaReverter(this); + _entries.AddFirst(reverter); + ResetResourceInternal(); + return reverter; + } + + public void SetResource(nint data, int length) + { + Penumbra.Log.Excessive($"Set resource {GlobalMetaIndex} to 0x{(ulong)data:X} ({length} bytes)."); + SetResourceInternal(data, length); + } + + public void ResetResource() + { + Penumbra.Log.Excessive($"Reset resource {GlobalMetaIndex} to default at 0x{_defaultResourceData:X} ({_defaultResourceSize} bytes)."); + ResetResourceInternal(); + } + + /// Set the currently stored data of this resource to new values. + private void SetResourceInternal(nint data, int length) + { + if (!Ready) + return; + + var resource = _utility.Address->Resource(GlobalMetaIndex); + resource->SetData(data, length); + } + + /// Reset the currently stored data of this resource to its default values. + private void ResetResourceInternal() + => SetResourceInternal(_defaultResourceData, _defaultResourceSize); + + private void SetResourceToDefaultCollection() + => _utility.Active.Default.SetMetaFile(_utility, GlobalMetaIndex); + + public void Dispose() + { + if (_entries.Count > 0) + { + foreach (var entry in _entries) + entry.Disposed = true; + + _entries.Clear(); + } + + ResetResourceInternal(); + } + + public sealed class MetaReverter : IDisposable + { + public static readonly MetaReverter Disabled = new(null!) { Disposed = true }; + + public readonly MetaList MetaList; + public readonly nint Data; + public readonly int Length; + public readonly bool Resetter; + public bool Disposed; + + public MetaReverter(MetaList metaList, nint data, int length) + { + MetaList = metaList; + Data = data; + Length = length; + } + + public MetaReverter(MetaList metaList) + { + MetaList = metaList; + Data = nint.Zero; + Length = 0; + Resetter = true; + } + + public void Dispose() + { + if (Disposed) + return; + + var list = MetaList._entries; + var wasCurrent = ReferenceEquals(this, list.First?.Value); + list.Remove(this); + if (!wasCurrent) + return; + + if (list.Count == 0) + { + MetaList.SetResourceToDefaultCollection(); + } + else + { + var next = list.First!.Value; + if (next.Resetter) + MetaList.ResetResourceInternal(); + else + MetaList.SetResourceInternal(next.Data, next.Length); + } + + Disposed = true; + } + } } diff --git a/Penumbra/Interop/Services/ModelRenderer.cs b/Penumbra/Interop/Services/ModelRenderer.cs index 5e2cd1fb..7df83cf7 100644 --- a/Penumbra/Interop/Services/ModelRenderer.cs +++ b/Penumbra/Interop/Services/ModelRenderer.cs @@ -1,76 +1,22 @@ using Dalamud.Plugin.Services; using FFXIVClientStructs.FFXIV.Client.Graphics.Render; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; -using OtterGui.Services; -using ModelRendererData = FFXIVClientStructs.FFXIV.Client.Graphics.Render.ModelRenderer; namespace Penumbra.Interop.Services; -public unsafe class ModelRenderer : IDisposable, IRequiredService +public unsafe class ModelRenderer : IDisposable { public bool Ready { get; private set; } - public ModelRendererData* Address + public ShaderPackageResourceHandle** CharacterGlassShaderPackage => Manager.Instance() switch { null => null, - var renderManager => &renderManager->ModelRenderer, + var renderManager => &renderManager->ModelRenderer.CharacterGlassShaderPackage, }; - public ShaderPackageResourceHandle** IrisShaderPackage - => Address switch - { - null => null, - var data => &data->IrisShaderPackage, - }; - - public ShaderPackageResourceHandle** CharacterGlassShaderPackage - => Address switch - { - null => null, - var data => &data->CharacterGlassShaderPackage, - }; - - public ShaderPackageResourceHandle** CharacterTransparencyShaderPackage - => Address switch - { - null => null, - var data => &data->CharacterTransparencyShaderPackage, - }; - - public ShaderPackageResourceHandle** CharacterTattooShaderPackage - => Address switch - { - null => null, - var data => &data->CharacterTattooShaderPackage, - }; - - public ShaderPackageResourceHandle** CharacterOcclusionShaderPackage - => Address switch - { - null => null, - var data => &data->CharacterOcclusionShaderPackage, - }; - - public ShaderPackageResourceHandle** HairMaskShaderPackage - => Address switch - { - null => null, - var data => &data->HairMaskShaderPackage, - }; - - public ShaderPackageResourceHandle* DefaultIrisShaderPackage { get; private set; } - public ShaderPackageResourceHandle* DefaultCharacterGlassShaderPackage { get; private set; } - public ShaderPackageResourceHandle* DefaultCharacterTransparencyShaderPackage { get; private set; } - - public ShaderPackageResourceHandle* DefaultCharacterTattooShaderPackage { get; private set; } - - public ShaderPackageResourceHandle* DefaultCharacterOcclusionShaderPackage { get; private set; } - - public ShaderPackageResourceHandle* DefaultHairMaskShaderPackage { get; private set; } - private readonly IFramework _framework; public ModelRenderer(IFramework framework) @@ -89,46 +35,16 @@ public unsafe class ModelRenderer : IDisposable, IRequiredService var anyMissing = false; - if (DefaultIrisShaderPackage == null) - { - DefaultIrisShaderPackage = *IrisShaderPackage; - anyMissing |= DefaultIrisShaderPackage == null; - } - if (DefaultCharacterGlassShaderPackage == null) { - DefaultCharacterGlassShaderPackage = *CharacterGlassShaderPackage; - anyMissing |= DefaultCharacterGlassShaderPackage == null; - } - - if (DefaultCharacterTransparencyShaderPackage == null) - { - DefaultCharacterTransparencyShaderPackage = *CharacterTransparencyShaderPackage; - anyMissing |= DefaultCharacterTransparencyShaderPackage == null; - } - - if (DefaultCharacterTattooShaderPackage == null) - { - DefaultCharacterTattooShaderPackage = *CharacterTattooShaderPackage; - anyMissing |= DefaultCharacterTattooShaderPackage == null; - } - - if (DefaultCharacterOcclusionShaderPackage == null) - { - DefaultCharacterOcclusionShaderPackage = *CharacterOcclusionShaderPackage; - anyMissing |= DefaultCharacterOcclusionShaderPackage == null; - } - - if (DefaultHairMaskShaderPackage == null) - { - DefaultHairMaskShaderPackage = *HairMaskShaderPackage; - anyMissing |= DefaultHairMaskShaderPackage == null; + DefaultCharacterGlassShaderPackage = *CharacterGlassShaderPackage; + anyMissing |= DefaultCharacterGlassShaderPackage == null; } if (anyMissing) return; - Ready = true; + Ready = true; _framework.Update -= LoadDefaultResources; } @@ -138,12 +54,7 @@ public unsafe class ModelRenderer : IDisposable, IRequiredService if (!Ready) return; - *HairMaskShaderPackage = DefaultHairMaskShaderPackage; - *CharacterOcclusionShaderPackage = DefaultCharacterOcclusionShaderPackage; - *CharacterTattooShaderPackage = DefaultCharacterTattooShaderPackage; - *CharacterTransparencyShaderPackage = DefaultCharacterTransparencyShaderPackage; - *CharacterGlassShaderPackage = DefaultCharacterGlassShaderPackage; - *IrisShaderPackage = DefaultIrisShaderPackage; + *CharacterGlassShaderPackage = DefaultCharacterGlassShaderPackage; } public void Dispose() diff --git a/Penumbra/Interop/Hooks/PostProcessing/PreBoneDeformerReplacer.cs b/Penumbra/Interop/Services/PreBoneDeformerReplacer.cs similarity index 54% rename from Penumbra/Interop/Hooks/PostProcessing/PreBoneDeformerReplacer.cs rename to Penumbra/Interop/Services/PreBoneDeformerReplacer.cs index 51af5813..9f553257 100644 --- a/Penumbra/Interop/Hooks/PostProcessing/PreBoneDeformerReplacer.cs +++ b/Penumbra/Interop/Services/PreBoneDeformerReplacer.cs @@ -4,48 +4,48 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using FFXIVClientStructs.FFXIV.Client.System.Resource; using OtterGui.Services; using Penumbra.Api.Enums; -using Penumbra.Interop.Hooks.ResourceLoading; using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.SafeHandles; -using Penumbra.String; using Penumbra.String.Classes; -using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; -namespace Penumbra.Interop.Hooks.PostProcessing; +namespace Penumbra.Interop.Services; public sealed unsafe class PreBoneDeformerReplacer : IDisposable, IRequiredService { public static readonly Utf8GamePath PreBoneDeformerPath = - Utf8GamePath.FromSpan("chara/xls/boneDeformer/human.pbd"u8, MetaDataComputation.All, out var p) ? p : Utf8GamePath.Empty; + Utf8GamePath.FromSpan("chara/xls/boneDeformer/human.pbd"u8, out var p) ? p : Utf8GamePath.Empty; - // Approximate name guess. + // Approximate name guesses. + private delegate void CharacterBaseSetupScalingDelegate(CharacterBase* drawObject, uint slotIndex); private delegate void* CharacterBaseCreateDeformerDelegate(CharacterBase* drawObject, uint slotIndex); + private readonly Hook _humanSetupScalingHook; private readonly Hook _humanCreateDeformerHook; - private readonly CharacterUtility _utility; - private readonly CollectionResolver _collectionResolver; - private readonly ResourceLoader _resourceLoader; - private readonly IFramework _framework; - private readonly HumanSetupScalingHook _humanSetupScalingHook; + private readonly CharacterUtility _utility; + private readonly CollectionResolver _collectionResolver; + private readonly ResourceLoader _resourceLoader; + private readonly IFramework _framework; public PreBoneDeformerReplacer(CharacterUtility utility, CollectionResolver collectionResolver, ResourceLoader resourceLoader, - HookManager hooks, IFramework framework, CharacterBaseVTables vTables, HumanSetupScalingHook humanSetupScalingHook) + IGameInteropProvider interop, IFramework framework, CharacterBaseVTables vTables) { - _utility = utility; - _collectionResolver = collectionResolver; - _resourceLoader = resourceLoader; - _framework = framework; - _humanSetupScalingHook = humanSetupScalingHook; - _humanSetupScalingHook.SetupReplacements += SetupHssReplacements; - _humanCreateDeformerHook = hooks.CreateHook("HumanCreateDeformer", vTables.HumanVTable[101], - CreateDeformer, !HookOverrides.Instance.PostProcessing.HumanCreateDeformer).Result; + interop.InitializeFromAttributes(this); + _utility = utility; + _collectionResolver = collectionResolver; + _resourceLoader = resourceLoader; + _framework = framework; + _humanSetupScalingHook = interop.HookFromAddress(vTables.HumanVTable[57], SetupScaling); + _humanCreateDeformerHook = interop.HookFromAddress(vTables.HumanVTable[91], CreateDeformer); + _humanSetupScalingHook.Enable(); + _humanCreateDeformerHook.Enable(); } public void Dispose() { _humanCreateDeformerHook.Dispose(); - _humanSetupScalingHook.SetupReplacements -= SetupHssReplacements; + _humanSetupScalingHook.Dispose(); } private SafeResourceHandle GetPreBoneDeformerForCharacter(CharacterBase* drawObject) @@ -57,25 +57,22 @@ public sealed unsafe class PreBoneDeformerReplacer : IDisposable, IRequiredServi return cache.CustomResources.Get(ResourceCategory.Chara, ResourceType.Pbd, PreBoneDeformerPath, resolveData); } - private void SetupHssReplacements(CharacterBase* drawObject, uint slotIndex, Span replacements, - ref int numReplacements, ref IDisposable? pbdDisposable, ref object? shpkLock) + private void SetupScaling(CharacterBase* drawObject, uint slotIndex) { if (!_framework.IsInFrameworkUpdateThread) Penumbra.Log.Warning( - $"{nameof(PreBoneDeformerReplacer)}.{nameof(SetupHssReplacements)}(0x{(nint)drawObject:X}, {slotIndex}) called out of framework thread"); - - var preBoneDeformer = GetPreBoneDeformerForCharacter(drawObject); + $"{nameof(PreBoneDeformerReplacer)}.{nameof(SetupScaling)}(0x{(nint)drawObject:X}, {slotIndex}) called out of framework thread"); + + using var preBoneDeformer = GetPreBoneDeformerForCharacter(drawObject); try { - pbdDisposable = preBoneDeformer; - replacements[numReplacements++] = new HumanSetupScalingHook.Replacement((nint)(&_utility.Address->HumanPbdResource), - (nint)preBoneDeformer.ResourceHandle, - _utility.DefaultHumanPbdResource); + if (!preBoneDeformer.IsInvalid) + _utility.Address->HumanPbdResource = (Structs.ResourceHandle*)preBoneDeformer.ResourceHandle; + _humanSetupScalingHook.Original(drawObject, slotIndex); } - catch + finally { - preBoneDeformer.Dispose(); - throw; + _utility.Address->HumanPbdResource = (Structs.ResourceHandle*)_utility.DefaultHumanPbdResource; } } diff --git a/Penumbra/Interop/Services/RedrawService.cs b/Penumbra/Interop/Services/RedrawService.cs index 2d741277..21ecfd4f 100644 --- a/Penumbra/Interop/Services/RedrawService.cs +++ b/Penumbra/Interop/Services/RedrawService.cs @@ -4,12 +4,12 @@ using Dalamud.Game.ClientState.Objects.Enums; using Dalamud.Game.ClientState.Objects.SubKinds; using Dalamud.Game.ClientState.Objects.Types; using Dalamud.Plugin.Services; -using FFXIVClientStructs.FFXIV.Client.Game; -using FFXIVClientStructs.FFXIV.Client.Game.Character; -using OtterGui.Services; +using FFXIVClientStructs.FFXIV.Client.Game.Housing; +using FFXIVClientStructs.Interop; using Penumbra.Api; using Penumbra.Api.Enums; using Penumbra.Communication; +using Penumbra.GameData; using Penumbra.GameData.Enums; using Penumbra.GameData.Interop; using Penumbra.Interop.Structs; @@ -20,7 +20,7 @@ using Character = FFXIVClientStructs.FFXIV.Client.Game.Character.Character; namespace Penumbra.Interop.Services; -public unsafe partial class RedrawService : IService +public unsafe partial class RedrawService { public const int GPosePlayerIdx = 201; public const int GPoseSlots = 42; @@ -36,11 +36,11 @@ public unsafe partial class RedrawService : IService => _clientState.IsGPosing; // VFuncs that disable and enable draw, used only for GPose actors. - private static void DisableDraw(IGameObject actor) - => ((delegate* unmanaged**)actor.Address)[0][VolatileOffsets.RedrawService.DisableDrawVFunc](actor.Address); + private static void DisableDraw(GameObject actor) + => ((delegate* unmanaged< IntPtr, void >**)actor.Address)[0][Offsets.DisableDrawVfunc](actor.Address); - private static void EnableDraw(IGameObject actor) - => ((delegate* unmanaged**)actor.Address)[0][VolatileOffsets.RedrawService.EnableDrawVFunc](actor.Address); + private static void EnableDraw(GameObject actor) + => ((delegate* unmanaged< IntPtr, void >**)actor.Address)[0][Offsets.EnableDrawVfunc](actor.Address); // Check whether we currently are in GPose. // Also clear the name list. @@ -56,7 +56,7 @@ public unsafe partial class RedrawService : IService // obj will be the object itself (or null) and false will be returned. // If we are in GPose and a game object with the same name as the original actor is found, // this will be in obj and true will be returned. - private bool FindCorrectActor(int idx, out IGameObject? obj) + private bool FindCorrectActor(int idx, out GameObject? obj) { obj = _objects.GetDalamudObject(idx); if (!InGPose || obj == null || IsGPoseActor(idx)) @@ -90,11 +90,11 @@ public unsafe partial class RedrawService : IService } } - return false; + return obj; } // Do not ever redraw any of the five UI Window actors. - private static bool BadRedrawIndices(IGameObject? actor, out int tableIndex) + private static bool BadRedrawIndices(GameObject? actor, out int tableIndex) { if (actor == null) { @@ -154,13 +154,13 @@ public sealed unsafe partial class RedrawService : IDisposable _communicator.ModFileChanged.Unsubscribe(OnModFileChanged); } - public static DrawState* ActorDrawState(IGameObject actor) + public static DrawState* ActorDrawState(GameObject actor) => (DrawState*)(&((FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actor.Address)->RenderFlags); - private static int ObjectTableIndex(IGameObject actor) + private static int ObjectTableIndex(GameObject actor) => ((FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actor.Address)->ObjectIndex; - private void WriteInvisible(IGameObject? actor) + private void WriteInvisible(GameObject? actor) { if (BadRedrawIndices(actor, out var tableIndex)) return; @@ -171,8 +171,7 @@ public sealed unsafe partial class RedrawService : IDisposable if (gPose) DisableDraw(actor!); - if (actor is IPlayerCharacter - && _objects.GetDalamudObject(tableIndex + 1) is { ObjectKind: ObjectKind.MountType or ObjectKind.Ornament } mountOrOrnament) + if (actor is PlayerCharacter && _objects.GetDalamudObject(tableIndex + 1) is { ObjectKind: ObjectKind.MountType or ObjectKind.Ornament } mountOrOrnament) { *ActorDrawState(mountOrOrnament) |= DrawState.Invisibility; if (gPose) @@ -180,7 +179,7 @@ public sealed unsafe partial class RedrawService : IDisposable } } - private void WriteVisible(IGameObject? actor) + private void WriteVisible(GameObject? actor) { if (BadRedrawIndices(actor, out var tableIndex)) return; @@ -191,8 +190,7 @@ public sealed unsafe partial class RedrawService : IDisposable if (gPose) EnableDraw(actor!); - if (actor is IPlayerCharacter - && _objects.GetDalamudObject(tableIndex + 1) is { ObjectKind: ObjectKind.MountType or ObjectKind.Ornament } mountOrOrnament) + if (actor is PlayerCharacter && _objects.GetDalamudObject(tableIndex + 1) is { ObjectKind: ObjectKind.MountType or ObjectKind.Ornament } mountOrOrnament) { *ActorDrawState(mountOrOrnament) &= ~DrawState.Invisibility; if (gPose) @@ -202,7 +200,7 @@ public sealed unsafe partial class RedrawService : IDisposable GameObjectRedrawn?.Invoke(actor!.Address, tableIndex); } - private void ReloadActor(IGameObject? actor) + private void ReloadActor(GameObject? actor) { if (BadRedrawIndices(actor, out var tableIndex)) return; @@ -213,7 +211,7 @@ public sealed unsafe partial class RedrawService : IDisposable _queue.Add(~tableIndex); } - private void ReloadActorAfterGPose(IGameObject? actor) + private void ReloadActorAfterGPose(GameObject? actor) { if (_objects[GPosePlayerIdx].Valid) { @@ -283,31 +281,26 @@ public sealed unsafe partial class RedrawService : IDisposable _queue.RemoveRange(numKept, _queue.Count - numKept); } - private static uint GetCurrentAnimationId(IGameObject obj) + private static uint GetCurrentAnimationId(GameObject obj) { var gameObj = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)obj.Address; if (gameObj == null || !gameObj->IsCharacter()) return 0; var chara = (Character*)gameObj; - var ptr = (byte*)&chara->Timeline + 0xF0; + var ptr = (byte*)&chara->ActionTimelineManager + 0xF0; return *(uint*)ptr; } - private static bool DelayRedraw(IGameObject obj) + private static bool DelayRedraw(GameObject obj) => ((Character*)obj.Address)->Mode switch { - (CharacterModes)6 => // fishing + (Character.CharacterModes)6 => // fishing GetCurrentAnimationId(obj) switch { - 278 => true, // line out. - 283 => true, // reeling in - 284 => true, // reeling in - 287 => true, // reeling in 2 - 3149 => true, // line out sitting, - 3155 => true, // reeling in sitting, - 3159 => true, // reeling in sitting 2, - _ => false, + 278 => true, // line out. + 283 => true, // reeling in + _ => false, }, _ => false, }; @@ -349,20 +342,27 @@ public sealed unsafe partial class RedrawService : IDisposable HandleTarget(); } - public void RedrawObject(IGameObject? actor, RedrawType settings) + public void RedrawObject(GameObject? actor, RedrawType settings) { switch (settings) { - case RedrawType.Redraw: ReloadActor(actor); break; - case RedrawType.AfterGPose: ReloadActorAfterGPose(actor); break; - default: throw new ArgumentOutOfRangeException(nameof(settings), settings, null); + case RedrawType.Redraw: + ReloadActor(actor); + break; + case RedrawType.AfterGPose: + ReloadActorAfterGPose(actor); + break; + default: throw new ArgumentOutOfRangeException(nameof(settings), settings, null); } } - private IGameObject? GetLocalPlayer() - => InGPose ? _objects.GetDalamudObject(GPosePlayerIdx) ?? _objects.GetDalamudObject(0) : _objects.GetDalamudObject(0); + private GameObject? GetLocalPlayer() + { + var gPosePlayer = _objects.GetDalamudObject(GPosePlayerIdx); + return gPosePlayer ?? _objects.GetDalamudObject(0); + } - public bool GetName(string lowerName, out IGameObject? actor) + public bool GetName(string lowerName, out GameObject? actor) { (actor, var ret) = lowerName switch { @@ -380,7 +380,7 @@ public sealed unsafe partial class RedrawService : IDisposable if (!ret && lowerName.Length > 1 && lowerName[0] == '#' && ushort.TryParse(lowerName[1..], out var objectIndex)) { ret = true; - actor = _objects.GetDalamudObject((int)objectIndex); + actor = _objects.GetDalamudObject((int) objectIndex); } return ret; @@ -416,14 +416,15 @@ public sealed unsafe partial class RedrawService : IDisposable if (housingManager == null) return; - var currentTerritory = (IndoorTerritory*)housingManager->CurrentTerritory; - if (currentTerritory == null || currentTerritory->GetTerritoryType() is not HousingTerritoryType.Indoor) + var currentTerritory = housingManager->CurrentTerritory; + if (currentTerritory == null) + return; + if (!housingManager->IsInside()) return; - - foreach (ref var f in currentTerritory->FurnitureManager.FurnitureMemory) + foreach (var f in currentTerritory->FurnitureSpan.PointerEnumerator()) { - var gameObject = f.Index >= 0 ? currentTerritory->FurnitureManager.ObjectManager.ObjectArray.Objects[f.Index].Value : null; + var gameObject = f->Index >= 0 ? currentTerritory->HousingObjectManager.ObjectsSpan[f->Index].Value : null; if (gameObject == null) continue; diff --git a/Penumbra/Interop/Services/ResidentResourceManager.cs b/Penumbra/Interop/Services/ResidentResourceManager.cs index 4f430aa1..72697185 100644 --- a/Penumbra/Interop/Services/ResidentResourceManager.cs +++ b/Penumbra/Interop/Services/ResidentResourceManager.cs @@ -1,11 +1,10 @@ -using Dalamud.Plugin.Services; +using Dalamud.Plugin.Services; using Dalamud.Utility.Signatures; -using OtterGui.Services; using Penumbra.GameData; namespace Penumbra.Interop.Services; -public unsafe class ResidentResourceManager : IService +public unsafe class ResidentResourceManager { // A static pointer to the resident resource manager address. [Signature(Sigs.ResidentResourceManager, ScanType = ScanType.StaticAddress)] diff --git a/Penumbra/Interop/Services/SchedulerResourceManagementService.cs b/Penumbra/Interop/Services/SchedulerResourceManagementService.cs deleted file mode 100644 index b7f57a44..00000000 --- a/Penumbra/Interop/Services/SchedulerResourceManagementService.cs +++ /dev/null @@ -1,92 +0,0 @@ -using System.Collections.Frozen; -using Dalamud.Plugin.Services; -using Dalamud.Utility.Signatures; -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Resource; -using Lumina.Excel.Sheets; -using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.Communication; -using Penumbra.GameData; -using Penumbra.Mods.Editor; -using Penumbra.Services; -using Penumbra.String; -using Penumbra.String.Classes; - -namespace Penumbra.Interop.Services; - -public unsafe class SchedulerResourceManagementService : IService, IDisposable -{ - private static readonly CiByteString TmbExtension = new(".tmb"u8, MetaDataComputation.All); - private static readonly CiByteString FolderPrefix = new("chara/action/"u8, MetaDataComputation.All); - - private readonly CommunicatorService _communicator; - private readonly FrozenDictionary _actionTmbs; - - private readonly ConcurrentDictionary _listedTmbIds = []; - - public bool Contains(uint tmbId) - => _listedTmbIds.ContainsKey(tmbId); - - public IReadOnlyDictionary ListedTmbs - => _listedTmbIds; - - public IReadOnlyDictionary ActionTmbs - => _actionTmbs; - - public SchedulerResourceManagementService(IGameInteropProvider interop, CommunicatorService communicator, IDataManager dataManager) - { - _communicator = communicator; - _actionTmbs = CreateActionTmbs(dataManager); - _communicator.ResolvedFileChanged.Subscribe(OnResolvedFileChange, ResolvedFileChanged.Priority.SchedulerResourceManagementService); - interop.InitializeFromAttributes(this); - } - - private void OnResolvedFileChange(ModCollection collection, ResolvedFileChanged.Type type, Utf8GamePath gamePath, FullPath oldPath, - FullPath newPath, IMod? mod) - { - switch (type) - { - case ResolvedFileChanged.Type.Added: - CheckFile(gamePath); - return; - case ResolvedFileChanged.Type.FullRecomputeFinished: - foreach (var path in collection.ResolvedFiles.Keys) - CheckFile(path); - return; - } - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private void CheckFile(Utf8GamePath gamePath) - { - if (!gamePath.Extension().Equals(TmbExtension)) - return; - - if (!gamePath.Path.StartsWith(FolderPrefix)) - return; - - var tmb = gamePath.Path.Substring(FolderPrefix.Length, gamePath.Length - FolderPrefix.Length - TmbExtension.Length).Clone(); - if (_actionTmbs.TryGetValue(tmb, out var rowId)) - _listedTmbIds[rowId] = tmb; - else - Penumbra.Log.Verbose($"Action TMB {gamePath} encountered with no corresponding row ID."); - } - - [Signature(Sigs.SchedulerResourceManagementInstance, ScanType = ScanType.StaticAddress)] - public readonly SchedulerResourceManagement** Address = null; - - public SchedulerResourceManagement* Scheduler - => *Address; - - public void Dispose() - { - _listedTmbIds.Clear(); - _communicator.ResolvedFileChanged.Unsubscribe(OnResolvedFileChange); - } - - private static FrozenDictionary CreateActionTmbs(IDataManager dataManager) - { - var sheet = dataManager.GetExcelSheet(); - return sheet.Where(row => !row.Key.IsEmpty).DistinctBy(row => row.Key).ToFrozenDictionary(row => new CiByteString(row.Key, MetaDataComputation.All).Clone(), row => row.RowId); - } -} diff --git a/Penumbra/Interop/Services/ShaderReplacementFixer.cs b/Penumbra/Interop/Services/ShaderReplacementFixer.cs new file mode 100644 index 00000000..3809ecbd --- /dev/null +++ b/Penumbra/Interop/Services/ShaderReplacementFixer.cs @@ -0,0 +1,186 @@ +using Dalamud.Hooking; +using Dalamud.Plugin.Services; +using Dalamud.Utility.Signatures; +using FFXIVClientStructs.FFXIV.Client.Graphics.Render; +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; +using OtterGui.Classes; +using OtterGui.Services; +using Penumbra.Communication; +using Penumbra.GameData; +using Penumbra.Interop.Hooks.Resources; +using Penumbra.Services; +using CSModelRenderer = FFXIVClientStructs.FFXIV.Client.Graphics.Render.ModelRenderer; + +namespace Penumbra.Interop.Services; + +public sealed unsafe class ShaderReplacementFixer : IDisposable, IRequiredService +{ + public static ReadOnlySpan SkinShpkName + => "skin.shpk"u8; + + public static ReadOnlySpan CharacterGlassShpkName + => "characterglass.shpk"u8; + + private delegate nint CharacterBaseOnRenderMaterialDelegate(CharacterBase* drawObject, CSModelRenderer.OnRenderMaterialParams* param); + + private delegate nint ModelRendererOnRenderMaterialDelegate(CSModelRenderer* modelRenderer, ushort* outFlags, + CSModelRenderer.OnRenderModelParams* param, Material* material, uint materialIndex); + + private readonly Hook _humanOnRenderMaterialHook; + + [Signature(Sigs.ModelRendererOnRenderMaterial, DetourName = nameof(ModelRendererOnRenderMaterialDetour))] + private readonly Hook _modelRendererOnRenderMaterialHook = null!; + + private readonly ResourceHandleDestructor _resourceHandleDestructor; + private readonly CommunicatorService _communicator; + private readonly CharacterUtility _utility; + private readonly ModelRenderer _modelRenderer; + + // MaterialResourceHandle set + private readonly ConcurrentSet _moddedSkinShpkMaterials = new(); + private readonly ConcurrentSet _moddedCharacterGlassShpkMaterials = new(); + + private readonly object _skinLock = new(); + private readonly object _characterGlassLock = new(); + + // ConcurrentDictionary.Count uses a lock in its current implementation. + private int _moddedSkinShpkCount; + private int _moddedCharacterGlassShpkCount; + private ulong _skinSlowPathCallDelta; + private ulong _characterGlassSlowPathCallDelta; + + public bool Enabled { get; internal set; } = true; + + public int ModdedSkinShpkCount + => _moddedSkinShpkCount; + + public int ModdedCharacterGlassShpkCount + => _moddedCharacterGlassShpkCount; + + public ShaderReplacementFixer(ResourceHandleDestructor resourceHandleDestructor, CharacterUtility utility, ModelRenderer modelRenderer, + CommunicatorService communicator, IGameInteropProvider interop, CharacterBaseVTables vTables) + { + interop.InitializeFromAttributes(this); + _resourceHandleDestructor = resourceHandleDestructor; + _utility = utility; + _modelRenderer = modelRenderer; + _communicator = communicator; + _humanOnRenderMaterialHook = + interop.HookFromAddress(vTables.HumanVTable[62], OnRenderHumanMaterial); + _communicator.MtrlShpkLoaded.Subscribe(OnMtrlShpkLoaded, MtrlShpkLoaded.Priority.ShaderReplacementFixer); + _resourceHandleDestructor.Subscribe(OnResourceHandleDestructor, ResourceHandleDestructor.Priority.ShaderReplacementFixer); + _humanOnRenderMaterialHook.Enable(); + _modelRendererOnRenderMaterialHook.Enable(); + } + + public void Dispose() + { + _modelRendererOnRenderMaterialHook.Dispose(); + _humanOnRenderMaterialHook.Dispose(); + _communicator.MtrlShpkLoaded.Unsubscribe(OnMtrlShpkLoaded); + _resourceHandleDestructor.Unsubscribe(OnResourceHandleDestructor); + _moddedCharacterGlassShpkMaterials.Clear(); + _moddedSkinShpkMaterials.Clear(); + _moddedCharacterGlassShpkCount = 0; + _moddedSkinShpkCount = 0; + } + + public (ulong Skin, ulong CharacterGlass) GetAndResetSlowPathCallDeltas() + => (Interlocked.Exchange(ref _skinSlowPathCallDelta, 0), Interlocked.Exchange(ref _characterGlassSlowPathCallDelta, 0)); + + private static bool IsMaterialWithShpk(MaterialResourceHandle* mtrlResource, ReadOnlySpan shpkName) + { + if (mtrlResource == null) + return false; + + return shpkName.SequenceEqual(mtrlResource->ShpkNameSpan); + } + + private void OnMtrlShpkLoaded(nint mtrlResourceHandle, nint gameObject) + { + var mtrl = (MaterialResourceHandle*)mtrlResourceHandle; + var shpk = mtrl->ShaderPackageResourceHandle; + if (shpk == null) + return; + + var shpkName = mtrl->ShpkNameSpan; + + if (SkinShpkName.SequenceEqual(shpkName) && (nint)shpk != _utility.DefaultSkinShpkResource) + if (_moddedSkinShpkMaterials.TryAdd(mtrlResourceHandle)) + Interlocked.Increment(ref _moddedSkinShpkCount); + + if (CharacterGlassShpkName.SequenceEqual(shpkName) && shpk != _modelRenderer.DefaultCharacterGlassShaderPackage) + if (_moddedCharacterGlassShpkMaterials.TryAdd(mtrlResourceHandle)) + Interlocked.Increment(ref _moddedCharacterGlassShpkCount); + } + + private void OnResourceHandleDestructor(Structs.ResourceHandle* handle) + { + if (_moddedSkinShpkMaterials.TryRemove((nint)handle)) + Interlocked.Decrement(ref _moddedSkinShpkCount); + + if (_moddedCharacterGlassShpkMaterials.TryRemove((nint)handle)) + Interlocked.Decrement(ref _moddedCharacterGlassShpkCount); + } + + private nint OnRenderHumanMaterial(CharacterBase* human, CSModelRenderer.OnRenderMaterialParams* param) + { + // If we don't have any on-screen instances of modded skin.shpk, we don't need the slow path at all. + if (!Enabled || _moddedSkinShpkCount == 0) + return _humanOnRenderMaterialHook.Original(human, param); + + var material = param->Model->Materials[param->MaterialIndex]; + var mtrlResource = material->MaterialResourceHandle; + if (!IsMaterialWithShpk(mtrlResource, SkinShpkName)) + return _humanOnRenderMaterialHook.Original(human, param); + + Interlocked.Increment(ref _skinSlowPathCallDelta); + + // Performance considerations: + // - This function is called from several threads simultaneously, hence the need for synchronization in the swapping path ; + // - Function is called each frame for each material on screen, after culling, i. e. up to thousands of times a frame in crowded areas ; + // - Swapping path is taken up to hundreds of times a frame. + // At the time of writing, the lock doesn't seem to have a noticeable impact in either framerate or CPU usage, but the swapping path shall still be avoided as much as possible. + lock (_skinLock) + { + try + { + _utility.Address->SkinShpkResource = (Structs.ResourceHandle*)mtrlResource->ShaderPackageResourceHandle; + return _humanOnRenderMaterialHook.Original(human, param); + } + finally + { + _utility.Address->SkinShpkResource = (Structs.ResourceHandle*)_utility.DefaultSkinShpkResource; + } + } + } + + private nint ModelRendererOnRenderMaterialDetour(CSModelRenderer* modelRenderer, ushort* outFlags, + CSModelRenderer.OnRenderModelParams* param, Material* material, uint materialIndex) + { + // If we don't have any on-screen instances of modded characterglass.shpk, we don't need the slow path at all. + if (!Enabled || _moddedCharacterGlassShpkCount == 0) + return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); + + var mtrlResource = material->MaterialResourceHandle; + if (!IsMaterialWithShpk(mtrlResource, CharacterGlassShpkName)) + return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); + + Interlocked.Increment(ref _characterGlassSlowPathCallDelta); + + // Same performance considerations as above. + lock (_characterGlassLock) + { + try + { + *_modelRenderer.CharacterGlassShaderPackage = mtrlResource->ShaderPackageResourceHandle; + return _modelRendererOnRenderMaterialHook.Original(modelRenderer, outFlags, param, material, materialIndex); + } + finally + { + *_modelRenderer.CharacterGlassShaderPackage = _modelRenderer.DefaultCharacterGlassShaderPackage; + } + } + } +} diff --git a/Penumbra/Interop/Services/TextureArraySlicer.cs b/Penumbra/Interop/Services/TextureArraySlicer.cs deleted file mode 100644 index a3db4d04..00000000 --- a/Penumbra/Interop/Services/TextureArraySlicer.cs +++ /dev/null @@ -1,147 +0,0 @@ -using Dalamud.Bindings.ImGui; -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using OtterGui.Services; -using TerraFX.Interop.DirectX; - -namespace Penumbra.Interop.Services; - -/// -/// Creates ImGui handles over slices of array textures, and manages their lifetime. -/// -public sealed unsafe class TextureArraySlicer : IUiService, IDisposable -{ - private const uint InitialTimeToLive = 2; - - private readonly Dictionary<(nint XivTexture, byte SliceIndex), SliceState> _activeSlices = []; - private readonly HashSet<(nint XivTexture, byte SliceIndex)> _expiredKeys = []; - - /// Caching this across frames will cause a crash to desktop. - public ImTextureID GetImGuiHandle(Texture* texture, byte sliceIndex) - { - if (texture is null) - throw new ArgumentNullException(nameof(texture)); - if (sliceIndex >= texture->ArraySize) - throw new ArgumentOutOfRangeException(nameof(sliceIndex), - $"Slice index ({sliceIndex}) is greater than or equal to the texture array size ({texture->ArraySize})"); - - if (_activeSlices.TryGetValue(((nint)texture, sliceIndex), out var state)) - { - state.Refresh(); - return new ImTextureID((nint)state.ShaderResourceView); - } - - ref var srv = ref *(ID3D11ShaderResourceView*)(nint)texture->D3D11ShaderResourceView; - srv.AddRef(); - try - { - D3D11_SHADER_RESOURCE_VIEW_DESC description; - srv.GetDesc(&description); - switch (description.ViewDimension) - { - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE1D: - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE2D: - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE2DMS: - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE3D: - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURECUBE: - // This function treats these as single-slice arrays. - // As per the range check above, the only valid slice (i. e. 0) has been requested, therefore there is nothing to do. - break; - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE1DARRAY: - description.Texture1DArray.FirstArraySlice = sliceIndex; - description.Texture1DArray.ArraySize = 1; - break; - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE2DARRAY: - description.Texture2DArray.FirstArraySlice = sliceIndex; - description.Texture2DArray.ArraySize = 1; - break; - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURE2DMSARRAY: - description.Texture2DMSArray.FirstArraySlice = sliceIndex; - description.Texture2DMSArray.ArraySize = 1; - break; - case D3D_SRV_DIMENSION.D3D11_SRV_DIMENSION_TEXTURECUBEARRAY: - description.TextureCubeArray.First2DArrayFace = sliceIndex * 6u; - description.TextureCubeArray.NumCubes = 1; - break; - default: - throw new NotSupportedException($"{nameof(TextureArraySlicer)} does not support dimension {description.ViewDimension}"); - } - - ID3D11Device* device = null; - srv.GetDevice(&device); - ID3D11Resource* resource = null; - srv.GetResource(&resource); - try - { - ID3D11ShaderResourceView* slicedSrv = null; - Marshal.ThrowExceptionForHR(device->CreateShaderResourceView(resource, &description, &slicedSrv)); - state = new SliceState(slicedSrv); - _activeSlices.Add(((nint)texture, sliceIndex), state); - return new ImTextureID((nint)state.ShaderResourceView); - } - finally - { - if (resource is not null) - resource->Release(); - if (device is not null) - device->Release(); - } - } - finally - { - srv.Release(); - } - } - - public void Tick() - { - try - { - foreach (var (key, slice) in _activeSlices) - { - if (!slice.Tick()) - _expiredKeys.Add(key); - } - - foreach (var key in _expiredKeys) - _activeSlices.Remove(key); - } - finally - { - _expiredKeys.Clear(); - } - } - - public void Dispose() - { - foreach (var slice in _activeSlices.Values) - slice.Dispose(); - } - - private sealed class SliceState(ID3D11ShaderResourceView* shaderResourceView) : IDisposable - { - public readonly ID3D11ShaderResourceView* ShaderResourceView = shaderResourceView; - - private uint _timeToLive = InitialTimeToLive; - - public void Refresh() - { - _timeToLive = InitialTimeToLive; - } - - public bool Tick() - { - if (unchecked(_timeToLive--) > 0) - return true; - - if (ShaderResourceView is not null) - ShaderResourceView->Release(); - return false; - } - - public void Dispose() - { - if (ShaderResourceView is not null) - ShaderResourceView->Release(); - } - } -} diff --git a/Penumbra/Interop/Structs/CharacterUtilityData.cs b/Penumbra/Interop/Structs/CharacterUtilityData.cs index 8543466d..22150cc1 100644 --- a/Penumbra/Interop/Structs/CharacterUtilityData.cs +++ b/Penumbra/Interop/Structs/CharacterUtilityData.cs @@ -5,24 +5,17 @@ namespace Penumbra.Interop.Structs; [StructLayout(LayoutKind.Explicit)] public unsafe struct CharacterUtilityData { - public const int IndexHumanPbd = 63; - public const int IndexTransparentTex = 79; - public const int IndexDecalTex = 80; - public const int IndexTileOrbArrayTex = 81; - public const int IndexTileNormArrayTex = 82; - public const int IndexSkinShpk = 83; - public const int IndexCharacterStockingsShpk = 84; - public const int IndexCharacterLegacyShpk = 85; - public const int IndexGudStm = 94; - public const int IndexLegacyStm = 95; - public const int IndexSphereDArrayTex = 96; + public const int IndexHumanPbd = 63; + public const int IndexTransparentTex = 72; + public const int IndexDecalTex = 73; + public const int IndexSkinShpk = 76; public static readonly MetaIndex[] EqdpIndices = Enum.GetNames() .Zip(Enum.GetValues()) .Where(n => n.First.StartsWith("Eqdp")) .Select(n => n.Second).ToArray(); - public const int TotalNumResources = 114; + public const int TotalNumResources = 87; /// Obtain the index for the eqdp file corresponding to the given race code and accessory. public static MetaIndex EqdpIdx(GenderRace raceCode, bool accessory) @@ -43,7 +36,7 @@ public unsafe struct CharacterUtilityData 1301 => accessory ? MetaIndex.Eqdp1301Acc : MetaIndex.Eqdp1301, 1401 => accessory ? MetaIndex.Eqdp1401Acc : MetaIndex.Eqdp1401, 1501 => accessory ? MetaIndex.Eqdp1501Acc : MetaIndex.Eqdp1501, - 1601 => accessory ? MetaIndex.Eqdp1601Acc : MetaIndex.Eqdp1601, + //1601 => accessory ? MetaIndex.Eqdp1601Acc : MetaIndex.Eqdp1601, Female Hrothgar 1701 => accessory ? MetaIndex.Eqdp1701Acc : MetaIndex.Eqdp1701, 1801 => accessory ? MetaIndex.Eqdp1801Acc : MetaIndex.Eqdp1801, 0104 => accessory ? MetaIndex.Eqdp0104Acc : MetaIndex.Eqdp0104, @@ -104,29 +97,8 @@ public unsafe struct CharacterUtilityData [FieldOffset(8 + IndexDecalTex * 8)] public TextureResourceHandle* DecalTexResource; - [FieldOffset(8 + IndexTileOrbArrayTex * 8)] - public TextureResourceHandle* TileOrbArrayTexResource; - - [FieldOffset(8 + IndexTileNormArrayTex * 8)] - public TextureResourceHandle* TileNormArrayTexResource; - [FieldOffset(8 + IndexSkinShpk * 8)] public ResourceHandle* SkinShpkResource; - [FieldOffset(8 + IndexCharacterStockingsShpk * 8)] - public ResourceHandle* CharacterStockingsShpkResource; - - [FieldOffset(8 + IndexCharacterLegacyShpk * 8)] - public ResourceHandle* CharacterLegacyShpkResource; - - [FieldOffset(8 + IndexGudStm * 8)] - public ResourceHandle* GudStmResource; - - [FieldOffset(8 + IndexLegacyStm * 8)] - public ResourceHandle* LegacyStmResource; - - [FieldOffset(8 + IndexSphereDArrayTex * 8)] - public TextureResourceHandle* SphereDArrayTexResource; - // not included resources have no known use case. } diff --git a/Penumbra/Interop/Structs/ClipScheduler.cs b/Penumbra/Interop/Structs/ClipScheduler.cs index 8270e0f2..3211c4f9 100644 --- a/Penumbra/Interop/Structs/ClipScheduler.cs +++ b/Penumbra/Interop/Structs/ClipScheduler.cs @@ -1,13 +1,11 @@ -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Base; - namespace Penumbra.Interop.Structs; [StructLayout(LayoutKind.Explicit)] public unsafe struct ClipScheduler { [FieldOffset(0)] - public nint* VTable; + public IntPtr* VTable; [FieldOffset(0x38)] - public SchedulerTimeline* SchedulerTimeline; + public IntPtr SchedulerTimeline; } diff --git a/Penumbra/Interop/Structs/MetaIndex.cs b/Penumbra/Interop/Structs/MetaIndex.cs index 2ec5fce4..65302264 100644 --- a/Penumbra/Interop/Structs/MetaIndex.cs +++ b/Penumbra/Interop/Structs/MetaIndex.cs @@ -4,7 +4,6 @@ namespace Penumbra.Interop.Structs; public enum MetaIndex : int { Eqp = 0, - Evp = 1, Gmp = 2, Eqdp0101 = 3, @@ -22,8 +21,9 @@ public enum MetaIndex : int Eqdp1301, Eqdp1401, Eqdp1501, - Eqdp1601, - Eqdp1701, + + //Eqdp1601, // TODO: female Hrothgar + Eqdp1701 = Eqdp1501 + 2, Eqdp1801, Eqdp0104, Eqdp0204, @@ -51,8 +51,9 @@ public enum MetaIndex : int Eqdp1301Acc, Eqdp1401Acc, Eqdp1501Acc, - Eqdp1601Acc, - Eqdp1701Acc, + + //Eqdp1601Acc, // TODO: female Hrothgar + Eqdp1701Acc = Eqdp1501Acc + 2, Eqdp1801Acc, Eqdp0104Acc, Eqdp0204Acc, @@ -65,7 +66,7 @@ public enum MetaIndex : int Eqdp9104Acc, Eqdp9204Acc, - HumanCmp = 71, + HumanCmp = 64, FaceEst, HairEst, HeadEst, diff --git a/Penumbra/Interop/Structs/ModelRendererStructs.cs b/Penumbra/Interop/Structs/ModelRendererStructs.cs deleted file mode 100644 index 551a32e3..00000000 --- a/Penumbra/Interop/Structs/ModelRendererStructs.cs +++ /dev/null @@ -1,35 +0,0 @@ -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.Graphics.Render; -using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; - -namespace Penumbra.Interop.Structs; - -public static unsafe class ModelRendererStructs -{ - [StructLayout(LayoutKind.Explicit, Size = 0x28)] - public struct UnkShaderWrapper - { - [FieldOffset(0)] - public void* Vtbl; - - [FieldOffset(8)] - public ShaderPackage* ShaderPackage; - } - - // Unknown size, this is allocated on FUN_1404446c0's stack (E8 ?? ?? ?? ?? FF C3 41 3B DE 72 ?? 48 C7 85) - [StructLayout(LayoutKind.Explicit)] - public struct UnkPayload - { - [FieldOffset(0)] - public ModelRenderer.OnRenderModelParams* Params; - - [FieldOffset(8)] - public ModelResourceHandle* ModelResourceHandle; - - [FieldOffset(0x10)] - public UnkShaderWrapper* ShaderWrapper; - - [FieldOffset(0x1C)] - public ushort UnkIndex; - } -} diff --git a/Penumbra/Interop/Structs/ResourceHandle.cs b/Penumbra/Interop/Structs/ResourceHandle.cs index 1558c035..382368b4 100644 --- a/Penumbra/Interop/Structs/ResourceHandle.cs +++ b/Penumbra/Interop/Structs/ResourceHandle.cs @@ -14,30 +14,14 @@ public unsafe struct TextureResourceHandle [FieldOffset(0x0)] public CsHandle.TextureResourceHandle CsHandle; - - [FieldOffset(0x104)] - public byte SomeLodFlag; - - public bool ChangeLod - => (SomeLodFlag & 1) != 0; } public enum LoadState : byte { - Constructing = 0x00, - Constructed = 0x01, - Async2 = 0x02, - AsyncRequested = 0x03, - Async4 = 0x04, - AsyncLoading = 0x05, - Async6 = 0x06, Success = 0x07, - Unknown8 = 0x08, + Async = 0x03, Failure = 0x09, FailedSubResource = 0x0A, - FailureB = 0x0B, - FailureC = 0x0C, - FailureD = 0x0D, None = 0xFF, } @@ -57,11 +41,11 @@ public unsafe struct ResourceHandle public ulong DataLength; } - public readonly CiByteString FileName() + public readonly ByteString FileName() => CsHandle.FileName.AsByteString(); public readonly bool GamePath(out Utf8GamePath path) - => Utf8GamePath.FromSpan(CsHandle.FileName.AsSpan(), MetaDataComputation.All, out path); + => Utf8GamePath.FromSpan(CsHandle.FileName.AsSpan(), out path); [FieldOffset(0x00)] public CsHandle.ResourceHandle CsHandle; @@ -84,9 +68,6 @@ public unsafe struct ResourceHandle [FieldOffset(0x58)] public int FileNameLength; - [FieldOffset(0xA8)] - public byte UnkState; - [FieldOffset(0xA9)] public LoadState LoadState; @@ -102,12 +83,12 @@ public unsafe struct ResourceHandle [FieldOffset(0xB8)] public uint DataLength; - public (nint Data, int Length) GetData() + public (IntPtr Data, int Length) GetData() => Data != null - ? ((nint)Data->DataPtr, (int)Data->DataLength) - : (nint.Zero, 0); + ? ((IntPtr)Data->DataPtr, (int)Data->DataLength) + : (IntPtr.Zero, 0); - public bool SetData(nint data, int length) + public bool SetData(IntPtr data, int length) { if (Data == null) return false; diff --git a/Penumbra/Interop/Structs/SeFileDescriptor.cs b/Penumbra/Interop/Structs/SeFileDescriptor.cs index 02ab4dc8..67730799 100644 --- a/Penumbra/Interop/Structs/SeFileDescriptor.cs +++ b/Penumbra/Interop/Structs/SeFileDescriptor.cs @@ -1,6 +1,3 @@ -using Dalamud.Memory; -using Penumbra.String.Functions; - namespace Penumbra.Interop.Structs; [StructLayout(LayoutKind.Explicit)] @@ -17,18 +14,4 @@ public unsafe struct SeFileDescriptor [FieldOffset(0x70)] public char Utf16FileName; - - public FFXIVClientStructs.FFXIV.Client.System.Resource.Handle.ResourceHandle* CsResourceHandele - => (FFXIVClientStructs.FFXIV.Client.System.Resource.Handle.ResourceHandle*)ResourceHandle; - - public string FileName - { - get - { - fixed (char* ptr = &Utf16FileName) - { - return MemoryMarshal.CreateReadOnlySpanFromNullTerminated(ptr).ToString(); - } - } - } } diff --git a/Penumbra/Interop/Structs/StructExtensions.cs b/Penumbra/Interop/Structs/StructExtensions.cs index 7349f6cc..3cd87424 100644 --- a/Penumbra/Interop/Structs/StructExtensions.cs +++ b/Penumbra/Interop/Structs/StructExtensions.cs @@ -1,78 +1,53 @@ using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; using FFXIVClientStructs.STD; -using InteropGenerator.Runtime; using Penumbra.String; namespace Penumbra.Interop.Structs; internal static class StructExtensions { - public static CiByteString AsByteString(in this StdString str) - => CiByteString.FromSpanUnsafe(str.AsSpan(), true); + public static unsafe ByteString AsByteString(in this StdString str) + => ByteString.FromSpanUnsafe(str.AsSpan(), true); - public static CiByteString ResolveEidPathAsByteString(ref this CharacterBase character) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveEidPath(pathBuffer)); + public static ByteString ResolveEidPathAsByteString(in this CharacterBase character) + { + Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveEidPath(pathBuffer)); + } + + public static ByteString ResolveImcPathAsByteString(in this CharacterBase character, uint slotIndex) + { + Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveImcPath(pathBuffer, slotIndex)); } - public static CiByteString ResolveImcPathAsByteString(ref this CharacterBase character, uint slotIndex) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveImcPath(pathBuffer, slotIndex)); + public static ByteString ResolveMdlPathAsByteString(in this CharacterBase character, uint slotIndex) + { + Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveMdlPath(pathBuffer, slotIndex)); } - public static CiByteString ResolveMdlPathAsByteString(ref this CharacterBase character, uint slotIndex) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveMdlPath(pathBuffer, slotIndex)); + public static unsafe ByteString ResolveMtrlPathAsByteString(in this CharacterBase character, uint slotIndex, byte* mtrlFileName) + { + var pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveMtrlPath(pathBuffer, CharacterBase.PathBufferSize, slotIndex, mtrlFileName)); } - public static unsafe CiByteString ResolveMtrlPathAsByteString(ref this CharacterBase character, uint slotIndex, byte* mtrlFileName) - { - var pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveMtrlPath(pathBuffer, CharacterBase.PathBufferSize, slotIndex, mtrlFileName)); + public static ByteString ResolveSklbPathAsByteString(in this CharacterBase character, uint partialSkeletonIndex) + { + Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveSklbPath(pathBuffer, partialSkeletonIndex)); } - public static unsafe CiByteString ResolveSkinMtrlPathAsByteString(ref this CharacterBase character, uint slotIndex) - { - var pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveSkinMtrlPath(pathBuffer, CharacterBase.PathBufferSize, slotIndex)); + public static ByteString ResolveSkpPathAsByteString(in this CharacterBase character, uint partialSkeletonIndex) + { + Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; + return ToOwnedByteString(character.ResolveSkpPath(pathBuffer, partialSkeletonIndex)); } - public static CiByteString ResolveMaterialPapPathAsByteString(ref this CharacterBase character, uint slotIndex, uint unkSId) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveMaterialPapPath(pathBuffer, slotIndex, unkSId)); - } + private static unsafe ByteString ToOwnedByteString(byte* str) + => str == null ? ByteString.Empty : new ByteString(str).Clone(); - public static CiByteString ResolveSklbPathAsByteString(ref this CharacterBase character, uint partialSkeletonIndex) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveSklbPath(pathBuffer, partialSkeletonIndex)); - } - - public static CiByteString ResolveSkpPathAsByteString(ref this CharacterBase character, uint partialSkeletonIndex) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveSkpPath(pathBuffer, partialSkeletonIndex)); - } - - public static CiByteString ResolvePhybPathAsByteString(ref this CharacterBase character, uint partialSkeletonIndex) - { - Span pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolvePhybPath(pathBuffer, partialSkeletonIndex)); - } - - public static unsafe CiByteString ResolveKdbPathAsByteString(ref this CharacterBase character, uint partialSkeletonIndex) - { - var pathBuffer = stackalloc byte[CharacterBase.PathBufferSize]; - return ToOwnedByteString(character.ResolveKdbPath(pathBuffer, CharacterBase.PathBufferSize, partialSkeletonIndex)); - } - - private static unsafe CiByteString ToOwnedByteString(CStringPointer str) - => str.HasValue ? new CiByteString(str.Value).Clone() : CiByteString.Empty; - - private static CiByteString ToOwnedByteString(ReadOnlySpan str) - => str.Length == 0 ? CiByteString.Empty : CiByteString.FromSpanUnsafe(str, true).Clone(); + private static ByteString ToOwnedByteString(ReadOnlySpan str) + => str.Length == 0 ? ByteString.Empty : ByteString.FromSpanUnsafe(str, true).Clone(); } diff --git a/Penumbra/Interop/VolatileOffsets.cs b/Penumbra/Interop/VolatileOffsets.cs deleted file mode 100644 index 85008aae..00000000 --- a/Penumbra/Interop/VolatileOffsets.cs +++ /dev/null @@ -1,35 +0,0 @@ -namespace Penumbra.Interop; - -public static class VolatileOffsets -{ - public static class ApricotListenerSoundPlayCaller - { - public const int PlayTimeOffset = 0x254; - public const int SomeIntermediate = 0x1F8; - public const int Flags = 0x4A8; - public const int IInstanceListenner = 0x270; - public const int BitShift = 13; - public const int CasterVFunc = 1; - } - - public static class AnimationState - { - public const int TimeLinePtr = 0x50; - } - - public static class UpdateModel - { - public const int ShortCircuit = 0xA3C; - } - - public static class FontReloader - { - public const int ReloadFontsVFunc = 43; - } - - public static class RedrawService - { - public const int EnableDrawVFunc = 12; - public const int DisableDrawVFunc = 13; - } -} diff --git a/Penumbra/Meta/AtchManager.cs b/Penumbra/Meta/AtchManager.cs deleted file mode 100644 index 68f2f815..00000000 --- a/Penumbra/Meta/AtchManager.cs +++ /dev/null @@ -1,26 +0,0 @@ -using System.Collections.Frozen; -using Dalamud.Plugin.Services; -using OtterGui.Services; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files; - -namespace Penumbra.Interop.Hooks.Meta; - -public sealed unsafe class AtchManager : IService -{ - private static readonly IReadOnlyList GenderRaces = - [ - GenderRace.MidlanderMale, GenderRace.MidlanderFemale, GenderRace.HighlanderMale, GenderRace.HighlanderFemale, GenderRace.ElezenMale, - GenderRace.ElezenFemale, GenderRace.MiqoteMale, GenderRace.MiqoteFemale, GenderRace.RoegadynMale, GenderRace.RoegadynFemale, - GenderRace.LalafellMale, GenderRace.LalafellFemale, GenderRace.AuRaMale, GenderRace.AuRaFemale, GenderRace.HrothgarMale, - GenderRace.HrothgarFemale, GenderRace.VieraMale, GenderRace.VieraFemale, - ]; - - public readonly IReadOnlyDictionary AtchFileBase; - - public AtchManager(IDataManager manager) - { - AtchFileBase = GenderRaces.ToFrozenDictionary(gr => gr, - gr => new AtchFile(manager.GetFile($"chara/xls/attachOffset/c{gr.ToRaceCode()}.atch")!.DataSpan)); - } -} diff --git a/Penumbra/Meta/Files/CmpFile.cs b/Penumbra/Meta/Files/CmpFile.cs index 5028a3de..b265a5e8 100644 --- a/Penumbra/Meta/Files/CmpFile.cs +++ b/Penumbra/Meta/Files/CmpFile.cs @@ -2,7 +2,6 @@ using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Interop.Structs; using Penumbra.Interop.Services; -using Penumbra.Meta.Manipulations; using Penumbra.String.Functions; namespace Penumbra.Meta.Files; @@ -18,10 +17,10 @@ public sealed unsafe class CmpFile : MetaBaseFile private const int RacialScalingStart = 0x2A800; - public RspEntry this[SubRace subRace, RspAttribute attribute] + public float this[SubRace subRace, RspAttribute attribute] { - get => *(RspEntry*)(Data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4); - set => *(RspEntry*)(Data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4) = value; + get => *(float*)(Data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4); + set => *(float*)(Data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4) = value; } public override void Reset() @@ -34,24 +33,16 @@ public sealed unsafe class CmpFile : MetaBaseFile } public CmpFile(MetaFileManager manager) - : base(manager, manager.MarshalAllocator, MetaIndex.HumanCmp) + : base(manager, MetaIndex.HumanCmp) { AllocateData(DefaultData.Length); Reset(); } - public static RspEntry GetDefault(MetaFileManager manager, SubRace subRace, RspAttribute attribute) + public static float GetDefault(MetaFileManager manager, SubRace subRace, RspAttribute attribute) { var data = (byte*)manager.CharacterUtility.DefaultResource(InternalIndex).Address; - return *(RspEntry*)(data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4); - } - - public static RspEntry* GetDefaults(MetaFileManager manager, SubRace subRace, RspAttribute attribute) - { - { - var data = (byte*)manager.CharacterUtility.DefaultResource(InternalIndex).Address; - return (RspEntry*)(data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4); - } + return *(float*)(data + RacialScalingStart + ToRspIndex(subRace) * RspData.ByteSize + (int)attribute * 4); } private static int ToRspIndex(SubRace subRace) diff --git a/Penumbra/Meta/Files/EqdpFile.cs b/Penumbra/Meta/Files/EqdpFile.cs index 34b4f25b..c76c4efd 100644 --- a/Penumbra/Meta/Files/EqdpFile.cs +++ b/Penumbra/Meta/Files/EqdpFile.cs @@ -2,7 +2,6 @@ using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Interop.Services; using Penumbra.Interop.Structs; -using Penumbra.Meta.Manipulations; using Penumbra.String.Functions; namespace Penumbra.Meta.Files; @@ -87,7 +86,7 @@ public sealed unsafe class ExpandedEqdpFile : MetaBaseFile } public ExpandedEqdpFile(MetaFileManager manager, GenderRace raceCode, bool accessory) - : base(manager, manager.MarshalAllocator, CharacterUtilityData.EqdpIdx(raceCode, accessory)) + : base(manager, CharacterUtilityData.EqdpIdx(raceCode, accessory)) { var def = (byte*)DefaultData.Data; var blockSize = *(ushort*)(def + IdentifierSize); @@ -127,7 +126,4 @@ public sealed unsafe class ExpandedEqdpFile : MetaBaseFile public static EqdpEntry GetDefault(MetaFileManager manager, GenderRace raceCode, bool accessory, PrimaryId primaryId) => GetDefault(manager, CharacterUtility.ReverseIndices[(int)CharacterUtilityData.EqdpIdx(raceCode, accessory)], primaryId); - - public static EqdpEntry GetDefault(MetaFileManager manager, EqdpIdentifier identifier) - => GetDefault(manager, CharacterUtility.ReverseIndices[(int)identifier.FileIndex()], identifier.SetId); } diff --git a/Penumbra/Meta/Files/EqpGmpFile.cs b/Penumbra/Meta/Files/EqpGmpFile.cs index a7540f4b..70067c2b 100644 --- a/Penumbra/Meta/Files/EqpGmpFile.cs +++ b/Penumbra/Meta/Files/EqpGmpFile.cs @@ -1,7 +1,6 @@ using Penumbra.GameData.Structs; using Penumbra.Interop.Services; using Penumbra.Interop.Structs; -using Penumbra.Meta.Manipulations; using Penumbra.String.Functions; namespace Penumbra.Meta.Files; @@ -15,10 +14,10 @@ namespace Penumbra.Meta.Files; /// public unsafe class ExpandedEqpGmpBase : MetaBaseFile { - public const int BlockSize = 160; - public const int NumBlocks = 64; - public const int EntrySize = 8; - public const int MaxSize = BlockSize * NumBlocks * EntrySize; + protected const int BlockSize = 160; + protected const int NumBlocks = 64; + protected const int EntrySize = 8; + protected const int MaxSize = BlockSize * NumBlocks * EntrySize; public const int Count = BlockSize * NumBlocks; @@ -76,7 +75,7 @@ public unsafe class ExpandedEqpGmpBase : MetaBaseFile } public ExpandedEqpGmpBase(MetaFileManager manager, bool gmp) - : base(manager, manager.MarshalAllocator, gmp ? MetaIndex.Gmp : MetaIndex.Eqp) + : base(manager, gmp ? MetaIndex.Gmp : MetaIndex.Eqp) { AllocateData(MaxSize); Reset(); @@ -104,11 +103,15 @@ public unsafe class ExpandedEqpGmpBase : MetaBaseFile } } -public sealed class ExpandedEqpFile(MetaFileManager manager) : ExpandedEqpGmpBase(manager, false), IEnumerable +public sealed class ExpandedEqpFile : ExpandedEqpGmpBase, IEnumerable { public static readonly CharacterUtility.InternalIndex InternalIndex = CharacterUtility.ReverseIndices[(int)MetaIndex.Eqp]; + public ExpandedEqpFile(MetaFileManager manager) + : base(manager, false) + { } + public EqpEntry this[PrimaryId idx] { get => (EqpEntry)GetInternal(idx); @@ -143,11 +146,15 @@ public sealed class ExpandedEqpFile(MetaFileManager manager) : ExpandedEqpGmpBas => GetEnumerator(); } -public sealed class ExpandedGmpFile(MetaFileManager manager) : ExpandedEqpGmpBase(manager, true), IEnumerable +public sealed class ExpandedGmpFile : ExpandedEqpGmpBase, IEnumerable { public static readonly CharacterUtility.InternalIndex InternalIndex = CharacterUtility.ReverseIndices[(int)MetaIndex.Gmp]; + public ExpandedGmpFile(MetaFileManager manager) + : base(manager, true) + { } + public GmpEntry this[PrimaryId idx] { get => new() { Value = GetInternal(idx) }; @@ -157,9 +164,6 @@ public sealed class ExpandedGmpFile(MetaFileManager manager) : ExpandedEqpGmpBas public static GmpEntry GetDefault(MetaFileManager manager, PrimaryId primaryIdx) => new() { Value = GetDefaultInternal(manager, InternalIndex, primaryIdx, GmpEntry.Default.Value) }; - public static GmpEntry GetDefault(MetaFileManager manager, GmpIdentifier identifier) - => new() { Value = GetDefaultInternal(manager, InternalIndex, identifier.SetId, GmpEntry.Default.Value) }; - public void Reset(IEnumerable entries) { foreach (var entry in entries) diff --git a/Penumbra/Meta/Files/EstFile.cs b/Penumbra/Meta/Files/EstFile.cs index ba38d6d9..af441b22 100644 --- a/Penumbra/Meta/Files/EstFile.cs +++ b/Penumbra/Meta/Files/EstFile.cs @@ -34,26 +34,26 @@ public sealed unsafe class EstFile : MetaBaseFile Removed, } - public EstEntry this[GenderRace genderRace, PrimaryId setId] + public ushort this[GenderRace genderRace, ushort setId] { get { var (idx, exists) = FindEntry(genderRace, setId); if (!exists) - return EstEntry.Zero; + return 0; - return *(EstEntry*)(Data + EntryDescSize * (Count + 1) + EntrySize * idx); + return *(ushort*)(Data + EntryDescSize * (Count + 1) + EntrySize * idx); } set => SetEntry(genderRace, setId, value); } - private void InsertEntry(int idx, GenderRace genderRace, PrimaryId setId, EstEntry skeletonId) + private void InsertEntry(int idx, GenderRace genderRace, ushort setId, ushort skeletonId) { if (Length < Size + EntryDescSize + EntrySize) ResizeResources(Length + IncreaseSize); var control = (Info*)(Data + 4); - var entries = (EstEntry*)(control + Count); + var entries = (ushort*)(control + Count); for (var i = Count - 1; i >= idx; --i) entries[i + 3] = entries[i]; @@ -94,10 +94,10 @@ public sealed unsafe class EstFile : MetaBaseFile [StructLayout(LayoutKind.Sequential, Size = 4)] private struct Info : IComparable { - public readonly PrimaryId SetId; + public readonly ushort SetId; public readonly GenderRace GenderRace; - public Info(GenderRace gr, PrimaryId setId) + public Info(GenderRace gr, ushort setId) { GenderRace = gr; SetId = setId; @@ -106,42 +106,42 @@ public sealed unsafe class EstFile : MetaBaseFile public int CompareTo(Info other) { var genderRaceComparison = GenderRace.CompareTo(other.GenderRace); - return genderRaceComparison != 0 ? genderRaceComparison : SetId.Id.CompareTo(other.SetId.Id); + return genderRaceComparison != 0 ? genderRaceComparison : SetId.CompareTo(other.SetId); } } - private static (int, bool) FindEntry(ReadOnlySpan data, GenderRace genderRace, PrimaryId setId) + private static (int, bool) FindEntry(ReadOnlySpan data, GenderRace genderRace, ushort setId) { var idx = data.BinarySearch(new Info(genderRace, setId)); return idx < 0 ? (~idx, false) : (idx, true); } - private (int, bool) FindEntry(GenderRace genderRace, PrimaryId setId) + private (int, bool) FindEntry(GenderRace genderRace, ushort setId) { var span = new ReadOnlySpan(Data + 4, Count); return FindEntry(span, genderRace, setId); } - public EstEntryChange SetEntry(GenderRace genderRace, PrimaryId setId, EstEntry skeletonId) + public EstEntryChange SetEntry(GenderRace genderRace, ushort setId, ushort skeletonId) { var (idx, exists) = FindEntry(genderRace, setId); if (exists) { - var value = *(EstEntry*)(Data + 4 * (Count + 1) + 2 * idx); + var value = *(ushort*)(Data + 4 * (Count + 1) + 2 * idx); if (value == skeletonId) return EstEntryChange.Unchanged; - if (skeletonId == EstEntry.Zero) + if (skeletonId == 0) { RemoveEntry(idx); return EstEntryChange.Removed; } - *(EstEntry*)(Data + 4 * (Count + 1) + 2 * idx) = skeletonId; + *(ushort*)(Data + 4 * (Count + 1) + 2 * idx) = skeletonId; return EstEntryChange.Changed; } - if (skeletonId == EstEntry.Zero) + if (skeletonId == 0) return EstEntryChange.Unchanged; InsertEntry(idx, genderRace, setId, skeletonId); @@ -156,35 +156,32 @@ public sealed unsafe class EstFile : MetaBaseFile MemoryUtility.MemSet(Data + length, 0, Length - length); } - public EstFile(MetaFileManager manager, EstType estType) - : base(manager, manager.MarshalAllocator, (MetaIndex)estType) + public EstFile(MetaFileManager manager, EstManipulation.EstType estType) + : base(manager, (MetaIndex)estType) { var length = DefaultData.Length; AllocateData(length + IncreaseSize); Reset(); } - public EstEntry GetDefault(GenderRace genderRace, PrimaryId setId) + public ushort GetDefault(GenderRace genderRace, ushort setId) => GetDefault(Manager, Index, genderRace, setId); - public static EstEntry GetDefault(MetaFileManager manager, CharacterUtility.InternalIndex index, GenderRace genderRace, PrimaryId primaryId) + public static ushort GetDefault(MetaFileManager manager, CharacterUtility.InternalIndex index, GenderRace genderRace, PrimaryId primaryId) { var data = (byte*)manager.CharacterUtility.DefaultResource(index).Address; var count = *(int*)data; var span = new ReadOnlySpan(data + 4, count); var (idx, found) = FindEntry(span, genderRace, primaryId.Id); if (!found) - return EstEntry.Zero; + return 0; - return *(EstEntry*)(data + 4 + count * EntryDescSize + idx * EntrySize); + return *(ushort*)(data + 4 + count * EntryDescSize + idx * EntrySize); } - public static EstEntry GetDefault(MetaFileManager manager, MetaIndex metaIndex, GenderRace genderRace, PrimaryId primaryId) + public static ushort GetDefault(MetaFileManager manager, MetaIndex metaIndex, GenderRace genderRace, PrimaryId primaryId) => GetDefault(manager, CharacterUtility.ReverseIndices[(int)metaIndex], genderRace, primaryId); - public static EstEntry GetDefault(MetaFileManager manager, EstType estType, GenderRace genderRace, PrimaryId primaryId) + public static ushort GetDefault(MetaFileManager manager, EstManipulation.EstType estType, GenderRace genderRace, PrimaryId primaryId) => GetDefault(manager, (MetaIndex)estType, genderRace, primaryId); - - public static EstEntry GetDefault(MetaFileManager manager, EstIdentifier identifier) - => GetDefault(manager, identifier.FileIndex(), identifier.GenderRace, identifier.SetId); } diff --git a/Penumbra/Meta/Files/EvpFile.cs b/Penumbra/Meta/Files/EvpFile.cs index 6ab1591c..3d0b4dbe 100644 --- a/Penumbra/Meta/Files/EvpFile.cs +++ b/Penumbra/Meta/Files/EvpFile.cs @@ -12,7 +12,7 @@ namespace Penumbra.Meta.Files; /// Containing Flags in each byte, 0x01 set for Body, 0x02 set for Helmet. /// Each flag corresponds to a mount row from the Mounts table and determines whether the mount disables the effect. /// -public unsafe class EvpFile(MetaFileManager manager) : MetaBaseFile(manager, manager.MarshalAllocator, (MetaIndex)1) +public unsafe class EvpFile : MetaBaseFile { public const int FlagArraySize = 512; @@ -57,4 +57,8 @@ public unsafe class EvpFile(MetaFileManager manager) : MetaBaseFile(manager, man return EvpFlag.None; } + + public EvpFile(MetaFileManager manager) + : base(manager, (MetaIndex)1) // TODO: Name + { } } diff --git a/Penumbra/Meta/Files/ImcFile.cs b/Penumbra/Meta/Files/ImcFile.cs index b8db66dd..68d3f5b3 100644 --- a/Penumbra/Meta/Files/ImcFile.cs +++ b/Penumbra/Meta/Files/ImcFile.cs @@ -1,5 +1,3 @@ -using OtterGui.Extensions; -using Penumbra.GameData; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Interop.Structs; @@ -9,16 +7,22 @@ using Penumbra.String.Functions; namespace Penumbra.Meta.Files; -public class ImcException(ImcIdentifier identifier, Utf8GamePath path) : Exception +public class ImcException : Exception { - public readonly ImcIdentifier Identifier = identifier; - public readonly string GamePath = path.ToString(); + public readonly ImcManipulation Manipulation; + public readonly string GamePath; + + public ImcException(ImcManipulation manip, Utf8GamePath path) + { + Manipulation = manip; + GamePath = path.ToString(); + } public override string Message => "Could not obtain default Imc File.\n" + " Either the default file does not exist (possibly for offhand files from TexTools) or the installation is corrupted.\n" + $" Game Path: {GamePath}\n" - + $" Manipulation: {Identifier}"; + + $" Manipulation: {Manipulation}"; } public unsafe class ImcFile : MetaBaseFile @@ -61,9 +65,6 @@ public unsafe class ImcFile : MetaBaseFile return ptr == null ? new ImcEntry() : *ptr; } - public ImcEntry GetEntry(EquipSlot slot, Variant variantIdx) - => GetEntry(PartIndex(slot), variantIdx); - public ImcEntry GetEntry(int partIdx, Variant variantIdx, out bool exists) { var ptr = VariantPtr(Data, partIdx, variantIdx); @@ -141,18 +142,13 @@ public unsafe class ImcFile : MetaBaseFile } } - public ImcFile(MetaFileManager manager, ImcIdentifier identifier) - : this(manager, manager.MarshalAllocator, identifier) - { } - - public ImcFile(MetaFileManager manager, IFileAllocator alloc, ImcIdentifier identifier) - : base(manager, alloc, 0) + public ImcFile(MetaFileManager manager, ImcManipulation manip) + : base(manager, 0) { - var path = identifier.GamePathString(); - Path = Utf8GamePath.FromString(path, out var p) ? p : Utf8GamePath.Empty; - var file = manager.GameData.GetFile(path); + Path = manip.GamePath(); + var file = manager.GameData.GetFile(Path.ToString()); if (file == null) - throw new ImcException(identifier, Path); + throw new ImcException(manip, Path); fixed (byte* ptr = file.Data) { @@ -194,52 +190,16 @@ public unsafe class ImcFile : MetaBaseFile public void Replace(ResourceHandle* resource) { var (data, length) = resource->GetData(); - var actualLength = ActualLength; - - if (DebugConfiguration.WriteImcBytesToLog) - { - Penumbra.Log.Information($"Default IMC file -> Modified IMC File for {Path}, current handle state {resource->LoadState}:"); - Penumbra.Log.Information(new Span((void*)data, length).WriteHexBytes()); - Penumbra.Log.Information(new Span(Data, actualLength).WriteHexBytes()); - Penumbra.Log.Information(new Span(Data, actualLength).WriteHexByteDiff(new Span((void*)data, length))); - } - - if (length >= actualLength) - { - MemoryUtility.MemCpyUnchecked((byte*)data, Data, actualLength); - if (length > actualLength) - MemoryUtility.MemSet((byte*)(data + actualLength), 0, length - actualLength); - if (DebugConfiguration.WriteImcBytesToLog) - { - Penumbra.Log.Information( - $"Copied {actualLength} bytes from local IMC file into {length} available bytes.{(length > actualLength ? $" Filled remaining {length - actualLength} bytes with 0." : string.Empty)}"); - Penumbra.Log.Information("Result IMC Resource Data:"); - Penumbra.Log.Information(new Span((void*)data, length).WriteHexBytes()); - } - - return; - } - - var paddedLength = actualLength.PadToMultiple(128); - var newData = Manager.XivFileAllocator.Allocate(paddedLength, 8); + var newData = Manager.AllocateDefaultMemory(ActualLength, 8); if (newData == null) { Penumbra.Log.Error($"Could not replace loaded IMC data at 0x{(ulong)resource:X}, allocation failed."); return; } - MemoryUtility.MemCpyUnchecked(newData, Data, actualLength); - if (paddedLength > actualLength) - MemoryUtility.MemSet(newData + actualLength, 0, paddedLength - actualLength); - if (DebugConfiguration.WriteImcBytesToLog) - { - Penumbra.Log.Information( - $"Allocated {paddedLength} bytes for IMC file, copied {actualLength} bytes from local IMC file. {(length > actualLength ? $" Filled remaining {length - actualLength} bytes with 0." : string.Empty)}"); - Penumbra.Log.Information("Result IMC Resource Data:"); - Penumbra.Log.Information(new Span(newData, paddedLength).WriteHexBytes()); - } + MemoryUtility.MemCpyUnchecked(newData, Data, ActualLength); - Manager.XivFileAllocator.Release((void*)data, length); - resource->SetData((nint)newData, paddedLength); + Manager.Free(data, length); + resource->SetData((IntPtr)newData, ActualLength); } } diff --git a/Penumbra/Meta/Files/MetaBaseFile.cs b/Penumbra/Meta/Files/MetaBaseFile.cs index d04e1bdf..ab08efc2 100644 --- a/Penumbra/Meta/Files/MetaBaseFile.cs +++ b/Penumbra/Meta/Files/MetaBaseFile.cs @@ -1,106 +1,25 @@ using Dalamud.Memory; -using Dalamud.Plugin.Services; -using Dalamud.Utility.Signatures; -using FFXIVClientStructs.FFXIV.Client.System.Memory; -using OtterGui.Services; -using Penumbra.GameData; using Penumbra.Interop.Structs; using Penumbra.String.Functions; using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; namespace Penumbra.Meta.Files; -public unsafe interface IFileAllocator +public unsafe class MetaBaseFile : IDisposable { - public T* Allocate(int length, int alignment = 1) where T : unmanaged; - public void Release(ref T* pointer, int length) where T : unmanaged; - - public void Release(void* pointer, int length) - { - var tmp = (byte*)pointer; - Release(ref tmp, length); - } - - public byte* Allocate(int length, int alignment = 1) - => Allocate(length, alignment); -} - -public sealed class MarshalAllocator : IFileAllocator -{ - public unsafe T* Allocate(int length, int alignment = 1) where T : unmanaged - { - var ret = (T*)Marshal.AllocHGlobal(length * sizeof(T)); - Penumbra.Log.Verbose($"Allocating {length * sizeof(T)} bytes via Marshal Allocator to 0x{(nint)ret:X}."); - return ret; - } - - public unsafe void Release(ref T* pointer, int length) where T : unmanaged - { - Marshal.FreeHGlobal((nint)pointer); - Penumbra.Log.Verbose($"Freeing {length * sizeof(T)} bytes from 0x{(nint)pointer:X} via Marshal Allocator."); - pointer = null; - } -} - -public sealed unsafe class XivFileAllocator : IFileAllocator, IService -{ - /// - /// Allocate in the games space for file storage. - /// We only need this if using any meta file. - /// - [Signature(Sigs.GetFileSpace)] - private readonly nint _getFileSpaceAddress = nint.Zero; - - public XivFileAllocator(IGameInteropProvider provider) - => provider.InitializeFromAttributes(this); - - public IMemorySpace* GetFileSpace() - => ((delegate* unmanaged)_getFileSpaceAddress)(); - - public T* Allocate(int length, int alignment = 1) where T : unmanaged - { - var ret = (T*)GetFileSpace()->Malloc((ulong)(length * sizeof(T)), (ulong)alignment); - Penumbra.Log.Verbose($"Allocating {length * sizeof(T)} bytes via FFXIV File Allocator to 0x{(nint)ret:X}."); - return ret; - } - - public void Release(ref T* pointer, int length) where T : unmanaged - { - - IMemorySpace.Free(pointer, (ulong)(length * sizeof(T))); - Penumbra.Log.Verbose($"Freeing {length * sizeof(T)} bytes from 0x{(nint)pointer:X} via FFXIV File Allocator."); - pointer = null; - } -} - -public sealed unsafe class XivDefaultAllocator : IFileAllocator, IService -{ - public T* Allocate(int length, int alignment = 1) where T : unmanaged - { - var ret = (T*)IMemorySpace.GetDefaultSpace()->Malloc((ulong)(length * sizeof(T)), (ulong)alignment); - Penumbra.Log.Verbose($"Allocating {length * sizeof(T)} bytes via FFXIV Default Allocator to 0x{(nint)ret:X}."); - return ret; - } - - public void Release(ref T* pointer, int length) where T : unmanaged - { - - IMemorySpace.Free(pointer, (ulong)(length * sizeof(T))); - Penumbra.Log.Verbose($"Freeing {length * sizeof(T)} bytes from 0x{(nint)pointer:X} via FFXIV Default Allocator."); - pointer = null; - } -} - -public unsafe class MetaBaseFile(MetaFileManager manager, IFileAllocator alloc, MetaIndex idx) : IDisposable -{ - protected readonly MetaFileManager Manager = manager; - protected readonly IFileAllocator Allocator = alloc; + protected readonly MetaFileManager Manager; public byte* Data { get; private set; } public int Length { get; private set; } - public CharacterUtility.InternalIndex Index { get; } = CharacterUtility.ReverseIndices[(int)idx]; + public CharacterUtility.InternalIndex Index { get; } - protected (nint Data, int Length) DefaultData + public MetaBaseFile(MetaFileManager manager, MetaIndex idx) + { + Manager = manager; + Index = CharacterUtility.ReverseIndices[(int)idx]; + } + + protected (IntPtr Data, int Length) DefaultData => Manager.CharacterUtility.DefaultResource(Index); /// Reset to default values. @@ -111,7 +30,7 @@ public unsafe class MetaBaseFile(MetaFileManager manager, IFileAllocator alloc, protected void AllocateData(int length) { Length = length; - Data = Allocator.Allocate(length); + Data = (byte*)Manager.AllocateFileMemory(length); if (length > 0) GC.AddMemoryPressure(length); } @@ -119,7 +38,8 @@ public unsafe class MetaBaseFile(MetaFileManager manager, IFileAllocator alloc, /// Free memory. protected void ReleaseUnmanagedResources() { - Allocator.Release(Data, Length); + var ptr = (IntPtr)Data; + MemoryHelper.GameFree(ref ptr, (ulong)Length); if (Length > 0) GC.RemoveMemoryPressure(Length); @@ -133,7 +53,7 @@ public unsafe class MetaBaseFile(MetaFileManager manager, IFileAllocator alloc, if (newLength == Length) return; - var data = Allocator.Allocate(newLength); + var data = (byte*)Manager.AllocateFileMemory((ulong)newLength); if (newLength > Length) { MemoryUtility.MemCpyUnchecked(data, Data, Length); diff --git a/Penumbra/Meta/ImcChecker.cs b/Penumbra/Meta/ImcChecker.cs index a415c9b0..14486e21 100644 --- a/Penumbra/Meta/ImcChecker.cs +++ b/Penumbra/Meta/ImcChecker.cs @@ -4,42 +4,20 @@ using Penumbra.Meta.Manipulations; namespace Penumbra.Meta; -public class ImcChecker +public class ImcChecker(MetaFileManager metaFileManager) { - private static readonly Dictionary VariantCounts = []; - private static MetaFileManager? _dataManager; - private static readonly ConcurrentDictionary GlobalCachedDefaultEntries = []; - - public static int GetVariantCount(ImcIdentifier identifier) - { - lock (VariantCounts) - { - if (VariantCounts.TryGetValue(identifier, out var count)) - return count; - - count = GetFile(identifier)?.Count ?? 0; - VariantCounts[identifier] = count; - - return count; - } - } - public readonly record struct CachedEntry(ImcEntry Entry, bool FileExists, bool VariantExists); - public ImcChecker(MetaFileManager metaFileManager) - => _dataManager = metaFileManager; + private readonly Dictionary _cachedDefaultEntries = new(); - public static CachedEntry GetDefaultEntry(ImcIdentifier identifier, bool storeCache) + public CachedEntry GetDefaultEntry(ImcIdentifier identifier, bool storeCache) { - if (GlobalCachedDefaultEntries.TryGetValue(identifier, out var entry)) + if (_cachedDefaultEntries.TryGetValue(identifier, out var entry)) return entry; - if (_dataManager == null) - return new CachedEntry(default, false, false); - try { - var e = ImcFile.GetDefault(_dataManager, identifier.GamePath(), identifier.EquipSlot, identifier.Variant, out var entryExists); + var e = ImcFile.GetDefault(metaFileManager, identifier.GamePath(), identifier.EquipSlot, identifier.Variant, out var entryExists); entry = new CachedEntry(e, true, entryExists); } catch (Exception) @@ -48,22 +26,11 @@ public class ImcChecker } if (storeCache) - GlobalCachedDefaultEntries.TryAdd(identifier, entry); + _cachedDefaultEntries.Add(identifier, entry); return entry; } - private static ImcFile? GetFile(ImcIdentifier identifier) - { - if (_dataManager == null) - return null; - - try - { - return new ImcFile(_dataManager, identifier); - } - catch - { - return null; - } - } + public CachedEntry GetDefaultEntry(ImcManipulation imcManip, bool storeCache) + => GetDefaultEntry(new ImcIdentifier(imcManip.PrimaryId, imcManip.Variant, imcManip.ObjectType, imcManip.SecondaryId.Id, + imcManip.EquipSlot, imcManip.BodySlot), storeCache); } diff --git a/Penumbra/Meta/Manipulations/AtchIdentifier.cs b/Penumbra/Meta/Manipulations/AtchIdentifier.cs deleted file mode 100644 index c248c48b..00000000 --- a/Penumbra/Meta/Manipulations/AtchIdentifier.cs +++ /dev/null @@ -1,77 +0,0 @@ -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files.AtchStructs; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct AtchIdentifier(AtchType Type, GenderRace GenderRace, ushort EntryIndex) - : IComparable, IMetaIdentifier -{ - public Gender Gender - => GenderRace.Split().Item1; - - public ModelRace Race - => GenderRace.Split().Item2; - - public int CompareTo(AtchIdentifier other) - { - var typeComparison = Type.CompareTo(other.Type); - if (typeComparison != 0) - return typeComparison; - - var genderRaceComparison = GenderRace.CompareTo(other.GenderRace); - if (genderRaceComparison != 0) - return genderRaceComparison; - - return EntryIndex.CompareTo(other.EntryIndex); - } - - public override string ToString() - => $"Atch - {Type.ToAbbreviation()} - {GenderRace.ToName()} - {EntryIndex}"; - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - // Nothing specific - } - - public MetaIndex FileIndex() - => (MetaIndex)(-1); - - public bool Validate() - { - var race = (int)GenderRace / 100; - var remainder = (int)GenderRace - 100 * race; - if (remainder != 1) - return false; - - return race is >= 0 and <= 18; - } - - public JObject AddToJson(JObject jObj) - { - var (gender, race) = GenderRace.Split(); - jObj["Gender"] = gender.ToString(); - jObj["Race"] = race.ToString(); - jObj["Type"] = Type.ToAbbreviation(); - jObj["Index"] = EntryIndex; - return jObj; - } - - public static AtchIdentifier? FromJson(JObject jObj) - { - var gender = jObj["Gender"]?.ToObject() ?? Gender.Unknown; - var race = jObj["Race"]?.ToObject() ?? ModelRace.Unknown; - var type = AtchExtensions.FromString(jObj["Type"]?.ToObject() ?? string.Empty); - var entryIndex = jObj["Index"]?.ToObject() ?? ushort.MaxValue; - if (entryIndex == ushort.MaxValue || type is AtchType.Unknown) - return null; - - var ret = new AtchIdentifier(type, Names.CombinedRace(gender, race), entryIndex); - return ret.Validate() ? ret : null; - } - - MetaManipulationType IMetaIdentifier.Type - => MetaManipulationType.Atch; -} diff --git a/Penumbra/Meta/Manipulations/AtrIdentifier.cs b/Penumbra/Meta/Manipulations/AtrIdentifier.cs deleted file mode 100644 index ca65f6aa..00000000 --- a/Penumbra/Meta/Manipulations/AtrIdentifier.cs +++ /dev/null @@ -1,145 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; -using Penumbra.Meta.Files; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct AtrIdentifier(HumanSlot Slot, PrimaryId? Id, ShapeAttributeString Attribute, GenderRace GenderRaceCondition) - : IComparable, IMetaIdentifier -{ - public int CompareTo(AtrIdentifier other) - { - var slotComparison = Slot.CompareTo(other.Slot); - if (slotComparison is not 0) - return slotComparison; - - if (Id.HasValue) - { - if (other.Id.HasValue) - { - var idComparison = Id.Value.Id.CompareTo(other.Id.Value.Id); - if (idComparison is not 0) - return idComparison; - } - else - { - return -1; - } - } - else if (other.Id.HasValue) - { - return 1; - } - - var genderRaceComparison = GenderRaceCondition.CompareTo(other.GenderRaceCondition); - if (genderRaceComparison is not 0) - return genderRaceComparison; - - return Attribute.CompareTo(other.Attribute); - } - - - public override string ToString() - { - var sb = new StringBuilder(64); - sb.Append("Shp - ") - .Append(Attribute); - if (Slot is HumanSlot.Unknown) - { - sb.Append(" - All Slots & IDs"); - } - else - { - sb.Append(" - ") - .Append(Slot.ToName()) - .Append(" - "); - if (Id.HasValue) - sb.Append(Id.Value.Id); - else - sb.Append("All IDs"); - } - - if (GenderRaceCondition is not GenderRace.Unknown) - sb.Append(" - ").Append(GenderRaceCondition.ToRaceCode()); - - return sb.ToString(); - } - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - // Nothing for now since it depends entirely on the shape key. - } - - public MetaIndex FileIndex() - => (MetaIndex)(-1); - - public bool Validate() - { - if (!Enum.IsDefined(Slot) || Slot is HumanSlot.UnkBonus) - return false; - - if (!ShapeAttributeHashSet.GenderRaceIndices.ContainsKey(GenderRaceCondition)) - return false; - - if (Slot is HumanSlot.Unknown && Id is not null) - return false; - - if (Slot.ToSpecificEnum() is BodySlot && Id is { Id: > byte.MaxValue }) - return false; - - if (Id is { Id: > ExpandedEqpGmpBase.Count - 1 }) - return false; - - return Attribute.ValidateCustomAttributeString(); - } - - public JObject AddToJson(JObject jObj) - { - if (Slot is not HumanSlot.Unknown) - jObj["Slot"] = Slot.ToString(); - if (Id.HasValue) - jObj["Id"] = Id.Value.Id.ToString(); - jObj["Attribute"] = Attribute.ToString(); - if (GenderRaceCondition is not GenderRace.Unknown) - jObj["GenderRaceCondition"] = (uint)GenderRaceCondition; - return jObj; - } - - public static AtrIdentifier? FromJson(JObject jObj) - { - var attribute = jObj["Attribute"]?.ToObject(); - if (attribute is null || !ShapeAttributeString.TryRead(attribute, out var attributeString)) - return null; - - var slot = jObj["Slot"]?.ToObject() ?? HumanSlot.Unknown; - var id = jObj["Id"]?.ToObject(); - var genderRaceCondition = jObj["GenderRaceCondition"]?.ToObject() ?? 0; - var identifier = new AtrIdentifier(slot, id, attributeString, genderRaceCondition); - return identifier.Validate() ? identifier : null; - } - - public MetaManipulationType Type - => MetaManipulationType.Atr; -} - -[JsonConverter(typeof(Converter))] -public readonly record struct AtrEntry(bool Value) -{ - public static readonly AtrEntry True = new(true); - public static readonly AtrEntry False = new(false); - - private class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, AtrEntry value, JsonSerializer serializer) - => serializer.Serialize(writer, value.Value); - - public override AtrEntry ReadJson(JsonReader reader, Type objectType, AtrEntry existingValue, bool hasExistingValue, - JsonSerializer serializer) - => new(serializer.Deserialize(reader)); - } -} diff --git a/Penumbra/Meta/Manipulations/Eqdp.cs b/Penumbra/Meta/Manipulations/Eqdp.cs deleted file mode 100644 index c8423b92..00000000 --- a/Penumbra/Meta/Manipulations/Eqdp.cs +++ /dev/null @@ -1,95 +0,0 @@ -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct EqdpIdentifier(PrimaryId SetId, EquipSlot Slot, GenderRace GenderRace) - : IMetaIdentifier, IComparable -{ - public ModelRace Race - => GenderRace.Split().Item2; - - public Gender Gender - => GenderRace.Split().Item1; - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => identifier.Identify(changedItems, GamePaths.Mdl.Equipment(SetId, GenderRace, Slot)); - - public MetaIndex FileIndex() - => CharacterUtilityData.EqdpIdx(GenderRace, Slot.IsAccessory()); - - public override string ToString() - => $"Eqdp - {SetId} - {Slot.ToName()} - {GenderRace.ToName()}"; - - public bool Validate() - { - var mask = Eqdp.Mask(Slot); - if (mask == 0) - return false; - - if (FileIndex() == (MetaIndex)(-1)) - return false; - - // No check for set id. - return true; - } - - public int CompareTo(EqdpIdentifier other) - { - var gr = GenderRace.CompareTo(other.GenderRace); - if (gr != 0) - return gr; - - var set = SetId.Id.CompareTo(other.SetId.Id); - if (set != 0) - return set; - - return Slot.CompareTo(other.Slot); - } - - public static EqdpIdentifier? FromJson(JObject jObj) - { - var gender = jObj["Gender"]?.ToObject() ?? Gender.Unknown; - var race = jObj["Race"]?.ToObject() ?? ModelRace.Unknown; - var setId = new PrimaryId(jObj["SetId"]?.ToObject() ?? 0); - var slot = jObj["Slot"]?.ToObject() ?? EquipSlot.Unknown; - var ret = new EqdpIdentifier(setId, slot, Names.CombinedRace(gender, race)); - return ret.Validate() ? ret : null; - } - - public JObject AddToJson(JObject jObj) - { - var (gender, race) = GenderRace.Split(); - jObj["Gender"] = gender.ToString(); - jObj["Race"] = race.ToString(); - jObj["SetId"] = SetId.Id.ToString(); - jObj["Slot"] = Slot.ToString(); - return jObj; - } - - public MetaManipulationType Type - => MetaManipulationType.Eqdp; -} - -public readonly record struct EqdpEntryInternal(bool Material, bool Model) -{ - public byte AsByte - => (byte)(Material ? Model ? 3 : 1 : Model ? 2 : 0); - - private EqdpEntryInternal((bool, bool) val) - : this(val.Item1, val.Item2) - { } - - public EqdpEntryInternal(EqdpEntry entry, EquipSlot slot) - : this(entry.ToBits(slot)) - { } - - public EqdpEntry ToEntry(EquipSlot slot) - => Eqdp.FromSlotAndBits(slot, Material, Model); - - public override string ToString() - => $"Material: {Material}, Model: {Model}"; -} diff --git a/Penumbra/Meta/Manipulations/EqdpManipulation.cs b/Penumbra/Meta/Manipulations/EqdpManipulation.cs new file mode 100644 index 00000000..0426dfce --- /dev/null +++ b/Penumbra/Meta/Manipulations/EqdpManipulation.cs @@ -0,0 +1,108 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct EqdpManipulation : IMetaManipulation +{ + public EqdpEntry Entry { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public Gender Gender { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public ModelRace Race { get; private init; } + + public PrimaryId SetId { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public EquipSlot Slot { get; private init; } + + [JsonConstructor] + public EqdpManipulation(EqdpEntry entry, EquipSlot slot, Gender gender, ModelRace race, PrimaryId setId) + { + Gender = gender; + Race = race; + SetId = setId; + Slot = slot; + Entry = Eqdp.Mask(Slot) & entry; + } + + public EqdpManipulation Copy(EqdpManipulation entry) + { + if (entry.Slot != Slot) + { + var (bit1, bit2) = entry.Entry.ToBits(entry.Slot); + return new EqdpManipulation(Eqdp.FromSlotAndBits(Slot, bit1, bit2), Slot, Gender, Race, SetId); + } + + return new EqdpManipulation(entry.Entry, Slot, Gender, Race, SetId); + } + + public EqdpManipulation Copy(EqdpEntry entry) + => new(entry, Slot, Gender, Race, SetId); + + public override string ToString() + => $"Eqdp - {SetId} - {Slot} - {Race.ToName()} - {Gender.ToName()}"; + + public bool Equals(EqdpManipulation other) + => Gender == other.Gender + && Race == other.Race + && SetId == other.SetId + && Slot == other.Slot; + + public override bool Equals(object? obj) + => obj is EqdpManipulation other && Equals(other); + + public override int GetHashCode() + => HashCode.Combine((int)Gender, (int)Race, SetId, (int)Slot); + + public int CompareTo(EqdpManipulation other) + { + var r = Race.CompareTo(other.Race); + if (r != 0) + return r; + + var g = Gender.CompareTo(other.Gender); + if (g != 0) + return g; + + var set = SetId.Id.CompareTo(other.SetId.Id); + return set != 0 ? set : Slot.CompareTo(other.Slot); + } + + public MetaIndex FileIndex() + => CharacterUtilityData.EqdpIdx(Names.CombinedRace(Gender, Race), Slot.IsAccessory()); + + public bool Apply(ExpandedEqdpFile file) + { + var entry = file[SetId]; + var mask = Eqdp.Mask(Slot); + if ((entry & mask) == Entry) + return false; + + file[SetId] = (entry & ~mask) | Entry; + return true; + } + + public bool Validate() + { + var mask = Eqdp.Mask(Slot); + if (mask == 0) + return false; + + if ((mask & Entry) != Entry) + return false; + + if (FileIndex() == (MetaIndex)(-1)) + return false; + + // No check for set id. + return true; + } +} diff --git a/Penumbra/Meta/Manipulations/Eqp.cs b/Penumbra/Meta/Manipulations/Eqp.cs deleted file mode 100644 index 154aca40..00000000 --- a/Penumbra/Meta/Manipulations/Eqp.cs +++ /dev/null @@ -1,78 +0,0 @@ -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct EqpIdentifier(PrimaryId SetId, EquipSlot Slot) : IMetaIdentifier, IComparable -{ - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => identifier.Identify(changedItems, GamePaths.Mdl.Equipment(SetId, GenderRace.MidlanderMale, Slot)); - - public MetaIndex FileIndex() - => MetaIndex.Eqp; - - public override string ToString() - => $"Eqp - {SetId} - {Slot}"; - - public bool Validate() - { - var mask = Eqp.Mask(Slot); - if (mask == 0) - return false; - - // No check for set id. - return true; - } - - public int CompareTo(EqpIdentifier other) - { - var set = SetId.Id.CompareTo(other.SetId.Id); - if (set != 0) - return set; - - return Slot.CompareTo(other.Slot); - } - - public static EqpIdentifier? FromJson(JObject jObj) - { - var setId = new PrimaryId(jObj["SetId"]?.ToObject() ?? 0); - var slot = jObj["Slot"]?.ToObject() ?? EquipSlot.Unknown; - var ret = new EqpIdentifier(setId, slot); - return ret.Validate() ? ret : null; - } - - public JObject AddToJson(JObject jObj) - { - jObj["SetId"] = SetId.Id.ToString(); - jObj["Slot"] = Slot.ToString(); - return jObj; - } - - public MetaManipulationType Type - => MetaManipulationType.Eqp; -} - -public readonly record struct EqpEntryInternal(uint Value) -{ - public EqpEntryInternal(EqpEntry entry, EquipSlot slot) - : this(GetValue(entry, slot)) - { } - - public EqpEntry ToEntry(EquipSlot slot) - { - var (offset, mask) = Eqp.OffsetAndMask(slot); - return (EqpEntry)((ulong)Value << offset) & mask; - } - - private static uint GetValue(EqpEntry entry, EquipSlot slot) - { - var (offset, mask) = Eqp.OffsetAndMask(slot); - return (uint)((ulong)(entry & mask) >> offset); - } - - public override string ToString() - => Value.ToString("X8"); -} diff --git a/Penumbra/Meta/Manipulations/EqpManipulation.cs b/Penumbra/Meta/Manipulations/EqpManipulation.cs new file mode 100644 index 00000000..d59938b6 --- /dev/null +++ b/Penumbra/Meta/Manipulations/EqpManipulation.cs @@ -0,0 +1,79 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; +using Penumbra.Util; +using SharpCompress.Common; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct EqpManipulation : IMetaManipulation +{ + [JsonConverter(typeof(ForceNumericFlagEnumConverter))] + public EqpEntry Entry { get; private init; } + + public PrimaryId SetId { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public EquipSlot Slot { get; private init; } + + [JsonConstructor] + public EqpManipulation(EqpEntry entry, EquipSlot slot, PrimaryId setId) + { + Slot = slot; + SetId = setId; + Entry = Eqp.Mask(slot) & entry; + } + + public EqpManipulation Copy(EqpEntry entry) + => new(entry, Slot, SetId); + + public override string ToString() + => $"Eqp - {SetId} - {Slot}"; + + public bool Equals(EqpManipulation other) + => Slot == other.Slot + && SetId == other.SetId; + + public override bool Equals(object? obj) + => obj is EqpManipulation other && Equals(other); + + public override int GetHashCode() + => HashCode.Combine((int)Slot, SetId); + + public int CompareTo(EqpManipulation other) + { + var set = SetId.Id.CompareTo(other.SetId.Id); + return set != 0 ? set : Slot.CompareTo(other.Slot); + } + + public MetaIndex FileIndex() + => MetaIndex.Eqp; + + public bool Apply(ExpandedEqpFile file) + { + var entry = file[SetId]; + var mask = Eqp.Mask(Slot); + if ((entry & mask) == Entry) + return false; + + file[SetId] = (entry & ~mask) | Entry; + return true; + } + + public bool Validate() + { + var mask = Eqp.Mask(Slot); + if (mask == 0) + return false; + if ((Entry & mask) != Entry) + return false; + + // No check for set id. + + return true; + } +} diff --git a/Penumbra/Meta/Manipulations/Est.cs b/Penumbra/Meta/Manipulations/Est.cs deleted file mode 100644 index 46a275a5..00000000 --- a/Penumbra/Meta/Manipulations/Est.cs +++ /dev/null @@ -1,134 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public enum EstType : byte -{ - Hair = MetaIndex.HairEst, - Face = MetaIndex.FaceEst, - Body = MetaIndex.BodyEst, - Head = MetaIndex.HeadEst, -} - -public readonly record struct EstIdentifier(PrimaryId SetId, EstType Slot, GenderRace GenderRace) - : IMetaIdentifier, IComparable -{ - public ModelRace Race - => GenderRace.Split().Item2; - - public Gender Gender - => GenderRace.Split().Item1; - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - switch (Slot) - { - case EstType.Hair: - { - var (gender, race) = GenderRace.Split(); - var id = (CustomizeValue)SetId.Id; - changedItems.UpdateCountOrSet( - $"Customization: {race.ToName()} {gender.ToName()} Hair {SetId}", () => IdentifiedCustomization.Hair(race, gender, id)); - break; - } - case EstType.Face: - { - var (gender, race) = GenderRace.Split(); - var id = (CustomizeValue)SetId.Id; - changedItems.UpdateCountOrSet( - $"Customization: {race.ToName()} {gender.ToName()} Face {SetId}", - () => IdentifiedCustomization.Face(race, gender, id)); - break; - } - case EstType.Body: identifier.Identify(changedItems, GamePaths.Mdl.Equipment(SetId, GenderRace, EquipSlot.Body)); break; - case EstType.Head: identifier.Identify(changedItems, GamePaths.Mdl.Equipment(SetId, GenderRace, EquipSlot.Head)); break; - } - } - - public MetaIndex FileIndex() - => (MetaIndex)Slot; - - public override string ToString() - => $"Est - {SetId} - {Slot} - {GenderRace.ToName()}"; - - public bool Validate() - { - if (!Enum.IsDefined(Slot)) - return false; - if (GenderRace is GenderRace.Unknown || !Enum.IsDefined(GenderRace)) - return false; - - // No known check for set id. - return true; - } - - public int CompareTo(EstIdentifier other) - { - var gr = GenderRace.CompareTo(other.GenderRace); - if (gr != 0) - return gr; - - var id = SetId.Id.CompareTo(other.SetId.Id); - return id != 0 ? id : Slot.CompareTo(other.Slot); - } - - public static EstIdentifier? FromJson(JObject jObj) - { - var gender = jObj["Gender"]?.ToObject() ?? Gender.Unknown; - var race = jObj["Race"]?.ToObject() ?? ModelRace.Unknown; - var setId = new PrimaryId(jObj["SetId"]?.ToObject() ?? 0); - var slot = jObj["Slot"]?.ToObject() ?? 0; - var ret = new EstIdentifier(setId, slot, Names.CombinedRace(gender, race)); - return ret.Validate() ? ret : null; - } - - public JObject AddToJson(JObject jObj) - { - var (gender, race) = GenderRace.Split(); - jObj["Gender"] = gender.ToString(); - jObj["Race"] = race.ToString(); - jObj["SetId"] = SetId.Id.ToString(); - jObj["Slot"] = Slot.ToString(); - return jObj; - } - - public MetaManipulationType Type - => MetaManipulationType.Est; -} - -[JsonConverter(typeof(Converter))] -public readonly record struct EstEntry(ushort Value) -{ - public static readonly EstEntry Zero = new(0); - - public PrimaryId AsId - => new(Value); - - private class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, EstEntry value, JsonSerializer serializer) - => serializer.Serialize(writer, value.Value); - - public override EstEntry ReadJson(JsonReader reader, Type objectType, EstEntry existingValue, bool hasExistingValue, - JsonSerializer serializer) - => new(serializer.Deserialize(reader)); - } -} - -public static class EstTypeExtension -{ - public static string ToName(this EstType type) - => type switch - { - EstType.Hair => "hair", - EstType.Face => "face", - EstType.Body => "top", - EstType.Head => "met", - _ => "unk", - }; -} diff --git a/Penumbra/Meta/Manipulations/EstManipulation.cs b/Penumbra/Meta/Manipulations/EstManipulation.cs new file mode 100644 index 00000000..d3c92ad3 --- /dev/null +++ b/Penumbra/Meta/Manipulations/EstManipulation.cs @@ -0,0 +1,113 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct EstManipulation : IMetaManipulation +{ + public enum EstType : byte + { + Hair = MetaIndex.HairEst, + Face = MetaIndex.FaceEst, + Body = MetaIndex.BodyEst, + Head = MetaIndex.HeadEst, + } + + public static string ToName(EstType type) + => type switch + { + EstType.Hair => "hair", + EstType.Face => "face", + EstType.Body => "top", + EstType.Head => "met", + _ => "unk", + }; + + public ushort Entry { get; private init; } // SkeletonIdx. + + [JsonConverter(typeof(StringEnumConverter))] + public Gender Gender { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public ModelRace Race { get; private init; } + + public PrimaryId SetId { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public EstType Slot { get; private init; } + + + [JsonConstructor] + public EstManipulation(Gender gender, ModelRace race, EstType slot, PrimaryId setId, ushort entry) + { + Entry = entry; + Gender = gender; + Race = race; + SetId = setId; + Slot = slot; + } + + public EstManipulation Copy(ushort entry) + => new(Gender, Race, Slot, SetId, entry); + + + public override string ToString() + => $"Est - {SetId} - {Slot} - {Race.ToName()} {Gender.ToName()}"; + + public bool Equals(EstManipulation other) + => Gender == other.Gender + && Race == other.Race + && SetId == other.SetId + && Slot == other.Slot; + + public override bool Equals(object? obj) + => obj is EstManipulation other && Equals(other); + + public override int GetHashCode() + => HashCode.Combine((int)Gender, (int)Race, SetId, (int)Slot); + + public int CompareTo(EstManipulation other) + { + var r = Race.CompareTo(other.Race); + if (r != 0) + return r; + + var g = Gender.CompareTo(other.Gender); + if (g != 0) + return g; + + var s = Slot.CompareTo(other.Slot); + return s != 0 ? s : SetId.Id.CompareTo(other.SetId.Id); + } + + public MetaIndex FileIndex() + => (MetaIndex)Slot; + + public bool Apply(EstFile file) + { + return file.SetEntry(Names.CombinedRace(Gender, Race), SetId.Id, Entry) switch + { + EstFile.EstEntryChange.Unchanged => false, + EstFile.EstEntryChange.Changed => true, + EstFile.EstEntryChange.Added => true, + EstFile.EstEntryChange.Removed => true, + _ => throw new ArgumentOutOfRangeException(), + }; + } + + public bool Validate() + { + if (!Enum.IsDefined(Slot)) + return false; + if (Names.CombinedRace(Gender, Race) == GenderRace.Unknown) + return false; + + // No known check for set id or entry. + return true; + } +} diff --git a/Penumbra/Collections/Cache/GlobalEqpCache.cs b/Penumbra/Meta/Manipulations/GlobalEqpCache.cs similarity index 53% rename from Penumbra/Collections/Cache/GlobalEqpCache.cs rename to Penumbra/Meta/Manipulations/GlobalEqpCache.cs index 7d2fbf64..48ffb308 100644 --- a/Penumbra/Collections/Cache/GlobalEqpCache.cs +++ b/Penumbra/Meta/Manipulations/GlobalEqpCache.cs @@ -1,12 +1,9 @@ -using OtterGui.Classes; using OtterGui.Services; using Penumbra.GameData.Structs; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -namespace Penumbra.Collections.Cache; +namespace Penumbra.Meta.Manipulations; -public class GlobalEqpCache : ReadWriteDictionary, IService +public struct GlobalEqpCache : IService { private readonly HashSet _doNotHideEarrings = []; private readonly HashSet _doNotHideNecklace = []; @@ -15,13 +12,12 @@ public class GlobalEqpCache : ReadWriteDictionary, private readonly HashSet _doNotHideRingR = []; private bool _doNotHideVieraHats; private bool _doNotHideHrothgarHats; - private bool _hideAuRaHorns; - private bool _hideVieraEars; - private bool _hideMiqoteEars; - public new void Clear() + public GlobalEqpCache() + { } + + public void Clear() { - base.Clear(); _doNotHideEarrings.Clear(); _doNotHideNecklace.Clear(); _doNotHideBracelets.Clear(); @@ -29,36 +25,18 @@ public class GlobalEqpCache : ReadWriteDictionary, _doNotHideRingR.Clear(); _doNotHideHrothgarHats = false; _doNotHideVieraHats = false; - _hideAuRaHorns = false; - _hideVieraEars = false; - _hideMiqoteEars = false; } public unsafe EqpEntry Apply(EqpEntry original, CharacterArmor* armor) { - if (Count == 0) - return original; - if (_doNotHideVieraHats) original |= EqpEntry.HeadShowVieraHat; if (_doNotHideHrothgarHats) original |= EqpEntry.HeadShowHrothgarHat; - if (_hideAuRaHorns) - original &= ~EqpEntry.HeadShowEarAuRa; - - if (_hideVieraEars) - original &= ~EqpEntry.HeadShowEarViera; - - if (_hideMiqoteEars) - original &= ~EqpEntry.HeadShowEarMiqote; - if (_doNotHideEarrings.Contains(armor[5].Set)) - original |= EqpEntry.HeadShowEarringsHyurRoe - | EqpEntry.HeadShowEarringsLalaElezen - | EqpEntry.HeadShowEarringsMiqoHrothViera - | EqpEntry.HeadShowEarringsAura; + original |= EqpEntry.HeadShowEarrings | EqpEntry.HeadShowEarringsAura | EqpEntry.HeadShowEarringsHuman; if (_doNotHideNecklace.Contains(armor[6].Set)) original |= EqpEntry.BodyShowNecklace | EqpEntry.HeadShowNecklace; @@ -66,22 +44,16 @@ public class GlobalEqpCache : ReadWriteDictionary, if (_doNotHideBracelets.Contains(armor[7].Set)) original |= EqpEntry.BodyShowBracelet | EqpEntry.HandShowBracelet; - if (_doNotHideRingR.Contains(armor[8].Set)) + if (_doNotHideBracelets.Contains(armor[8].Set)) original |= EqpEntry.HandShowRingR; - if (_doNotHideRingL.Contains(armor[9].Set)) + if (_doNotHideBracelets.Contains(armor[9].Set)) original |= EqpEntry.HandShowRingL; - return original; } - public bool ApplyMod(IMod mod, GlobalEqpManipulation manipulation) - { - if (Remove(manipulation, out var oldMod) && oldMod == mod) - return false; - - this[manipulation] = mod; - _ = manipulation.Type switch + public bool Add(GlobalEqpManipulation manipulation) + => manipulation.Type switch { GlobalEqpType.DoNotHideEarrings => _doNotHideEarrings.Add(manipulation.Condition), GlobalEqpType.DoNotHideNecklace => _doNotHideNecklace.Add(manipulation.Condition), @@ -89,21 +61,12 @@ public class GlobalEqpCache : ReadWriteDictionary, GlobalEqpType.DoNotHideRingR => _doNotHideRingR.Add(manipulation.Condition), GlobalEqpType.DoNotHideRingL => _doNotHideRingL.Add(manipulation.Condition), GlobalEqpType.DoNotHideHrothgarHats => !_doNotHideHrothgarHats && (_doNotHideHrothgarHats = true), - GlobalEqpType.DoNotHideVieraHats => !_doNotHideVieraHats && (_doNotHideVieraHats = true), - GlobalEqpType.HideHorns => !_hideAuRaHorns && (_hideAuRaHorns = true), - GlobalEqpType.HideMiqoteEars => !_hideMiqoteEars && (_hideMiqoteEars = true), - GlobalEqpType.HideVieraEars => !_hideVieraEars && (_hideVieraEars = true), - _ => false, + GlobalEqpType.DoNotHideVieraHats => !_doNotHideVieraHats && (_doNotHideVieraHats = true), + _ => false, }; - return true; - } - public bool RevertMod(GlobalEqpManipulation manipulation, [NotNullWhen(true)] out IMod? mod) - { - if (!Remove(manipulation, out mod)) - return false; - - _ = manipulation.Type switch + public bool Remove(GlobalEqpManipulation manipulation) + => manipulation.Type switch { GlobalEqpType.DoNotHideEarrings => _doNotHideEarrings.Remove(manipulation.Condition), GlobalEqpType.DoNotHideNecklace => _doNotHideNecklace.Remove(manipulation.Condition), @@ -111,12 +74,7 @@ public class GlobalEqpCache : ReadWriteDictionary, GlobalEqpType.DoNotHideRingR => _doNotHideRingR.Remove(manipulation.Condition), GlobalEqpType.DoNotHideRingL => _doNotHideRingL.Remove(manipulation.Condition), GlobalEqpType.DoNotHideHrothgarHats => _doNotHideHrothgarHats && !(_doNotHideHrothgarHats = false), - GlobalEqpType.DoNotHideVieraHats => _doNotHideVieraHats && !(_doNotHideVieraHats = false), - GlobalEqpType.HideHorns => _hideAuRaHorns && (_hideAuRaHorns = false), - GlobalEqpType.HideMiqoteEars => _hideMiqoteEars && (_hideMiqoteEars = false), - GlobalEqpType.HideVieraEars => _hideVieraEars && (_hideVieraEars = false), - _ => false, + GlobalEqpType.DoNotHideVieraHats => _doNotHideVieraHats && !(_doNotHideVieraHats = false), + _ => false, }; - return true; - } } diff --git a/Penumbra/Meta/Manipulations/GlobalEqpManipulation.cs b/Penumbra/Meta/Manipulations/GlobalEqpManipulation.cs index 33399a36..ada543dc 100644 --- a/Penumbra/Meta/Manipulations/GlobalEqpManipulation.cs +++ b/Penumbra/Meta/Manipulations/GlobalEqpManipulation.cs @@ -1,12 +1,9 @@ -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; using Penumbra.Interop.Structs; namespace Penumbra.Meta.Manipulations; -public readonly struct GlobalEqpManipulation : IMetaIdentifier +public readonly struct GlobalEqpManipulation : IMetaManipulation { public GlobalEqpType Type { get; init; } public PrimaryId Condition { get; init; } @@ -16,32 +13,10 @@ public readonly struct GlobalEqpManipulation : IMetaIdentifier if (!Enum.IsDefined(Type)) return false; - if (Type.HasCondition()) - return Condition.Id is not 0; + if (Type is GlobalEqpType.DoNotHideVieraHats or GlobalEqpType.DoNotHideHrothgarHats) + return Condition == 0; - return Condition.Id is 0; - } - - public JObject AddToJson(JObject jObj) - { - jObj[nameof(Type)] = Type.ToString(); - jObj[nameof(Condition)] = Condition.Id; - return jObj; - } - - public static GlobalEqpManipulation? FromJson(JObject? jObj) - { - if (jObj == null) - return null; - - var type = jObj[nameof(Type)]?.ToObject() ?? (GlobalEqpType)100; - var condition = jObj[nameof(Condition)]?.ToObject() ?? 0; - var ret = new GlobalEqpManipulation - { - Type = type, - Condition = condition, - }; - return ret.Validate() ? ret : null; + return Condition != 0; } @@ -70,36 +45,6 @@ public readonly struct GlobalEqpManipulation : IMetaIdentifier public override string ToString() => $"Global EQP - {Type}{(Condition != 0 ? $" - {Condition.Id}" : string.Empty)}"; - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - var path = Type switch - { - GlobalEqpType.DoNotHideEarrings => GamePaths.Mdl.Accessory(Condition, GenderRace.MidlanderMale, EquipSlot.Ears), - GlobalEqpType.DoNotHideNecklace => GamePaths.Mdl.Accessory(Condition, GenderRace.MidlanderMale, EquipSlot.Neck), - GlobalEqpType.DoNotHideBracelets => GamePaths.Mdl.Accessory(Condition, GenderRace.MidlanderMale, EquipSlot.Wrists), - GlobalEqpType.DoNotHideRingR => GamePaths.Mdl.Accessory(Condition, GenderRace.MidlanderMale, EquipSlot.RFinger), - GlobalEqpType.DoNotHideRingL => GamePaths.Mdl.Accessory(Condition, GenderRace.MidlanderMale, EquipSlot.LFinger), - GlobalEqpType.DoNotHideHrothgarHats => string.Empty, - GlobalEqpType.DoNotHideVieraHats => string.Empty, - _ => string.Empty, - }; - if (path.Length > 0) - identifier.Identify(changedItems, path); - else if (Type is GlobalEqpType.DoNotHideVieraHats) - changedItems.UpdateCountOrSet("All Hats for Viera", () => new IdentifiedName()); - else if (Type is GlobalEqpType.DoNotHideHrothgarHats) - changedItems.UpdateCountOrSet("All Hats for Hrothgar", () => new IdentifiedName()); - else if (Type is GlobalEqpType.HideHorns) - changedItems.UpdateCountOrSet("All Au Ra Horns", () => new IdentifiedName()); - else if (Type is GlobalEqpType.HideVieraEars) - changedItems.UpdateCountOrSet("All Viera Ears", () => new IdentifiedName()); - else if (Type is GlobalEqpType.HideMiqoteEars) - changedItems.UpdateCountOrSet("All Miqo'te Ears", () => new IdentifiedName()); - } - public MetaIndex FileIndex() - => MetaIndex.Eqp; - - MetaManipulationType IMetaIdentifier.Type - => MetaManipulationType.GlobalEqp; + => (MetaIndex)(-1); } diff --git a/Penumbra/Meta/Manipulations/GlobalEqpType.cs b/Penumbra/Meta/Manipulations/GlobalEqpType.cs index 29bfe825..d57af1d9 100644 --- a/Penumbra/Meta/Manipulations/GlobalEqpType.cs +++ b/Penumbra/Meta/Manipulations/GlobalEqpType.cs @@ -1,9 +1,5 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; - namespace Penumbra.Meta.Manipulations; -[JsonConverter(typeof(StringEnumConverter))] public enum GlobalEqpType { DoNotHideEarrings, @@ -13,9 +9,6 @@ public enum GlobalEqpType DoNotHideRingL, DoNotHideHrothgarHats, DoNotHideVieraHats, - HideHorns, - HideVieraEars, - HideMiqoteEars, } public static class GlobalEqpExtensions @@ -30,9 +23,6 @@ public static class GlobalEqpExtensions GlobalEqpType.DoNotHideRingL => true, GlobalEqpType.DoNotHideHrothgarHats => false, GlobalEqpType.DoNotHideVieraHats => false, - GlobalEqpType.HideHorns => false, - GlobalEqpType.HideVieraEars => false, - GlobalEqpType.HideMiqoteEars => false, _ => false, }; @@ -47,9 +37,6 @@ public static class GlobalEqpExtensions GlobalEqpType.DoNotHideRingL => "Always Show Rings (Left Finger)"u8, GlobalEqpType.DoNotHideHrothgarHats => "Always Show Hats for Hrothgar"u8, GlobalEqpType.DoNotHideVieraHats => "Always Show Hats for Viera"u8, - GlobalEqpType.HideHorns => "Always Hide Horns (Au Ra)"u8, - GlobalEqpType.HideVieraEars => "Always Hide Ears (Viera)"u8, - GlobalEqpType.HideMiqoteEars => "Always Hide Ears (Miqo'te)"u8, _ => "\0"u8, }; @@ -69,9 +56,6 @@ public static class GlobalEqpExtensions "Prevents the game from hiding any hats for Hrothgar that are normally flagged to not display on them."u8, GlobalEqpType.DoNotHideVieraHats => "Prevents the game from hiding any hats for Viera that are normally flagged to not display on them."u8, - GlobalEqpType.HideHorns => "Forces the game to hide Au Ra horns regardless of headwear."u8, - GlobalEqpType.HideVieraEars => "Forces the game to hide Viera ears regardless of headwear."u8, - GlobalEqpType.HideMiqoteEars => "Forces the game to hide Miqo'te ears regardless of headwear."u8, - _ => "\0"u8, + _ => "\0"u8, }; } diff --git a/Penumbra/Meta/Manipulations/Gmp.cs b/Penumbra/Meta/Manipulations/Gmp.cs deleted file mode 100644 index 5bc81f26..00000000 --- a/Penumbra/Meta/Manipulations/Gmp.cs +++ /dev/null @@ -1,42 +0,0 @@ -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct GmpIdentifier(PrimaryId SetId) : IMetaIdentifier, IComparable -{ - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => identifier.Identify(changedItems, GamePaths.Mdl.Equipment(SetId, GenderRace.MidlanderMale, EquipSlot.Head)); - - public MetaIndex FileIndex() - => MetaIndex.Gmp; - - public override string ToString() - => $"Gmp - {SetId}"; - - public bool Validate() - // No known conditions. - => true; - - public int CompareTo(GmpIdentifier other) - => SetId.Id.CompareTo(other.SetId.Id); - - public static GmpIdentifier? FromJson(JObject jObj) - { - var setId = new PrimaryId(jObj["SetId"]?.ToObject() ?? 0); - var ret = new GmpIdentifier(setId); - return ret.Validate() ? ret : null; - } - - public JObject AddToJson(JObject jObj) - { - jObj["SetId"] = SetId.Id.ToString(); - return jObj; - } - - public MetaManipulationType Type - => MetaManipulationType.Gmp; -} diff --git a/Penumbra/Meta/Manipulations/GmpManipulation.cs b/Penumbra/Meta/Manipulations/GmpManipulation.cs new file mode 100644 index 00000000..ee58295d --- /dev/null +++ b/Penumbra/Meta/Manipulations/GmpManipulation.cs @@ -0,0 +1,55 @@ +using Newtonsoft.Json; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct GmpManipulation : IMetaManipulation +{ + public GmpEntry Entry { get; private init; } + public PrimaryId SetId { get; private init; } + + [JsonConstructor] + public GmpManipulation(GmpEntry entry, PrimaryId setId) + { + Entry = entry; + SetId = setId; + } + + public GmpManipulation Copy(GmpEntry entry) + => new(entry, SetId); + + public override string ToString() + => $"Gmp - {SetId}"; + + public bool Equals(GmpManipulation other) + => SetId == other.SetId; + + public override bool Equals(object? obj) + => obj is GmpManipulation other && Equals(other); + + public override int GetHashCode() + => SetId.GetHashCode(); + + public int CompareTo(GmpManipulation other) + => SetId.Id.CompareTo(other.SetId.Id); + + public MetaIndex FileIndex() + => MetaIndex.Gmp; + + public bool Apply(ExpandedGmpFile file) + { + var entry = file[SetId]; + if (entry == Entry) + return false; + + file[SetId] = Entry; + return true; + } + + public bool Validate() + // No known conditions. + => true; +} diff --git a/Penumbra/Meta/Manipulations/IMetaIdentifier.cs b/Penumbra/Meta/Manipulations/IMetaIdentifier.cs index 922825c3..4ad6bd3d 100644 --- a/Penumbra/Meta/Manipulations/IMetaIdentifier.cs +++ b/Penumbra/Meta/Manipulations/IMetaIdentifier.cs @@ -4,32 +4,13 @@ using Penumbra.Interop.Structs; namespace Penumbra.Meta.Manipulations; -public enum MetaManipulationType : byte -{ - Unknown = 0, - Imc = 1, - Eqdp = 2, - Eqp = 3, - Est = 4, - Gmp = 5, - Rsp = 6, - GlobalEqp = 7, - Atch = 8, - Shp = 9, - Atr = 10, -} - public interface IMetaIdentifier { - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems); + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems); public MetaIndex FileIndex(); public bool Validate(); public JObject AddToJson(JObject jObj); - - public MetaManipulationType Type { get; } - - public string ToString(); } diff --git a/Penumbra/Meta/Manipulations/Imc.cs b/Penumbra/Meta/Manipulations/Imc.cs index fa726708..fef86520 100644 --- a/Penumbra/Meta/Manipulations/Imc.cs +++ b/Penumbra/Meta/Manipulations/Imc.cs @@ -27,21 +27,20 @@ public readonly record struct ImcIdentifier( : this(primaryId, variant, slot.IsAccessory() ? ObjectType.Accessory : ObjectType.Equipment, 0, slot, BodySlot.Unknown) { } - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => AddChangedItems(identifier, changedItems, false); + public ImcManipulation ToManipulation(ImcEntry entry) + => new(ObjectType, BodySlot, PrimaryId, SecondaryId.Id, Variant.Id, EquipSlot, entry); - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems, bool allVariants) + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) { var path = ObjectType switch { - ObjectType.Equipment when allVariants => GamePaths.Mdl.Equipment(PrimaryId, GenderRace.MidlanderMale, EquipSlot), - ObjectType.Equipment => GamePaths.Mtrl.Equipment(PrimaryId, GenderRace.MidlanderMale, EquipSlot, Variant, "a"), - ObjectType.Accessory when allVariants => GamePaths.Mdl.Accessory(PrimaryId, GenderRace.MidlanderMale, EquipSlot), - ObjectType.Accessory => GamePaths.Mtrl.Accessory(PrimaryId, GenderRace.MidlanderMale, EquipSlot, Variant, "a"), - ObjectType.Weapon => GamePaths.Mtrl.Weapon(PrimaryId, SecondaryId.Id, Variant, "a"), - ObjectType.DemiHuman => GamePaths.Mtrl.DemiHuman(PrimaryId, SecondaryId.Id, EquipSlot, Variant, + ObjectType.Equipment or ObjectType.Accessory => GamePaths.Equipment.Mtrl.Path(PrimaryId, GenderRace.MidlanderMale, EquipSlot, + Variant, "a"), - ObjectType.Monster => GamePaths.Mtrl.Monster(PrimaryId, SecondaryId.Id, Variant, "a"), + ObjectType.Weapon => GamePaths.Weapon.Mtrl.Path(PrimaryId, SecondaryId.Id, Variant, "a"), + ObjectType.DemiHuman => GamePaths.DemiHuman.Mtrl.Path(PrimaryId, SecondaryId.Id, EquipSlot, Variant, + "a"), + ObjectType.Monster => GamePaths.Monster.Mtrl.Path(PrimaryId, SecondaryId.Id, Variant, "a"), _ => string.Empty, }; if (path.Length == 0) @@ -50,23 +49,32 @@ public readonly record struct ImcIdentifier( identifier.Identify(changedItems, path); } - public string GamePathString() - => GamePaths.Imc.Path(ObjectType, PrimaryId, SecondaryId); - public Utf8GamePath GamePath() - => Utf8GamePath.FromString(GamePathString(), out var p) ? p : Utf8GamePath.Empty; + { + return ObjectType switch + { + ObjectType.Accessory => Utf8GamePath.FromString(GamePaths.Accessory.Imc.Path(PrimaryId), out var p) ? p : Utf8GamePath.Empty, + ObjectType.Equipment => Utf8GamePath.FromString(GamePaths.Equipment.Imc.Path(PrimaryId), out var p) ? p : Utf8GamePath.Empty, + ObjectType.DemiHuman => Utf8GamePath.FromString(GamePaths.DemiHuman.Imc.Path(PrimaryId, SecondaryId.Id), out var p) + ? p + : Utf8GamePath.Empty, + ObjectType.Monster => Utf8GamePath.FromString(GamePaths.Monster.Imc.Path(PrimaryId, SecondaryId.Id), out var p) + ? p + : Utf8GamePath.Empty, + ObjectType.Weapon => Utf8GamePath.FromString(GamePaths.Weapon.Imc.Path(PrimaryId, SecondaryId.Id), out var p) + ? p + : Utf8GamePath.Empty, + _ => throw new NotImplementedException(), + }; + } public MetaIndex FileIndex() => (MetaIndex)(-1); public override string ToString() - => ObjectType switch - { - ObjectType.Equipment or ObjectType.Accessory => $"Imc - {PrimaryId} - {EquipSlot.ToName()} - {Variant}", - ObjectType.DemiHuman => $"Imc - {PrimaryId} - DemiHuman - {SecondaryId} - {EquipSlot.ToName()} - {Variant}", - _ => $"Imc - {PrimaryId} - {ObjectType.ToName()} - {SecondaryId} - {BodySlot} - {Variant}", - }; - + => ObjectType is ObjectType.Equipment or ObjectType.Accessory + ? $"Imc - {PrimaryId} - {EquipSlot.ToName()} - {Variant}" + : $"Imc - {PrimaryId} - {ObjectType.ToName()} - {SecondaryId} - {BodySlot} - {Variant}"; public bool Validate() { @@ -96,8 +104,6 @@ public readonly record struct ImcIdentifier( return false; if (!Enum.IsDefined(ObjectType)) return false; - if (ItemData.AdaptOffhandImc(PrimaryId, out _)) - return false; break; } @@ -160,7 +166,7 @@ public readonly record struct ImcIdentifier( case ObjectType.DemiHuman: { var secondaryId = new SecondaryId(jObj["SecondaryId"]?.ToObject() ?? 0); - var slot = jObj["EquipSlot"]?.ToObject() ?? EquipSlot.Unknown; + var slot = jObj["Slot"]?.ToObject() ?? EquipSlot.Unknown; ret = new ImcIdentifier(primaryId, (Variant)variant, objectType, secondaryId, slot, BodySlot.Unknown); break; } @@ -188,7 +194,4 @@ public readonly record struct ImcIdentifier( jObj["BodySlot"] = BodySlot.ToString(); return jObj; } - - public MetaManipulationType Type - => MetaManipulationType.Imc; } diff --git a/Penumbra/Meta/Manipulations/ImcManipulation.cs b/Penumbra/Meta/Manipulations/ImcManipulation.cs new file mode 100644 index 00000000..eb3720c9 --- /dev/null +++ b/Penumbra/Meta/Manipulations/ImcManipulation.cs @@ -0,0 +1,109 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.GameData.Data; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; +using Penumbra.String.Classes; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct ImcManipulation : IMetaManipulation +{ + [JsonIgnore] + public ImcIdentifier Identifier { get; private init; } + + public ImcEntry Entry { get; private init; } + + + public PrimaryId PrimaryId + => Identifier.PrimaryId; + + public SecondaryId SecondaryId + => Identifier.SecondaryId; + + public Variant Variant + => Identifier.Variant; + + [JsonConverter(typeof(StringEnumConverter))] + public ObjectType ObjectType + => Identifier.ObjectType; + + [JsonConverter(typeof(StringEnumConverter))] + public EquipSlot EquipSlot + => Identifier.EquipSlot; + + [JsonConverter(typeof(StringEnumConverter))] + public BodySlot BodySlot + => Identifier.BodySlot; + + public ImcManipulation(EquipSlot equipSlot, ushort variant, PrimaryId primaryId, ImcEntry entry) + : this(new ImcIdentifier(equipSlot, primaryId, variant), entry) + { } + + public ImcManipulation(ImcIdentifier identifier, ImcEntry entry) + { + Identifier = identifier; + Entry = entry; + } + + + // Variants were initially ushorts but got shortened to bytes. + // There are still some manipulations around that have values > 255 for variant, + // so we change the unused value to something nonsensical in that case, just so they do not compare equal, + // and clamp the variant to 255. + [JsonConstructor] + internal ImcManipulation(ObjectType objectType, BodySlot bodySlot, PrimaryId primaryId, SecondaryId secondaryId, ushort variant, + EquipSlot equipSlot, ImcEntry entry) + { + Entry = entry; + var v = (Variant)Math.Clamp(variant, (ushort)0, byte.MaxValue); + Identifier = objectType switch + { + ObjectType.Accessory or ObjectType.Equipment => new ImcIdentifier(primaryId, v, objectType, 0, equipSlot, + variant > byte.MaxValue ? BodySlot.Body : BodySlot.Unknown), + ObjectType.DemiHuman => new ImcIdentifier(primaryId, v, objectType, secondaryId, equipSlot, variant > byte.MaxValue ? BodySlot.Body : BodySlot.Unknown), + _ => new ImcIdentifier(primaryId, v, objectType, secondaryId, equipSlot, bodySlot == BodySlot.Unknown ? BodySlot.Body : BodySlot.Unknown), + }; + } + + public ImcManipulation Copy(ImcEntry entry) + => new(Identifier, entry); + + public override string ToString() + => Identifier.ToString(); + + public bool Equals(ImcManipulation other) + => Identifier == other.Identifier; + + public override bool Equals(object? obj) + => obj is ImcManipulation other && Equals(other); + + public override int GetHashCode() + => Identifier.GetHashCode(); + + public int CompareTo(ImcManipulation other) + => Identifier.CompareTo(other.Identifier); + + public MetaIndex FileIndex() + => Identifier.FileIndex(); + + public Utf8GamePath GamePath() + => Identifier.GamePath(); + + public bool Apply(ImcFile file) + => file.SetEntry(ImcFile.PartIndex(EquipSlot), Variant.Id, Entry); + + public bool Validate(bool withMaterial) + { + if (!Identifier.Validate()) + return false; + + if (withMaterial && Entry.MaterialId == 0) + return false; + + return true; + } +} diff --git a/Penumbra/Meta/Manipulations/MetaDictionary.cs b/Penumbra/Meta/Manipulations/MetaDictionary.cs deleted file mode 100644 index 8b448ec6..00000000 --- a/Penumbra/Meta/Manipulations/MetaDictionary.cs +++ /dev/null @@ -1,1119 +0,0 @@ -using System.Collections.Frozen; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files.AtchStructs; -using Penumbra.GameData.Interop; -using Penumbra.GameData.Structs; -using Penumbra.Util; -using ImcEntry = Penumbra.GameData.Structs.ImcEntry; - -namespace Penumbra.Meta.Manipulations; - -[JsonConverter(typeof(Converter))] -public class MetaDictionary -{ - private class Wrapper : HashSet - { - public readonly Dictionary Imc = []; - public readonly Dictionary Eqp = []; - public readonly Dictionary Eqdp = []; - public readonly Dictionary Est = []; - public readonly Dictionary Rsp = []; - public readonly Dictionary Gmp = []; - public readonly Dictionary Atch = []; - public readonly Dictionary Shp = []; - public readonly Dictionary Atr = []; - - public Wrapper() - { } - - public Wrapper(MetaCache cache) - { - Imc = cache.Imc.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Eqp = cache.Eqp.ToDictionary(kvp => kvp.Key, kvp => new EqpEntryInternal(kvp.Value.Entry, kvp.Key.Slot)); - Eqdp = cache.Eqdp.ToDictionary(kvp => kvp.Key, kvp => new EqdpEntryInternal(kvp.Value.Entry, kvp.Key.Slot)); - Est = cache.Est.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Gmp = cache.Gmp.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Rsp = cache.Rsp.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Atch = cache.Atch.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Shp = cache.Shp.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - Atr = cache.Atr.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Entry); - foreach (var geqp in cache.GlobalEqp.Keys) - Add(geqp); - } - - public static unsafe Wrapper Filtered(MetaCache cache, Actor actor) - { - if (!actor.IsCharacter) - return new Wrapper(cache); - - var model = actor.Model; - if (!model.IsHuman) - return new Wrapper(cache); - - var headId = model.GetModelId(HumanSlot.Head); - var bodyId = model.GetModelId(HumanSlot.Body); - var equipIdSet = ((IEnumerable) - [ - headId, - bodyId, - model.GetModelId(HumanSlot.Hands), - model.GetModelId(HumanSlot.Legs), - model.GetModelId(HumanSlot.Feet), - ]).ToFrozenSet(); - var earsId = model.GetModelId(HumanSlot.Ears); - var neckId = model.GetModelId(HumanSlot.Neck); - var wristId = model.GetModelId(HumanSlot.Wrists); - var rFingerId = model.GetModelId(HumanSlot.RFinger); - var lFingerId = model.GetModelId(HumanSlot.LFinger); - - var wrapper = new Wrapper(); - // Check for all relevant primary IDs due to slot overlap. - foreach (var (eqp, value) in cache.Eqp) - { - if (eqp.Slot.IsEquipment()) - { - if (equipIdSet.Contains(eqp.SetId)) - wrapper.Eqp.Add(eqp, new EqpEntryInternal(value.Entry, eqp.Slot)); - } - else - { - switch (eqp.Slot) - { - case EquipSlot.Ears when eqp.SetId == earsId: - case EquipSlot.Neck when eqp.SetId == neckId: - case EquipSlot.Wrists when eqp.SetId == wristId: - case EquipSlot.RFinger when eqp.SetId == rFingerId: - case EquipSlot.LFinger when eqp.SetId == lFingerId: - wrapper.Eqp.Add(eqp, new EqpEntryInternal(value.Entry, eqp.Slot)); - break; - } - } - } - - // Check also for body IDs due to body occupying head. - foreach (var (gmp, value) in cache.Gmp) - { - if (gmp.SetId == headId || gmp.SetId == bodyId) - wrapper.Gmp.Add(gmp, value.Entry); - } - - // Check for all races due to inheritance and all slots due to overlap. - foreach (var (eqdp, value) in cache.Eqdp) - { - if (eqdp.Slot.IsEquipment()) - { - if (equipIdSet.Contains(eqdp.SetId)) - wrapper.Eqdp.Add(eqdp, new EqdpEntryInternal(value.Entry, eqdp.Slot)); - } - else - { - switch (eqdp.Slot) - { - case EquipSlot.Ears when eqdp.SetId == earsId: - case EquipSlot.Neck when eqdp.SetId == neckId: - case EquipSlot.Wrists when eqdp.SetId == wristId: - case EquipSlot.RFinger when eqdp.SetId == rFingerId: - case EquipSlot.LFinger when eqdp.SetId == lFingerId: - wrapper.Eqdp.Add(eqdp, new EqdpEntryInternal(value.Entry, eqdp.Slot)); - break; - } - } - } - - var genderRace = (GenderRace)model.AsHuman->RaceSexId; - var hairId = model.GetModelId(HumanSlot.Hair); - var faceId = model.GetModelId(HumanSlot.Face); - // We do not need to care for racial inheritance for ESTs. - foreach (var (est, value) in cache.Est) - { - switch (est.Slot) - { - case EstType.Hair when est.SetId == hairId && est.GenderRace == genderRace: - case EstType.Face when est.SetId == faceId && est.GenderRace == genderRace: - case EstType.Body when est.SetId == bodyId && est.GenderRace == genderRace: - case EstType.Head when (est.SetId == headId || est.SetId == bodyId) && est.GenderRace == genderRace: - wrapper.Est.Add(est, value.Entry); - break; - } - } - - foreach (var (geqp, _) in cache.GlobalEqp) - { - switch (geqp.Type) - { - case GlobalEqpType.DoNotHideEarrings when geqp.Condition != earsId: - case GlobalEqpType.DoNotHideNecklace when geqp.Condition != neckId: - case GlobalEqpType.DoNotHideBracelets when geqp.Condition != wristId: - case GlobalEqpType.DoNotHideRingR when geqp.Condition != rFingerId: - case GlobalEqpType.DoNotHideRingL when geqp.Condition != lFingerId: - continue; - default: wrapper.Add(geqp); break; - } - } - - var (_, _, main, off) = model.GetWeapons(actor); - foreach (var (imc, value) in cache.Imc) - { - switch (imc.ObjectType) - { - case ObjectType.Equipment when equipIdSet.Contains(imc.PrimaryId): wrapper.Imc.Add(imc, value.Entry); break; - - case ObjectType.Weapon: - if (imc.PrimaryId == main.Skeleton && imc.SecondaryId == main.Weapon) - wrapper.Imc.Add(imc, value.Entry); - else if (imc.PrimaryId == off.Skeleton && imc.SecondaryId == off.Weapon) - wrapper.Imc.Add(imc, value.Entry); - break; - case ObjectType.Accessory: - switch (imc.EquipSlot) - { - case EquipSlot.Ears when imc.PrimaryId == earsId: - case EquipSlot.Neck when imc.PrimaryId == neckId: - case EquipSlot.Wrists when imc.PrimaryId == wristId: - case EquipSlot.RFinger when imc.PrimaryId == rFingerId: - case EquipSlot.LFinger when imc.PrimaryId == lFingerId: - wrapper.Imc.Add(imc, value.Entry); - break; - } - - break; - } - } - - var subRace = (SubRace)model.AsHuman->Customize[4]; - foreach (var (rsp, value) in cache.Rsp) - { - if (rsp.SubRace == subRace) - wrapper.Rsp.Add(rsp, value.Entry); - } - - // Keep all atch, atr and shp. - wrapper.Atch.EnsureCapacity(cache.Atch.Count); - wrapper.Shp.EnsureCapacity(cache.Shp.Count); - wrapper.Atr.EnsureCapacity(cache.Atr.Count); - foreach (var (atch, value) in cache.Atch) - wrapper.Atch.Add(atch, value.Entry); - foreach (var (shp, value) in cache.Shp) - wrapper.Shp.Add(shp, value.Entry); - foreach (var (atr, value) in cache.Atr) - wrapper.Atr.Add(atr, value.Entry); - return wrapper; - } - } - - private Wrapper? _data; - - public IReadOnlyDictionary Imc - => _data?.Imc ?? []; - - public IReadOnlyDictionary Eqp - => _data?.Eqp ?? []; - - public IReadOnlyDictionary Eqdp - => _data?.Eqdp ?? []; - - public IReadOnlyDictionary Est - => _data?.Est ?? []; - - public IReadOnlyDictionary Gmp - => _data?.Gmp ?? []; - - public IReadOnlyDictionary Rsp - => _data?.Rsp ?? []; - - public IReadOnlyDictionary Atch - => _data?.Atch ?? []; - - public IReadOnlyDictionary Shp - => _data?.Shp ?? []; - - public IReadOnlyDictionary Atr - => _data?.Atr ?? []; - - public IReadOnlySet GlobalEqp - => _data ?? []; - - public int Count { get; private set; } - - public int GetCount(MetaManipulationType type) - => _data is null - ? 0 - : type switch - { - MetaManipulationType.Imc => _data.Imc.Count, - MetaManipulationType.Eqdp => _data.Eqdp.Count, - MetaManipulationType.Eqp => _data.Eqp.Count, - MetaManipulationType.Est => _data.Est.Count, - MetaManipulationType.Gmp => _data.Gmp.Count, - MetaManipulationType.Rsp => _data.Rsp.Count, - MetaManipulationType.Atch => _data.Atch.Count, - MetaManipulationType.Shp => _data.Shp.Count, - MetaManipulationType.Atr => _data.Atr.Count, - MetaManipulationType.GlobalEqp => _data.Count, - _ => 0, - }; - - public bool Contains(IMetaIdentifier identifier) - => _data is not null - && identifier switch - { - EqdpIdentifier i => _data.Eqdp.ContainsKey(i), - EqpIdentifier i => _data.Eqp.ContainsKey(i), - EstIdentifier i => _data.Est.ContainsKey(i), - GlobalEqpManipulation i => _data.Contains(i), - GmpIdentifier i => _data.Gmp.ContainsKey(i), - ImcIdentifier i => _data.Imc.ContainsKey(i), - AtchIdentifier i => _data.Atch.ContainsKey(i), - ShpIdentifier i => _data.Shp.ContainsKey(i), - AtrIdentifier i => _data.Atr.ContainsKey(i), - RspIdentifier i => _data.Rsp.ContainsKey(i), - _ => false, - }; - - public void Clear() - { - _data = null; - Count = 0; - } - - public void ClearForDefault() - { - if (_data is null) - return; - - if (_data.Count is 0 && Shp.Count is 0 && Atr.Count is 0) - { - _data = null; - Count = 0; - return; - } - - Count = GlobalEqp.Count + Shp.Count + Atr.Count; - _data!.Imc.Clear(); - _data!.Eqp.Clear(); - _data!.Eqdp.Clear(); - _data!.Est.Clear(); - _data!.Rsp.Clear(); - _data!.Gmp.Clear(); - _data!.Atch.Clear(); - } - - public bool Equals(MetaDictionary other) - { - if (Count != other.Count) - return false; - - if (_data is null) - return true; - - return _data.Imc.SetEquals(other._data!.Imc) - && _data.Eqp.SetEquals(other._data!.Eqp) - && _data.Eqdp.SetEquals(other._data!.Eqdp) - && _data.Est.SetEquals(other._data!.Est) - && _data.Rsp.SetEquals(other._data!.Rsp) - && _data.Gmp.SetEquals(other._data!.Gmp) - && _data.Atch.SetEquals(other._data!.Atch) - && _data.Shp.SetEquals(other._data!.Shp) - && _data.Atr.SetEquals(other._data!.Atr) - && _data.SetEquals(other._data!); - } - - public IEnumerable Identifiers - => _data is null - ? [] - : _data.Imc.Keys.Cast() - .Concat(_data!.Eqdp.Keys.Cast()) - .Concat(_data!.Eqp.Keys.Cast()) - .Concat(_data!.Est.Keys.Cast()) - .Concat(_data!.Gmp.Keys.Cast()) - .Concat(_data!.Rsp.Keys.Cast()) - .Concat(_data!.Atch.Keys.Cast()) - .Concat(_data!.Shp.Keys.Cast()) - .Concat(_data!.Atr.Keys.Cast()) - .Concat(_data!.Cast()); - - #region TryAdd - - public bool TryAdd(ImcIdentifier identifier, ImcEntry entry) - { - _data ??= []; - if (!_data!.Imc.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(EqpIdentifier identifier, EqpEntryInternal entry) - { - _data ??= []; - if (!_data!.Eqp.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(EqpIdentifier identifier, EqpEntry entry) - => TryAdd(identifier, new EqpEntryInternal(entry, identifier.Slot)); - - public bool TryAdd(EqdpIdentifier identifier, EqdpEntryInternal entry) - { - _data ??= []; - if (!_data!.Eqdp.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(EqdpIdentifier identifier, EqdpEntry entry) - => TryAdd(identifier, new EqdpEntryInternal(entry, identifier.Slot)); - - public bool TryAdd(EstIdentifier identifier, EstEntry entry) - { - _data ??= []; - if (!_data!.Est.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(GmpIdentifier identifier, GmpEntry entry) - { - _data ??= []; - if (!_data!.Gmp.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(RspIdentifier identifier, RspEntry entry) - { - _data ??= []; - if (!_data!.Rsp.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(AtchIdentifier identifier, in AtchEntry entry) - { - _data ??= []; - if (!_data!.Atch.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(ShpIdentifier identifier, in ShpEntry entry) - { - _data ??= []; - if (!_data!.Shp.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(AtrIdentifier identifier, in AtrEntry entry) - { - _data ??= []; - if (!_data!.Atr.TryAdd(identifier, entry)) - return false; - - ++Count; - return true; - } - - public bool TryAdd(GlobalEqpManipulation identifier) - { - _data ??= []; - if (!_data.Add(identifier)) - return false; - - ++Count; - return true; - } - - #endregion - - #region Update - - public bool Update(ImcIdentifier identifier, ImcEntry entry) - { - if (_data is null || !_data.Imc.ContainsKey(identifier)) - return false; - - _data.Imc[identifier] = entry; - return true; - } - - public bool Update(EqpIdentifier identifier, EqpEntryInternal entry) - { - if (_data is null || !_data.Eqp.ContainsKey(identifier)) - return false; - - _data.Eqp[identifier] = entry; - return true; - } - - public bool Update(EqpIdentifier identifier, EqpEntry entry) - => Update(identifier, new EqpEntryInternal(entry, identifier.Slot)); - - public bool Update(EqdpIdentifier identifier, EqdpEntryInternal entry) - { - if (_data is null || !_data.Eqdp.ContainsKey(identifier)) - return false; - - _data.Eqdp[identifier] = entry; - return true; - } - - public bool Update(EqdpIdentifier identifier, EqdpEntry entry) - => Update(identifier, new EqdpEntryInternal(entry, identifier.Slot)); - - public bool Update(EstIdentifier identifier, EstEntry entry) - { - if (_data is null || !_data.Est.ContainsKey(identifier)) - return false; - - _data.Est[identifier] = entry; - return true; - } - - public bool Update(GmpIdentifier identifier, GmpEntry entry) - { - if (_data is null || !_data.Gmp.ContainsKey(identifier)) - return false; - - _data.Gmp[identifier] = entry; - return true; - } - - public bool Update(RspIdentifier identifier, RspEntry entry) - { - if (_data is null || !_data.Rsp.ContainsKey(identifier)) - return false; - - _data.Rsp[identifier] = entry; - return true; - } - - public bool Update(AtchIdentifier identifier, in AtchEntry entry) - { - if (_data is null || !_data.Atch.ContainsKey(identifier)) - return false; - - _data.Atch[identifier] = entry; - return true; - } - - public bool Update(ShpIdentifier identifier, in ShpEntry entry) - { - if (_data is null || !_data.Shp.ContainsKey(identifier)) - return false; - - _data.Shp[identifier] = entry; - return true; - } - - public bool Update(AtrIdentifier identifier, in AtrEntry entry) - { - if (_data is null || !_data.Atr.ContainsKey(identifier)) - return false; - - _data.Atr[identifier] = entry; - return true; - } - - #endregion - - #region TryGetValue - - public bool TryGetValue(EstIdentifier identifier, out EstEntry value) - => _data?.Est.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(EqpIdentifier identifier, out EqpEntryInternal value) - => _data?.Eqp.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(EqdpIdentifier identifier, out EqdpEntryInternal value) - => _data?.Eqdp.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(GmpIdentifier identifier, out GmpEntry value) - => _data?.Gmp.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(RspIdentifier identifier, out RspEntry value) - => _data?.Rsp.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(ImcIdentifier identifier, out ImcEntry value) - => _data?.Imc.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(AtchIdentifier identifier, out AtchEntry value) - => _data?.Atch.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(ShpIdentifier identifier, out ShpEntry value) - => _data?.Shp.TryGetValue(identifier, out value) ?? SetDefault(out value); - - public bool TryGetValue(AtrIdentifier identifier, out AtrEntry value) - => _data?.Atr.TryGetValue(identifier, out value) ?? SetDefault(out value); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private static bool SetDefault(out T? value) - { - value = default; - return false; - } - - #endregion - - public bool Remove(IMetaIdentifier identifier) - { - if (_data is null) - return false; - - var ret = identifier switch - { - EqdpIdentifier i => _data.Eqdp.Remove(i), - EqpIdentifier i => _data.Eqp.Remove(i), - EstIdentifier i => _data.Est.Remove(i), - GlobalEqpManipulation i => _data.Remove(i), - GmpIdentifier i => _data.Gmp.Remove(i), - ImcIdentifier i => _data.Imc.Remove(i), - RspIdentifier i => _data.Rsp.Remove(i), - AtchIdentifier i => _data.Atch.Remove(i), - ShpIdentifier i => _data.Shp.Remove(i), - AtrIdentifier i => _data.Atr.Remove(i), - _ => false, - }; - if (ret && --Count is 0) - _data = null; - - return ret; - } - - #region Merging - - public void UnionWith(MetaDictionary manips) - { - if (manips.Count is 0) - return; - - _data ??= []; - foreach (var (identifier, entry) in manips._data!.Imc) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Eqp) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Eqdp) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Gmp) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Rsp) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Est) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Atch) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Shp) - TryAdd(identifier, entry); - - foreach (var (identifier, entry) in manips._data!.Atr) - TryAdd(identifier, entry); - - foreach (var identifier in manips._data!) - TryAdd(identifier); - } - - /// Try to merge all manipulations from manips into this, and return the first failure, if any. - public bool MergeForced(MetaDictionary manips, out IMetaIdentifier? failedIdentifier) - { - if (manips.Count is 0) - { - failedIdentifier = null; - return true; - } - - _data ??= []; - foreach (var (identifier, _) in manips._data!.Imc.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Eqp.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Eqdp.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Gmp.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Rsp.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Est.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Atch.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Shp.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var (identifier, _) in manips._data!.Atr.Where(kvp => !TryAdd(kvp.Key, kvp.Value))) - { - failedIdentifier = identifier; - return false; - } - - foreach (var identifier in manips._data!.Where(identifier => !TryAdd(identifier))) - { - failedIdentifier = identifier; - return false; - } - - failedIdentifier = null; - return true; - } - - public void SetTo(MetaDictionary other) - { - if (other.Count is 0) - { - _data = null; - Count = 0; - return; - } - - _data ??= []; - _data!.Imc.SetTo(other._data!.Imc); - _data!.Eqp.SetTo(other._data!.Eqp); - _data!.Eqdp.SetTo(other._data!.Eqdp); - _data!.Est.SetTo(other._data!.Est); - _data!.Rsp.SetTo(other._data!.Rsp); - _data!.Gmp.SetTo(other._data!.Gmp); - _data!.Atch.SetTo(other._data!.Atch); - _data!.Shp.SetTo(other._data!.Shp); - _data!.Atr.SetTo(other._data!.Atr); - _data!.SetTo(other._data!); - Count = other.Count; - } - - public void UpdateTo(MetaDictionary other) - { - if (other.Count is 0) - return; - - _data ??= []; - _data!.Imc.UpdateTo(other._data!.Imc); - _data!.Eqp.UpdateTo(other._data!.Eqp); - _data!.Eqdp.UpdateTo(other._data!.Eqdp); - _data!.Est.UpdateTo(other._data!.Est); - _data!.Rsp.UpdateTo(other._data!.Rsp); - _data!.Gmp.UpdateTo(other._data!.Gmp); - _data!.Atch.UpdateTo(other._data!.Atch); - _data!.Shp.UpdateTo(other._data!.Shp); - _data!.Atr.UpdateTo(other._data!.Atr); - _data!.UnionWith(other._data!); - Count = _data!.Imc.Count - + _data!.Eqp.Count - + _data!.Eqdp.Count - + _data!.Est.Count - + _data!.Rsp.Count - + _data!.Gmp.Count - + _data!.Atch.Count - + _data!.Shp.Count - + _data!.Atr.Count - + _data!.Count; - } - - #endregion - - public MetaDictionary Clone() - { - var ret = new MetaDictionary(); - ret.SetTo(this); - return ret; - } - - public static JObject Serialize(EqpIdentifier identifier, EqpEntryInternal entry) - => Serialize(identifier, entry.ToEntry(identifier.Slot)); - - public static JObject Serialize(EqpIdentifier identifier, EqpEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Eqp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = (ulong)entry, - }), - }; - - public static JObject Serialize(EqdpIdentifier identifier, EqdpEntryInternal entry) - => Serialize(identifier, entry.ToEntry(identifier.Slot)); - - public static JObject Serialize(EqdpIdentifier identifier, EqdpEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Eqdp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = (ushort)entry, - }), - }; - - public static JObject Serialize(EstIdentifier identifier, EstEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Est.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = entry.Value, - }), - }; - - public static JObject Serialize(GmpIdentifier identifier, GmpEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Gmp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = JObject.FromObject(entry), - }), - }; - - public static JObject Serialize(ImcIdentifier identifier, ImcEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Imc.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = JObject.FromObject(entry), - }), - }; - - public static JObject Serialize(RspIdentifier identifier, RspEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Rsp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = entry.Value, - }), - }; - - public static JObject Serialize(AtchIdentifier identifier, AtchEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Atch.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = entry.ToJson(), - }), - }; - - public static JObject Serialize(ShpIdentifier identifier, ShpEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Shp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = entry.Value, - }), - }; - - public static JObject Serialize(AtrIdentifier identifier, AtrEntry entry) - => new() - { - ["Type"] = MetaManipulationType.Atr.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject - { - ["Entry"] = entry.Value, - }), - }; - - public static JObject Serialize(GlobalEqpManipulation identifier) - => new() - { - ["Type"] = MetaManipulationType.GlobalEqp.ToString(), - ["Manipulation"] = identifier.AddToJson(new JObject()), - }; - - public static JObject? Serialize(TIdentifier identifier, TEntry entry) - where TIdentifier : unmanaged, IMetaIdentifier - where TEntry : unmanaged - { - if (typeof(TIdentifier) == typeof(EqpIdentifier) && typeof(TEntry) == typeof(EqpEntryInternal)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(EqpIdentifier) && typeof(TEntry) == typeof(EqpEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(EqdpIdentifier) && typeof(TEntry) == typeof(EqdpEntryInternal)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(EqdpIdentifier) && typeof(TEntry) == typeof(EqdpEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(EstIdentifier) && typeof(TEntry) == typeof(EstEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(GmpIdentifier) && typeof(TEntry) == typeof(GmpEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(RspIdentifier) && typeof(TEntry) == typeof(RspEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(ImcIdentifier) && typeof(TEntry) == typeof(ImcEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(AtchIdentifier) && typeof(TEntry) == typeof(AtchEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(ShpIdentifier) && typeof(TEntry) == typeof(ShpEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(AtrIdentifier) && typeof(TEntry) == typeof(AtrEntry)) - return Serialize(Unsafe.As(ref identifier), Unsafe.As(ref entry)); - if (typeof(TIdentifier) == typeof(GlobalEqpManipulation)) - return Serialize(Unsafe.As(ref identifier)); - - return null; - } - - public static JArray SerializeTo(JArray array, IEnumerable> manipulations) - where TIdentifier : unmanaged, IMetaIdentifier - where TEntry : unmanaged - { - foreach (var (identifier, entry) in manipulations) - { - if (Serialize(identifier, entry) is { } jObj) - array.Add(jObj); - } - - return array; - } - - public static JArray SerializeTo(JArray array, IEnumerable manipulations) - { - foreach (var manip in manipulations) - array.Add(Serialize(manip)); - - return array; - } - - private class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, MetaDictionary? value, JsonSerializer serializer) - { - if (value is null) - { - writer.WriteNull(); - return; - } - - var array = new JArray(); - if (value._data is not null) - { - SerializeTo(array, value._data!.Imc); - SerializeTo(array, value._data!.Eqp); - SerializeTo(array, value._data!.Eqdp); - SerializeTo(array, value._data!.Est); - SerializeTo(array, value._data!.Rsp); - SerializeTo(array, value._data!.Gmp); - SerializeTo(array, value._data!.Atch); - SerializeTo(array, value._data!.Shp); - SerializeTo(array, value._data!.Atr); - SerializeTo(array, value._data!); - } - - array.WriteTo(writer); - } - - public override MetaDictionary ReadJson(JsonReader reader, Type objectType, MetaDictionary? existingValue, bool hasExistingValue, - JsonSerializer serializer) - { - var dict = existingValue ?? new MetaDictionary(); - dict.Clear(); - var jObj = JArray.Load(reader); - foreach (var item in jObj) - { - var type = item["Type"]?.ToObject() ?? MetaManipulationType.Unknown; - if (type is MetaManipulationType.Unknown) - { - Penumbra.Log.Warning($"Invalid Meta Manipulation Type {type} encountered."); - continue; - } - - if (item["Manipulation"] is not JObject manip) - { - Penumbra.Log.Warning($"Manipulation of type {type} does not contain manipulation data."); - continue; - } - - switch (type) - { - case MetaManipulationType.Imc: - { - var identifier = ImcIdentifier.FromJson(manip); - var entry = manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid IMC Manipulation encountered."); - break; - } - case MetaManipulationType.Eqdp: - { - var identifier = EqdpIdentifier.FromJson(manip); - var entry = (EqdpEntry?)manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid EQDP Manipulation encountered."); - break; - } - case MetaManipulationType.Eqp: - { - var identifier = EqpIdentifier.FromJson(manip); - var entry = (EqpEntry?)manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid EQP Manipulation encountered."); - break; - } - case MetaManipulationType.Est: - { - var identifier = EstIdentifier.FromJson(manip); - var entry = manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid EST Manipulation encountered."); - break; - } - case MetaManipulationType.Gmp: - { - var identifier = GmpIdentifier.FromJson(manip); - var entry = manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid GMP Manipulation encountered."); - break; - } - case MetaManipulationType.Rsp: - { - var identifier = RspIdentifier.FromJson(manip); - var entry = manip["Entry"]?.ToObject(); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid RSP Manipulation encountered."); - break; - } - case MetaManipulationType.Atch: - { - var identifier = AtchIdentifier.FromJson(manip); - var entry = AtchEntry.FromJson(manip["Entry"] as JObject); - if (identifier.HasValue && entry.HasValue) - dict.TryAdd(identifier.Value, entry.Value); - else - Penumbra.Log.Warning("Invalid ATCH Manipulation encountered."); - break; - } - case MetaManipulationType.Shp: - { - var identifier = ShpIdentifier.FromJson(manip); - var entry = new ShpEntry(manip["Entry"]?.Value() ?? true); - if (identifier.HasValue) - dict.TryAdd(identifier.Value, entry); - else - Penumbra.Log.Warning("Invalid SHP Manipulation encountered."); - break; - } - case MetaManipulationType.Atr: - { - var identifier = AtrIdentifier.FromJson(manip); - var entry = new AtrEntry(manip["Entry"]?.Value() ?? true); - if (identifier.HasValue) - dict.TryAdd(identifier.Value, entry); - else - Penumbra.Log.Warning("Invalid ATR Manipulation encountered."); - break; - } - case MetaManipulationType.GlobalEqp: - { - var identifier = GlobalEqpManipulation.FromJson(manip); - if (identifier.HasValue) - dict.TryAdd(identifier.Value); - else - Penumbra.Log.Warning("Invalid Global EQP Manipulation encountered."); - break; - } - } - } - - return dict; - } - } - - public MetaDictionary() - { } - - public MetaDictionary(MetaCache? cache) - { - if (cache is null) - return; - - _data = new Wrapper(cache); - Count = cache.Count; - } - - public MetaDictionary(MetaCache? cache, Actor actor) - { - if (cache is null) - return; - - _data = Wrapper.Filtered(cache, actor); - Count = _data.Count - + _data.Eqp.Count - + _data.Eqdp.Count - + _data.Est.Count - + _data.Gmp.Count - + _data.Imc.Count - + _data.Rsp.Count - + _data.Atch.Count - + _data.Atr.Count - + _data.Shp.Count; - if (Count is 0) - _data = null; - } -} diff --git a/Penumbra/Meta/Manipulations/MetaManipulation.cs b/Penumbra/Meta/Manipulations/MetaManipulation.cs new file mode 100644 index 00000000..f22de809 --- /dev/null +++ b/Penumbra/Meta/Manipulations/MetaManipulation.cs @@ -0,0 +1,317 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.Interop.Structs; +using Penumbra.String.Functions; + +namespace Penumbra.Meta.Manipulations; + +public interface IMetaManipulation +{ + public MetaIndex FileIndex(); +} + +public interface IMetaManipulation + : IMetaManipulation, IComparable, IEquatable where T : struct +{ } + +[StructLayout(LayoutKind.Explicit, Pack = 1, Size = 16)] +public readonly struct MetaManipulation : IEquatable, IComparable +{ + public const int CurrentVersion = 0; + + public enum Type : byte + { + Unknown = 0, + Imc = 1, + Eqdp = 2, + Eqp = 3, + Est = 4, + Gmp = 5, + Rsp = 6, + GlobalEqp = 7, + } + + [FieldOffset(0)] + [JsonIgnore] + public readonly EqpManipulation Eqp = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly GmpManipulation Gmp = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly EqdpManipulation Eqdp = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly EstManipulation Est = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly RspManipulation Rsp = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly ImcManipulation Imc = default; + + [FieldOffset(0)] + [JsonIgnore] + public readonly GlobalEqpManipulation GlobalEqp = default; + + [FieldOffset(15)] + [JsonConverter(typeof(StringEnumConverter))] + [JsonProperty("Type")] + public readonly Type ManipulationType; + + public object? Manipulation + { + get => ManipulationType switch + { + Type.Unknown => null, + Type.Imc => Imc, + Type.Eqdp => Eqdp, + Type.Eqp => Eqp, + Type.Est => Est, + Type.Gmp => Gmp, + Type.Rsp => Rsp, + Type.GlobalEqp => GlobalEqp, + _ => null, + }; + init + { + switch (value) + { + case EqpManipulation m: + Eqp = m; + ManipulationType = m.Validate() ? Type.Eqp : Type.Unknown; + return; + case EqdpManipulation m: + Eqdp = m; + ManipulationType = m.Validate() ? Type.Eqdp : Type.Unknown; + return; + case GmpManipulation m: + Gmp = m; + ManipulationType = m.Validate() ? Type.Gmp : Type.Unknown; + return; + case EstManipulation m: + Est = m; + ManipulationType = m.Validate() ? Type.Est : Type.Unknown; + return; + case RspManipulation m: + Rsp = m; + ManipulationType = m.Validate() ? Type.Rsp : Type.Unknown; + return; + case ImcManipulation m: + Imc = m; + ManipulationType = m.Validate(true) ? Type.Imc : Type.Unknown; + return; + case GlobalEqpManipulation m: + GlobalEqp = m; + ManipulationType = m.Validate() ? Type.GlobalEqp : Type.Unknown; + return; + } + } + } + + public bool Validate() + { + return ManipulationType switch + { + Type.Imc => Imc.Validate(true), + Type.Eqdp => Eqdp.Validate(), + Type.Eqp => Eqp.Validate(), + Type.Est => Est.Validate(), + Type.Gmp => Gmp.Validate(), + Type.Rsp => Rsp.Validate(), + Type.GlobalEqp => GlobalEqp.Validate(), + _ => false, + }; + } + + public MetaManipulation(EqpManipulation eqp) + { + Eqp = eqp; + ManipulationType = Type.Eqp; + } + + public MetaManipulation(GmpManipulation gmp) + { + Gmp = gmp; + ManipulationType = Type.Gmp; + } + + public MetaManipulation(EqdpManipulation eqdp) + { + Eqdp = eqdp; + ManipulationType = Type.Eqdp; + } + + public MetaManipulation(EstManipulation est) + { + Est = est; + ManipulationType = Type.Est; + } + + public MetaManipulation(RspManipulation rsp) + { + Rsp = rsp; + ManipulationType = Type.Rsp; + } + + public MetaManipulation(ImcManipulation imc) + { + Imc = imc; + ManipulationType = Type.Imc; + } + + public MetaManipulation(GlobalEqpManipulation eqp) + { + GlobalEqp = eqp; + ManipulationType = Type.GlobalEqp; + } + + public static implicit operator MetaManipulation(EqpManipulation eqp) + => new(eqp); + + public static implicit operator MetaManipulation(GmpManipulation gmp) + => new(gmp); + + public static implicit operator MetaManipulation(EqdpManipulation eqdp) + => new(eqdp); + + public static implicit operator MetaManipulation(EstManipulation est) + => new(est); + + public static implicit operator MetaManipulation(RspManipulation rsp) + => new(rsp); + + public static implicit operator MetaManipulation(ImcManipulation imc) + => new(imc); + + public static implicit operator MetaManipulation(GlobalEqpManipulation eqp) + => new(eqp); + + public bool EntryEquals(MetaManipulation other) + { + if (ManipulationType != other.ManipulationType) + return false; + + return ManipulationType switch + { + Type.Eqp => Eqp.Entry.Equals(other.Eqp.Entry), + Type.Gmp => Gmp.Entry.Equals(other.Gmp.Entry), + Type.Eqdp => Eqdp.Entry.Equals(other.Eqdp.Entry), + Type.Est => Est.Entry.Equals(other.Est.Entry), + Type.Rsp => Rsp.Entry.Equals(other.Rsp.Entry), + Type.Imc => Imc.Entry.Equals(other.Imc.Entry), + Type.GlobalEqp => true, + _ => throw new ArgumentOutOfRangeException(), + }; + } + + public bool Equals(MetaManipulation other) + { + if (ManipulationType != other.ManipulationType) + return false; + + return ManipulationType switch + { + Type.Eqp => Eqp.Equals(other.Eqp), + Type.Gmp => Gmp.Equals(other.Gmp), + Type.Eqdp => Eqdp.Equals(other.Eqdp), + Type.Est => Est.Equals(other.Est), + Type.Rsp => Rsp.Equals(other.Rsp), + Type.Imc => Imc.Equals(other.Imc), + Type.GlobalEqp => GlobalEqp.Equals(other.GlobalEqp), + _ => false, + }; + } + + public MetaManipulation WithEntryOf(MetaManipulation other) + { + if (ManipulationType != other.ManipulationType) + return this; + + return ManipulationType switch + { + Type.Eqp => Eqp.Copy(other.Eqp.Entry), + Type.Gmp => Gmp.Copy(other.Gmp.Entry), + Type.Eqdp => Eqdp.Copy(other.Eqdp), + Type.Est => Est.Copy(other.Est.Entry), + Type.Rsp => Rsp.Copy(other.Rsp.Entry), + Type.Imc => Imc.Copy(other.Imc.Entry), + Type.GlobalEqp => GlobalEqp, + _ => throw new ArgumentOutOfRangeException(), + }; + } + + public override bool Equals(object? obj) + => obj is MetaManipulation other && Equals(other); + + public override int GetHashCode() + => ManipulationType switch + { + Type.Eqp => Eqp.GetHashCode(), + Type.Gmp => Gmp.GetHashCode(), + Type.Eqdp => Eqdp.GetHashCode(), + Type.Est => Est.GetHashCode(), + Type.Rsp => Rsp.GetHashCode(), + Type.Imc => Imc.GetHashCode(), + Type.GlobalEqp => GlobalEqp.GetHashCode(), + _ => 0, + }; + + public unsafe int CompareTo(MetaManipulation other) + { + fixed (MetaManipulation* lhs = &this) + { + return MemoryUtility.MemCmpUnchecked(lhs, &other, sizeof(MetaManipulation)); + } + } + + public override string ToString() + => ManipulationType switch + { + Type.Eqp => Eqp.ToString(), + Type.Gmp => Gmp.ToString(), + Type.Eqdp => Eqdp.ToString(), + Type.Est => Est.ToString(), + Type.Rsp => Rsp.ToString(), + Type.Imc => Imc.ToString(), + Type.GlobalEqp => GlobalEqp.ToString(), + _ => "Invalid", + }; + + public string EntryToString() + => ManipulationType switch + { + Type.Imc => + $"{Imc.Entry.DecalId}-{Imc.Entry.MaterialId}-{Imc.Entry.VfxId}-{Imc.Entry.SoundId}-{Imc.Entry.MaterialAnimationId}-{Imc.Entry.AttributeMask}", + Type.Eqdp => $"{(ushort)Eqdp.Entry:X}", + Type.Eqp => $"{(ulong)Eqp.Entry:X}", + Type.Est => $"{Est.Entry}", + Type.Gmp => $"{Gmp.Entry.Value}", + Type.Rsp => $"{Rsp.Entry}", + Type.GlobalEqp => string.Empty, + _ => string.Empty, + }; + + public static bool operator ==(MetaManipulation left, MetaManipulation right) + => left.Equals(right); + + public static bool operator !=(MetaManipulation left, MetaManipulation right) + => !(left == right); + + public static bool operator <(MetaManipulation left, MetaManipulation right) + => left.CompareTo(right) < 0; + + public static bool operator <=(MetaManipulation left, MetaManipulation right) + => left.CompareTo(right) <= 0; + + public static bool operator >(MetaManipulation left, MetaManipulation right) + => left.CompareTo(right) > 0; + + public static bool operator >=(MetaManipulation left, MetaManipulation right) + => left.CompareTo(right) >= 0; +} diff --git a/Penumbra/Meta/Manipulations/Rsp.cs b/Penumbra/Meta/Manipulations/Rsp.cs deleted file mode 100644 index 5f91a37c..00000000 --- a/Penumbra/Meta/Manipulations/Rsp.cs +++ /dev/null @@ -1,79 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.Interop.Structs; - -namespace Penumbra.Meta.Manipulations; - -public readonly record struct RspIdentifier(SubRace SubRace, RspAttribute Attribute) : IMetaIdentifier -{ - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => changedItems.UpdateCountOrSet($"{SubRace.ToName()} {Attribute.ToFullString()}", () => new IdentifiedName()); - - public MetaIndex FileIndex() - => MetaIndex.HumanCmp; - - public bool Validate() - => SubRace is not SubRace.Unknown - && Enum.IsDefined(SubRace) - && Attribute is not RspAttribute.NumAttributes - && Enum.IsDefined(Attribute); - - public JObject AddToJson(JObject jObj) - { - jObj["SubRace"] = SubRace.ToString(); - jObj["Attribute"] = Attribute.ToString(); - return jObj; - } - - public static RspIdentifier? FromJson(JObject? jObj) - { - if (jObj == null) - return null; - - var subRace = jObj["SubRace"]?.ToObject() ?? SubRace.Unknown; - var attribute = jObj["Attribute"]?.ToObject() ?? RspAttribute.NumAttributes; - var ret = new RspIdentifier(subRace, attribute); - return ret.Validate() ? ret : null; - } - - public MetaManipulationType Type - => MetaManipulationType.Rsp; - - public override string ToString() - => $"RSP - {SubRace.ToName()} - {Attribute.ToFullString()}"; -} - -[JsonConverter(typeof(Converter))] -public readonly record struct RspEntry(float Value) : IComparisonOperators -{ - public const float MinValue = 0.01f; - public const float MaxValue = 512f; - public static readonly RspEntry One = new(1f); - - public bool Validate() - => Value is >= MinValue and <= MaxValue; - - private class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, RspEntry value, JsonSerializer serializer) - => serializer.Serialize(writer, value.Value); - - public override RspEntry ReadJson(JsonReader reader, Type objectType, RspEntry existingValue, bool hasExistingValue, - JsonSerializer serializer) - => new(serializer.Deserialize(reader)); - } - - public static bool operator >(RspEntry left, RspEntry right) - => left.Value > right.Value; - - public static bool operator >=(RspEntry left, RspEntry right) - => left.Value >= right.Value; - - public static bool operator <(RspEntry left, RspEntry right) - => left.Value < right.Value; - - public static bool operator <=(RspEntry left, RspEntry right) - => left.Value <= right.Value; -} diff --git a/Penumbra/Meta/Manipulations/RspManipulation.cs b/Penumbra/Meta/Manipulations/RspManipulation.cs new file mode 100644 index 00000000..7e5e3fcb --- /dev/null +++ b/Penumbra/Meta/Manipulations/RspManipulation.cs @@ -0,0 +1,76 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Penumbra.GameData.Enums; +using Penumbra.Interop.Structs; +using Penumbra.Meta.Files; + +namespace Penumbra.Meta.Manipulations; + +[StructLayout(LayoutKind.Sequential, Pack = 1)] +public readonly struct RspManipulation : IMetaManipulation +{ + public const float MinValue = 0.01f; + public const float MaxValue = 512f; + public float Entry { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public SubRace SubRace { get; private init; } + + [JsonConverter(typeof(StringEnumConverter))] + public RspAttribute Attribute { get; private init; } + + [JsonConstructor] + public RspManipulation(SubRace subRace, RspAttribute attribute, float entry) + { + Entry = entry; + SubRace = subRace; + Attribute = attribute; + } + + public RspManipulation Copy(float entry) + => new(SubRace, Attribute, entry); + + public override string ToString() + => $"Rsp - {SubRace.ToName()} - {Attribute.ToFullString()}"; + + public bool Equals(RspManipulation other) + => SubRace == other.SubRace + && Attribute == other.Attribute; + + public override bool Equals(object? obj) + => obj is RspManipulation other && Equals(other); + + public override int GetHashCode() + => HashCode.Combine((int)SubRace, (int)Attribute); + + public int CompareTo(RspManipulation other) + { + var s = SubRace.CompareTo(other.SubRace); + return s != 0 ? s : Attribute.CompareTo(other.Attribute); + } + + public MetaIndex FileIndex() + => MetaIndex.HumanCmp; + + public bool Apply(CmpFile file) + { + var value = file[SubRace, Attribute]; + if (value == Entry) + return false; + + file[SubRace, Attribute] = Entry; + return true; + } + + public bool Validate() + { + if (SubRace is SubRace.Unknown || !Enum.IsDefined(SubRace)) + return false; + if (!Enum.IsDefined(Attribute)) + return false; + if (Entry is < MinValue or > MaxValue) + return false; + + return true; + } +} diff --git a/Penumbra/Meta/Manipulations/ShpIdentifier.cs b/Penumbra/Meta/Manipulations/ShpIdentifier.cs deleted file mode 100644 index 0a5b71b7..00000000 --- a/Penumbra/Meta/Manipulations/ShpIdentifier.cs +++ /dev/null @@ -1,187 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Structs; -using Penumbra.Meta.Files; - -namespace Penumbra.Meta.Manipulations; - -[JsonConverter(typeof(StringEnumConverter))] -public enum ShapeConnectorCondition : byte -{ - None = 0, - Wrists = 1, - Waist = 2, - Ankles = 3, -} - -public readonly record struct ShpIdentifier( - HumanSlot Slot, - PrimaryId? Id, - ShapeAttributeString Shape, - ShapeConnectorCondition ConnectorCondition, - GenderRace GenderRaceCondition) - : IComparable, IMetaIdentifier -{ - public int CompareTo(ShpIdentifier other) - { - var slotComparison = Slot.CompareTo(other.Slot); - if (slotComparison is not 0) - return slotComparison; - - if (Id.HasValue) - { - if (other.Id.HasValue) - { - var idComparison = Id.Value.Id.CompareTo(other.Id.Value.Id); - if (idComparison is not 0) - return idComparison; - } - else - { - return -1; - } - } - else if (other.Id.HasValue) - { - return 1; - } - - var conditionComparison = ConnectorCondition.CompareTo(other.ConnectorCondition); - if (conditionComparison is not 0) - return conditionComparison; - - var genderRaceComparison = GenderRaceCondition.CompareTo(other.GenderRaceCondition); - if (genderRaceComparison is not 0) - return genderRaceComparison; - - return Shape.CompareTo(other.Shape); - } - - - public override string ToString() - { - var sb = new StringBuilder(64); - sb.Append("Shp - ") - .Append(Shape); - if (Slot is HumanSlot.Unknown) - { - sb.Append(" - All Slots & IDs"); - } - else - { - sb.Append(" - ") - .Append(Slot.ToName()) - .Append(" - "); - if (Id.HasValue) - sb.Append(Id.Value.Id); - else - sb.Append("All IDs"); - } - - switch (ConnectorCondition) - { - case ShapeConnectorCondition.Wrists: sb.Append(" - Wrist Connector"); break; - case ShapeConnectorCondition.Waist: sb.Append(" - Waist Connector"); break; - case ShapeConnectorCondition.Ankles: sb.Append(" - Ankle Connector"); break; - } - - if (GenderRaceCondition is not GenderRace.Unknown) - sb.Append(" - ").Append(GenderRaceCondition.ToRaceCode()); - - return sb.ToString(); - } - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - // Nothing for now since it depends entirely on the shape key. - } - - public MetaIndex FileIndex() - => (MetaIndex)(-1); - - public bool Validate() - { - if (!Enum.IsDefined(Slot) || Slot is HumanSlot.UnkBonus) - return false; - - if (!ShapeAttributeHashSet.GenderRaceIndices.ContainsKey(GenderRaceCondition)) - return false; - - if (!Enum.IsDefined(ConnectorCondition)) - return false; - - if (Slot is HumanSlot.Unknown && Id is not null) - return false; - - if (Slot.ToSpecificEnum() is BodySlot && Id is { Id: > byte.MaxValue }) - return false; - - if (Id is { Id: > ExpandedEqpGmpBase.Count - 1 }) - return false; - - if (!Shape.ValidateCustomShapeString()) - return false; - - return ConnectorCondition switch - { - ShapeConnectorCondition.None => true, - ShapeConnectorCondition.Wrists => Slot is HumanSlot.Body or HumanSlot.Hands or HumanSlot.Unknown, - ShapeConnectorCondition.Waist => Slot is HumanSlot.Body or HumanSlot.Legs or HumanSlot.Unknown, - ShapeConnectorCondition.Ankles => Slot is HumanSlot.Legs or HumanSlot.Feet or HumanSlot.Unknown, - _ => false, - }; - } - - public JObject AddToJson(JObject jObj) - { - if (Slot is not HumanSlot.Unknown) - jObj["Slot"] = Slot.ToString(); - if (Id.HasValue) - jObj["Id"] = Id.Value.Id.ToString(); - jObj["Shape"] = Shape.ToString(); - if (ConnectorCondition is not ShapeConnectorCondition.None) - jObj["ConnectorCondition"] = ConnectorCondition.ToString(); - if (GenderRaceCondition is not GenderRace.Unknown) - jObj["GenderRaceCondition"] = (uint)GenderRaceCondition; - return jObj; - } - - public static ShpIdentifier? FromJson(JObject jObj) - { - var shape = jObj["Shape"]?.ToObject(); - if (shape is null || !ShapeAttributeString.TryRead(shape, out var shapeString)) - return null; - - var slot = jObj["Slot"]?.ToObject() ?? HumanSlot.Unknown; - var id = jObj["Id"]?.ToObject(); - var connectorCondition = jObj["ConnectorCondition"]?.ToObject() ?? ShapeConnectorCondition.None; - var genderRaceCondition = jObj["GenderRaceCondition"]?.ToObject() ?? 0; - var identifier = new ShpIdentifier(slot, id, shapeString, connectorCondition, genderRaceCondition); - return identifier.Validate() ? identifier : null; - } - - public MetaManipulationType Type - => MetaManipulationType.Shp; -} - -[JsonConverter(typeof(Converter))] -public readonly record struct ShpEntry(bool Value) -{ - public static readonly ShpEntry True = new(true); - public static readonly ShpEntry False = new(false); - - private class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, ShpEntry value, JsonSerializer serializer) - => serializer.Serialize(writer, value.Value); - - public override ShpEntry ReadJson(JsonReader reader, Type objectType, ShpEntry existingValue, bool hasExistingValue, - JsonSerializer serializer) - => new(serializer.Deserialize(reader)); - } -} diff --git a/Penumbra/Meta/MetaFileManager.cs b/Penumbra/Meta/MetaFileManager.cs index 6130a48f..40fceb07 100644 --- a/Penumbra/Meta/MetaFileManager.cs +++ b/Penumbra/Meta/MetaFileManager.cs @@ -1,12 +1,14 @@ using Dalamud.Plugin.Services; +using Dalamud.Utility.Signatures; +using FFXIVClientStructs.FFXIV.Client.System.Memory; using OtterGui.Compression; -using OtterGui.Services; using Penumbra.Collections; using Penumbra.Collections.Manager; +using Penumbra.GameData; using Penumbra.GameData.Data; using Penumbra.Import; -using Penumbra.Interop.Hooks.Meta; using Penumbra.Interop.Services; +using Penumbra.Interop.Structs; using Penumbra.Meta.Files; using Penumbra.Mods; using Penumbra.Mods.Groups; @@ -15,7 +17,7 @@ using ResidentResourceManager = Penumbra.Interop.Services.ResidentResourceManage namespace Penumbra.Meta; -public class MetaFileManager : IService +public unsafe class MetaFileManager { internal readonly Configuration Config; internal readonly CharacterUtility CharacterUtility; @@ -26,28 +28,20 @@ public class MetaFileManager : IService internal readonly ObjectIdentification Identifier; internal readonly FileCompactor Compactor; internal readonly ImcChecker ImcChecker; - internal readonly AtchManager AtchManager; - internal readonly IFileAllocator MarshalAllocator = new MarshalAllocator(); - internal readonly IFileAllocator XivFileAllocator; - internal readonly IFileAllocator XivDefaultAllocator; - public MetaFileManager(CharacterUtility characterUtility, ResidentResourceManager residentResources, IDataManager gameData, ActiveCollectionData activeCollections, Configuration config, ValidityChecker validityChecker, ObjectIdentification identifier, - FileCompactor compactor, IGameInteropProvider interop, AtchManager atchManager) + FileCompactor compactor, IGameInteropProvider interop) { - CharacterUtility = characterUtility; - ResidentResources = residentResources; - GameData = gameData; - ActiveCollections = activeCollections; - Config = config; - ValidityChecker = validityChecker; - Identifier = identifier; - Compactor = compactor; - AtchManager = atchManager; - ImcChecker = new ImcChecker(this); - XivFileAllocator = new XivFileAllocator(interop); - XivDefaultAllocator = new XivDefaultAllocator(); + CharacterUtility = characterUtility; + ResidentResources = residentResources; + GameData = gameData; + ActiveCollections = activeCollections; + Config = config; + ValidityChecker = validityChecker; + Identifier = identifier; + Compactor = compactor; + ImcChecker = new ImcChecker(this); interop.InitializeFromAttributes(this); } @@ -82,11 +76,57 @@ public class MetaFileManager : IService } } + [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] + public void SetFile(MetaBaseFile? file, MetaIndex metaIndex) + { + if (file == null || !Config.EnableMods) + CharacterUtility.ResetResource(metaIndex); + else + CharacterUtility.SetResource(metaIndex, (nint)file.Data, file.Length); + } + + [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] + public MetaList.MetaReverter TemporarilySetFile(MetaBaseFile? file, MetaIndex metaIndex) + => Config.EnableMods + ? file == null + ? CharacterUtility.TemporarilyResetResource(metaIndex) + : CharacterUtility.TemporarilySetResource(metaIndex, (nint)file.Data, file.Length) + : MetaList.MetaReverter.Disabled; + public void ApplyDefaultFiles(ModCollection? collection) { if (ActiveCollections.Default != collection || !CharacterUtility.Ready || !Config.EnableMods) return; ResidentResources.Reload(); + if (collection._cache == null) + CharacterUtility.ResetAll(); + else + collection._cache.Meta.SetFiles(); } + + /// + /// Allocate in the games space for file storage. + /// We only need this if using any meta file. + /// + [Signature(Sigs.GetFileSpace)] + private readonly nint _getFileSpaceAddress = nint.Zero; + + public IMemorySpace* GetFileSpace() + => ((delegate* unmanaged)_getFileSpaceAddress)(); + + public void* AllocateFileMemory(ulong length, ulong alignment = 0) + => GetFileSpace()->Malloc(length, alignment); + + public void* AllocateFileMemory(int length, int alignment = 0) + => AllocateFileMemory((ulong)length, (ulong)alignment); + + public void* AllocateDefaultMemory(ulong length, ulong alignment = 0) + => GetFileSpace()->Malloc(length, alignment); + + public void* AllocateDefaultMemory(int length, int alignment = 0) + => IMemorySpace.GetDefaultSpace()->Malloc((ulong)length, (ulong)alignment); + + public void Free(nint ptr, int length) + => IMemorySpace.Free((void*)ptr, (ulong)length); } diff --git a/Penumbra/Meta/ShapeAttributeManager.cs b/Penumbra/Meta/ShapeAttributeManager.cs deleted file mode 100644 index a7f71ac7..00000000 --- a/Penumbra/Meta/ShapeAttributeManager.cs +++ /dev/null @@ -1,227 +0,0 @@ -using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Interop; -using Penumbra.GameData.Structs; -using Penumbra.Interop.Hooks.PostProcessing; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.Meta; - -public unsafe class ShapeAttributeManager : IRequiredService, IDisposable -{ - public const int NumSlots = 14; - public const int ModelSlotSize = 18; - private readonly AttributeHook _attributeHook; - - public static ReadOnlySpan UsedModels - => - [ - HumanSlot.Head, HumanSlot.Body, HumanSlot.Hands, HumanSlot.Legs, HumanSlot.Feet, HumanSlot.Ears, HumanSlot.Neck, HumanSlot.Wrists, - HumanSlot.RFinger, HumanSlot.LFinger, HumanSlot.Glasses, HumanSlot.Hair, HumanSlot.Face, HumanSlot.Ear, - ]; - - public ShapeAttributeManager(AttributeHook attributeHook) - { - _attributeHook = attributeHook; - _attributeHook.Subscribe(OnAttributeComputed, AttributeHook.Priority.ShapeAttributeManager); - } - - private readonly Dictionary[] _temporaryShapes = - Enumerable.Range(0, NumSlots).Select(_ => new Dictionary()).ToArray(); - - private readonly PrimaryId[] _ids = new PrimaryId[ModelSlotSize]; - - private HumanSlot _modelIndex; - private int _slotIndex; - private GenderRace _genderRace; - - private FFXIVClientStructs.FFXIV.Client.Graphics.Render.Model* _model; - - public void Dispose() - => _attributeHook.Unsubscribe(OnAttributeComputed); - - private void OnAttributeComputed(Actor actor, Model model, ModCollection collection) - { - if (!collection.HasCache) - return; - - _genderRace = (GenderRace)model.AsHuman->RaceSexId; - for (_slotIndex = 0; _slotIndex < NumSlots; ++_slotIndex) - { - _modelIndex = UsedModels[_slotIndex]; - _model = model.AsHuman->Models[_modelIndex.ToIndex()]; - if (_model is null || _model->ModelResourceHandle is null) - continue; - - _ids[(int)_modelIndex] = model.GetModelId(_modelIndex); - CheckShapes(collection.MetaCache!.Shp); - CheckAttributes(collection.MetaCache!.Atr); - if (_modelIndex is <= HumanSlot.LFinger and >= HumanSlot.Ears) - AccessoryImcCheck(model); - } - - UpdateDefaultMasks(model, collection.MetaCache!.Shp); - } - - private void AccessoryImcCheck(Model model) - { - var imcMask = (ushort)(0x03FF & *(ushort*)(model.Address + 0xAAC + 6 * (int)_modelIndex)); - - Span attr = - [ - (byte)'a', - (byte)'t', - (byte)'r', - (byte)'_', - AccessoryByte(_modelIndex), - (byte)'v', - (byte)'_', - (byte)'a', - 0, - ]; - for (var i = 1; i < 10; ++i) - { - var flag = (ushort)(1 << i); - if ((imcMask & flag) is not 0) - continue; - - attr[^2] = (byte)('a' + i); - - foreach (var (attribute, index) in _model->ModelResourceHandle->Attributes) - { - if (!EqualAttribute(attr, attribute.Value)) - continue; - - _model->EnabledAttributeIndexMask &= ~(1u << index); - break; - } - } - } - - [MethodImpl(MethodImplOptions.AggressiveOptimization | MethodImplOptions.AggressiveInlining)] - private static bool EqualAttribute(Span needle, byte* haystack) - { - foreach (var character in needle) - { - if (*haystack++ != character) - return false; - } - - return true; - } - - private static byte AccessoryByte(HumanSlot slot) - => slot switch - { - HumanSlot.Head => (byte)'m', - HumanSlot.Ears => (byte)'e', - HumanSlot.Neck => (byte)'n', - HumanSlot.Wrists => (byte)'w', - HumanSlot.RFinger => (byte)'r', - HumanSlot.LFinger => (byte)'r', - _ => 0, - }; - - private void CheckAttributes(AtrCache attributeCache) - { - if (attributeCache.DisabledCount is 0) - return; - - ref var attributes = ref _model->ModelResourceHandle->Attributes; - foreach (var (attribute, index) in attributes.Where(kvp => ShapeAttributeString.ValidateCustomAttributeString(kvp.Key.Value))) - { - if (ShapeAttributeString.TryRead(attribute.Value, out var attributeString)) - { - // Mask out custom attributes if they are disabled. Attributes are enabled by default. - if (attributeCache.ShouldBeDisabled(attributeString, _modelIndex, _ids[_modelIndex.ToIndex()], _genderRace)) - _model->EnabledAttributeIndexMask &= ~(1u << index); - } - else - { - Penumbra.Log.Warning($"Trying to read a attribute string that is too long: {attribute}."); - } - } - } - - private void CheckShapes(ShpCache shapeCache) - { - _temporaryShapes[_slotIndex].Clear(); - ref var shapes = ref _model->ModelResourceHandle->Shapes; - foreach (var (shape, index) in shapes.Where(kvp => ShapeAttributeString.ValidateCustomShapeString(kvp.Key.Value))) - { - if (ShapeAttributeString.TryRead(shape.Value, out var shapeString)) - { - _temporaryShapes[_slotIndex].TryAdd(shapeString, index); - // Add custom shapes if they are enabled. Shapes are disabled by default. - if (shapeCache.ShouldBeEnabled(shapeString, _modelIndex, _ids[_modelIndex.ToIndex()], _genderRace)) - _model->EnabledShapeKeyIndexMask |= 1u << index; - } - else - { - Penumbra.Log.Warning($"Trying to read a shape string that is too long: {shape}."); - } - } - } - - private void UpdateDefaultMasks(Model human, ShpCache cache) - { - var genderRace = (GenderRace)human.AsHuman->RaceSexId; - foreach (var (shape, topIndex) in _temporaryShapes[1]) - { - if (shape.IsWrist() - && _temporaryShapes[2].TryGetValue(shape, out var handIndex) - && !cache.ShouldBeDisabled(shape, HumanSlot.Body, _ids[1], genderRace) - && !cache.ShouldBeDisabled(shape, HumanSlot.Hands, _ids[2], genderRace) - && human.AsHuman->Models[1] is not null - && human.AsHuman->Models[2] is not null) - { - human.AsHuman->Models[1]->EnabledShapeKeyIndexMask |= 1u << topIndex; - human.AsHuman->Models[2]->EnabledShapeKeyIndexMask |= 1u << handIndex; - CheckCondition(cache.State(ShapeConnectorCondition.Wrists), genderRace, HumanSlot.Body, HumanSlot.Hands, 1, 2); - } - - if (shape.IsWaist() - && _temporaryShapes[3].TryGetValue(shape, out var legIndex) - && !cache.ShouldBeDisabled(shape, HumanSlot.Body, _ids[1], genderRace) - && !cache.ShouldBeDisabled(shape, HumanSlot.Legs, _ids[3], genderRace) - && human.AsHuman->Models[1] is not null - && human.AsHuman->Models[3] is not null) - { - human.AsHuman->Models[1]->EnabledShapeKeyIndexMask |= 1u << topIndex; - human.AsHuman->Models[3]->EnabledShapeKeyIndexMask |= 1u << legIndex; - CheckCondition(cache.State(ShapeConnectorCondition.Waist), genderRace, HumanSlot.Body, HumanSlot.Legs, 1, 3); - } - } - - foreach (var (shape, bottomIndex) in _temporaryShapes[3]) - { - if (shape.IsAnkle() - && _temporaryShapes[4].TryGetValue(shape, out var footIndex) - && !cache.ShouldBeDisabled(shape, HumanSlot.Legs, _ids[3], genderRace) - && !cache.ShouldBeDisabled(shape, HumanSlot.Feet, _ids[4], genderRace) - && human.AsHuman->Models[3] is not null - && human.AsHuman->Models[4] is not null) - { - human.AsHuman->Models[3]->EnabledShapeKeyIndexMask |= 1u << bottomIndex; - human.AsHuman->Models[4]->EnabledShapeKeyIndexMask |= 1u << footIndex; - CheckCondition(cache.State(ShapeConnectorCondition.Ankles), genderRace, HumanSlot.Legs, HumanSlot.Feet, 3, 4); - } - } - - return; - - void CheckCondition(IReadOnlyDictionary dict, GenderRace genderRace, HumanSlot slot1, - HumanSlot slot2, int idx1, int idx2) - { - foreach (var (shape, set) in dict) - { - if (set.CheckEntry(slot1, _ids[idx1], genderRace) is true && _temporaryShapes[idx1].TryGetValue(shape, out var index1)) - human.AsHuman->Models[idx1]->EnabledShapeKeyIndexMask |= 1u << index1; - if (set.CheckEntry(slot2, _ids[idx2], genderRace) is true && _temporaryShapes[idx2].TryGetValue(shape, out var index2)) - human.AsHuman->Models[idx2]->EnabledShapeKeyIndexMask |= 1u << index2; - } - } - } -} diff --git a/Penumbra/Meta/ShapeAttributeString.cs b/Penumbra/Meta/ShapeAttributeString.cs deleted file mode 100644 index 55e3f021..00000000 --- a/Penumbra/Meta/ShapeAttributeString.cs +++ /dev/null @@ -1,203 +0,0 @@ -using Lumina.Misc; -using Newtonsoft.Json; -using Penumbra.GameData.Files.PhybStructs; -using Penumbra.String.Functions; - -namespace Penumbra.Meta; - -[JsonConverter(typeof(Converter))] -public struct ShapeAttributeString : IEquatable, IComparable -{ - public const int MaxLength = 30; - - public static readonly ShapeAttributeString Empty = new(); - - private FixedString32 _buffer; - - public int Count - => _buffer[31]; - - public int Length - => _buffer[31]; - - public override string ToString() - => Encoding.UTF8.GetString(_buffer[..Length]); - - public byte this[int index] - => _buffer[index]; - - public unsafe ReadOnlySpan AsSpan - { - get - { - fixed (void* ptr = &this) - { - return new ReadOnlySpan(ptr, Length); - } - } - } - - public static unsafe bool ValidateCustomShapeString(byte* shape) - { - // "shpx_*" - if (shape is null) - return false; - - if (*shape++ is not (byte)'s' - || *shape++ is not (byte)'h' - || *shape++ is not (byte)'p' - || *shape++ is not (byte)'x' - || *shape++ is not (byte)'_' - || *shape is 0) - return false; - - return true; - } - - public bool ValidateCustomShapeString() - { - // "shpx_*" - if (Length < 6) - return false; - - if (_buffer[0] is not (byte)'s' - || _buffer[1] is not (byte)'h' - || _buffer[2] is not (byte)'p' - || _buffer[3] is not (byte)'x' - || _buffer[4] is not (byte)'_') - return false; - - return true; - } - - public static unsafe bool ValidateCustomAttributeString(byte* shape) - { - // "atrx_*" - if (shape is null) - return false; - - if (*shape++ is not (byte)'a' - || *shape++ is not (byte)'t' - || *shape++ is not (byte)'r' - || *shape++ is not (byte)'x' - || *shape++ is not (byte)'_' - || *shape is 0) - return false; - - return true; - } - - public bool ValidateCustomAttributeString() - { - // "atrx_*" - if (Length < 6) - return false; - - if (_buffer[0] is not (byte)'a' - || _buffer[1] is not (byte)'t' - || _buffer[2] is not (byte)'r' - || _buffer[3] is not (byte)'x' - || _buffer[4] is not (byte)'_') - return false; - - return true; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public bool IsAnkle() - => CheckCenter('a', 'n'); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public bool IsWaist() - => CheckCenter('w', 'a'); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - public bool IsWrist() - => CheckCenter('w', 'r'); - - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] - private bool CheckCenter(char first, char second) - => Length > 8 && _buffer[5] == first && _buffer[6] == second && _buffer[7] is (byte)'_'; - - public bool Equals(ShapeAttributeString other) - => Length == other.Length && _buffer[..Length].SequenceEqual(other._buffer[..Length]); - - public override bool Equals(object? obj) - => obj is ShapeAttributeString other && Equals(other); - - public override int GetHashCode() - => (int)Crc32.Get(_buffer[..Length]); - - public static bool operator ==(ShapeAttributeString left, ShapeAttributeString right) - => left.Equals(right); - - public static bool operator !=(ShapeAttributeString left, ShapeAttributeString right) - => !left.Equals(right); - - public static unsafe bool TryRead(byte* pointer, out ShapeAttributeString ret) - { - var span = MemoryMarshal.CreateReadOnlySpanFromNullTerminated(pointer); - return TryRead(span, out ret); - } - - public unsafe int CompareTo(ShapeAttributeString other) - { - fixed (void* lhs = &this) - { - return ByteStringFunctions.Compare((byte*)lhs, Length, (byte*)&other, other.Length); - } - } - - public static bool TryRead(ReadOnlySpan utf8, out ShapeAttributeString ret) - { - if (utf8.Length is 0 or > MaxLength) - { - ret = Empty; - return false; - } - - ret = Empty; - utf8.CopyTo(ret._buffer); - ret._buffer[utf8.Length] = 0; - ret._buffer[31] = (byte)utf8.Length; - return true; - } - - public static bool TryRead(ReadOnlySpan utf16, out ShapeAttributeString ret) - { - ret = Empty; - if (!Encoding.UTF8.TryGetBytes(utf16, ret._buffer[..MaxLength], out var written)) - return false; - - ret._buffer[written] = 0; - ret._buffer[31] = (byte)written; - return true; - } - - public void ForceLength(byte length) - { - if (length > MaxLength) - length = MaxLength; - _buffer[length] = 0; - _buffer[31] = length; - } - - private sealed class Converter : JsonConverter - { - public override void WriteJson(JsonWriter writer, ShapeAttributeString value, JsonSerializer serializer) - { - writer.WriteValue(value.ToString()); - } - - public override ShapeAttributeString ReadJson(JsonReader reader, Type objectType, ShapeAttributeString existingValue, - bool hasExistingValue, - JsonSerializer serializer) - { - var value = serializer.Deserialize(reader); - if (!TryRead(value, out existingValue)) - throw new JsonReaderException($"Could not parse {value} into ShapeAttributeString."); - - return existingValue; - } - } -} diff --git a/Penumbra/Mods/Editor/DuplicateManager.cs b/Penumbra/Mods/Editor/DuplicateManager.cs index 56a19766..47aa18dc 100644 --- a/Penumbra/Mods/Editor/DuplicateManager.cs +++ b/Penumbra/Mods/Editor/DuplicateManager.cs @@ -1,5 +1,4 @@ using OtterGui.Classes; -using OtterGui.Services; using Penumbra.Mods.Groups; using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; @@ -8,7 +7,7 @@ using Penumbra.String.Classes; namespace Penumbra.Mods.Editor; -public class DuplicateManager(ModManager modManager, SaveService saveService, Configuration config) : IService +public class DuplicateManager(ModManager modManager, SaveService saveService, Configuration config) { private readonly SHA256 _hasher = SHA256.Create(); private readonly List<(FullPath[] Paths, long Size, byte[] Hash)> _duplicates = []; @@ -225,7 +224,7 @@ public class DuplicateManager(ModManager modManager, SaveService saveService, Co if (!useModManager || !modManager.TryGetMod(modDirectory.Name, string.Empty, out var mod)) { mod = new Mod(modDirectory); - modManager.Creator.ReloadMod(mod, true, true, out _); + modManager.Creator.ReloadMod(mod, true, out _); } Clear(); diff --git a/Penumbra/Mods/Editor/IMod.cs b/Penumbra/Mods/Editor/IMod.cs index 3da38829..d4c881e9 100644 --- a/Penumbra/Mods/Editor/IMod.cs +++ b/Penumbra/Mods/Editor/IMod.cs @@ -8,9 +8,9 @@ namespace Penumbra.Mods.Editor; public record struct AppliedModData( Dictionary FileRedirections, - MetaDictionary Manipulations) + HashSet Manipulations) { - public static readonly AppliedModData Empty = new([], new MetaDictionary()); + public static readonly AppliedModData Empty = new([], []); } public interface IMod diff --git a/Penumbra/Mods/Editor/MdlMaterialEditor.cs b/Penumbra/Mods/Editor/MdlMaterialEditor.cs index da580794..738e606e 100644 --- a/Penumbra/Mods/Editor/MdlMaterialEditor.cs +++ b/Penumbra/Mods/Editor/MdlMaterialEditor.cs @@ -1,12 +1,11 @@ +using OtterGui; using OtterGui.Compression; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.GameData.Enums; using Penumbra.GameData.Files; namespace Penumbra.Mods.Editor; -public partial class MdlMaterialEditor(ModFileCollection files) : IService +public partial class MdlMaterialEditor(ModFileCollection files) { [GeneratedRegex(@"/mt_c(?'RaceCode'\d{4})b0001_(?'Suffix'.*?)\.mtrl", RegexOptions.ExplicitCapture | RegexOptions.NonBacktracking)] private static partial Regex MaterialRegex(); diff --git a/Penumbra/Mods/Editor/ModEditor.cs b/Penumbra/Mods/Editor/ModEditor.cs index 19ca7022..37524da1 100644 --- a/Penumbra/Mods/Editor/ModEditor.cs +++ b/Penumbra/Mods/Editor/ModEditor.cs @@ -1,5 +1,5 @@ +using OtterGui; using OtterGui.Compression; -using OtterGui.Services; using Penumbra.Mods.Groups; using Penumbra.Mods.SubMods; @@ -14,7 +14,7 @@ public class ModEditor( ModSwapEditor swapEditor, MdlMaterialEditor mdlMaterialEditor, FileCompactor compactor) - : IDisposable, IService + : IDisposable { public readonly ModNormalizer ModNormalizer = modNormalizer; public readonly ModMetaEditor MetaEditor = metaEditor; @@ -25,21 +25,6 @@ public class ModEditor( public readonly MdlMaterialEditor MdlMaterialEditor = mdlMaterialEditor; public readonly FileCompactor Compactor = compactor; - - public bool IsLoading - { - get - { - lock (_lock) - { - return _loadingMod is { IsCompleted: false }; - } - } - } - - private readonly object _lock = new(); - private Task? _loadingMod; - public Mod? Mod { get; private set; } public int GroupIdx { get; private set; } public int DataIdx { get; private set; } @@ -47,42 +32,28 @@ public class ModEditor( public IModGroup? Group { get; private set; } public IModDataContainer? Option { get; private set; } - public async Task LoadMod(Mod mod, int groupIdx, int dataIdx) + public void LoadMod(Mod mod) + => LoadMod(mod, -1, 0); + + public void LoadMod(Mod mod, int groupIdx, int dataIdx) { - await AppendTask(() => - { - Mod = mod; - LoadOption(groupIdx, dataIdx, true); - Files.UpdateAll(mod, Option!); - SwapEditor.Revert(Option!); - MetaEditor.Load(Mod!, Option!); - Duplicates.Clear(); - MdlMaterialEditor.ScanModels(Mod!); - }); + Mod = mod; + LoadOption(groupIdx, dataIdx, true); + Files.UpdateAll(mod, Option!); + SwapEditor.Revert(Option!); + MetaEditor.Load(Mod!, Option!); + Duplicates.Clear(); + MdlMaterialEditor.ScanModels(Mod!); } - private Task AppendTask(Action run) + public void LoadOption(int groupIdx, int dataIdx) { - lock (_lock) - { - if (_loadingMod == null || _loadingMod.IsCompleted) - return _loadingMod = Task.Run(run); - - return _loadingMod = _loadingMod.ContinueWith(_ => run()); - } - } - - public async Task LoadOption(int groupIdx, int dataIdx) - { - await AppendTask(() => - { - LoadOption(groupIdx, dataIdx, true); - SwapEditor.Revert(Option!); - Files.UpdatePaths(Mod!, Option!); - MetaEditor.Load(Mod!, Option!); - FileEditor.Clear(); - Duplicates.Clear(); - }); + LoadOption(groupIdx, dataIdx, true); + SwapEditor.Revert(Option!); + Files.UpdatePaths(Mod!, Option!); + MetaEditor.Load(Mod!, Option!); + FileEditor.Clear(); + Duplicates.Clear(); } /// Load the correct option by indices for the currently loaded mod if possible, unload if not. diff --git a/Penumbra/Mods/Editor/ModFileCollection.cs b/Penumbra/Mods/Editor/ModFileCollection.cs index 15bd179e..551d04cf 100644 --- a/Penumbra/Mods/Editor/ModFileCollection.cs +++ b/Penumbra/Mods/Editor/ModFileCollection.cs @@ -1,20 +1,16 @@ using OtterGui; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.Mods.SubMods; using Penumbra.String.Classes; namespace Penumbra.Mods.Editor; -public class ModFileCollection : IDisposable, IService +public class ModFileCollection : IDisposable { private readonly List _available = []; private readonly List _mtrl = []; private readonly List _mdl = []; private readonly List _tex = []; private readonly List _shpk = []; - private readonly List _pbd = []; - private readonly List _atch = []; private readonly SortedSet _missing = []; private readonly HashSet _usedPaths = []; @@ -26,41 +22,35 @@ public class ModFileCollection : IDisposable, IService => Ready ? _usedPaths : []; public IReadOnlyList Available - => Ready ? _available : []; + => Ready ? _available : Array.Empty(); public IReadOnlyList Mtrl - => Ready ? _mtrl : []; + => Ready ? _mtrl : Array.Empty(); public IReadOnlyList Mdl - => Ready ? _mdl : []; + => Ready ? _mdl : Array.Empty(); public IReadOnlyList Tex - => Ready ? _tex : []; + => Ready ? _tex : Array.Empty(); public IReadOnlyList Shpk - => Ready ? _shpk : []; - - public IReadOnlyList Pbd - => Ready ? _pbd : []; - - public IReadOnlyList Atch - => Ready ? _atch : []; + => Ready ? _shpk : Array.Empty(); public bool Ready { get; private set; } = true; public void UpdateAll(Mod mod, IModDataContainer option) { - UpdateFiles(mod, CancellationToken.None); - UpdatePaths(mod, option, false, CancellationToken.None); + UpdateFiles(mod, new CancellationToken()); + UpdatePaths(mod, option, false, new CancellationToken()); } public void UpdatePaths(Mod mod, IModDataContainer option) - => UpdatePaths(mod, option, true, CancellationToken.None); + => UpdatePaths(mod, option, true, new CancellationToken()); public void Clear() { ClearFiles(); - ClearPaths(false, CancellationToken.None); + ClearPaths(false, new CancellationToken()); } public void Dispose() @@ -137,12 +127,6 @@ public class ModFileCollection : IDisposable, IService case ".shpk": _shpk.Add(registry); break; - case ".pbd": - _pbd.Add(registry); - break; - case ".atch": - _atch.Add(registry); - break; } } } @@ -154,8 +138,6 @@ public class ModFileCollection : IDisposable, IService _mdl.Clear(); _tex.Clear(); _shpk.Clear(); - _pbd.Clear(); - _atch.Clear(); } private void ClearPaths(bool clearRegistries, CancellationToken tok) diff --git a/Penumbra/Mods/Editor/ModFileEditor.cs b/Penumbra/Mods/Editor/ModFileEditor.cs index 3b765215..e2c0b726 100644 --- a/Penumbra/Mods/Editor/ModFileEditor.cs +++ b/Penumbra/Mods/Editor/ModFileEditor.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; using Penumbra.Services; @@ -6,7 +5,7 @@ using Penumbra.String.Classes; namespace Penumbra.Mods.Editor; -public class ModFileEditor(ModFileCollection files, ModManager modManager, CommunicatorService communicator) : IService +public class ModFileEditor(ModFileCollection files, ModManager modManager, CommunicatorService communicator) { public bool Changes { get; private set; } @@ -151,7 +150,7 @@ public class ModFileEditor(ModFileCollection files, ModManager modManager, Commu if (deletions <= 0) return; - modManager.Creator.ReloadMod(mod, false, false, out _); + modManager.Creator.ReloadMod(mod, false, out _); files.UpdateAll(mod, option); } diff --git a/Penumbra/Mods/Editor/ModMerger.cs b/Penumbra/Mods/Editor/ModMerger.cs index eb270e13..d6e21076 100644 --- a/Penumbra/Mods/Editor/ModMerger.cs +++ b/Penumbra/Mods/Editor/ModMerger.cs @@ -1,32 +1,30 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Utility; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.Communication; -using Penumbra.Mods.Groups; using Penumbra.Mods.Manager; using Penumbra.Mods.Manager.OptionEditor; using Penumbra.Mods.SubMods; using Penumbra.Services; using Penumbra.String.Classes; +using Penumbra.UI.ModsTab; namespace Penumbra.Mods.Editor; -public class ModMerger : IDisposable, IService +public class ModMerger : IDisposable { - private readonly Configuration _config; - private readonly CommunicatorService _communicator; - private readonly ModGroupEditor _editor; - private readonly ModSelection _selection; - private readonly DuplicateManager _duplicates; - private readonly ModManager _mods; - private readonly ModCreator _creator; + private readonly Configuration _config; + private readonly CommunicatorService _communicator; + private readonly ModGroupEditor _editor; + private readonly ModFileSystemSelector _selector; + private readonly DuplicateManager _duplicates; + private readonly ModManager _mods; + private readonly ModCreator _creator; public Mod? MergeFromMod - => _selection.Mod; + => _selector.Selected; public Mod? MergeToMod; public string OptionGroupName = "Merges"; @@ -39,26 +37,26 @@ public class ModMerger : IDisposable, IService public readonly HashSet SelectedOptions = []; - public readonly IReadOnlyList Warnings = new List(); + public readonly IReadOnlyList Warnings = []; public Exception? Error { get; private set; } - public ModMerger(ModManager mods, ModGroupEditor editor, ModSelection selection, DuplicateManager duplicates, + public ModMerger(ModManager mods, ModGroupEditor editor, ModFileSystemSelector selector, DuplicateManager duplicates, CommunicatorService communicator, ModCreator creator, Configuration config) { - _editor = editor; - _selection = selection; - _duplicates = duplicates; - _communicator = communicator; - _creator = creator; - _config = config; - _mods = mods; - _selection.Subscribe(OnSelectionChange, ModSelection.Priority.ModMerger); + _editor = editor; + _selector = selector; + _duplicates = duplicates; + _communicator = communicator; + _creator = creator; + _config = config; + _mods = mods; + _selector.SelectionChanged += OnSelectionChange; _communicator.ModPathChanged.Subscribe(OnModPathChange, ModPathChanged.Priority.ModMerger); } public void Dispose() { - _selection.Unsubscribe(OnSelectionChange); + _selector.SelectionChanged -= OnSelectionChange; _communicator.ModPathChanged.Unsubscribe(OnModPathChange); } @@ -100,117 +98,26 @@ public class ModMerger : IDisposable, IService foreach (var originalGroup in MergeFromMod!.Groups) { - switch (originalGroup.Type) + var (group, groupIdx, groupCreated) = _editor.FindOrAddModGroup(MergeToMod!, originalGroup.Type, originalGroup.Name); + if (groupCreated) + _createdGroups.Add(groupIdx); + if (group == null) + throw new Exception( + $"The merged group {originalGroup.Name} already existed, but had a different type than the original group of type {originalGroup.Type}."); + + foreach (var originalOption in group.DataContainers) { - case GroupType.Single: - case GroupType.Multi: + var (option, _, optionCreated) = _editor.FindOrAddOption(group, originalOption.GetName()); + if (optionCreated) { - var (group, groupIdx, groupCreated) = _editor.FindOrAddModGroup(MergeToMod!, originalGroup.Type, originalGroup.Name); - if (group is null) - throw new Exception( - $"The merged group {originalGroup.Name} already existed, but had a different type than the original group of type {originalGroup.Type}."); - - if (groupCreated) - { - _createdGroups.Add(groupIdx); - group.Description = originalGroup.Description; - group.Image = originalGroup.Image; - group.DefaultSettings = originalGroup.DefaultSettings; - group.Page = originalGroup.Page; - group.Priority = originalGroup.Priority; - } - - foreach (var originalOption in originalGroup.Options) - { - var (option, _, optionCreated) = _editor.FindOrAddOption(group, originalOption.Name); - if (optionCreated) - { - _createdOptions.Add(option!); - MergeIntoOption([(IModDataContainer)originalOption], (IModDataContainer)option!, false); - option!.Description = originalOption.Description; - if (option is MultiSubMod multiOption) - multiOption.Priority = ((MultiSubMod)originalOption).Priority; - } - else - { - throw new Exception( - $"Could not merge {MergeFromMod!.Name} into {MergeToMod!.Name}: The option {option!.FullName} already existed."); - } - } - - break; + _createdOptions.Add(option!); + // #TODO DataContainer <> Option. + MergeIntoOption([originalOption], (IModDataContainer)option!, false); } - - case GroupType.Imc when originalGroup is ImcModGroup imc: + else { - var group = _editor.ImcEditor.AddModGroup(MergeToMod!, imc.Name, imc.Identifier, imc.DefaultEntry); - if (group is null) - throw new Exception( - $"The merged group {originalGroup.Name} already existed, but groups of type {originalGroup.Type} can not be merged."); - - group.AllVariants = imc.AllVariants; - group.OnlyAttributes = imc.OnlyAttributes; - group.Description = imc.Description; - group.Image = imc.Image; - group.DefaultSettings = imc.DefaultSettings; - group.Page = imc.Page; - group.Priority = imc.Priority; - foreach (var originalOption in imc.OptionData) - { - if (originalOption.IsDisableSubMod) - { - _editor.ImcEditor.ChangeCanBeDisabled(group, true); - var disable = group.OptionData.First(s => s.IsDisableSubMod); - disable.Description = originalOption.Description; - disable.Name = originalOption.Name; - continue; - } - - var newOption = _editor.ImcEditor.AddOption(group, originalOption.Name); - if (newOption is null) - throw new Exception( - $"Could not merge {MergeFromMod!.Name} into {MergeToMod!.Name}: Unknown error when creating IMC option {originalOption.FullName}."); - - newOption.Description = originalOption.Description; - newOption.AttributeMask = originalOption.AttributeMask; - } - - break; - } - case GroupType.Combining when originalGroup is CombiningModGroup combining: - { - var group = _editor.CombiningEditor.AddModGroup(MergeToMod!, combining.Name); - if (group is null) - throw new Exception( - $"The merged group {originalGroup.Name} already existed, but groups of type {originalGroup.Type} can not be merged."); - - group.Description = combining.Description; - group.Image = combining.Image; - group.DefaultSettings = combining.DefaultSettings; - group.Page = combining.Page; - group.Priority = combining.Priority; - foreach (var originalOption in combining.OptionData) - { - var option = _editor.CombiningEditor.AddOption(group, originalOption.Name); - if (option is null) - throw new Exception( - $"Could not merge {MergeFromMod!.Name} into {MergeToMod!.Name}: Unknown error when creating combining option {originalOption.FullName}."); - - option.Description = originalOption.Description; - } - - if (group.Data.Count != combining.Data.Count) - throw new Exception( - $"Could not merge {MergeFromMod!.Name} into {MergeToMod!.Name}: Unknown error caused data container counts in combining group {originalGroup.Name} to differ."); - - foreach (var (originalContainer, container) in combining.Data.Zip(group.Data)) - { - container.Name = originalContainer.Name; - MergeIntoOption([originalContainer], container, false); - } - - - break; + throw new Exception( + $"Could not merge {MergeFromMod!.Name} into {MergeToMod!.Name}: The option {option!.FullName} already existed."); } } } @@ -243,6 +150,7 @@ public class ModMerger : IDisposable, IService if (!dir.Exists) _createdDirectories.Add(dir.FullName); CopyFiles(dir); + // #TODO DataContainer <> Option. MergeIntoOption(MergeFromMod!.AllDataContainers.Reverse(), (IModDataContainer)option!, true); } @@ -250,13 +158,16 @@ public class ModMerger : IDisposable, IService { var redirections = option.Files.ToDictionary(kvp => kvp.Key, kvp => kvp.Value); var swaps = option.FileSwaps.ToDictionary(kvp => kvp.Key, kvp => kvp.Value); - var manips = option.Manipulations.Clone(); + var manips = option.Manipulations.ToHashSet(); foreach (var originalOption in mergeOptions) { - if (!manips.MergeForced(originalOption.Manipulations, out var failed)) - throw new Exception( - $"Could not add meta manipulation {failed} from {originalOption.GetFullName()} to {option.GetFullName()} because another manipulation of the same data already exists in this option."); + foreach (var manip in originalOption.Manipulations) + { + if (!manips.Add(manip)) + throw new Exception( + $"Could not add meta manipulation {manip} from {originalOption.GetFullName()} to {option.GetFullName()} because another manipulation of the same data already exists in this option."); + } foreach (var (swapA, swapB) in originalOption.FileSwaps) { @@ -278,15 +189,14 @@ public class ModMerger : IDisposable, IService _editor.SetFiles(option, redirections, SaveType.None); _editor.SetFileSwaps(option, swaps, SaveType.None); - _editor.SetManipulations(option, manips, SaveType.None); - _editor.ForceSave(option, SaveType.ImmediateSync); + _editor.SetManipulations(option, manips, SaveType.ImmediateSync); return; bool GetFullPath(FullPath input, out FullPath ret) { if (fromFileToFile) { - if (!_fileToFile.TryGetValue(input.FullName.ToLowerInvariant(), out var s)) + if (!_fileToFile.TryGetValue(input.FullName, out var s)) { ret = input; return false; @@ -328,7 +238,7 @@ public class ModMerger : IDisposable, IService Directory.CreateDirectory(finalDir); file.CopyTo(path); Penumbra.Log.Verbose($"[Merger] Copied file {file.FullName} to {path}."); - _fileToFile.Add(file.FullName.ToLowerInvariant(), path); + _fileToFile.Add(file.FullName, path); } } @@ -348,15 +258,14 @@ public class ModMerger : IDisposable, IService if (dir == null) throw new Exception($"Could not split off mods, unable to create new mod with name {modName}."); - _mods.AddMod(dir, false); + _mods.AddMod(dir); result = _mods[^1]; if (mods.Count == 1) { var files = CopySubModFiles(mods[0], dir); - _editor.SetFiles(result.Default, files, SaveType.None); - _editor.SetFileSwaps(result.Default, mods[0].FileSwaps, SaveType.None); - _editor.SetManipulations(result.Default, mods[0].Manipulations, SaveType.None); - _editor.ForceSave(result.Default); + _editor.SetFiles(result.Default, files); + _editor.SetFileSwaps(result.Default, mods[0].FileSwaps); + _editor.SetManipulations(result.Default, mods[0].Manipulations); } else { @@ -368,18 +277,17 @@ public class ModMerger : IDisposable, IService _editor.SetFiles(result.Default, files); _editor.SetFileSwaps(result.Default, mods[0].FileSwaps); _editor.SetManipulations(result.Default, mods[0].Manipulations); - _editor.ForceSave(result.Default); } else { + // TODO DataContainer <> Option. var (group, _, _) = _editor.FindOrAddModGroup(result, originalGroup.Type, originalGroup.Name); var (option, _, _) = _editor.FindOrAddOption(group!, originalOption.GetName()); var folder = Path.Combine(dir.FullName, group!.Name, option!.Name); var files = CopySubModFiles(originalOption, new DirectoryInfo(folder)); - _editor.SetFiles((IModDataContainer)option, files, SaveType.None); - _editor.SetFileSwaps((IModDataContainer)option, originalOption.FileSwaps, SaveType.None); - _editor.SetManipulations((IModDataContainer)option, originalOption.Manipulations, SaveType.None); - _editor.ForceSave((IModDataContainer)option); + _editor.SetFiles((IModDataContainer)option, files); + _editor.SetFileSwaps((IModDataContainer)option, originalOption.FileSwaps); + _editor.SetManipulations((IModDataContainer)option, originalOption.Manipulations); } } } @@ -480,7 +388,7 @@ public class ModMerger : IDisposable, IService } } - private void OnSelectionChange(Mod? oldSelection, Mod? newSelection) + private void OnSelectionChange(Mod? oldSelection, Mod? newSelection, in ModFileSystemSelector.ModState state) { if (OptionGroupName == "Merges" && OptionName.Length == 0 || OptionName == oldSelection?.Name.Text) OptionName = newSelection?.Name.Text ?? string.Empty; diff --git a/Penumbra/Mods/Editor/ModMetaEditor.cs b/Penumbra/Mods/Editor/ModMetaEditor.cs index b4db457d..829161f5 100644 --- a/Penumbra/Mods/Editor/ModMetaEditor.cs +++ b/Penumbra/Mods/Editor/ModMetaEditor.cs @@ -1,342 +1,212 @@ -using System.Collections.Frozen; -using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Collections.Cache; -using Penumbra.Meta; -using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Groups; -using Penumbra.Mods.Manager.OptionEditor; +using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; -using Penumbra.Services; -using static Penumbra.GameData.Files.ShpkFile; namespace Penumbra.Mods.Editor; -public class ModMetaEditor( - ModGroupEditor groupEditor, - MetaFileManager metaFileManager) : MetaDictionary, IService +public class ModMetaEditor(ModManager modManager) { - public sealed class OtherOptionData : HashSet + private readonly HashSet _imc = []; + private readonly HashSet _eqp = []; + private readonly HashSet _eqdp = []; + private readonly HashSet _gmp = []; + private readonly HashSet _est = []; + private readonly HashSet _rsp = []; + private readonly HashSet _globalEqp = []; + + public int OtherImcCount { get; private set; } + public int OtherEqpCount { get; private set; } + public int OtherEqdpCount { get; private set; } + public int OtherGmpCount { get; private set; } + public int OtherEstCount { get; private set; } + public int OtherRspCount { get; private set; } + public int OtherGlobalEqpCount { get; private set; } + + public bool Changes { get; private set; } + + public IReadOnlySet Imc + => _imc; + + public IReadOnlySet Eqp + => _eqp; + + public IReadOnlySet Eqdp + => _eqdp; + + public IReadOnlySet Gmp + => _gmp; + + public IReadOnlySet Est + => _est; + + public IReadOnlySet Rsp + => _rsp; + + public IReadOnlySet GlobalEqp + => _globalEqp; + + public bool CanAdd(MetaManipulation m) { - public int TotalCount; - - public void Add(string name, int count) + return m.ManipulationType switch { - if (count > 0) - Add(name); - TotalCount += count; - } - - public new void Clear() - { - TotalCount = 0; - base.Clear(); - } + MetaManipulation.Type.Imc => !_imc.Contains(m.Imc), + MetaManipulation.Type.Eqdp => !_eqdp.Contains(m.Eqdp), + MetaManipulation.Type.Eqp => !_eqp.Contains(m.Eqp), + MetaManipulation.Type.Est => !_est.Contains(m.Est), + MetaManipulation.Type.Gmp => !_gmp.Contains(m.Gmp), + MetaManipulation.Type.Rsp => !_rsp.Contains(m.Rsp), + MetaManipulation.Type.GlobalEqp => !_globalEqp.Contains(m.GlobalEqp), + _ => false, + }; } - public readonly FrozenDictionary OtherData = - Enum.GetValues().ToFrozenDictionary(t => t, _ => new OtherOptionData()); - - public bool Changes { get; set; } - - public new void Clear() + public bool Add(MetaManipulation m) { - Changes = Count > 0; - base.Clear(); + var added = m.ManipulationType switch + { + MetaManipulation.Type.Imc => _imc.Add(m.Imc), + MetaManipulation.Type.Eqdp => _eqdp.Add(m.Eqdp), + MetaManipulation.Type.Eqp => _eqp.Add(m.Eqp), + MetaManipulation.Type.Est => _est.Add(m.Est), + MetaManipulation.Type.Gmp => _gmp.Add(m.Gmp), + MetaManipulation.Type.Rsp => _rsp.Add(m.Rsp), + MetaManipulation.Type.GlobalEqp => _globalEqp.Add(m.GlobalEqp), + _ => false, + }; + Changes |= added; + return added; + } + + public bool Delete(MetaManipulation m) + { + var deleted = m.ManipulationType switch + { + MetaManipulation.Type.Imc => _imc.Remove(m.Imc), + MetaManipulation.Type.Eqdp => _eqdp.Remove(m.Eqdp), + MetaManipulation.Type.Eqp => _eqp.Remove(m.Eqp), + MetaManipulation.Type.Est => _est.Remove(m.Est), + MetaManipulation.Type.Gmp => _gmp.Remove(m.Gmp), + MetaManipulation.Type.Rsp => _rsp.Remove(m.Rsp), + MetaManipulation.Type.GlobalEqp => _globalEqp.Remove(m.GlobalEqp), + _ => false, + }; + Changes |= deleted; + return deleted; + } + + public bool Change(MetaManipulation m) + => Delete(m) && Add(m); + + public bool Set(MetaManipulation m) + => Delete(m) | Add(m); + + public void Clear() + { + _imc.Clear(); + _eqp.Clear(); + _eqdp.Clear(); + _gmp.Clear(); + _est.Clear(); + _rsp.Clear(); + _globalEqp.Clear(); + Changes = true; } public void Load(Mod mod, IModDataContainer currentOption) { - foreach (var type in Enum.GetValues()) - OtherData[type].Clear(); - + OtherImcCount = 0; + OtherEqpCount = 0; + OtherEqdpCount = 0; + OtherGmpCount = 0; + OtherEstCount = 0; + OtherRspCount = 0; + OtherGlobalEqpCount = 0; foreach (var option in mod.AllDataContainers) { if (option == currentOption) continue; - var name = option.GetFullName(); - OtherData[MetaManipulationType.Imc].Add(name, option.Manipulations.GetCount(MetaManipulationType.Imc)); - OtherData[MetaManipulationType.Eqp].Add(name, option.Manipulations.GetCount(MetaManipulationType.Eqp)); - OtherData[MetaManipulationType.Eqdp].Add(name, option.Manipulations.GetCount(MetaManipulationType.Eqdp)); - OtherData[MetaManipulationType.Gmp].Add(name, option.Manipulations.GetCount(MetaManipulationType.Gmp)); - OtherData[MetaManipulationType.Est].Add(name, option.Manipulations.GetCount(MetaManipulationType.Est)); - OtherData[MetaManipulationType.Rsp].Add(name, option.Manipulations.GetCount(MetaManipulationType.Rsp)); - OtherData[MetaManipulationType.Atch].Add(name, option.Manipulations.GetCount(MetaManipulationType.Atch)); - OtherData[MetaManipulationType.Shp].Add(name, option.Manipulations.GetCount(MetaManipulationType.Shp)); - OtherData[MetaManipulationType.Atr].Add(name, option.Manipulations.GetCount(MetaManipulationType.Atr)); - OtherData[MetaManipulationType.GlobalEqp].Add(name, option.Manipulations.GetCount(MetaManipulationType.GlobalEqp)); - } - - Clear(); - UnionWith(currentOption.Manipulations); - Changes = false; - } - - public static bool DeleteDefaultValues(Mod mod, MetaFileManager metaFileManager, SaveService? saveService, bool deleteAll = false) - { - if (deleteAll) - { - var changes = false; - foreach (var container in mod.AllDataContainers) + foreach (var manip in option.Manipulations) { - if (!DeleteDefaultValues(metaFileManager, container.Manipulations)) - continue; - - saveService?.ImmediateSaveSync(new ModSaveGroup(container, metaFileManager.Config.ReplaceNonAsciiOnImport)); - changes = true; - } - - return changes; - } - - var defaultEntries = new MultiDictionary(); - var actualEntries = new HashSet(); - if (!FilterDefaultValues(mod.AllDataContainers, metaFileManager, defaultEntries, actualEntries)) - return false; - - var groups = new HashSet(); - DefaultSubMod? defaultMod = null; - foreach (var (defaultIdentifier, containers) in defaultEntries.Grouped) - { - if (!deleteAll && actualEntries.Contains(defaultIdentifier)) - continue; - - foreach (var container in containers) - { - if (!container.Manipulations.Remove(defaultIdentifier)) - continue; - - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {defaultIdentifier}."); - if (container.Group is { } group) - groups.Add(group); - else if (container is DefaultSubMod d) - defaultMod = d; + switch (manip.ManipulationType) + { + case MetaManipulation.Type.Imc: + ++OtherImcCount; + break; + case MetaManipulation.Type.Eqdp: + ++OtherEqdpCount; + break; + case MetaManipulation.Type.Eqp: + ++OtherEqpCount; + break; + case MetaManipulation.Type.Est: + ++OtherEstCount; + break; + case MetaManipulation.Type.Gmp: + ++OtherGmpCount; + break; + case MetaManipulation.Type.Rsp: + ++OtherRspCount; + break; + case MetaManipulation.Type.GlobalEqp: + ++OtherGlobalEqpCount; + break; + } } } - if (saveService is not null) - { - if (defaultMod is not null) - saveService.ImmediateSaveSync(new ModSaveGroup(defaultMod, metaFileManager.Config.ReplaceNonAsciiOnImport)); - foreach (var group in groups) - saveService.ImmediateSaveSync(new ModSaveGroup(group, metaFileManager.Config.ReplaceNonAsciiOnImport)); - } - - return defaultMod is not null || groups.Count > 0; + Split(currentOption.Manipulations); } - public void DeleteDefaultValues() - => Changes = DeleteDefaultValues(metaFileManager, this); - public void Apply(IModDataContainer container) { if (!Changes) return; - groupEditor.SetManipulations(container, this); + modManager.OptionEditor.SetManipulations(container, Recombine().ToHashSet()); Changes = false; } - private static bool FilterDefaultValues(IEnumerable containers, MetaFileManager metaFileManager, - MultiDictionary defaultEntries, HashSet actualEntries) + private void Split(IEnumerable manips) { - if (!metaFileManager.CharacterUtility.Ready) + Clear(); + foreach (var manip in manips) { - Penumbra.Log.Warning("Trying to filter default meta values before CharacterUtility was ready, skipped."); - return false; - } - - foreach (var container in containers) - { - foreach (var (key, value) in container.Manipulations.Imc) + switch (manip.ManipulationType) { - var defaultEntry = ImcChecker.GetDefaultEntry(key, false); - if (defaultEntry.Entry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Eqp) - { - var defaultEntry = new EqpEntryInternal(ExpandedEqpFile.GetDefault(metaFileManager, key.SetId), key.Slot); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Eqdp) - { - var defaultEntry = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(metaFileManager, key), key.Slot); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Est) - { - var defaultEntry = EstFile.GetDefault(metaFileManager, key); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Gmp) - { - var defaultEntry = ExpandedGmpFile.GetDefault(metaFileManager, key); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Rsp) - { - var defaultEntry = CmpFile.GetDefault(metaFileManager, key.SubRace, key.Attribute); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); - } - - foreach (var (key, value) in container.Manipulations.Atch) - { - var defaultEntry = AtchCache.GetDefault(metaFileManager, key); - if (defaultEntry.Equals(value)) - defaultEntries.TryAdd(key, container); - else - actualEntries.Add(key); + case MetaManipulation.Type.Imc: + _imc.Add(manip.Imc); + break; + case MetaManipulation.Type.Eqdp: + _eqdp.Add(manip.Eqdp); + break; + case MetaManipulation.Type.Eqp: + _eqp.Add(manip.Eqp); + break; + case MetaManipulation.Type.Est: + _est.Add(manip.Est); + break; + case MetaManipulation.Type.Gmp: + _gmp.Add(manip.Gmp); + break; + case MetaManipulation.Type.Rsp: + _rsp.Add(manip.Rsp); + break; + case MetaManipulation.Type.GlobalEqp: + _globalEqp.Add(manip.GlobalEqp); + break; } } - return true; + Changes = false; } - private static bool DeleteDefaultValues(MetaFileManager metaFileManager, MetaDictionary dict) - { - if (!metaFileManager.CharacterUtility.Ready) - { - Penumbra.Log.Warning("Trying to delete default meta values before CharacterUtility was ready, skipped."); - return false; - } - - var clone = dict.Clone(); - dict.ClearForDefault(); - - var count = 0; - foreach (var value in clone.GlobalEqp) - dict.TryAdd(value); - - foreach (var (key, value) in clone.Imc) - { - var defaultEntry = ImcChecker.GetDefaultEntry(key, false); - if (!defaultEntry.Entry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Eqp) - { - var defaultEntry = new EqpEntryInternal(ExpandedEqpFile.GetDefault(metaFileManager, key.SetId), key.Slot); - if (!defaultEntry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Eqdp) - { - var defaultEntry = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(metaFileManager, key), key.Slot); - if (!defaultEntry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Est) - { - var defaultEntry = EstFile.GetDefault(metaFileManager, key); - if (!defaultEntry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Gmp) - { - var defaultEntry = ExpandedGmpFile.GetDefault(metaFileManager, key); - if (!defaultEntry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Rsp) - { - var defaultEntry = CmpFile.GetDefault(metaFileManager, key.SubRace, key.Attribute); - if (!defaultEntry.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - foreach (var (key, value) in clone.Atch) - { - var defaultEntry = AtchCache.GetDefault(metaFileManager, key); - if (!defaultEntry.HasValue) - continue; - - if (!defaultEntry.Value.Equals(value)) - { - dict.TryAdd(key, value); - } - else - { - Penumbra.Log.Verbose($"Deleted default-valued meta-entry {key}."); - ++count; - } - } - - if (count == 0) - return false; - - Penumbra.Log.Debug($"Deleted {count} default-valued meta-entries from a mod option."); - return true; - } + public IEnumerable Recombine() + => _imc.Select(m => (MetaManipulation)m) + .Concat(_eqdp.Select(m => (MetaManipulation)m)) + .Concat(_eqp.Select(m => (MetaManipulation)m)) + .Concat(_est.Select(m => (MetaManipulation)m)) + .Concat(_gmp.Select(m => (MetaManipulation)m)) + .Concat(_rsp.Select(m => (MetaManipulation)m)) + .Concat(_globalEqp.Select(m => (MetaManipulation)m)); } diff --git a/Penumbra/Mods/Editor/ModNormalizer.cs b/Penumbra/Mods/Editor/ModNormalizer.cs index df1528f6..58e4fc08 100644 --- a/Penumbra/Mods/Editor/ModNormalizer.cs +++ b/Penumbra/Mods/Editor/ModNormalizer.cs @@ -1,17 +1,15 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; using OtterGui.Tasks; using Penumbra.Mods.Groups; using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; -using Penumbra.Services; using Penumbra.String.Classes; namespace Penumbra.Mods.Editor; -public class ModNormalizer(ModManager modManager, Configuration config, SaveService saveService) : IService +public class ModNormalizer(ModManager _modManager, Configuration _config) { private readonly List>> _redirections = []; @@ -41,103 +39,6 @@ public class ModNormalizer(ModManager modManager, Configuration config, SaveServ Worker = TrackedTask.Run(NormalizeSync); } - public void NormalizeUi(DirectoryInfo modDirectory) - { - if (!config.AutoReduplicateUiOnImport) - return; - - if (modManager.Creator.LoadMod(modDirectory, false, false) is not { } mod) - return; - - Dictionary> paths = []; - Dictionary containers = []; - foreach (var container in mod.AllDataContainers) - { - foreach (var (gamePath, path) in container.Files) - { - if (!gamePath.Path.StartsWith("ui/"u8)) - continue; - - if (!paths.TryGetValue(path, out var list)) - { - list = []; - paths.Add(path, list); - } - - list.Add((container, gamePath)); - containers.TryAdd(container, string.Empty); - } - } - - foreach (var container in containers.Keys.ToList()) - { - if (container.Group == null) - containers[container] = mod.ModPath.FullName; - else - { - var groupDir = ModCreator.NewOptionDirectory(mod.ModPath, container.Group.Name, config.ReplaceNonAsciiOnImport); - var optionDir = ModCreator.NewOptionDirectory(groupDir, container.GetDirectoryName(), config.ReplaceNonAsciiOnImport); - containers[container] = optionDir.FullName; - } - } - - var anyChanges = 0; - var modRootLength = mod.ModPath.FullName.Length + 1; - foreach (var (file, gamePaths) in paths) - { - if (gamePaths.Count < 2) - continue; - - var keptPath = false; - foreach (var (container, gamePath) in gamePaths) - { - var directory = containers[container]; - var relPath = new Utf8RelPath(gamePath).ToString(); - var newFilePath = Path.Combine(directory, relPath); - if (newFilePath == file.FullName) - { - Penumbra.Log.Verbose($"[UIReduplication] Kept {file.FullName[modRootLength..]} because new path was identical."); - keptPath = true; - continue; - } - - try - { - Directory.CreateDirectory(Path.GetDirectoryName(newFilePath)!); - File.Copy(file.FullName, newFilePath, false); - Penumbra.Log.Verbose($"[UIReduplication] Copied {file.FullName[modRootLength..]} to {newFilePath[modRootLength..]}."); - container.Files[gamePath] = new FullPath(newFilePath); - ++anyChanges; - } - catch (Exception ex) - { - Penumbra.Log.Error( - $"[UIReduplication] Failed to copy {file.FullName[modRootLength..]} to {newFilePath[modRootLength..]}:\n{ex}"); - } - } - - if (keptPath) - continue; - - try - { - File.Delete(file.FullName); - Penumbra.Log.Verbose($"[UIReduplication] Deleted {file.FullName[modRootLength..]} because no new path matched."); - } - catch (Exception ex) - { - Penumbra.Log.Error($"[UIReduplication] Failed to delete {file.FullName[modRootLength..]}:\n{ex}"); - } - } - - if (anyChanges == 0) - return; - - saveService.Save(SaveType.ImmediateSync, new ModSaveGroup(mod.Default, config.ReplaceNonAsciiOnImport)); - saveService.SaveAllOptionGroups(mod, false, config.ReplaceNonAsciiOnImport); - Penumbra.Log.Information($"[UIReduplication] Saved groups after {anyChanges} changes."); - } - private void NormalizeSync() { try @@ -267,7 +168,7 @@ public class ModNormalizer(ModManager modManager, Configuration config, SaveServ // Normalize all other options. foreach (var (group, groupIdx) in Mod.Groups.WithIndex()) { - var groupDir = ModCreator.CreateModFolder(directory, group.Name, config.ReplaceNonAsciiOnImport, true); + var groupDir = ModCreator.CreateModFolder(directory, group.Name, _config.ReplaceNonAsciiOnImport, true); _redirections[groupIdx + 1].EnsureCapacity(group.DataContainers.Count); for (var i = _redirections[groupIdx + 1].Count; i < group.DataContainers.Count; ++i) _redirections[groupIdx + 1].Add([]); @@ -286,8 +187,8 @@ public class ModNormalizer(ModManager modManager, Configuration config, SaveServ void HandleSubMod(DirectoryInfo groupDir, IModDataContainer option, Dictionary newDict) { - var name = option.GetDirectoryName(); - var optionDir = ModCreator.CreateModFolder(groupDir, name, config.ReplaceNonAsciiOnImport, true); + var name = option.GetName(); + var optionDir = ModCreator.CreateModFolder(groupDir, name, _config.ReplaceNonAsciiOnImport, true); newDict.Clear(); newDict.EnsureCapacity(option.Files.Count); @@ -376,10 +277,9 @@ public class ModNormalizer(ModManager modManager, Configuration config, SaveServ private void ApplyRedirections() { - modManager.OptionEditor.SetFiles(Mod.Default, _redirections[0][0]); foreach (var (group, groupIdx) in Mod.Groups.WithIndex()) foreach (var (container, containerIdx) in group.DataContainers.WithIndex()) - modManager.OptionEditor.SetFiles(container, _redirections[groupIdx + 1][containerIdx]); + _modManager.OptionEditor.SetFiles(container, _redirections[groupIdx + 1][containerIdx]); ++Step; } diff --git a/Penumbra/Mods/Editor/ModSwapEditor.cs b/Penumbra/Mods/Editor/ModSwapEditor.cs index 1a8ff2eb..0250efae 100644 --- a/Penumbra/Mods/Editor/ModSwapEditor.cs +++ b/Penumbra/Mods/Editor/ModSwapEditor.cs @@ -1,10 +1,10 @@ -using OtterGui.Services; +using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; using Penumbra.String.Classes; using Penumbra.Util; -public class ModSwapEditor(ModManager modManager) : IService +public class ModSwapEditor(ModManager modManager) { private readonly Dictionary _swaps = []; diff --git a/Penumbra/Mods/Editor/ModelMaterialInfo.cs b/Penumbra/Mods/Editor/ModelMaterialInfo.cs index fe46048f..741c2388 100644 --- a/Penumbra/Mods/Editor/ModelMaterialInfo.cs +++ b/Penumbra/Mods/Editor/ModelMaterialInfo.cs @@ -1,5 +1,5 @@ +using OtterGui; using OtterGui.Compression; -using OtterGui.Extensions; using Penumbra.GameData.Files; using Penumbra.String.Classes; diff --git a/Penumbra/Mods/FeatureChecker.cs b/Penumbra/Mods/FeatureChecker.cs deleted file mode 100644 index 10874fc9..00000000 --- a/Penumbra/Mods/FeatureChecker.cs +++ /dev/null @@ -1,95 +0,0 @@ -using System.Collections.Frozen; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using OtterGui.Text; -using Penumbra.Mods.Manager; -using Penumbra.UI.Classes; -using Notification = OtterGui.Classes.Notification; - -namespace Penumbra.Mods; - -public static class FeatureChecker -{ - /// Manually setup supported features to exclude None and Invalid and not make something supported too early. - private static readonly FrozenDictionary SupportedFlags = new[] - { - FeatureFlags.Atch, - FeatureFlags.Shp, - FeatureFlags.Atr, - }.ToFrozenDictionary(f => f.ToString(), f => f); - - public static IReadOnlyCollection SupportedFeatures - => SupportedFlags.Keys; - - public static FeatureFlags ParseFlags(string modDirectory, string modName, IEnumerable features) - { - var featureFlags = FeatureFlags.None; - HashSet missingFeatures = []; - foreach (var feature in features) - { - if (SupportedFlags.TryGetValue(feature, out var featureFlag)) - featureFlags |= featureFlag; - else - missingFeatures.Add(feature); - } - - if (missingFeatures.Count > 0) - { - Penumbra.Messager.AddMessage(new Notification( - $"Please update Penumbra to use the mod {modName}{(modDirectory != modName ? $" at {modDirectory}" : string.Empty)}!\n\nLoading failed because it requires the unsupported feature{(missingFeatures.Count > 1 ? $"s\n\n\t[{string.Join("], [", missingFeatures)}]." : $" [{missingFeatures.First()}].")}", - NotificationType.Warning)); - return FeatureFlags.Invalid; - } - - return featureFlags; - } - - public static bool Supported(string features) - => SupportedFlags.ContainsKey(features); - - public static void DrawFeatureFlagInput(ModDataEditor editor, Mod mod, float width) - { - const int numButtons = 5; - var innerSpacing = ImGui.GetStyle().ItemInnerSpacing; - var size = new Vector2((width - (numButtons - 1) * innerSpacing.X) / numButtons, 0); - var buttonColor = ImGui.GetColorU32(ImGuiCol.FrameBg); - var textColor = ImGui.GetColorU32(ImGuiCol.TextDisabled); - using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, innerSpacing) - .Push(ImGuiStyleVar.FrameBorderSize, 0); - using (var color = ImRaii.PushColor(ImGuiCol.Border, ColorId.FolderLine.Value()) - .Push(ImGuiCol.Button, buttonColor) - .Push(ImGuiCol.Text, textColor)) - { - foreach (var flag in SupportedFlags.Values) - { - if (mod.RequiredFeatures.HasFlag(flag)) - { - style.Push(ImGuiStyleVar.FrameBorderSize, ImUtf8.GlobalScale); - color.Pop(2); - if (ImUtf8.Button($"{flag}", size)) - editor.ChangeRequiredFeatures(mod, mod.RequiredFeatures & ~flag); - color.Push(ImGuiCol.Button, buttonColor) - .Push(ImGuiCol.Text, textColor); - style.Pop(); - } - else if (ImUtf8.Button($"{flag}", size)) - { - editor.ChangeRequiredFeatures(mod, mod.RequiredFeatures | flag); - } - - ImGui.SameLine(); - } - } - - if (ImUtf8.ButtonEx("Compute"u8, "Compute the required features automatically from the used features."u8, size)) - editor.ChangeRequiredFeatures(mod, mod.ComputeRequiredFeatures()); - - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Clear"u8, "Clear all required features."u8, size)) - editor.ChangeRequiredFeatures(mod, FeatureFlags.None); - - ImGui.SameLine(); - ImUtf8.Text("Required Features"u8); - } -} diff --git a/Penumbra/Mods/Groups/CombiningModGroup.cs b/Penumbra/Mods/Groups/CombiningModGroup.cs deleted file mode 100644 index d3f14101..00000000 --- a/Penumbra/Mods/Groups/CombiningModGroup.cs +++ /dev/null @@ -1,197 +0,0 @@ -using Dalamud.Interface.ImGuiNotification; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using OtterGui; -using OtterGui.Classes; -using OtterGui.Extensions; -using Penumbra.Api.Enums; -using Penumbra.GameData.Data; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Settings; -using Penumbra.Mods.SubMods; -using Penumbra.String.Classes; -using Penumbra.UI.ModsTab.Groups; -using Penumbra.Util; - -namespace Penumbra.Mods.Groups; - -/// Groups that allow all available options to be selected at once. -public sealed class CombiningModGroup : IModGroup -{ - public GroupType Type - => GroupType.Combining; - - public GroupDrawBehaviour Behaviour - => GroupDrawBehaviour.MultiSelection; - - public Mod Mod { get; } - public string Name { get; set; } = "Group"; - public string Description { get; set; } = string.Empty; - public string Image { get; set; } = string.Empty; - public ModPriority Priority { get; set; } - public int Page { get; set; } - public Setting DefaultSettings { get; set; } - public readonly List OptionData = []; - public List Data { get; private set; } - - /// Groups that allow all available options to be selected at once. - public CombiningModGroup(Mod mod) - { - Mod = mod; - Data = [new CombinedDataContainer(this)]; - } - - IReadOnlyList IModGroup.Options - => OptionData; - - public IReadOnlyList DataContainers - => Data; - - public bool IsOption - => OptionData.Count > 0; - - public FullPath? FindBestMatch(Utf8GamePath gamePath) - { - foreach (var path in Data.SelectWhere(o - => (o.Files.TryGetValue(gamePath, out var file) || o.FileSwaps.TryGetValue(gamePath, out file), file))) - return path; - - return null; - } - - public IModOption? AddOption(string name, string description = "") - { - var groupIdx = Mod.Groups.IndexOf(this); - if (groupIdx < 0) - return null; - - var subMod = new CombiningSubMod(this) - { - Name = name, - Description = description, - }; - return OptionData.AddNewWithPowerSet(Data, subMod, () => new CombinedDataContainer(this), IModGroup.MaxCombiningOptions) - ? subMod - : null; - } - - public static CombiningModGroup? Load(Mod mod, JObject json) - { - var ret = new CombiningModGroup(mod, true); - if (!ModSaveGroup.ReadJsonBase(json, ret)) - return null; - - var options = json["Options"]; - if (options != null) - foreach (var child in options.Children()) - { - if (ret.OptionData.Count == IModGroup.MaxCombiningOptions) - { - Penumbra.Messager.NotificationMessage( - $"Combining Group {ret.Name} in {mod.Name} has more than {IModGroup.MaxCombiningOptions} options, ignoring excessive options.", - NotificationType.Warning); - break; - } - - var subMod = new CombiningSubMod(ret, child); - ret.OptionData.Add(subMod); - } - - var requiredContainers = 1 << ret.OptionData.Count; - var containers = json["Containers"]; - if (containers != null) - foreach (var child in containers.Children()) - { - if (requiredContainers <= ret.Data.Count) - { - Penumbra.Messager.NotificationMessage( - $"Combining Group {ret.Name} in {mod.Name} has more data containers than it can support with {ret.OptionData.Count} options, ignoring excessive containers.", - NotificationType.Warning); - break; - } - - var container = new CombinedDataContainer(ret, child); - ret.Data.Add(container); - } - - if (requiredContainers > ret.Data.Count) - { - Penumbra.Messager.NotificationMessage( - $"Combining Group {ret.Name} in {mod.Name} has not enough data containers for its {ret.OptionData.Count} options, filling with empty containers.", - NotificationType.Warning); - ret.Data.EnsureCapacity(requiredContainers); - ret.Data.AddRange(Enumerable.Repeat(0, requiredContainers - ret.Data.Count).Select(_ => new CombinedDataContainer(ret))); - } - - ret.DefaultSettings = ret.FixSetting(ret.DefaultSettings); - - return ret; - } - - public int GetIndex() - => ModGroup.GetIndex(this); - - public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer) - => new CombiningModGroupEditDrawer(editDrawer, this); - - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations) - => Data[setting.AsIndex].AddDataTo(redirections, manipulations); - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - foreach (var container in DataContainers) - identifier.AddChangedItems(container, changedItems); - } - - public void WriteJson(JsonTextWriter jWriter, JsonSerializer serializer, DirectoryInfo? basePath = null) - { - ModSaveGroup.WriteJsonBase(jWriter, this); - jWriter.WritePropertyName("Options"); - jWriter.WriteStartArray(); - foreach (var option in OptionData) - { - jWriter.WriteStartObject(); - SubMod.WriteModOption(jWriter, option); - jWriter.WriteEndObject(); - } - - jWriter.WriteEndArray(); - - jWriter.WritePropertyName("Containers"); - jWriter.WriteStartArray(); - foreach (var container in Data) - { - jWriter.WriteStartObject(); - if (container.Name.Length > 0) - { - jWriter.WritePropertyName("Name"); - jWriter.WriteValue(container.Name); - } - - SubMod.WriteModContainer(jWriter, serializer, container, basePath ?? Mod.ModPath); - jWriter.WriteEndObject(); - } - - jWriter.WriteEndArray(); - } - - public (int Redirections, int Swaps, int Manips) GetCounts() - => ModGroup.GetCountsBase(this); - - public Setting FixSetting(Setting setting) - => new(Math.Min(setting.Value, (ulong)(Data.Count - 1))); - - /// Create a group without a mod only for saving it in the creator. - internal static CombiningModGroup WithoutMod(string name) - => new(null!) - { - Name = name, - }; - - /// For loading when no empty container should be created. - private CombiningModGroup(Mod mod, bool _) - { - Mod = mod; - Data = []; - } -} diff --git a/Penumbra/Mods/Groups/ComplexModGroup.cs b/Penumbra/Mods/Groups/ComplexModGroup.cs deleted file mode 100644 index 435bc253..00000000 --- a/Penumbra/Mods/Groups/ComplexModGroup.cs +++ /dev/null @@ -1,180 +0,0 @@ -using Dalamud.Interface.ImGuiNotification; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using OtterGui.Classes; -using OtterGui.Extensions; -using Penumbra.Api.Enums; -using Penumbra.GameData.Data; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Settings; -using Penumbra.Mods.SubMods; -using Penumbra.String.Classes; -using Penumbra.UI.ModsTab.Groups; -using Penumbra.Util; - -namespace Penumbra.Mods.Groups; - -public sealed class ComplexModGroup(Mod mod) : IModGroup -{ - public Mod Mod { get; } = mod; - public string Name { get; set; } = "Option"; - public string Description { get; set; } = string.Empty; - public string Image { get; set; } = string.Empty; - - public GroupType Type - => GroupType.Complex; - - public GroupDrawBehaviour Behaviour - => GroupDrawBehaviour.Complex; - - public ModPriority Priority { get; set; } - public int Page { get; set; } - public Setting DefaultSettings { get; set; } - - public readonly List Options = []; - public readonly List Containers = []; - - - public FullPath? FindBestMatch(Utf8GamePath gamePath) - => throw new NotImplementedException(); - - public IModOption? AddOption(string name, string description = "") - => throw new NotImplementedException(); - - IReadOnlyList IModGroup.Options - => Options; - - IReadOnlyList IModGroup.DataContainers - => Containers; - - public bool IsOption - => Options.Count > 0; - - public int GetIndex() - => ModGroup.GetIndex(this); - - public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer) - => throw new NotImplementedException(); - - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations) - { - foreach (var container in Containers.Where(c => c.Association.IsEnabled(setting))) - SubMod.AddContainerTo(container, redirections, manipulations); - } - - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - { - foreach (var container in Containers) - identifier.AddChangedItems(container, changedItems); - } - - public Setting FixSetting(Setting setting) - => new(setting.Value & ((1ul << Options.Count) - 1)); - - public void WriteJson(JsonTextWriter jWriter, JsonSerializer serializer, DirectoryInfo? basePath = null) - { - ModSaveGroup.WriteJsonBase(jWriter, this); - jWriter.WritePropertyName("Options"); - jWriter.WriteStartArray(); - foreach (var option in Options) - { - jWriter.WriteStartObject(); - SubMod.WriteModOption(jWriter, option); - if (!option.Conditions.IsZero) - { - jWriter.WritePropertyName("ConditionMask"); - jWriter.WriteValue(option.Conditions.Mask.Value); - jWriter.WritePropertyName("ConditionValue"); - jWriter.WriteValue(option.Conditions.Value.Value); - } - - if (option.Indentation > 0) - { - jWriter.WritePropertyName("Indentation"); - jWriter.WriteValue(option.Indentation); - } - - if (option.SubGroupLabel.Length > 0) - { - jWriter.WritePropertyName("SubGroup"); - jWriter.WriteValue(option.SubGroupLabel); - } - - jWriter.WriteEndObject(); - } - - jWriter.WriteEndArray(); - - jWriter.WritePropertyName("Containers"); - jWriter.WriteStartArray(); - foreach (var container in Containers) - { - jWriter.WriteStartObject(); - if (container.Name.Length > 0) - { - jWriter.WritePropertyName("Name"); - jWriter.WriteValue(container.Name); - } - - if (!container.Association.IsZero) - { - jWriter.WritePropertyName("AssociationMask"); - jWriter.WriteValue(container.Association.Mask.Value); - - jWriter.WritePropertyName("AssociationValue"); - jWriter.WriteValue(container.Association.Value.Value); - } - - SubMod.WriteModContainer(jWriter, serializer, container, basePath ?? Mod.ModPath); - jWriter.WriteEndObject(); - } - - jWriter.WriteEndArray(); - } - - public (int Redirections, int Swaps, int Manips) GetCounts() - => ModGroup.GetCountsBase(this); - - public static ComplexModGroup? Load(Mod mod, JObject json) - { - var ret = new ComplexModGroup(mod); - if (!ModSaveGroup.ReadJsonBase(json, ret)) - return null; - - var options = json["Options"]; - if (options != null) - foreach (var child in options.Children()) - { - if (ret.Options.Count == IModGroup.MaxComplexOptions) - { - Penumbra.Messager.NotificationMessage( - $"Complex Group {ret.Name} in {mod.Name} has more than {IModGroup.MaxComplexOptions} options, ignoring excessive options.", - NotificationType.Warning); - break; - } - - var subMod = new ComplexSubMod(ret, child); - ret.Options.Add(subMod); - } - - // Fix up conditions: No condition on itself. - foreach (var (option, index) in ret.Options.WithIndex()) - { - option.Conditions = option.Conditions.Limit(ret.Options.Count); - option.Conditions = new MaskedSetting(option.Conditions.Mask.SetBit(index, false), option.Conditions.Value); - } - - var containers = json["Containers"]; - if (containers != null) - foreach (var child in containers.Children()) - { - var container = new ComplexDataContainer(ret, child); - container.Association = container.Association.Limit(ret.Options.Count); - ret.Containers.Add(container); - } - - ret.DefaultSettings = ret.FixSetting(ret.DefaultSettings); - - return ret; - } -} diff --git a/Penumbra/Mods/Groups/IModGroup.cs b/Penumbra/Mods/Groups/IModGroup.cs index 98f62862..fcc8c093 100644 --- a/Penumbra/Mods/Groups/IModGroup.cs +++ b/Penumbra/Mods/Groups/IModGroup.cs @@ -18,30 +18,19 @@ public enum GroupDrawBehaviour { SingleSelection, MultiSelection, - Complex, } public interface IModGroup { - public const int MaxMultiOptions = 32; - public const int MaxComplexOptions = MaxMultiOptions; - public const int MaxCombiningOptions = 8; + public const int MaxMultiOptions = 32; - public Mod Mod { get; } - public string Name { get; set; } - public string Description { get; set; } - - /// Unused in Penumbra but for better TexTools interop. - public string Image { get; set; } - - public GroupType Type { get; } - public GroupDrawBehaviour Behaviour { get; } - public ModPriority Priority { get; set; } - - /// Unused in Penumbra but for better TexTools interop. - public int Page { get; set; } - - public Setting DefaultSettings { get; set; } + public Mod Mod { get; } + public string Name { get; set; } + public string Description { get; set; } + public GroupType Type { get; } + public GroupDrawBehaviour Behaviour { get; } + public ModPriority Priority { get; set; } + public Setting DefaultSettings { get; set; } public FullPath? FindBestMatch(Utf8GamePath gamePath); public IModOption? AddOption(string name, string description = ""); @@ -54,8 +43,8 @@ public interface IModGroup public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer); - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations); - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems); + public void AddData(Setting setting, Dictionary redirections, HashSet manipulations); + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems); /// Ensure that a value is valid for a group. public Setting FixSetting(Setting setting); diff --git a/Penumbra/Mods/Groups/ImcModGroup.cs b/Penumbra/Mods/Groups/ImcModGroup.cs index 34174f7f..e0d70aa6 100644 --- a/Penumbra/Mods/Groups/ImcModGroup.cs +++ b/Penumbra/Mods/Groups/ImcModGroup.cs @@ -1,12 +1,11 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using Newtonsoft.Json.Linq; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using Penumbra.Api.Enums; using Penumbra.GameData.Data; using Penumbra.GameData.Structs; -using Penumbra.Meta; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Settings; using Penumbra.Mods.SubMods; @@ -20,7 +19,6 @@ public class ImcModGroup(Mod mod) : IModGroup public Mod Mod { get; } = mod; public string Name { get; set; } = "Option"; public string Description { get; set; } = string.Empty; - public string Image { get; set; } = string.Empty; public GroupType Type => GroupType.Imc; @@ -29,14 +27,10 @@ public class ImcModGroup(Mod mod) : IModGroup => GroupDrawBehaviour.MultiSelection; public ModPriority Priority { get; set; } = ModPriority.Default; - public int Page { get; set; } public Setting DefaultSettings { get; set; } = Setting.Zero; public ImcIdentifier Identifier; public ImcEntry DefaultEntry; - public bool AllVariants; - public bool OnlyAttributes; - public FullPath? FindBestMatch(Utf8GamePath gamePath) => null; @@ -45,7 +39,7 @@ public class ImcModGroup(Mod mod) : IModGroup public bool CanBeDisabled { - get => _canBeDisabled; + get => OptionData.Any(m => m.IsDisableSubMod); set { _canBeDisabled = value; @@ -98,41 +92,22 @@ public class ImcModGroup(Mod mod) : IModGroup public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer) => new ImcModGroupEditDrawer(editDrawer, this); - private ImcEntry GetEntry(Variant variant, ushort mask) - { - if (!OnlyAttributes) - return DefaultEntry with { AttributeMask = mask }; + public ImcManipulation GetManip(ushort mask) + => new(Identifier.ObjectType, Identifier.BodySlot, Identifier.PrimaryId, Identifier.SecondaryId.Id, Identifier.Variant.Id, + Identifier.EquipSlot, DefaultEntry with { AttributeMask = mask }); - var defaultEntry = ImcChecker.GetDefaultEntry(Identifier with { Variant = variant }, true); - if (defaultEntry.VariantExists) - return defaultEntry.Entry with { AttributeMask = mask }; - - return DefaultEntry with { AttributeMask = mask }; - } - - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations) + public void AddData(Setting setting, Dictionary redirections, HashSet manipulations) { if (IsDisabled(setting)) return; var mask = GetCurrentMask(setting); - if (AllVariants) - { - var count = ImcChecker.GetVariantCount(Identifier); - if (count == 0) - manipulations.TryAdd(Identifier, GetEntry(Identifier.Variant, mask)); - else - for (var i = 0; i <= count; ++i) - manipulations.TryAdd(Identifier with { Variant = (Variant)i }, GetEntry((Variant)i, mask)); - } - else - { - manipulations.TryAdd(Identifier, GetEntry(Identifier.Variant, mask)); - } + var imc = GetManip(mask); + manipulations.Add(imc); } - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) - => Identifier.AddChangedItems(identifier, changedItems, AllVariants); + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) + => Identifier.AddChangedItems(identifier, changedItems); public Setting FixSetting(Setting setting) => new(setting.Value & ((1ul << OptionData.Count) - 1)); @@ -145,10 +120,6 @@ public class ImcModGroup(Mod mod) : IModGroup jObj.WriteTo(jWriter); jWriter.WritePropertyName(nameof(DefaultEntry)); serializer.Serialize(jWriter, DefaultEntry); - jWriter.WritePropertyName(nameof(AllVariants)); - jWriter.WriteValue(AllVariants); - jWriter.WritePropertyName(nameof(OnlyAttributes)); - jWriter.WriteValue(OnlyAttributes); jWriter.WritePropertyName("Options"); jWriter.WriteStartArray(); foreach (var option in OptionData) @@ -181,11 +152,12 @@ public class ImcModGroup(Mod mod) : IModGroup var identifier = ImcIdentifier.FromJson(json[nameof(Identifier)] as JObject); var ret = new ImcModGroup(mod) { - DefaultEntry = json[nameof(DefaultEntry)]?.ToObject() ?? new ImcEntry(), - AllVariants = json[nameof(AllVariants)]?.ToObject() ?? false, - OnlyAttributes = json[nameof(OnlyAttributes)]?.ToObject() ?? false, + Name = json[nameof(Name)]?.ToObject() ?? string.Empty, + Description = json[nameof(Description)]?.ToObject() ?? string.Empty, + Priority = json[nameof(Priority)]?.ToObject() ?? ModPriority.Default, + DefaultEntry = json[nameof(DefaultEntry)]?.ToObject() ?? new ImcEntry(), }; - if (!ModSaveGroup.ReadJsonBase(json, ret)) + if (ret.Name.Length == 0) return null; if (!identifier.HasValue || ret.DefaultEntry.MaterialId == 0) @@ -195,7 +167,7 @@ public class ImcModGroup(Mod mod) : IModGroup return null; } - var rollingMask = 0ul; + var rollingMask = ret.DefaultEntry.AttributeMask; if (options != null) foreach (var child in options.Children()) { @@ -224,6 +196,7 @@ public class ImcModGroup(Mod mod) : IModGroup } ret.Identifier = identifier.Value; + ret.DefaultSettings = json[nameof(DefaultSettings)]?.ToObject() ?? Setting.Zero; ret.DefaultSettings = ret.FixSetting(ret.DefaultSettings); return ret; } @@ -237,7 +210,7 @@ public class ImcModGroup(Mod mod) : IModGroup if (idx >= 0) return setting.HasFlag(idx); - Penumbra.Log.Warning("A IMC Group should be able to be disabled, but does not contain a disable option."); + Penumbra.Log.Warning($"A IMC Group should be able to be disabled, but does not contain a disable option."); return false; } @@ -250,7 +223,7 @@ public class ImcModGroup(Mod mod) : IModGroup continue; var option = OptionData[i]; - mask ^= option.AttributeMask; + mask |= option.AttributeMask; } return mask; diff --git a/Penumbra/Mods/Groups/ModSaveGroup.cs b/Penumbra/Mods/Groups/ModSaveGroup.cs index bda70b54..05437e3d 100644 --- a/Penumbra/Mods/Groups/ModSaveGroup.cs +++ b/Penumbra/Mods/Groups/ModSaveGroup.cs @@ -1,7 +1,4 @@ using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using Penumbra.GameData.Files.ShaderStructs; -using Penumbra.Mods.Settings; using Penumbra.Mods.SubMods; using Penumbra.Services; @@ -9,8 +6,6 @@ namespace Penumbra.Mods.Groups; public readonly struct ModSaveGroup : ISavable { - public const int CurrentVersion = 0; - private readonly DirectoryInfo _basePath; private readonly IModGroup? _group; private readonly int _groupIdx; @@ -76,8 +71,6 @@ public readonly struct ModSaveGroup : ISavable j.Formatting = Formatting.Indented; var serializer = new JsonSerializer { Formatting = Formatting.Indented }; j.WriteStartObject(); - j.WritePropertyName("Version"); - j.WriteValue(CurrentVersion); if (_groupIdx >= 0) _group!.WriteJson(j, serializer, _basePath); else @@ -91,10 +84,6 @@ public readonly struct ModSaveGroup : ISavable jWriter.WriteValue(group.Name); jWriter.WritePropertyName(nameof(group.Description)); jWriter.WriteValue(group.Description); - jWriter.WritePropertyName(nameof(group.Image)); - jWriter.WriteValue(group.Image); - jWriter.WritePropertyName(nameof(group.Page)); - jWriter.WriteValue(group.Page); jWriter.WritePropertyName(nameof(group.Priority)); jWriter.WriteValue(group.Priority.Value); jWriter.WritePropertyName(nameof(group.Type)); @@ -102,16 +91,4 @@ public readonly struct ModSaveGroup : ISavable jWriter.WritePropertyName(nameof(group.DefaultSettings)); jWriter.WriteValue(group.DefaultSettings.Value); } - - public static bool ReadJsonBase(JObject json, IModGroup group) - { - group.Name = json[nameof(IModGroup.Name)]?.ToObject() ?? string.Empty; - group.Description = json[nameof(IModGroup.Description)]?.ToObject() ?? string.Empty; - group.Image = json[nameof(IModGroup.Image)]?.ToObject() ?? string.Empty; - group.Page = json[nameof(IModGroup.Page)]?.ToObject() ?? 0; - group.Priority = json[nameof(IModGroup.Priority)]?.ToObject() ?? ModPriority.Default; - group.DefaultSettings = json[nameof(IModGroup.DefaultSettings)]?.ToObject() ?? Setting.Zero; - - return group.Name.Length > 0; - } } diff --git a/Penumbra/Mods/Groups/MultiModGroup.cs b/Penumbra/Mods/Groups/MultiModGroup.cs index 558ee6be..7816d628 100644 --- a/Penumbra/Mods/Groups/MultiModGroup.cs +++ b/Penumbra/Mods/Groups/MultiModGroup.cs @@ -1,9 +1,10 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using Newtonsoft.Json.Linq; +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using Penumbra.Api.Enums; +using Penumbra.GameData; using Penumbra.GameData.Data; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Settings; @@ -26,9 +27,7 @@ public sealed class MultiModGroup(Mod mod) : IModGroup, ITexToolsGroup public Mod Mod { get; } = mod; public string Name { get; set; } = "Group"; public string Description { get; set; } = string.Empty; - public string Image { get; set; } = string.Empty; public ModPriority Priority { get; set; } - public int Page { get; set; } public Setting DefaultSettings { get; set; } public readonly List OptionData = []; @@ -67,8 +66,14 @@ public sealed class MultiModGroup(Mod mod) : IModGroup, ITexToolsGroup public static MultiModGroup? Load(Mod mod, JObject json) { - var ret = new MultiModGroup(mod); - if (!ModSaveGroup.ReadJsonBase(json, ret)) + var ret = new MultiModGroup(mod) + { + Name = json[nameof(Name)]?.ToObject() ?? string.Empty, + Description = json[nameof(Description)]?.ToObject() ?? string.Empty, + Priority = json[nameof(Priority)]?.ToObject() ?? ModPriority.Default, + DefaultSettings = json[nameof(DefaultSettings)]?.ToObject() ?? Setting.Zero, + }; + if (ret.Name.Length == 0) return null; var options = json["Options"]; @@ -99,8 +104,6 @@ public sealed class MultiModGroup(Mod mod) : IModGroup, ITexToolsGroup Name = Name, Description = Description, Priority = Priority, - Image = Image, - Page = Page, DefaultSettings = DefaultSettings.TurnMulti(OptionData.Count), }; single.OptionData.AddRange(OptionData.Select(o => o.ConvertToSingle(single))); @@ -113,7 +116,7 @@ public sealed class MultiModGroup(Mod mod) : IModGroup, ITexToolsGroup public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer) => new MultiModGroupEditDrawer(editDrawer, this); - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations) + public void AddData(Setting setting, Dictionary redirections, HashSet manipulations) { foreach (var (option, index) in OptionData.WithIndex().OrderByDescending(o => o.Value.Priority)) { @@ -122,7 +125,7 @@ public sealed class MultiModGroup(Mod mod) : IModGroup, ITexToolsGroup } } - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) { foreach (var container in DataContainers) identifier.AddChangedItems(container, changedItems); diff --git a/Penumbra/Mods/Groups/SingleModGroup.cs b/Penumbra/Mods/Groups/SingleModGroup.cs index f376c1c9..a6ebd846 100644 --- a/Penumbra/Mods/Groups/SingleModGroup.cs +++ b/Penumbra/Mods/Groups/SingleModGroup.cs @@ -1,6 +1,6 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; -using OtterGui.Extensions; +using OtterGui; using Penumbra.Api.Enums; using Penumbra.GameData.Data; using Penumbra.Meta.Manipulations; @@ -24,9 +24,7 @@ public sealed class SingleModGroup(Mod mod) : IModGroup, ITexToolsGroup public Mod Mod { get; } = mod; public string Name { get; set; } = "Option"; public string Description { get; set; } = string.Empty; - public string Image { get; set; } = string.Empty; public ModPriority Priority { get; set; } - public int Page { get; set; } public Setting DefaultSettings { get; set; } public readonly List OptionData = []; @@ -63,8 +61,14 @@ public sealed class SingleModGroup(Mod mod) : IModGroup, ITexToolsGroup public static SingleModGroup? Load(Mod mod, JObject json) { var options = json["Options"]; - var ret = new SingleModGroup(mod); - if (!ModSaveGroup.ReadJsonBase(json, ret)) + var ret = new SingleModGroup(mod) + { + Name = json[nameof(Name)]?.ToObject() ?? string.Empty, + Description = json[nameof(Description)]?.ToObject() ?? string.Empty, + Priority = json[nameof(Priority)]?.ToObject() ?? ModPriority.Default, + DefaultSettings = json[nameof(DefaultSettings)]?.ToObject() ?? Setting.Zero, + }; + if (ret.Name.Length == 0) return null; if (options != null) @@ -85,8 +89,6 @@ public sealed class SingleModGroup(Mod mod) : IModGroup, ITexToolsGroup Name = Name, Description = Description, Priority = Priority, - Image = Image, - Page = Page, DefaultSettings = Setting.Multi((int)DefaultSettings.Value), }; multi.OptionData.AddRange(OptionData.Select((o, i) => o.ConvertToMulti(multi, new ModPriority(i)))); @@ -99,7 +101,7 @@ public sealed class SingleModGroup(Mod mod) : IModGroup, ITexToolsGroup public IModGroupEditDrawer EditDrawer(ModGroupEditDrawer editDrawer) => new SingleModGroupEditDrawer(editDrawer, this); - public void AddData(Setting setting, Dictionary redirections, MetaDictionary manipulations) + public void AddData(Setting setting, Dictionary redirections, HashSet manipulations) { if (OptionData.Count == 0) return; @@ -107,7 +109,7 @@ public sealed class SingleModGroup(Mod mod) : IModGroup, ITexToolsGroup OptionData[setting.AsIndex].AddDataTo(redirections, manipulations); } - public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) + public void AddChangedItems(ObjectIdentification identifier, IDictionary changedItems) { foreach (var container in DataContainers) identifier.AddChangedItems(container, changedItems); diff --git a/Penumbra/Mods/ItemSwap/CustomizationSwap.cs b/Penumbra/Mods/ItemSwap/CustomizationSwap.cs index c5406f66..cd36de93 100644 --- a/Penumbra/Mods/ItemSwap/CustomizationSwap.cs +++ b/Penumbra/Mods/ItemSwap/CustomizationSwap.cs @@ -17,8 +17,8 @@ public static class CustomizationSwap if (idFrom.Id > byte.MaxValue) throw new Exception($"The Customization ID {idFrom} is too large for {slot}."); - var mdlPathFrom = GamePaths.Mdl.Customization(race, slot, idFrom, slot.ToCustomizationType()); - var mdlPathTo = GamePaths.Mdl.Customization(race, slot, idTo, slot.ToCustomizationType()); + var mdlPathFrom = GamePaths.Character.Mdl.Path(race, slot, idFrom, slot.ToCustomizationType()); + var mdlPathTo = GamePaths.Character.Mdl.Path(race, slot, idTo, slot.ToCustomizationType()); var mdl = FileSwap.CreateSwap(manager, ResourceType.Mdl, redirections, mdlPathFrom, mdlPathTo); var range = slot == BodySlot.Tail @@ -47,8 +47,8 @@ public static class CustomizationSwap ref string fileName, ref bool dataWasChanged) { variant = slot is BodySlot.Face or BodySlot.Ear ? Variant.None.Id : variant; - var mtrlFromPath = GamePaths.Mtrl.Customization(race, slot, idFrom, fileName, out var gameRaceFrom, out var gameSetIdFrom, variant); - var mtrlToPath = GamePaths.Mtrl.Customization(race, slot, idTo, fileName, out var gameRaceTo, out var gameSetIdTo, variant); + var mtrlFromPath = GamePaths.Character.Mtrl.Path(race, slot, idFrom, fileName, out var gameRaceFrom, out var gameSetIdFrom, variant); + var mtrlToPath = GamePaths.Character.Mtrl.Path(race, slot, idTo, fileName, out var gameRaceTo, out var gameSetIdTo, variant); var newFileName = fileName; newFileName = ItemSwap.ReplaceRace(newFileName, gameRaceTo, race, gameRaceTo != race); @@ -60,7 +60,7 @@ public static class CustomizationSwap var actualMtrlFromPath = mtrlFromPath; if (newFileName != fileName) { - actualMtrlFromPath = GamePaths.Mtrl.Customization(race, slot, idFrom, newFileName, out _, out _, variant); + actualMtrlFromPath = GamePaths.Character.Mtrl.Path(race, slot, idFrom, newFileName, out _, out _, variant); fileName = newFileName; dataWasChanged = true; } diff --git a/Penumbra/Mods/ItemSwap/EquipmentSwap.cs b/Penumbra/Mods/ItemSwap/EquipmentSwap.cs index 216b5841..5a5181a5 100644 --- a/Penumbra/Mods/ItemSwap/EquipmentSwap.cs +++ b/Penumbra/Mods/ItemSwap/EquipmentSwap.cs @@ -1,4 +1,4 @@ -using Penumbra.Api.Enums; +using Penumbra.Api.Enums; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Files; @@ -16,19 +16,32 @@ public static class EquipmentSwap private static EquipSlot[] ConvertSlots(EquipSlot slot, bool rFinger, bool lFinger) { if (slot != EquipSlot.RFinger) - return [slot]; + return new[] + { + slot, + }; return rFinger ? lFinger - ? [EquipSlot.RFinger, EquipSlot.LFinger] - : [EquipSlot.RFinger] + ? new[] + { + EquipSlot.RFinger, + EquipSlot.LFinger, + } + : new[] + { + EquipSlot.RFinger, + } : lFinger - ? [EquipSlot.LFinger] - : []; + ? new[] + { + EquipSlot.LFinger, + } + : Array.Empty(); } - public static HashSet CreateTypeSwap(MetaFileManager manager, ObjectIdentification identifier, List swaps, - Func redirections, MetaDictionary manips, + public static EquipItem[] CreateTypeSwap(MetaFileManager manager, ObjectIdentification identifier, List swaps, + Func redirections, Func manips, EquipSlot slotFrom, EquipItem itemFrom, EquipSlot slotTo, EquipItem itemTo) { LookupItem(itemFrom, out var actualSlotFrom, out var idFrom, out var variantFrom); @@ -37,14 +50,11 @@ public static class EquipmentSwap throw new ItemSwap.InvalidItemTypeException(); var (imcFileFrom, variants, affectedItems) = GetVariants(manager, identifier, slotFrom, idFrom, idTo, variantFrom); - var imcIdentifierTo = new ImcIdentifier(slotTo, idTo, variantTo); - var imcFileTo = new ImcFile(manager, imcIdentifierTo); - var imcEntry = manips.TryGetValue(imcIdentifierTo, out var entry) - ? entry - : imcFileTo.GetEntry(imcIdentifierTo.EquipSlot, imcIdentifierTo.Variant); - var mtrlVariantTo = imcEntry.MaterialId; + var imcManip = new ImcManipulation(slotTo, variantTo.Id, idTo.Id, default); + var imcFileTo = new ImcFile(manager, imcManip); var skipFemale = false; var skipMale = false; + var mtrlVariantTo = manips(imcManip.Copy(imcFileTo.GetEntry(ImcFile.PartIndex(slotTo), variantTo.Id))).Imc.Entry.MaterialId; foreach (var gr in Enum.GetValues()) { switch (gr.Split().Item1) @@ -88,8 +98,8 @@ public static class EquipmentSwap return affectedItems; } - public static HashSet CreateItemSwap(MetaFileManager manager, ObjectIdentification identifier, List swaps, - Func redirections, MetaDictionary manips, EquipItem itemFrom, + public static EquipItem[] CreateItemSwap(MetaFileManager manager, ObjectIdentification identifier, List swaps, + Func redirections, Func manips, EquipItem itemFrom, EquipItem itemTo, bool rFinger = true, bool lFinger = true) { // Check actual ids, variants and slots. We only support using the same slot. @@ -98,45 +108,32 @@ public static class EquipmentSwap if (slotFrom != slotTo) throw new ItemSwap.InvalidItemTypeException(); - HashSet affectedItems = []; - var eqp = CreateEqp(manager, manips, slotFrom, idFrom, idTo); + var eqp = CreateEqp(manager, manips, slotFrom, idFrom, idTo); if (eqp != null) - { swaps.Add(eqp); - // Add items affected through multi-slot EQP edits. - foreach (var child in eqp.ChildSwaps.SelectMany(c => c.WithChildren()).OfType>()) - { - affectedItems.UnionWith(identifier - .Identify(GamePaths.Mdl.Equipment(idFrom, GenderRace.MidlanderMale, child.SwapFromIdentifier.Slot)) - .Select(kvp => kvp.Value).OfType().Select(i => i.Item)); - } - } var gmp = CreateGmp(manager, manips, slotFrom, idFrom, idTo); if (gmp != null) swaps.Add(gmp); + var affectedItems = Array.Empty(); foreach (var slot in ConvertSlots(slotFrom, rFinger, lFinger)) { - var (imcFileFrom, variants, affectedItemsLocal) = GetVariants(manager, identifier, slot, idFrom, idTo, variantFrom); - affectedItems.UnionWith(affectedItemsLocal); - var imcIdentifierTo = new ImcIdentifier(slotTo, idTo, variantTo); - var imcFileTo = new ImcFile(manager, imcIdentifierTo); - var imcEntry = manips.TryGetValue(imcIdentifierTo, out var entry) - ? entry - : imcFileTo.GetEntry(imcIdentifierTo.EquipSlot, imcIdentifierTo.Variant); - var mtrlVariantTo = imcEntry.MaterialId; + (var imcFileFrom, var variants, affectedItems) = GetVariants(manager, identifier, slot, idFrom, idTo, variantFrom); + var imcManip = new ImcManipulation(slot, variantTo.Id, idTo, default); + var imcFileTo = new ImcFile(manager, imcManip); var isAccessory = slot.IsAccessory(); var estType = slot switch { - EquipSlot.Head => EstType.Head, - EquipSlot.Body => EstType.Body, - _ => (EstType)0, + EquipSlot.Head => EstManipulation.EstType.Head, + EquipSlot.Body => EstManipulation.EstType.Body, + _ => (EstManipulation.EstType)0, }; - var skipFemale = false; - var skipMale = false; + var skipFemale = false; + var skipMale = false; + var mtrlVariantTo = manips(imcManip.Copy(imcFileTo.GetEntry(ImcFile.PartIndex(slot), variantTo))).Imc.Entry.MaterialId; foreach (var gr in Enum.GetValues()) { switch (gr.Split().Item1) @@ -157,7 +154,7 @@ public static class EquipmentSwap if (eqdp != null) swaps.Add(eqdp); - var ownMdl = eqdp?.SwapToModdedEntry.Model ?? false; + var ownMdl = eqdp?.SwapApplied.Eqdp.Entry.ToBits(slot).Item2 ?? false; var est = ItemSwap.CreateEst(manager, redirections, manips, estType, gr, idFrom, idTo, ownMdl); if (est != null) swaps.Add(est); @@ -187,22 +184,22 @@ public static class EquipmentSwap return affectedItems; } - public static MetaSwap? CreateEqdp(MetaFileManager manager, Func redirections, - MetaDictionary manips, EquipSlot slot, GenderRace gr, PrimaryId idFrom, PrimaryId idTo, byte mtrlTo) + public static MetaSwap? CreateEqdp(MetaFileManager manager, Func redirections, + Func manips, EquipSlot slot, GenderRace gr, PrimaryId idFrom, + PrimaryId idTo, byte mtrlTo) => CreateEqdp(manager, redirections, manips, slot, slot, gr, idFrom, idTo, mtrlTo); - public static MetaSwap? CreateEqdp(MetaFileManager manager, Func redirections, - MetaDictionary manips, EquipSlot slotFrom, EquipSlot slotTo, GenderRace gr, PrimaryId idFrom, + public static MetaSwap? CreateEqdp(MetaFileManager manager, Func redirections, + Func manips, EquipSlot slotFrom, EquipSlot slotTo, GenderRace gr, PrimaryId idFrom, PrimaryId idTo, byte mtrlTo) { - var eqdpFromIdentifier = new EqdpIdentifier(idFrom, slotFrom, gr); - var eqdpToIdentifier = new EqdpIdentifier(idTo, slotTo, gr); - var eqdpFromDefault = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(manager, eqdpFromIdentifier), slotFrom); - var eqdpToDefault = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(manager, eqdpToIdentifier), slotTo); - var meta = new MetaSwap(i => manips.TryGetValue(i, out var e) ? e : null, eqdpFromIdentifier, - eqdpFromDefault, eqdpToIdentifier, - eqdpToDefault); - var (ownMtrl, ownMdl) = meta.SwapToModdedEntry; + var (gender, race) = gr.Split(); + var eqdpFrom = new EqdpManipulation(ExpandedEqdpFile.GetDefault(manager, gr, slotFrom.IsAccessory(), idFrom), slotFrom, gender, + race, idFrom); + var eqdpTo = new EqdpManipulation(ExpandedEqdpFile.GetDefault(manager, gr, slotTo.IsAccessory(), idTo), slotTo, gender, race, + idTo); + var meta = new MetaSwap(manips, eqdpFrom, eqdpTo); + var (ownMtrl, ownMdl) = meta.SwapApplied.Eqdp.Entry.ToBits(slotFrom); if (ownMdl) { var mdl = CreateMdl(manager, redirections, slotFrom, slotTo, gr, idFrom, idTo, mtrlTo); @@ -223,9 +220,11 @@ public static class EquipmentSwap public static FileSwap CreateMdl(MetaFileManager manager, Func redirections, EquipSlot slotFrom, EquipSlot slotTo, GenderRace gr, PrimaryId idFrom, PrimaryId idTo, byte mtrlTo) { - var mdlPathFrom = GamePaths.Mdl.Gear(idFrom, gr, slotFrom); - var mdlPathTo = GamePaths.Mdl.Gear(idTo, gr, slotTo); - var mdl = FileSwap.CreateSwap(manager, ResourceType.Mdl, redirections, mdlPathFrom, mdlPathTo); + var mdlPathFrom = slotFrom.IsAccessory() + ? GamePaths.Accessory.Mdl.Path(idFrom, gr, slotFrom) + : GamePaths.Equipment.Mdl.Path(idFrom, gr, slotFrom); + var mdlPathTo = slotTo.IsAccessory() ? GamePaths.Accessory.Mdl.Path(idTo, gr, slotTo) : GamePaths.Equipment.Mdl.Path(idTo, gr, slotTo); + var mdl = FileSwap.CreateSwap(manager, ResourceType.Mdl, redirections, mdlPathFrom, mdlPathTo); foreach (ref var fileName in mdl.AsMdl()!.Materials.AsSpan()) { @@ -234,56 +233,9 @@ public static class EquipmentSwap mdl.ChildSwaps.Add(mtrl); } - FixAttributes(mdl, slotFrom, slotTo); - return mdl; } - private static void FixAttributes(FileSwap swap, EquipSlot slotFrom, EquipSlot slotTo) - { - if (slotFrom == slotTo) - return; - - var needle = slotTo switch - { - EquipSlot.Head => "atr_mv_", - EquipSlot.Ears => "atr_ev_", - EquipSlot.Neck => "atr_nv_", - EquipSlot.Wrists => "atr_wv_", - EquipSlot.RFinger or EquipSlot.LFinger => "atr_rv_", - _ => string.Empty, - }; - - var replacement = slotFrom switch - { - EquipSlot.Head => 'm', - EquipSlot.Ears => 'e', - EquipSlot.Neck => 'n', - EquipSlot.Wrists => 'w', - EquipSlot.RFinger or EquipSlot.LFinger => 'r', - _ => 'm', - }; - - var attributes = swap.AsMdl()!.Attributes; - for (var i = 0; i < attributes.Length; ++i) - { - if (FixAttribute(ref attributes[i], needle, replacement)) - swap.DataWasChanged = true; - } - } - - private static unsafe bool FixAttribute(ref string attribute, string from, char to) - { - if (!attribute.StartsWith(from) || attribute.Length != from.Length + 1 || attribute[^1] is < 'a' or > 'j') - return false; - - Span stack = stackalloc char[attribute.Length]; - attribute.CopyTo(stack); - stack[4] = to; - attribute = new string(stack); - return true; - } - private static void LookupItem(EquipItem i, out EquipSlot slot, out PrimaryId modelId, out Variant variant) { slot = i.Type.ToSlot(); @@ -294,65 +246,62 @@ public static class EquipmentSwap variant = i.Variant; } - private static (ImcFile, Variant[], HashSet) GetVariants(MetaFileManager manager, ObjectIdentification identifier, - EquipSlot slotFrom, + private static (ImcFile, Variant[], EquipItem[]) GetVariants(MetaFileManager manager, ObjectIdentification identifier, EquipSlot slotFrom, PrimaryId idFrom, PrimaryId idTo, Variant variantFrom) { - var ident = new ImcIdentifier(slotFrom, idFrom, variantFrom); - var imc = new ImcFile(manager, ident); - HashSet items; - Variant[] variants; + var entry = new ImcManipulation(slotFrom, variantFrom.Id, idFrom, default); + var imc = new ImcFile(manager, entry); + EquipItem[] items; + Variant[] variants; if (idFrom == idTo) { - items = identifier.Identify(idFrom, 0, variantFrom, slotFrom).ToHashSet(); + items = identifier.Identify(idFrom, 0, variantFrom, slotFrom).ToArray(); variants = [variantFrom]; } else { - items = identifier.Identify(GamePaths.Mdl.Gear(idFrom, GenderRace.MidlanderMale, slotFrom)) - .Select(kvp => kvp.Value).OfType().Select(i => i.Item) - .ToHashSet(); + items = identifier.Identify(slotFrom.IsEquipment() + ? GamePaths.Equipment.Mdl.Path(idFrom, GenderRace.MidlanderMale, slotFrom) + : GamePaths.Accessory.Mdl.Path(idFrom, GenderRace.MidlanderMale, slotFrom)).Select(kvp => kvp.Value).OfType() + .ToArray(); variants = Enumerable.Range(0, imc.Count + 1).Select(i => (Variant)i).ToArray(); } return (imc, variants, items); } - public static MetaSwap? CreateGmp(MetaFileManager manager, MetaDictionary manips, - EquipSlot slot, PrimaryId idFrom, PrimaryId idTo) + public static MetaSwap? CreateGmp(MetaFileManager manager, Func manips, EquipSlot slot, PrimaryId idFrom, + PrimaryId idTo) { if (slot is not EquipSlot.Head) return null; - var manipFromIdentifier = new GmpIdentifier(idFrom); - var manipToIdentifier = new GmpIdentifier(idTo); - var manipFromDefault = ExpandedGmpFile.GetDefault(manager, manipFromIdentifier); - var manipToDefault = ExpandedGmpFile.GetDefault(manager, manipToIdentifier); - return new MetaSwap(i => manips.TryGetValue(i, out var e) ? e : null, manipFromIdentifier, manipFromDefault, - manipToIdentifier, manipToDefault); + var manipFrom = new GmpManipulation(ExpandedGmpFile.GetDefault(manager, idFrom), idFrom); + var manipTo = new GmpManipulation(ExpandedGmpFile.GetDefault(manager, idTo), idTo); + return new MetaSwap(manips, manipFrom, manipTo); } - public static MetaSwap CreateImc(MetaFileManager manager, Func redirections, - MetaDictionary manips, EquipSlot slot, PrimaryId idFrom, PrimaryId idTo, Variant variantFrom, Variant variantTo, - ImcFile imcFileFrom, ImcFile imcFileTo) + public static MetaSwap CreateImc(MetaFileManager manager, Func redirections, + Func manips, EquipSlot slot, + PrimaryId idFrom, PrimaryId idTo, Variant variantFrom, Variant variantTo, ImcFile imcFileFrom, ImcFile imcFileTo) => CreateImc(manager, redirections, manips, slot, slot, idFrom, idTo, variantFrom, variantTo, imcFileFrom, imcFileTo); - public static MetaSwap CreateImc(MetaFileManager manager, Func redirections, - MetaDictionary manips, EquipSlot slotFrom, EquipSlot slotTo, PrimaryId idFrom, PrimaryId idTo, + public static MetaSwap CreateImc(MetaFileManager manager, Func redirections, + Func manips, + EquipSlot slotFrom, EquipSlot slotTo, PrimaryId idFrom, PrimaryId idTo, Variant variantFrom, Variant variantTo, ImcFile imcFileFrom, ImcFile imcFileTo) { - var manipFromIdentifier = new ImcIdentifier(slotFrom, idFrom, variantFrom); - var manipToIdentifier = new ImcIdentifier(slotTo, idTo, variantTo); - var manipFromDefault = imcFileFrom.GetEntry(ImcFile.PartIndex(slotFrom), variantFrom); - var manipToDefault = imcFileTo.GetEntry(ImcFile.PartIndex(slotTo), variantTo); - var imc = new MetaSwap(i => manips.TryGetValue(i, out var e) ? e : null, manipFromIdentifier, manipFromDefault, - manipToIdentifier, manipToDefault); + var entryFrom = imcFileFrom.GetEntry(ImcFile.PartIndex(slotFrom), variantFrom); + var entryTo = imcFileTo.GetEntry(ImcFile.PartIndex(slotTo), variantTo); + var manipulationFrom = new ImcManipulation(slotFrom, variantFrom.Id, idFrom, entryFrom); + var manipulationTo = new ImcManipulation(slotTo, variantTo.Id, idTo, entryTo); + var imc = new MetaSwap(manips, manipulationFrom, manipulationTo); - var decal = CreateDecal(manager, redirections, imc.SwapToModdedEntry.DecalId); + var decal = CreateDecal(manager, redirections, imc.SwapToModded.Imc.Entry.DecalId); if (decal != null) imc.ChildSwaps.Add(decal); - var avfx = CreateAvfx(manager, redirections, slotFrom, slotTo, idFrom, idTo, imc.SwapToModdedEntry.VfxId); + var avfx = CreateAvfx(manager, redirections, idFrom, idTo, imc.SwapToModded.Imc.Entry.VfxId); if (avfx != null) imc.ChildSwaps.Add(avfx); @@ -367,69 +316,41 @@ public static class EquipmentSwap if (decalId == 0) return null; - var decalPath = GamePaths.Tex.EquipDecal(decalId); + var decalPath = GamePaths.Equipment.Decal.Path(decalId); return FileSwap.CreateSwap(manager, ResourceType.Tex, redirections, decalPath, decalPath); } // Example: Abyssos Helm / Body - public static FileSwap? CreateAvfx(MetaFileManager manager, Func redirections, EquipSlot slotFrom, EquipSlot slotTo, - PrimaryId idFrom, PrimaryId idTo, - byte vfxId) + public static FileSwap? CreateAvfx(MetaFileManager manager, Func redirections, PrimaryId idFrom, PrimaryId idTo, byte vfxId) { if (vfxId == 0) return null; - var vfxPathFrom = GamePaths.Avfx.Path(slotFrom, idFrom, vfxId); - vfxPathFrom = ItemSwap.ReplaceType(vfxPathFrom, slotFrom, slotTo, idFrom); - var vfxPathTo = GamePaths.Avfx.Path(slotTo, idTo, vfxId); - var avfx = FileSwap.CreateSwap(manager, ResourceType.Avfx, redirections, vfxPathFrom, vfxPathTo); + var vfxPathFrom = GamePaths.Equipment.Avfx.Path(idFrom, vfxId); + var vfxPathTo = GamePaths.Equipment.Avfx.Path(idTo, vfxId); + var avfx = FileSwap.CreateSwap(manager, ResourceType.Avfx, redirections, vfxPathFrom, vfxPathTo); foreach (ref var filePath in avfx.AsAvfx()!.Textures.AsSpan()) { - var atex = CreateAtex(manager, redirections, slotFrom, slotTo, idFrom, ref filePath, ref avfx.DataWasChanged); + var atex = CreateAtex(manager, redirections, ref filePath, ref avfx.DataWasChanged); avfx.ChildSwaps.Add(atex); } return avfx; } - public static MetaSwap? CreateEqp(MetaFileManager manager, MetaDictionary manips, EquipSlot slot, - PrimaryId idFrom, PrimaryId idTo) + public static MetaSwap? CreateEqp(MetaFileManager manager, Func manips, EquipSlot slot, PrimaryId idFrom, + PrimaryId idTo) { if (slot.IsAccessory()) return null; - var manipFromIdentifier = new EqpIdentifier(idFrom, slot); - var manipToIdentifier = new EqpIdentifier(idTo, slot); - var manipFromDefault = new EqpEntryInternal(ExpandedEqpFile.GetDefault(manager, idFrom), slot); - var manipToDefault = new EqpEntryInternal(ExpandedEqpFile.GetDefault(manager, idTo), slot); - var swap = new MetaSwap(i => manips.TryGetValue(i, out var e) ? e : null, manipFromIdentifier, - manipFromDefault, manipToIdentifier, manipToDefault); - var entry = swap.SwapToModdedEntry.ToEntry(slot); - // Add additional EQP entries if the swapped item is a multi-slot item, - // because those take the EQP entries of their other model-set slots when used. - switch (slot) - { - case EquipSlot.Body: - if (!entry.HasFlag(EqpEntry.BodyShowLeg) - && CreateEqp(manager, manips, EquipSlot.Legs, idFrom, idTo) is { } legChild) - swap.ChildSwaps.Add(legChild); - if (!entry.HasFlag(EqpEntry.BodyShowHead) - && CreateEqp(manager, manips, EquipSlot.Head, idFrom, idTo) is { } headChild) - swap.ChildSwaps.Add(headChild); - if (!entry.HasFlag(EqpEntry.BodyShowHand) - && CreateEqp(manager, manips, EquipSlot.Hands, idFrom, idTo) is { } handChild) - swap.ChildSwaps.Add(handChild); - break; - case EquipSlot.Legs: - if (!entry.HasFlag(EqpEntry.LegsShowFoot) - && CreateEqp(manager, manips, EquipSlot.Feet, idFrom, idTo) is { } footChild) - swap.ChildSwaps.Add(footChild); - break; - } - - return swap; + var eqpValueFrom = ExpandedEqpFile.GetDefault(manager, idFrom); + var eqpValueTo = ExpandedEqpFile.GetDefault(manager, idTo); + var eqpFrom = new EqpManipulation(eqpValueFrom, slot, idFrom); + var eqpTo = new EqpManipulation(eqpValueTo, slot, idFrom); + return new MetaSwap(manips, eqpFrom, eqpTo); } public static FileSwap? CreateMtrl(MetaFileManager manager, Func redirections, EquipSlot slot, PrimaryId idFrom, @@ -445,10 +366,14 @@ public static class EquipmentSwap if (!fileName.Contains($"{prefix}{idTo.Id:D4}")) return null; - var folderTo = GamePaths.Mtrl.GearFolder(slotTo, idTo, variantTo); - var pathTo = $"{folderTo}{fileName}"; + var folderTo = slotTo.IsAccessory() + ? GamePaths.Accessory.Mtrl.FolderPath(idTo, variantTo) + : GamePaths.Equipment.Mtrl.FolderPath(idTo, variantTo); + var pathTo = $"{folderTo}{fileName}"; - var folderFrom = GamePaths.Mtrl.GearFolder(slotFrom, idFrom, variantTo); + var folderFrom = slotFrom.IsAccessory() + ? GamePaths.Accessory.Mtrl.FolderPath(idFrom, variantTo) + : GamePaths.Equipment.Mtrl.FolderPath(idFrom, variantTo); var newFileName = ItemSwap.ReplaceId(fileName, prefix, idTo, idFrom); newFileName = ItemSwap.ReplaceSlot(newFileName, slotTo, slotFrom, slotTo != slotFrom); var pathFrom = $"{folderFrom}{newFileName}"; @@ -472,8 +397,8 @@ public static class EquipmentSwap return mtrl; } - public static FileSwap CreateTex(MetaFileManager manager, Func redirections, char prefix, PrimaryId idFrom, - PrimaryId idTo, ref MtrlFile.Texture texture, ref bool dataWasChanged) + public static FileSwap CreateTex(MetaFileManager manager, Func redirections, char prefix, PrimaryId idFrom, PrimaryId idTo, + ref MtrlFile.Texture texture, ref bool dataWasChanged) => CreateTex(manager, redirections, prefix, EquipSlot.Unknown, EquipSlot.Unknown, idFrom, idTo, ref texture, ref dataWasChanged); public static FileSwap CreateTex(MetaFileManager manager, Func redirections, char prefix, EquipSlot slotFrom, @@ -482,7 +407,6 @@ public static class EquipmentSwap var addedDashes = GamePaths.Tex.HandleDx11Path(texture, out var path); var newPath = ItemSwap.ReplaceAnyId(path, prefix, idFrom); newPath = ItemSwap.ReplaceSlot(newPath, slotTo, slotFrom, slotTo != slotFrom); - newPath = ItemSwap.ReplaceType(newPath, slotFrom, slotTo, idFrom); newPath = ItemSwap.AddSuffix(newPath, ".tex", $"_{Path.GetFileName(texture.Path).GetStableHashCode():x8}"); if (newPath != path) { @@ -496,16 +420,15 @@ public static class EquipmentSwap public static FileSwap CreateShader(MetaFileManager manager, Func redirections, ref string shaderName, ref bool dataWasChanged) { - var path = GamePaths.Shader(shaderName); + var path = $"shader/sm5/shpk/{shaderName}"; return FileSwap.CreateSwap(manager, ResourceType.Shpk, redirections, path, path); } - public static FileSwap CreateAtex(MetaFileManager manager, Func redirections, EquipSlot slotFrom, EquipSlot slotTo, - PrimaryId idFrom, ref string filePath, ref bool dataWasChanged) + public static FileSwap CreateAtex(MetaFileManager manager, Func redirections, ref string filePath, + ref bool dataWasChanged) { var oldPath = filePath; filePath = ItemSwap.AddSuffix(filePath, ".atex", $"_{Path.GetFileName(filePath).GetStableHashCode():x8}"); - filePath = ItemSwap.ReplaceType(filePath, slotFrom, slotTo, idFrom); dataWasChanged = true; return FileSwap.CreateSwap(manager, ResourceType.Atex, redirections, filePath, oldPath, oldPath); diff --git a/Penumbra/Mods/ItemSwap/ItemSwap.cs b/Penumbra/Mods/ItemSwap/ItemSwap.cs index 0049fa12..b269d89c 100644 --- a/Penumbra/Mods/ItemSwap/ItemSwap.cs +++ b/Penumbra/Mods/ItemSwap/ItemSwap.cs @@ -15,9 +15,13 @@ public static class ItemSwap public class InvalidItemTypeException : Exception { } - public class MissingFileException(ResourceType type, object path) : Exception($"Could not load {type} File Data for \"{path}\".") + public class MissingFileException : Exception { - public readonly ResourceType Type = type; + public readonly ResourceType Type; + + public MissingFileException(ResourceType type, object path) + : base($"Could not load {type} File Data for \"{path}\".") + => Type = type; } private static bool LoadFile(MetaFileManager manager, FullPath path, out byte[] data) @@ -43,7 +47,7 @@ public static class ItemSwap Penumbra.Log.Debug($"Could not load file {path}:\n{e}"); } - data = []; + data = Array.Empty(); return false; } @@ -129,38 +133,38 @@ public static class ItemSwap } - public static FileSwap CreatePhyb(MetaFileManager manager, Func redirections, EstType type, - GenderRace race, EstEntry estEntry) + public static FileSwap CreatePhyb(MetaFileManager manager, Func redirections, EstManipulation.EstType type, + GenderRace race, ushort estEntry) { - var phybPath = GamePaths.Phyb.Customization(race, type.ToName(), estEntry.AsId); + var phybPath = GamePaths.Skeleton.Phyb.Path(race, EstManipulation.ToName(type), estEntry); return FileSwap.CreateSwap(manager, ResourceType.Phyb, redirections, phybPath, phybPath); } - public static FileSwap CreateSklb(MetaFileManager manager, Func redirections, EstType type, - GenderRace race, EstEntry estEntry) + public static FileSwap CreateSklb(MetaFileManager manager, Func redirections, EstManipulation.EstType type, + GenderRace race, ushort estEntry) { - var sklbPath = GamePaths.Sklb.Customization(race, type.ToName(), estEntry.AsId); + var sklbPath = GamePaths.Skeleton.Sklb.Path(race, EstManipulation.ToName(type), estEntry); return FileSwap.CreateSwap(manager, ResourceType.Sklb, redirections, sklbPath, sklbPath); } - public static MetaSwap? CreateEst(MetaFileManager manager, Func redirections, - MetaDictionary manips, EstType type, GenderRace genderRace, PrimaryId idFrom, PrimaryId idTo, bool ownMdl) + /// metaChanges is not manipulated, but IReadOnlySet does not support TryGetValue. + public static MetaSwap? CreateEst(MetaFileManager manager, Func redirections, + Func manips, EstManipulation.EstType type, + GenderRace genderRace, PrimaryId idFrom, PrimaryId idTo, bool ownMdl) { if (type == 0) return null; - var manipFromIdentifier = new EstIdentifier(idFrom, type, genderRace); - var manipToIdentifier = new EstIdentifier(idTo, type, genderRace); - var manipFromDefault = EstFile.GetDefault(manager, manipFromIdentifier); - var manipToDefault = EstFile.GetDefault(manager, manipToIdentifier); - var est = new MetaSwap(i => manips.TryGetValue(i, out var e) ? e : null, manipFromIdentifier, manipFromDefault, - manipToIdentifier, manipToDefault); + var (gender, race) = genderRace.Split(); + var fromDefault = new EstManipulation(gender, race, type, idFrom, EstFile.GetDefault(manager, type, genderRace, idFrom)); + var toDefault = new EstManipulation(gender, race, type, idTo, EstFile.GetDefault(manager, type, genderRace, idTo)); + var est = new MetaSwap(manips, fromDefault, toDefault); - if (ownMdl && est.SwapToModdedEntry.Value >= 2) + if (ownMdl && est.SwapApplied.Est.Entry >= 2) { - var phyb = CreatePhyb(manager, redirections, type, genderRace, est.SwapToModdedEntry); + var phyb = CreatePhyb(manager, redirections, type, genderRace, est.SwapApplied.Est.Entry); est.ChildSwaps.Add(phyb); - var sklb = CreateSklb(manager, redirections, type, genderRace, est.SwapToModdedEntry); + var sklb = CreateSklb(manager, redirections, type, genderRace, est.SwapApplied.Est.Entry); est.ChildSwaps.Add(sklb); } else if (est.SwapAppliedIsDefault) @@ -212,22 +216,6 @@ public static class ItemSwap ? path.Replace($"_{from.ToSuffix()}_", $"_{to.ToSuffix()}_") : path; - public static string ReplaceType(string path, EquipSlot from, EquipSlot to, PrimaryId idFrom) - { - var isAccessoryFrom = from.IsAccessory(); - if (isAccessoryFrom == to.IsAccessory()) - return path; - - if (isAccessoryFrom) - { - path = path.Replace("accessory/a", "equipment/e"); - return path.Replace($"a{idFrom.Id:D4}", $"e{idFrom.Id:D4}"); - } - - path = path.Replace("equipment/e", "accessory/a"); - return path.Replace($"e{idFrom.Id:D4}", $"a{idFrom.Id:D4}"); - } - public static string ReplaceRace(string path, GenderRace from, GenderRace to, bool condition = true) => ReplaceId(path, 'c', (ushort)from, (ushort)to, condition); diff --git a/Penumbra/Mods/ItemSwap/ItemSwapContainer.cs b/Penumbra/Mods/ItemSwap/ItemSwapContainer.cs index a9d5e0d6..449405a0 100644 --- a/Penumbra/Mods/ItemSwap/ItemSwapContainer.cs +++ b/Penumbra/Mods/ItemSwap/ItemSwapContainer.cs @@ -23,7 +23,7 @@ public class ItemSwapContainer public IReadOnlyDictionary ModRedirections => _appliedModData.FileRedirections; - public MetaDictionary ModManipulations + public IReadOnlySet ModManipulations => _appliedModData.Manipulations; public readonly List Swaps = []; @@ -42,10 +42,9 @@ public class ItemSwapContainer NoSwaps, } - public bool WriteMod(ModManager manager, Mod mod, IModDataContainer container, WriteType writeType = WriteType.NoSwaps, - DirectoryInfo? directory = null) + public bool WriteMod(ModManager manager, Mod mod, IModDataContainer container, WriteType writeType = WriteType.NoSwaps, DirectoryInfo? directory = null) { - var convertedManips = new MetaDictionary(); + var convertedManips = new HashSet(Swaps.Count); var convertedFiles = new Dictionary(Swaps.Count); var convertedSwaps = new Dictionary(Swaps.Count); directory ??= mod.ModPath; @@ -53,45 +52,38 @@ public class ItemSwapContainer { foreach (var swap in Swaps.SelectMany(s => s.WithChildren())) { - if (swap is FileSwap file) + switch (swap) { - // Skip, nothing to do - if (file.SwapToModdedEqualsOriginal) - continue; + case FileSwap file: + // Skip, nothing to do + if (file.SwapToModdedEqualsOriginal) + continue; - if (writeType == WriteType.UseSwaps && file.SwapToModdedExistsInGame && !file.DataWasChanged) - { - convertedSwaps.TryAdd(file.SwapFromRequestPath, file.SwapToModded); - } - else - { - var path = file.GetNewPath(directory.FullName); - var bytes = file.FileData.Write(); - Directory.CreateDirectory(Path.GetDirectoryName(path)!); - _manager.Compactor.WriteAllBytes(path, bytes); - convertedFiles.TryAdd(file.SwapFromRequestPath, new FullPath(path)); - } - } - else if (swap is IMetaSwap { SwapAppliedIsDefault: false }) - { - // @formatter:off - _ = swap switch - { - MetaSwap meta => convertedManips.TryAdd(meta.SwapFromIdentifier, meta.SwapToModdedEntry), - MetaSwap meta => convertedManips.TryAdd(meta.SwapFromIdentifier, meta.SwapToModdedEntry), - MetaSwap meta => convertedManips.TryAdd(meta.SwapFromIdentifier, meta.SwapToModdedEntry), - MetaSwapmeta => convertedManips.TryAdd(meta.SwapFromIdentifier, meta.SwapToModdedEntry), - MetaSwapmeta => convertedManips.TryAdd(meta.SwapFromIdentifier, meta.SwapToModdedEntry), - _ => false, - }; - // @formatter:on + if (writeType == WriteType.UseSwaps && file.SwapToModdedExistsInGame && !file.DataWasChanged) + { + convertedSwaps.TryAdd(file.SwapFromRequestPath, file.SwapToModded); + } + else + { + var path = file.GetNewPath(directory.FullName); + var bytes = file.FileData.Write(); + Directory.CreateDirectory(Path.GetDirectoryName(path)!); + _manager.Compactor.WriteAllBytes(path, bytes); + convertedFiles.TryAdd(file.SwapFromRequestPath, new FullPath(path)); + } + + break; + case MetaSwap meta: + if (!meta.SwapAppliedIsDefault) + convertedManips.Add(meta.SwapApplied); + + break; } } manager.OptionEditor.SetFiles(container, convertedFiles, SaveType.None); manager.OptionEditor.SetFileSwaps(container, convertedSwaps, SaveType.None); - manager.OptionEditor.SetManipulations(container, convertedManips, SaveType.None); - manager.OptionEditor.ForceSave(container, SaveType.ImmediateSync); + manager.OptionEditor.SetManipulations(container, convertedManips, SaveType.ImmediateSync); return true; } catch (Exception e) @@ -105,9 +97,13 @@ public class ItemSwapContainer { Clear(); if (mod == null || mod.Index < 0) - _appliedModData = AppliedModData.Empty; + { + _appliedModData = AppliedModData.Empty; + } else + { _appliedModData = ModSettings.GetResolveData(mod, settings); + } } public ItemSwapContainer(MetaFileManager manager, ObjectIdentification identifier) @@ -122,12 +118,13 @@ public class ItemSwapContainer ? p => collection.ResolvePath(p) ?? new FullPath(p) : p => ModRedirections.TryGetValue(p, out var path) ? path : new FullPath(p); - private MetaDictionary MetaResolver(ModCollection? collection) - => collection?.MetaCache is { } cache - ? new MetaDictionary(cache) - : _appliedModData.Manipulations; + private Func MetaResolver(ModCollection? collection) + { + var set = collection?.MetaCache?.Manipulations.ToHashSet() ?? _appliedModData.Manipulations; + return m => set.TryGetValue(m, out var a) ? a : m; + } - public HashSet LoadEquipment(EquipItem from, EquipItem to, ModCollection? collection = null, bool useRightRing = true, + public EquipItem[] LoadEquipment(EquipItem from, EquipItem to, ModCollection? collection = null, bool useRightRing = true, bool useLeftRing = true) { Swaps.Clear(); @@ -138,7 +135,7 @@ public class ItemSwapContainer return ret; } - public HashSet LoadTypeSwap(EquipSlot slotFrom, EquipItem from, EquipSlot slotTo, EquipItem to, ModCollection? collection = null) + public EquipItem[] LoadTypeSwap(EquipSlot slotFrom, EquipItem from, EquipSlot slotTo, EquipItem to, ModCollection? collection = null) { Swaps.Clear(); Loaded = false; @@ -155,13 +152,13 @@ public class ItemSwapContainer var mdl = CustomizationSwap.CreateMdl(manager, pathResolver, slot, race, from, to); var type = slot switch { - BodySlot.Hair => EstType.Hair, - BodySlot.Face => EstType.Face, - _ => (EstType)0, + BodySlot.Hair => EstManipulation.EstType.Hair, + BodySlot.Face => EstManipulation.EstType.Face, + _ => (EstManipulation.EstType)0, }; - var estResolver = MetaResolver(collection); - var est = ItemSwap.CreateEst(manager, pathResolver, estResolver, type, race, from, to, true); + var metaResolver = MetaResolver(collection); + var est = ItemSwap.CreateEst(manager, pathResolver, metaResolver, type, race, from, to, true); Swaps.Add(mdl); if (est != null) diff --git a/Penumbra/Mods/ItemSwap/Swaps.cs b/Penumbra/Mods/ItemSwap/Swaps.cs index 36c54203..27935ffb 100644 --- a/Penumbra/Mods/ItemSwap/Swaps.cs +++ b/Penumbra/Mods/ItemSwap/Swaps.cs @@ -1,91 +1,58 @@ -using Penumbra.Api.Enums; +using Penumbra.Api.Enums; using Penumbra.GameData.Files; using Penumbra.Meta.Manipulations; using Penumbra.String.Classes; using Penumbra.Meta; using static Penumbra.Mods.ItemSwap.ItemSwap; +using Penumbra.Services; namespace Penumbra.Mods.ItemSwap; public class Swap { /// Any further swaps belonging specifically to this tree of changes. - public readonly List ChildSwaps = []; + public readonly List ChildSwaps = new(); public IEnumerable WithChildren() => ChildSwaps.SelectMany(c => c.WithChildren()).Prepend(this); } -public interface IMetaSwap +public sealed class MetaSwap : Swap { - public IMetaIdentifier SwapFromIdentifier { get; } - public IMetaIdentifier SwapToIdentifier { get; } - - public object SwapFromDefaultEntry { get; } - public object SwapToDefaultEntry { get; } - public object SwapToModdedEntry { get; } - - public bool SwapToIsDefault { get; } - public bool SwapAppliedIsDefault { get; } -} - -public sealed class MetaSwap : Swap, IMetaSwap - where TIdentifier : unmanaged, IMetaIdentifier - where TEntry : unmanaged, IEquatable -{ - public TIdentifier SwapFromIdentifier; - public TIdentifier SwapToIdentifier; - /// The default value of a specific meta manipulation that needs to be redirected. - public TEntry SwapFromDefaultEntry; + public MetaManipulation SwapFrom; /// The default value of the same Meta entry of the redirected item. - public TEntry SwapToDefaultEntry; + public MetaManipulation SwapToDefault; /// The modded value of the same Meta entry of the redirected item, or the same as SwapToDefault if unmodded. - public TEntry SwapToModdedEntry; + public MetaManipulation SwapToModded; - /// Whether SwapToModdedEntry equals SwapToDefaultEntry. - public bool SwapToIsDefault { get; } + /// The modded value applied to the specific meta manipulation target before redirection. + public MetaManipulation SwapApplied; + + /// Whether SwapToModded equals SwapToDefault. + public bool SwapToIsDefault; /// Whether the applied meta manipulation does not change anything against the default. - public bool SwapAppliedIsDefault { get; } + public bool SwapAppliedIsDefault; /// /// Create a new MetaSwap from the original meta identifier and the target meta identifier. /// - /// A function that obtains a modded meta entry if it exists. - /// The original meta identifier. - /// The default value for the original meta identifier. - /// The target meta identifier. - /// The default value for the target meta identifier. - public MetaSwap(Func manipulations, TIdentifier manipFromIdentifier, TEntry manipFromEntry, - TIdentifier manipToIdentifier, TEntry manipToEntry) + /// A function that converts the given manipulation to the modded one. + /// The original meta identifier with its default value. + /// The target meta identifier with its default value. + public MetaSwap(Func manipulations, MetaManipulation manipFrom, MetaManipulation manipTo) { - SwapFromIdentifier = manipFromIdentifier; - SwapToIdentifier = manipToIdentifier; - SwapFromDefaultEntry = manipFromEntry; - SwapToDefaultEntry = manipToEntry; + SwapFrom = manipFrom; + SwapToDefault = manipTo; - SwapToModdedEntry = manipulations(SwapToIdentifier) ?? SwapToDefaultEntry; - SwapToIsDefault = SwapToModdedEntry.Equals(SwapToDefaultEntry); - SwapAppliedIsDefault = SwapToModdedEntry.Equals(SwapFromDefaultEntry); + SwapToModded = manipulations(manipTo); + SwapToIsDefault = manipTo.EntryEquals(SwapToModded); + SwapApplied = SwapFrom.WithEntryOf(SwapToModded); + SwapAppliedIsDefault = SwapApplied.EntryEquals(SwapFrom); } - - IMetaIdentifier IMetaSwap.SwapFromIdentifier - => SwapFromIdentifier; - - IMetaIdentifier IMetaSwap.SwapToIdentifier - => SwapToIdentifier; - - object IMetaSwap.SwapFromDefaultEntry - => SwapFromDefaultEntry; - - object IMetaSwap.SwapToDefaultEntry - => SwapToDefaultEntry; - - object IMetaSwap.SwapToModdedEntry - => SwapToModdedEntry; } public sealed class FileSwap : Swap @@ -146,7 +113,8 @@ public sealed class FileSwap : Swap /// A full swap container with the actual file in memory. /// True if everything could be read correctly, false otherwise. public static FileSwap CreateSwap(MetaFileManager manager, ResourceType type, Func redirections, - string swapFromRequest, string swapToRequest, string? swapFromPreChange = null) + string swapFromRequest, string swapToRequest, + string? swapFromPreChange = null) { var swap = new FileSwap { diff --git a/Penumbra/Mods/Manager/ModCacheManager.cs b/Penumbra/Mods/Manager/ModCacheManager.cs index 130c8fcb..8ab8cf33 100644 --- a/Penumbra/Mods/Manager/ModCacheManager.cs +++ b/Penumbra/Mods/Manager/ModCacheManager.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using Penumbra.Communication; using Penumbra.GameData.Data; using Penumbra.Mods.Groups; @@ -9,13 +8,13 @@ using Penumbra.Util; namespace Penumbra.Mods.Manager; -public class ModCacheManager : IDisposable, IService +public class ModCacheManager : IDisposable { private readonly Configuration _config; private readonly CommunicatorService _communicator; private readonly ObjectIdentification _identifier; private readonly ModStorage _modManager; - private bool _updatingItems; + private bool _updatingItems = false; public ModCacheManager(CommunicatorService communicator, ObjectIdentification identifier, ModStorage modStorage, Configuration config) { @@ -139,7 +138,6 @@ public class ModCacheManager : IDisposable, IService mod.ChangedItems.RemoveMachinistOffhands(); mod.LowerChangedItemsString = string.Join("\0", mod.ChangedItems.Keys.Select(k => k.ToLowerInvariant())); - ++mod.LastChangedItemsUpdate; } private static void UpdateCounts(Mod mod) diff --git a/Penumbra/Mods/Manager/ModDataEditor.cs b/Penumbra/Mods/Manager/ModDataEditor.cs index ffa73b76..e0af6f36 100644 --- a/Penumbra/Mods/Manager/ModDataEditor.cs +++ b/Penumbra/Mods/Manager/ModDataEditor.cs @@ -1,8 +1,6 @@ using Dalamud.Utility; +using Newtonsoft.Json.Linq; using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.GameData.Data; -using Penumbra.GameData.Structs; using Penumbra.Services; namespace Penumbra.Mods.Manager; @@ -10,42 +8,171 @@ namespace Penumbra.Mods.Manager; [Flags] public enum ModDataChangeType : ushort { - None = 0x0000, - Name = 0x0001, - Author = 0x0002, - Description = 0x0004, - Version = 0x0008, - Website = 0x0010, - Deletion = 0x0020, - Migration = 0x0040, - ModTags = 0x0080, - ImportDate = 0x0100, - Favorite = 0x0200, - LocalTags = 0x0400, - Note = 0x0800, - Image = 0x1000, - DefaultChangedItems = 0x2000, - PreferredChangedItems = 0x4000, - RequiredFeatures = 0x8000, + None = 0x0000, + Name = 0x0001, + Author = 0x0002, + Description = 0x0004, + Version = 0x0008, + Website = 0x0010, + Deletion = 0x0020, + Migration = 0x0040, + ModTags = 0x0080, + ImportDate = 0x0100, + Favorite = 0x0200, + LocalTags = 0x0400, + Note = 0x0800, } -public class ModDataEditor(SaveService saveService, CommunicatorService communicatorService, ItemData itemData) : IService +public class ModDataEditor(SaveService saveService, CommunicatorService communicatorService) { - public SaveService SaveService - => saveService; - /// Create the file containing the meta information about a mod from scratch. public void CreateMeta(DirectoryInfo directory, string? name, string? author, string? description, string? version, - string? website, params string[] tags) + string? website) { var mod = new Mod(directory); - mod.Name = name.IsNullOrEmpty() ? mod.Name : new LowerString(name); + mod.Name = name.IsNullOrEmpty() ? mod.Name : new LowerString(name!); mod.Author = author != null ? new LowerString(author) : mod.Author; mod.Description = description ?? mod.Description; mod.Version = version ?? mod.Version; mod.Website = website ?? mod.Website; - mod.ModTags = tags; - saveService.ImmediateSaveSync(new ModMeta(mod)); + saveService.ImmediateSave(new ModMeta(mod)); + } + + public ModDataChangeType LoadLocalData(Mod mod) + { + var dataFile = saveService.FileNames.LocalDataFile(mod); + + var importDate = 0L; + var localTags = Enumerable.Empty(); + var favorite = false; + var note = string.Empty; + + var save = true; + if (File.Exists(dataFile)) + { + save = false; + try + { + var text = File.ReadAllText(dataFile); + var json = JObject.Parse(text); + + importDate = json[nameof(Mod.ImportDate)]?.Value() ?? importDate; + favorite = json[nameof(Mod.Favorite)]?.Value() ?? favorite; + note = json[nameof(Mod.Note)]?.Value() ?? note; + localTags = json[nameof(Mod.LocalTags)]?.Values().OfType() ?? localTags; + } + catch (Exception e) + { + Penumbra.Log.Error($"Could not load local mod data:\n{e}"); + } + } + + if (importDate == 0) + importDate = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); + + ModDataChangeType changes = 0; + if (mod.ImportDate != importDate) + { + mod.ImportDate = importDate; + changes |= ModDataChangeType.ImportDate; + } + + changes |= ModLocalData.UpdateTags(mod, null, localTags); + + if (mod.Favorite != favorite) + { + mod.Favorite = favorite; + changes |= ModDataChangeType.Favorite; + } + + if (mod.Note != note) + { + mod.Note = note; + changes |= ModDataChangeType.Note; + } + + if (save) + saveService.QueueSave(new ModLocalData(mod)); + + return changes; + } + + public ModDataChangeType LoadMeta(ModCreator creator, Mod mod) + { + var metaFile = saveService.FileNames.ModMetaPath(mod); + if (!File.Exists(metaFile)) + { + Penumbra.Log.Debug($"No mod meta found for {mod.ModPath.Name}."); + return ModDataChangeType.Deletion; + } + + try + { + var text = File.ReadAllText(metaFile); + var json = JObject.Parse(text); + + var newName = json[nameof(Mod.Name)]?.Value() ?? string.Empty; + var newAuthor = json[nameof(Mod.Author)]?.Value() ?? string.Empty; + var newDescription = json[nameof(Mod.Description)]?.Value() ?? string.Empty; + var newVersion = json[nameof(Mod.Version)]?.Value() ?? string.Empty; + var newWebsite = json[nameof(Mod.Website)]?.Value() ?? string.Empty; + var newFileVersion = json[nameof(ModMeta.FileVersion)]?.Value() ?? 0; + var importDate = json[nameof(Mod.ImportDate)]?.Value(); + var modTags = json[nameof(Mod.ModTags)]?.Values().OfType(); + + ModDataChangeType changes = 0; + if (mod.Name != newName) + { + changes |= ModDataChangeType.Name; + mod.Name = newName; + } + + if (mod.Author != newAuthor) + { + changes |= ModDataChangeType.Author; + mod.Author = newAuthor; + } + + if (mod.Description != newDescription) + { + changes |= ModDataChangeType.Description; + mod.Description = newDescription; + } + + if (mod.Version != newVersion) + { + changes |= ModDataChangeType.Version; + mod.Version = newVersion; + } + + if (mod.Website != newWebsite) + { + changes |= ModDataChangeType.Website; + mod.Website = newWebsite; + } + + if (newFileVersion != ModMeta.FileVersion) + if (ModMigration.Migrate(creator, saveService, mod, json, ref newFileVersion)) + { + changes |= ModDataChangeType.Migration; + saveService.ImmediateSave(new ModMeta(mod)); + } + + if (importDate != null && mod.ImportDate != importDate.Value) + { + mod.ImportDate = importDate.Value; + changes |= ModDataChangeType.ImportDate; + } + + changes |= ModLocalData.UpdateTags(mod, modTags, null); + + return changes; + } + catch (Exception e) + { + Penumbra.Log.Error($"Could not load mod meta for {metaFile}:\n{e}"); + return ModDataChangeType.Deletion; + } } public void ChangeModName(Mod mod, string newName) @@ -97,16 +224,6 @@ public class ModDataEditor(SaveService saveService, CommunicatorService communic mod.Website = newWebsite; saveService.QueueSave(new ModMeta(mod)); communicatorService.ModDataChanged.Invoke(ModDataChangeType.Website, mod, null); - } - - public void ChangeRequiredFeatures(Mod mod, FeatureFlags flags) - { - if (mod.RequiredFeatures == flags) - return; - - mod.RequiredFeatures = flags; - saveService.QueueSave(new ModMeta(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.RequiredFeatures, mod, null); } public void ChangeModTag(Mod mod, int tagIdx, string newTag) @@ -122,20 +239,10 @@ public class ModDataEditor(SaveService saveService, CommunicatorService communic mod.Favorite = state; saveService.QueueSave(new ModLocalData(mod)); + ; communicatorService.ModDataChanged.Invoke(ModDataChangeType.Favorite, mod, null); } - public void ResetModImportDate(Mod mod) - { - var newDate = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); - if (mod.ImportDate == newDate) - return; - - mod.ImportDate = newDate; - saveService.QueueSave(new ModLocalData(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.ImportDate, mod, null); - } - public void ChangeModNote(Mod mod, string newNote) { if (mod.Note == newNote) @@ -143,6 +250,7 @@ public class ModDataEditor(SaveService saveService, CommunicatorService communic mod.Note = newNote; saveService.QueueSave(new ModLocalData(mod)); + ; communicatorService.ModDataChanged.Invoke(ModDataChangeType.Favorite, mod, null); } @@ -152,7 +260,7 @@ public class ModDataEditor(SaveService saveService, CommunicatorService communic if (tagIdx < 0 || tagIdx > which.Count) return; - ModDataChangeType flags; + ModDataChangeType flags = 0; if (tagIdx == which.Count) { flags = ModLocalData.UpdateTags(mod, local ? null : which.Append(newTag), local ? which.Append(newTag) : null); @@ -190,125 +298,4 @@ public class ModDataEditor(SaveService saveService, CommunicatorService communic Penumbra.Log.Error($"Could not move local data file {oldFile} to {newFile}:\n{e}"); } } - - public void AddPreferredItem(Mod mod, CustomItemId id, bool toDefault, bool cleanExisting) - { - if (CleanExisting(mod.PreferredChangedItems)) - { - ++mod.LastChangedItemsUpdate; - saveService.QueueSave(new ModLocalData(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.PreferredChangedItems, mod, null); - } - - if (toDefault && CleanExisting(mod.DefaultPreferredItems)) - { - saveService.QueueSave(new ModMeta(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.DefaultChangedItems, mod, null); - } - - bool CleanExisting(HashSet items) - { - if (!items.Add(id)) - return false; - - if (!cleanExisting) - return true; - - var it1Exists = itemData.Primary.TryGetValue(id, out var it1); - var it2Exists = itemData.Secondary.TryGetValue(id, out var it2); - var it3Exists = itemData.Tertiary.TryGetValue(id, out var it3); - - foreach (var item in items.ToArray()) - { - if (item == id) - continue; - - if (it1Exists - && itemData.Primary.TryGetValue(item, out var oldItem1) - && oldItem1.PrimaryId == it1.PrimaryId - && oldItem1.Type == it1.Type) - items.Remove(item); - - else if (it2Exists - && itemData.Primary.TryGetValue(item, out var oldItem2) - && oldItem2.PrimaryId == it2.PrimaryId - && oldItem2.Type == it2.Type) - items.Remove(item); - - else if (it3Exists - && itemData.Primary.TryGetValue(item, out var oldItem3) - && oldItem3.PrimaryId == it3.PrimaryId - && oldItem3.Type == it3.Type) - items.Remove(item); - } - - return true; - } - } - - public void RemovePreferredItem(Mod mod, CustomItemId id, bool fromDefault) - { - if (!fromDefault && mod.PreferredChangedItems.Remove(id)) - { - ++mod.LastChangedItemsUpdate; - saveService.QueueSave(new ModLocalData(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.PreferredChangedItems, mod, null); - } - - if (fromDefault && mod.DefaultPreferredItems.Remove(id)) - { - saveService.QueueSave(new ModMeta(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.DefaultChangedItems, mod, null); - } - } - - public void ClearInvalidPreferredItems(Mod mod) - { - var currentChangedItems = mod.ChangedItems.Values.OfType().Select(i => i.Item.Id).Distinct().ToHashSet(); - var newSet = new HashSet(mod.PreferredChangedItems.Count); - - if (CheckItems(mod.PreferredChangedItems)) - { - mod.PreferredChangedItems = newSet; - ++mod.LastChangedItemsUpdate; - saveService.QueueSave(new ModLocalData(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.PreferredChangedItems, mod, null); - } - - newSet = new HashSet(mod.DefaultPreferredItems.Count); - if (CheckItems(mod.DefaultPreferredItems)) - { - mod.DefaultPreferredItems = newSet; - saveService.QueueSave(new ModMeta(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.DefaultChangedItems, mod, null); - } - - return; - - bool CheckItems(HashSet set) - { - var changes = false; - foreach (var item in set) - { - if (currentChangedItems.Contains(item)) - newSet.Add(item); - else - changes = true; - } - - return changes; - } - } - - public void ResetPreferredItems(Mod mod) - { - if (mod.PreferredChangedItems.SetEquals(mod.DefaultPreferredItems)) - return; - - mod.PreferredChangedItems.Clear(); - mod.PreferredChangedItems.UnionWith(mod.DefaultPreferredItems); - ++mod.LastChangedItemsUpdate; - saveService.QueueSave(new ModLocalData(mod)); - communicatorService.ModDataChanged.Invoke(ModDataChangeType.PreferredChangedItems, mod, null); - } } diff --git a/Penumbra/Mods/Manager/ModExportManager.cs b/Penumbra/Mods/Manager/ModExportManager.cs index 38b9c0fd..676018be 100644 --- a/Penumbra/Mods/Manager/ModExportManager.cs +++ b/Penumbra/Mods/Manager/ModExportManager.cs @@ -1,11 +1,10 @@ -using OtterGui.Services; using Penumbra.Communication; using Penumbra.Mods.Editor; using Penumbra.Services; namespace Penumbra.Mods.Manager; -public class ModExportManager : IDisposable, IService +public class ModExportManager : IDisposable { private readonly Configuration _config; private readonly CommunicatorService _communicator; diff --git a/Penumbra/Mods/Manager/ModFileSystem.cs b/Penumbra/Mods/Manager/ModFileSystem.cs index 20a78995..c8a0a5db 100644 --- a/Penumbra/Mods/Manager/ModFileSystem.cs +++ b/Penumbra/Mods/Manager/ModFileSystem.cs @@ -1,26 +1,23 @@ -using Dalamud.Interface.ImGuiNotification; +using Newtonsoft.Json.Linq; using OtterGui.Classes; using OtterGui.Filesystem; -using OtterGui.Services; using Penumbra.Communication; using Penumbra.Services; namespace Penumbra.Mods.Manager; -public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, IService +public sealed class ModFileSystem : FileSystem, IDisposable, ISavable { private readonly ModManager _modManager; private readonly CommunicatorService _communicator; private readonly SaveService _saveService; - private readonly Configuration _config; // Create a new ModFileSystem from the currently loaded mods and the current sort order file. - public ModFileSystem(ModManager modManager, CommunicatorService communicator, SaveService saveService, Configuration config) + public ModFileSystem(ModManager modManager, CommunicatorService communicator, SaveService saveService) { _modManager = modManager; _communicator = communicator; _saveService = saveService; - _config = config; Reload(); Changed += OnChange; _communicator.ModDiscoveryFinished.Subscribe(Reload, ModDiscoveryFinished.Priority.ModFileSystem); @@ -37,11 +34,11 @@ public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, ISer public struct ImportDate : ISortMode { - public ReadOnlySpan Name - => "Import Date (Older First)"u8; + public string Name + => "Import Date (Older First)"; - public ReadOnlySpan Description - => "In each folder, sort all subfolders lexicographically, then sort all leaves using their import date."u8; + public string Description + => "In each folder, sort all subfolders lexicographically, then sort all leaves using their import date."; public IEnumerable GetChildren(Folder f) => f.GetSubFolders().Cast().Concat(f.GetLeaves().OrderBy(l => l.Value.ImportDate)); @@ -49,11 +46,11 @@ public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, ISer public struct InverseImportDate : ISortMode { - public ReadOnlySpan Name - => "Import Date (Newer First)"u8; + public string Name + => "Import Date (Newer First)"; - public ReadOnlySpan Description - => "In each folder, sort all subfolders lexicographically, then sort all leaves using their inverse import date."u8; + public string Description + => "In each folder, sort all subfolders lexicographically, then sort all leaves using their inverse import date."; public IEnumerable GetChildren(Folder f) => f.GetSubFolders().Cast().Concat(f.GetLeaves().OrderByDescending(l => l.Value.ImportDate)); @@ -80,7 +77,7 @@ public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, ISer // Update sort order when defaulted mod names change. private void OnModDataChange(ModDataChangeType type, Mod mod, string? oldName) { - if (!type.HasFlag(ModDataChangeType.Name) || oldName == null || !TryGetValue(mod, out var leaf)) + if (!type.HasFlag(ModDataChangeType.Name) || oldName == null || !FindLeaf(mod, out var leaf)) return; var old = oldName.FixName(); @@ -95,23 +92,10 @@ public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, ISer switch (type) { case ModPathChangeType.Added: - var parent = Root; - if (_config.DefaultImportFolder.Length != 0) - try - { - parent = FindOrCreateAllFolders(_config.DefaultImportFolder); - } - catch (Exception e) - { - Penumbra.Messager.NotificationMessage(e, - $"Could not move newly imported mod {mod.Name} to default import folder {_config.DefaultImportFolder}.", - NotificationType.Warning); - } - - CreateDuplicateLeaf(parent, mod.Name.Text, mod); + CreateDuplicateLeaf(Root, mod.Name.Text, mod); break; case ModPathChangeType.Deleted: - if (TryGetValue(mod, out var leaf)) + if (FindLeaf(mod, out var leaf)) Delete(leaf); break; @@ -124,6 +108,16 @@ public sealed class ModFileSystem : FileSystem, IDisposable, ISavable, ISer } } + // Search the entire filesystem for the leaf corresponding to a mod. + public bool FindLeaf(Mod mod, [NotNullWhen(true)] out Leaf? leaf) + { + leaf = Root.GetAllDescendants(ISortMode.Lexicographical) + .OfType() + .FirstOrDefault(l => l.Value == mod); + return leaf != null; + } + + // Used for saving and loading. private static string ModToIdentifier(Mod mod) => mod.ModPath.Name; diff --git a/Penumbra/Mods/Manager/ModImportManager.cs b/Penumbra/Mods/Manager/ModImportManager.cs index bb282262..c99b7d0e 100644 --- a/Penumbra/Mods/Manager/ModImportManager.cs +++ b/Penumbra/Mods/Manager/ModImportManager.cs @@ -1,13 +1,11 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using OtterGui.Classes; -using OtterGui.Services; using Penumbra.Import; using Penumbra.Mods.Editor; -using Penumbra.Services; namespace Penumbra.Mods.Manager; -public class ModImportManager(ModManager modManager, Configuration config, ModEditor modEditor, MigrationManager migrationManager) : IDisposable, IService +public class ModImportManager(ModManager modManager, Configuration config, ModEditor modEditor) : IDisposable { private readonly ConcurrentQueue _modsToUnpack = new(); @@ -34,8 +32,7 @@ public class ModImportManager(ModManager modManager, Configuration config, ModEd if (File.Exists(s)) return true; - Penumbra.Messager.NotificationMessage($"Failed to import queued mod at {s}, the file does not exist.", NotificationType.Warning, - false); + Penumbra.Messager.NotificationMessage($"Failed to import queued mod at {s}, the file does not exist.", NotificationType.Warning, false); return false; }).Select(s => new FileInfo(s)).ToArray(); @@ -43,7 +40,7 @@ public class ModImportManager(ModManager modManager, Configuration config, ModEd if (files.Length == 0) return; - _import = new TexToolsImporter(files.Length, files, AddNewMod, config, modEditor, modManager, modEditor.Compactor, migrationManager); + _import = new TexToolsImporter(files.Length, files, AddNewMod, config, modEditor, modManager, modEditor.Compactor); } public bool Importing @@ -70,6 +67,7 @@ public class ModImportManager(ModManager modManager, Configuration config, ModEd _import = null; } + public bool AddUnpackedMod([NotNullWhen(true)] out Mod? mod) { if (!_modsToAdd.TryDequeue(out var directory)) @@ -78,7 +76,7 @@ public class ModImportManager(ModManager modManager, Configuration config, ModEd return false; } - modManager.AddMod(directory, true); + modManager.AddMod(directory); mod = modManager.LastOrDefault(); return mod != null && mod.ModPath == directory; } diff --git a/Penumbra/Mods/Manager/ModManager.cs b/Penumbra/Mods/Manager/ModManager.cs index 77385bbd..adaca85e 100644 --- a/Penumbra/Mods/Manager/ModManager.cs +++ b/Penumbra/Mods/Manager/ModManager.cs @@ -1,6 +1,4 @@ -using OtterGui.Services; using Penumbra.Communication; -using Penumbra.Interop; using Penumbra.Mods.Editor; using Penumbra.Mods.Manager.OptionEditor; using Penumbra.Services; @@ -29,7 +27,7 @@ public enum ModPathChangeType StartingReload, } -public sealed class ModManager : ModStorage, IDisposable, IService +public sealed class ModManager : ModStorage, IDisposable { private readonly Configuration _config; private readonly CommunicatorService _communicator; @@ -49,15 +47,15 @@ public sealed class ModManager : ModStorage, IDisposable, IService DataEditor = dataEditor; OptionEditor = optionEditor; Creator = creator; - SetBaseDirectory(config.ModDirectory, true, out _); + SetBaseDirectory(config.ModDirectory, true); _communicator.ModPathChanged.Subscribe(OnModPathChange, ModPathChanged.Priority.ModManager); DiscoverMods(); } /// Change the mod base directory and discover available mods. - public void DiscoverMods(string newDir, out string resultNewDir) + public void DiscoverMods(string newDir) { - SetBaseDirectory(newDir, false, out resultNewDir); + SetBaseDirectory(newDir, false); DiscoverMods(); } @@ -82,13 +80,13 @@ public sealed class ModManager : ModStorage, IDisposable, IService } /// Load a new mod and add it to the manager if successful. - public void AddMod(DirectoryInfo modFolder, bool deleteDefaultMeta) + public void AddMod(DirectoryInfo modFolder) { if (this.Any(m => m.ModPath.Name == modFolder.Name)) return; Creator.SplitMultiGroups(modFolder); - var mod = Creator.LoadMod(modFolder, true, deleteDefaultMeta); + var mod = Creator.LoadMod(modFolder, true); if (mod == null) return; @@ -116,21 +114,12 @@ public sealed class ModManager : ModStorage, IDisposable, IService Penumbra.Log.Error($"Could not delete the mod {mod.ModPath.Name}:\n{e}"); } - RemoveMod(mod); - } - - /// - /// Remove a loaded mod. The event is invoked before the mod is removed from the list. - /// Does not delete the mod from the filesystem. - /// Updates indices of later mods. - /// - public void RemoveMod(Mod mod) - { _communicator.ModPathChanged.Invoke(ModPathChangeType.Deleted, mod, mod.ModPath, null); foreach (var remainingMod in Mods.Skip(mod.Index + 1)) --remainingMod.Index; Mods.RemoveAt(mod.Index); - Penumbra.Log.Debug($"Removed loaded mod {mod.Name} from list."); + + Penumbra.Log.Debug($"Deleted mod {mod.Name}."); } /// @@ -142,13 +131,13 @@ public sealed class ModManager : ModStorage, IDisposable, IService var oldName = mod.Name; _communicator.ModPathChanged.Invoke(ModPathChangeType.StartingReload, mod, mod.ModPath, mod.ModPath); - if (!Creator.ReloadMod(mod, true, false, out var metaChange)) + if (!Creator.ReloadMod(mod, true, out var metaChange)) { - if (mod.RequiredFeatures is not FeatureFlags.Invalid) - Penumbra.Log.Warning(mod.Name.Length == 0 - ? $"Reloading mod {oldName} has failed, new name is empty. Removing from loaded mods instead." - : $"Reloading mod {oldName} failed, {mod.ModPath.FullName} does not exist anymore or it has invalid data. Removing from loaded mods instead."); - RemoveMod(mod); + Penumbra.Log.Warning(mod.Name.Length == 0 + ? $"Reloading mod {oldName} has failed, new name is empty. Deleting instead." + : $"Reloading mod {oldName} failed, {mod.ModPath.FullName} does not exist anymore or it ha. Deleting instead."); + + DeleteMod(mod); return; } @@ -208,7 +197,7 @@ public sealed class ModManager : ModStorage, IDisposable, IService dir.Refresh(); mod.ModPath = dir; - if (!Creator.ReloadMod(mod, false, false, out var metaChange)) + if (!Creator.ReloadMod(mod, false, out var metaChange)) { Penumbra.Log.Error($"Error reloading moved mod {mod.Name}."); return; @@ -253,8 +242,12 @@ public sealed class ModManager : ModStorage, IDisposable, IService { switch (type) { - case ModPathChangeType.Added: SetNew(mod); break; - case ModPathChangeType.Deleted: SetKnown(mod); break; + case ModPathChangeType.Added: + SetNew(mod); + break; + case ModPathChangeType.Deleted: + SetKnown(mod); + break; case ModPathChangeType.Moved: if (oldDirectory != null && newDirectory != null) DataEditor.MoveDataFile(oldDirectory, newDirectory); @@ -268,13 +261,12 @@ public sealed class ModManager : ModStorage, IDisposable, IService /// /// Set the mod base directory. - /// If it's not the first time, check if it is the same directory as before. + /// If its not the first time, check if it is the same directory as before. /// Also checks if the directory is available and tries to create it if it is not. /// - private void SetBaseDirectory(string newPath, bool firstTime, out string resultNewDir) + private void SetBaseDirectory(string newPath, bool firstTime) { - resultNewDir = newPath; - if (!firstTime && string.Equals(newPath, _config.ModDirectory, StringComparison.Ordinal)) + if (!firstTime && string.Equals(newPath, _config.ModDirectory, StringComparison.OrdinalIgnoreCase)) return; if (newPath.Length == 0) @@ -286,7 +278,7 @@ public sealed class ModManager : ModStorage, IDisposable, IService } else { - var newDir = new DirectoryInfo(Path.TrimEndingDirectorySeparator(newPath)); + var newDir = new DirectoryInfo(newPath); if (!newDir.Exists) try { @@ -298,15 +290,11 @@ public sealed class ModManager : ModStorage, IDisposable, IService Penumbra.Log.Error($"Could not create specified mod directory {newDir.FullName}:\n{e}"); } - BasePath = newDir; - Valid = Directory.Exists(newDir.FullName); - resultNewDir = BasePath.FullName; + BasePath = newDir; + Valid = Directory.Exists(newDir.FullName); if (!firstTime && _config.ModDirectory != BasePath.FullName) TriggerModDirectoryChange(BasePath.FullName, Valid); } - - if (CloudApi.IsCloudSynced(BasePath.FullName)) - Penumbra.Log.Warning($"Mod base directory {BasePath.FullName} is cloud-synced. This may cause issues."); } private void TriggerModDirectoryChange(string newPath, bool valid) @@ -333,7 +321,7 @@ public sealed class ModManager : ModStorage, IDisposable, IService var queue = new ConcurrentQueue(); Parallel.ForEach(BasePath.EnumerateDirectories(), options, dir => { - var mod = Creator.LoadMod(dir, false, false); + var mod = Creator.LoadMod(dir, false); if (mod != null) queue.Enqueue(mod); }); @@ -351,22 +339,4 @@ public sealed class ModManager : ModStorage, IDisposable, IService Penumbra.Log.Error($"Could not scan for mods:\n{ex}"); } } - - public bool TryIdentifyPath(string path, [NotNullWhen(true)] out Mod? mod, [NotNullWhen(true)] out string? relativePath) - { - var relPath = Path.GetRelativePath(BasePath.FullName, path); - if (relPath != "." && (relPath.StartsWith('.') || Path.IsPathRooted(relPath))) - { - mod = null; - relativePath = null; - return false; - } - - var modDirectorySeparator = relPath.IndexOfAny([Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar]); - - var modDirectory = modDirectorySeparator < 0 ? relPath : relPath[..modDirectorySeparator]; - relativePath = modDirectorySeparator < 0 ? string.Empty : relPath[(modDirectorySeparator + 1)..]; - - return TryGetMod(modDirectory, "\0", out mod); - } } diff --git a/Penumbra/Mods/Manager/ModMigration.cs b/Penumbra/Mods/Manager/ModMigration.cs index f3b25f1a..c7eb7cc5 100644 --- a/Penumbra/Mods/Manager/ModMigration.cs +++ b/Penumbra/Mods/Manager/ModMigration.cs @@ -1,8 +1,7 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; -using OtterGui.Extensions; +using OtterGui; using Penumbra.Api.Enums; -using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; using Penumbra.Mods.Settings; using Penumbra.Mods.SubMods; @@ -83,8 +82,9 @@ public static partial class ModMigration foreach (var (gamePath, swapPath) in swaps) mod.Default.FileSwaps.Add(gamePath, swapPath); - creator.IncorporateAllMetaChanges(mod, true, true); - saveService.SaveAllOptionGroups(mod, false, creator.Config.ReplaceNonAsciiOnImport); + creator.IncorporateMetaChanges(mod.Default, mod.ModPath, true); + foreach (var group in mod.Groups) + saveService.ImmediateSave(new ModSaveGroup(group, creator.Config.ReplaceNonAsciiOnImport)); // Delete meta files. foreach (var file in seenMetaFiles.Where(f => f.Exists)) diff --git a/Penumbra/Mods/Manager/OptionEditor/CombiningModGroupEditor.cs b/Penumbra/Mods/Manager/OptionEditor/CombiningModGroupEditor.cs deleted file mode 100644 index 5acf5eb5..00000000 --- a/Penumbra/Mods/Manager/OptionEditor/CombiningModGroupEditor.cs +++ /dev/null @@ -1,49 +0,0 @@ -using OtterGui; -using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Services; -using Penumbra.Mods.Groups; -using Penumbra.Mods.Settings; -using Penumbra.Mods.SubMods; -using Penumbra.Services; - -namespace Penumbra.Mods.Manager.OptionEditor; - -public sealed class CombiningModGroupEditor(CommunicatorService communicator, SaveService saveService, Configuration config) - : ModOptionEditor(communicator, saveService, config), IService -{ - protected override CombiningModGroup CreateGroup(Mod mod, string newName, ModPriority priority, SaveType saveType = SaveType.ImmediateSync) - => new(mod) - { - Name = newName, - Priority = priority, - }; - - protected override CombiningSubMod? CloneOption(CombiningModGroup group, IModOption option) - => throw new NotImplementedException(); - - protected override void RemoveOption(CombiningModGroup group, int optionIndex) - { - if (group.OptionData.RemoveWithPowerSet(group.Data, optionIndex)) - group.DefaultSettings.RemoveBit(optionIndex); - } - - protected override bool MoveOption(CombiningModGroup group, int optionIdxFrom, int optionIdxTo) - { - if (!group.OptionData.MoveWithPowerSet(group.Data, ref optionIdxFrom, ref optionIdxTo)) - return false; - - group.DefaultSettings.MoveBit(optionIdxFrom, optionIdxTo); - return true; - } - - public void SetDisplayName(CombinedDataContainer container, string name, SaveType saveType = SaveType.Queue) - { - if (container.Name == name) - return; - - container.Name = name; - SaveService.Save(saveType, new ModSaveGroup(container.Group, Config.ReplaceNonAsciiOnImport)); - Communicator.ModOptionChanged.Invoke(ModOptionChangeType.DisplayChange, container.Group.Mod, container.Group, null, null, -1); - } -} diff --git a/Penumbra/Mods/Manager/OptionEditor/ImcAttributeCache.cs b/Penumbra/Mods/Manager/OptionEditor/ImcAttributeCache.cs index 12ed4c60..e1235c5b 100644 --- a/Penumbra/Mods/Manager/OptionEditor/ImcAttributeCache.cs +++ b/Penumbra/Mods/Manager/OptionEditor/ImcAttributeCache.cs @@ -1,4 +1,4 @@ -using OtterGui.Extensions; +using OtterGui; using Penumbra.GameData.Structs; using Penumbra.Mods.Groups; using Penumbra.Mods.SubMods; @@ -21,14 +21,23 @@ public unsafe ref struct ImcAttributeCache _option[i] = byte.MaxValue; var flag = (ushort)(1 << i); + var set = (group.DefaultEntry.AttributeMask & flag) != 0; + if (set) + { + _canChange[i] = true; + _option[i] = byte.MaxValue - 1; + continue; + } + foreach (var (option, idx) in group.OptionData.WithIndex()) { - if ((option.AttributeMask & flag) == 0) - continue; - - _canChange[i] = option.AttributeMask != flag; - _option[i] = (byte)idx; - break; + set = (option.AttributeMask & flag) != 0; + if (set) + { + _canChange[i] = option.AttributeMask != flag; + _option[i] = (byte)idx; + break; + } } if (_option[i] == byte.MaxValue && LowestUnsetMask is 0) @@ -56,16 +65,25 @@ public unsafe ref struct ImcAttributeCache return true; } + if (!_canChange[idx]) + return false; + var mask = (ushort)(oldMask | flag); if (oldMask == mask) return false; group.DefaultEntry = group.DefaultEntry with { AttributeMask = mask }; + if (_option[idx] <= ImcEntry.NumAttributes) + { + var option = group.OptionData[_option[idx]]; + option.AttributeMask = (ushort)(option.AttributeMask & ~flag); + } + return true; } /// Set an attribute flag to a value if possible, remove it from its prior option or the default entry if necessary, and return if anything changed. - public readonly bool Set(ImcSubMod option, int idx, bool value, bool turnOffDefault = false) + public readonly bool Set(ImcSubMod option, int idx, bool value) { if (!_canChange[idx]) return false; @@ -92,7 +110,7 @@ public unsafe ref struct ImcAttributeCache var oldOption = option.Group.OptionData[_option[idx]]; oldOption.AttributeMask = (ushort)(oldOption.AttributeMask & ~flag); } - else if (turnOffDefault && _option[idx] is byte.MaxValue - 1) + else if (_option[idx] is byte.MaxValue - 1) { option.Group.DefaultEntry = option.Group.DefaultEntry with { diff --git a/Penumbra/Mods/Manager/OptionEditor/ImcModGroupEditor.cs b/Penumbra/Mods/Manager/OptionEditor/ImcModGroupEditor.cs index f8760625..f9fd532f 100644 --- a/Penumbra/Mods/Manager/OptionEditor/ImcModGroupEditor.cs +++ b/Penumbra/Mods/Manager/OptionEditor/ImcModGroupEditor.cs @@ -14,8 +14,7 @@ public sealed class ImcModGroupEditor(CommunicatorService communicator, SaveServ : ModOptionEditor(communicator, saveService, config), IService { /// Add a new, empty imc group with the given manipulation data. - public ImcModGroup? AddModGroup(Mod mod, string newName, ImcIdentifier identifier, ImcEntry defaultEntry, - SaveType saveType = SaveType.ImmediateSync) + public ImcModGroup? AddModGroup(Mod mod, string newName, ImcIdentifier identifier, ImcEntry defaultEntry, SaveType saveType = SaveType.ImmediateSync) { if (!ModGroupEditor.VerifyFileName(mod, null, newName, true)) return null; @@ -79,26 +78,6 @@ public sealed class ImcModGroupEditor(CommunicatorService communicator, SaveServ Communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionMetaChanged, option.Mod, option.Group, option, null, -1); } - public void ChangeAllVariants(ImcModGroup group, bool allVariants, SaveType saveType = SaveType.Queue) - { - if (group.AllVariants == allVariants) - return; - - group.AllVariants = allVariants; - SaveService.Save(saveType, new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); - Communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionMetaChanged, group.Mod, group, null, null, -1); - } - - public void ChangeOnlyAttributes(ImcModGroup group, bool onlyAttributes, SaveType saveType = SaveType.Queue) - { - if (group.OnlyAttributes == onlyAttributes) - return; - - group.OnlyAttributes = onlyAttributes; - SaveService.Save(saveType, new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); - Communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionMetaChanged, group.Mod, group, null, null, -1); - } - public void ChangeCanBeDisabled(ImcModGroup group, bool canBeDisabled, SaveType saveType = SaveType.Queue) { if (group.CanBeDisabled == canBeDisabled) @@ -138,7 +117,7 @@ public sealed class ImcModGroupEditor(CommunicatorService communicator, SaveServ protected override bool MoveOption(ImcModGroup group, int optionIdxFrom, int optionIdxTo) { - if (!group.OptionData.Move(ref optionIdxFrom, ref optionIdxTo)) + if (!group.OptionData.Move(optionIdxFrom, optionIdxTo)) return false; group.DefaultSettings = group.DefaultSettings.MoveBit(optionIdxFrom, optionIdxTo); diff --git a/Penumbra/Mods/Manager/OptionEditor/ModGroupEditor.cs b/Penumbra/Mods/Manager/OptionEditor/ModGroupEditor.cs index 1c077c58..e1db0ccf 100644 --- a/Penumbra/Mods/Manager/OptionEditor/ModGroupEditor.cs +++ b/Penumbra/Mods/Manager/OptionEditor/ModGroupEditor.cs @@ -1,4 +1,4 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using OtterGui.Classes; using OtterGui.Filesystem; using OtterGui.Services; @@ -37,10 +37,9 @@ public class ModGroupEditor( SingleModGroupEditor singleEditor, MultiModGroupEditor multiEditor, ImcModGroupEditor imcEditor, - CombiningModGroupEditor combiningEditor, CommunicatorService communicator, SaveService saveService, - Configuration config) : IService + Configuration Config) : IService { public SingleModGroupEditor SingleEditor => singleEditor; @@ -51,9 +50,6 @@ public class ModGroupEditor( public ImcModGroupEditor ImcEditor => imcEditor; - public CombiningModGroupEditor CombiningEditor - => combiningEditor; - /// Change the settings stored as default options in a mod. public void ChangeModGroupDefaultOption(IModGroup group, Setting defaultOption) { @@ -61,7 +57,7 @@ public class ModGroupEditor( return; group.DefaultSettings = defaultOption; - saveService.QueueSave(new ModSaveGroup(group, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.DefaultOptionChanged, group.Mod, group, null, null, -1); } @@ -72,9 +68,9 @@ public class ModGroupEditor( if (oldName == newName || !VerifyFileName(group.Mod, group, newName, true)) return; - saveService.ImmediateDelete(new ModSaveGroup(group, config.ReplaceNonAsciiOnImport)); + saveService.ImmediateDelete(new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); group.Name = newName; - saveService.ImmediateSave(new ModSaveGroup(group, config.ReplaceNonAsciiOnImport)); + saveService.ImmediateSave(new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.GroupRenamed, group.Mod, group, null, null, -1); } @@ -85,7 +81,7 @@ public class ModGroupEditor( var idx = group.GetIndex(); communicator.ModOptionChanged.Invoke(ModOptionChangeType.PrepareChange, mod, group, null, null, -1); mod.Groups.RemoveAt(idx); - saveService.SaveAllOptionGroups(mod, false, config.ReplaceNonAsciiOnImport); + saveService.SaveAllOptionGroups(mod, false, Config.ReplaceNonAsciiOnImport); communicator.ModOptionChanged.Invoke(ModOptionChangeType.GroupDeleted, mod, null, null, null, idx); } @@ -94,10 +90,10 @@ public class ModGroupEditor( { var mod = group.Mod; var idxFrom = group.GetIndex(); - if (!mod.Groups.Move(ref idxFrom, ref groupIdxTo)) + if (!mod.Groups.Move(idxFrom, groupIdxTo)) return; - saveService.SaveAllOptionGroups(mod, false, config.ReplaceNonAsciiOnImport); + saveService.SaveAllOptionGroups(mod, false, Config.ReplaceNonAsciiOnImport); communicator.ModOptionChanged.Invoke(ModOptionChangeType.GroupMoved, mod, group, null, null, idxFrom); } @@ -108,7 +104,7 @@ public class ModGroupEditor( return; group.Priority = newPriority; - saveService.QueueSave(new ModSaveGroup(group, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.PriorityChanged, group.Mod, group, null, null, -1); } @@ -119,7 +115,7 @@ public class ModGroupEditor( return; group.Description = newDescription; - saveService.QueueSave(new ModSaveGroup(group, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.DisplayChange, group.Mod, group, null, null, -1); } @@ -130,7 +126,7 @@ public class ModGroupEditor( return; option.Name = newName; - saveService.QueueSave(new ModSaveGroup(option.Group, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(option.Group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.DisplayChange, option.Mod, option.Group, option, null, -1); } @@ -141,19 +137,20 @@ public class ModGroupEditor( return; option.Description = newDescription; - saveService.QueueSave(new ModSaveGroup(option.Group, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(option.Group, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.DisplayChange, option.Mod, option.Group, option, null, -1); } /// Set the meta manipulations for a given option. Replaces existing manipulations. - public void SetManipulations(IModDataContainer subMod, MetaDictionary manipulations, SaveType saveType = SaveType.Queue) + public void SetManipulations(IModDataContainer subMod, HashSet manipulations, SaveType saveType = SaveType.Queue) { - if (subMod.Manipulations.Equals(manipulations)) + if (subMod.Manipulations.Count == manipulations.Count + && subMod.Manipulations.All(m => manipulations.TryGetValue(m, out var old) && old.EntryEquals(m))) return; communicator.ModOptionChanged.Invoke(ModOptionChangeType.PrepareChange, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); subMod.Manipulations.SetTo(manipulations); - saveService.Save(saveType, new ModSaveGroup(subMod, config.ReplaceNonAsciiOnImport)); + saveService.Save(saveType, new ModSaveGroup(subMod, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionMetaChanged, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); } @@ -165,14 +162,10 @@ public class ModGroupEditor( communicator.ModOptionChanged.Invoke(ModOptionChangeType.PrepareChange, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); subMod.Files.SetTo(replacements); - saveService.Save(saveType, new ModSaveGroup(subMod, config.ReplaceNonAsciiOnImport)); + saveService.Save(saveType, new ModSaveGroup(subMod, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionFilesChanged, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); } - /// Forces a file save of the given container's group. - public void ForceSave(IModDataContainer subMod, SaveType saveType = SaveType.Queue) - => saveService.Save(saveType, new ModSaveGroup(subMod, config.ReplaceNonAsciiOnImport)); - /// Add additional file redirections to a given option, keeping already existing ones. Only fires an event if anything is actually added. public void AddFiles(IModDataContainer subMod, IReadOnlyDictionary additions) { @@ -180,7 +173,7 @@ public class ModGroupEditor( subMod.Files.AddFrom(additions); if (oldCount != subMod.Files.Count) { - saveService.QueueSave(new ModSaveGroup(subMod, config.ReplaceNonAsciiOnImport)); + saveService.QueueSave(new ModSaveGroup(subMod, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionFilesAdded, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); } } @@ -193,7 +186,7 @@ public class ModGroupEditor( communicator.ModOptionChanged.Invoke(ModOptionChangeType.PrepareChange, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); subMod.FileSwaps.SetTo(swaps); - saveService.Save(saveType, new ModSaveGroup(subMod, config.ReplaceNonAsciiOnImport)); + saveService.Save(saveType, new ModSaveGroup(subMod, Config.ReplaceNonAsciiOnImport)); communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionSwapsChanged, (Mod)subMod.Mod, subMod.Group, null, subMod, -1); } @@ -227,60 +220,52 @@ public class ModGroupEditor( case ImcSubMod i: ImcEditor.DeleteOption(i); return; - case CombiningSubMod c: - CombiningEditor.DeleteOption(c); - return; } } public IModOption? AddOption(IModGroup group, IModOption option) => group switch { - SingleModGroup s => SingleEditor.AddOption(s, option), - MultiModGroup m => MultiEditor.AddOption(m, option), - ImcModGroup i => ImcEditor.AddOption(i, option), - CombiningModGroup c => CombiningEditor.AddOption(c, option), - _ => null, + SingleModGroup s => SingleEditor.AddOption(s, option), + MultiModGroup m => MultiEditor.AddOption(m, option), + ImcModGroup i => ImcEditor.AddOption(i, option), + _ => null, }; public IModOption? AddOption(IModGroup group, string newName) => group switch { - SingleModGroup s => SingleEditor.AddOption(s, newName), - MultiModGroup m => MultiEditor.AddOption(m, newName), - ImcModGroup i => ImcEditor.AddOption(i, newName), - CombiningModGroup c => CombiningEditor.AddOption(c, newName), - _ => null, + SingleModGroup s => SingleEditor.AddOption(s, newName), + MultiModGroup m => MultiEditor.AddOption(m, newName), + ImcModGroup i => ImcEditor.AddOption(i, newName), + _ => null, }; public IModGroup? AddModGroup(Mod mod, GroupType type, string newName, SaveType saveType = SaveType.ImmediateSync) => type switch { - GroupType.Single => SingleEditor.AddModGroup(mod, newName, saveType), - GroupType.Multi => MultiEditor.AddModGroup(mod, newName, saveType), - GroupType.Imc => ImcEditor.AddModGroup(mod, newName, default, default, saveType), - GroupType.Combining => CombiningEditor.AddModGroup(mod, newName, saveType), - _ => null, + GroupType.Single => SingleEditor.AddModGroup(mod, newName, saveType), + GroupType.Multi => MultiEditor.AddModGroup(mod, newName, saveType), + GroupType.Imc => ImcEditor.AddModGroup(mod, newName, default, default, saveType), + _ => null, }; public (IModGroup?, int, bool) FindOrAddModGroup(Mod mod, GroupType type, string name, SaveType saveType = SaveType.ImmediateSync) => type switch { - GroupType.Single => SingleEditor.FindOrAddModGroup(mod, name, saveType), - GroupType.Multi => MultiEditor.FindOrAddModGroup(mod, name, saveType), - GroupType.Imc => ImcEditor.FindOrAddModGroup(mod, name, saveType), - GroupType.Combining => CombiningEditor.FindOrAddModGroup(mod, name, saveType), - _ => (null, -1, false), + GroupType.Single => SingleEditor.FindOrAddModGroup(mod, name, saveType), + GroupType.Multi => MultiEditor.FindOrAddModGroup(mod, name, saveType), + GroupType.Imc => ImcEditor.FindOrAddModGroup(mod, name, saveType), + _ => (null, -1, false), }; public (IModOption?, int, bool) FindOrAddOption(IModGroup group, string name, SaveType saveType = SaveType.ImmediateSync) => group switch { - SingleModGroup s => SingleEditor.FindOrAddOption(s, name, saveType), - MultiModGroup m => MultiEditor.FindOrAddOption(m, name, saveType), - ImcModGroup i => ImcEditor.FindOrAddOption(i, name, saveType), - CombiningModGroup c => CombiningEditor.FindOrAddOption(c, name, saveType), - _ => (null, -1, false), + SingleModGroup s => SingleEditor.FindOrAddOption(s, name, saveType), + MultiModGroup m => MultiEditor.FindOrAddOption(m, name, saveType), + ImcModGroup i => ImcEditor.FindOrAddOption(i, name, saveType), + _ => (null, -1, false), }; public void MoveOption(IModOption option, int toIdx) @@ -296,9 +281,6 @@ public class ModGroupEditor( case ImcSubMod i: ImcEditor.MoveOption(i, toIdx); return; - case CombiningSubMod c: - CombiningEditor.MoveOption(c, toIdx); - return; } } } diff --git a/Penumbra/Mods/Manager/OptionEditor/ModOptionEditor.cs b/Penumbra/Mods/Manager/OptionEditor/ModOptionEditor.cs index d9d672e3..c067102e 100644 --- a/Penumbra/Mods/Manager/OptionEditor/ModOptionEditor.cs +++ b/Penumbra/Mods/Manager/OptionEditor/ModOptionEditor.cs @@ -1,5 +1,5 @@ +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using Penumbra.Mods.Groups; using Penumbra.Mods.Settings; using Penumbra.Mods.SubMods; @@ -15,8 +15,8 @@ public abstract class ModOptionEditor( where TOption : class, IModOption { protected readonly CommunicatorService Communicator = communicator; - protected readonly SaveService SaveService = saveService; - protected readonly Configuration Config = config; + protected readonly SaveService SaveService = saveService; + protected readonly Configuration Config = config; /// Add a new, empty option group of the given type and name. public TGroup? AddModGroup(Mod mod, string newName, SaveType saveType = SaveType.ImmediateSync) @@ -25,7 +25,7 @@ public abstract class ModOptionEditor( return null; var maxPriority = mod.Groups.Count == 0 ? ModPriority.Default : mod.Groups.Max(o => o.Priority) + 1; - var group = CreateGroup(mod, newName, maxPriority); + var group = CreateGroup(mod, newName, maxPriority); mod.Groups.Add(group); SaveService.Save(saveType, new ModSaveGroup(group, Config.ReplaceNonAsciiOnImport)); Communicator.ModOptionChanged.Invoke(ModOptionChangeType.GroupAdded, mod, group, null, null, -1); @@ -92,8 +92,8 @@ public abstract class ModOptionEditor( /// Delete the given option from the given group. public void DeleteOption(TOption option) { - var mod = option.Mod; - var group = option.Group; + var mod = option.Mod; + var group = option.Group; var optionIdx = option.GetIndex(); Communicator.ModOptionChanged.Invoke(ModOptionChangeType.PrepareChange, mod, group, option, null, -1); RemoveOption((TGroup)group, optionIdx); @@ -104,7 +104,7 @@ public abstract class ModOptionEditor( /// Move an option inside the given option group. public void MoveOption(TOption option, int optionIdxTo) { - var idx = option.GetIndex(); + var idx = option.GetIndex(); var group = (TGroup)option.Group; if (!MoveOption(group, idx, optionIdxTo)) return; @@ -113,10 +113,10 @@ public abstract class ModOptionEditor( Communicator.ModOptionChanged.Invoke(ModOptionChangeType.OptionMoved, group.Mod, group, option, null, idx); } - protected abstract TGroup CreateGroup(Mod mod, string newName, ModPriority priority, SaveType saveType = SaveType.ImmediateSync); + protected abstract TGroup CreateGroup(Mod mod, string newName, ModPriority priority, SaveType saveType = SaveType.ImmediateSync); protected abstract TOption? CloneOption(TGroup group, IModOption option); - protected abstract void RemoveOption(TGroup group, int optionIndex); - protected abstract bool MoveOption(TGroup group, int optionIdxFrom, int optionIdxTo); + protected abstract void RemoveOption(TGroup group, int optionIndex); + protected abstract bool MoveOption(TGroup group, int optionIdxFrom, int optionIdxTo); } public static class ModOptionChangeTypeExtension @@ -132,22 +132,22 @@ public static class ModOptionChangeTypeExtension { (requiresSaving, requiresReloading, wasPrepared) = type switch { - ModOptionChangeType.GroupRenamed => (true, false, false), - ModOptionChangeType.GroupAdded => (true, false, false), - ModOptionChangeType.GroupDeleted => (true, true, false), - ModOptionChangeType.GroupMoved => (true, false, false), - ModOptionChangeType.GroupTypeChanged => (true, true, true), - ModOptionChangeType.PriorityChanged => (true, true, true), - ModOptionChangeType.OptionAdded => (true, true, true), - ModOptionChangeType.OptionDeleted => (true, true, false), - ModOptionChangeType.OptionMoved => (true, false, false), - ModOptionChangeType.OptionFilesChanged => (false, true, false), - ModOptionChangeType.OptionFilesAdded => (false, true, true), - ModOptionChangeType.OptionSwapsChanged => (false, true, false), - ModOptionChangeType.OptionMetaChanged => (false, true, false), - ModOptionChangeType.DisplayChange => (false, false, false), + ModOptionChangeType.GroupRenamed => (true, false, false), + ModOptionChangeType.GroupAdded => (true, false, false), + ModOptionChangeType.GroupDeleted => (true, true, false), + ModOptionChangeType.GroupMoved => (true, false, false), + ModOptionChangeType.GroupTypeChanged => (true, true, true), + ModOptionChangeType.PriorityChanged => (true, true, true), + ModOptionChangeType.OptionAdded => (true, true, true), + ModOptionChangeType.OptionDeleted => (true, true, false), + ModOptionChangeType.OptionMoved => (true, false, false), + ModOptionChangeType.OptionFilesChanged => (false, true, false), + ModOptionChangeType.OptionFilesAdded => (false, true, true), + ModOptionChangeType.OptionSwapsChanged => (false, true, false), + ModOptionChangeType.OptionMetaChanged => (false, true, false), + ModOptionChangeType.DisplayChange => (false, false, false), ModOptionChangeType.DefaultOptionChanged => (true, false, false), - _ => (false, false, false), + _ => (false, false, false), }; } } diff --git a/Penumbra/Mods/Manager/OptionEditor/MultiModGroupEditor.cs b/Penumbra/Mods/Manager/OptionEditor/MultiModGroupEditor.cs index 2446ae80..74362325 100644 --- a/Penumbra/Mods/Manager/OptionEditor/MultiModGroupEditor.cs +++ b/Penumbra/Mods/Manager/OptionEditor/MultiModGroupEditor.cs @@ -75,7 +75,7 @@ public sealed class MultiModGroupEditor(CommunicatorService communicator, SaveSe protected override bool MoveOption(MultiModGroup group, int optionIdxFrom, int optionIdxTo) { - if (!group.OptionData.Move(ref optionIdxFrom, ref optionIdxTo)) + if (!group.OptionData.Move(optionIdxFrom, optionIdxTo)) return false; group.DefaultSettings = group.DefaultSettings.MoveBit(optionIdxFrom, optionIdxTo); diff --git a/Penumbra/Mods/Manager/OptionEditor/SingleModGroupEditor.cs b/Penumbra/Mods/Manager/OptionEditor/SingleModGroupEditor.cs index 5fd785cf..15a899a0 100644 --- a/Penumbra/Mods/Manager/OptionEditor/SingleModGroupEditor.cs +++ b/Penumbra/Mods/Manager/OptionEditor/SingleModGroupEditor.cs @@ -48,7 +48,7 @@ public sealed class SingleModGroupEditor(CommunicatorService communicator, SaveS protected override bool MoveOption(SingleModGroup group, int optionIdxFrom, int optionIdxTo) { - if (!group.OptionData.Move(ref optionIdxFrom, ref optionIdxTo)) + if (!group.OptionData.Move(optionIdxFrom, optionIdxTo)) return false; group.DefaultSettings = group.DefaultSettings.MoveSingle(optionIdxFrom, optionIdxTo); diff --git a/Penumbra/Mods/Mod.cs b/Penumbra/Mods/Mod.cs index e262e8f1..783ef3e6 100644 --- a/Penumbra/Mods/Mod.cs +++ b/Penumbra/Mods/Mod.cs @@ -1,7 +1,5 @@ +using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; -using Penumbra.GameData.Data; -using Penumbra.GameData.Structs; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; @@ -11,16 +9,6 @@ using Penumbra.String.Classes; namespace Penumbra.Mods; -[Flags] -public enum FeatureFlags : ulong -{ - None = 0, - Atch = 1ul << 0, - Shp = 1ul << 1, - Atr = 1ul << 2, - Invalid = 1ul << 62, -} - public sealed class Mod : IMod { public static readonly TemporaryMod ForcedFiles = new() @@ -58,53 +46,33 @@ public sealed class Mod : IMod => Name.Text; // Meta Data - public LowerString Name { get; internal set; } = "New Mod"; - public LowerString Author { get; internal set; } = LowerString.Empty; - public string Description { get; internal set; } = string.Empty; - public string Version { get; internal set; } = string.Empty; - public string Website { get; internal set; } = string.Empty; - public string Image { get; internal set; } = string.Empty; - public IReadOnlyList ModTags { get; internal set; } = []; - public HashSet DefaultPreferredItems { get; internal set; } = []; - public FeatureFlags RequiredFeatures { get; internal set; } = 0; + public LowerString Name { get; internal set; } = "New Mod"; + public LowerString Author { get; internal set; } = LowerString.Empty; + public string Description { get; internal set; } = string.Empty; + public string Version { get; internal set; } = string.Empty; + public string Website { get; internal set; } = string.Empty; + public IReadOnlyList ModTags { get; internal set; } = []; // Local Data - public long ImportDate { get; internal set; } = DateTimeOffset.UnixEpoch.ToUnixTimeMilliseconds(); - public IReadOnlyList LocalTags { get; internal set; } = []; - public string Note { get; internal set; } = string.Empty; - public HashSet PreferredChangedItems { get; internal set; } = []; - public bool Favorite { get; internal set; } = false; + public long ImportDate { get; internal set; } = DateTimeOffset.UnixEpoch.ToUnixTimeMilliseconds(); + public IReadOnlyList LocalTags { get; internal set; } = []; + public string Note { get; internal set; } = string.Empty; + public bool Favorite { get; internal set; } = false; + // Options public readonly DefaultSubMod Default; public readonly List Groups = []; - /// Compute the required feature flags for this mod. - public FeatureFlags ComputeRequiredFeatures() - { - var flags = FeatureFlags.None; - foreach (var option in AllDataContainers) - { - if (option.Manipulations.Atch.Count > 0) - flags |= FeatureFlags.Atch; - if (option.Manipulations.Atr.Count > 0) - flags |= FeatureFlags.Atr; - if (option.Manipulations.Shp.Count > 0) - flags |= FeatureFlags.Shp; - } - - return flags; - } - public AppliedModData GetData(ModSettings? settings = null) { if (settings is not { Enabled: true }) return AppliedModData.Empty; var dictRedirections = new Dictionary(TotalFileCount); - var setManips = new MetaDictionary(); - foreach (var (group, groupIndex) in Groups.WithIndex().Reverse().OrderByDescending(g => g.Value.Priority)) + var setManips = new HashSet(TotalManipulations); + foreach (var (group, groupIndex) in Groups.WithIndex().OrderByDescending(g => g.Value.Priority)) { var config = settings.Settings[groupIndex]; group.AddData(config, dictRedirections, setManips); @@ -131,14 +99,13 @@ public sealed class Mod : IMod } // Cache - public readonly SortedList ChangedItems = new(); + public readonly SortedList ChangedItems = new(); public string LowerChangedItemsString { get; internal set; } = string.Empty; public string AllTagsLower { get; internal set; } = string.Empty; - public int TotalFileCount { get; internal set; } - public int TotalSwapCount { get; internal set; } - public int TotalManipulations { get; internal set; } - public ushort LastChangedItemsUpdate { get; internal set; } - public bool HasOptions { get; internal set; } + public int TotalFileCount { get; internal set; } + public int TotalSwapCount { get; internal set; } + public int TotalManipulations { get; internal set; } + public bool HasOptions { get; internal set; } } diff --git a/Penumbra/Mods/ModCreator.cs b/Penumbra/Mods/ModCreator.cs index 3a7bd105..ed4245c4 100644 --- a/Penumbra/Mods/ModCreator.cs +++ b/Penumbra/Mods/ModCreator.cs @@ -1,17 +1,14 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Newtonsoft.Json; using Newtonsoft.Json.Linq; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Filesystem; -using OtterGui.Services; using Penumbra.Api.Enums; using Penumbra.GameData.Data; using Penumbra.Import; using Penumbra.Import.Structs; using Penumbra.Meta; -using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; using Penumbra.Mods.Manager; using Penumbra.Mods.Settings; @@ -22,22 +19,21 @@ using Penumbra.String.Classes; namespace Penumbra.Mods; public partial class ModCreator( - SaveService saveService, + SaveService _saveService, Configuration config, - ModDataEditor dataEditor, - MetaFileManager metaFileManager, - GamePathParser gamePathParser) : IService + ModDataEditor _dataEditor, + MetaFileManager _metaFileManager, + GamePathParser _gamePathParser) { - public const FeatureFlags SupportedFeatures = FeatureFlags.Atch | FeatureFlags.Shp | FeatureFlags.Atr; - public readonly Configuration Config = config; + public readonly Configuration Config = config; /// Creates directory and files necessary for a new mod without adding it to the manager. - public DirectoryInfo? CreateEmptyMod(DirectoryInfo basePath, string newName, string description = "", string? author = null, params string[] tags) + public DirectoryInfo? CreateEmptyMod(DirectoryInfo basePath, string newName, string description = "") { try { var newDir = CreateModFolder(basePath, newName, Config.ReplaceNonAsciiOnImport, true); - dataEditor.CreateMeta(newDir, newName, author ?? Config.DefaultModAuthor, description, "1.0", string.Empty, tags); + _dataEditor.CreateMeta(newDir, newName, Config.DefaultModAuthor, description, "1.0", string.Empty); CreateDefaultFiles(newDir); return newDir; } @@ -49,7 +45,7 @@ public partial class ModCreator( } /// Load a mod by its directory. - public Mod? LoadMod(DirectoryInfo modPath, bool incorporateMetaChanges, bool deleteDefaultMetaChanges) + public Mod? LoadMod(DirectoryInfo modPath, bool incorporateMetaChanges) { modPath.Refresh(); if (!modPath.Exists) @@ -59,7 +55,7 @@ public partial class ModCreator( } var mod = new Mod(modPath); - if (ReloadMod(mod, incorporateMetaChanges, deleteDefaultMetaChanges, out _)) + if (ReloadMod(mod, incorporateMetaChanges, out _)) return mod; // Can not be base path not existing because that is checked before. @@ -68,23 +64,21 @@ public partial class ModCreator( } /// Reload a mod from its mod path. - public bool ReloadMod(Mod mod, bool incorporateMetaChanges, bool deleteDefaultMetaChanges, out ModDataChangeType modDataChange) + public bool ReloadMod(Mod mod, bool incorporateMetaChanges, out ModDataChangeType modDataChange) { modDataChange = ModDataChangeType.Deletion; if (!Directory.Exists(mod.ModPath.FullName)) return false; - modDataChange = ModMeta.Load(dataEditor, this, mod); - if (modDataChange.HasFlag(ModDataChangeType.Deletion) || mod.Name.Length == 0 || mod.RequiredFeatures is FeatureFlags.Invalid) + modDataChange = _dataEditor.LoadMeta(this, mod); + if (modDataChange.HasFlag(ModDataChangeType.Deletion) || mod.Name.Length == 0) return false; - modDataChange |= ModLocalData.Load(dataEditor, mod); + _dataEditor.LoadLocalData(mod); LoadDefaultOption(mod); LoadAllGroups(mod); if (incorporateMetaChanges) - IncorporateAllMetaChanges(mod, true, deleteDefaultMetaChanges); - else if (deleteDefaultMetaChanges) - ModMetaEditor.DeleteDefaultValues(mod, metaFileManager, saveService, false); + IncorporateAllMetaChanges(mod, true); return true; } @@ -94,13 +88,13 @@ public partial class ModCreator( { mod.Groups.Clear(); var changes = false; - foreach (var file in saveService.FileNames.GetOptionGroupFiles(mod)) + foreach (var file in _saveService.FileNames.GetOptionGroupFiles(mod)) { var group = LoadModGroup(mod, file); if (group != null && mod.Groups.All(g => g.Name != group.Name)) { changes = changes - || saveService.FileNames.OptionGroupFile(mod.ModPath.FullName, mod.Groups.Count, group.Name, true) + || _saveService.FileNames.OptionGroupFile(mod.ModPath.FullName, mod.Groups.Count, group.Name, true) != Path.Combine(file.DirectoryName!, ReplaceBadXivSymbols(file.Name, true)); mod.Groups.Add(group); } @@ -111,13 +105,13 @@ public partial class ModCreator( } if (changes) - saveService.SaveAllOptionGroups(mod, true, Config.ReplaceNonAsciiOnImport); + _saveService.SaveAllOptionGroups(mod, true, Config.ReplaceNonAsciiOnImport); } /// Load the default option for a given mod. public void LoadDefaultOption(Mod mod) { - var defaultFile = saveService.FileNames.OptionGroupFile(mod, -1, Config.ReplaceNonAsciiOnImport); + var defaultFile = _saveService.FileNames.OptionGroupFile(mod, -1, Config.ReplaceNonAsciiOnImport); try { var jObject = File.Exists(defaultFile) ? JObject.Parse(File.ReadAllText(defaultFile)) : new JObject(); @@ -156,10 +150,10 @@ public partial class ModCreator( /// Convert all .meta and .rgsp files to their respective meta changes and add them to their options. /// Deletes the source files if delete is true. /// - public void IncorporateAllMetaChanges(Mod mod, bool delete, bool removeDefaultValues) + public void IncorporateAllMetaChanges(Mod mod, bool delete) { var changes = false; - List deleteList = []; + List deleteList = new(); foreach (var subMod in mod.AllDataContainers) { var (localChanges, localDeleteList) = IncorporateMetaChanges(subMod, mod.ModPath, false); @@ -169,14 +163,12 @@ public partial class ModCreator( } DeleteDeleteList(deleteList, delete); - if (removeDefaultValues && !Config.KeepDefaultMetaChanges) - changes |= ModMetaEditor.DeleteDefaultValues(mod, metaFileManager, null, false); if (!changes) return; - saveService.SaveAllOptionGroups(mod, false, Config.ReplaceNonAsciiOnImport); - saveService.ImmediateSaveSync(new ModSaveGroup(mod.ModPath, mod.Default, Config.ReplaceNonAsciiOnImport)); + _saveService.SaveAllOptionGroups(mod, false, Config.ReplaceNonAsciiOnImport); + _saveService.ImmediateSaveSync(new ModSaveGroup(mod.ModPath, mod.Default, Config.ReplaceNonAsciiOnImport)); } @@ -201,7 +193,8 @@ public partial class ModCreator( if (!file.Exists) continue; - var meta = new TexToolsMeta(gamePathParser, File.ReadAllBytes(file.FullName)); + var meta = new TexToolsMeta(_metaFileManager, _gamePathParser, File.ReadAllBytes(file.FullName), + Config.KeepDefaultMetaChanges); Penumbra.Log.Verbose( $"Incorporating {file} as Metadata file of {meta.MetaManipulations.Count} manipulations {deleteString}"); deleteList.Add(file.FullName); @@ -213,7 +206,8 @@ public partial class ModCreator( if (!file.Exists) continue; - var rgsp = TexToolsMeta.FromRgspFile(metaFileManager, file.FullName, File.ReadAllBytes(file.FullName)); + var rgsp = TexToolsMeta.FromRgspFile(_metaFileManager, file.FullName, File.ReadAllBytes(file.FullName), + Config.KeepDefaultMetaChanges); Penumbra.Log.Verbose( $"Incorporating {file} as racial scaling file of {rgsp.MetaManipulations.Count} manipulations {deleteString}"); deleteList.Add(file.FullName); @@ -228,8 +222,7 @@ public partial class ModCreator( } DeleteDeleteList(deleteList, delete); - var changes = oldSize < option.Manipulations.Count; - return (changes, deleteList); + return (oldSize < option.Manipulations.Count, deleteList); } /// @@ -256,7 +249,7 @@ public partial class ModCreator( group.Priority = priority; group.DefaultSettings = defaultSettings; group.OptionData.AddRange(subMods.Select(s => s.Clone(group))); - saveService.ImmediateSaveSync(ModSaveGroup.WithoutMod(baseFolder, group, index, Config.ReplaceNonAsciiOnImport)); + _saveService.ImmediateSaveSync(ModSaveGroup.WithoutMod(baseFolder, group, index, Config.ReplaceNonAsciiOnImport)); break; } case GroupType.Single: @@ -266,7 +259,7 @@ public partial class ModCreator( group.Priority = priority; group.DefaultSettings = defaultSettings; group.OptionData.AddRange(subMods.Select(s => s.ConvertToSingle(group))); - saveService.ImmediateSaveSync(ModSaveGroup.WithoutMod(baseFolder, group, index, Config.ReplaceNonAsciiOnImport)); + _saveService.ImmediateSaveSync(ModSaveGroup.WithoutMod(baseFolder, group, index, Config.ReplaceNonAsciiOnImport)); break; } } @@ -276,7 +269,7 @@ public partial class ModCreator( public MultiSubMod CreateSubMod(DirectoryInfo baseFolder, DirectoryInfo optionFolder, OptionList option, ModPriority priority) { var list = optionFolder.EnumerateNonHiddenFiles() - .Select(f => (Utf8GamePath.FromFile(f, optionFolder, out var gamePath), gamePath, new FullPath(f))) + .Select(f => (Utf8GamePath.FromFile(f, optionFolder, out var gamePath, true), gamePath, new FullPath(f))) .Where(t => t.Item1); var mod = MultiSubMod.WithoutGroup(option.Name, option.Description, priority); @@ -284,7 +277,6 @@ public partial class ModCreator( mod.Files.TryAdd(gamePath, file); IncorporateMetaChanges(mod, baseFolder, true); - return mod; } @@ -295,15 +287,15 @@ public partial class ModCreator( internal void CreateDefaultFiles(DirectoryInfo directory) { var mod = new Mod(directory); - ReloadMod(mod, false, false, out _); + ReloadMod(mod, false, out _); foreach (var file in mod.FindUnusedFiles()) { - if (Utf8GamePath.FromFile(new FileInfo(file.FullName), directory, out var gamePath)) + if (Utf8GamePath.FromFile(new FileInfo(file.FullName), directory, out var gamePath, true)) mod.Default.Files.TryAdd(gamePath, file); } IncorporateMetaChanges(mod.Default, directory, true); - saveService.ImmediateSaveSync(new ModSaveGroup(mod.ModPath, mod.Default, Config.ReplaceNonAsciiOnImport)); + _saveService.ImmediateSaveSync(new ModSaveGroup(mod.ModPath, mod.Default, Config.ReplaceNonAsciiOnImport)); } /// Return the name of a new valid directory based on the base directory and the given name. @@ -340,7 +332,7 @@ public partial class ModCreator( { var mod = new Mod(baseDir); - var files = saveService.FileNames.GetOptionGroupFiles(mod).ToList(); + var files = _saveService.FileNames.GetOptionGroupFiles(mod).ToList(); var idx = 0; var reorder = false; foreach (var groupFile in files) @@ -440,10 +432,9 @@ public partial class ModCreator( var json = JObject.Parse(File.ReadAllText(file.FullName)); switch (json[nameof(Type)]?.ToObject() ?? GroupType.Single) { - case GroupType.Multi: return MultiModGroup.Load(mod, json); - case GroupType.Single: return SingleModGroup.Load(mod, json); - case GroupType.Imc: return ImcModGroup.Load(mod, json); - case GroupType.Combining: return CombiningModGroup.Load(mod, json); + case GroupType.Multi: return MultiModGroup.Load(mod, json); + case GroupType.Single: return SingleModGroup.Load(mod, json); + case GroupType.Imc: return ImcModGroup.Load(mod, json); } } catch (Exception e) diff --git a/Penumbra/Mods/ModLocalData.cs b/Penumbra/Mods/ModLocalData.cs index cc20fad6..beda0dc7 100644 --- a/Penumbra/Mods/ModLocalData.cs +++ b/Penumbra/Mods/ModLocalData.cs @@ -1,6 +1,5 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; -using Penumbra.GameData.Structs; using Penumbra.Mods.Manager; using Penumbra.Services; @@ -22,83 +21,12 @@ public readonly struct ModLocalData(Mod mod) : ISavable { nameof(Mod.LocalTags), JToken.FromObject(mod.LocalTags) }, { nameof(Mod.Note), JToken.FromObject(mod.Note) }, { nameof(Mod.Favorite), JToken.FromObject(mod.Favorite) }, - { nameof(Mod.PreferredChangedItems), JToken.FromObject(mod.PreferredChangedItems) }, }; using var jWriter = new JsonTextWriter(writer); jWriter.Formatting = Formatting.Indented; jObject.WriteTo(jWriter); } - public static ModDataChangeType Load(ModDataEditor editor, Mod mod) - { - var dataFile = editor.SaveService.FileNames.LocalDataFile(mod); - - var importDate = 0L; - var localTags = Enumerable.Empty(); - var favorite = false; - var note = string.Empty; - - HashSet preferredChangedItems = []; - - var save = true; - if (File.Exists(dataFile)) - try - { - var text = File.ReadAllText(dataFile); - var json = JObject.Parse(text); - - importDate = json[nameof(Mod.ImportDate)]?.Value() ?? importDate; - favorite = json[nameof(Mod.Favorite)]?.Value() ?? favorite; - note = json[nameof(Mod.Note)]?.Value() ?? note; - localTags = (json[nameof(Mod.LocalTags)] as JArray)?.Values().OfType() ?? localTags; - preferredChangedItems = (json[nameof(Mod.PreferredChangedItems)] as JArray)?.Values().Select(i => (CustomItemId) i).ToHashSet() ?? mod.DefaultPreferredItems; - save = false; - } - catch (Exception e) - { - Penumbra.Log.Error($"Could not load local mod data:\n{e}"); - } - else - { - preferredChangedItems = mod.DefaultPreferredItems; - } - - if (importDate == 0) - importDate = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); - - ModDataChangeType changes = 0; - if (mod.ImportDate != importDate) - { - mod.ImportDate = importDate; - changes |= ModDataChangeType.ImportDate; - } - - changes |= UpdateTags(mod, null, localTags); - - if (mod.Favorite != favorite) - { - mod.Favorite = favorite; - changes |= ModDataChangeType.Favorite; - } - - if (mod.Note != note) - { - mod.Note = note; - changes |= ModDataChangeType.Note; - } - - if (!preferredChangedItems.SetEquals(mod.PreferredChangedItems)) - { - mod.PreferredChangedItems = preferredChangedItems; - changes |= ModDataChangeType.PreferredChangedItems; - } - - if (save) - editor.SaveService.QueueSave(new ModLocalData(mod)); - - return changes; - } - internal static ModDataChangeType UpdateTags(Mod mod, IEnumerable? newModTags, IEnumerable? newLocalTags) { if (newModTags == null && newLocalTags == null) diff --git a/Penumbra/Mods/ModMeta.cs b/Penumbra/Mods/ModMeta.cs index b52eecf4..870d6d4f 100644 --- a/Penumbra/Mods/ModMeta.cs +++ b/Penumbra/Mods/ModMeta.cs @@ -1,7 +1,5 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; -using Penumbra.GameData.Structs; -using Penumbra.Mods.Manager; using Penumbra.Services; namespace Penumbra.Mods; @@ -21,125 +19,12 @@ public readonly struct ModMeta(Mod mod) : ISavable { nameof(Mod.Name), JToken.FromObject(mod.Name) }, { nameof(Mod.Author), JToken.FromObject(mod.Author) }, { nameof(Mod.Description), JToken.FromObject(mod.Description) }, - { nameof(Mod.Image), JToken.FromObject(mod.Image) }, { nameof(Mod.Version), JToken.FromObject(mod.Version) }, { nameof(Mod.Website), JToken.FromObject(mod.Website) }, { nameof(Mod.ModTags), JToken.FromObject(mod.ModTags) }, - { nameof(Mod.DefaultPreferredItems), JToken.FromObject(mod.DefaultPreferredItems) }, }; - if (mod.RequiredFeatures is not FeatureFlags.None) - { - var features = mod.RequiredFeatures; - var array = new JArray(); - foreach (var flag in Enum.GetValues()) - { - if ((features & flag) is not FeatureFlags.None) - array.Add(flag.ToString()); - } - - jObject[nameof(Mod.RequiredFeatures)] = array; - } - using var jWriter = new JsonTextWriter(writer); jWriter.Formatting = Formatting.Indented; jObject.WriteTo(jWriter); } - - public static ModDataChangeType Load(ModDataEditor editor, ModCreator creator, Mod mod) - { - var metaFile = editor.SaveService.FileNames.ModMetaPath(mod); - if (!File.Exists(metaFile)) - { - Penumbra.Log.Debug($"No mod meta found for {mod.ModPath.Name}."); - return ModDataChangeType.Deletion; - } - - try - { - var text = File.ReadAllText(metaFile); - var json = JObject.Parse(text); - - var newFileVersion = json[nameof(FileVersion)]?.Value() ?? 0; - - // Empty name gets checked after loading and is not allowed. - var newName = json[nameof(Mod.Name)]?.Value() ?? string.Empty; - - var newAuthor = json[nameof(Mod.Author)]?.Value() ?? string.Empty; - var newDescription = json[nameof(Mod.Description)]?.Value() ?? string.Empty; - var newImage = json[nameof(Mod.Image)]?.Value() ?? string.Empty; - var newVersion = json[nameof(Mod.Version)]?.Value() ?? string.Empty; - var newWebsite = json[nameof(Mod.Website)]?.Value() ?? string.Empty; - var modTags = (json[nameof(Mod.ModTags)] as JArray)?.Values().OfType(); - var defaultItems = (json[nameof(Mod.DefaultPreferredItems)] as JArray)?.Values().Select(i => (CustomItemId)i).ToHashSet() - ?? []; - var requiredFeatureArray = (json[nameof(Mod.RequiredFeatures)] as JArray)?.Values() ?? []; - var requiredFeatures = FeatureChecker.ParseFlags(mod.ModPath.Name, newName.Length > 0 ? newName : mod.Name.Length > 0 ? mod.Name : "Unknown", requiredFeatureArray!); - - ModDataChangeType changes = 0; - if (mod.Name != newName) - { - changes |= ModDataChangeType.Name; - mod.Name = newName; - } - - if (mod.Author != newAuthor) - { - changes |= ModDataChangeType.Author; - mod.Author = newAuthor; - } - - if (mod.Description != newDescription) - { - changes |= ModDataChangeType.Description; - mod.Description = newDescription; - } - - if (mod.Image != newImage) - { - changes |= ModDataChangeType.Image; - mod.Image = newImage; - } - - if (mod.Version != newVersion) - { - changes |= ModDataChangeType.Version; - mod.Version = newVersion; - } - - if (mod.Website != newWebsite) - { - changes |= ModDataChangeType.Website; - mod.Website = newWebsite; - } - - if (!mod.DefaultPreferredItems.SetEquals(defaultItems)) - { - changes |= ModDataChangeType.DefaultChangedItems; - mod.DefaultPreferredItems = defaultItems; - } - - if (newFileVersion != FileVersion) - if (ModMigration.Migrate(creator, editor.SaveService, mod, json, ref newFileVersion)) - { - changes |= ModDataChangeType.Migration; - editor.SaveService.ImmediateSave(new ModMeta(mod)); - } - - // Required features get checked during parsing, in which case the new required features signal invalid. - if (requiredFeatures != mod.RequiredFeatures) - { - changes |= ModDataChangeType.RequiredFeatures; - mod.RequiredFeatures = requiredFeatures; - } - - changes |= ModLocalData.UpdateTags(mod, modTags, null); - - return changes; - } - catch (Exception e) - { - Penumbra.Log.Error($"Could not load mod meta for {metaFile}:\n{e}"); - return ModDataChangeType.Deletion; - } - } } diff --git a/Penumbra/Mods/ModSelection.cs b/Penumbra/Mods/ModSelection.cs deleted file mode 100644 index b728bd00..00000000 --- a/Penumbra/Mods/ModSelection.cs +++ /dev/null @@ -1,108 +0,0 @@ -using OtterGui.Classes; -using Penumbra.Api.Enums; -using Penumbra.Collections; -using Penumbra.Collections.Manager; -using Penumbra.Communication; -using Penumbra.Mods.Manager; -using Penumbra.Mods.Settings; -using Penumbra.Services; - -namespace Penumbra.Mods; - -/// -/// Triggered whenever the selected mod changes -/// -/// Parameter is the old selected mod. -/// Parameter is the new selected mod -/// -/// -public class ModSelection : EventWrapper -{ - private readonly ActiveCollections _collections; - private readonly EphemeralConfig _config; - private readonly CommunicatorService _communicator; - - public ModSelection(CommunicatorService communicator, ModManager mods, ActiveCollections collections, EphemeralConfig config) - : base(nameof(ModSelection)) - { - _communicator = communicator; - _collections = collections; - _config = config; - if (_config.LastModPath.Length > 0) - SelectMod(mods.FirstOrDefault(m => string.Equals(m.Identifier, config.LastModPath, StringComparison.OrdinalIgnoreCase))); - - _communicator.CollectionChange.Subscribe(OnCollectionChange, CollectionChange.Priority.ModSelection); - _communicator.CollectionInheritanceChanged.Subscribe(OnInheritanceChange, CollectionInheritanceChanged.Priority.ModSelection); - _communicator.ModSettingChanged.Subscribe(OnSettingChange, ModSettingChanged.Priority.ModSelection); - } - - public ModSettings Settings { get; private set; } = ModSettings.Empty; - public ModCollection Collection { get; private set; } = ModCollection.Empty; - public Mod? Mod { get; private set; } - public ModSettings? OwnSettings { get; private set; } - public TemporaryModSettings? TemporarySettings { get; private set; } - - public void SelectMod(Mod? mod) - { - if (mod == Mod) - return; - - var oldMod = Mod; - Mod = mod; - OnCollectionChange(CollectionType.Current, null, _collections.Current, string.Empty); - Invoke(oldMod, Mod); - _config.LastModPath = mod?.ModPath.Name ?? string.Empty; - _config.Save(); - } - - protected override void Dispose(bool _) - { - _communicator.CollectionChange.Unsubscribe(OnCollectionChange); - _communicator.CollectionInheritanceChanged.Unsubscribe(OnInheritanceChange); - _communicator.ModSettingChanged.Unsubscribe(OnSettingChange); - } - - private void OnCollectionChange(CollectionType type, ModCollection? oldCollection, ModCollection? newCollection, string _2) - { - if (type is CollectionType.Current && oldCollection != newCollection) - UpdateSettings(); - } - - private void OnSettingChange(ModCollection collection, ModSettingChange _1, Mod? mod, Setting _2, int _3, bool _4) - { - if (collection == _collections.Current && mod == Mod) - UpdateSettings(); - } - - private void OnInheritanceChange(ModCollection collection, bool arg2) - { - if (collection == _collections.Current) - UpdateSettings(); - } - - private void UpdateSettings() - { - if (Mod == null) - { - Settings = ModSettings.Empty; - Collection = ModCollection.Empty; - OwnSettings = null; - } - else - { - (var settings, Collection) = _collections.Current.GetActualSettings(Mod.Index); - OwnSettings = _collections.Current.GetOwnSettings(Mod.Index); - TemporarySettings = _collections.Current.GetTempSettings(Mod.Index); - Settings = settings ?? ModSettings.Empty; - } - } - - public enum Priority - { - /// - ModPanel = 0, - - /// - ModMerger = 0, - } -} diff --git a/Penumbra/Mods/Settings/FullModSettings.cs b/Penumbra/Mods/Settings/FullModSettings.cs deleted file mode 100644 index 904b56bd..00000000 --- a/Penumbra/Mods/Settings/FullModSettings.cs +++ /dev/null @@ -1,19 +0,0 @@ -namespace Penumbra.Mods.Settings; - -public readonly record struct FullModSettings(ModSettings? Settings = null, TemporaryModSettings? TempSettings = null) -{ - public static readonly FullModSettings Empty = new(); - - public ModSettings? Resolve() - { - if (TempSettings == null) - return Settings; - if (TempSettings.ForceInherit) - return null; - - return TempSettings; - } - - public FullModSettings DeepCopy() - => new(Settings?.DeepCopy()); -} diff --git a/Penumbra/Mods/Settings/ModPriority.cs b/Penumbra/Mods/Settings/ModPriority.cs index cf234c00..993bd577 100644 --- a/Penumbra/Mods/Settings/ModPriority.cs +++ b/Penumbra/Mods/Settings/ModPriority.cs @@ -66,10 +66,4 @@ public readonly record struct ModPriority(int Value) : public int CompareTo(ModPriority other) => Value.CompareTo(other.Value); - - public const int HiddenMin = -84037; - public const int HiddenMax = HiddenMin + 1000; - - public bool IsHidden - => Value is > HiddenMin and < HiddenMax; } diff --git a/Penumbra/Mods/Settings/ModSettings.cs b/Penumbra/Mods/Settings/ModSettings.cs index bbdd6bfa..7fe48365 100644 --- a/Penumbra/Mods/Settings/ModSettings.cs +++ b/Penumbra/Mods/Settings/ModSettings.cs @@ -1,4 +1,4 @@ -using OtterGui.Extensions; +using OtterGui; using OtterGui.Filesystem; using Penumbra.Api.Enums; using Penumbra.Mods.Editor; @@ -11,18 +11,10 @@ namespace Penumbra.Mods.Settings; /// Contains the settings for a given mod. public class ModSettings { - public static readonly ModSettings Empty = new(true); - - public SettingList Settings { get; internal init; } = []; - public ModPriority Priority { get; set; } - public bool Enabled { get; set; } - public bool IsEmpty { get; protected init; } - - public ModSettings() - { } - - protected ModSettings(bool empty) - => IsEmpty = empty; + public static readonly ModSettings Empty = new(); + public SettingList Settings { get; private init; } = []; + public ModPriority Priority { get; set; } + public bool Enabled { get; set; } // Create an independent copy of the current settings. public ModSettings DeepCopy() @@ -193,10 +185,10 @@ public class ModSettings switch (mod.Groups[idx]) { - case { Behaviour: GroupDrawBehaviour.SingleSelection } single when setting.Value < (ulong)single.Options.Count: + case SingleModGroup single when setting.Value < (ulong)single.Options.Count: dict.Add(single.Name, [single.Options[setting.AsIndex].Name]); break; - case { Behaviour: GroupDrawBehaviour.MultiSelection } multi: + case MultiModGroup multi: var list = multi.Options.WithIndex().Where(p => setting.HasFlag(p.Index)).Select(p => p.Value.Name).ToList(); dict.Add(multi.Name, list); break; diff --git a/Penumbra/Mods/Settings/Setting.cs b/Penumbra/Mods/Settings/Setting.cs index e8ad103c..059cbf51 100644 --- a/Penumbra/Mods/Settings/Setting.cs +++ b/Penumbra/Mods/Settings/Setting.cs @@ -85,24 +85,6 @@ public readonly record struct Setting(ulong Value) public override Setting ReadJson(JsonReader reader, Type objectType, Setting existingValue, bool hasExistingValue, JsonSerializer serializer) - { - try - { - return new Setting(serializer.Deserialize(reader)); - } - catch (Exception e) - { - Penumbra.Log.Warning($"Could not deserialize setting {reader.Value} to unsigned long:\n{e}"); - try - { - return new Setting((ulong)serializer.Deserialize(reader)); - } - catch - { - Penumbra.Log.Warning($"Could not deserialize setting {reader.Value} to long:\n{e}"); - return Zero; - } - } - } + => new(serializer.Deserialize(reader)); } } diff --git a/Penumbra/Mods/Settings/TemporaryModSettings.cs b/Penumbra/Mods/Settings/TemporaryModSettings.cs deleted file mode 100644 index d3e36ef6..00000000 --- a/Penumbra/Mods/Settings/TemporaryModSettings.cs +++ /dev/null @@ -1,54 +0,0 @@ -namespace Penumbra.Mods.Settings; - -public sealed class TemporaryModSettings : ModSettings -{ - public new static readonly TemporaryModSettings Empty = new(true); - - public const string OwnSource = "yourself"; - public string Source = string.Empty; - public int Lock; - public bool ForceInherit; - - // Create default settings for a given mod. - public static TemporaryModSettings DefaultSettings(Mod mod, string source, bool enabled = false, int key = 0) - => new() - { - Enabled = enabled, - Source = source, - Lock = key, - Priority = ModPriority.Default, - Settings = SettingList.Default(mod), - }; - - public TemporaryModSettings() - { } - - private TemporaryModSettings(bool empty) - : base(empty) - { } - - public TemporaryModSettings(Mod mod, ModSettings? clone, string source = OwnSource, int key = 0) - { - Source = source; - Lock = key; - ForceInherit = clone == null; - if (clone is { IsEmpty: false }) - { - Enabled = clone.Enabled; - Priority = clone.Priority; - Settings = clone.Settings.Clone(); - } - else - { - Enabled = false; - Priority = ModPriority.Default; - Settings = SettingList.Default(mod); - } - } -} - -public static class ModSettingsExtensions -{ - public static bool IsTemporary(this ModSettings? settings) - => settings is TemporaryModSettings; -} diff --git a/Penumbra/Mods/SubMods/CombinedDataContainer.cs b/Penumbra/Mods/SubMods/CombinedDataContainer.cs deleted file mode 100644 index bfca2afd..00000000 --- a/Penumbra/Mods/SubMods/CombinedDataContainer.cs +++ /dev/null @@ -1,91 +0,0 @@ -using Newtonsoft.Json.Linq; -using OtterGui.Extensions; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.Mods.Groups; -using Penumbra.String.Classes; - -namespace Penumbra.Mods.SubMods; - -public class CombinedDataContainer(IModGroup group) : IModDataContainer -{ - public IMod Mod - => Group.Mod; - - public IModGroup Group { get; } = group; - - public string Name { get; set; } = string.Empty; - public Dictionary Files { get; set; } = []; - public Dictionary FileSwaps { get; set; } = []; - public MetaDictionary Manipulations { get; set; } = new(); - - public void AddDataTo(Dictionary redirections, MetaDictionary manipulations) - => SubMod.AddContainerTo(this, redirections, manipulations); - - public string GetName() - { - if (Name.Length > 0) - return Name; - - var index = GetDataIndex(); - if (index == 0) - return "None"; - - var sb = new StringBuilder(128); - for (var i = 0; i < IModGroup.MaxCombiningOptions; ++i) - { - if ((index & 1) != 0) - { - sb.Append(Group.Options[i].Name); - sb.Append(' ').Append('+').Append(' '); - } - - index >>= 1; - if (index == 0) - break; - } - - return sb.ToString(0, sb.Length - 3); - } - - public unsafe string GetDirectoryName() - { - if (Name.Length > 0) - return Name; - - var index = GetDataIndex(); - if (index == 0) - return "None"; - - var text = stackalloc char[IModGroup.MaxCombiningOptions].Slice(0, Group.Options.Count); - for (var i = 0; i < Group.Options.Count; ++i) - { - text[Group.Options.Count - 1 - i] = (index & 1) is 0 ? '0' : '1'; - index >>= 1; - } - - return new string(text); - } - - public string GetFullName() - => $"{Group.Name}: {GetName()}"; - - public (int GroupIndex, int DataIndex) GetDataIndices() - => (Group.GetIndex(), GetDataIndex()); - - private int GetDataIndex() - { - var dataIndex = Group.DataContainers.IndexOf(this); - if (dataIndex < 0) - throw new Exception($"Group {Group.Name} from SubMod {Name} does not contain this SubMod."); - - return dataIndex; - } - - public CombinedDataContainer(CombiningModGroup group, JToken token) - : this(group) - { - SubMod.LoadDataContainer(token, this, group.Mod.ModPath); - Name = token["Name"]?.ToObject() ?? string.Empty; - } -} diff --git a/Penumbra/Mods/SubMods/CombiningSubMod.cs b/Penumbra/Mods/SubMods/CombiningSubMod.cs deleted file mode 100644 index 6eb5de9d..00000000 --- a/Penumbra/Mods/SubMods/CombiningSubMod.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Newtonsoft.Json.Linq; -using Penumbra.Mods.Groups; - -namespace Penumbra.Mods.SubMods; - -public class CombiningSubMod(IModGroup group) : IModOption -{ - public IModGroup Group { get; } = group; - - public Mod Mod - => Group.Mod; - - public string Name { get; set; } = "Option"; - public string Description { get; set; } = string.Empty; - - public string FullName - => $"{Group.Name}: {Name}"; - - public int GetIndex() - => SubMod.GetIndex(this); - - public CombiningSubMod(CombiningModGroup group, JToken json) - : this(group) - => SubMod.LoadOptionData(json, this); -} diff --git a/Penumbra/Mods/SubMods/ComplexDataContainer.cs b/Penumbra/Mods/SubMods/ComplexDataContainer.cs deleted file mode 100644 index 0f0fdef8..00000000 --- a/Penumbra/Mods/SubMods/ComplexDataContainer.cs +++ /dev/null @@ -1,46 +0,0 @@ -using Newtonsoft.Json.Linq; -using OtterGui.Extensions; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.Mods.Groups; -using Penumbra.String.Classes; - -namespace Penumbra.Mods.SubMods; - -public sealed class ComplexDataContainer(ComplexModGroup group) : IModDataContainer -{ - public IMod Mod - => Group.Mod; - - public IModGroup Group { get; } = group; - - public Dictionary Files { get; set; } = []; - public Dictionary FileSwaps { get; set; } = []; - public MetaDictionary Manipulations { get; set; } = new(); - - public MaskedSetting Association = MaskedSetting.Zero; - - public string Name { get; set; } = string.Empty; - - public string GetName() - => Name.Length > 0 ? Name : $"Container {Group.DataContainers.IndexOf(this)}"; - - public string GetDirectoryName() - => Name.Length > 0 ? Name : $"{Group.DataContainers.IndexOf(this)}"; - - public string GetFullName() - => $"{Group.Name}: {GetName()}"; - - public (int GroupIndex, int DataIndex) GetDataIndices() - => (Group.GetIndex(), Group.DataContainers.IndexOf(this)); - - public ComplexDataContainer(ComplexModGroup group, JToken json) - : this(group) - { - SubMod.LoadDataContainer(json, this, group.Mod.ModPath); - var mask = json["AssociationMask"]?.ToObject() ?? 0; - var value = json["AssociationMask"]?.ToObject() ?? 0; - Association = new MaskedSetting(mask, value); - Name = json["Name"]?.ToObject() ?? string.Empty; - } -} diff --git a/Penumbra/Mods/SubMods/ComplexSubMod.cs b/Penumbra/Mods/SubMods/ComplexSubMod.cs deleted file mode 100644 index 7c189170..00000000 --- a/Penumbra/Mods/SubMods/ComplexSubMod.cs +++ /dev/null @@ -1,37 +0,0 @@ -using Newtonsoft.Json.Linq; -using OtterGui.Extensions; -using Penumbra.Mods.Groups; - -namespace Penumbra.Mods.SubMods; - -public sealed class ComplexSubMod(ComplexModGroup group) : IModOption -{ - public Mod Mod - => group.Mod; - - public IModGroup Group { get; } = group; - public string Name { get; set; } = "Option"; - - public string FullName - => $"{Group.Name}: {Name}"; - - public MaskedSetting Conditions = MaskedSetting.Zero; - public int Indentation = 0; - public string SubGroupLabel = string.Empty; - - public string Description { get; set; } = string.Empty; - - public int GetIndex() - => Group.Options.IndexOf(this); - - public ComplexSubMod(ComplexModGroup group, JToken json) - : this(group) - { - SubMod.LoadOptionData(json, this); - var mask = json["ConditionMask"]?.ToObject() ?? 0; - var value = json["ConditionMask"]?.ToObject() ?? 0; - Conditions = new MaskedSetting(mask, value); - Indentation = json["Indentation"]?.ToObject() ?? 0; - SubGroupLabel = json["SubGroup"]?.ToObject() ?? string.Empty; - } -} diff --git a/Penumbra/Mods/SubMods/DefaultSubMod.cs b/Penumbra/Mods/SubMods/DefaultSubMod.cs index 3282f518..1a234879 100644 --- a/Penumbra/Mods/SubMods/DefaultSubMod.cs +++ b/Penumbra/Mods/SubMods/DefaultSubMod.cs @@ -13,7 +13,7 @@ public class DefaultSubMod(IMod mod) : IModDataContainer public Dictionary Files { get; set; } = []; public Dictionary FileSwaps { get; set; } = []; - public MetaDictionary Manipulations { get; set; } = new(); + public HashSet Manipulations { get; set; } = []; IMod IModDataContainer.Mod => Mod; @@ -21,15 +21,12 @@ public class DefaultSubMod(IMod mod) : IModDataContainer IModGroup? IModDataContainer.Group => null; - public void AddTo(Dictionary redirections, MetaDictionary manipulations) + public void AddTo(Dictionary redirections, HashSet manipulations) => SubMod.AddContainerTo(this, redirections, manipulations); public string GetName() => FullName; - public string GetDirectoryName() - => GetName(); - public string GetFullName() => FullName; diff --git a/Penumbra/Mods/SubMods/IModDataContainer.cs b/Penumbra/Mods/SubMods/IModDataContainer.cs index 92ccf7e1..7f7ef4a6 100644 --- a/Penumbra/Mods/SubMods/IModDataContainer.cs +++ b/Penumbra/Mods/SubMods/IModDataContainer.cs @@ -10,12 +10,11 @@ public interface IModDataContainer public IMod Mod { get; } public IModGroup? Group { get; } - public Dictionary Files { get; set; } - public Dictionary FileSwaps { get; set; } - public MetaDictionary Manipulations { get; set; } + public Dictionary Files { get; set; } + public Dictionary FileSwaps { get; set; } + public HashSet Manipulations { get; set; } public string GetName(); - public string GetDirectoryName(); public string GetFullName(); public (int GroupIndex, int DataIndex) GetDataIndices(); } diff --git a/Penumbra/Mods/SubMods/MaskedSetting.cs b/Penumbra/Mods/SubMods/MaskedSetting.cs deleted file mode 100644 index 75bb46c2..00000000 --- a/Penumbra/Mods/SubMods/MaskedSetting.cs +++ /dev/null @@ -1,27 +0,0 @@ -using Penumbra.Mods.Groups; -using Penumbra.Mods.Settings; - -namespace Penumbra.Mods.SubMods; - -public readonly struct MaskedSetting(Setting mask, Setting value) -{ - public const int MaxSettings = IModGroup.MaxMultiOptions; - public static readonly MaskedSetting Zero = new(Setting.Zero, Setting.Zero); - public static readonly MaskedSetting FullMask = new(Setting.AllBits(IModGroup.MaxComplexOptions), Setting.Zero); - - public readonly Setting Mask = mask; - public readonly Setting Value = new(value.Value & mask.Value); - - public MaskedSetting(ulong mask, ulong value) - : this(new Setting(mask), new Setting(value)) - { } - - public MaskedSetting Limit(int numOptions) - => new(Mask.Value & Setting.AllBits(numOptions).Value, Value.Value); - - public bool IsZero - => Mask.Value is 0; - - public bool IsEnabled(Setting input) - => (input.Value & Mask.Value) == Value.Value; -} diff --git a/Penumbra/Mods/SubMods/OptionSubMod.cs b/Penumbra/Mods/SubMods/OptionSubMod.cs index aa3fed8f..02d86af2 100644 --- a/Penumbra/Mods/SubMods/OptionSubMod.cs +++ b/Penumbra/Mods/SubMods/OptionSubMod.cs @@ -1,4 +1,4 @@ -using OtterGui.Extensions; +using OtterGui; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; @@ -33,17 +33,14 @@ public abstract class OptionSubMod(IModGroup group) : IModOption, IModDataContai public Dictionary Files { get; set; } = []; public Dictionary FileSwaps { get; set; } = []; - public MetaDictionary Manipulations { get; set; } = new(); + public HashSet Manipulations { get; set; } = []; - public void AddDataTo(Dictionary redirections, MetaDictionary manipulations) + public void AddDataTo(Dictionary redirections, HashSet manipulations) => SubMod.AddContainerTo(this, redirections, manipulations); public string GetName() => Name; - public string GetDirectoryName() - => GetName(); - public string GetFullName() => FullName; diff --git a/Penumbra/Mods/SubMods/SubMod.cs b/Penumbra/Mods/SubMods/SubMod.cs index a7a2ee61..b984b570 100644 --- a/Penumbra/Mods/SubMods/SubMod.cs +++ b/Penumbra/Mods/SubMods/SubMod.cs @@ -1,6 +1,6 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; -using OtterGui.Extensions; +using OtterGui; using Penumbra.Meta.Manipulations; using Penumbra.String.Classes; @@ -21,7 +21,7 @@ public static class SubMod /// Add all unique meta manipulations, file redirections and then file swaps from a ModDataContainer to the given sets. Skip any keys that are already contained. [MethodImpl(MethodImplOptions.AggressiveOptimization | MethodImplOptions.AggressiveInlining)] public static void AddContainerTo(IModDataContainer container, Dictionary redirections, - MetaDictionary manipulations) + HashSet manipulations) { foreach (var (path, file) in container.Files) redirections.TryAdd(path, file); @@ -37,7 +37,7 @@ public static class SubMod { to.Files = new Dictionary(from.Files); to.FileSwaps = new Dictionary(from.FileSwaps); - to.Manipulations = from.Manipulations.Clone(); + to.Manipulations = [.. from.Manipulations]; } /// Load all file redirections, file swaps and meta manipulations from a JToken of that option into a data container. @@ -52,7 +52,7 @@ public static class SubMod if (files != null) foreach (var property in files.Properties()) { - if (Utf8GamePath.FromString(property.Name, out var p)) + if (Utf8GamePath.FromString(property.Name, out var p, true)) data.Files.TryAdd(p, new FullPath(basePath, property.Value.ToObject())); } @@ -60,13 +60,15 @@ public static class SubMod if (swaps != null) foreach (var property in swaps.Properties()) { - if (Utf8GamePath.FromString(property.Name, out var p)) + if (Utf8GamePath.FromString(property.Name, out var p, true)) data.FileSwaps.TryAdd(p, new FullPath(property.Value.ToObject()!)); } - var manips = json[nameof(data.Manipulations)]?.ToObject(); + var manips = json[nameof(data.Manipulations)]; if (manips != null) - data.Manipulations.UnionWith(manips); + foreach (var s in manips.Children().Select(c => c.ToObject()) + .Where(m => m.Validate())) + data.Manipulations.Add(s); } /// Load the relevant data for a selectable option from a JToken of that option. @@ -81,41 +83,29 @@ public static class SubMod [MethodImpl(MethodImplOptions.AggressiveOptimization | MethodImplOptions.AggressiveInlining)] public static void WriteModContainer(JsonWriter j, JsonSerializer serializer, IModDataContainer data, DirectoryInfo basePath) { - // #TODO: remove comments when TexTools updated. - //if (data.Files.Count > 0) - //{ - j.WritePropertyName(nameof(data.Files)); - j.WriteStartObject(); - foreach (var (gamePath, file) in data.Files) - { - if (file.ToRelPath(basePath, out var relPath)) - { - j.WritePropertyName(gamePath.ToString()); - j.WriteValue(relPath.ToString()); - } - } - - j.WriteEndObject(); - //} - - //if (data.FileSwaps.Count > 0) - //{ - j.WritePropertyName(nameof(data.FileSwaps)); - j.WriteStartObject(); - foreach (var (gamePath, file) in data.FileSwaps) + j.WritePropertyName(nameof(data.Files)); + j.WriteStartObject(); + foreach (var (gamePath, file) in data.Files) + { + if (file.ToRelPath(basePath, out var relPath)) { j.WritePropertyName(gamePath.ToString()); - j.WriteValue(file.ToString()); + j.WriteValue(relPath.ToString()); } + } - j.WriteEndObject(); - //} + j.WriteEndObject(); + j.WritePropertyName(nameof(data.FileSwaps)); + j.WriteStartObject(); + foreach (var (gamePath, file) in data.FileSwaps) + { + j.WritePropertyName(gamePath.ToString()); + j.WriteValue(file.ToString()); + } - //if (data.Manipulations.Count > 0) - //{ - j.WritePropertyName(nameof(data.Manipulations)); - serializer.Serialize(j, data.Manipulations); - //} + j.WriteEndObject(); + j.WritePropertyName(nameof(data.Manipulations)); + serializer.Serialize(j, data.Manipulations); } /// Write the data for a selectable mod option on a JsonWriter. diff --git a/Penumbra/Mods/TemporaryMod.cs b/Penumbra/Mods/TemporaryMod.cs index 8fdd09c5..d08c8b06 100644 --- a/Penumbra/Mods/TemporaryMod.cs +++ b/Penumbra/Mods/TemporaryMod.cs @@ -1,6 +1,5 @@ using OtterGui.Classes; using Penumbra.Collections; -using Penumbra.Interop.PathResolving; using Penumbra.Meta.Manipulations; using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; @@ -51,7 +50,13 @@ public class TemporaryMod : IMod public TemporaryMod() => Default = new DefaultSubMod(this); - public void SetAll(Dictionary dict, MetaDictionary manips) + public void SetFile(Utf8GamePath gamePath, FullPath fullPath) + => Default.Files[gamePath] = fullPath; + + public bool SetManipulation(MetaManipulation manip) + => Default.Manipulations.Remove(manip) | Default.Manipulations.Add(manip); + + public void SetAll(Dictionary dict, HashSet manips) { Default.Files = dict; Default.Manipulations = manips; @@ -63,10 +68,10 @@ public class TemporaryMod : IMod DirectoryInfo? dir = null; try { - dir = ModCreator.CreateModFolder(modManager.BasePath, collection.Identity.Name, config.ReplaceNonAsciiOnImport, true); + dir = ModCreator.CreateModFolder(modManager.BasePath, collection.Name, config.ReplaceNonAsciiOnImport, true); var fileDir = Directory.CreateDirectory(Path.Combine(dir.FullName, "files")); - modManager.DataEditor.CreateMeta(dir, collection.Identity.Name, character ?? config.DefaultModAuthor, - $"Mod generated from temporary collection {collection.Identity.Id} for {character ?? "Unknown Character"} with name {collection.Identity.Name}.", + modManager.DataEditor.CreateMeta(dir, collection.Name, character ?? config.DefaultModAuthor, + $"Mod generated from temporary collection {collection.Id} for {character ?? "Unknown Character"} with name {collection.Name}.", null, null); var mod = new Mod(dir); var defaultMod = mod.Default; @@ -78,8 +83,10 @@ public class TemporaryMod : IMod } var targetPath = fullPath.Path.FullName; - if (PathDataHandler.Split(fullPath.Path.FullName, out var actualPath, out _)) - targetPath = actualPath.ToString(); + if (fullPath.Path.Name.StartsWith('|')) + { + targetPath = targetPath.Split('|', 3, StringSplitOptions.RemoveEmptyEntries).Last(); + } if (Path.IsPathRooted(targetPath)) { @@ -93,17 +100,17 @@ public class TemporaryMod : IMod } } - var manips = new MetaDictionary(collection.MetaCache); - defaultMod.Manipulations.UnionWith(manips); + foreach (var manip in collection.MetaCache?.Manipulations ?? Array.Empty()) + defaultMod.Manipulations.Add(manip); - saveService.ImmediateSaveSync(new ModSaveGroup(dir, defaultMod, config.ReplaceNonAsciiOnImport)); - modManager.AddMod(dir, false); + saveService.ImmediateSave(new ModSaveGroup(dir, defaultMod, config.ReplaceNonAsciiOnImport)); + modManager.AddMod(dir); Penumbra.Log.Information( - $"Successfully generated mod {mod.Name} at {mod.ModPath.FullName} for collection {collection.Identity.Identifier}."); + $"Successfully generated mod {mod.Name} at {mod.ModPath.FullName} for collection {collection.Identifier}."); } catch (Exception e) { - Penumbra.Log.Error($"Could not save temporary collection {collection.Identity.Identifier} to permanent Mod:\n{e}"); + Penumbra.Log.Error($"Could not save temporary collection {collection.Identifier} to permanent Mod:\n{e}"); if (dir != null && Directory.Exists(dir.FullName)) { try diff --git a/Penumbra/Penumbra.cs b/Penumbra/Penumbra.cs index d433a0fb..42be0aa3 100644 --- a/Penumbra/Penumbra.cs +++ b/Penumbra/Penumbra.cs @@ -1,6 +1,6 @@ using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; -using Dalamud.Game; +using ImGuiNET; +using Lumina.Excel.GeneratedSheets; using OtterGui; using OtterGui.Log; using OtterGui.Services; @@ -8,6 +8,7 @@ using Penumbra.Api; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Cache; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.PathResolving; using Penumbra.Services; using Penumbra.Interop.Services; @@ -17,15 +18,10 @@ using Penumbra.UI.Tabs; using ChangedItemClick = Penumbra.Communication.ChangedItemClick; using ChangedItemHover = Penumbra.Communication.ChangedItemHover; using OtterGui.Tasks; +using Penumbra.GameData.Enums; using Penumbra.UI; +using IPenumbraApi = Penumbra.Api.Api.IPenumbraApi; using ResidentResourceManager = Penumbra.Interop.Services.ResidentResourceManager; -using Dalamud.Plugin.Services; -using Lumina.Excel.Sheets; -using Penumbra.GameData.Data; -using Penumbra.Interop; -using Penumbra.Interop.Hooks; -using Penumbra.Interop.Hooks.PostProcessing; -using Penumbra.Interop.Hooks.ResourceLoading; namespace Penumbra; @@ -36,7 +32,6 @@ public class Penumbra : IDalamudPlugin public static readonly Logger Log = new(); public static MessageService Messager { get; private set; } = null!; - public static DynamisIpc Dynamis { get; private set; } = null!; private readonly ValidityChecker _validityChecker; private readonly ResidentResourceManager _residentResources; @@ -48,22 +43,17 @@ public class Penumbra : IDalamudPlugin private readonly CharacterUtility _characterUtility; private readonly RedrawService _redrawService; private readonly CommunicatorService _communicatorService; - private readonly IDataManager _gameData; private PenumbraWindowSystem? _windowSystem; private bool _disposed; private readonly ServiceManager _services; - public Penumbra(IDalamudPluginInterface pluginInterface) + public Penumbra(DalamudPluginInterface pluginInterface) { try { - HookOverrides.Instance = HookOverrides.LoadFile(pluginInterface); - _services = StaticServiceManager.CreateProvider(this, pluginInterface, Log); - // Invoke the IPC Penumbra.Launching method before any hooks or other services are created. - _services.GetService(); + _services = StaticServiceManager.CreateProvider(this, pluginInterface, Log); Messager = _services.GetService(); - Dynamis = _services.GetService(); _validityChecker = _services.GetService(); _services.EnsureRequiredServices(); @@ -84,7 +74,6 @@ public class Penumbra : IDalamudPlugin _tempCollections = _services.GetService(); _redrawService = _services.GetService(); _communicatorService = _services.GetService(); - _gameData = _services.GetService(); _services.GetService(); // Initialize because not required anywhere else. _services.GetService(); // Initialize because not required anywhere else. _collectionManager.Caches.CreateNecessaryCaches(); @@ -118,17 +107,16 @@ public class Penumbra : IDalamudPlugin private void SetupApi() { _services.GetService(); - var itemSheet = _services.GetService().GetExcelSheet(); _communicatorService.ChangedItemHover.Subscribe(it => { - if (it is IdentifiedItem { Item.Id.IsItem: true }) + if (it is (Item, FullEquipType)) ImGui.TextUnformatted("Left Click to create an item link in chat."); }, ChangedItemHover.Priority.Link); _communicatorService.ChangedItemClick.Subscribe((button, it) => { - if (button == MouseButton.Left && it is IdentifiedItem item && itemSheet.GetRow(item.Item.ItemId.Id) is { } i) - Messager.LinkItem(i); + if (button == MouseButton.Left && it is (Item item, FullEquipType type)) + Messager.LinkItem(item); }, ChangedItemClick.Priority.Link); } @@ -157,6 +145,7 @@ public class Penumbra : IDalamudPlugin { if (_characterUtility.Ready) { + _collectionManager.Active.Default.SetFiles(_characterUtility); _residentResources.Reload(); _redrawService.RedrawAll(RedrawType.Redraw); } @@ -165,6 +154,7 @@ public class Penumbra : IDalamudPlugin { if (_characterUtility.Ready) { + _characterUtility.ResetAll(); _residentResources.Reload(); _redrawService.RedrawAll(RedrawType.Redraw); } @@ -188,34 +178,11 @@ public class Penumbra : IDalamudPlugin _disposed = true; } - private void GatherRelevantPlugins(StringBuilder sb) - { - ReadOnlySpan relevantPlugins = - [ - "Glamourer", "MareSynchronos", "CustomizePlus", "SimpleHeels", "VfxEditor", "heliosphere-plugin", "Ktisis", "Brio", "DynamicBridge", - "IllusioVitae", "Aetherment", "LoporritSync", "GagSpeak", "ProjectGagSpeak", "RoleplayingVoiceDalamud", "AQuestReborn", - ]; - var plugins = _services.GetService().InstalledPlugins - .GroupBy(p => p.InternalName) - .ToDictionary(g => g.Key, g => - { - var item = g.OrderByDescending(p => p.IsLoaded).ThenByDescending(p => p.Version).First(); - return (item.IsLoaded, item.Version, item.Name); - }); - foreach (var plugin in relevantPlugins) - { - if (plugins.TryGetValue(plugin, out var data)) - sb.Append($"> **`{data.Name + ':',-29}`** {data.Version}{(data.IsLoaded ? string.Empty : " (Disabled)")}\n"); - } - } - public string GatherSupportInformation() { - var sb = new StringBuilder(10240); - var exists = _config.ModDirectory.Length > 0 && Directory.Exists(_config.ModDirectory); - var cloudSynced = exists && CloudApi.IsCloudSynced(_config.ModDirectory); - var hdrEnabler = _services.GetService(); - var drive = exists ? new DriveInfo(new DirectoryInfo(_config.ModDirectory).Root.FullName) : null; + var sb = new StringBuilder(10240); + var exists = _config.ModDirectory.Length > 0 && Directory.Exists(_config.ModDirectory); + var drive = exists ? new DriveInfo(new DirectoryInfo(_config.ModDirectory).Root.FullName) : null; sb.AppendLine("**Settings**"); sb.Append($"> **`Plugin Version: `** {_validityChecker.Version}\n"); sb.Append($"> **`Commit Hash: `** {_validityChecker.CommitHash}\n"); @@ -224,25 +191,16 @@ public class Penumbra : IDalamudPlugin sb.Append($"> **`Operating System: `** {(Dalamud.Utility.Util.IsWine() ? "Mac/Linux (Wine)" : "Windows")}\n"); if (Dalamud.Utility.Util.IsWine()) sb.Append($"> **`Locale Environment Variables:`** {CollectLocaleEnvironmentVariables()}\n"); - sb.Append( - $"> **`Root Directory: `** `{_config.ModDirectory}`, {(exists ? "Exists" : "Not Existing")}{(cloudSynced ? ", Cloud-Synced" : "")}\n"); + sb.Append($"> **`Root Directory: `** `{_config.ModDirectory}`, {(exists ? "Exists" : "Not Existing")}\n"); sb.Append( $"> **`Free Drive Space: `** {(drive != null ? Functions.HumanReadableSize(drive.AvailableFreeSpace) : "Unknown")}\n"); - sb.Append($"> **`Game Data Files: `** {(_gameData.HasModifiedGameDataFiles ? "Modified" : "Pristine")}\n"); sb.Append($"> **`Auto-Deduplication: `** {_config.AutoDeduplicateOnImport}\n"); - sb.Append($"> **`Auto-UI-Reduplication: `** {_config.AutoReduplicateUiOnImport}\n"); sb.Append($"> **`Debug Mode: `** {_config.DebugMode}\n"); - sb.Append($"> **`Penumbra Reloads: `** {hdrEnabler.PenumbraReloadCount}\n"); sb.Append( - $"> **`HDR Enabled (from Start): `** {_config.HdrRenderTargets} ({hdrEnabler is { FirstLaunchHdrState: true, FirstLaunchHdrHookOverrideState: true }}){(hdrEnabler.HdrEnabledSuccess ? ", Detour Called" : ", **NEVER CALLED**")}\n"); - sb.Append($"> **`Custom Shapes Enabled: `** {_config.EnableCustomShapes}\n"); - sb.Append($"> **`Hook Overrides: `** {HookOverrides.Instance.IsCustomLoaded}\n"); - sb.Append( - $"> **`Synchronous Load (Dalamud): `** {(_services.GetService().GetDalamudConfig(DalamudConfigService.WaitingForPluginsOption, out bool v) ? v.ToString() : "Unknown")} (first Start: {hdrEnabler.FirstLaunchWaitForPluginsState?.ToString() ?? "Unknown"})\n"); + $"> **`Synchronous Load (Dalamud): `** {(_services.GetService().GetDalamudConfig(DalamudConfigService.WaitingForPluginsOption, out bool v) ? v.ToString() : "Unknown")}\n"); sb.Append( $"> **`Logging: `** Log: {_config.Ephemeral.EnableResourceLogging}, Watcher: {_config.Ephemeral.EnableResourceWatcher} ({_config.MaxResourceWatcherRecords})\n"); sb.Append($"> **`Use Ownership: `** {_config.UseOwnerNameForCharacterCollection}\n"); - GatherRelevantPlugins(sb); sb.AppendLine("**Mods**"); sb.Append($"> **`Installed Mods: `** {_modManager.Count}\n"); sb.Append($"> **`Mods with Config: `** {_modManager.Count(m => m.HasOptions)}\n"); @@ -257,25 +215,27 @@ public class Penumbra : IDalamudPlugin $"> **`#Temp Mods: `** {_tempMods.Mods.Sum(kvp => kvp.Value.Count) + _tempMods.ModsForAllCollections.Count}\n"); void PrintCollection(ModCollection c, CollectionCache _) - => sb.Append( - $"> **`Collection {c.Identity.AnonymizedName + ':',-18}`** Inheritances: `{c.Inheritance.DirectlyInheritsFrom.Count,3}`, Enabled Mods: `{c.ActualSettings.Count(s => s is { Enabled: true }),4}`, Conflicts: `{c.AllConflicts.SelectMany(x => x).Sum(x => x is { HasPriority: true, Solved: true } ? x.Conflicts.Count : 0),5}/{c.AllConflicts.SelectMany(x => x).Sum(x => x.HasPriority ? x.Conflicts.Count : 0),5}`\n"); + => sb.Append($"**Collection {c.AnonymizedName}**\n" + + $"> **`Inheritances: `** {c.DirectlyInheritsFrom.Count}\n" + + $"> **`Enabled Mods: `** {c.ActualSettings.Count(s => s is { Enabled: true })}\n" + + $"> **`Conflicts (Solved/Total): `** {c.AllConflicts.SelectMany(x => x).Sum(x => x.HasPriority && x.Solved ? x.Conflicts.Count : 0)}/{c.AllConflicts.SelectMany(x => x).Sum(x => x.HasPriority ? x.Conflicts.Count : 0)}\n"); sb.AppendLine("**Collections**"); - sb.Append($"> **`#Collections: `** {_collectionManager.Storage.Count - 1}\n"); - sb.Append($"> **`#Temp Collections: `** {_tempCollections.Count}\n"); - sb.Append($"> **`Active Collections: `** {_collectionManager.Caches.Count}\n"); - sb.Append($"> **`Base Collection: `** {_collectionManager.Active.Default.Identity.AnonymizedName}\n"); - sb.Append($"> **`Interface Collection: `** {_collectionManager.Active.Interface.Identity.AnonymizedName}\n"); - sb.Append($"> **`Selected Collection: `** {_collectionManager.Active.Current.Identity.AnonymizedName}\n"); + sb.Append($"> **`#Collections: `** {_collectionManager.Storage.Count - 1}\n"); + sb.Append($"> **`#Temp Collections: `** {_tempCollections.Count}\n"); + sb.Append($"> **`Active Collections: `** {_collectionManager.Caches.Count}\n"); + sb.Append($"> **`Base Collection: `** {_collectionManager.Active.Default.AnonymizedName}\n"); + sb.Append($"> **`Interface Collection: `** {_collectionManager.Active.Interface.AnonymizedName}\n"); + sb.Append($"> **`Selected Collection: `** {_collectionManager.Active.Current.AnonymizedName}\n"); foreach (var (type, name, _) in CollectionTypeExtensions.Special) { var collection = _collectionManager.Active.ByType(type); if (collection != null) - sb.Append($"> **`{name,-29}`** {collection.Identity.AnonymizedName}\n"); + sb.Append($"> **`{name,-30}`** {collection.AnonymizedName}\n"); } foreach (var (name, id, collection) in _collectionManager.Active.Individuals.Assignments) - sb.Append($"> **`{id[0].Incognito(name) + ':',-29}`** {collection.Identity.AnonymizedName}\n"); + sb.Append($"> **`{id[0].Incognito(name) + ':',-30}`** {collection.AnonymizedName}\n"); foreach (var collection in _collectionManager.Caches.Active) PrintCollection(collection, collection._cache!); diff --git a/Penumbra/Penumbra.csproj b/Penumbra/Penumbra.csproj index f9e33219..2e53bd22 100644 --- a/Penumbra/Penumbra.csproj +++ b/Penumbra/Penumbra.csproj @@ -1,45 +1,71 @@ - + + net8.0-windows + preview + x64 Penumbra absolute gangstas Penumbra - Copyright © 2025 + Copyright © 2022 9.0.0.1 9.0.0.1 bin\$(Configuration)\ + true + enable + true + false + false + true + $(MSBuildWarningsAsMessages);MSB3277 PROFILING; - false - - - - + + + + PreserveNewest - - PreserveNewest - DirectXTexC.dll - - - PreserveNewest - + + $(AppData)\XIVLauncher\addon\Hooks\dev\ + + - - $(DalamudLibPath)Iced.dll + + $(DalamudLibPath)Dalamud.dll False - - $(DalamudLibPath)TerraFX.Interop.Windows.dll + + $(DalamudLibPath)ImGui.NET.dll + False + + + $(DalamudLibPath)ImGuiScene.dll + False + + + $(DalamudLibPath)Lumina.dll + False + + + $(DalamudLibPath)Lumina.Excel.dll + False + + + $(DalamudLibPath)FFXIVClientStructs.dll + False + + + $(DalamudLibPath)Newtonsoft.Json.dll False @@ -48,12 +74,11 @@ - - - - - - + + + + + @@ -64,6 +89,16 @@ + + + PreserveNewest + DirectXTexC.dll + + + PreserveNewest + + + diff --git a/Penumbra/Penumbra.json b/Penumbra/Penumbra.json index 975c5bb3..85e01c84 100644 --- a/Penumbra/Penumbra.json +++ b/Penumbra/Penumbra.json @@ -1,5 +1,5 @@ { - "Author": "Ottermandias, Nylfae, Adam, Wintermute", + "Author": "Ottermandias, Adam, Wintermute", "Name": "Penumbra", "Punchline": "Runtime mod loader and manager.", "Description": "Runtime mod loader and manager.", @@ -8,9 +8,9 @@ "RepoUrl": "https://github.com/xivdev/Penumbra", "ApplicableVersion": "any", "Tags": [ "modding" ], - "DalamudApiLevel": 14, + "DalamudApiLevel": 9, "LoadPriority": 69420, - "LoadRequiredState": 2, + "LoadState": 2, "LoadSync": true, "IconUrl": "https://raw.githubusercontent.com/xivdev/Penumbra/master/images/icon.png" } diff --git a/Penumbra/Services/CleanupService.cs b/Penumbra/Services/CleanupService.cs deleted file mode 100644 index bf76f5f0..00000000 --- a/Penumbra/Services/CleanupService.cs +++ /dev/null @@ -1,165 +0,0 @@ -using OtterGui.Services; -using Penumbra.Collections.Manager; -using Penumbra.Mods.Manager; - -namespace Penumbra.Services; - -public class CleanupService(SaveService saveService, ModManager mods, CollectionManager collections) : IService -{ - private CancellationTokenSource _cancel = new(); - private Task? _task; - - public double Progress { get; private set; } - - public bool IsRunning - => _task is { IsCompleted: false }; - - public void Cancel() - => _cancel.Cancel(); - - public void CleanUnusedLocalData() - { - if (IsRunning) - return; - - var usedFiles = mods.Select(saveService.FileNames.LocalDataFile).ToHashSet(); - Progress = 0; - var deleted = 0; - _cancel = new CancellationTokenSource(); - _task = Task.Run(() => - { - var localFiles = saveService.FileNames.LocalDataFiles.ToList(); - var step = 0.9 / localFiles.Count; - Progress = 0.1; - foreach (var file in localFiles) - { - if (_cancel.IsCancellationRequested) - break; - - try - { - if (!file.Exists || usedFiles.Contains(file.FullName)) - continue; - - file.Delete(); - Penumbra.Log.Debug($"[CleanupService] Deleted unused local data file {file.Name}."); - ++deleted; - } - catch (Exception ex) - { - Penumbra.Log.Error($"[CleanupService] Failed to delete unused local data file {file.Name}:\n{ex}"); - } - - Progress += step; - } - - Penumbra.Log.Information($"[CleanupService] Deleted {deleted} unused local data files."); - Progress = 1; - }); - } - - public void CleanBackupFiles() - { - if (IsRunning) - return; - - Progress = 0; - var deleted = 0; - _cancel = new CancellationTokenSource(); - _task = Task.Run(() => - { - var configFiles = Directory.EnumerateFiles(saveService.FileNames.ConfigDirectory, "*.json.bak", SearchOption.AllDirectories) - .ToList(); - Progress = 0.1; - if (_cancel.IsCancellationRequested) - return; - - var groupFiles = mods.BasePath.EnumerateFiles("group_*.json.bak", SearchOption.AllDirectories).ToList(); - Progress = 0.5; - var step = 0.4 / (groupFiles.Count + configFiles.Count); - foreach (var file in groupFiles) - { - if (_cancel.IsCancellationRequested) - break; - - try - { - if (!file.Exists) - continue; - - file.Delete(); - ++deleted; - Penumbra.Log.Debug($"[CleanupService] Deleted group backup file {file.FullName}."); - } - catch (Exception ex) - { - Penumbra.Log.Error($"[CleanupService] Failed to delete group backup file {file.FullName}:\n{ex}"); - } - - Progress += step; - } - - Penumbra.Log.Information($"[CleanupService] Deleted {deleted} group backup files."); - - deleted = 0; - foreach (var file in configFiles) - { - if (_cancel.IsCancellationRequested) - break; - - try - { - if (!File.Exists(file)) - continue; - - File.Delete(file); - ++deleted; - Penumbra.Log.Debug($"[CleanupService] Deleted config backup file {file}."); - } - catch (Exception ex) - { - Penumbra.Log.Error($"[CleanupService] Failed to delete config backup file {file}:\n{ex}"); - } - - Progress += step; - } - - Penumbra.Log.Information($"[CleanupService] Deleted {deleted} config backup files."); - Progress = 1; - }); - } - - public void CleanupAllUnusedSettings() - { - if (IsRunning) - return; - - Progress = 0; - var totalRemoved = 0; - var diffCollections = 0; - _cancel = new CancellationTokenSource(); - _task = Task.Run(() => - { - var step = 1.0 / collections.Storage.Count; - foreach (var collection in collections.Storage) - { - if (_cancel.IsCancellationRequested) - break; - - var count = collections.Storage.CleanUnavailableSettings(collection); - if (count > 0) - { - Penumbra.Log.Debug( - $"[CleanupService] Removed {count} unused settings from collection {collection.Identity.AnonymizedName}."); - totalRemoved += count; - ++diffCollections; - } - - Progress += step; - } - - Penumbra.Log.Information($"[CleanupService] Removed {totalRemoved} unused settings from {diffCollections} separate collections."); - Progress = 1; - }); - } -} diff --git a/Penumbra/Services/CommunicatorService.cs b/Penumbra/Services/CommunicatorService.cs index 35f15e9e..cacbe689 100644 --- a/Penumbra/Services/CommunicatorService.cs +++ b/Penumbra/Services/CommunicatorService.cs @@ -24,8 +24,8 @@ public class CommunicatorService : IDisposable, IService /// public readonly CreatedCharacterBase CreatedCharacterBase = new(); - /// - public readonly MtrlLoaded MtrlLoaded = new(); + /// + public readonly MtrlShpkLoaded MtrlShpkLoaded = new(); /// public readonly ModDataChanged ModDataChanged = new(); @@ -81,19 +81,13 @@ public class CommunicatorService : IDisposable, IService /// public readonly ResolvedFileChanged ResolvedFileChanged = new(); - /// - public readonly PcpCreation PcpCreation = new(); - - /// - public readonly PcpParsing PcpParsing = new(); - public void Dispose() { CollectionChange.Dispose(); TemporaryGlobalModChange.Dispose(); CreatingCharacterBase.Dispose(); CreatedCharacterBase.Dispose(); - MtrlLoaded.Dispose(); + MtrlShpkLoaded.Dispose(); ModDataChanged.Dispose(); ModOptionChanged.Dispose(); ModDiscoveryStarted.Dispose(); @@ -111,7 +105,5 @@ public class CommunicatorService : IDisposable, IService ChangedItemClick.Dispose(); SelectTab.Dispose(); ResolvedFileChanged.Dispose(); - PcpCreation.Dispose(); - PcpParsing.Dispose(); } } diff --git a/Penumbra/Services/ConfigMigrationService.cs b/Penumbra/Services/ConfigMigrationService.cs index 9fe8c420..1f6ac170 100644 --- a/Penumbra/Services/ConfigMigrationService.cs +++ b/Penumbra/Services/ConfigMigrationService.cs @@ -27,8 +27,8 @@ public class ConfigMigrationService(SaveService saveService, BackupService backu private Configuration _config = null!; private JObject _data = null!; - public string CurrentCollection = ModCollectionIdentity.DefaultCollectionName; - public string DefaultCollection = ModCollectionIdentity.DefaultCollectionName; + public string CurrentCollection = ModCollection.DefaultCollectionName; + public string DefaultCollection = ModCollection.DefaultCollectionName; public string ForcedCollection = string.Empty; public Dictionary CharacterCollections = []; public Dictionary ModSortOrder = []; @@ -115,7 +115,7 @@ public class ConfigMigrationService(SaveService saveService, BackupService backu _data["ResourceWatcherRecordTypes"]?.ToObject() ?? _config.Ephemeral.ResourceWatcherRecordTypes; _config.Ephemeral.CollectionPanel = _data["CollectionPanel"]?.ToObject() ?? _config.Ephemeral.CollectionPanel; _config.Ephemeral.SelectedTab = _data["SelectedTab"]?.ToObject() ?? _config.Ephemeral.SelectedTab; - _config.Ephemeral.ChangedItemFilter = _data["ChangedItemFilter"]?.ToObject() + _config.Ephemeral.ChangedItemFilter = _data["ChangedItemFilter"]?.ToObject() ?? _config.Ephemeral.ChangedItemFilter; _config.Ephemeral.FixMainWindow = _data["FixMainWindow"]?.ToObject() ?? _config.Ephemeral.FixMainWindow; _config.Ephemeral.Save(); @@ -240,7 +240,7 @@ public class ConfigMigrationService(SaveService saveService, BackupService backu if (jObject["Name"]?.ToObject() == ForcedCollection) continue; - jObject[nameof(ModCollectionInheritance.DirectlyInheritsFrom)] = JToken.FromObject(new List { ForcedCollection }); + jObject[nameof(ModCollection.DirectlyInheritsFrom)] = JToken.FromObject(new List { ForcedCollection }); File.WriteAllText(collection.FullName, jObject.ToString()); } catch (Exception e) @@ -346,7 +346,7 @@ public class ConfigMigrationService(SaveService saveService, BackupService backu if (!collectionJson.Exists) return; - var defaultCollectionFile = new FileInfo(saveService.FileNames.CollectionFile(ModCollectionIdentity.DefaultCollectionName)); + var defaultCollectionFile = new FileInfo(saveService.FileNames.CollectionFile(ModCollection.DefaultCollectionName)); if (defaultCollectionFile.Exists) return; @@ -379,8 +379,7 @@ public class ConfigMigrationService(SaveService saveService, BackupService backu dict = dict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value with { Priority = maxPriority - kvp.Value.Priority }); var emptyStorage = new ModStorage(); - // Only used for saving and immediately discarded, so the local collection id here is irrelevant. - var collection = ModCollection.CreateFromData(saveService, emptyStorage, ModCollectionIdentity.New(ModCollectionIdentity.DefaultCollectionName, LocalCollectionId.Zero, 1), 0, dict, []); + var collection = ModCollection.CreateFromData(saveService, emptyStorage, Guid.NewGuid(), ModCollection.DefaultCollectionName, 0, 1, dict, []); saveService.ImmediateSaveSync(new ModCollectionSave(emptyStorage, collection)); } catch (Exception e) diff --git a/Penumbra/Services/CrashHandlerService.cs b/Penumbra/Services/CrashHandlerService.cs index 4814795c..6805e7db 100644 --- a/Penumbra/Services/CrashHandlerService.cs +++ b/Penumbra/Services/CrashHandlerService.cs @@ -7,8 +7,7 @@ using Penumbra.Communication; using Penumbra.CrashHandler; using Penumbra.CrashHandler.Buffers; using Penumbra.GameData.Actors; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Structs; using Penumbra.String; using Penumbra.String.Classes; @@ -240,7 +239,7 @@ public sealed class CrashHandlerService : IDisposable, IService var name = GetActorName(character); lock (_eventWriter) { - _eventWriter?.AnimationFuncInvoked.WriteLine(character, name.Span, collection.Identity.Id, type); + _eventWriter?.AnimationFuncInvoked.WriteLine(character, name.Span, collection.Id, type); } } catch (Exception ex) @@ -287,13 +286,14 @@ public sealed class CrashHandlerService : IDisposable, IService try { - if (PathDataHandler.Split(manipulatedPath.Value.FullName, out var actualPath, out _) && !Path.IsPathRooted(actualPath)) + var dashIdx = manipulatedPath.Value.InternalName[0] == (byte)'|' ? manipulatedPath.Value.InternalName.IndexOf((byte)'|', 1) : -1; + if (dashIdx >= 0 && !Utf8GamePath.IsRooted(manipulatedPath.Value.InternalName.Substring(dashIdx + 1))) return; var name = GetActorName(resolveData.AssociatedGameObject); lock (_eventWriter) { - _eventWriter!.FileLoaded.WriteLine(resolveData.AssociatedGameObject, name.Span, resolveData.ModCollection.Identity.Id, + _eventWriter!.FileLoaded.WriteLine(resolveData.AssociatedGameObject, name.Span, resolveData.ModCollection.Id, manipulatedPath.Value.InternalName.Span, originalPath.Path.Span); } } diff --git a/Penumbra/Services/DalamudConfigService.cs b/Penumbra/Services/DalamudConfigService.cs index 012a45f5..8379a3e7 100644 --- a/Penumbra/Services/DalamudConfigService.cs +++ b/Penumbra/Services/DalamudConfigService.cs @@ -10,9 +10,9 @@ public class DalamudConfigService : IService try { var serviceType = - typeof(IDalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "Service`1" && t.IsGenericType); - var configType = typeof(IDalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "DalamudConfiguration"); - var interfaceType = typeof(IDalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "DalamudInterface"); + typeof(DalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "Service`1" && t.IsGenericType); + var configType = typeof(DalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "DalamudConfiguration"); + var interfaceType = typeof(DalamudPluginInterface).Assembly.DefinedTypes.FirstOrDefault(t => t.Name == "DalamudInterface"); if (serviceType == null || configType == null || interfaceType == null) return; diff --git a/Penumbra/Services/FileWatcher.cs b/Penumbra/Services/FileWatcher.cs deleted file mode 100644 index 1d572f05..00000000 --- a/Penumbra/Services/FileWatcher.cs +++ /dev/null @@ -1,209 +0,0 @@ -using OtterGui.Services; -using Penumbra.Mods.Manager; - -namespace Penumbra.Services; - -public class FileWatcher : IDisposable, IService -{ - // TODO: use ConcurrentSet when it supports comparers in Luna. - private readonly ConcurrentDictionary _pending = new(StringComparer.OrdinalIgnoreCase); - private readonly ModImportManager _modImportManager; - private readonly MessageService _messageService; - private readonly Configuration _config; - - private bool _pausedConsumer; - private FileSystemWatcher? _fsw; - private CancellationTokenSource? _cts = new(); - private Task? _consumer; - - public FileWatcher(ModImportManager modImportManager, MessageService messageService, Configuration config) - { - _modImportManager = modImportManager; - _messageService = messageService; - _config = config; - - if (_config.EnableDirectoryWatch) - { - SetupFileWatcher(_config.WatchDirectory); - SetupConsumerTask(); - } - } - - public void Toggle(bool value) - { - if (_config.EnableDirectoryWatch == value) - return; - - _config.EnableDirectoryWatch = value; - _config.Save(); - if (value) - { - SetupFileWatcher(_config.WatchDirectory); - SetupConsumerTask(); - } - else - { - EndFileWatcher(); - EndConsumerTask(); - } - } - - internal void PauseConsumer(bool pause) - => _pausedConsumer = pause; - - private void EndFileWatcher() - { - if (_fsw is null) - return; - - _fsw.Dispose(); - _fsw = null; - } - - private void SetupFileWatcher(string directory) - { - EndFileWatcher(); - _fsw = new FileSystemWatcher - { - IncludeSubdirectories = false, - NotifyFilter = NotifyFilters.FileName | NotifyFilters.CreationTime, - InternalBufferSize = 32 * 1024, - }; - - // Only wake us for the exact patterns we care about - _fsw.Filters.Add("*.pmp"); - _fsw.Filters.Add("*.pcp"); - _fsw.Filters.Add("*.ttmp"); - _fsw.Filters.Add("*.ttmp2"); - - _fsw.Created += OnPath; - _fsw.Renamed += OnPath; - UpdateDirectory(directory); - } - - - private void EndConsumerTask() - { - if (_cts is not null) - { - _cts.Cancel(); - _cts = null; - } - _consumer = null; - } - - private void SetupConsumerTask() - { - EndConsumerTask(); - _cts = new CancellationTokenSource(); - _consumer = Task.Factory.StartNew( - () => ConsumerLoopAsync(_cts.Token), - _cts.Token, TaskCreationOptions.LongRunning, TaskScheduler.Default).Unwrap(); - } - - public void UpdateDirectory(string newPath) - { - if (_config.WatchDirectory != newPath) - { - _config.WatchDirectory = newPath; - _config.Save(); - } - - if (_fsw is null) - return; - - _fsw.EnableRaisingEvents = false; - if (!Directory.Exists(newPath) || newPath.Length is 0) - { - _fsw.Path = string.Empty; - } - else - { - _fsw.Path = newPath; - _fsw.EnableRaisingEvents = true; - } - } - - private void OnPath(object? sender, FileSystemEventArgs e) - => _pending.TryAdd(e.FullPath, 0); - - private async Task ConsumerLoopAsync(CancellationToken token) - { - while (true) - { - var (path, _) = _pending.FirstOrDefault(); - if (path is null || _pausedConsumer) - { - await Task.Delay(500, token).ConfigureAwait(false); - continue; - } - - try - { - await ProcessOneAsync(path, token).ConfigureAwait(false); - } - catch (OperationCanceledException) - { - Penumbra.Log.Debug("[FileWatcher] Canceled via Token."); - } - catch (Exception ex) - { - Penumbra.Log.Warning($"[FileWatcher] Error during Processing: {ex}"); - } - finally - { - _pending.TryRemove(path, out _); - } - } - } - - private async Task ProcessOneAsync(string path, CancellationToken token) - { - // Downloads often finish via rename; file may be locked briefly. - // Wait until it exists and is readable; also require two stable size checks. - const int maxTries = 40; - long lastLen = -1; - - for (var i = 0; i < maxTries && !token.IsCancellationRequested; i++) - { - if (!File.Exists(path)) - { - await Task.Delay(100, token); - continue; - } - - try - { - var fi = new FileInfo(path); - var len = fi.Length; - if (len > 0 && len == lastLen) - { - if (_config.EnableAutomaticModImport) - _modImportManager.AddUnpack(path); - else - _messageService.AddMessage(new InstallNotification(_modImportManager, path), false); - return; - } - - lastLen = len; - } - catch (IOException) - { - Penumbra.Log.Debug($"[FileWatcher] File is still being written to."); - } - catch (UnauthorizedAccessException) - { - Penumbra.Log.Debug($"[FileWatcher] File is locked."); - } - - await Task.Delay(150, token); - } - } - - - public void Dispose() - { - EndConsumerTask(); - EndFileWatcher(); - } -} diff --git a/Penumbra/Services/FilenameService.cs b/Penumbra/Services/FilenameService.cs index ee096109..e1c482f7 100644 --- a/Penumbra/Services/FilenameService.cs +++ b/Penumbra/Services/FilenameService.cs @@ -5,7 +5,7 @@ using Penumbra.Mods; namespace Penumbra.Services; -public class FilenameService(IDalamudPluginInterface pi) : IService +public class FilenameService(DalamudPluginInterface pi) : IService { public readonly string ConfigDirectory = pi.ConfigDirectory.FullName; public readonly string CollectionDirectory = Path.Combine(pi.ConfigDirectory.FullName, "collections"); @@ -24,7 +24,7 @@ public class FilenameService(IDalamudPluginInterface pi) : IService /// Obtain the path of a collection file given its name. public string CollectionFile(ModCollection collection) - => CollectionFile(collection.Identity.Identifier); + => CollectionFile(collection.Identifier); /// Obtain the path of a collection file given its name. public string CollectionFile(string collectionName) diff --git a/Penumbra/Services/InstallNotification.cs b/Penumbra/Services/InstallNotification.cs deleted file mode 100644 index e3956076..00000000 --- a/Penumbra/Services/InstallNotification.cs +++ /dev/null @@ -1,39 +0,0 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Interface.ImGuiNotification.EventArgs; -using OtterGui.Text; -using Penumbra.Mods.Manager; - -namespace Penumbra.Services; - -public class InstallNotification(ModImportManager modImportManager, string filePath) : OtterGui.Classes.MessageService.IMessage -{ - public string Message - => "A new mod has been found!"; - - public NotificationType NotificationType - => NotificationType.Info; - - public uint NotificationDuration - => uint.MaxValue; - - public string NotificationTitle { get; } = Path.GetFileNameWithoutExtension(filePath); - - public string LogMessage - => $"A new mod has been found: {Path.GetFileName(filePath)}"; - - public void OnNotificationActions(INotificationDrawArgs args) - { - var region = ImGui.GetContentRegionAvail(); - var buttonSize = new Vector2((region.X - ImGui.GetStyle().ItemSpacing.X) / 2, 0); - if (ImUtf8.ButtonEx("Install"u8, ""u8, buttonSize)) - { - modImportManager.AddUnpack(filePath); - args.Notification.DismissNow(); - } - - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Ignore"u8, ""u8, buttonSize)) - args.Notification.DismissNow(); - } -} diff --git a/Penumbra/Services/MessageService.cs b/Penumbra/Services/MessageService.cs index 70ccf47b..0a85a569 100644 --- a/Penumbra/Services/MessageService.cs +++ b/Penumbra/Services/MessageService.cs @@ -2,22 +2,17 @@ using Dalamud.Game.Text; using Dalamud.Game.Text.SeStringHandling; using Dalamud.Game.Text.SeStringHandling.Payloads; using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; using Dalamud.Plugin.Services; -using Lumina.Excel.Sheets; +using Lumina.Excel.GeneratedSheets; using OtterGui.Log; using OtterGui.Services; -using Penumbra.GameData.Data; -using Penumbra.Mods.Manager; -using Penumbra.String.Classes; -using Notification = OtterGui.Classes.Notification; namespace Penumbra.Services; -public class MessageService(Logger log, IUiBuilder builder, IChatGui chat, INotificationManager notificationManager) - : OtterGui.Classes.MessageService(log, builder, chat, notificationManager), IService +public class MessageService(Logger log, UiBuilder uiBuilder, IChatGui chat, INotificationManager notificationManager) + : OtterGui.Classes.MessageService(log, uiBuilder, chat, notificationManager), IService { - public void LinkItem(in Item item) + public void LinkItem(Item item) { // @formatter:off var payloadList = new List @@ -30,7 +25,7 @@ public class MessageService(Logger log, IUiBuilder builder, IChatGui chat, INoti new TextPayload($"{(char)SeIconChar.LinkMarker}"), new UIForegroundPayload(0), new UIGlowPayload(0), - new TextPayload(item.Name.ExtractTextExtended()), + new TextPayload(item.Name), new RawPayload([0x02, 0x27, 0x07, 0xCF, 0x01, 0x01, 0x01, 0xFF, 0x01, 0x03]), new RawPayload([0x02, 0x13, 0x02, 0xEC, 0x03]), }; @@ -43,16 +38,4 @@ public class MessageService(Logger log, IUiBuilder builder, IChatGui chat, INoti Message = payload, }); } - - public void PrintFileWarning(ModManager modManager, string fullPath, Utf8GamePath originalGamePath, string messageComplement) - { - // Don't warn for files managed by other plugins, or files we aren't sure about. - if (!modManager.TryIdentifyPath(fullPath, out var mod, out _)) - return; - - AddTaggedMessage($"{fullPath}.{messageComplement}", - new Notification( - $"Cowardly refusing to load replacement for {originalGamePath.Filename().ToString().ToLowerInvariant()} by {mod.Name}{(messageComplement.Length > 0 ? ":\n" : ".")}{messageComplement}", - NotificationType.Warning, 10000)); - } } diff --git a/Penumbra/Services/MigrationManager.cs b/Penumbra/Services/MigrationManager.cs deleted file mode 100644 index 8db62e48..00000000 --- a/Penumbra/Services/MigrationManager.cs +++ /dev/null @@ -1,436 +0,0 @@ -using Dalamud.Interface.ImGuiNotification; -using Lumina.Data.Files; -using OtterGui.Classes; -using OtterGui.Services; -using Lumina.Extensions; -using Penumbra.GameData.Files.Utility; -using Penumbra.Import.Textures; -using SharpCompress.Common; -using SharpCompress.Readers; -using MdlFile = Penumbra.GameData.Files.MdlFile; -using MtrlFile = Penumbra.GameData.Files.MtrlFile; - -namespace Penumbra.Services; - -public class MigrationManager(Configuration config) : IService -{ - public enum TaskType : byte - { - None, - MdlMigration, - MdlRestoration, - MdlCleanup, - MtrlMigration, - MtrlRestoration, - MtrlCleanup, - } - - public class MigrationData(bool hasUnchanged) - - { - public int Changed; - public int Unchanged; - public int Failed; - public bool HasData; - public readonly bool HasUnchanged = hasUnchanged; - - public int Total - => Changed + Unchanged + Failed; - - public void Init() - { - Changed = 0; - Unchanged = 0; - Failed = 0; - HasData = true; - } - } - - private Task? _currentTask; - private CancellationTokenSource? _source; - - public TaskType CurrentTask { get; private set; } - - public readonly MigrationData MdlMigration = new(true); - public readonly MigrationData MtrlMigration = new(true); - public readonly MigrationData MdlCleanup = new(false); - public readonly MigrationData MtrlCleanup = new(false); - public readonly MigrationData MdlRestoration = new(false); - public readonly MigrationData MtrlRestoration = new(false); - - - public bool IsRunning - => _currentTask is { IsCompleted: false }; - - public void CleanMdlBackups(string path) - => CleanBackups(path, "*.mdl.bak", "model", MdlCleanup, TaskType.MdlCleanup); - - public void CleanMtrlBackups(string path) - => CleanBackups(path, "*.mtrl.bak", "material", MtrlCleanup, TaskType.MtrlCleanup); - - public void Await() - => _currentTask?.Wait(); - - private void CleanBackups(string path, string extension, string fileType, MigrationData data, TaskType type) - { - if (IsRunning) - return; - - _source = new CancellationTokenSource(); - var token = _source.Token; - _currentTask = Task.Run(() => - { - CurrentTask = type; - data.Init(); - foreach (var file in Directory.EnumerateFiles(path, extension, SearchOption.AllDirectories)) - { - if (token.IsCancellationRequested) - return; - - try - { - File.Delete(file); - ++data.Changed; - Penumbra.Log.Debug($"Deleted {fileType} backup file {file}."); - } - catch (Exception ex) - { - Penumbra.Messager.NotificationMessage(ex, $"Failed to delete {fileType} backup file {file}", NotificationType.Warning); - ++data.Failed; - } - } - }, token); - } - - public void RestoreMdlBackups(string path) - => RestoreBackups(path, "*.mdl.bak", "model", MdlRestoration, TaskType.MdlRestoration); - - public void RestoreMtrlBackups(string path) - => RestoreBackups(path, "*.mtrl.bak", "material", MtrlRestoration, TaskType.MtrlRestoration); - - private void RestoreBackups(string path, string extension, string fileType, MigrationData data, TaskType type) - { - if (IsRunning) - return; - - _source = new CancellationTokenSource(); - var token = _source.Token; - _currentTask = Task.Run(() => - { - CurrentTask = type; - data.Init(); - foreach (var file in Directory.EnumerateFiles(path, extension, SearchOption.AllDirectories)) - { - if (token.IsCancellationRequested) - return; - - var target = file[..^4]; - try - { - File.Copy(file, target, true); - ++data.Changed; - Penumbra.Log.Debug($"Restored {fileType} backup file {file} to {target}."); - } - catch (Exception ex) - { - Penumbra.Messager.NotificationMessage(ex, $"Failed to restore {fileType} backup file {file} to {target}", - NotificationType.Warning); - ++data.Failed; - } - } - }, token); - } - - public void MigrateMdlDirectory(string path, bool createBackups) - => MigrateDirectory(path, createBackups, "*.mdl", "model", MdlMigration, TaskType.MdlMigration, "from V5 to V6", "V6", - (file, fileData, backups) => - { - var mdl = new MdlFile(fileData); - return MigrateModel(file, mdl, backups); - }); - - public void MigrateMtrlDirectory(string path, bool createBackups) - => MigrateDirectory(path, createBackups, "*.mtrl", "material", MtrlMigration, TaskType.MtrlMigration, "to Dawntrail", "Dawntrail", - (file, fileData, backups) => - { - var mtrl = new MtrlFile(fileData); - return MigrateMaterial(file, mtrl, backups); - } - ); - - private void MigrateDirectory(string path, bool createBackups, string extension, string fileType, MigrationData data, TaskType type, - string action, string state, Func func) - { - if (IsRunning) - return; - - _source = new CancellationTokenSource(); - var token = _source.Token; - _currentTask = Task.Run(() => - { - CurrentTask = type; - data.Init(); - foreach (var file in Directory.EnumerateFiles(path, extension, SearchOption.AllDirectories)) - { - if (token.IsCancellationRequested) - return; - - var timer = Stopwatch.StartNew(); - try - { - var fileData = File.ReadAllBytes(file); - if (func(file, fileData, createBackups)) - { - ++data.Changed; - Penumbra.Log.Debug($"Migrated {fileType} file {file} {action} in {timer.ElapsedMilliseconds} ms."); - } - else - { - ++data.Unchanged; - Penumbra.Log.Verbose($"Verified that {fileType} file {file} is already {state} in {timer.ElapsedMilliseconds} ms."); - } - } - catch (Exception ex) - { - ++data.Failed; - Penumbra.Messager.NotificationMessage(ex, - $"Failed to migrate {fileType} file {file} to {state} in {timer.ElapsedMilliseconds} ms", - NotificationType.Warning); - } - } - }, token); - } - - public void Cancel() - { - _source?.Cancel(); - _source = null; - _currentTask = null; - } - - public static bool TryMigrateSingleModel(string path, bool createBackup) - { - try - { - var data = File.ReadAllBytes(path); - var mdl = new MdlFile(data); - return MigrateModel(path, mdl, createBackup); - } - catch (Exception ex) - { - Penumbra.Messager.NotificationMessage(ex, $"Failed to migrate the model {path} to V6", NotificationType.Warning); - return false; - } - } - - public static bool TryMigrateSingleMaterial(string path, bool createBackup) - { - try - { - var data = File.ReadAllBytes(path); - var mtrl = new MtrlFile(data); - return MigrateMaterial(path, mtrl, createBackup); - } - catch (Exception ex) - { - Penumbra.Messager.NotificationMessage(ex, $"Failed to migrate the material {path} to Dawntrail", NotificationType.Warning); - return false; - } - } - - /// Writes or migrates a .mdl file during extraction from a regular archive. - public void MigrateMdlDuringExtraction(IReader reader, string directory, ExtractionOptions options) - { - if (!config.MigrateImportedModelsToV6) - { - reader.WriteEntryToDirectory(directory, options); - return; - } - - var path = Path.Combine(directory, reader.Entry.Key!); - using var s = new MemoryStream(); - using var e = reader.OpenEntryStream(); - e.CopyTo(s); - s.Position = 0; - using var b = new BinaryReader(s); - var version = b.ReadUInt32(); - if (version == MdlFile.V5) - { - var data = s.ToArray(); - var mdl = new MdlFile(data); - Directory.CreateDirectory(Path.GetDirectoryName(path)!); - MigrateModel(path, mdl, false); - Penumbra.Log.Debug($"Migrated model {reader.Entry.Key} from V5 to V6 during import."); - } - else - { - Directory.CreateDirectory(Path.GetDirectoryName(path)!); - using var f = File.Open(path, FileMode.Create, FileAccess.Write); - s.Seek(0, SeekOrigin.Begin); - s.WriteTo(f); - } - } - - public void MigrateMtrlDuringExtraction(IReader reader, string directory, ExtractionOptions options) - { - if (!config.MigrateImportedMaterialsToLegacy || true) // TODO change when this is working - { - reader.WriteEntryToDirectory(directory, options); - return; - } - - var path = Path.Combine(directory, reader.Entry.Key); - using var s = new MemoryStream(); - using var e = reader.OpenEntryStream(); - e.CopyTo(s); - var file = new MtrlFile(s.GetBuffer()); - - Directory.CreateDirectory(Path.GetDirectoryName(path)!); - using var f = File.Open(path, FileMode.Create, FileAccess.Write); - if (file.IsDawntrail) - { - file.MigrateToDawntrail(); - Penumbra.Log.Debug($"Migrated material {reader.Entry.Key} to Dawntrail during import."); - f.Write(file.Write()); - } - else - { - s.Seek(0, SeekOrigin.Begin); - s.WriteTo(f); - } - } - - public void FixMipMaps(IReader reader, string directory, ExtractionOptions options) - { - var path = Path.Combine(directory, reader.Entry.Key!); - using var s = new MemoryStream(); - using var e = reader.OpenEntryStream(); - e.CopyTo(s); - var length = s.Position; - s.Seek(0, SeekOrigin.Begin); - var br = new BinaryReader(s, Encoding.UTF8, true); - var header = br.ReadStructure(); - br.Dispose(); - TexFileParser.FixMipOffsets(length, ref header, out var actualSize); - - s.Seek(0, SeekOrigin.Begin); - Directory.CreateDirectory(Path.GetDirectoryName(path)!); - using var f = File.Open(path, FileMode.Create, FileAccess.Write); - f.Write(header); - f.Write(s.GetBuffer().AsSpan(80, (int)actualSize - 80)); - } - - /// Update the data of a .mdl file during TTMP extraction. Returns either the existing array or a new one. - public byte[] MigrateTtmpModel(string path, byte[] data) - { - FixLodNum(data); - if (!config.MigrateImportedModelsToV6) - return data; - - var version = BitConverter.ToUInt32(data); - if (version != 5) - return data; - - try - { - var mdl = new MdlFile(data); - if (!mdl.ConvertV5ToV6()) - return data; - - data = mdl.Write(); - Penumbra.Log.Debug($"Migrated model {path} from V5 to V6 during import."); - return data; - } - catch (Exception ex) - { - Penumbra.Log.Warning($"Failed to migrate model {path} from V5 to V6 during import:\n{ex}"); - return data; - } - } - - /// Update the data of a .mtrl file during TTMP extraction. Returns either the existing array or a new one. - public byte[] MigrateTtmpMaterial(string path, byte[] data) - { - if (!config.MigrateImportedMaterialsToLegacy || true) // TODO fix when this is working - return data; - - try - { - var mtrl = new MtrlFile(data); - if (mtrl.IsDawntrail) - return data; - - mtrl.MigrateToDawntrail(); - data = mtrl.Write(); - Penumbra.Log.Debug($"Migrated material {path} to Dawntrail during import."); - return data; - } - catch (Exception ex) - { - Penumbra.Log.Warning($"Failed to migrate material {path} to Dawntrail during import:\n{ex}"); - return data; - } - } - - public byte[] FixTtmpMipMaps(string path, byte[] data) - { - using var m = new MemoryStream(data); - var br = new BinaryReader(m, Encoding.UTF8, true); - var header = br.ReadStructure(); - br.Dispose(); - TexFileParser.FixMipOffsets(data.Length, ref header, out var actualSize); - if (actualSize == data.Length) - return data; - - var ret = new byte[actualSize]; - using var m2 = new MemoryStream(ret); - using var bw = new BinaryWriter(m2); - bw.Write(header); - bw.Write(data.AsSpan(80, (int)actualSize - 80)); - - return ret; - } - - - private static bool MigrateModel(string path, MdlFile mdl, bool createBackup) - { - if (!mdl.ConvertV5ToV6()) - return false; - - var data = mdl.Write(); - if (createBackup) - File.Copy(path, Path.ChangeExtension(path, ".mdl.bak")); - File.WriteAllBytes(path, data); - return true; - } - - private static bool MigrateMaterial(string path, MtrlFile mtrl, bool createBackup) - { - if (!mtrl.MigrateToDawntrail()) - return false; - - var data = mtrl.Write(); - - mtrl.Write(); - if (createBackup) - File.Copy(path, Path.ChangeExtension(path, ".mtrl.bak")); - File.WriteAllBytes(path, data); - return true; - } - - private static void FixLodNum(byte[] data) - { - const int modelHeaderLodOffset = 22; - - // Model file header LOD num - data[64] = 1; - - // Model header LOD num - var stackSize = BitConverter.ToUInt32(data, 4); - var runtimeBegin = stackSize + 0x44; - var stringsLengthOffset = runtimeBegin + 4; - var stringsLength = BitConverter.ToUInt32(data, (int)stringsLengthOffset); - var modelHeaderStart = stringsLengthOffset + stringsLength + 4; - data[modelHeaderStart + modelHeaderLodOffset] = 1; - } -} diff --git a/Penumbra/Services/ModMigrator.cs b/Penumbra/Services/ModMigrator.cs deleted file mode 100644 index 043d9631..00000000 --- a/Penumbra/Services/ModMigrator.cs +++ /dev/null @@ -1,349 +0,0 @@ -using Dalamud.Plugin.Services; -using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Api.Enums; -using Penumbra.GameData.Data; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Structs; -using Penumbra.Import.Textures; -using Penumbra.Mods; -using Penumbra.Mods.SubMods; -using Penumbra.String.Classes; - -namespace Penumbra.Services; - -public class ModMigrator(IDataManager gameData, TextureManager textures) : IService -{ - private sealed class FileDataDict : MultiDictionary; - - private readonly Lazy _glassReferenceMaterial = new(() => - { - var bytes = gameData.GetFile("chara/equipment/e5001/material/v0001/mt_c0101e5001_met_b.mtrl"); - return new MtrlFile(bytes!.Data); - }); - - private readonly HashSet _changedMods = []; - private readonly HashSet _failedMods = []; - - private readonly FileDataDict Textures = []; - private readonly FileDataDict Models = []; - private readonly FileDataDict Materials = []; - private readonly FileDataDict FileSwaps = []; - - private readonly ConcurrentBag _messages = []; - - public void Update(IEnumerable mods) - { - CollectFiles(mods); - foreach (var (from, (to, container)) in FileSwaps) - MigrateFileSwaps(from, to, container); - foreach (var (model, list) in Models.Grouped) - MigrateModel(model, (Mod)list[0].Container.Mod); - } - - private void CollectFiles(IEnumerable mods) - { - foreach (var mod in mods) - { - foreach (var container in mod.AllDataContainers) - { - foreach (var (gamePath, file) in container.Files) - { - switch (ResourceTypeExtensions.FromExtension(gamePath.Extension().Span)) - { - case ResourceType.Tex: Textures.TryAdd(file.FullName, (gamePath.ToString(), container)); break; - case ResourceType.Mdl: Models.TryAdd(file.FullName, (gamePath.ToString(), container)); break; - case ResourceType.Mtrl: Materials.TryAdd(file.FullName, (gamePath.ToString(), container)); break; - } - } - - foreach (var (swapFrom, swapTo) in container.FileSwaps) - FileSwaps.TryAdd(swapTo.FullName, (swapFrom.ToString(), container)); - } - } - } - - public Task CreateIndexFile(string normalPath, string targetPath) - { - const int rowBlend = 17; - - return Task.Run(async () => - { - var tex = textures.LoadTex(normalPath); - var data = tex.GetPixelData(); - var rgbaData = new RgbaPixelData(data.Width, data.Height, data.Rgba); - if (!BitOperations.IsPow2(rgbaData.Height) || !BitOperations.IsPow2(rgbaData.Width)) - { - var requiredHeight = (int)BitOperations.RoundUpToPowerOf2((uint)rgbaData.Height); - var requiredWidth = (int)BitOperations.RoundUpToPowerOf2((uint)rgbaData.Width); - rgbaData = rgbaData.Resize((requiredWidth, requiredHeight)); - } - - Parallel.ForEach(Enumerable.Range(0, rgbaData.PixelData.Length / 4), idx => - { - var pixelIdx = 4 * idx; - var normal = rgbaData.PixelData[pixelIdx + 3]; - - // Copied from TT - var blendRem = normal % (2 * rowBlend); - var originalRow = normal / rowBlend; - switch (blendRem) - { - // Goes to next row, clamped to the closer row. - case > 25: - blendRem = 0; - ++originalRow; - break; - // Stays in this row, clamped to the closer row. - case > 17: blendRem = 17; break; - } - - var newBlend = (byte)(255 - MathF.Round(blendRem / 17f * 255f)); - - // Slight add here to push the color deeper into the row to ensure BC5 compression doesn't - // cause any artifacting. - var newRow = (byte)(originalRow / 2 * 17 + 4); - - rgbaData.PixelData[pixelIdx] = newRow; - rgbaData.PixelData[pixelIdx] = newBlend; - rgbaData.PixelData[pixelIdx] = 0; - rgbaData.PixelData[pixelIdx] = 255; - }); - await textures.SaveAs(CombinedTexture.TextureSaveType.BC5, true, true, new BaseImage(), targetPath, rgbaData.PixelData, - rgbaData.Width, rgbaData.Height); - }); - } - - private void MigrateModel(string filePath, Mod mod) - { - if (MigrationManager.TryMigrateSingleModel(filePath, true)) - { - _messages.Add($"Migrated model {filePath} in {mod.Name}."); - } - else - { - _messages.Add($"Failed to migrate model {filePath} in {mod.Name}"); - _failedMods.Add(mod); - } - } - - private void SetGlassReferenceValues(MtrlFile mtrl) - { - var reference = _glassReferenceMaterial.Value; - mtrl.ShaderPackage.ShaderKeys = reference.ShaderPackage.ShaderKeys.ToArray(); - mtrl.ShaderPackage.Constants = reference.ShaderPackage.Constants.ToArray(); - mtrl.AdditionalData = reference.AdditionalData.ToArray(); - mtrl.ShaderPackage.Flags &= ~(0x04u | 0x08u); - // From TT. - if (mtrl.Table is ColorTable t) - foreach (ref var row in t.AsRows()) - row.SpecularColor = new HalfColor((Half)0.8100586, (Half)0.8100586, (Half)0.8100586); - } - - private ref struct MaterialPack - { - public readonly MtrlFile File; - public readonly bool UsesMaskAsSpecular; - - private readonly Dictionary Samplers = []; - - public MaterialPack(MtrlFile file) - { - File = file; - UsesMaskAsSpecular = File.ShaderPackage.ShaderKeys.Any(x => x.Key is 0xC8BD1DEF && x.Value is 0xA02F4828 or 0x198D11CD); - Add(Samplers, TextureUsage.Normal, ShpkFile.NormalSamplerId); - Add(Samplers, TextureUsage.Index, ShpkFile.IndexSamplerId); - Add(Samplers, TextureUsage.Mask, ShpkFile.MaskSamplerId); - Add(Samplers, TextureUsage.Diffuse, ShpkFile.DiffuseSamplerId); - Add(Samplers, TextureUsage.Specular, ShpkFile.SpecularSamplerId); - return; - - void Add(Dictionary dict, TextureUsage usage, uint samplerId) - { - var idx = new SamplerIndex(file, samplerId); - if (idx.Texture >= 0) - dict.Add(usage, idx); - } - } - - public readonly record struct SamplerIndex(int Sampler, int Texture) - { - public SamplerIndex(MtrlFile file, uint samplerId) - : this(file.FindSampler(samplerId), -1) - => Texture = Sampler < 0 ? -1 : file.ShaderPackage.Samplers[Sampler].TextureIndex; - } - - public enum TextureUsage - { - Unknown, - Normal, - Index, - Mask, - Diffuse, - Specular, - } - - public static bool AdaptPath(IDataManager data, string path, TextureUsage usage, out string newPath) - { - newPath = path; - if (Path.GetExtension(newPath) is not ".tex") - return false; - - if (data.FileExists(newPath)) - return true; - - ReadOnlySpan<(string, string)> pairs = usage switch - { - TextureUsage.Unknown => - [ - ("_n.tex", "_norm.tex"), - ("_m.tex", "_mult.tex"), - ("_m.tex", "_mask.tex"), - ("_d.tex", "_base.tex"), - ], - TextureUsage.Normal => - [ - ("_n_", "_norm_"), - ("_n.tex", "_norm.tex"), - ], - TextureUsage.Mask => - [ - ("_m_", "_mult_"), - ("_m_", "_mask_"), - ("_m.tex", "_mult.tex"), - ("_m.tex", "_mask.tex"), - ], - TextureUsage.Diffuse => - [ - ("_d_", "_base_"), - ("_d.tex", "_base.tex"), - ], - TextureUsage.Index => [], - TextureUsage.Specular => [], - _ => [], - }; - foreach (var (from, to) in pairs) - { - newPath = path.Replace(from, to); - if (data.FileExists(newPath)) - return true; - } - - return false; - } - } - - private void MigrateMaterial(string filePath, IReadOnlyList<(string GamePath, IModDataContainer Container)> redirections) - { - try - { - var bytes = File.ReadAllBytes(filePath); - var mtrl = new MtrlFile(bytes); - if (!CheckUpdateNeeded(mtrl)) - return; - - // Update colorsets, flags and character shader package. - var changes = mtrl.MigrateToDawntrail(); - - if (!changes) - switch (mtrl.ShaderPackage.Name) - { - case "hair.shpk": break; - case "characterglass.shpk": - SetGlassReferenceValues(mtrl); - changes = true; - break; - } - - // Remove DX11 flags and update paths if necessary. - foreach (ref var tex in mtrl.Textures.AsSpan()) - { - if (tex.DX11) - { - changes = true; - if (GamePaths.Tex.HandleDx11Path(tex, out var newPath)) - tex.Path = newPath; - tex.DX11 = false; - } - - if (gameData.FileExists(tex.Path)) - continue; - } - - // Dyeing, from TT. - if (mtrl.DyeTable is ColorDyeTable dye) - foreach (ref var row in dye.AsRows()) - row.Template += 1000; - } - catch - { - // ignored - } - - static bool CheckUpdateNeeded(MtrlFile mtrl) - { - if (!mtrl.IsDawntrail) - return true; - - if (mtrl.ShaderPackage.Name is not "hair.shpk") - return false; - - var foundOld = 0; - foreach (var c in mtrl.ShaderPackage.Constants) - { - switch (c.Id) - { - case 0x36080AD0: foundOld |= 1; break; // == 1, from TT - case 0x992869AB: foundOld |= 2; break; // == 3 (skin) or 4 (hair) from TT - } - - if (foundOld is 3) - return true; - } - - return false; - } - } - - private void MigrateFileSwaps(string swapFrom, string swapTo, IModDataContainer container) - { - var fromExists = gameData.FileExists(swapFrom); - var toExists = gameData.FileExists(swapTo); - if (fromExists && toExists) - return; - - if (ResourceTypeExtensions.FromExtension(Path.GetExtension(swapFrom.AsSpan())) is not ResourceType.Tex - || ResourceTypeExtensions.FromExtension(Path.GetExtension(swapTo.AsSpan())) is not ResourceType.Tex) - { - _messages.Add( - $"Could not migrate file swap {swapFrom} -> {swapTo} in {container.Mod.Name}: {container.GetFullName()}. Only textures may be migrated.{(fromExists ? "\n\tSource File does not exist." : "")}{(toExists ? "\n\tTarget File does not exist." : "")}"); - return; - } - - var newSwapFrom = swapFrom; - if (!fromExists && !MaterialPack.AdaptPath(gameData, swapFrom, MaterialPack.TextureUsage.Unknown, out newSwapFrom)) - { - _messages.Add($"Could not migrate file swap {swapFrom} -> {swapTo} in {container.Mod.Name}: {container.GetFullName()}."); - return; - } - - var newSwapTo = swapTo; - if (!toExists && !MaterialPack.AdaptPath(gameData, swapTo, MaterialPack.TextureUsage.Unknown, out newSwapTo)) - { - _messages.Add($"Could not migrate file swap {swapFrom} -> {swapTo} in {container.Mod.Name}: {container.GetFullName()}."); - return; - } - - if (!Utf8GamePath.FromString(swapFrom, out var path) || !Utf8GamePath.FromString(newSwapFrom, out var newPath)) - { - _messages.Add( - $"Could not migrate file swap {swapFrom} -> {swapTo} in {container.Mod.Name}: {container.GetFullName()}. Unknown Error."); - return; - } - - container.FileSwaps.Remove(path); - container.FileSwaps.Add(newPath, new FullPath(newSwapTo)); - _changedMods.Add((Mod)container.Mod); - } -} diff --git a/Penumbra/Services/PcpService.cs b/Penumbra/Services/PcpService.cs deleted file mode 100644 index 17646564..00000000 --- a/Penumbra/Services/PcpService.cs +++ /dev/null @@ -1,308 +0,0 @@ -using Dalamud.Game.ClientState.Objects.Types; -using FFXIVClientStructs.FFXIV.Client.Game.Object; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using OtterGui.Classes; -using OtterGui.Services; -using Penumbra.Collections; -using Penumbra.Collections.Manager; -using Penumbra.Communication; -using Penumbra.GameData.Actors; -using Penumbra.GameData.Interop; -using Penumbra.GameData.Structs; -using Penumbra.Interop.PathResolving; -using Penumbra.Interop.ResourceTree; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods; -using Penumbra.Mods.Groups; -using Penumbra.Mods.Manager; -using Penumbra.Mods.SubMods; -using Penumbra.String.Classes; - -namespace Penumbra.Services; - -public class PcpService : IApiService, IDisposable -{ - public const string Extension = ".pcp"; - - private readonly Configuration _config; - private readonly SaveService _files; - private readonly ResourceTreeFactory _treeFactory; - private readonly ObjectManager _objectManager; - private readonly ActorManager _actors; - private readonly FrameworkManager _framework; - private readonly CollectionResolver _collectionResolver; - private readonly CollectionManager _collections; - private readonly ModCreator _modCreator; - private readonly ModExportManager _modExport; - private readonly CommunicatorService _communicator; - private readonly SHA1 _sha1 = SHA1.Create(); - private readonly ModFileSystem _fileSystem; - private readonly ModManager _mods; - - public PcpService(Configuration config, - SaveService files, - ResourceTreeFactory treeFactory, - ObjectManager objectManager, - ActorManager actors, - FrameworkManager framework, - CollectionManager collections, - CollectionResolver collectionResolver, - ModCreator modCreator, - ModExportManager modExport, - CommunicatorService communicator, - ModFileSystem fileSystem, - ModManager mods) - { - _config = config; - _files = files; - _treeFactory = treeFactory; - _objectManager = objectManager; - _actors = actors; - _framework = framework; - _collectionResolver = collectionResolver; - _collections = collections; - _modCreator = modCreator; - _modExport = modExport; - _communicator = communicator; - _fileSystem = fileSystem; - _mods = mods; - - _communicator.ModPathChanged.Subscribe(OnModPathChange, ModPathChanged.Priority.PcpService); - } - - public void CleanPcpMods() - { - var mods = _mods.Where(m => m.ModTags.Contains("PCP")).ToList(); - Penumbra.Log.Information($"[PCPService] Deleting {mods.Count} mods containing the tag PCP."); - foreach (var mod in mods) - _mods.DeleteMod(mod); - } - - public void CleanPcpCollections() - { - var collections = _collections.Storage.Where(c => c.Identity.Name.StartsWith("PCP/")).ToList(); - Penumbra.Log.Information($"[PCPService] Deleting {collections.Count} collections starting with PCP/."); - foreach (var collection in collections) - _collections.Storage.RemoveCollection(collection); - } - - private void OnModPathChange(ModPathChangeType type, Mod mod, DirectoryInfo? oldDirectory, DirectoryInfo? newDirectory) - { - if (type is not ModPathChangeType.Added || _config.PcpSettings.DisableHandling || newDirectory is null) - return; - - try - { - var file = Path.Combine(newDirectory.FullName, "character.json"); - if (!File.Exists(file)) - { - // First version had collection.json, changed. - var oldFile = Path.Combine(newDirectory.FullName, "collection.json"); - if (File.Exists(oldFile)) - { - Penumbra.Log.Information("[PCPService] Renaming old PCP file from collection.json to character.json."); - File.Move(oldFile, file, true); - } - else - return; - } - - Penumbra.Log.Information($"[PCPService] Found a PCP file for {mod.Name}, applying."); - var text = File.ReadAllText(file); - var jObj = JObject.Parse(text); - var collection = ModCollection.Empty; - // Create collection. - if (_config.PcpSettings.CreateCollection) - { - var identifier = _actors.FromJson(jObj["Actor"] as JObject); - if (identifier.IsValid && jObj["Collection"]?.ToObject() is { } collectionName) - { - var name = $"PCP/{collectionName}"; - if (_collections.Storage.AddCollection(name, null)) - { - collection = _collections.Storage[^1]; - _collections.Editor.SetModState(collection, mod, true); - - // Assign collection. - if (_config.PcpSettings.AssignCollection) - { - var identifierGroup = _collections.Active.Individuals.GetGroup(identifier); - _collections.Active.SetCollection(collection, CollectionType.Individual, identifierGroup); - } - } - } - } - - // Move to folder. - if (_fileSystem.TryGetValue(mod, out var leaf)) - { - try - { - var folder = _fileSystem.FindOrCreateAllFolders(_config.PcpSettings.FolderName); - _fileSystem.Move(leaf, folder); - } - catch - { - // ignored. - } - } - - // Invoke IPC. - if (_config.PcpSettings.AllowIpc) - _communicator.PcpParsing.Invoke(jObj, mod.Identifier, collection.Identity.Id); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Error reading the character.json file from {mod.Identifier}:\n{ex}"); - } - } - - public void Dispose() - => _communicator.ModPathChanged.Unsubscribe(OnModPathChange); - - public async Task<(bool, string)> CreatePcp(ObjectIndex objectIndex, string note = "", CancellationToken cancel = default) - { - try - { - Penumbra.Log.Information($"[PCPService] Creating PCP file for game object {objectIndex.Index}."); - var (identifier, tree, meta) = await _framework.Framework.RunOnFrameworkThread(() => - { - var (actor, identifier) = CheckActor(objectIndex); - cancel.ThrowIfCancellationRequested(); - unsafe - { - var collection = _collectionResolver.IdentifyCollection((GameObject*)actor.Address, true); - if (!collection.Valid || !collection.ModCollection.HasCache) - throw new Exception($"Actor {identifier} has no mods applying, nothing to do."); - - cancel.ThrowIfCancellationRequested(); - if (_treeFactory.FromCharacter(actor, 0) is not { } tree) - throw new Exception($"Unable to fetch modded resources for {identifier}."); - - var meta = new MetaDictionary(collection.ModCollection.MetaCache, actor.Address); - return (identifier.CreatePermanent(), tree, meta); - } - }); - cancel.ThrowIfCancellationRequested(); - var time = DateTime.Now; - var modDirectory = CreateMod(identifier, note, time); - await CreateDefaultMod(modDirectory, meta, tree, cancel); - await CreateCollectionInfo(modDirectory, objectIndex, identifier, note, time, cancel); - var file = ZipUp(modDirectory); - return (true, file); - } - catch (Exception ex) - { - return (false, ex.Message); - } - } - - private static string ZipUp(DirectoryInfo directory) - { - var fileName = directory.FullName + Extension; - ZipFile.CreateFromDirectory(directory.FullName, fileName, CompressionLevel.Optimal, false); - directory.Delete(true); - return fileName; - } - - private async Task CreateCollectionInfo(DirectoryInfo directory, ObjectIndex index, ActorIdentifier actor, string note, DateTime time, - CancellationToken cancel = default) - { - var jObj = new JObject - { - ["Version"] = 1, - ["Actor"] = actor.ToJson(), - ["Mod"] = directory.Name, - ["Collection"] = note.Length > 0 ? $"{actor.ToName()}: {note}" : actor.ToName(), - ["Time"] = time, - ["Note"] = note, - }; - if (note.Length > 0) - cancel.ThrowIfCancellationRequested(); - if (_config.PcpSettings.AllowIpc) - await _framework.Framework.RunOnFrameworkThread(() => _communicator.PcpCreation.Invoke(jObj, index.Index, directory.FullName)); - var filePath = Path.Combine(directory.FullName, "character.json"); - await using var file = File.Open(filePath, File.Exists(filePath) ? FileMode.Truncate : FileMode.CreateNew); - await using var stream = new StreamWriter(file); - await using var json = new JsonTextWriter(stream); - json.Formatting = Formatting.Indented; - await jObj.WriteToAsync(json, cancel); - } - - private DirectoryInfo CreateMod(ActorIdentifier actor, string note, DateTime time) - { - var directory = _modExport.ExportDirectory; - directory.Create(); - var actorName = actor.ToName(); - var authorName = _actors.GetCurrentPlayer().ToName(); - var suffix = note.Length > 0 - ? note - : time.ToString("yyyy-MM-ddTHH\\:mm", CultureInfo.InvariantCulture); - var modName = $"{actorName} - {suffix}"; - var description = $"On-Screen Data for {actorName} as snapshotted on {time}."; - return _modCreator.CreateEmptyMod(directory, modName, description, authorName, "PCP") - ?? throw new Exception($"Unable to create mod {modName} in {directory.FullName}."); - } - - private async Task CreateDefaultMod(DirectoryInfo modDirectory, MetaDictionary meta, ResourceTree tree, - CancellationToken cancel = default) - { - var subDirectory = modDirectory.CreateSubdirectory("files"); - var subMod = new DefaultSubMod(null!) - { - Manipulations = meta, - }; - - foreach (var node in tree.FlatNodes) - { - cancel.ThrowIfCancellationRequested(); - var gamePath = node.GamePath; - var fullPath = node.FullPath; - if (fullPath.IsRooted) - { - var hash = await _sha1.ComputeHashAsync(File.OpenRead(fullPath.FullName), cancel).ConfigureAwait(false); - cancel.ThrowIfCancellationRequested(); - var name = Convert.ToHexString(hash) + fullPath.Extension; - var newFile = Path.Combine(subDirectory.FullName, name); - if (!File.Exists(newFile)) - File.Copy(fullPath.FullName, newFile); - subMod.Files.TryAdd(gamePath, new FullPath(newFile)); - } - else if (gamePath.Path != fullPath.InternalName) - { - subMod.FileSwaps.TryAdd(gamePath, fullPath); - } - } - - cancel.ThrowIfCancellationRequested(); - - var saveGroup = new ModSaveGroup(modDirectory, subMod, _config.ReplaceNonAsciiOnImport); - var filePath = _files.FileNames.OptionGroupFile(modDirectory.FullName, -1, string.Empty, _config.ReplaceNonAsciiOnImport); - cancel.ThrowIfCancellationRequested(); - await using var fileStream = File.Open(filePath, File.Exists(filePath) ? FileMode.Truncate : FileMode.CreateNew); - await using var writer = new StreamWriter(fileStream); - saveGroup.Save(writer); - } - - private (ICharacter Actor, ActorIdentifier Identifier) CheckActor(ObjectIndex objectIndex) - { - var actor = _objectManager[objectIndex]; - if (!actor.Valid) - throw new Exception($"No Actor at index {objectIndex} found."); - - if (!actor.Identifier(_actors, out var identifier)) - throw new Exception($"Could not create valid identifier for actor at index {objectIndex}."); - - if (!actor.IsCharacter) - throw new Exception($"Actor {identifier} at index {objectIndex} is not a valid character."); - - if (!actor.Model.Valid) - throw new Exception($"Actor {identifier} at index {objectIndex} has no model."); - - if (_objectManager.Objects.CreateObjectReference(actor.Address) is not ICharacter character) - throw new Exception($"Actor {identifier} at index {objectIndex} could not be converted to ICharacter"); - - return (character, identifier); - } -} diff --git a/Penumbra/Services/StainService.cs b/Penumbra/Services/StainService.cs index 17294aa8..26b39229 100644 --- a/Penumbra/Services/StainService.cs +++ b/Penumbra/Services/StainService.cs @@ -1,37 +1,30 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; using Dalamud.Interface.Utility.Raii; using Dalamud.Plugin.Services; +using ImGuiNET; using OtterGui.Services; using OtterGui.Widgets; using Penumbra.GameData.DataContainers; using Penumbra.GameData.Files; -using Penumbra.GameData.Files.StainMapStructs; -using Penumbra.Interop.Services; -using Penumbra.Interop.Structs; -using Penumbra.UI.AdvancedWindow.Materials; +using Penumbra.UI.AdvancedWindow; namespace Penumbra.Services; public class StainService : IService { - public sealed class StainTemplateCombo(FilterComboColors[] stainCombos, StmFile stmFile) - : FilterComboCache(stmFile.Entries.Keys.Prepend(0), MouseWheelType.None, Penumbra.Log) - where TDyePack : unmanaged, IDyePack + public sealed class StainTemplateCombo(FilterComboColors stainCombo, StmFile stmFile) + : FilterComboCache(stmFile.Entries.Keys.Prepend((ushort)0), MouseWheelType.None, Penumbra.Log) { - // FIXME There might be a better way to handle that. - public int CurrentDyeChannel = 0; - protected override float GetFilterWidth() { var baseSize = ImGui.CalcTextSize("0000").X + ImGui.GetStyle().ScrollbarSize + ImGui.GetStyle().ItemInnerSpacing.X; - if (stainCombos[CurrentDyeChannel].CurrentSelection.Key == 0) + if (stainCombo.CurrentSelection.Key == 0) return baseSize; return baseSize + ImGui.GetTextLineHeight() * 3 + ImGui.GetStyle().ItemInnerSpacing.X * 3; } - protected override string ToString(StmKeyType obj) + protected override string ToString(ushort obj) => $"{obj,4}"; protected override void DrawFilter(int currentSelected, float width) @@ -54,85 +47,33 @@ public class StainService : IService protected override bool DrawSelectable(int globalIdx, bool selected) { var ret = base.DrawSelectable(globalIdx, selected); - var selection = stainCombos[CurrentDyeChannel].CurrentSelection.Key; + var selection = stainCombo.CurrentSelection.Key; if (selection == 0 || !stmFile.TryGetValue(Items[globalIdx], selection, out var colors)) return ret; ImGui.SameLine(); var frame = new Vector2(ImGui.GetTextLineHeight()); - ImGui.ColorButton("D", new Vector4(MtrlTab.PseudoSqrtRgb((Vector3)colors.DiffuseColor), 1), 0, frame); + ImGui.ColorButton("D", new Vector4(ModEditWindow.PseudoSqrtRgb(colors.Diffuse), 1), 0, frame); ImGui.SameLine(); - ImGui.ColorButton("S", new Vector4(MtrlTab.PseudoSqrtRgb((Vector3)colors.SpecularColor), 1), 0, frame); + ImGui.ColorButton("S", new Vector4(ModEditWindow.PseudoSqrtRgb(colors.Specular), 1), 0, frame); ImGui.SameLine(); - ImGui.ColorButton("E", new Vector4(MtrlTab.PseudoSqrtRgb((Vector3)colors.EmissiveColor), 1), 0, frame); + ImGui.ColorButton("E", new Vector4(ModEditWindow.PseudoSqrtRgb(colors.Emissive), 1), 0, frame); return ret; } } - public const int ChannelCount = 2; + public readonly DictStain StainData; + public readonly FilterComboColors StainCombo; + public readonly StmFile StmFile; + public readonly StainTemplateCombo TemplateCombo; - public readonly DictStain StainData; - public readonly FilterComboColors StainCombo1; - public readonly FilterComboColors StainCombo2; // FIXME is there a better way to handle this? - public readonly StmFile LegacyStmFile; - public readonly StmFile GudStmFile; - public readonly StainTemplateCombo LegacyTemplateCombo; - public readonly StainTemplateCombo GudTemplateCombo; - - public unsafe StainService(IDataManager dataManager, CharacterUtility characterUtility, DictStain stainData) + public StainService(IDataManager dataManager, DictStain stainData) { - StainData = stainData; - StainCombo1 = CreateStainCombo(); - StainCombo2 = CreateStainCombo(); - - if (characterUtility.Address == null) - { - LegacyStmFile = LoadStmFile(null, dataManager); - GudStmFile = LoadStmFile(null, dataManager); - } - else - { - LegacyStmFile = LoadStmFile(characterUtility.Address->LegacyStmResource, dataManager); - GudStmFile = LoadStmFile(characterUtility.Address->GudStmResource, dataManager); - } - - - FilterComboColors[] stainCombos = [StainCombo1, StainCombo2]; - - LegacyTemplateCombo = new StainTemplateCombo(stainCombos, LegacyStmFile); - GudTemplateCombo = new StainTemplateCombo(stainCombos, GudStmFile); - } - - /// Retrieves the instance for the given channel. Indexing is zero-based. - public FilterComboColors GetStainCombo(int channel) - => channel switch - { - 0 => StainCombo1, - 1 => StainCombo2, - _ => throw new ArgumentOutOfRangeException(nameof(channel), channel, - $"Unsupported dye channel {channel} (supported values are 0 and 1)"), - }; - - /// Loads a STM file. Opportunistically attempts to re-use the file already read by the game, with Lumina fallback. - private static unsafe StmFile LoadStmFile(ResourceHandle* stmResourceHandle, IDataManager dataManager) - where TDyePack : unmanaged, IDyePack - { - if (stmResourceHandle != null) - { - var stmData = stmResourceHandle->CsHandle.GetDataSpan(); - if (stmData.Length > 0) - { - Penumbra.Log.Debug($"[StainService] Loading StmFile<{typeof(TDyePack)}> from ResourceHandle 0x{(nint)stmResourceHandle:X}"); - return new StmFile(stmData); - } - } - - Penumbra.Log.Debug($"[StainService] Loading StmFile<{typeof(TDyePack)}> from Lumina"); - return new StmFile(dataManager); - } - - private FilterComboColors CreateStainCombo() - => new(140, MouseWheelType.None, - () => StainData.Value.Prepend(new KeyValuePair(0, ("None", 0, false))).ToList(), + StainData = stainData; + StainCombo = new FilterComboColors(140, MouseWheelType.None, + () => StainData.Value.Prepend(new KeyValuePair(0, ("None", 0, false))).ToList(), Penumbra.Log); + StmFile = new StmFile(dataManager); + TemplateCombo = new StainTemplateCombo(StainCombo, StmFile); + } } diff --git a/Penumbra/Services/StaticServiceManager.cs b/Penumbra/Services/StaticServiceManager.cs index be482d1d..0c6648ba 100644 --- a/Penumbra/Services/StaticServiceManager.cs +++ b/Penumbra/Services/StaticServiceManager.cs @@ -5,50 +5,69 @@ using Dalamud.Plugin; using Dalamud.Plugin.Services; using Microsoft.Extensions.DependencyInjection; using OtterGui; +using OtterGui.Classes; using OtterGui.Log; using OtterGui.Services; +using Penumbra.Api; using Penumbra.Api.Api; +using Penumbra.Collections.Cache; +using Penumbra.Collections.Manager; using Penumbra.GameData.Actors; +using Penumbra.Import.Models; using Penumbra.GameData.Structs; +using Penumbra.Import.Textures; using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceLoading; +using Penumbra.Interop.ResourceTree; +using Penumbra.Interop.Services; using Penumbra.Meta; +using Penumbra.Mods; +using Penumbra.Mods.Editor; using Penumbra.Mods.Manager; +using Penumbra.UI; +using Penumbra.UI.AdvancedWindow; +using Penumbra.UI.Classes; +using Penumbra.UI.ModsTab; +using Penumbra.UI.ResourceWatcher; +using Penumbra.UI.Tabs; +using Penumbra.UI.Tabs.Debug; using IPenumbraApi = Penumbra.Api.Api.IPenumbraApi; +using MdlMaterialEditor = Penumbra.Mods.Editor.MdlMaterialEditor; +using ResidentResourceManager = Penumbra.Interop.Services.ResidentResourceManager; +using Penumbra.Api.IpcTester; namespace Penumbra.Services; -#pragma warning disable SeStringEvaluator - public static class StaticServiceManager { - public static ServiceManager CreateProvider(Penumbra penumbra, IDalamudPluginInterface pi, Logger log) + public static ServiceManager CreateProvider(Penumbra penumbra, DalamudPluginInterface pi, Logger log) { var services = new ServiceManager(log) .AddDalamudServices(pi) .AddExistingService(log) - .AddExistingService(penumbra); + .AddExistingService(penumbra) + .AddInterop() + .AddConfiguration() + .AddCollections() + .AddMods() + .AddResources() + .AddResolvers() + .AddInterface() + .AddModEditor() + .AddApi(); services.AddIServices(typeof(EquipItem).Assembly); services.AddIServices(typeof(Penumbra).Assembly); services.AddIServices(typeof(ImGuiUtil).Assembly); - services.AddSingleton(p => - { - var cutsceneService = p.GetRequiredService(); - return new CutsceneResolver(cutsceneService.GetParentIndex); - }) - .AddSingleton(p => p.GetRequiredService().ImcChecker) - .AddSingleton(s => (ModStorage)s.GetRequiredService()) - .AddSingleton(x => x.GetRequiredService()); services.CreateProvider(); return services; } - private static ServiceManager AddDalamudServices(this ServiceManager services, IDalamudPluginInterface pi) + private static ServiceManager AddDalamudServices(this ServiceManager services, DalamudPluginInterface pi) => services.AddExistingService(pi) .AddExistingService(pi.UiBuilder) .AddDalamudService(pi) .AddDalamudService(pi) .AddDalamudService(pi) - .AddDalamudService(pi) .AddDalamudService(pi) .AddDalamudService(pi) .AddDalamudService(pi) @@ -63,6 +82,120 @@ public static class StaticServiceManager .AddDalamudService(pi) .AddDalamudService(pi) .AddDalamudService(pi) - .AddDalamudService(pi) - .AddDalamudService(pi); + .AddDalamudService(pi); + + private static ServiceManager AddInterop(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton(p => + { + var cutsceneService = p.GetRequiredService(); + return new CutsceneResolver(cutsceneService.GetParentIndex); + }) + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(p => p.GetRequiredService().ImcChecker); + + private static ServiceManager AddConfiguration(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton(); + + private static ServiceManager AddCollections(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(); + + private static ServiceManager AddMods(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(s => (ModStorage)s.GetRequiredService()); + + private static ServiceManager AddResources(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(); + + private static ServiceManager AddResolvers(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(); + + private static ServiceManager AddInterface(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(p => new Diagnostics(p)); + + private static ServiceManager AddModEditor(this ServiceManager services) + => services.AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton() + .AddSingleton(); + + private static ServiceManager AddApi(this ServiceManager services) + => services.AddSingleton(x => x.GetRequiredService()); } diff --git a/Penumbra/Services/ValidityChecker.cs b/Penumbra/Services/ValidityChecker.cs index 5feeab02..cc70306b 100644 --- a/Penumbra/Services/ValidityChecker.cs +++ b/Penumbra/Services/ValidityChecker.cs @@ -1,4 +1,4 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Plugin; using FFXIVClientStructs.FFXIV.Client.System.Framework; using OtterGui.Classes; @@ -27,11 +27,11 @@ public class ValidityChecker : IService get { var framework = Framework.Instance(); - return framework == null ? string.Empty : framework->GameVersionString; + return framework == null ? string.Empty : framework->GameVersion[0]; } } - public ValidityChecker(IDalamudPluginInterface pi) + public ValidityChecker(DalamudPluginInterface pi) { DevPenumbraExists = CheckDevPluginPenumbra(pi); IsNotInstalledPenumbra = CheckIsNotInstalled(pi); @@ -45,12 +45,12 @@ public class ValidityChecker : IService public void LogExceptions() { if (ImcExceptions.Count > 0) - Penumbra.Messager.NotificationMessage($"{ImcExceptions.Count} IMC Exceptions thrown during Penumbra load. Please repair your game files.", + Penumbra.Messager.NotificationMessage($"{ImcExceptions} IMC Exceptions thrown during Penumbra load. Please repair your game files.", NotificationType.Warning); } // Because remnants of penumbra in devPlugins cause issues, we check for them to warn users to remove them. - private static bool CheckDevPluginPenumbra(IDalamudPluginInterface pi) + private static bool CheckDevPluginPenumbra(DalamudPluginInterface pi) { #if !DEBUG var path = Path.Combine(pi.DalamudAssetDirectory.Parent?.FullName ?? "INVALIDPATH", "devPlugins", "Penumbra"); @@ -71,7 +71,7 @@ public class ValidityChecker : IService } // Check if the loaded version of Penumbra itself is in devPlugins. - private static bool CheckIsNotInstalled(IDalamudPluginInterface pi) + private static bool CheckIsNotInstalled(DalamudPluginInterface pi) { #if !DEBUG var checkedDirectory = pi.AssemblyLocation.Directory?.Parent?.Parent?.Name; @@ -86,7 +86,7 @@ public class ValidityChecker : IService } // Check if the loaded version of Penumbra is installed from a valid source repo. - private static bool CheckSourceRepo(IDalamudPluginInterface pi) + private static bool CheckSourceRepo(DalamudPluginInterface pi) { #if !DEBUG return pi.SourceRepository?.Trim().ToLowerInvariant() switch diff --git a/Penumbra/UI/AdvancedWindow/FileEditor.cs b/Penumbra/UI/AdvancedWindow/FileEditor.cs index 424bc56f..c95884c6 100644 --- a/Penumbra/UI/AdvancedWindow/FileEditor.cs +++ b/Penumbra/UI/AdvancedWindow/FileEditor.cs @@ -1,14 +1,12 @@ using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Compression; using OtterGui.Raii; -using OtterGui.Text; using OtterGui.Widgets; -using Penumbra.GameData.Data; using Penumbra.GameData.Files; using Penumbra.Mods.Editor; using Penumbra.Services; @@ -81,7 +79,7 @@ public class FileEditor( private Exception? _currentException; private bool _changed; - private string _defaultPath = typeof(T) == typeof(ModEditWindow.PbdTab) ? GamePaths.Pbd.Path : string.Empty; + private string _defaultPath = string.Empty; private bool _inInput; private Utf8GamePath _defaultPathUtf8; private bool _isDefaultPathUtf8Valid; @@ -100,7 +98,7 @@ public class FileEditor( _inInput = ImGui.IsItemActive(); if (ImGui.IsItemDeactivatedAfterEdit() && _defaultPath.Length > 0) { - _isDefaultPathUtf8Valid = Utf8GamePath.FromString(_defaultPath, out _defaultPathUtf8); + _isDefaultPathUtf8Valid = Utf8GamePath.FromString(_defaultPath, out _defaultPathUtf8, true); _quickImport = null; fileDialog.Reset(); try @@ -209,15 +207,12 @@ public class FileEditor( var canSave = _changed && _currentFile is { Valid: true }; if (ImGuiUtil.DrawDisabledButton("Save to File", Vector2.Zero, $"Save the selected {fileType} file with all changes applied. This is not revertible.", !canSave)) - SaveFile(); - } - - public void SaveFile() - { - compactor.WriteAllBytes(_currentPath!.File.FullName, _currentFile!.Write()); - if (owner.Mod != null) - communicator.ModFileChanged.Invoke(owner.Mod, _currentPath); - _changed = false; + { + compactor.WriteAllBytes(_currentPath!.File.FullName, _currentFile!.Write()); + if (owner.Mod != null) + communicator.ModFileChanged.Invoke(owner.Mod, _currentPath); + _changed = false; + } } private void ResetButton() @@ -308,7 +303,7 @@ public class FileEditor( foreach (var (option, gamePath) in file.SubModUsage) { ImGui.TableNextColumn(); - ImUtf8.Text(gamePath.Path.Span); + UiHelpers.Text(gamePath.Path); ImGui.TableNextColumn(); using var color = ImRaii.PushColor(ImGuiCol.Text, ColorId.ItemId.Value()); ImGui.TextUnformatted(option.GetFullName()); diff --git a/Penumbra/UI/AdvancedWindow/ItemSwapTab.cs b/Penumbra/UI/AdvancedWindow/ItemSwapTab.cs index e9d76990..6010cdaf 100644 --- a/Penumbra/UI/AdvancedWindow/ItemSwapTab.cs +++ b/Penumbra/UI/AdvancedWindow/ItemSwapTab.cs @@ -1,10 +1,8 @@ -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; +using Dalamud.Interface.Internal.Notifications; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Collections; @@ -13,10 +11,8 @@ using Penumbra.Communication; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; -using Penumbra.Import.Structs; using Penumbra.Meta; using Penumbra.Mods; -using Penumbra.Mods.Editor; using Penumbra.Mods.Groups; using Penumbra.Mods.ItemSwap; using Penumbra.Mods.Manager; @@ -25,11 +21,10 @@ using Penumbra.Mods.Settings; using Penumbra.Mods.SubMods; using Penumbra.Services; using Penumbra.UI.Classes; -using Penumbra.UI.ModsTab; namespace Penumbra.UI.AdvancedWindow; -public class ItemSwapTab : IDisposable, ITab, IUiService +public class ItemSwapTab : IDisposable, ITab { private readonly Configuration _config; private readonly CommunicatorService _communicator; @@ -38,8 +33,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService private readonly MetaFileManager _metaFileManager; public ItemSwapTab(CommunicatorService communicator, ItemData itemService, CollectionManager collectionManager, - ModManager modManager, ModFileSystemSelector selector, ObjectIdentification identifier, MetaFileManager metaFileManager, - Configuration config) + ModManager modManager, ObjectIdentification identifier, MetaFileManager metaFileManager, Configuration config) { _communicator = communicator; _collectionManager = collectionManager; @@ -48,20 +42,18 @@ public class ItemSwapTab : IDisposable, ITab, IUiService _config = config; _swapData = new ItemSwapContainer(metaFileManager, identifier); - var a = collectionManager.Active; _selectors = new Dictionary { // @formatter:off - [SwapType.Hat] = (new ItemSelector(a, itemService, selector, FullEquipType.Head), new ItemSelector(a, itemService, null, FullEquipType.Head), "Take this Hat", "and put it on this one" ), - [SwapType.Top] = (new ItemSelector(a, itemService, selector, FullEquipType.Body), new ItemSelector(a, itemService, null, FullEquipType.Body), "Take this Top", "and put it on this one" ), - [SwapType.Gloves] = (new ItemSelector(a, itemService, selector, FullEquipType.Hands), new ItemSelector(a, itemService, null, FullEquipType.Hands), "Take these Gloves", "and put them on these" ), - [SwapType.Pants] = (new ItemSelector(a, itemService, selector, FullEquipType.Legs), new ItemSelector(a, itemService, null, FullEquipType.Legs), "Take these Pants", "and put them on these" ), - [SwapType.Shoes] = (new ItemSelector(a, itemService, selector, FullEquipType.Feet), new ItemSelector(a, itemService, null, FullEquipType.Feet), "Take these Shoes", "and put them on these" ), - [SwapType.Earrings] = (new ItemSelector(a, itemService, selector, FullEquipType.Ears), new ItemSelector(a, itemService, null, FullEquipType.Ears), "Take these Earrings", "and put them on these" ), - [SwapType.Necklace] = (new ItemSelector(a, itemService, selector, FullEquipType.Neck), new ItemSelector(a, itemService, null, FullEquipType.Neck), "Take this Necklace", "and put it on this one" ), - [SwapType.Bracelet] = (new ItemSelector(a, itemService, selector, FullEquipType.Wrists), new ItemSelector(a, itemService, null, FullEquipType.Wrists), "Take these Bracelets", "and put them on these" ), - [SwapType.Ring] = (new ItemSelector(a, itemService, selector, FullEquipType.Finger), new ItemSelector(a, itemService, null, FullEquipType.Finger), "Take this Ring", "and put it on this one" ), - [SwapType.Glasses] = (new ItemSelector(a, itemService, selector, FullEquipType.Glasses), new ItemSelector(a, itemService, null, FullEquipType.Glasses), "Take these Glasses", "and put them on these" ), + [SwapType.Hat] = (new ItemSelector(itemService, FullEquipType.Head), new ItemSelector(itemService, FullEquipType.Head), "Take this Hat", "and put it on this one" ), + [SwapType.Top] = (new ItemSelector(itemService, FullEquipType.Body), new ItemSelector(itemService, FullEquipType.Body), "Take this Top", "and put it on this one" ), + [SwapType.Gloves] = (new ItemSelector(itemService, FullEquipType.Hands), new ItemSelector(itemService, FullEquipType.Hands), "Take these Gloves", "and put them on these" ), + [SwapType.Pants] = (new ItemSelector(itemService, FullEquipType.Legs), new ItemSelector(itemService, FullEquipType.Legs), "Take these Pants", "and put them on these" ), + [SwapType.Shoes] = (new ItemSelector(itemService, FullEquipType.Feet), new ItemSelector(itemService, FullEquipType.Feet), "Take these Shoes", "and put them on these" ), + [SwapType.Earrings] = (new ItemSelector(itemService, FullEquipType.Ears), new ItemSelector(itemService, FullEquipType.Ears), "Take these Earrings", "and put them on these" ), + [SwapType.Necklace] = (new ItemSelector(itemService, FullEquipType.Neck), new ItemSelector(itemService, FullEquipType.Neck), "Take this Necklace", "and put it on this one" ), + [SwapType.Bracelet] = (new ItemSelector(itemService, FullEquipType.Wrists), new ItemSelector(itemService, FullEquipType.Wrists), "Take these Bracelets", "and put them on these" ), + [SwapType.Ring] = (new ItemSelector(itemService, FullEquipType.Finger), new ItemSelector(itemService, FullEquipType.Finger), "Take this Ring", "and put it on this one" ), // @formatter:on }; @@ -134,38 +126,13 @@ public class ItemSwapTab : IDisposable, ITab, IUiService Ears, Tail, Weapon, - Glasses, } - private class ItemSelector(ActiveCollections collections, ItemData data, ModFileSystemSelector? selector, FullEquipType type) - : FilterComboCache<(EquipItem Item, bool InMod, SingleArray InCollection)>(() => - { - var list = data.ByType[type]; - var enumerable = selector?.Selected is { } mod && mod.ChangedItems.Values.Any(o => o is IdentifiedItem i && i.Item.Type == type) - ? list.Select(i => (i, mod.ChangedItems.ContainsKey(i.Name), collections.Current.ChangedItems.TryGetValue(i.Name, out var m) ? m.Item1 : new SingleArray())) - .OrderByDescending(p => p.Item2).ThenByDescending(p => p.Item3.Count) - : selector is null - ? list.Select(i => (i, false, collections.Current.ChangedItems.TryGetValue(i.Name, out var m) ? m.Item1 : new SingleArray())).OrderBy(p => p.Item3.Count) - : list.Select(i => (i, false, collections.Current.ChangedItems.TryGetValue(i.Name, out var m) ? m.Item1 : new SingleArray())).OrderByDescending(p => p.Item3.Count); - return enumerable.ToList(); - }, MouseWheelType.None, Penumbra.Log) + private class ItemSelector(ItemData data, FullEquipType type) + : FilterComboCache(() => data.ByType[type], MouseWheelType.None, Penumbra.Log) { - protected override bool DrawSelectable(int globalIdx, bool selected) - { - var (_, inMod, inCollection) = Items[globalIdx]; - using var color = inMod - ? ImRaii.PushColor(ImGuiCol.Text, ColorId.ResTreeLocalPlayer.Value()) - : inCollection.Count > 0 - ? ImRaii.PushColor(ImGuiCol.Text, ColorId.ResTreeNonNetworked.Value()) - : null; - var ret = base.DrawSelectable(globalIdx, selected); - if (inCollection.Count > 0) - ImUtf8.HoverTooltip(string.Join('\n', inCollection.Select(m => m.Name.Text))); - return ret; - } - - protected override string ToString((EquipItem Item, bool InMod, SingleArray InCollection) obj) - => obj.Item.Name; + protected override string ToString(EquipItem obj) + => obj.Name; } private readonly Dictionary _selectors; @@ -175,14 +142,14 @@ public class ItemSwapTab : IDisposable, ITab, IUiService private ModSettings? _modSettings; private bool _dirty; - private SwapType _lastTab = SwapType.Hair; - private Gender _currentGender = Gender.Male; - private ModelRace _currentRace = ModelRace.Midlander; - private int _targetId; - private int _sourceId; - private Exception? _loadException; - private BetweenSlotTypes _slotFrom = BetweenSlotTypes.Hat; - private BetweenSlotTypes _slotTo = BetweenSlotTypes.Earrings; + private SwapType _lastTab = SwapType.Hair; + private Gender _currentGender = Gender.Male; + private ModelRace _currentRace = ModelRace.Midlander; + private int _targetId; + private int _sourceId; + private Exception? _loadException; + private EquipSlot _slotFrom = EquipSlot.Head; + private EquipSlot _slotTo = EquipSlot.Ears; private string _newModName = string.Empty; private string _newGroupName = "Swaps"; @@ -194,7 +161,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService private bool _useLeftRing = true; private bool _useRightRing = true; - private HashSet? _affectedItems; + private EquipItem[]? _affectedItems; private void UpdateState() { @@ -217,19 +184,18 @@ public class ItemSwapTab : IDisposable, ITab, IUiService case SwapType.Necklace: case SwapType.Bracelet: case SwapType.Ring: - case SwapType.Glasses: var values = _selectors[_lastTab]; - if (values.Source.CurrentSelection.Item.Type != FullEquipType.Unknown - && values.Target.CurrentSelection.Item.Type != FullEquipType.Unknown) - _affectedItems = _swapData.LoadEquipment(values.Target.CurrentSelection.Item, values.Source.CurrentSelection.Item, + if (values.Source.CurrentSelection.Type != FullEquipType.Unknown + && values.Target.CurrentSelection.Type != FullEquipType.Unknown) + _affectedItems = _swapData.LoadEquipment(values.Target.CurrentSelection, values.Source.CurrentSelection, _useCurrentCollection ? _collectionManager.Active.Current : null, _useRightRing, _useLeftRing); + break; case SwapType.BetweenSlots: var (_, _, selectorFrom) = GetAccessorySelector(_slotFrom, true); var (_, _, selectorTo) = GetAccessorySelector(_slotTo, false); - if (selectorFrom.CurrentSelection.Item.Valid && selectorTo.CurrentSelection.Item.Valid) - _affectedItems = _swapData.LoadTypeSwap(ToEquipSlot(_slotTo), selectorTo.CurrentSelection.Item, ToEquipSlot(_slotFrom), - selectorFrom.CurrentSelection.Item, + if (selectorFrom.CurrentSelection.Valid && selectorTo.CurrentSelection.Valid) + _affectedItems = _swapData.LoadTypeSwap(_slotTo, selectorTo.CurrentSelection, _slotFrom, selectorFrom.CurrentSelection, _useCurrentCollection ? _collectionManager.Active.Current : null); break; case SwapType.Hair when _targetId > 0 && _sourceId > 0: @@ -274,7 +240,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService { return swap switch { - IMetaSwap meta => $"{meta.SwapFromIdentifier}: {meta.SwapFromDefaultEntry} -> {meta.SwapToModdedEntry}", + MetaSwap meta => $"{meta.SwapFrom}: {meta.SwapFrom.EntryToString()} -> {meta.SwapApplied.EntryToString()}", FileSwap file => $"{file.Type}: {file.SwapFromRequestPath} -> {file.SwapToModded.FullName}{(file.DataWasChanged ? " (EDITED)" : string.Empty)}", _ => string.Empty, @@ -282,45 +248,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService } private string CreateDescription() - { - switch (_lastTab) - { - case SwapType.Ears: - case SwapType.Face: - case SwapType.Hair: - case SwapType.Tail: - return - $"Created by swapping {_lastTab} {_sourceId} onto {_lastTab} {_targetId} for {_currentRace.ToName()} {_currentGender.ToName()}s in {_mod!.Name}{OriginalAuthor()}"; - case SwapType.BetweenSlots: - return - $"Created by swapping {GetAccessorySelector(_slotFrom, true).Item3.CurrentSelection.Item.Name} onto {GetAccessorySelector(_slotTo, false).Item3.CurrentSelection.Item.Name} in {_mod!.Name}{OriginalAuthor()}"; - default: - return - $"Created by swapping {_selectors[_lastTab].Source.CurrentSelection.Item.Name} onto {_selectors[_lastTab].Target.CurrentSelection.Item.Name} in {_mod!.Name}{OriginalAuthor()}"; - } - } - - private string OriginalAuthor() - { - if (_mod!.Author.IsEmpty || _mod!.Author.Text is "TexTools User" or DefaultTexToolsData.Author) - return "."; - - return $" by {_mod!.Author}."; - } - - private string CreateAuthor() - { - if (_mod!.Author.IsEmpty) - return _config.DefaultModAuthor; - if (_mod!.Author.Text == _config.DefaultModAuthor) - return _config.DefaultModAuthor; - if (_mod!.Author.Text is "TexTools User" or DefaultTexToolsData.Author) - return _config.DefaultModAuthor; - if (_config.DefaultModAuthor is DefaultTexToolsData.Author) - return _mod!.Author; - - return $"{_mod!.Author} (Swap by {_config.DefaultModAuthor})"; - } + => $"Created by swapping {_lastTab} {_sourceId} onto {_lastTab} {_targetId} for {_currentRace.ToName()} {_currentGender.ToName()}s in {_mod!.Name}."; private void UpdateOption() { @@ -333,11 +261,11 @@ public class ItemSwapTab : IDisposable, ITab, IUiService private void CreateMod() { - var newDir = _modManager.Creator.CreateEmptyMod(_modManager.BasePath, _newModName, CreateDescription(), CreateAuthor()); + var newDir = _modManager.Creator.CreateEmptyMod(_modManager.BasePath, _newModName, CreateDescription()); if (newDir == null) return; - _modManager.AddMod(newDir, false); + _modManager.AddMod(newDir); var mod = _modManager[^1]; if (!_swapData.WriteMod(_modManager, mod, mod.Default, _useFileSwaps ? ItemSwapContainer.WriteType.UseSwaps : ItemSwapContainer.WriteType.NoSwaps)) @@ -472,7 +400,6 @@ public class ItemSwapTab : IDisposable, ITab, IUiService DrawEquipmentSwap(SwapType.Necklace); DrawEquipmentSwap(SwapType.Bracelet); DrawEquipmentSwap(SwapType.Ring); - DrawEquipmentSwap(SwapType.Glasses); DrawAccessorySwap(); DrawHairSwap(); //DrawFaceSwap(); @@ -483,7 +410,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService private ImRaii.IEndObject DrawTab(SwapType newTab) { - var tab = ImRaii.TabItem(newTab is SwapType.BetweenSlots ? "Between Slots" : newTab.ToString()); + using var tab = ImRaii.TabItem(newTab is SwapType.BetweenSlots ? "Between Slots" : newTab.ToString()); if (tab) { _dirty |= _lastTab != newTab; @@ -511,24 +438,23 @@ public class ItemSwapTab : IDisposable, ITab, IUiService ImGui.TableNextColumn(); ImGui.SetNextItemWidth(100 * UiHelpers.Scale); - using (var combo = ImRaii.Combo("##fromType", ToName(_slotFrom))) + using (var combo = ImRaii.Combo("##fromType", _slotFrom is EquipSlot.Head ? "Hat" : _slotFrom.ToName())) { if (combo) - foreach (var slot in Enum.GetValues()) + foreach (var slot in EquipSlotExtensions.AccessorySlots.Prepend(EquipSlot.Head)) { - if (!ImGui.Selectable(ToName(slot), slot == _slotFrom) || slot == _slotFrom) + if (!ImGui.Selectable(slot is EquipSlot.Head ? "Hat" : slot.ToName(), slot == _slotFrom) || slot == _slotFrom) continue; _dirty = true; _slotFrom = slot; if (slot == _slotTo) - _slotTo = AvailableToTypes.First(s => slot != s); + _slotTo = EquipSlotExtensions.AccessorySlots.First(s => slot != s); } } ImGui.TableNextColumn(); - _dirty |= selector.Draw("##itemSource", selector.CurrentSelection.Item.Name ?? string.Empty, string.Empty, - InputWidth * 2 * UiHelpers.Scale, + _dirty |= selector.Draw("##itemSource", selector.CurrentSelection.Name ?? string.Empty, string.Empty, InputWidth * 2 * UiHelpers.Scale, ImGui.GetTextLineHeightWithSpacing()); (article1, _, selector) = GetAccessorySelector(_slotTo, false); @@ -538,12 +464,12 @@ public class ItemSwapTab : IDisposable, ITab, IUiService ImGui.TableNextColumn(); ImGui.SetNextItemWidth(100 * UiHelpers.Scale); - using (var combo = ImRaii.Combo("##toType", ToName(_slotTo))) + using (var combo = ImRaii.Combo("##toType", _slotTo.ToName())) { if (combo) - foreach (var slot in AvailableToTypes.Where(t => t != _slotFrom)) + foreach (var slot in EquipSlotExtensions.AccessorySlots.Where(s => s != _slotFrom)) { - if (!ImGui.Selectable(ToName(slot), slot == _slotTo) || slot == _slotTo) + if (!ImGui.Selectable(slot.ToName(), slot == _slotTo) || slot == _slotTo) continue; _dirty = true; @@ -553,31 +479,30 @@ public class ItemSwapTab : IDisposable, ITab, IUiService ImGui.TableNextColumn(); - _dirty |= selector.Draw("##itemTarget", selector.CurrentSelection.Item.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, + _dirty |= selector.Draw("##itemTarget", selector.CurrentSelection.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, ImGui.GetTextLineHeightWithSpacing()); - if (_affectedItems is not { Count: > 1 }) + if (_affectedItems is not { Length: > 1 }) return; ImGui.SameLine(); - ImGuiUtil.DrawTextButton($"which will also affect {_affectedItems.Count - 1} other Items.", Vector2.Zero, + ImGuiUtil.DrawTextButton($"which will also affect {_affectedItems.Length - 1} other Items.", Vector2.Zero, Colors.PressEnterWarningBg); if (ImGui.IsItemHovered()) - ImGui.SetTooltip(string.Join('\n', _affectedItems.Where(i => !ReferenceEquals(i.Name, selector.CurrentSelection.Item.Name)) + ImGui.SetTooltip(string.Join('\n', _affectedItems.Where(i => !ReferenceEquals(i.Name, selector.CurrentSelection.Name)) .Select(i => i.Name))); } - private (string, string, ItemSelector) GetAccessorySelector(BetweenSlotTypes slot, bool source) + private (string, string, ItemSelector) GetAccessorySelector(EquipSlot slot, bool source) { var (type, article1, article2) = slot switch { - BetweenSlotTypes.Hat => (SwapType.Hat, "this", "it"), - BetweenSlotTypes.Earrings => (SwapType.Earrings, "these", "them"), - BetweenSlotTypes.Necklace => (SwapType.Necklace, "this", "it"), - BetweenSlotTypes.Bracelets => (SwapType.Bracelet, "these", "them"), - BetweenSlotTypes.RightRing => (SwapType.Ring, "this", "it"), - BetweenSlotTypes.LeftRing => (SwapType.Ring, "this", "it"), - BetweenSlotTypes.Glasses => (SwapType.Glasses, "these", "them"), - _ => (SwapType.Ring, "this", "it"), + EquipSlot.Head => (SwapType.Hat, "this", "it"), + EquipSlot.Ears => (SwapType.Earrings, "these", "them"), + EquipSlot.Neck => (SwapType.Necklace, "this", "it"), + EquipSlot.Wrists => (SwapType.Bracelet, "these", "them"), + EquipSlot.RFinger => (SwapType.Ring, "this", "it"), + EquipSlot.LFinger => (SwapType.Ring, "this", "it"), + _ => (SwapType.Ring, "this", "it"), }; var (itemSelector, target, _, _) = _selectors[type]; return (article1, article2, source ? itemSelector : target); @@ -595,7 +520,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService ImGui.AlignTextToFramePadding(); ImGui.TextUnformatted(text1); ImGui.TableNextColumn(); - _dirty |= sourceSelector.Draw("##itemSource", sourceSelector.CurrentSelection.Item.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, + _dirty |= sourceSelector.Draw("##itemSource", sourceSelector.CurrentSelection.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, ImGui.GetTextLineHeightWithSpacing()); if (type == SwapType.Ring) @@ -608,7 +533,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService ImGui.AlignTextToFramePadding(); ImGui.TextUnformatted(text2); ImGui.TableNextColumn(); - _dirty |= targetSelector.Draw("##itemTarget", targetSelector.CurrentSelection.Item.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, + _dirty |= targetSelector.Draw("##itemTarget", targetSelector.CurrentSelection.Name, string.Empty, InputWidth * 2 * UiHelpers.Scale, ImGui.GetTextLineHeightWithSpacing()); if (type == SwapType.Ring) { @@ -616,14 +541,14 @@ public class ItemSwapTab : IDisposable, ITab, IUiService _dirty |= ImGui.Checkbox("Swap Left Ring", ref _useLeftRing); } - if (_affectedItems is not { Count: > 1 }) + if (_affectedItems is not { Length: > 1 }) return; ImGui.SameLine(); - ImGuiUtil.DrawTextButton($"which will also affect {_affectedItems.Count - 1} other Items.", Vector2.Zero, + ImGuiUtil.DrawTextButton($"which will also affect {_affectedItems.Length - 1} other Items.", Vector2.Zero, Colors.PressEnterWarningBg); if (ImGui.IsItemHovered()) - ImGui.SetTooltip(string.Join('\n', _affectedItems.Where(i => !ReferenceEquals(i.Name, targetSelector.CurrentSelection.Item.Name)) + ImGui.SetTooltip(string.Join('\n', _affectedItems.Where(i => !ReferenceEquals(i.Name, targetSelector.CurrentSelection.Name)) .Select(i => i.Name))); } @@ -748,7 +673,6 @@ public class ItemSwapTab : IDisposable, ITab, IUiService SwapType.Necklace => "One of the selected necklaces does not seem to exist.", SwapType.Bracelet => "One of the selected bracelets does not seem to exist.", SwapType.Ring => "One of the selected rings does not seem to exist.", - SwapType.Glasses => "One of the selected glasses does not seem to exist.", SwapType.Hair => "One of the selected hairstyles does not seem to exist for this gender and race combo.", SwapType.Face => "One of the selected faces does not seem to exist for this gender and race combo.", SwapType.Ears => "One of the selected ear types does not seem to exist for this gender and race combo.", @@ -774,12 +698,12 @@ public class ItemSwapTab : IDisposable, ITab, IUiService if (collectionType is not CollectionType.Current || _mod == null || newCollection == null) return; - UpdateMod(_mod, _mod.Index < newCollection.Settings.Count ? newCollection.GetInheritedSettings(_mod.Index).Settings : null); + UpdateMod(_mod, _mod.Index < newCollection.Settings.Count ? newCollection[_mod.Index].Settings : null); } private void OnSettingChange(ModCollection collection, ModSettingChange type, Mod? mod, Setting oldValue, int groupIdx, bool inherited) { - if (collection != _collectionManager.Active.Current || mod != _mod || type is ModSettingChange.TemporarySetting) + if (collection != _collectionManager.Active.Current || mod != _mod) return; _swapData.LoadMod(_mod, _modSettings); @@ -791,7 +715,7 @@ public class ItemSwapTab : IDisposable, ITab, IUiService if (collection != _collectionManager.Active.Current || _mod == null) return; - UpdateMod(_mod, collection.GetInheritedSettings(_mod.Index).Settings); + UpdateMod(_mod, collection[_mod.Index].Settings); _swapData.LoadMod(_mod, _modSettings); _dirty = true; } @@ -806,44 +730,4 @@ public class ItemSwapTab : IDisposable, ITab, IUiService UpdateOption(); _dirty = true; } - - private enum BetweenSlotTypes - { - Hat, - Earrings, - Necklace, - Bracelets, - RightRing, - LeftRing, - Glasses, - } - - private static EquipSlot ToEquipSlot(BetweenSlotTypes type) - => type switch - { - BetweenSlotTypes.Hat => EquipSlot.Head, - BetweenSlotTypes.Earrings => EquipSlot.Ears, - BetweenSlotTypes.Necklace => EquipSlot.Neck, - BetweenSlotTypes.Bracelets => EquipSlot.Wrists, - BetweenSlotTypes.RightRing => EquipSlot.RFinger, - BetweenSlotTypes.LeftRing => EquipSlot.LFinger, - BetweenSlotTypes.Glasses => BonusItemFlag.Glasses.ToEquipSlot(), - _ => EquipSlot.Unknown, - }; - - private static string ToName(BetweenSlotTypes type) - => type switch - { - BetweenSlotTypes.Hat => "Hat", - BetweenSlotTypes.Earrings => "Earrings", - BetweenSlotTypes.Necklace => "Necklace", - BetweenSlotTypes.Bracelets => "Bracelets", - BetweenSlotTypes.RightRing => "Right Ring", - BetweenSlotTypes.LeftRing => "Left Ring", - BetweenSlotTypes.Glasses => "Glasses", - _ => "Unknown", - }; - - private static readonly IReadOnlyList AvailableToTypes = - Enum.GetValues().Where(s => s is not BetweenSlotTypes.Hat).ToArray(); } diff --git a/Penumbra/UI/AdvancedWindow/Materials/ConstantEditors.cs b/Penumbra/UI/AdvancedWindow/Materials/ConstantEditors.cs deleted file mode 100644 index 690580df..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/ConstantEditors.cs +++ /dev/null @@ -1,71 +0,0 @@ -using System.Collections.Frozen; -using OtterGui.Text.Widget.Editors; -using Penumbra.GameData.Files.ShaderStructs; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public static class ConstantEditors -{ - public static readonly IEditor DefaultFloat = Editors.DefaultFloat.AsByteEditor(); - public static readonly IEditor DefaultInt = Editors.DefaultInt.AsByteEditor(); - public static readonly IEditor DefaultIntAsFloat = Editors.DefaultInt.IntAsFloatEditor().AsByteEditor(); - public static readonly IEditor DefaultColor = ColorEditor.HighDynamicRange.Reinterpreting(); - - /// - /// Material constants known to be encoded as native s. - /// - /// A editor is nonfunctional for them, as typical values for these constants would fall into the IEEE 754 denormalized number range. - /// - private static readonly FrozenSet KnownIntConstants; - - static ConstantEditors() - { - IReadOnlyList knownIntConstants = [ - "g_ToonIndex", - "g_ToonSpecIndex", - ]; - - KnownIntConstants = knownIntConstants.ToFrozenSet(); - } - - public static IEditor DefaultFor(Name name, MaterialTemplatePickers? materialTemplatePickers = null) - { - if (materialTemplatePickers != null) - { - if (name == Names.SphereMapIndexConstantName) - return materialTemplatePickers.SphereMapIndexPicker; - else if (name == Names.TileIndexConstantName) - return materialTemplatePickers.TileIndexPicker; - } - - if (name.Value != null && name.Value.EndsWith("Color")) - return DefaultColor; - - if (KnownIntConstants.Contains(name)) - return DefaultInt; - - return DefaultFloat; - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static IEditor AsByteEditor(this IEditor inner) where T : unmanaged - => inner.Reinterpreting(); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static IEditor IntAsFloatEditor(this IEditor inner) - => inner.Converting(value => int.CreateSaturating(MathF.Round(value)), value => value); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static IEditor WithExponent(this IEditor inner, T exponent) - where T : unmanaged, IPowerFunctions, IComparisonOperators - => exponent == T.MultiplicativeIdentity - ? inner - : inner.Converting(value => value < T.Zero ? -T.Pow(-value, T.MultiplicativeIdentity / exponent) : T.Pow(value, T.MultiplicativeIdentity / exponent), value => value < T.Zero ? -T.Pow(-value, exponent) : T.Pow(value, exponent)); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public static IEditor WithFactorAndBias(this IEditor inner, T factor, T bias) - where T : unmanaged, IMultiplicativeIdentity, IAdditiveIdentity, IMultiplyOperators, IAdditionOperators, ISubtractionOperators, IDivisionOperators, IEqualityOperators - => factor == T.MultiplicativeIdentity && bias == T.AdditiveIdentity - ? inner - : inner.Converting(value => (value - bias) / factor, value => value * factor + bias); -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MaterialTemplatePickers.cs b/Penumbra/UI/AdvancedWindow/Materials/MaterialTemplatePickers.cs deleted file mode 100644 index 24a5f9c2..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MaterialTemplatePickers.cs +++ /dev/null @@ -1,177 +0,0 @@ -using Dalamud.Interface; -using FFXIVClientStructs.Interop; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using OtterGui.Text.Widget.Editors; -using Penumbra.Interop.Services; -using Penumbra.Interop.Structs; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public sealed unsafe class MaterialTemplatePickers : IUiService -{ - private const float MaximumTextureSize = 64.0f; - - private readonly TextureArraySlicer _textureArraySlicer; - private readonly CharacterUtility _characterUtility; - - public readonly IEditor TileIndexPicker; - public readonly IEditor SphereMapIndexPicker; - - public MaterialTemplatePickers(TextureArraySlicer textureArraySlicer, CharacterUtility characterUtility) - { - _textureArraySlicer = textureArraySlicer; - _characterUtility = characterUtility; - - TileIndexPicker = new Editor(DrawTileIndexPicker).AsByteEditor(); - SphereMapIndexPicker = new Editor(DrawSphereMapIndexPicker).AsByteEditor(); - } - - public bool DrawTileIndexPicker(ReadOnlySpan label, ReadOnlySpan description, ref ushort value, bool compact) - => _characterUtility.Address != null - && DrawTextureArrayIndexPicker(label, description, ref value, compact, [ - _characterUtility.Address->TileOrbArrayTexResource, - _characterUtility.Address->TileNormArrayTexResource, - ]); - - public bool DrawSphereMapIndexPicker(ReadOnlySpan label, ReadOnlySpan description, ref ushort value, bool compact) - => _characterUtility.Address != null - && DrawTextureArrayIndexPicker(label, description, ref value, compact, [ - _characterUtility.Address->SphereDArrayTexResource, - ]); - - public bool DrawTextureArrayIndexPicker(ReadOnlySpan label, ReadOnlySpan description, ref ushort value, bool compact, ReadOnlySpan> textureRHs) - { - TextureResourceHandle* firstNonNullTextureRH = null; - foreach (var texture in textureRHs) - { - if (texture.Value != null && texture.Value->CsHandle.Texture != null) - { - firstNonNullTextureRH = texture; - break; - } - } - var firstNonNullTexture = firstNonNullTextureRH != null ? firstNonNullTextureRH->CsHandle.Texture : null; - - var textureSize = firstNonNullTexture != null ? new Vector2(firstNonNullTexture->ActualWidth, firstNonNullTexture->ActualHeight).Contain(new Vector2(MaximumTextureSize)) : Vector2.Zero; - var count = firstNonNullTexture != null ? firstNonNullTexture->ArraySize : 0; - - var ret = false; - - var framePadding = ImGui.GetStyle().FramePadding; - var itemSpacing = ImGui.GetStyle().ItemSpacing; - using (var font = ImRaii.PushFont(UiBuilder.MonoFont)) - { - var spaceSize = ImUtf8.CalcTextSize(" "u8).X; - var spaces = (int)((ImGui.CalcItemWidth() - framePadding.X * 2.0f - (compact ? 0.0f : (textureSize.X + itemSpacing.X) * textureRHs.Length)) / spaceSize); - using var padding = ImRaii.PushStyle(ImGuiStyleVar.FramePadding, framePadding + new Vector2(0.0f, Math.Max(textureSize.Y - ImGui.GetFrameHeight() + itemSpacing.Y, 0.0f) * 0.5f), !compact); - using var combo = ImUtf8.Combo(label, (value == ushort.MaxValue ? "-" : value.ToString()).PadLeft(spaces), ImGuiComboFlags.NoArrowButton | ImGuiComboFlags.HeightLarge); - if (combo.Success && firstNonNullTextureRH != null) - { - var lineHeight = Math.Max(ImGui.GetTextLineHeightWithSpacing(), framePadding.Y * 2.0f + textureSize.Y); - var itemWidth = Math.Max(ImGui.GetContentRegionAvail().X, ImUtf8.CalcTextSize("MMM"u8).X + (itemSpacing.X + textureSize.X) * textureRHs.Length + framePadding.X * 2.0f); - using var center = ImRaii.PushStyle(ImGuiStyleVar.SelectableTextAlign, new Vector2(0, 0.5f)); - using var clipper = ImUtf8.ListClipper(count, lineHeight); - while (clipper.Step()) - { - for (var i = clipper.DisplayStart; i < clipper.DisplayEnd && i < count; i++) - { - if (ImUtf8.Selectable($"{i,3}", i == value, size: new(itemWidth, lineHeight))) - { - ret = value != i; - value = (ushort)i; - } - var rectMin = ImGui.GetItemRectMin(); - var rectMax = ImGui.GetItemRectMax(); - var textureRegionStart = new Vector2( - rectMax.X - framePadding.X - textureSize.X * textureRHs.Length - itemSpacing.X * (textureRHs.Length - 1), - rectMin.Y + framePadding.Y); - var maxSize = new Vector2(textureSize.X, rectMax.Y - framePadding.Y - textureRegionStart.Y); - DrawTextureSlices(textureRegionStart, maxSize, itemSpacing.X, textureRHs, (byte)i); - } - } - } - } - if (!compact && value != ushort.MaxValue) - { - var cbRectMin = ImGui.GetItemRectMin(); - var cbRectMax = ImGui.GetItemRectMax(); - var cbTextureRegionStart = new Vector2(cbRectMax.X - framePadding.X - textureSize.X * textureRHs.Length - itemSpacing.X * (textureRHs.Length - 1), cbRectMin.Y + framePadding.Y); - var cbMaxSize = new Vector2(textureSize.X, cbRectMax.Y - framePadding.Y - cbTextureRegionStart.Y); - DrawTextureSlices(cbTextureRegionStart, cbMaxSize, itemSpacing.X, textureRHs, (byte)value); - } - if (ImGui.IsItemHovered(ImGuiHoveredFlags.AllowWhenDisabled) && (description.Length > 0 || compact && value != ushort.MaxValue)) - { - using var disabled = ImRaii.Enabled(); - using var tt = ImUtf8.Tooltip(); - if (description.Length > 0) - ImUtf8.Text(description); - if (compact && value != ushort.MaxValue) - { - ImGui.Dummy(new Vector2(textureSize.X * textureRHs.Length + itemSpacing.X * (textureRHs.Length - 1), textureSize.Y)); - var rectMin = ImGui.GetItemRectMin(); - var rectMax = ImGui.GetItemRectMax(); - DrawTextureSlices(rectMin, textureSize, itemSpacing.X, textureRHs, (byte)value); - } - } - - return ret; - } - - public void DrawTextureSlices(Vector2 regionStart, Vector2 itemSize, float itemSpacing, ReadOnlySpan> textureRHs, byte sliceIndex) - { - for (var j = 0; j < textureRHs.Length; ++j) - { - if (textureRHs[j].Value == null) - continue; - var texture = textureRHs[j].Value->CsHandle.Texture; - if (texture == null) - continue; - var handle = _textureArraySlicer.GetImGuiHandle(texture, sliceIndex); - if (handle.IsNull) - continue; - - var position = regionStart with { X = regionStart.X + (itemSize.X + itemSpacing) * j }; - var size = new Vector2(texture->ActualWidth, texture->ActualHeight).Contain(itemSize); - position += (itemSize - size) * 0.5f; - ImGui.GetWindowDrawList().AddImage(handle, position, position + size, Vector2.Zero, - new Vector2(texture->ActualWidth / (float)texture->AllocatedWidth, texture->ActualHeight / (float)texture->AllocatedHeight)); - } - } - - private delegate bool DrawEditor(ReadOnlySpan label, ReadOnlySpan description, ref ushort value, bool compact); - - private sealed class Editor(DrawEditor draw) : IEditor - { - public bool Draw(Span values, bool disabled) - { - var helper = Editors.PrepareMultiComponent(values.Length); - var ret = false; - - for (var valueIdx = 0; valueIdx < values.Length; ++valueIdx) - { - helper.SetupComponent(valueIdx); - - var value = ushort.CreateSaturating(MathF.Round(values[valueIdx])); - if (disabled) - { - using var _ = ImRaii.Disabled(); - draw(helper.Id, default, ref value, true); - } - else - { - if (draw(helper.Id, default, ref value, true)) - { - values[valueIdx] = value; - ret = true; - } - } - } - - return ret; - } - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ColorTable.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ColorTable.cs deleted file mode 100644 index fad9adeb..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ColorTable.cs +++ /dev/null @@ -1,642 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Files.StainMapStructs; -using Penumbra.Services; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private const float ColorTableScalarSize = 65.0f; - - private int _colorTableSelectedPair; - - private bool DrawColorTable(ColorTable table, ColorDyeTable? dyeTable, bool disabled) - { - DrawColorTablePairSelector(table, disabled); - return DrawColorTablePairEditor(table, dyeTable, disabled); - } - - private void DrawColorTablePairSelector(ColorTable table, bool disabled) - { - var style = ImGui.GetStyle(); - var itemSpacing = style.ItemSpacing.X; - var itemInnerSpacing = style.ItemInnerSpacing.X; - var framePadding = style.FramePadding; - var buttonWidth = (ImGui.GetContentRegionAvail().X - itemSpacing * 7.0f) * 0.125f; - var frameHeight = ImGui.GetFrameHeight(); - var highlighterSize = ImUtf8.CalcIconSize(FontAwesomeIcon.Crosshairs) + framePadding * 2.0f; - - using var font = ImRaii.PushFont(UiBuilder.MonoFont); - using var alignment = ImRaii.PushStyle(ImGuiStyleVar.ButtonTextAlign, new Vector2(0, 0.5f)); - - // This depends on the font being pushed for "proper" alignment of the pair indices in the buttons. - var spaceWidth = ImUtf8.CalcTextSize(" "u8).X; - var spacePadding = (int)MathF.Ceiling((highlighterSize.X + framePadding.X + itemInnerSpacing) / spaceWidth); - - for (var i = 0; i < ColorTable.NumRows >> 1; i += 8) - { - for (var j = 0; j < 8; ++j) - { - var pairIndex = i + j; - using (ImRaii.PushColor(ImGuiCol.Button, ImGui.GetColorU32(ImGuiCol.ButtonActive), pairIndex == _colorTableSelectedPair)) - { - if (ImUtf8.Button($"#{pairIndex + 1}".PadLeft(3 + spacePadding), - new Vector2(buttonWidth, ImGui.GetFrameHeightWithSpacing() + frameHeight))) - _colorTableSelectedPair = pairIndex; - } - - var rcMin = ImGui.GetItemRectMin() + framePadding; - var rcMax = ImGui.GetItemRectMax() - framePadding; - CtBlendRect( - rcMin with { X = rcMax.X - frameHeight * 3 - itemInnerSpacing * 2 }, - rcMax with { X = rcMax.X - (frameHeight + itemInnerSpacing) * 2 }, - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[pairIndex << 1].DiffuseColor)), - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[(pairIndex << 1) | 1].DiffuseColor)) - ); - CtBlendRect( - rcMin with { X = rcMax.X - frameHeight * 2 - itemInnerSpacing }, - rcMax with { X = rcMax.X - frameHeight - itemInnerSpacing }, - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[pairIndex << 1].SpecularColor)), - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[(pairIndex << 1) | 1].SpecularColor)) - ); - CtBlendRect( - rcMin with { X = rcMax.X - frameHeight }, rcMax, - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[pairIndex << 1].EmissiveColor)), - ImGuiUtil.ColorConvertFloat3ToU32(PseudoSqrtRgb((Vector3)table[(pairIndex << 1) | 1].EmissiveColor)) - ); - if (j < 7) - ImGui.SameLine(); - - var cursor = ImGui.GetCursorScreenPos(); - ImGui.SetCursorScreenPos(rcMin with { Y = float.Lerp(rcMin.Y, rcMax.Y, 0.5f) - highlighterSize.Y * 0.5f }); - font.Pop(); - ColorTablePairHighlightButton(pairIndex, disabled); - font.Push(UiBuilder.MonoFont); - ImGui.SetCursorScreenPos(cursor); - } - } - } - - private bool DrawColorTablePairEditor(ColorTable table, ColorDyeTable? dyeTable, bool disabled) - { - var retA = false; - var retB = false; - var rowAIdx = _colorTableSelectedPair << 1; - var rowBIdx = rowAIdx | 1; - var dyeA = dyeTable?[_colorTableSelectedPair << 1] ?? default; - var dyeB = dyeTable?[(_colorTableSelectedPair << 1) | 1] ?? default; - var previewDyeA = _stainService.GetStainCombo(dyeA.Channel).CurrentSelection.Key; - var previewDyeB = _stainService.GetStainCombo(dyeB.Channel).CurrentSelection.Key; - var dyePackA = _stainService.GudStmFile.GetValueOrNull(dyeA.Template, previewDyeA); - var dyePackB = _stainService.GudStmFile.GetValueOrNull(dyeB.Template, previewDyeB); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using (ImUtf8.PushId("RowHeaderA"u8)) - { - retA |= DrawRowHeader(rowAIdx, disabled); - } - columns.Next(); - using (ImUtf8.PushId("RowHeaderB"u8)) - { - retB |= DrawRowHeader(rowBIdx, disabled); - } - } - - DrawHeader(" Colors"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("ColorsA"u8)) - { - retA |= DrawColors(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("ColorsB"u8)) - { - retB |= DrawColors(table, dyeTable, dyePackB, rowBIdx); - } - } - - DrawHeader(" Physical Parameters"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("PbrA"u8)) - { - retA |= DrawPbr(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("PbrB"u8)) - { - retB |= DrawPbr(table, dyeTable, dyePackB, rowBIdx); - } - } - - DrawHeader(" Sheen Layer Parameters"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("SheenA"u8)) - { - retA |= DrawSheen(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("SheenB"u8)) - { - retB |= DrawSheen(table, dyeTable, dyePackB, rowBIdx); - } - } - - DrawHeader(" Pair Blending"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("BlendingA"u8)) - { - retA |= DrawBlending(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("BlendingB"u8)) - { - retB |= DrawBlending(table, dyeTable, dyePackB, rowBIdx); - } - } - - DrawHeader(" Material Template"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("TemplateA"u8)) - { - retA |= DrawTemplate(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("TemplateB"u8)) - { - retB |= DrawTemplate(table, dyeTable, dyePackB, rowBIdx); - } - } - - if (dyeTable != null) - { - DrawHeader(" Dye Properties"u8); - using var columns = ImUtf8.Columns(2, "ColorTable"u8); - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("DyeA"u8)) - { - retA |= DrawDye(dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("DyeB"u8)) - { - retB |= DrawDye(dyeTable, dyePackB, rowBIdx); - } - } - - DrawHeader(" Further Content"u8); - using (var columns = ImUtf8.Columns(2, "ColorTable"u8)) - { - using var dis = ImRaii.Disabled(disabled); - using (ImUtf8.PushId("FurtherA"u8)) - { - retA |= DrawFurther(table, dyeTable, dyePackA, rowAIdx); - } - - columns.Next(); - using (ImUtf8.PushId("FurtherB"u8)) - { - retB |= DrawFurther(table, dyeTable, dyePackB, rowBIdx); - } - } - - if (retA) - UpdateColorTableRowPreview(rowAIdx); - if (retB) - UpdateColorTableRowPreview(rowBIdx); - - return retA | retB; - } - - /// Padding styles do not seem to apply to this component. It is recommended to prepend two spaces. - private static void DrawHeader(ReadOnlySpan label) - { - var headerColor = ImGui.GetColorU32(ImGuiCol.Header); - using var _ = ImRaii.PushColor(ImGuiCol.HeaderHovered, headerColor).Push(ImGuiCol.HeaderActive, headerColor); - ImUtf8.CollapsingHeader(label, ImGuiTreeNodeFlags.Leaf); - } - - private bool DrawRowHeader(int rowIdx, bool disabled) - { - ColorTableCopyClipboardButton(rowIdx); - ImUtf8.SameLineInner(); - var ret = ColorTablePasteFromClipboardButton(rowIdx, disabled); - ImUtf8.SameLineInner(); - ColorTableRowHighlightButton(rowIdx, disabled); - - ImGui.SameLine(); - CenteredTextInRest($"Row {(rowIdx >> 1) + 1}{"AB"[rowIdx & 1]}"); - - return ret; - } - - private static bool DrawColors(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var dyeOffset = ImGui.GetContentRegionAvail().X - + ImGui.GetStyle().ItemSpacing.X - - ImGui.GetStyle().ItemInnerSpacing.X - - ImGui.GetFrameHeight() * 2.0f; - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ret |= CtColorPicker("Diffuse Color"u8, default, row.DiffuseColor, - c => table[rowIdx].DiffuseColor = c); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeDiffuseColor"u8, "Apply Diffuse Color on Dye"u8, dye.DiffuseColor, - b => dyeTable[rowIdx].DiffuseColor = b); - ImUtf8.SameLineInner(); - CtColorPicker("##dyePreviewDiffuseColor"u8, "Dye Preview for Diffuse Color"u8, dyePack?.DiffuseColor); - } - - ret |= CtColorPicker("Specular Color"u8, default, row.SpecularColor, - c => table[rowIdx].SpecularColor = c); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeSpecularColor"u8, "Apply Specular Color on Dye"u8, dye.SpecularColor, - b => dyeTable[rowIdx].SpecularColor = b); - ImUtf8.SameLineInner(); - CtColorPicker("##dyePreviewSpecularColor"u8, "Dye Preview for Specular Color"u8, dyePack?.SpecularColor); - } - - ret |= CtColorPicker("Emissive Color"u8, default, row.EmissiveColor, - c => table[rowIdx].EmissiveColor = c); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeEmissiveColor"u8, "Apply Emissive Color on Dye"u8, dye.EmissiveColor, - b => dyeTable[rowIdx].EmissiveColor = b); - ImUtf8.SameLineInner(); - CtColorPicker("##dyePreviewEmissiveColor"u8, "Dye Preview for Emissive Color"u8, dyePack?.EmissiveColor); - } - - return ret; - } - - private static bool DrawBlending(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var dyeOffset = ImGui.GetContentRegionAvail().X - + ImGui.GetStyle().ItemSpacing.X - - ImGui.GetStyle().ItemInnerSpacing.X - - ImGui.GetFrameHeight() - - scalarSize; - - var isRowB = (rowIdx & 1) != 0; - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf(isRowB ? "Field #19"u8 : "Anisotropy Degree"u8, default, row.Anisotropy, "%.2f"u8, 0.0f, HalfMaxValue, 0.1f, - v => table[rowIdx].Anisotropy = v); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeAnisotropy"u8, isRowB ? "Apply Field #19 on Dye"u8 : "Apply Anisotropy Degree on Dye"u8, - dye.Anisotropy, - b => dyeTable[rowIdx].Anisotropy = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragHalf("##dyePreviewAnisotropy"u8, isRowB ? "Dye Preview for Field #19"u8 : "Dye Preview for Anisotropy Degree"u8, - dyePack?.Anisotropy, "%.2f"u8); - } - - return ret; - } - - private bool DrawTemplate(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var itemSpacing = ImGui.GetStyle().ItemSpacing.X; - var dyeOffset = ImGui.GetContentRegionAvail().X - ImGui.GetStyle().ItemInnerSpacing.X - ImGui.GetFrameHeight() - scalarSize - 64.0f; - var subColWidth = CalculateSubColumnWidth(2); - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Shader ID"u8, default, row.ShaderId, "%d"u8, (ushort)0, (ushort)255, 0.25f, - v => table[rowIdx].ShaderId = v); - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - - ImGui.SetNextItemWidth(scalarSize + itemSpacing + 64.0f); - ret |= CtSphereMapIndexPicker("###SphereMapIndex"u8, default, row.SphereMapIndex, false, - v => table[rowIdx].SphereMapIndex = v); - ImUtf8.SameLineInner(); - ImUtf8.Text("Sphere Map"u8); - if (dyeTable != null) - { - var textRectMin = ImGui.GetItemRectMin(); - var textRectMax = ImGui.GetItemRectMax(); - ImGui.SameLine(dyeOffset); - var cursor = ImGui.GetCursorScreenPos(); - ImGui.SetCursorScreenPos(cursor with { Y = float.Lerp(textRectMin.Y, textRectMax.Y, 0.5f) - ImGui.GetFrameHeight() * 0.5f }); - ret |= CtApplyStainCheckbox("##dyeSphereMapIndex"u8, "Apply Sphere Map on Dye"u8, dye.SphereMapIndex, - b => dyeTable[rowIdx].SphereMapIndex = b); - ImUtf8.SameLineInner(); - ImGui.SetCursorScreenPos(ImGui.GetCursorScreenPos() with { Y = cursor.Y }); - ImGui.SetNextItemWidth(scalarSize + itemSpacing + 64.0f); - using var dis = ImRaii.Disabled(); - CtSphereMapIndexPicker("###SphereMapIndexDye"u8, "Dye Preview for Sphere Map"u8, dyePack?.SphereMapIndex ?? ushort.MaxValue, false, - Nop); - } - - ImGui.Dummy(new Vector2(64.0f, 0.0f)); - ImGui.SameLine(); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Sphere Map Intensity"u8, default, (float)row.SphereMapMask * 100.0f, "%.0f%%"u8, HalfMinValue * 100.0f, - HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].SphereMapMask = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeSphereMapMask"u8, "Apply Sphere Map Intensity on Dye"u8, dye.SphereMapMask, - b => dyeTable[rowIdx].SphereMapMask = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyeSphereMapMask"u8, "Dye Preview for Sphere Map Intensity"u8, (float?)dyePack?.SphereMapMask * 100.0f, "%.0f%%"u8); - } - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - - var leftLineHeight = 64.0f + ImGui.GetStyle().FramePadding.Y * 2.0f; - var rightLineHeight = 3.0f * ImGui.GetFrameHeight() + 2.0f * ImGui.GetStyle().ItemSpacing.Y; - var lineHeight = Math.Max(leftLineHeight, rightLineHeight); - var cursorPos = ImGui.GetCursorScreenPos(); - ImGui.SetCursorScreenPos(cursorPos + new Vector2(0.0f, (lineHeight - leftLineHeight) * 0.5f)); - ImGui.SetNextItemWidth(scalarSize + (itemSpacing + 64.0f) * 2.0f); - ret |= CtTileIndexPicker("###TileIndex"u8, default, row.TileIndex, false, - v => table[rowIdx].TileIndex = v); - ImUtf8.SameLineInner(); - ImUtf8.Text("Tile"u8); - - ImGui.SameLine(subColWidth); - ImGui.SetCursorScreenPos(ImGui.GetCursorScreenPos() with { Y = cursorPos.Y + (lineHeight - rightLineHeight) * 0.5f }); - using (ImUtf8.Child("###TileProperties"u8, - new Vector2(ImGui.GetContentRegionAvail().X, float.Lerp(rightLineHeight, lineHeight, 0.5f)))) - { - ImGui.Dummy(new Vector2(scalarSize, 0.0f)); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Tile Opacity"u8, default, (float)row.TileAlpha * 100.0f, "%.0f%%"u8, 0.0f, HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].TileAlpha = (Half)(v * 0.01f)); - - ret |= CtTileTransformMatrix(row.TileTransform, scalarSize, true, - m => table[rowIdx].TileTransform = m); - ImUtf8.SameLineInner(); - ImGui.SetCursorScreenPos(ImGui.GetCursorScreenPos() - - new Vector2(0.0f, (ImGui.GetFrameHeight() + ImGui.GetStyle().ItemSpacing.Y) * 0.5f)); - ImUtf8.Text("Tile Transform"u8); - } - - return ret; - } - - private static bool DrawPbr(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var subColWidth = CalculateSubColumnWidth(2) + ImGui.GetStyle().ItemSpacing.X; - var dyeOffset = subColWidth - - ImGui.GetStyle().ItemSpacing.X * 2.0f - - ImGui.GetStyle().ItemInnerSpacing.X - - ImGui.GetFrameHeight() - - scalarSize; - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Roughness"u8, default, (float)row.Roughness * 100.0f, "%.0f%%"u8, HalfMinValue * 100.0f, HalfMaxValue * 100.0f, - 1.0f, - v => table[rowIdx].Roughness = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeRoughness"u8, "Apply Roughness on Dye"u8, dye.Roughness, - b => dyeTable[rowIdx].Roughness = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyePreviewRoughness"u8, "Dye Preview for Roughness"u8, (float?)dyePack?.Roughness * 100.0f, "%.0f%%"u8); - } - - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Metalness"u8, default, (float)row.Metalness * 100.0f, "%.0f%%"u8, HalfMinValue * 100.0f, HalfMaxValue * 100.0f, - 1.0f, - v => table[rowIdx].Metalness = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImGui.SameLine(subColWidth + dyeOffset); - ret |= CtApplyStainCheckbox("##dyeMetalness"u8, "Apply Metalness on Dye"u8, dye.Metalness, - b => dyeTable[rowIdx].Metalness = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyePreviewMetalness"u8, "Dye Preview for Metalness"u8, (float?)dyePack?.Metalness * 100.0f, "%.0f%%"u8); - } - - return ret; - } - - private static bool DrawSheen(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var subColWidth = CalculateSubColumnWidth(2) + ImGui.GetStyle().ItemSpacing.X; - var dyeOffset = subColWidth - - ImGui.GetStyle().ItemSpacing.X * 2.0f - - ImGui.GetStyle().ItemInnerSpacing.X - - ImGui.GetFrameHeight() - - scalarSize; - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Sheen"u8, default, (float)row.SheenRate * 100.0f, "%.0f%%"u8, HalfMinValue * 100.0f, HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].SheenRate = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeSheenRate"u8, "Apply Sheen on Dye"u8, dye.SheenRate, - b => dyeTable[rowIdx].SheenRate = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyePreviewSheenRate"u8, "Dye Preview for Sheen"u8, (float?)dyePack?.SheenRate * 100.0f, "%.0f%%"u8); - } - - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Sheen Tint"u8, default, (float)row.SheenTintRate * 100.0f, "%.0f%%"u8, HalfMinValue * 100.0f, - HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].SheenTintRate = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImGui.SameLine(subColWidth + dyeOffset); - ret |= CtApplyStainCheckbox("##dyeSheenTintRate"u8, "Apply Sheen Tint on Dye"u8, dye.SheenTintRate, - b => dyeTable[rowIdx].SheenTintRate = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyePreviewSheenTintRate"u8, "Dye Preview for Sheen Tint"u8, (float?)dyePack?.SheenTintRate * 100.0f, "%.0f%%"u8); - } - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Sheen Roughness"u8, default, 100.0f / (float)row.SheenAperture, "%.0f%%"u8, 100.0f / HalfMaxValue, - 100.0f / HalfEpsilon, 1.0f, - v => table[rowIdx].SheenAperture = (Half)(100.0f / v)); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeSheenRoughness"u8, "Apply Sheen Roughness on Dye"u8, dye.SheenAperture, - b => dyeTable[rowIdx].SheenAperture = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragScalar("##dyePreviewSheenRoughness"u8, "Dye Preview for Sheen Roughness"u8, 100.0f / (float?)dyePack?.SheenAperture, - "%.0f%%"u8); - } - - return ret; - } - - private static bool DrawFurther(ColorTable table, ColorDyeTable? dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var subColWidth = CalculateSubColumnWidth(2) + ImGui.GetStyle().ItemSpacing.X; - var dyeOffset = subColWidth - - ImGui.GetStyle().ItemSpacing.X * 2.0f - - ImGui.GetStyle().ItemInnerSpacing.X - - ImGui.GetFrameHeight() - - scalarSize; - - var ret = false; - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #11"u8, default, row.Scalar11, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar11 = v); - if (dyeTable != null) - { - ImGui.SameLine(dyeOffset); - ret |= CtApplyStainCheckbox("##dyeScalar11"u8, "Apply Field #11 on Dye"u8, dye.Scalar3, - b => dyeTable[rowIdx].Scalar3 = b); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(scalarSize); - CtDragHalf("##dyePreviewScalar11"u8, "Dye Preview for Field #11"u8, dyePack?.Scalar3, "%.2f"u8); - } - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #3"u8, default, row.Scalar3, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar3 = v); - - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #7"u8, default, row.Scalar7, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar7 = v); - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #15"u8, default, row.Scalar15, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar15 = v); - - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #17"u8, default, row.Scalar17, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar17 = v); - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #20"u8, default, row.Scalar20, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar20 = v); - - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #22"u8, default, row.Scalar22, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar22 = v); - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragHalf("Field #23"u8, default, row.Scalar23, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f, - v => table[rowIdx].Scalar23 = v); - - return ret; - } - - private bool DrawDye(ColorDyeTable dyeTable, DyePack? dyePack, int rowIdx) - { - var scalarSize = ColorTableScalarSize * UiHelpers.Scale; - var applyButtonWidth = ImUtf8.CalcTextSize("Apply Preview Dye"u8).X + ImGui.GetStyle().FramePadding.X * 2.0f; - var subColWidth = CalculateSubColumnWidth(2, applyButtonWidth); - - var ret = false; - ref var dye = ref dyeTable[rowIdx]; - - ImGui.SetNextItemWidth(scalarSize); - ret |= CtDragScalar("Dye Channel"u8, default, dye.Channel + 1, "%d"u8, 1, StainService.ChannelCount, 0.1f, - value => dyeTable[rowIdx].Channel = (byte)(Math.Clamp(value, 1, StainService.ChannelCount) - 1)); - ImGui.SameLine(subColWidth); - ImGui.SetNextItemWidth(scalarSize); - _stainService.GudTemplateCombo.CurrentDyeChannel = dye.Channel; - if (_stainService.GudTemplateCombo.Draw("##dyeTemplate", dye.Template.ToString(), string.Empty, - scalarSize + ImGui.GetStyle().ScrollbarSize / 2, ImGui.GetTextLineHeightWithSpacing(), ImGuiComboFlags.NoArrowButton)) - { - dye.Template = _stainService.GudTemplateCombo.CurrentSelection.UShort; - ret = true; - } - - ImUtf8.SameLineInner(); - ImUtf8.Text("Dye Template"u8); - ImGui.SameLine(ImGui.GetContentRegionAvail().X - applyButtonWidth + ImGui.GetStyle().ItemSpacing.X); - using var dis = ImRaii.Disabled(!dyePack.HasValue); - if (ImUtf8.Button("Apply Preview Dye"u8)) - ret |= Mtrl.ApplyDyeToRow(_stainService.GudStmFile, [ - _stainService.StainCombo1.CurrentSelection.Key, - _stainService.StainCombo2.CurrentSelection.Key, - ], rowIdx); - - return ret; - } - - private static void CenteredTextInRest(string text) - => AlignedTextInRest(text, 0.5f); - - private static void AlignedTextInRest(string text, float alignment) - { - var width = ImGui.CalcTextSize(text).X; - ImGui.SetCursorScreenPos(ImGui.GetCursorScreenPos() + new Vector2((ImGui.GetContentRegionAvail().X - width) * alignment, 0.0f)); - ImGui.TextUnformatted(text); - } - - private static float CalculateSubColumnWidth(int numSubColumns, float reservedSpace = 0.0f) - { - var itemSpacing = ImGui.GetStyle().ItemSpacing.X; - return (ImGui.GetContentRegionAvail().X - reservedSpace - itemSpacing * (numSubColumns - 1)) / numSubColumns + itemSpacing; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.CommonColorTable.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.CommonColorTable.cs deleted file mode 100644 index 9ea9c2e0..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.CommonColorTable.cs +++ /dev/null @@ -1,602 +0,0 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface; -using Dalamud.Interface.Utility; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Files; -using OtterGui.Text; -using Penumbra.GameData.Structs; -using OtterGui.Raii; -using OtterGui.Text.Widget; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private static readonly float HalfMinValue = (float)Half.MinValue; - private static readonly float HalfMaxValue = (float)Half.MaxValue; - private static readonly float HalfEpsilon = (float)Half.Epsilon; - - private static readonly FontAwesomeCheckbox ApplyStainCheckbox = new(FontAwesomeIcon.FillDrip); - - private static (Vector2 Scale, float Rotation, float Shear)? _pinnedTileTransform; - - private bool DrawColorTableSection(bool disabled) - { - if (!_shpkLoading && !TextureIds.Contains(ShpkFile.TableSamplerId) || Mtrl.Table == null) - return false; - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - if (!ImUtf8.CollapsingHeader("Color Table"u8, ImGuiTreeNodeFlags.DefaultOpen)) - return false; - - ColorTableCopyAllClipboardButton(); - ImGui.SameLine(); - var ret = ColorTablePasteAllClipboardButton(disabled); - if (!disabled) - { - ImGui.SameLine(); - ImUtf8.IconDummy(); - ImGui.SameLine(); - ret |= ColorTableDyeableCheckbox(); - } - - if (Mtrl.DyeTable != null) - { - ImGui.SameLine(); - ImUtf8.IconDummy(); - ImGui.SameLine(); - ret |= DrawPreviewDye(disabled); - } - - ret |= Mtrl.Table switch - { - LegacyColorTable legacyTable => DrawLegacyColorTable(legacyTable, Mtrl.DyeTable as LegacyColorDyeTable, disabled), - ColorTable table when Mtrl.ShaderPackage.Name is "characterlegacy.shpk" => DrawLegacyColorTable(table, - Mtrl.DyeTable as ColorDyeTable, disabled), - ColorTable table => DrawColorTable(table, Mtrl.DyeTable as ColorDyeTable, disabled), - _ => false, - }; - - return ret; - } - - private void ColorTableCopyAllClipboardButton() - { - if (Mtrl.Table == null) - return; - - if (!ImUtf8.Button("Export All Rows to Clipboard"u8, ImGuiHelpers.ScaledVector2(200, 0))) - return; - - try - { - var data1 = Mtrl.Table.AsBytes(); - var data2 = Mtrl.DyeTable != null ? Mtrl.DyeTable.AsBytes() : []; - - var array = new byte[data1.Length + data2.Length]; - data1.TryCopyTo(array); - data2.TryCopyTo(array.AsSpan(data1.Length)); - - var text = Convert.ToBase64String(array); - ImGui.SetClipboardText(text); - } - catch - { - // ignored - } - } - - private bool DrawPreviewDye(bool disabled) - { - var (dyeId1, (name1, dyeColor1, gloss1)) = _stainService.StainCombo1.CurrentSelection; - var (dyeId2, (name2, dyeColor2, gloss2)) = _stainService.StainCombo2.CurrentSelection; - var tt = dyeId1 == 0 && dyeId2 == 0 - ? "Select a preview dye first."u8 - : "Apply all preview values corresponding to the dye template and chosen dye where dyeing is enabled."u8; - if (ImUtf8.ButtonEx("Apply Preview Dye"u8, tt, disabled: disabled || dyeId1 == 0 && dyeId2 == 0)) - { - var ret = false; - if (Mtrl.DyeTable != null) - { - ret |= Mtrl.ApplyDye(_stainService.LegacyStmFile, [dyeId1, dyeId2]); - ret |= Mtrl.ApplyDye(_stainService.GudStmFile, [dyeId1, dyeId2]); - } - - UpdateColorTablePreview(); - - return ret; - } - - ImGui.SameLine(); - var label = dyeId1 == 0 ? "Preview Dye 1###previewDye1" : $"{name1} (Preview 1)###previewDye1"; - if (_stainService.StainCombo1.Draw(label, dyeColor1, string.Empty, true, gloss1)) - UpdateColorTablePreview(); - ImGui.SameLine(); - label = dyeId2 == 0 ? "Preview Dye 2###previewDye2" : $"{name2} (Preview 2)###previewDye2"; - if (_stainService.StainCombo2.Draw(label, dyeColor2, string.Empty, true, gloss2)) - UpdateColorTablePreview(); - return false; - } - - private bool ColorTablePasteAllClipboardButton(bool disabled) - { - if (Mtrl.Table == null) - return false; - - if (!ImUtf8.ButtonEx("Import All Rows from Clipboard"u8, ImGuiHelpers.ScaledVector2(200, 0), disabled)) - return false; - - try - { - var text = ImGui.GetClipboardText(); - var data = Convert.FromBase64String(text); - var table = Mtrl.Table.AsBytes(); - var dyeTable = Mtrl.DyeTable != null ? Mtrl.DyeTable.AsBytes() : []; - if (data.Length != table.Length && data.Length != table.Length + dyeTable.Length) - return false; - - data.AsSpan(0, table.Length).TryCopyTo(table); - data.AsSpan(table.Length).TryCopyTo(dyeTable); - - UpdateColorTablePreview(); - - return true; - } - catch - { - return false; - } - } - - [SkipLocalsInit] - private void ColorTableCopyClipboardButton(int rowIdx) - { - if (Mtrl.Table == null) - return; - - if (!ImUtf8.IconButton(FontAwesomeIcon.Clipboard, "Export this row to your clipboard."u8, - ImGui.GetFrameHeight() * Vector2.One)) - return; - - try - { - var data1 = Mtrl.Table.RowAsBytes(rowIdx); - var data2 = Mtrl.DyeTable != null ? Mtrl.DyeTable.RowAsBytes(rowIdx) : []; - - var array = new byte[data1.Length + data2.Length]; - data1.TryCopyTo(array); - data2.TryCopyTo(array.AsSpan(data1.Length)); - - var text = Convert.ToBase64String(array); - ImGui.SetClipboardText(text); - } - catch - { - // ignored - } - } - - private bool ColorTableDyeableCheckbox() - { - var dyeable = Mtrl.DyeTable != null; - var ret = ImUtf8.Checkbox("Dyeable"u8, ref dyeable); - - if (ret) - { - Mtrl.DyeTable = dyeable - ? Mtrl.Table switch - { - ColorTable => new ColorDyeTable(), - LegacyColorTable => new LegacyColorDyeTable(), - _ => null, - } - : null; - UpdateColorTablePreview(); - } - - return ret; - } - - private bool ColorTablePasteFromClipboardButton(int rowIdx, bool disabled) - { - if (Mtrl.Table == null) - return false; - - if (ImUtf8.IconButton(FontAwesomeIcon.Paste, - "Import an exported row from your clipboard onto this row.\n\nRight-Click for more options."u8, - ImGui.GetFrameHeight() * Vector2.One, disabled)) - try - { - var text = ImGui.GetClipboardText(); - var data = Convert.FromBase64String(text); - var row = Mtrl.Table.RowAsBytes(rowIdx); - var dyeRow = Mtrl.DyeTable != null ? Mtrl.DyeTable.RowAsBytes(rowIdx) : []; - if (data.Length != row.Length && data.Length != row.Length + dyeRow.Length) - return false; - - data.AsSpan(0, row.Length).TryCopyTo(row); - data.AsSpan(row.Length).TryCopyTo(dyeRow); - - UpdateColorTableRowPreview(rowIdx); - - return true; - } - catch - { - return false; - } - - return ColorTablePasteFromClipboardContext(rowIdx, disabled); - } - - private unsafe bool ColorTablePasteFromClipboardContext(int rowIdx, bool disabled) - { - if (!disabled && ImGui.IsItemClicked(ImGuiMouseButton.Right)) - ImUtf8.OpenPopup("context"u8); - - using var context = ImUtf8.Popup("context"u8); - if (!context) - return false; - - using var _ = ImRaii.Disabled(disabled); - - IColorTable.ValueTypes copy = 0; - IColorDyeTable.ValueTypes dyeCopy = 0; - if (ImUtf8.Selectable("Import Colors Only"u8)) - { - copy = IColorTable.ValueTypes.Colors; - dyeCopy = IColorDyeTable.ValueTypes.Colors; - } - - if (ImUtf8.Selectable("Import Other Values Only"u8)) - { - copy = ~IColorTable.ValueTypes.Colors; - dyeCopy = ~IColorDyeTable.ValueTypes.Colors; - } - - if (copy == 0) - return false; - - try - { - var text = ImGui.GetClipboardText(); - var data = Convert.FromBase64String(text); - var row = Mtrl.Table!.RowAsHalves(rowIdx); - var halves = new Span(Unsafe.AsPointer(ref data[0]), row.Length); - var dyeRow = Mtrl.DyeTable != null ? Mtrl.DyeTable.RowAsBytes(rowIdx) : []; - if (!Mtrl.Table.MergeSpecificValues(row, halves, copy)) - return false; - - Mtrl.DyeTable?.MergeSpecificValues(dyeRow, data.AsSpan(row.Length * 2), dyeCopy); - - UpdateColorTableRowPreview(rowIdx); - return true; - } - catch - { - return false; - } - } - - private void ColorTablePairHighlightButton(int pairIdx, bool disabled) - { - ImUtf8.IconButton(FontAwesomeIcon.Crosshairs, - "Highlight this pair of rows on your character, if possible.\n\nHighlight colors can be configured in Penumbra's settings."u8, - ImGui.GetFrameHeight() * Vector2.One, disabled || _colorTablePreviewers.Count == 0); - - if (ImGui.IsItemHovered()) - HighlightColorTablePair(pairIdx); - else if (_highlightedColorTablePair == pairIdx) - CancelColorTableHighlight(); - } - - private void ColorTableRowHighlightButton(int rowIdx, bool disabled) - { - ImUtf8.IconButton(FontAwesomeIcon.Crosshairs, - "Highlight this row on your character, if possible.\n\nHighlight colors can be configured in Penumbra's settings."u8, - ImGui.GetFrameHeight() * Vector2.One, disabled || _colorTablePreviewers.Count == 0); - - if (ImGui.IsItemHovered()) - HighlightColorTableRow(rowIdx); - else if (_highlightedColorTableRow == rowIdx) - CancelColorTableHighlight(); - } - - private static void CtBlendRect(Vector2 rcMin, Vector2 rcMax, uint topColor, uint bottomColor) - { - var style = ImGui.GetStyle(); - var frameRounding = style.FrameRounding; - var frameThickness = style.FrameBorderSize; - var borderColor = ImGui.GetColorU32(ImGuiCol.Border); - var drawList = ImGui.GetWindowDrawList(); - if (topColor == bottomColor) - { - drawList.AddRectFilled(rcMin, rcMax, topColor, frameRounding, ImDrawFlags.RoundCornersDefault); - } - else - { - drawList.AddRectFilled( - rcMin, rcMax with { Y = float.Lerp(rcMin.Y, rcMax.Y, 1.0f / 3) }, - topColor, frameRounding, ImDrawFlags.RoundCornersTopLeft | ImDrawFlags.RoundCornersTopRight); - drawList.AddRectFilledMultiColor( - rcMin with { Y = float.Lerp(rcMin.Y, rcMax.Y, 1.0f / 3) }, - rcMax with { Y = float.Lerp(rcMin.Y, rcMax.Y, 2.0f / 3) }, - topColor, topColor, bottomColor, bottomColor); - drawList.AddRectFilled( - rcMin with { Y = float.Lerp(rcMin.Y, rcMax.Y, 2.0f / 3) }, rcMax, - bottomColor, frameRounding, ImDrawFlags.RoundCornersBottomLeft | ImDrawFlags.RoundCornersBottomRight); - } - - drawList.AddRect(rcMin, rcMax, borderColor, frameRounding, ImDrawFlags.RoundCornersDefault, frameThickness); - } - - private static bool CtColorPicker(ReadOnlySpan label, ReadOnlySpan description, HalfColor current, Action setter, - ReadOnlySpan letter = default) - { - var ret = false; - var inputSqrt = PseudoSqrtRgb((Vector3)current); - var tmp = inputSqrt; - if (ImUtf8.ColorEdit(label, ref tmp, - ImGuiColorEditFlags.NoInputs - | ImGuiColorEditFlags.DisplayRgb - | ImGuiColorEditFlags.InputRgb - | ImGuiColorEditFlags.NoTooltip - | ImGuiColorEditFlags.Hdr) - && tmp != inputSqrt) - { - setter((HalfColor)PseudoSquareRgb(tmp)); - ret = true; - } - - if (letter.Length > 0 && ImGui.IsItemVisible()) - { - var textSize = ImUtf8.CalcTextSize(letter); - var center = ImGui.GetItemRectMin() + (ImGui.GetItemRectSize() - textSize) / 2; - var textColor = inputSqrt.LengthSquared() < 0.25f ? 0x80FFFFFFu : 0x80000000u; - ImGui.GetWindowDrawList().AddText(letter, center, textColor); - } - - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - - return ret; - } - - private static void CtColorPicker(ReadOnlySpan label, ReadOnlySpan description, HalfColor? current, - ReadOnlySpan letter = default) - { - if (current.HasValue) - { - CtColorPicker(label, description, current.Value, Nop, letter); - } - else - { - var tmp = Vector4.Zero; - ImUtf8.ColorEdit(label, ref tmp, - ImGuiColorEditFlags.NoInputs - | ImGuiColorEditFlags.DisplayRgb - | ImGuiColorEditFlags.InputRgb - | ImGuiColorEditFlags.NoTooltip - | ImGuiColorEditFlags.Hdr - | ImGuiColorEditFlags.AlphaPreview); - - if (letter.Length > 0 && ImGui.IsItemVisible()) - { - var textSize = ImUtf8.CalcTextSize(letter); - var center = ImGui.GetItemRectMin() + (ImGui.GetItemRectSize() - textSize) / 2; - ImGui.GetWindowDrawList().AddText(letter, center, 0x80000000u); - } - - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - } - } - - private static bool CtApplyStainCheckbox(ReadOnlySpan label, ReadOnlySpan description, bool current, Action setter) - { - var tmp = current; - var result = ApplyStainCheckbox.Draw(label, ref tmp); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - if (!result || tmp == current) - return false; - - setter(tmp); - return true; - } - - private static bool CtDragHalf(ReadOnlySpan label, ReadOnlySpan description, Half value, ReadOnlySpan format, float min, - float max, float speed, Action setter) - { - var tmp = (float)value; - var result = ImUtf8.DragScalar(label, ref tmp, format, min, max, speed); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - if (!result) - return false; - - var newValue = (Half)tmp; - if (newValue == value) - return false; - - setter(newValue); - return true; - } - - private static bool CtDragHalf(ReadOnlySpan label, ReadOnlySpan description, ref Half value, ReadOnlySpan format, - float min, float max, float speed) - { - var tmp = (float)value; - var result = ImUtf8.DragScalar(label, ref tmp, format, min, max, speed); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - if (!result) - return false; - - var newValue = (Half)tmp; - if (newValue == value) - return false; - - value = newValue; - return true; - } - - private static void CtDragHalf(ReadOnlySpan label, ReadOnlySpan description, Half? value, ReadOnlySpan format) - { - using var _ = ImRaii.Disabled(); - var valueOrDefault = value ?? Half.Zero; - var floatValue = (float)valueOrDefault; - CtDragHalf(label, description, valueOrDefault, value.HasValue ? format : "-"u8, floatValue, floatValue, 0.0f, Nop); - } - - private static bool CtDragScalar(ReadOnlySpan label, ReadOnlySpan description, T value, ReadOnlySpan format, T min, - T max, float speed, Action setter) where T : unmanaged, INumber - { - var tmp = value; - var result = ImUtf8.DragScalar(label, ref tmp, format, min, max, speed); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - if (!result || tmp == value) - return false; - - setter(tmp); - return true; - } - - private static bool CtDragScalar(ReadOnlySpan label, ReadOnlySpan description, ref T value, ReadOnlySpan format, T min, - T max, float speed) where T : unmanaged, INumber - { - var tmp = value; - var result = ImUtf8.DragScalar(label, ref tmp, format, min, max, speed); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, description); - if (!result || tmp == value) - return false; - - value = tmp; - return true; - } - - private static void CtDragScalar(ReadOnlySpan label, ReadOnlySpan description, T? value, ReadOnlySpan format) - where T : unmanaged, INumber - { - using var _ = ImRaii.Disabled(); - var valueOrDefault = value ?? T.Zero; - CtDragScalar(label, description, valueOrDefault, value.HasValue ? format : "-"u8, valueOrDefault, valueOrDefault, 0.0f, Nop); - } - - private bool CtTileIndexPicker(ReadOnlySpan label, ReadOnlySpan description, ushort value, bool compact, Action setter) - { - if (!_materialTemplatePickers.DrawTileIndexPicker(label, description, ref value, compact)) - return false; - - setter(value); - return true; - } - - private bool CtSphereMapIndexPicker(ReadOnlySpan label, ReadOnlySpan description, ushort value, bool compact, - Action setter) - { - if (!_materialTemplatePickers.DrawSphereMapIndexPicker(label, description, ref value, compact)) - return false; - - setter(value); - return true; - } - - private bool CtTileTransformMatrix(HalfMatrix2x2 value, float floatSize, bool twoRowLayout, Action setter) - { - var ret = false; - if (_config.EditRawTileTransforms) - { - var tmp = value; - ImGui.SetNextItemWidth(floatSize); - ret |= CtDragHalf("##TileTransformUU"u8, "Tile Repeat U"u8, ref tmp.UU, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - ret |= CtDragHalf("##TileTransformVV"u8, "Tile Repeat V"u8, ref tmp.VV, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - if (!twoRowLayout) - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - ret |= CtDragHalf("##TileTransformUV"u8, "Tile Skew U"u8, ref tmp.UV, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - ret |= CtDragHalf("##TileTransformVU"u8, "Tile Skew V"u8, ref tmp.VU, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - if (!ret || tmp == value) - return false; - - setter(tmp); - } - else - { - value.Decompose(out var scale, out var rotation, out var shear); - rotation *= 180.0f / MathF.PI; - shear *= 180.0f / MathF.PI; - ImGui.SetNextItemWidth(floatSize); - var scaleXChanged = CtDragScalar("##TileScaleU"u8, "Tile Scale U"u8, ref scale.X, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - var activated = ImGui.IsItemActivated(); - var deactivated = ImGui.IsItemDeactivated(); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - var scaleYChanged = CtDragScalar("##TileScaleV"u8, "Tile Scale V"u8, ref scale.Y, "%.2f"u8, HalfMinValue, HalfMaxValue, 0.1f); - activated |= ImGui.IsItemActivated(); - deactivated |= ImGui.IsItemDeactivated(); - if (!twoRowLayout) - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - var rotationChanged = CtDragScalar("##TileRotation"u8, "Tile Rotation"u8, ref rotation, "%.0f°"u8, -180.0f, 180.0f, 1.0f); - activated |= ImGui.IsItemActivated(); - deactivated |= ImGui.IsItemDeactivated(); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - var shearChanged = CtDragScalar("##TileShear"u8, "Tile Shear"u8, ref shear, "%.0f°"u8, -90.0f, 90.0f, 1.0f); - activated |= ImGui.IsItemActivated(); - deactivated |= ImGui.IsItemDeactivated(); - if (deactivated) - _pinnedTileTransform = null; - else if (activated) - _pinnedTileTransform = (scale, rotation, shear); - ret = scaleXChanged | scaleYChanged | rotationChanged | shearChanged; - if (!ret) - return false; - - if (_pinnedTileTransform.HasValue) - { - var (pinScale, pinRotation, pinShear) = _pinnedTileTransform.Value; - if (!scaleXChanged) - scale.X = pinScale.X; - if (!scaleYChanged) - scale.Y = pinScale.Y; - if (!rotationChanged) - rotation = pinRotation; - if (!shearChanged) - shear = pinShear; - } - - var newValue = HalfMatrix2x2.Compose(scale, rotation * MathF.PI / 180.0f, shear * MathF.PI / 180.0f); - if (newValue == value) - return false; - - setter(newValue); - } - - return true; - } - - /// For use as setter of read-only fields. - private static void Nop(T _) - { } - - // Functions to deal with squared RGB values without making negatives useless. - - internal static float PseudoSquareRgb(float x) - => x < 0.0f ? -(x * x) : x * x; - - internal static Vector3 PseudoSquareRgb(Vector3 vec) - => new(PseudoSquareRgb(vec.X), PseudoSquareRgb(vec.Y), PseudoSquareRgb(vec.Z)); - - internal static Vector4 PseudoSquareRgb(Vector4 vec) - => new(PseudoSquareRgb(vec.X), PseudoSquareRgb(vec.Y), PseudoSquareRgb(vec.Z), vec.W); - - internal static float PseudoSqrtRgb(float x) - => x < 0.0f ? -MathF.Sqrt(-x) : MathF.Sqrt(x); - - public static Vector3 PseudoSqrtRgb(Vector3 vec) - => new(PseudoSqrtRgb(vec.X), PseudoSqrtRgb(vec.Y), PseudoSqrtRgb(vec.Z)); - - internal static Vector4 PseudoSqrtRgb(Vector4 vec) - => new(PseudoSqrtRgb(vec.X), PseudoSqrtRgb(vec.Y), PseudoSqrtRgb(vec.Z), vec.W); -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Constants.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Constants.cs deleted file mode 100644 index 4ad6968b..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Constants.cs +++ /dev/null @@ -1,279 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Raii; -using OtterGui.Text; -using OtterGui.Text.Widget.Editors; -using Penumbra.GameData.Files.ShaderStructs; -using static Penumbra.GameData.Files.ShpkFile; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private const float MaterialConstantSize = 250.0f; - - public readonly - List<(string Header, List<(string Label, int ConstantIndex, Range Slice, string Description, bool MonoFont, IEditor Editor)> - Constants)> Constants = new(16); - - private void UpdateConstants() - { - static List FindOrAddGroup(List<(string, List)> groups, string name) - { - foreach (var (groupName, group) in groups) - { - if (string.Equals(name, groupName, StringComparison.Ordinal)) - return group; - } - - var newGroup = new List(16); - groups.Add((name, newGroup)); - return newGroup; - } - - Constants.Clear(); - string mpPrefix; - if (_associatedShpk == null) - { - mpPrefix = MaterialParamsConstantName.Value!; - var fcGroup = FindOrAddGroup(Constants, "Further Constants"); - foreach (var (constant, index) in Mtrl.ShaderPackage.Constants.WithIndex()) - { - var values = Mtrl.GetConstantValue(constant); - for (var i = 0; i < values.Length; i += 4) - { - fcGroup.Add(($"0x{constant.Id:X8}", index, i..Math.Min(i + 4, values.Length), string.Empty, true, - ConstantEditors.DefaultFloat)); - } - } - } - else - { - mpPrefix = _associatedShpk.GetConstantById(MaterialParamsConstantId)?.Name ?? MaterialParamsConstantName.Value!; - var autoNameMaxLength = Math.Max(Names.LongestKnownNameLength, mpPrefix.Length + 8); - foreach (var shpkConstant in _associatedShpk.MaterialParams) - { - var name = Names.KnownNames.TryResolve(shpkConstant.Id); - var constant = Mtrl.GetOrAddConstant(shpkConstant.Id, _associatedShpk, out var constantIndex); - var values = Mtrl.GetConstantValue(constant); - var handledElements = new IndexSet(values.Length, false); - - var dkData = TryGetShpkDevkitData("Constants", shpkConstant.Id, true); - if (dkData != null) - foreach (var dkConstant in dkData) - { - var offset = (int)dkConstant.EffectiveByteOffset; - var length = values.Length - offset; - var constantSize = dkConstant.EffectiveByteSize; - if (constantSize.HasValue) - length = Math.Min(length, (int)constantSize.Value); - if (length <= 0) - continue; - - var editor = dkConstant.CreateEditor(_materialTemplatePickers); - if (editor != null) - FindOrAddGroup(Constants, dkConstant.Group.Length > 0 ? dkConstant.Group : "Further Constants") - .Add((dkConstant.Label, constantIndex, offset..(offset + length), dkConstant.Description, false, editor)); - handledElements.AddRange(offset, length); - } - - if (handledElements.IsFull) - continue; - - var fcGroup = FindOrAddGroup(Constants, "Further Constants"); - foreach (var (start, end) in handledElements.Ranges(complement: true)) - { - if (start == 0 && end == values.Length && end - start <= 16) - if (name.Value != null) - { - fcGroup.Add(( - $"{name.Value.PadRight(autoNameMaxLength)} (0x{shpkConstant.Id:X8})", - constantIndex, 0..values.Length, string.Empty, true, DefaultConstantEditorFor(name))); - continue; - } - - if ((shpkConstant.ByteOffset & 0x3) == 0 && (shpkConstant.ByteSize & 0x3) == 0) - { - var offset = shpkConstant.ByteOffset; - for (int i = (start & ~0xF) - (offset & 0xF), j = offset >> 4; i < end; i += 16, ++j) - { - var rangeStart = Math.Max(i, start); - var rangeEnd = Math.Min(i + 16, end); - if (rangeEnd > rangeStart) - { - var autoName = - $"{mpPrefix}[{j,2:D}]{VectorSwizzle(((offset + rangeStart) & 0xF) >> 2, ((offset + rangeEnd - 1) & 0xF) >> 2)}"; - fcGroup.Add(( - $"{autoName.PadRight(autoNameMaxLength)} (0x{shpkConstant.Id:X8})", - constantIndex, rangeStart..rangeEnd, string.Empty, true, DefaultConstantEditorFor(name))); - } - } - } - else - { - for (var i = start; i < end; i += 16) - { - fcGroup.Add(($"{"???".PadRight(autoNameMaxLength)} (0x{shpkConstant.Id:X8})", constantIndex, - i..Math.Min(i + 16, end), string.Empty, true, - DefaultConstantEditorFor(name))); - } - } - } - } - } - - Constants.RemoveAll(group => group.Constants.Count == 0); - Constants.Sort((x, y) => - { - if (string.Equals(x.Header, "Further Constants", StringComparison.Ordinal)) - return 1; - if (string.Equals(y.Header, "Further Constants", StringComparison.Ordinal)) - return -1; - - return string.Compare(x.Header, y.Header, StringComparison.Ordinal); - }); - // HACK the Replace makes w appear after xyz, for the cbuffer-location-based naming scheme, and cbuffer-location names appear after known variable names - foreach (var (_, group) in Constants) - { - group.Sort((x, y) => string.CompareOrdinal( - x.MonoFont ? x.Label.Replace("].w", "].{").Replace(mpPrefix, "}_MaterialParameter") : x.Label, - y.MonoFont ? y.Label.Replace("].w", "].{").Replace(mpPrefix, "}_MaterialParameter") : y.Label)); - } - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private IEditor DefaultConstantEditorFor(Name name) - => ConstantEditors.DefaultFor(name, _materialTemplatePickers); - - private bool DrawConstantsSection(bool disabled) - { - if (Constants.Count == 0) - return false; - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - if (!ImGui.CollapsingHeader("Material Constants")) - return false; - - using var _ = ImRaii.PushId("MaterialConstants"); - - var ret = false; - foreach (var (header, group) in Constants) - { - using var t = ImRaii.TreeNode(header, ImGuiTreeNodeFlags.DefaultOpen); - if (!t) - continue; - - foreach (var (label, constantIndex, slice, description, monoFont, editor) in group) - { - var constant = Mtrl.ShaderPackage.Constants[constantIndex]; - var buffer = Mtrl.GetConstantValue(constant); - if (buffer.Length > 0) - { - using var id = ImRaii.PushId($"##{constant.Id:X8}:{slice.Start}"); - ImGui.SetNextItemWidth(MaterialConstantSize * UiHelpers.Scale); - if (editor.Draw(buffer[slice], disabled)) - { - ret = true; - SetMaterialParameter(constant.Id, slice.Start, buffer[slice]); - } - - var shpkConstant = _associatedShpk?.GetMaterialParamById(constant.Id); - var defaultConstantValue = shpkConstant.HasValue ? _associatedShpk!.GetMaterialParamDefault(shpkConstant.Value) : []; - var defaultValue = IsValid(slice, defaultConstantValue.Length) ? defaultConstantValue[slice] : []; - var canReset = _associatedShpk?.MaterialParamsDefaults != null - ? defaultValue.Length > 0 && !defaultValue.SequenceEqual(buffer[slice]) - : buffer[slice].ContainsAnyExcept((byte)0); - ImUtf8.SameLineInner(); - if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Backspace.ToIconString(), ImGui.GetFrameHeight() * Vector2.One, - "Reset this constant to its default value.\n\nHold Ctrl to unlock.", !ImGui.GetIO().KeyCtrl || !canReset, true)) - { - ret = true; - if (defaultValue.Length > 0) - defaultValue.CopyTo(buffer[slice]); - else - buffer[slice].Clear(); - - SetMaterialParameter(constant.Id, slice.Start, buffer[slice]); - } - - ImGui.SameLine(); - using var font = ImRaii.PushFont(UiBuilder.MonoFont, monoFont); - if (description.Length > 0) - ImGuiUtil.LabeledHelpMarker(label, description); - else - ImGui.TextUnformatted(label); - } - } - } - - return ret; - } - - private static bool IsValid(Range range, int length) - { - var start = range.Start.GetOffset(length); - var end = range.End.GetOffset(length); - return start >= 0 && start <= length && end >= start && end <= length; - } - - internal static string? MaterialParamName(bool componentOnly, int offset) - { - if (offset < 0) - return null; - - return (componentOnly, offset & 0x3) switch - { - (true, 0) => "x", - (true, 1) => "y", - (true, 2) => "z", - (true, 3) => "w", - (false, 0) => $"[{offset >> 2:D2}].x", - (false, 1) => $"[{offset >> 2:D2}].y", - (false, 2) => $"[{offset >> 2:D2}].z", - (false, 3) => $"[{offset >> 2:D2}].w", - _ => null, - }; - } - - /// Returned string is 4 chars long. - private static string VectorSwizzle(int firstComponent, int lastComponent) - => (firstComponent, lastComponent) switch - { - (0, 4) => " ", - (0, 0) => ".x ", - (0, 1) => ".xy ", - (0, 2) => ".xyz", - (0, 3) => " ", - (1, 1) => ".y ", - (1, 2) => ".yz ", - (1, 3) => ".yzw", - (2, 2) => ".z ", - (2, 3) => ".zw ", - (3, 3) => ".w ", - _ => string.Empty, - }; - - internal static (string? Name, bool ComponentOnly) MaterialParamRangeName(string prefix, int valueOffset, int valueLength) - { - if (valueLength == 0 || valueOffset < 0) - return (null, false); - - var firstVector = valueOffset >> 2; - var lastVector = (valueOffset + valueLength - 1) >> 2; - var firstComponent = valueOffset & 0x3; - var lastComponent = (valueOffset + valueLength - 1) & 0x3; - if (firstVector == lastVector) - return ($"{prefix}[{firstVector}]{VectorSwizzle(firstComponent, lastComponent)}", true); - - var sb = new StringBuilder(128); - sb.Append($"{prefix}[{firstVector}]{VectorSwizzle(firstComponent, 3).TrimEnd()}"); - for (var i = firstVector + 1; i < lastVector; ++i) - sb.Append($", [{i}]"); - - sb.Append($", [{lastVector}]{VectorSwizzle(0, lastComponent)}"); - return (sb.ToString(), false); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Devkit.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Devkit.cs deleted file mode 100644 index 26fe3dcb..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Devkit.cs +++ /dev/null @@ -1,252 +0,0 @@ -using JetBrains.Annotations; -using Newtonsoft.Json.Linq; -using OtterGui.Text.Widget.Editors; -using Penumbra.String.Classes; -using static Penumbra.GameData.Files.ShpkFile; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private JObject? TryLoadShpkDevkit(string shpkBaseName, out string devkitPathName) - { - try - { - if (!Utf8GamePath.FromString("penumbra/shpk_devkit/" + shpkBaseName + ".json", out var devkitPath)) - throw new Exception("Could not assemble ShPk dev-kit path."); - - var devkitFullPath = _edit.FindBestMatch(devkitPath); - if (!devkitFullPath.IsRooted) - throw new Exception("Could not resolve ShPk dev-kit path."); - - devkitPathName = devkitFullPath.FullName; - return JObject.Parse(File.ReadAllText(devkitFullPath.FullName)); - } - catch - { - devkitPathName = string.Empty; - return null; - } - } - - private T? TryGetShpkDevkitData(string category, uint? id, bool mayVary) where T : class - => TryGetShpkDevkitData(_associatedShpkDevkit, _loadedShpkDevkitPathName, category, id, mayVary) - ?? TryGetShpkDevkitData(_associatedBaseDevkit, _loadedBaseDevkitPathName, category, id, mayVary); - - private T? TryGetShpkDevkitData(JObject? devkit, string devkitPathName, string category, uint? id, bool mayVary) where T : class - { - if (devkit == null) - return null; - - try - { - var data = devkit[category]; - if (id.HasValue) - data = data?[id.Value.ToString()]; - - if (mayVary && (data as JObject)?["Vary"] != null) - { - var selector = BuildSelector(data!["Vary"]! - .Select(key => (uint)key) - .Select(key => Mtrl.GetShaderKey(key)?.Value ?? _associatedShpk!.GetMaterialKeyById(key)!.Value.DefaultValue)); - var index = (int)data["Selectors"]![selector.ToString()]!; - data = data["Items"]![index]; - } - - return data?.ToObject(typeof(T)) as T; - } - catch (Exception e) - { - // Some element in the JSON was undefined or invalid (wrong type, key that doesn't exist in the ShPk, index out of range, …) - Penumbra.Log.Error($"Error while traversing the ShPk dev-kit file at {devkitPathName}: {e}"); - return null; - } - } - - [UsedImplicitly] - private sealed class DevkitShaderKeyValue - { - public string Label = string.Empty; - public string Description = string.Empty; - } - - [UsedImplicitly] - private sealed class DevkitShaderKey - { - public string Label = string.Empty; - public string Description = string.Empty; - public Dictionary Values = []; - } - - [UsedImplicitly] - private sealed class DevkitSampler - { - public string Label = string.Empty; - public string Description = string.Empty; - public string DefaultTexture = string.Empty; - } - - private enum DevkitConstantType - { - Hidden = -1, - Float = 0, - - /// Integer encoded as a float. - Integer = 1, - Color = 2, - Enum = 3, - - /// Native integer. - Int32 = 4, - Int32Enum = 5, - Int8 = 6, - Int8Enum = 7, - Int16 = 8, - Int16Enum = 9, - Int64 = 10, - Int64Enum = 11, - Half = 12, - Double = 13, - TileIndex = 14, - SphereMapIndex = 15, - } - - [UsedImplicitly] - private sealed class DevkitConstantValue - { - public string Label = string.Empty; - public string Description = string.Empty; - public double Value = 0; - } - - [UsedImplicitly] - private sealed class DevkitConstant - { - public uint Offset = 0; - public uint? Length = null; - public uint? ByteOffset = null; - public uint? ByteSize = null; - public string Group = string.Empty; - public string Label = string.Empty; - public string Description = string.Empty; - public DevkitConstantType Type = DevkitConstantType.Float; - - public float? Minimum = null; - public float? Maximum = null; - public float Step = 0.0f; - public float StepFast = 0.0f; - public float? Speed = null; - public float RelativeSpeed = 0.0f; - public float Exponent = 1.0f; - public float Factor = 1.0f; - public float Bias = 0.0f; - public byte Precision = 3; - public bool Hex = false; - public bool Slider = true; - public bool Drag = true; - public string Unit = string.Empty; - - public bool SquaredRgb = false; - public bool Clamped = false; - - public DevkitConstantValue[] Values = []; - - public uint EffectiveByteOffset - => ByteOffset ?? Offset * ValueSize; - - public uint? EffectiveByteSize - => ByteSize ?? Length * ValueSize; - - public unsafe uint ValueSize - => Type switch - { - DevkitConstantType.Hidden => sizeof(byte), - DevkitConstantType.Float => sizeof(float), - DevkitConstantType.Integer => sizeof(float), - DevkitConstantType.Color => sizeof(float), - DevkitConstantType.Enum => sizeof(float), - DevkitConstantType.Int32 => sizeof(int), - DevkitConstantType.Int32Enum => sizeof(int), - DevkitConstantType.Int8 => sizeof(byte), - DevkitConstantType.Int8Enum => sizeof(byte), - DevkitConstantType.Int16 => sizeof(short), - DevkitConstantType.Int16Enum => sizeof(short), - DevkitConstantType.Int64 => sizeof(long), - DevkitConstantType.Int64Enum => sizeof(long), - DevkitConstantType.Half => (uint)sizeof(Half), - DevkitConstantType.Double => sizeof(double), - DevkitConstantType.TileIndex => sizeof(float), - DevkitConstantType.SphereMapIndex => sizeof(float), - _ => sizeof(float), - }; - - public IEditor? CreateEditor(MaterialTemplatePickers? materialTemplatePickers) - => Type switch - { - DevkitConstantType.Hidden => null, - DevkitConstantType.Float => CreateFloatEditor().AsByteEditor(), - DevkitConstantType.Integer => CreateIntegerEditor().IntAsFloatEditor().AsByteEditor(), - DevkitConstantType.Color => ColorEditor.Get(!Clamped).WithExponent(SquaredRgb ? 2.0f : 1.0f).AsByteEditor(), - DevkitConstantType.Enum => CreateEnumEditor(float.CreateSaturating).AsByteEditor(), - DevkitConstantType.Int32 => CreateIntegerEditor().AsByteEditor(), - DevkitConstantType.Int32Enum => CreateEnumEditor(ToInteger).AsByteEditor(), - DevkitConstantType.Int8 => CreateIntegerEditor(), - DevkitConstantType.Int8Enum => CreateEnumEditor(ToInteger), - DevkitConstantType.Int16 => CreateIntegerEditor().AsByteEditor(), - DevkitConstantType.Int16Enum => CreateEnumEditor(ToInteger).AsByteEditor(), - DevkitConstantType.Int64 => CreateIntegerEditor().AsByteEditor(), - DevkitConstantType.Int64Enum => CreateEnumEditor(ToInteger).AsByteEditor(), - DevkitConstantType.Half => CreateFloatEditor().AsByteEditor(), - DevkitConstantType.Double => CreateFloatEditor().AsByteEditor(), - DevkitConstantType.TileIndex => materialTemplatePickers?.TileIndexPicker ?? ConstantEditors.DefaultIntAsFloat, - DevkitConstantType.SphereMapIndex => materialTemplatePickers?.SphereMapIndexPicker ?? ConstantEditors.DefaultIntAsFloat, - _ => ConstantEditors.DefaultFloat, - }; - - private IEditor CreateIntegerEditor() - where T : unmanaged, INumber - => ((Drag || Slider) && !Hex - ? Drag - ? (IEditor)DragEditor.CreateInteger(ToInteger(Minimum), ToInteger(Maximum), Speed ?? 0.25f, RelativeSpeed, - Unit, 0) - : SliderEditor.CreateInteger(ToInteger(Minimum) ?? default, ToInteger(Maximum) ?? default, Unit, 0) - : InputEditor.CreateInteger(ToInteger(Minimum), ToInteger(Maximum), ToInteger(Step), ToInteger(StepFast), - Hex, Unit, 0)) - .WithFactorAndBias(ToInteger(Factor), ToInteger(Bias)); - - private IEditor CreateFloatEditor() - where T : unmanaged, INumber, IPowerFunctions - => (Drag || Slider - ? Drag - ? (IEditor)DragEditor.CreateFloat(ToFloat(Minimum), ToFloat(Maximum), Speed ?? 0.1f, RelativeSpeed, - Precision, Unit, 0) - : SliderEditor.CreateFloat(ToFloat(Minimum) ?? default, ToFloat(Maximum) ?? default, Precision, Unit, 0) - : InputEditor.CreateFloat(ToFloat(Minimum), ToFloat(Maximum), T.CreateSaturating(Step), - T.CreateSaturating(StepFast), Precision, Unit, 0)) - .WithExponent(T.CreateSaturating(Exponent)) - .WithFactorAndBias(T.CreateSaturating(Factor), T.CreateSaturating(Bias)); - - private EnumEditor CreateEnumEditor(Func convertValue) - where T : unmanaged, IUtf8SpanFormattable, IEqualityOperators - => new(Array.ConvertAll(Values, value => (ToUtf8(value.Label), convertValue(value.Value), ToUtf8(value.Description)))); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static T ToInteger(float value) where T : struct, INumberBase - => T.CreateSaturating(MathF.Round(value)); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static T ToInteger(double value) where T : struct, INumberBase - => T.CreateSaturating(Math.Round(value)); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static T? ToInteger(float? value) where T : struct, INumberBase - => value.HasValue ? ToInteger(value.Value) : null; - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static T? ToFloat(float? value) where T : struct, INumberBase - => value.HasValue ? T.CreateSaturating(value.Value) : null; - - private static ReadOnlyMemory ToUtf8(string value) - => Encoding.UTF8.GetBytes(value); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LegacyColorTable.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LegacyColorTable.cs deleted file mode 100644 index e75cd633..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LegacyColorTable.cs +++ /dev/null @@ -1,374 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Text; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Files.StainMapStructs; -using Penumbra.Services; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private const float LegacyColorTableFloatSize = 65.0f; - private const float LegacyColorTablePercentageSize = 50.0f; - private const float LegacyColorTableIntegerSize = 40.0f; - private const float LegacyColorTableByteSize = 25.0f; - - private bool DrawLegacyColorTable(LegacyColorTable table, LegacyColorDyeTable? dyeTable, bool disabled) - { - using var imTable = ImUtf8.Table("##ColorTable"u8, dyeTable != null ? 10 : 8, - ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg | ImGuiTableFlags.BordersInnerV); - if (!imTable) - return false; - - DrawLegacyColorTableHeader(dyeTable != null); - - var ret = false; - for (var i = 0; i < LegacyColorTable.NumRows; ++i) - { - if (DrawLegacyColorTableRow(table, dyeTable, i, disabled)) - { - UpdateColorTableRowPreview(i); - ret = true; - } - - ImGui.TableNextRow(); - } - - return ret; - } - - private bool DrawLegacyColorTable(ColorTable table, ColorDyeTable? dyeTable, bool disabled) - { - using var imTable = ImUtf8.Table("##ColorTable"u8, dyeTable != null ? 10 : 8, - ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg | ImGuiTableFlags.BordersInnerV); - if (!imTable) - return false; - - DrawLegacyColorTableHeader(dyeTable != null); - - var ret = false; - for (var i = 0; i < ColorTable.NumRows; ++i) - { - if (DrawLegacyColorTableRow(table, dyeTable, i, disabled)) - { - UpdateColorTableRowPreview(i); - ret = true; - } - - ImGui.TableNextRow(); - } - - return ret; - } - - private static void DrawLegacyColorTableHeader(bool hasDyeTable) - { - ImGui.TableNextColumn(); - ImUtf8.TableHeader(""u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Row"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Diffuse"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Specular"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Emissive"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Gloss"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Tile"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Repeat / Skew"u8); - if (hasDyeTable) - { - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Dye"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Dye Preview"u8); - } - } - - private bool DrawLegacyColorTableRow(LegacyColorTable table, LegacyColorDyeTable? dyeTable, int rowIdx, bool disabled) - { - using var id = ImRaii.PushId(rowIdx); - ref var row = ref table[rowIdx]; - var dye = dyeTable != null ? dyeTable[rowIdx] : default; - var floatSize = LegacyColorTableFloatSize * UiHelpers.Scale; - var pctSize = LegacyColorTablePercentageSize * UiHelpers.Scale; - var intSize = LegacyColorTableIntegerSize * UiHelpers.Scale; - ImGui.TableNextColumn(); - ColorTableCopyClipboardButton(rowIdx); - ImUtf8.SameLineInner(); - var ret = ColorTablePasteFromClipboardButton(rowIdx, disabled); - ImUtf8.SameLineInner(); - ColorTableRowHighlightButton(rowIdx, disabled); - - ImGui.TableNextColumn(); - using (ImRaii.PushFont(UiBuilder.MonoFont)) - { - ImUtf8.Text($"{(rowIdx >> 1) + 1,2:D}{"AB"[rowIdx & 1]}"); - } - - ImGui.TableNextColumn(); - using var dis = ImRaii.Disabled(disabled); - ret |= CtColorPicker("##Diffuse"u8, "Diffuse Color"u8, row.DiffuseColor, - c => table[rowIdx].DiffuseColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeDiffuse"u8, "Apply Diffuse Color on Dye"u8, dye.DiffuseColor, - b => dyeTable[rowIdx].DiffuseColor = b); - } - - ImGui.TableNextColumn(); - ret |= CtColorPicker("##Specular"u8, "Specular Color"u8, row.SpecularColor, - c => table[rowIdx].SpecularColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeSpecular"u8, "Apply Specular Color on Dye"u8, dye.SpecularColor, - b => dyeTable[rowIdx].SpecularColor = b); - } - - ImGui.SameLine(); - ImGui.SetNextItemWidth(pctSize); - ret |= CtDragScalar("##SpecularMask"u8, "Specular Strength"u8, (float)row.SpecularMask * 100.0f, "%.0f%%"u8, 0f, HalfMaxValue * 100.0f, - 1.0f, - v => table[rowIdx].SpecularMask = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeSpecularMask"u8, "Apply Specular Strength on Dye"u8, dye.SpecularMask, - b => dyeTable[rowIdx].SpecularMask = b); - } - - ImGui.TableNextColumn(); - ret |= CtColorPicker("##Emissive"u8, "Emissive Color"u8, row.EmissiveColor, - c => table[rowIdx].EmissiveColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeEmissive"u8, "Apply Emissive Color on Dye"u8, dye.EmissiveColor, - b => dyeTable[rowIdx].EmissiveColor = b); - } - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(floatSize); - var glossStrengthMin = ImGui.GetIO().KeyCtrl ? 0.0f : HalfEpsilon; - ret |= CtDragHalf("##Shininess"u8, "Gloss Strength"u8, row.Shininess, "%.1f"u8, glossStrengthMin, HalfMaxValue, - Math.Max(0.1f, (float)row.Shininess * 0.025f), - v => table[rowIdx].Shininess = v); - - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeShininess"u8, "Apply Gloss Strength on Dye"u8, dye.Shininess, - b => dyeTable[rowIdx].Shininess = b); - } - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(intSize); - ret |= CtTileIndexPicker("##TileIndex"u8, "Tile Index"u8, row.TileIndex, true, - value => table[rowIdx].TileIndex = value); - - ImGui.TableNextColumn(); - ret |= CtTileTransformMatrix(row.TileTransform, floatSize, false, - m => table[rowIdx].TileTransform = m); - - if (dyeTable != null) - { - ImGui.TableNextColumn(); - if (_stainService.LegacyTemplateCombo.Draw("##dyeTemplate", dye.Template.ToString(), string.Empty, intSize - + ImGui.GetStyle().ScrollbarSize / 2, ImGui.GetTextLineHeightWithSpacing(), ImGuiComboFlags.NoArrowButton)) - { - dyeTable[rowIdx].Template = _stainService.LegacyTemplateCombo.CurrentSelection.UShort; - ret = true; - } - - ImGuiUtil.HoverTooltip("Dye Template", ImGuiHoveredFlags.AllowWhenDisabled); - - ImGui.TableNextColumn(); - ret |= DrawLegacyDyePreview(rowIdx, disabled, dye, floatSize); - } - - return ret; - } - - private bool DrawLegacyColorTableRow(ColorTable table, ColorDyeTable? dyeTable, int rowIdx, bool disabled) - { - using var id = ImRaii.PushId(rowIdx); - ref var row = ref table[rowIdx]; - var dye = dyeTable?[rowIdx] ?? default; - var floatSize = LegacyColorTableFloatSize * UiHelpers.Scale; - var pctSize = LegacyColorTablePercentageSize * UiHelpers.Scale; - var intSize = LegacyColorTableIntegerSize * UiHelpers.Scale; - var byteSize = LegacyColorTableByteSize * UiHelpers.Scale; - ImGui.TableNextColumn(); - ColorTableCopyClipboardButton(rowIdx); - ImUtf8.SameLineInner(); - var ret = ColorTablePasteFromClipboardButton(rowIdx, disabled); - ImUtf8.SameLineInner(); - ColorTableRowHighlightButton(rowIdx, disabled); - - ImGui.TableNextColumn(); - using (ImRaii.PushFont(UiBuilder.MonoFont)) - { - ImUtf8.Text($"{(rowIdx >> 1) + 1,2:D}{"AB"[rowIdx & 1]}"); - } - - ImGui.TableNextColumn(); - using var dis = ImRaii.Disabled(disabled); - ret |= CtColorPicker("##Diffuse"u8, "Diffuse Color"u8, row.DiffuseColor, - c => table[rowIdx].DiffuseColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeDiffuse"u8, "Apply Diffuse Color on Dye"u8, dye.DiffuseColor, - b => dyeTable[rowIdx].DiffuseColor = b); - } - - ImGui.TableNextColumn(); - ret |= CtColorPicker("##Specular"u8, "Specular Color"u8, row.SpecularColor, - c => table[rowIdx].SpecularColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeSpecular"u8, "Apply Specular Color on Dye"u8, dye.SpecularColor, - b => dyeTable[rowIdx].SpecularColor = b); - } - - ImGui.SameLine(); - ImGui.SetNextItemWidth(pctSize); - ret |= CtDragScalar("##SpecularMask"u8, "Specular Strength"u8, (float)row.Scalar7 * 100.0f, "%.0f%%"u8, 0f, HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].Scalar7 = (Half)(v * 0.01f)); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeSpecularMask"u8, "Apply Specular Strength on Dye"u8, dye.Metalness, - b => dyeTable[rowIdx].Metalness = b); - } - - ImGui.TableNextColumn(); - ret |= CtColorPicker("##Emissive"u8, "Emissive Color"u8, row.EmissiveColor, - c => table[rowIdx].EmissiveColor = c); - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeEmissive"u8, "Apply Emissive Color on Dye"u8, dye.EmissiveColor, - b => dyeTable[rowIdx].EmissiveColor = b); - } - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(floatSize); - var glossStrengthMin = ImGui.GetIO().KeyCtrl ? 0.0f : HalfEpsilon; - ret |= CtDragHalf("##Shininess"u8, "Gloss Strength"u8, row.Scalar3, "%.1f"u8, glossStrengthMin, HalfMaxValue, - Math.Max(0.1f, (float)row.Scalar3 * 0.025f), - v => table[rowIdx].Scalar3 = v); - - if (dyeTable != null) - { - ImUtf8.SameLineInner(); - ret |= CtApplyStainCheckbox("##dyeShininess"u8, "Apply Gloss Strength on Dye"u8, dye.Scalar3, - b => dyeTable[rowIdx].Scalar3 = b); - } - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(intSize); - ret |= CtTileIndexPicker("##TileIndex"u8, "Tile Index"u8, row.TileIndex, true, - value => table[rowIdx].TileIndex = value); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(pctSize); - ret |= CtDragScalar("##TileAlpha"u8, "Tile Opacity"u8, (float)row.TileAlpha * 100.0f, "%.0f%%"u8, 0f, HalfMaxValue * 100.0f, 1.0f, - v => table[rowIdx].TileAlpha = (Half)(v * 0.01f)); - - ImGui.TableNextColumn(); - ret |= CtTileTransformMatrix(row.TileTransform, floatSize, false, - m => table[rowIdx].TileTransform = m); - - if (dyeTable != null) - { - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(byteSize); - ret |= CtDragScalar("##DyeChannel"u8, "Dye Channel"u8, dye.Channel + 1, "%hhd"u8, 1, StainService.ChannelCount, 0.25f, - value => dyeTable[rowIdx].Channel = (byte)(Math.Clamp(value, 1, StainService.ChannelCount) - 1)); - ImUtf8.SameLineInner(); - _stainService.LegacyTemplateCombo.CurrentDyeChannel = dye.Channel; - if (_stainService.LegacyTemplateCombo.Draw("##dyeTemplate", dye.Template.ToString(), string.Empty, intSize - + ImGui.GetStyle().ScrollbarSize / 2, ImGui.GetTextLineHeightWithSpacing(), ImGuiComboFlags.NoArrowButton)) - { - dyeTable[rowIdx].Template = _stainService.LegacyTemplateCombo.CurrentSelection.UShort; - ret = true; - } - - ImGuiUtil.HoverTooltip("Dye Template", ImGuiHoveredFlags.AllowWhenDisabled); - - ImGui.TableNextColumn(); - ret |= DrawLegacyDyePreview(rowIdx, disabled, dye, floatSize); - } - - return ret; - } - - private bool DrawLegacyDyePreview(int rowIdx, bool disabled, LegacyColorDyeTableRow dye, float floatSize) - { - var stain = _stainService.StainCombo1.CurrentSelection.Key; - if (stain == 0 || !_stainService.LegacyStmFile.TryGetValue(dye.Template, stain, out var values)) - return false; - - using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, ImGui.GetStyle().ItemSpacing / 2); - - var ret = ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.PaintBrush.ToIconString(), new Vector2(ImGui.GetFrameHeight()), - "Apply the selected dye to this row.", disabled, true); - - ret = ret && Mtrl.ApplyDyeToRow(_stainService.LegacyStmFile, [stain], rowIdx); - - ImGui.SameLine(); - DrawLegacyDyePreview(values, floatSize); - - return ret; - } - - private bool DrawLegacyDyePreview(int rowIdx, bool disabled, ColorDyeTableRow dye, float floatSize) - { - var stain = _stainService.GetStainCombo(dye.Channel).CurrentSelection.Key; - if (stain == 0 || !_stainService.LegacyStmFile.TryGetValue(dye.Template, stain, out var values)) - return false; - - using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, ImGui.GetStyle().ItemSpacing / 2); - - var ret = ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.PaintBrush.ToIconString(), new Vector2(ImGui.GetFrameHeight()), - "Apply the selected dye to this row.", disabled, true); - - ret = ret - && Mtrl.ApplyDyeToRow(_stainService.LegacyStmFile, [ - _stainService.StainCombo1.CurrentSelection.Key, - _stainService.StainCombo2.CurrentSelection.Key, - ], rowIdx); - - ImGui.SameLine(); - DrawLegacyDyePreview(values, floatSize); - - return ret; - } - - private static void DrawLegacyDyePreview(LegacyDyePack values, float floatSize) - { - CtColorPicker("##diffusePreview"u8, default, values.DiffuseColor, "D"u8); - ImUtf8.SameLineInner(); - CtColorPicker("##specularPreview"u8, default, values.SpecularColor, "S"u8); - ImUtf8.SameLineInner(); - CtColorPicker("##emissivePreview"u8, default, values.EmissiveColor, "E"u8); - ImUtf8.SameLineInner(); - using var dis = ImRaii.Disabled(); - ImGui.SetNextItemWidth(floatSize); - var shininess = (float)values.Shininess; - ImGui.DragFloat("##shininessPreview", ref shininess, 0, shininess, shininess, "%.1f G"); - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(floatSize); - var specularMask = (float)values.SpecularMask * 100.0f; - ImGui.DragFloat("##specularMaskPreview", ref specularMask, 0, specularMask, specularMask, "%.0f%% S"); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LivePreview.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LivePreview.cs deleted file mode 100644 index dfa3a963..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.LivePreview.cs +++ /dev/null @@ -1,301 +0,0 @@ -using Dalamud.Bindings.ImGui; -using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Structs; -using Penumbra.Interop.MaterialPreview; -using Penumbra.Services; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - private readonly List _materialPreviewers = new(4); - private readonly List _colorTablePreviewers = new(4); - private int _highlightedColorTableRow = -1; - private int _highlightedColorTablePair = -1; - private readonly Stopwatch _highlightTime = new(); - - private void DrawMaterialLivePreviewRebind(bool disabled) - { - if (disabled) - return; - - if (ImUtf8.Button("Reload live preview"u8)) - BindToMaterialInstances(); - - if (_materialPreviewers.Count != 0 || _colorTablePreviewers.Count != 0) - return; - - ImGui.SameLine(); - using var c = ImRaii.PushColor(ImGuiCol.Text, Colors.RegexWarningBorder); - ImUtf8.Text( - "The current material has not been found on your character. Please check the Import from Screen tab for more information."u8); - } - - private unsafe void BindToMaterialInstances() - { - UnbindFromMaterialInstances(); - - var instances = MaterialInfo.FindMaterials(_resourceTreeFactory.GetLocalPlayerRelatedCharacters().Select(ch => ch.Address), - FilePath); - - var foundMaterials = new HashSet(); - foreach (var materialInfo in instances) - { - var material = materialInfo.GetDrawObjectMaterial(_objects); - if (foundMaterials.Contains((nint)material)) - continue; - - try - { - _materialPreviewers.Add(new LiveMaterialPreviewer(_objects, materialInfo)); - foundMaterials.Add((nint)material); - } - catch (InvalidOperationException) - { - // Carry on without that previewer. - } - } - - UpdateMaterialPreview(); - - if (Mtrl.Table == null) - return; - - foreach (var materialInfo in instances) - { - try - { - _colorTablePreviewers.Add(new LiveColorTablePreviewer(_objects, _framework, materialInfo)); - } - catch (InvalidOperationException) - { - // Carry on without that previewer. - } - } - - UpdateColorTablePreview(); - } - - private void UnbindFromMaterialInstances() - { - foreach (var previewer in _materialPreviewers) - previewer.Dispose(); - _materialPreviewers.Clear(); - - foreach (var previewer in _colorTablePreviewers) - previewer.Dispose(); - _colorTablePreviewers.Clear(); - } - - private unsafe void UnbindFromDrawObjectMaterialInstances(CharacterBase* characterBase) - { - for (var i = _materialPreviewers.Count; i-- > 0;) - { - var previewer = _materialPreviewers[i]; - if (previewer.DrawObject != characterBase) - continue; - - previewer.Dispose(); - _materialPreviewers.RemoveAt(i); - } - - for (var i = _colorTablePreviewers.Count; i-- > 0;) - { - var previewer = _colorTablePreviewers[i]; - if (previewer.DrawObject != characterBase) - continue; - - previewer.Dispose(); - _colorTablePreviewers.RemoveAt(i); - } - } - - private void SetShaderPackageFlags(uint shPkFlags) - { - foreach (var previewer in _materialPreviewers) - previewer.SetShaderPackageFlags(shPkFlags); - } - - private void SetMaterialParameter(uint parameterCrc, Index offset, Span value) - { - foreach (var previewer in _materialPreviewers) - previewer.SetMaterialParameter(parameterCrc, offset, value); - } - - private void SetSamplerFlags(uint samplerCrc, uint samplerFlags) - { - foreach (var previewer in _materialPreviewers) - previewer.SetSamplerFlags(samplerCrc, samplerFlags); - } - - private void UpdateMaterialPreview() - { - SetShaderPackageFlags(Mtrl.ShaderPackage.Flags); - foreach (var constant in Mtrl.ShaderPackage.Constants) - { - var values = Mtrl.GetConstantValue(constant); - if (values != []) - SetMaterialParameter(constant.Id, 0, values); - } - - foreach (var sampler in Mtrl.ShaderPackage.Samplers) - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - private void HighlightColorTablePair(int pairIdx) - { - var oldPairIdx = _highlightedColorTablePair; - - if (_highlightedColorTablePair != pairIdx) - { - _highlightedColorTablePair = pairIdx; - _highlightTime.Restart(); - } - - if (oldPairIdx >= 0) - { - UpdateColorTableRowPreview(oldPairIdx << 1); - UpdateColorTableRowPreview((oldPairIdx << 1) | 1); - } - - if (pairIdx >= 0) - { - UpdateColorTableRowPreview(pairIdx << 1); - UpdateColorTableRowPreview((pairIdx << 1) | 1); - } - } - - private void HighlightColorTableRow(int rowIdx) - { - var oldRowIdx = _highlightedColorTableRow; - - if (_highlightedColorTableRow != rowIdx) - { - _highlightedColorTableRow = rowIdx; - _highlightTime.Restart(); - } - - if (oldRowIdx >= 0) - UpdateColorTableRowPreview(oldRowIdx); - - if (rowIdx >= 0) - UpdateColorTableRowPreview(rowIdx); - } - - private void CancelColorTableHighlight() - { - var rowIdx = _highlightedColorTableRow; - var pairIdx = _highlightedColorTablePair; - - _highlightedColorTableRow = -1; - _highlightedColorTablePair = -1; - _highlightTime.Reset(); - - if (rowIdx >= 0) - UpdateColorTableRowPreview(rowIdx); - - if (pairIdx >= 0) - { - UpdateColorTableRowPreview(pairIdx << 1); - UpdateColorTableRowPreview((pairIdx << 1) | 1); - } - } - - private void UpdateColorTableRowPreview(int rowIdx) - { - if (_colorTablePreviewers.Count == 0) - return; - - if (Mtrl.Table == null) - return; - - var row = Mtrl.Table switch - { - LegacyColorTable legacyTable => new ColorTableRow(legacyTable[rowIdx]), - ColorTable table => table[rowIdx], - _ => throw new InvalidOperationException($"Unsupported color table type {Mtrl.Table.GetType()}"), - }; - if (Mtrl.DyeTable != null) - { - var dyeRow = Mtrl.DyeTable switch - { - LegacyColorDyeTable legacyDyeTable => new ColorDyeTableRow(legacyDyeTable[rowIdx]), - ColorDyeTable dyeTable => dyeTable[rowIdx], - _ => throw new InvalidOperationException($"Unsupported color dye table type {Mtrl.DyeTable.GetType()}"), - }; - if (dyeRow.Channel < StainService.ChannelCount) - { - StainId stainId = _stainService.GetStainCombo(dyeRow.Channel).CurrentSelection.Key; - if (_stainService.LegacyStmFile.TryGetValue(dyeRow.Template, stainId, out var legacyDyes)) - row.ApplyDye(dyeRow, legacyDyes); - if (_stainService.GudStmFile.TryGetValue(dyeRow.Template, stainId, out var gudDyes)) - row.ApplyDye(dyeRow, gudDyes); - } - } - - if (_highlightedColorTablePair << 1 == rowIdx || _highlightedColorTableRow == rowIdx) - ApplyHighlight(ref row, ColorId.InGameHighlight, (float)_highlightTime.Elapsed.TotalSeconds); - else if (((_highlightedColorTablePair << 1) | 1) == rowIdx) - ApplyHighlight(ref row, ColorId.InGameHighlight2, (float)_highlightTime.Elapsed.TotalSeconds); - - foreach (var previewer in _colorTablePreviewers) - { - row[..].CopyTo(previewer.GetColorRow(rowIdx)); - previewer.ScheduleUpdate(); - } - } - - private void UpdateColorTablePreview() - { - if (_colorTablePreviewers.Count == 0) - return; - - if (Mtrl.Table == null) - return; - - var rows = new ColorTable(Mtrl.Table); - var dyeRows = Mtrl.DyeTable != null ? ColorDyeTable.CastOrConvert(Mtrl.DyeTable) : null; - if (dyeRows != null) - { - ReadOnlySpan stainIds = - [ - _stainService.StainCombo1.CurrentSelection.Key, - _stainService.StainCombo2.CurrentSelection.Key, - ]; - rows.ApplyDye(_stainService.LegacyStmFile, stainIds, dyeRows); - rows.ApplyDye(_stainService.GudStmFile, stainIds, dyeRows); - } - - if (_highlightedColorTableRow >= 0) - ApplyHighlight(ref rows[_highlightedColorTableRow], ColorId.InGameHighlight, (float)_highlightTime.Elapsed.TotalSeconds); - - if (_highlightedColorTablePair >= 0) - { - ApplyHighlight(ref rows[_highlightedColorTablePair << 1], ColorId.InGameHighlight, (float)_highlightTime.Elapsed.TotalSeconds); - ApplyHighlight(ref rows[(_highlightedColorTablePair << 1) | 1], ColorId.InGameHighlight2, - (float)_highlightTime.Elapsed.TotalSeconds); - } - - foreach (var previewer in _colorTablePreviewers) - { - rows.AsHalves().CopyTo(previewer.ColorTable); - previewer.ScheduleUpdate(); - } - } - - private static void ApplyHighlight(ref ColorTableRow row, ColorId colorId, float time) - { - var level = (MathF.Sin(time * 2.0f * MathF.PI) + 2.0f) / 3.0f / 255.0f; - var baseColor = colorId.Value(); - var color = level * new Vector3(baseColor & 0xFF, (baseColor >> 8) & 0xFF, (baseColor >> 16) & 0xFF); - var halfColor = (HalfColor)(color * color); - - row.DiffuseColor = halfColor; - row.SpecularColor = halfColor; - row.EmissiveColor = halfColor; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ShaderPackage.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ShaderPackage.cs deleted file mode 100644 index 43040ca3..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.ShaderPackage.cs +++ /dev/null @@ -1,515 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui; -using OtterGui.Classes; -using OtterGui.Extensions; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.GameData; -using Penumbra.GameData.Data; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.ShaderStructs; -using Penumbra.Interop.Processing; -using Penumbra.String.Classes; -using static Penumbra.GameData.Files.ShpkFile; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - // strings path/to/the.exe | grep --fixed-strings '.shpk' | sort -u | sed -e 's#^shader/sm5/shpk/##' - // Apricot shader packages are unlisted because - // 1. they cause severe performance/memory issues when calculating the effective shader set - // 2. they probably aren't intended for use with materials anyway - private static readonly IReadOnlyList StandardShaderPackages = - [ - "3dui.shpk", - // "apricot_decal_dummy.shpk", - // "apricot_decal_ring.shpk", - // "apricot_decal.shpk", - // "apricot_fogModel.shpk", - // "apricot_gbuffer_decal_dummy.shpk", - // "apricot_gbuffer_decal_ring.shpk", - // "apricot_gbuffer_decal.shpk", - // "apricot_lightmodel.shpk", - // "apricot_model_dummy.shpk", - // "apricot_model_morph.shpk", - // "apricot_model.shpk", - // "apricot_powder_dummy.shpk", - // "apricot_powder.shpk", - // "apricot_shape_dummy.shpk", - // "apricot_shape.shpk", - "bgcolorchange.shpk", - "bg_composite.shpk", - "bgcrestchange.shpk", - "bgdecal.shpk", - "bgprop.shpk", - "bg.shpk", - "bguvscroll.shpk", - "characterglass.shpk", - "characterinc.shpk", - "characterlegacy.shpk", - "characterocclusion.shpk", - "characterreflection.shpk", - "characterscroll.shpk", - "charactershadowoffset.shpk", - "character.shpk", - "characterstockings.shpk", - "charactertattoo.shpk", - "charactertransparency.shpk", - "cloud.shpk", - "createviewposition.shpk", - "crystal.shpk", - "directionallighting.shpk", - "directionalshadow.shpk", - "furblur.shpk", - "grassdynamicwave.shpk", - "grass.shpk", - "hairmask.shpk", - "hair.shpk", - "iris.shpk", - "lightshaft.shpk", - "linelighting.shpk", - "planelighting.shpk", - "pointlighting.shpk", - "river.shpk", - "shadowmask.shpk", - "skin.shpk", - "spotlighting.shpk", - "subsurfaceblur.shpk", - "verticalfog.shpk", - "water.shpk", - "weather.shpk", - ]; - - private static readonly byte[] UnknownShadersString = "Vertex Shaders: ???\nPixel Shaders: ???"u8.ToArray(); - - private string[]? _shpkNames; - - private string _shaderHeader = "Shader###Shader"; - private FullPath _loadedShpkPath = FullPath.Empty; - private string _loadedShpkPathName = string.Empty; - private string _loadedShpkDevkitPathName = string.Empty; - private string _shaderComment = string.Empty; - private ShpkFile? _associatedShpk; - private bool _shpkLoading; - private JObject? _associatedShpkDevkit; - - private readonly string _loadedBaseDevkitPathName; - private readonly JObject? _associatedBaseDevkit; - - // Shader Key State - private readonly - List<(string Label, int Index, string Description, bool MonoFont, IReadOnlyList<(string Label, uint Value, string Description)> - Values)> _shaderKeys = new(16); - - private readonly HashSet _vertexShaders = new(16); - private readonly HashSet _pixelShaders = new(16); - private bool _shadersKnown; - private ReadOnlyMemory _shadersString = UnknownShadersString; - - private string[] GetShpkNames() - { - if (null != _shpkNames) - return _shpkNames; - - var names = new HashSet(StandardShaderPackages); - names.UnionWith(_edit.FindPathsStartingWith(ShpkPrefix).Select(path => path.ToString()[ShpkPrefixLength..])); - - _shpkNames = names.ToArray(); - Array.Sort(_shpkNames); - - return _shpkNames; - } - - private FullPath FindAssociatedShpk(out string defaultPath, out Utf8GamePath defaultGamePath) - { - defaultPath = GamePaths.Shader(Mtrl.ShaderPackage.Name); - if (!Utf8GamePath.FromString(defaultPath, out defaultGamePath)) - return FullPath.Empty; - - var path = _edit.FindBestMatch(defaultGamePath); - if (!path.IsRooted || ShpkPathPreProcessor.SanityCheck(path.FullName) == ShpkPathPreProcessor.SanityCheckResult.Success) - return path; - - return new FullPath(defaultPath); - } - - private void LoadShpk(FullPath path) - => Task.Run(() => DoLoadShpk(path)); - - private async Task DoLoadShpk(FullPath path) - { - _shadersKnown = false; - _shaderHeader = $"Shader ({Mtrl.ShaderPackage.Name})###Shader"; - _shpkLoading = true; - - try - { - var data = path.IsRooted - ? await File.ReadAllBytesAsync(path.FullName) - : _gameData.GetFile(path.InternalName.ToString())?.Data; - _loadedShpkPath = path; - _associatedShpk = data?.Length > 0 ? new ShpkFile(data) : throw new Exception("Failure to load file data."); - _loadedShpkPathName = path.ToPath(); - } - catch (Exception e) - { - _loadedShpkPath = FullPath.Empty; - _loadedShpkPathName = string.Empty; - _associatedShpk = null; - Penumbra.Messager.NotificationMessage(e, $"Could not load {_loadedShpkPath.ToPath()}.", NotificationType.Error, false); - } - finally - { - _shpkLoading = false; - } - - if (_loadedShpkPath.InternalName.IsEmpty) - { - _associatedShpkDevkit = null; - _loadedShpkDevkitPathName = string.Empty; - } - else - { - _associatedShpkDevkit = - TryLoadShpkDevkit(Path.GetFileNameWithoutExtension(Mtrl.ShaderPackage.Name), out _loadedShpkDevkitPathName); - } - - UpdateShaderKeys(); - _updateOnNextFrame = true; - } - - private void UpdateShaderKeys() - { - _shaderKeys.Clear(); - if (_associatedShpk != null) - foreach (var key in _associatedShpk.MaterialKeys) - { - var keyName = Names.KnownNames.TryResolve(key.Id); - var dkData = TryGetShpkDevkitData("ShaderKeys", key.Id, false); - var hasDkLabel = !string.IsNullOrEmpty(dkData?.Label); - - var valueSet = new HashSet(key.Values); - if (dkData != null) - valueSet.UnionWith(dkData.Values.Keys); - - var valueKnownNames = keyName.WithKnownSuffixes(); - - var mtrlKeyIndex = Mtrl.FindOrAddShaderKey(key.Id, key.DefaultValue); - var values = valueSet.Select(value => - { - var valueName = valueKnownNames.TryResolve(Names.KnownNames, value); - if (dkData != null && dkData.Values.TryGetValue(value, out var dkValue)) - return (dkValue.Label.Length > 0 ? dkValue.Label : valueName.ToString(), value, dkValue.Description); - - return (valueName.ToString(), value, string.Empty); - }).ToArray(); - Array.Sort(values, (x, y) => - { - if (x.Value == key.DefaultValue) - return -1; - if (y.Value == key.DefaultValue) - return 1; - - return string.Compare(x.Label, y.Label, StringComparison.Ordinal); - }); - _shaderKeys.Add((hasDkLabel ? dkData!.Label : keyName.ToString(), mtrlKeyIndex, dkData?.Description ?? string.Empty, - !hasDkLabel, values)); - } - else - foreach (var (key, index) in Mtrl.ShaderPackage.ShaderKeys.WithIndex()) - { - var keyName = Names.KnownNames.TryResolve(key.Key); - var valueName = keyName.WithKnownSuffixes().TryResolve(Names.KnownNames, key.Value); - _shaderKeys.Add((keyName.ToString(), index, string.Empty, true, [(valueName.ToString(), key.Value, string.Empty)])); - } - } - - private void UpdateShaders() - { - static void AddShader(HashSet globalSet, Dictionary> byPassSets, uint passId, int shaderIndex) - { - globalSet.Add(shaderIndex); - if (!byPassSets.TryGetValue(passId, out var passSet)) - { - passSet = []; - byPassSets.Add(passId, passSet); - } - - passSet.Add(shaderIndex); - } - - _vertexShaders.Clear(); - _pixelShaders.Clear(); - - var vertexShadersByPass = new Dictionary>(); - var pixelShadersByPass = new Dictionary>(); - - if (_associatedShpk == null || !_associatedShpk.IsExhaustiveNodeAnalysisFeasible()) - { - _shadersKnown = false; - } - else - { - _shadersKnown = true; - var systemKeySelectors = AllSelectors(_associatedShpk.SystemKeys).ToArray(); - var sceneKeySelectors = AllSelectors(_associatedShpk.SceneKeys).ToArray(); - var subViewKeySelectors = AllSelectors(_associatedShpk.SubViewKeys).ToArray(); - var materialKeySelector = - BuildSelector(_associatedShpk.MaterialKeys.Select(key => Mtrl.GetOrAddShaderKey(key.Id, key.DefaultValue).Value)); - - foreach (var systemKeySelector in systemKeySelectors) - { - foreach (var sceneKeySelector in sceneKeySelectors) - { - foreach (var subViewKeySelector in subViewKeySelectors) - { - var selector = BuildSelector(systemKeySelector, sceneKeySelector, materialKeySelector, subViewKeySelector); - var node = _associatedShpk.GetNodeBySelector(selector); - if (node.HasValue) - foreach (var pass in node.Value.Passes) - { - AddShader(_vertexShaders, vertexShadersByPass, pass.Id, (int)pass.VertexShader); - AddShader(_pixelShaders, pixelShadersByPass, pass.Id, (int)pass.PixelShader); - } - else - _shadersKnown = false; - } - } - } - } - - if (_shadersKnown) - { - var builder = new StringBuilder(); - foreach (var (passId, passVertexShader) in vertexShadersByPass) - { - if (builder.Length > 0) - builder.Append("\n\n"); - - var passName = Names.KnownNames.TryResolve(passId); - var shaders = passVertexShader.OrderBy(i => i).Select(i => $"#{i}"); - builder.Append($"Vertex Shaders ({passName}): {string.Join(", ", shaders)}"); - if (pixelShadersByPass.TryGetValue(passId, out var passPixelShader)) - { - shaders = passPixelShader.OrderBy(i => i).Select(i => $"#{i}"); - builder.Append($"\nPixel Shaders ({passName}): {string.Join(", ", shaders)}"); - } - } - - foreach (var (passId, passPixelShader) in pixelShadersByPass) - { - if (vertexShadersByPass.ContainsKey(passId)) - continue; - - if (builder.Length > 0) - builder.Append("\n\n"); - - var passName = Names.KnownNames.TryResolve(passId); - var shaders = passPixelShader.OrderBy(i => i).Select(i => $"#{i}"); - builder.Append($"Pixel Shaders ({passName}): {string.Join(", ", shaders)}"); - } - - _shadersString = Encoding.UTF8.GetBytes(builder.ToString()); - } - else - { - _shadersString = UnknownShadersString; - } - - _shaderComment = TryGetShpkDevkitData("Comment", null, true) ?? string.Empty; - } - - private bool DrawShaderSection(bool disabled) - { - var ret = false; - if (ImGui.CollapsingHeader(_shaderHeader)) - { - ret |= DrawPackageNameInput(disabled); - ret |= DrawShaderFlagsInput(disabled); - DrawCustomAssociations(); - ret |= DrawMaterialShaderKeys(disabled); - DrawMaterialShaders(); - } - - if (!_shpkLoading && (_associatedShpk == null || _associatedShpkDevkit == null)) - { - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - - if (_associatedShpk == null) - ImUtf8.Text("Unable to find a suitable shader (.shpk) file for cross-references. Some functionality will be missing."u8, - ImGuiUtil.HalfBlendText(0x80u)); // Half red - else - ImUtf8.Text( - "No dev-kit file found for this material's shaders. Please install one for optimal editing experience, such as actual constant names instead of hexadecimal identifiers."u8, - ImGuiUtil.HalfBlendText(0x8080u)); // Half yellow - } - - return ret; - } - - private bool DrawPackageNameInput(bool disabled) - { - if (disabled) - { - ImGui.TextUnformatted("Shader Package: " + Mtrl.ShaderPackage.Name); - return false; - } - - var ret = false; - ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); - using var c = ImRaii.Combo("Shader Package", Mtrl.ShaderPackage.Name); - if (c) - foreach (var value in GetShpkNames()) - { - if (!ImGui.Selectable(value, value == Mtrl.ShaderPackage.Name)) - continue; - - Mtrl.ShaderPackage.Name = value; - ret = true; - _associatedShpk = null; - _loadedShpkPath = FullPath.Empty; - UnpinResources(true); - LoadShpk(FindAssociatedShpk(out _, out _)); - } - - return ret; - } - - private bool DrawShaderFlagsInput(bool disabled) - { - var shpkFlags = (int)Mtrl.ShaderPackage.Flags; - ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); - if (!ImGui.InputInt("Shader Flags", ref shpkFlags, 0, 0, - flags: ImGuiInputTextFlags.CharsHexadecimal | (disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None))) - return false; - - Mtrl.ShaderPackage.Flags = (uint)shpkFlags; - SetShaderPackageFlags((uint)shpkFlags); - return true; - } - - /// - /// Show the currently associated shpk file, if any, and the buttons to associate - /// a specific shpk from your drive, the modded shpk by path or the default shpk. - /// - private void DrawCustomAssociations() - { - const string tooltip = "Click to copy file path to clipboard."; - var text = _associatedShpk == null - ? "Associated .shpk file: None" - : $"Associated .shpk file: {_loadedShpkPathName}"; - var devkitText = _associatedShpkDevkit == null - ? "Associated dev-kit file: None" - : $"Associated dev-kit file: {_loadedShpkDevkitPathName}"; - var baseDevkitText = _associatedBaseDevkit == null - ? "Base dev-kit file: None" - : $"Base dev-kit file: {_loadedBaseDevkitPathName}"; - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - - ImUtf8.CopyOnClickSelectable(text, _loadedShpkPathName, tooltip); - ImUtf8.CopyOnClickSelectable(devkitText, _loadedShpkDevkitPathName, tooltip); - ImUtf8.CopyOnClickSelectable(baseDevkitText, _loadedBaseDevkitPathName, tooltip); - - if (ImUtf8.Button("Associate Custom .shpk File"u8)) - _fileDialog.OpenFilePicker("Associate Custom .shpk File...", ".shpk", (success, name) => - { - if (success) - LoadShpk(new FullPath(name[0])); - }, 1, _edit.Mod!.ModPath.FullName, false); - - var moddedPath = FindAssociatedShpk(out var defaultPath, out var gamePath); - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Associate Default .shpk File"u8, moddedPath.ToPath(), Vector2.Zero, - moddedPath.Equals(_loadedShpkPath))) - LoadShpk(moddedPath); - - if (!gamePath.Path.Equals(moddedPath.InternalName)) - { - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Associate Unmodded .shpk File", defaultPath, Vector2.Zero, - gamePath.Path.Equals(_loadedShpkPath.InternalName))) - LoadShpk(new FullPath(gamePath)); - } - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - } - - private bool DrawMaterialShaderKeys(bool disabled) - { - if (_shaderKeys.Count == 0) - return false; - - var ret = false; - foreach (var (label, index, description, monoFont, values) in _shaderKeys) - { - using var font = ImRaii.PushFont(UiBuilder.MonoFont, monoFont); - ref var key = ref Mtrl.ShaderPackage.ShaderKeys[index]; - using var id = ImUtf8.PushId((int)key.Key); - var shpkKey = _associatedShpk?.GetMaterialKeyById(key.Key); - var currentValue = key.Value; - var (currentLabel, _, currentDescription) = - values.FirstOrNull(v => v.Value == currentValue) ?? ($"0x{currentValue:X8}", currentValue, string.Empty); - if (!disabled && shpkKey.HasValue) - { - ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); - using (var c = ImUtf8.Combo(""u8, currentLabel)) - { - if (c) - foreach (var (valueLabel, value, valueDescription) in values) - { - if (ImGui.Selectable(valueLabel, value == currentValue)) - { - key.Value = value; - ret = true; - UnpinResources(false); - Update(); - } - - if (valueDescription.Length > 0) - ImGuiUtil.SelectableHelpMarker(valueDescription); - } - } - - ImGui.SameLine(); - if (description.Length > 0) - ImGuiUtil.LabeledHelpMarker(label, description); - else - ImUtf8.Text(label); - } - else if (description.Length > 0 || currentDescription.Length > 0) - { - ImUtf8.LabeledHelpMarker($"{label}: {currentLabel}", - description + (description.Length > 0 && currentDescription.Length > 0 ? "\n\n" : string.Empty) + currentDescription); - } - else - { - ImUtf8.Text($"{label}: {currentLabel}"); - } - } - - return ret; - } - - private void DrawMaterialShaders() - { - if (_associatedShpk == null) - return; - - using (var node = ImUtf8.TreeNode("Candidate Shaders"u8)) - { - if (node) - ImUtf8.Text(_shadersString.Span); - } - - if (_shaderComment.Length > 0) - { - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - ImUtf8.Text(_shaderComment); - } - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Textures.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Textures.cs deleted file mode 100644 index 82ba7be4..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.Textures.cs +++ /dev/null @@ -1,300 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Extensions; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.String.Classes; -using static Penumbra.GameData.Files.MaterialStructs.SamplerFlags; -using static Penumbra.GameData.Files.ShpkFile; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public partial class MtrlTab -{ - public readonly List<(string Label, int TextureIndex, int SamplerIndex, string Description, bool MonoFont)> Textures = new(4); - - public readonly HashSet UnfoldedTextures = new(4); - public readonly HashSet TextureIds = new(16); - public readonly HashSet SamplerIds = new(16); - public float TextureLabelWidth; - private bool _samplersPinned; - - private void UpdateTextures() - { - Textures.Clear(); - TextureIds.Clear(); - SamplerIds.Clear(); - if (_associatedShpk == null) - { - TextureIds.UnionWith(Mtrl.ShaderPackage.Samplers.Select(sampler => sampler.SamplerId)); - SamplerIds.UnionWith(Mtrl.ShaderPackage.Samplers.Select(sampler => sampler.SamplerId)); - if (Mtrl.Table != null) - TextureIds.Add(TableSamplerId); - - foreach (var (sampler, index) in Mtrl.ShaderPackage.Samplers.WithIndex()) - Textures.Add(($"0x{sampler.SamplerId:X8}", sampler.TextureIndex, index, string.Empty, true)); - } - else - { - foreach (var index in _vertexShaders) - { - TextureIds.UnionWith(_associatedShpk.VertexShaders[index].Textures.Select(texture => texture.Id)); - SamplerIds.UnionWith(_associatedShpk.VertexShaders[index].Samplers.Select(sampler => sampler.Id)); - } - - foreach (var index in _pixelShaders) - { - TextureIds.UnionWith(_associatedShpk.PixelShaders[index].Textures.Select(texture => texture.Id)); - SamplerIds.UnionWith(_associatedShpk.PixelShaders[index].Samplers.Select(sampler => sampler.Id)); - } - - if (_samplersPinned || !_shadersKnown) - { - TextureIds.UnionWith(Mtrl.ShaderPackage.Samplers.Select(sampler => sampler.SamplerId)); - if (Mtrl.Table != null) - TextureIds.Add(TableSamplerId); - } - - foreach (var textureId in TextureIds) - { - var shpkTexture = _associatedShpk.GetTextureById(textureId); - if (shpkTexture is not { Slot: 2 } && (shpkTexture is not null || textureId == TableSamplerId)) - continue; - - var dkData = TryGetShpkDevkitData("Samplers", textureId, true); - var hasDkLabel = !string.IsNullOrEmpty(dkData?.Label); - - var sampler = Mtrl.GetOrAddSampler(textureId, dkData?.DefaultTexture ?? string.Empty, out var samplerIndex); - Textures.Add((hasDkLabel ? dkData!.Label : shpkTexture!.Value.Name, sampler.TextureIndex, samplerIndex, - dkData?.Description ?? string.Empty, !hasDkLabel)); - } - - if (TextureIds.Contains(TableSamplerId)) - Mtrl.Table ??= new ColorTable(); - } - - Textures.Sort((x, y) => string.CompareOrdinal(x.Label, y.Label)); - - TextureLabelWidth = 50f * UiHelpers.Scale; - - float helpWidth; - using (var _ = ImRaii.PushFont(UiBuilder.IconFont)) - { - helpWidth = ImGui.GetStyle().ItemSpacing.X + ImGui.CalcTextSize(FontAwesomeIcon.InfoCircle.ToIconString()).X; - } - - foreach (var (label, _, _, description, monoFont) in Textures) - { - if (!monoFont) - TextureLabelWidth = Math.Max(TextureLabelWidth, ImGui.CalcTextSize(label).X + (description.Length > 0 ? helpWidth : 0.0f)); - } - - using (var _ = ImRaii.PushFont(UiBuilder.MonoFont)) - { - foreach (var (label, _, _, description, monoFont) in Textures) - { - if (monoFont) - TextureLabelWidth = Math.Max(TextureLabelWidth, - ImGui.CalcTextSize(label).X + (description.Length > 0 ? helpWidth : 0.0f)); - } - } - - TextureLabelWidth = TextureLabelWidth / UiHelpers.Scale + 4; - } - - private static ReadOnlySpan TextureAddressModeTooltip(TextureAddressMode addressMode) - => addressMode switch - { - TextureAddressMode.Wrap => - "Tile the texture at every UV integer junction.\n\nFor example, for U values between 0 and 3, the texture is repeated three times."u8, - TextureAddressMode.Mirror => - "Flip the texture at every UV integer junction.\n\nFor U values between 0 and 1, for example, the texture is addressed normally; between 1 and 2, the texture is mirrored; between 2 and 3, the texture is normal again; and so on."u8, - TextureAddressMode.Clamp => - "Texture coordinates outside the range [0.0, 1.0] are set to the texture color at 0.0 or 1.0, respectively."u8, - TextureAddressMode.Border => "Texture coordinates outside the range [0.0, 1.0] are set to the border color (generally black)."u8, - _ => ""u8, - }; - - private bool DrawTextureSection(bool disabled) - { - if (Textures.Count == 0) - return false; - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - if (!ImGui.CollapsingHeader("Textures and Samplers", ImGuiTreeNodeFlags.DefaultOpen)) - return false; - - var frameHeight = ImGui.GetFrameHeight(); - var ret = false; - using var table = ImRaii.Table("##Textures", 3); - - ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, frameHeight); - ImGui.TableSetupColumn("Path", ImGuiTableColumnFlags.WidthStretch); - ImGui.TableSetupColumn("Name", ImGuiTableColumnFlags.WidthFixed, TextureLabelWidth * UiHelpers.Scale); - foreach (var (label, textureI, samplerI, description, monoFont) in Textures) - { - using var _ = ImRaii.PushId(samplerI); - var tmp = Mtrl.Textures[textureI].Path; - var unfolded = UnfoldedTextures.Contains(samplerI); - ImGui.TableNextColumn(); - if (ImGuiUtil.DrawDisabledButton((unfolded ? FontAwesomeIcon.CaretDown : FontAwesomeIcon.CaretRight).ToIconString(), - new Vector2(frameHeight), - "Settings for this texture and the associated sampler", false, true)) - { - unfolded = !unfolded; - if (unfolded) - UnfoldedTextures.Add(samplerI); - else - UnfoldedTextures.Remove(samplerI); - } - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(ImGui.GetContentRegionAvail().X); - if (ImGui.InputText(string.Empty, ref tmp, Utf8GamePath.MaxGamePathLength, - disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None) - && tmp.Length > 0 - && tmp != Mtrl.Textures[textureI].Path) - { - ret = true; - Mtrl.Textures[textureI].Path = tmp; - } - - ImGui.TableNextColumn(); - using (ImRaii.PushFont(UiBuilder.MonoFont, monoFont)) - { - ImGui.AlignTextToFramePadding(); - if (description.Length > 0) - ImGuiUtil.LabeledHelpMarker(label, description); - else - ImGui.TextUnformatted(label); - } - - if (unfolded) - { - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - ret |= DrawMaterialSampler(disabled, textureI, samplerI); - ImGui.TableNextColumn(); - } - } - - return ret; - } - - private static bool ComboTextureAddressMode(ReadOnlySpan label, ref TextureAddressMode value) - { - using var c = ImUtf8.Combo(label, value.ToString()); - if (!c) - return false; - - var ret = false; - foreach (var mode in Enum.GetValues()) - { - if (ImGui.Selectable(mode.ToString(), mode == value)) - { - value = mode; - ret = true; - } - - ImUtf8.SelectableHelpMarker(TextureAddressModeTooltip(mode)); - } - - return ret; - } - - private bool DrawMaterialSampler(bool disabled, int textureIdx, int samplerIdx) - { - var ret = false; - ref var texture = ref Mtrl.Textures[textureIdx]; - ref var sampler = ref Mtrl.ShaderPackage.Samplers[samplerIdx]; - - var dx11 = texture.DX11; - if (ImUtf8.Checkbox("Prepend -- to the file name on DirectX 11"u8, ref dx11)) - { - texture.DX11 = dx11; - ret = true; - } - - if (SamplerIds.Contains(sampler.SamplerId)) - { - ref var samplerFlags = ref Wrap(ref sampler.Flags); - - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - var addressMode = samplerFlags.UAddressMode; - if (ComboTextureAddressMode("##UAddressMode"u8, ref addressMode)) - { - samplerFlags.UAddressMode = addressMode; - ret = true; - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - ImGui.SameLine(); - ImUtf8.LabeledHelpMarker("U Address Mode"u8, - "Method to use for resolving a U texture coordinate that is outside the 0 to 1 range."); - - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - addressMode = samplerFlags.VAddressMode; - if (ComboTextureAddressMode("##VAddressMode"u8, ref addressMode)) - { - samplerFlags.VAddressMode = addressMode; - ret = true; - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - ImGui.SameLine(); - ImUtf8.LabeledHelpMarker("V Address Mode"u8, - "Method to use for resolving a V texture coordinate that is outside the 0 to 1 range."); - - var lodBias = samplerFlags.LodBias; - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - if (ImUtf8.DragScalar("##LoDBias"u8, ref lodBias, -8.0f, 7.984375f, 0.1f)) - { - samplerFlags.LodBias = lodBias; - ret = true; - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - ImGui.SameLine(); - ImUtf8.LabeledHelpMarker("Level of Detail Bias"u8, - "Offset from the calculated mipmap level.\n\nHigher means that the texture will start to lose detail nearer.\nLower means that the texture will keep its detail until farther."); - - var minLod = samplerFlags.MinLod; - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - if (ImUtf8.DragScalar("##MinLoD"u8, ref minLod, 0, 15, 0.1f)) - { - samplerFlags.MinLod = minLod; - ret = true; - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - ImGui.SameLine(); - ImUtf8.LabeledHelpMarker("Minimum Level of Detail"u8, - "Most detailed mipmap level to use.\n\n0 is the full-sized texture, 1 is the half-sized texture, 2 is the quarter-sized texture, and so on.\n15 will forcibly reduce the texture to its smallest mipmap."); - } - else - { - ImUtf8.Text("This texture does not have a dedicated sampler."u8); - } - - using var t = ImUtf8.TreeNode("Advanced Settings"u8); - if (!t) - return ret; - - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - if (ImUtf8.InputScalar("Texture Flags"u8, ref texture.Flags, "%04X"u8, - flags: disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None)) - ret = true; - - ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); - if (ImUtf8.InputScalar("Sampler Flags"u8, ref sampler.Flags, "%08X"u8, - flags: ImGuiInputTextFlags.CharsHexadecimal | (disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None))) - { - ret = true; - SetSamplerFlags(sampler.SamplerId, sampler.Flags); - } - - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.cs deleted file mode 100644 index 2c7c889e..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTab.cs +++ /dev/null @@ -1,228 +0,0 @@ -using Dalamud.Interface.Components; -using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Raii; -using OtterGui.Text; -using OtterGui.Widgets; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.MaterialStructs; -using Penumbra.GameData.Interop; -using Penumbra.Interop.Hooks.Objects; -using Penumbra.Interop.ResourceTree; -using Penumbra.Services; -using Penumbra.String; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public sealed partial class MtrlTab : IWritable, IDisposable -{ - private const int ShpkPrefixLength = 16; - - private static readonly CiByteString ShpkPrefix = CiByteString.FromSpanUnsafe("shader/sm5/shpk/"u8, true, true, true); - - private readonly IDataManager _gameData; - private readonly IFramework _framework; - private readonly ObjectManager _objects; - private readonly CharacterBaseDestructor _characterBaseDestructor; - private readonly StainService _stainService; - private readonly ResourceTreeFactory _resourceTreeFactory; - private readonly FileDialogService _fileDialog; - private readonly MaterialTemplatePickers _materialTemplatePickers; - private readonly Configuration _config; - - private readonly ModEditWindow _edit; - public readonly MtrlFile Mtrl; - public readonly string FilePath; - public readonly bool Writable; - - private bool _updateOnNextFrame; - - public unsafe MtrlTab(IDataManager gameData, IFramework framework, ObjectManager objects, CharacterBaseDestructor characterBaseDestructor, - StainService stainService, ResourceTreeFactory resourceTreeFactory, FileDialogService fileDialog, - MaterialTemplatePickers materialTemplatePickers, - Configuration config, ModEditWindow edit, MtrlFile file, string filePath, bool writable) - { - _gameData = gameData; - _framework = framework; - _objects = objects; - _characterBaseDestructor = characterBaseDestructor; - _stainService = stainService; - _resourceTreeFactory = resourceTreeFactory; - _fileDialog = fileDialog; - _materialTemplatePickers = materialTemplatePickers; - _config = config; - - _edit = edit; - Mtrl = file; - FilePath = filePath; - Writable = writable; - _samplersPinned = true; - _associatedBaseDevkit = TryLoadShpkDevkit("_base", out _loadedBaseDevkitPathName); - Update(); - LoadShpk(FindAssociatedShpk(out _, out _)); - if (writable) - { - _characterBaseDestructor.Subscribe(UnbindFromDrawObjectMaterialInstances, CharacterBaseDestructor.Priority.MtrlTab); - BindToMaterialInstances(); - } - } - - public bool DrawVersionUpdate(bool disabled) - { - if (disabled || Mtrl.IsDawntrail) - return false; - - if (!ImUtf8.ButtonEx("Update MTRL Version to Dawntrail"u8, - "Try using this if the material can not be loaded or should use legacy shaders.\n\nThis is not revertible."u8, - new Vector2(-0.1f, 0), false, 0, Colors.PressEnterWarningBg)) - return false; - - Mtrl.MigrateToDawntrail(); - Update(); - LoadShpk(FindAssociatedShpk(out _, out _)); - return true; - } - - public bool DrawPanel(bool disabled) - { - if (_updateOnNextFrame) - { - _updateOnNextFrame = false; - Update(); - } - - DrawMaterialLivePreviewRebind(disabled); - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - var ret = DrawBackFaceAndTransparency(disabled); - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - ret |= DrawShaderSection(disabled); - - ret |= DrawTextureSection(disabled); - ret |= DrawColorTableSection(disabled); - ret |= DrawConstantsSection(disabled); - - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - DrawOtherMaterialDetails(disabled); - - return !disabled && ret; - } - - private bool DrawBackFaceAndTransparency(bool disabled) - { - ref var shaderFlags = ref ShaderFlags.Wrap(ref Mtrl.ShaderPackage.Flags); - - var ret = false; - - using var dis = ImRaii.Disabled(disabled); - - var tmp = shaderFlags.EnableTransparency; - - // guardrail: the game crashes if transparency is enabled on characterstockings.shpk - var disallowTransparency = Mtrl.ShaderPackage.Name == "characterstockings.shpk"; - using (ImRaii.Disabled(disallowTransparency)) - { - if (ImUtf8.Checkbox("Enable Transparency"u8, ref tmp)) - { - shaderFlags.EnableTransparency = tmp; - ret = true; - SetShaderPackageFlags(Mtrl.ShaderPackage.Flags); - } - } - - if (disallowTransparency) - { - ImGuiComponents.HelpMarker("Enabling transparency for shader package characterstockings.shpk will crash the game."); - } - - ImGui.SameLine(200 * UiHelpers.Scale + ImGui.GetStyle().ItemSpacing.X + ImGui.GetStyle().WindowPadding.X); - tmp = shaderFlags.HideBackfaces; - if (ImUtf8.Checkbox("Hide Backfaces"u8, ref tmp)) - { - shaderFlags.HideBackfaces = tmp; - ret = true; - SetShaderPackageFlags(Mtrl.ShaderPackage.Flags); - } - - if (_shpkLoading) - { - ImGui.SameLine(400 * UiHelpers.Scale + 2 * ImGui.GetStyle().ItemSpacing.X + ImGui.GetStyle().WindowPadding.X); - - ImUtf8.Text("Loading shader (.shpk) file. Some functionality will only be available after this is done."u8, - ImGuiUtil.HalfBlendText(0x808000u)); // Half cyan - } - - return ret; - } - - private void DrawOtherMaterialDetails(bool _) - { - if (!ImUtf8.CollapsingHeader("Further Content"u8)) - return; - - using (var sets = ImUtf8.TreeNode("UV Sets"u8, ImGuiTreeNodeFlags.DefaultOpen)) - { - if (sets) - foreach (var set in Mtrl.UvSets) - ImUtf8.TreeNode($"#{set.Index:D2} - {set.Name}", ImGuiTreeNodeFlags.Leaf).Dispose(); - } - - using (var sets = ImUtf8.TreeNode("Color Sets"u8, ImGuiTreeNodeFlags.DefaultOpen)) - { - if (sets) - foreach (var set in Mtrl.ColorSets) - ImUtf8.TreeNode($"#{set.Index:D2} - {set.Name}", ImGuiTreeNodeFlags.Leaf).Dispose(); - } - - if (Mtrl.AdditionalData.Length <= 0) - return; - - using var t = ImUtf8.TreeNode($"Additional Data (Size: {Mtrl.AdditionalData.Length})###AdditionalData"); - if (t) - Widget.DrawHexViewer(Mtrl.AdditionalData); - } - - private void UnpinResources(bool all) - { - _samplersPinned = false; - - if (!all) - return; - - var keys = Mtrl.ShaderPackage.ShaderKeys; - for (var i = 0; i < keys.Length; i++) - keys[i].Pinned = false; - - var constants = Mtrl.ShaderPackage.Constants; - for (var i = 0; i < constants.Length; i++) - constants[i].Pinned = false; - } - - private void Update() - { - UpdateShaders(); - UpdateTextures(); - UpdateConstants(); - } - - public unsafe void Dispose() - { - UnbindFromMaterialInstances(); - if (Writable) - _characterBaseDestructor.Unsubscribe(UnbindFromDrawObjectMaterialInstances); - } - - public bool Valid - => Mtrl.Valid; // FIXME This should be _shadersKnown && Mtrl.Valid but the algorithm for _shadersKnown is flawed as of 7.2. - - public byte[] Write() - { - var output = Mtrl.Clone(); - output.GarbageCollect(_associatedShpk, TextureIds); - - return output.Write(); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Materials/MtrlTabFactory.cs b/Penumbra/UI/AdvancedWindow/Materials/MtrlTabFactory.cs deleted file mode 100644 index 09db4277..00000000 --- a/Penumbra/UI/AdvancedWindow/Materials/MtrlTabFactory.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Dalamud.Plugin.Services; -using OtterGui.Services; -using Penumbra.GameData.Files; -using Penumbra.GameData.Interop; -using Penumbra.Interop.Hooks.Objects; -using Penumbra.Interop.ResourceTree; -using Penumbra.Services; - -namespace Penumbra.UI.AdvancedWindow.Materials; - -public sealed class MtrlTabFactory( - IDataManager gameData, - IFramework framework, - ObjectManager objects, - CharacterBaseDestructor characterBaseDestructor, - StainService stainService, - ResourceTreeFactory resourceTreeFactory, - FileDialogService fileDialog, - MaterialTemplatePickers materialTemplatePickers, - Configuration config) : IUiService -{ - public MtrlTab Create(ModEditWindow edit, MtrlFile file, string filePath, bool writable) - => new(gameData, framework, objects, characterBaseDestructor, stainService, resourceTreeFactory, fileDialog, - materialTemplatePickers, config, edit, file, filePath, writable); -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/AtchMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/AtchMetaDrawer.cs deleted file mode 100644 index 4a74cda5..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/AtchMetaDrawer.cs +++ /dev/null @@ -1,294 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Extensions; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using OtterGui.Widgets; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.AtchStructs; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; -using Notification = OtterGui.Classes.Notification; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class AtchMetaDrawer : MetaDrawer, IService -{ - public override ReadOnlySpan Label - => "Attachment Points (ATCH)###ATCH"u8; - - public override int NumColumns - => 10; - - public override float ColumnHeight - => 2 * ImUtf8.FrameHeightSpacing; - - private AtchFile? _currentBaseAtchFile; - private AtchPoint? _currentBaseAtchPoint; - private readonly AtchPointCombo _combo; - private string _fileImport = string.Empty; - - public AtchMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : base(editor, metaFiles) - { - _combo = new AtchPointCombo(() => _currentBaseAtchFile?.Points.Select(p => p.Type).ToList() ?? []); - } - - private sealed class AtchPointCombo(Func> generator) - : FilterComboCache(generator, MouseWheelType.Control, Penumbra.Log) - { - protected override string ToString(AtchType obj) - => obj.ToName(); - } - - private sealed class RaceCodeException(string filePath) : Exception($"Could not identify race code from path {filePath}."); - - public void ImportFile(string filePath) - { - try - { - if (filePath.Length == 0 || !File.Exists(filePath)) - throw new FileNotFoundException(); - - var gr = Parser.ParseRaceCode(filePath); - if (gr is GenderRace.Unknown) - throw new RaceCodeException(filePath); - - var text = File.ReadAllBytes(filePath); - var file = new AtchFile(text); - foreach (var point in file.Points) - { - foreach (var (entry, index) in point.Entries.WithIndex()) - { - var identifier = new AtchIdentifier(point.Type, gr, (ushort)index); - var defaultValue = AtchCache.GetDefault(MetaFiles, identifier); - if (defaultValue == null) - continue; - - if (defaultValue.Value.Equals(entry)) - Editor.Changes |= Editor.Remove(identifier); - else - Editor.Changes |= Editor.TryAdd(identifier, entry) || Editor.Update(identifier, entry); - } - } - } - catch (RaceCodeException ex) - { - Penumbra.Messager.AddMessage(new Notification(ex, "The imported .atch file does not contain a race code (cXXXX) in its name.", - "Could not import .atch file:", - NotificationType.Warning)); - } - catch (Exception ex) - { - Penumbra.Messager.AddMessage(new Notification(ex, "Unable to import .atch file.", "Could not import .atch file:", - NotificationType.Warning)); - } - } - - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current ATCH manipulations to clipboard."u8, - new Lazy(() => MetaDictionary.SerializeTo([], Editor.Atch))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - var defaultEntry = AtchCache.GetDefault(MetaFiles, Identifier) ?? default; - DrawEntry(defaultEntry, ref defaultEntry, true); - } - - private void UpdateEntry() - => Entry = _currentBaseAtchPoint!.Entries[Identifier.EntryIndex]; - - protected override void Initialize() - { - _currentBaseAtchFile = MetaFiles.AtchManager.AtchFileBase[GenderRace.MidlanderMale]; - _currentBaseAtchPoint = _currentBaseAtchFile.Points.First(); - Identifier = new AtchIdentifier(_currentBaseAtchPoint.Type, GenderRace.MidlanderMale, 0); - Entry = _currentBaseAtchPoint.Entries[0]; - } - - protected override void DrawEntry(AtchIdentifier identifier, AtchEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = AtchCache.GetDefault(MetaFiles, identifier) ?? default; - if (DrawEntry(defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(AtchIdentifier, AtchEntry)> Enumerate() - => Editor.Atch.Select(kvp => (kvp.Key, kvp.Value)) - .OrderBy(p => p.Key.GenderRace) - .ThenBy(p => p.Key.Type) - .ThenBy(p => p.Key.EntryIndex); - - protected override int Count - => Editor.Atch.Count; - - private bool DrawIdentifierInput(ref AtchIdentifier identifier) - { - var changes = false; - ImGui.TableNextColumn(); - changes |= DrawRace(ref identifier); - ImGui.TableNextColumn(); - changes |= DrawGender(ref identifier, false); - if (changes) - UpdateFile(); - ImGui.TableNextColumn(); - if (DrawPointInput(ref identifier, _combo)) - { - _currentBaseAtchPoint = _currentBaseAtchFile?.GetPoint(identifier.Type); - changes = true; - } - - ImGui.TableNextColumn(); - changes |= DrawEntryIndexInput(ref identifier, _currentBaseAtchPoint!); - - return changes; - } - - private void UpdateFile() - { - _currentBaseAtchFile = MetaFiles.AtchManager.AtchFileBase[Identifier.GenderRace]; - _currentBaseAtchPoint = _currentBaseAtchFile.GetPoint(Identifier.Type); - if (_currentBaseAtchPoint == null) - { - _currentBaseAtchPoint = _currentBaseAtchFile.Points.First(); - Identifier = Identifier with { Type = _currentBaseAtchPoint.Type }; - } - - if (Identifier.EntryIndex >= _currentBaseAtchPoint.Entries.Length) - Identifier = Identifier with { EntryIndex = 0 }; - } - - private static void DrawIdentifier(AtchIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Race.ToName(), FrameColor); - ImUtf8.HoverTooltip("Model Race"u8); - - ImGui.TableNextColumn(); - DrawGender(ref identifier, true); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Type.ToName(), FrameColor); - ImUtf8.HoverTooltip("Attachment Point Type"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.EntryIndex.ToString(), FrameColor); - ImUtf8.HoverTooltip("State Entry Index"u8); - } - - private static bool DrawEntry(in AtchEntry defaultEntry, ref AtchEntry entry, bool disabled) - { - var changes = false; - using var dis = ImRaii.Disabled(disabled); - if (defaultEntry.Bone.Length == 0) - return false; - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(200 * ImUtf8.GlobalScale); - if (ImUtf8.InputText("##BoneName"u8, entry.FullSpan, out TerminatedByteString newBone)) - { - entry.SetBoneName(newBone); - changes = true; - } - - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Bone Name"u8); - - ImGui.SetNextItemWidth(200 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchScale"u8, ref entry.Scale); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Scale"u8); - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchOffsetX"u8, ref entry.OffsetX); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Offset X-Coordinate"u8); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchRotationX"u8, ref entry.RotationX); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Rotation X-Axis"u8); - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchOffsetY"u8, ref entry.OffsetY); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Offset Y-Coordinate"u8); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchRotationY"u8, ref entry.RotationY); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Rotation Y-Axis"u8); - - ImGui.TableNextColumn(); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchOffsetZ"u8, ref entry.OffsetZ); - ImUtf8.HoverTooltip("Offset Z-Coordinate"u8); - ImGui.SetNextItemWidth(120 * ImUtf8.GlobalScale); - changes |= ImUtf8.InputScalar("##AtchRotationZ"u8, ref entry.RotationZ); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "Rotation Z-Axis"u8); - - return changes; - } - - private static bool DrawRace(ref AtchIdentifier identifier, float unscaledWidth = 100) - { - var ret = Combos.Race("##atchRace", identifier.Race, out var race, unscaledWidth); - ImUtf8.HoverTooltip("Model Race"u8); - if (ret) - identifier = identifier with { GenderRace = Names.CombinedRace(identifier.Gender, race) }; - - return ret; - } - - private static bool DrawGender(ref AtchIdentifier identifier, bool disabled) - { - var isMale = identifier.Gender is Gender.Male; - - if (!ImUtf8.IconButton(isMale ? FontAwesomeIcon.Mars : FontAwesomeIcon.Venus, "Gender"u8, buttonColor: disabled ? 0x000F0000u : 0) - || disabled) - return false; - - identifier = identifier with { GenderRace = Names.CombinedRace(isMale ? Gender.Female : Gender.Male, identifier.Race) }; - return true; - } - - private static bool DrawPointInput(ref AtchIdentifier identifier, AtchPointCombo combo) - { - if (!combo.Draw("##AtchPoint", identifier.Type.ToName(), "Attachment Point Type", 160 * ImUtf8.GlobalScale, - ImGui.GetTextLineHeightWithSpacing())) - return false; - - identifier = identifier with { Type = combo.CurrentSelection }; - return true; - } - - private static bool DrawEntryIndexInput(ref AtchIdentifier identifier, AtchPoint currentAtchPoint) - { - var index = identifier.EntryIndex; - ImGui.SetNextItemWidth(40 * ImUtf8.GlobalScale); - var ret = ImUtf8.DragScalar("##AtchEntry"u8, ref index, 0, (ushort)(currentAtchPoint.Entries.Length - 1), 0.05f, - ImGuiSliderFlags.AlwaysClamp); - ImUtf8.HoverTooltip("State Entry Index"u8); - if (!ret) - return false; - - index = Math.Clamp(index, (ushort)0, (ushort)(currentAtchPoint.Entries.Length - 1)); - identifier = identifier with { EntryIndex = index }; - return true; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/AtrMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/AtrMetaDrawer.cs deleted file mode 100644 index 4b375c26..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/AtrMetaDrawer.cs +++ /dev/null @@ -1,274 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class AtrMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Attributes(ATR)###ATR"u8; - - private ShapeAttributeString _buffer = ShapeAttributeString.TryRead("atrx_"u8, out var s) ? s : ShapeAttributeString.Empty; - private bool _identifierValid; - - public override int NumColumns - => 7; - - public override float ColumnHeight - => ImUtf8.FrameHeightSpacing; - - protected override void Initialize() - { - Identifier = new AtrIdentifier(HumanSlot.Unknown, null, ShapeAttributeString.Empty, GenderRace.Unknown); - Entry = AtrEntry.True; - } - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current ATR manipulations to clipboard."u8, - new Lazy(() => MetaDictionary.SerializeTo([], Editor.Atr))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier) && _identifierValid; - var tt = canAdd - ? "Stage this edit."u8 - : _identifierValid - ? "This entry does not contain a valid attribute."u8 - : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, AtrEntry.False); - - DrawIdentifierInput(ref Identifier); - DrawEntry(ref Entry, true); - } - - protected override void DrawEntry(AtrIdentifier identifier, AtrEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - if (DrawEntry(ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(AtrIdentifier, AtrEntry)> Enumerate() - => Editor.Atr - .OrderBy(kvp => kvp.Key.Attribute) - .ThenBy(kvp => kvp.Key.Slot) - .ThenBy(kvp => kvp.Key.Id) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Atr.Count; - - private bool DrawIdentifierInput(ref AtrIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawHumanSlot(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawGenderRaceConditionInput(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawAttributeKeyInput(ref identifier, ref _buffer, ref _identifierValid); - return changes; - } - - private static void DrawIdentifier(AtrIdentifier identifier) - { - ImGui.TableNextColumn(); - - ImUtf8.TextFramed(ShpMetaDrawer.SlotName(identifier.Slot), FrameColor); - ImUtf8.HoverTooltip("Model Slot"u8); - - ImGui.TableNextColumn(); - if (identifier.GenderRaceCondition is not GenderRace.Unknown) - { - ImUtf8.TextFramed($"{identifier.GenderRaceCondition.ToName()} ({identifier.GenderRaceCondition.ToRaceCode()})", FrameColor); - ImUtf8.HoverTooltip("Gender & Race Code for this attribute to be set."); - } - else - { - ImUtf8.TextFramed("Any Gender & Race"u8, FrameColor); - } - - ImGui.TableNextColumn(); - if (identifier.Id.HasValue) - ImUtf8.TextFramed($"{identifier.Id.Value.Id}", FrameColor); - else - ImUtf8.TextFramed("All IDs"u8, FrameColor); - ImUtf8.HoverTooltip("Primary ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Attribute.AsSpan, FrameColor); - } - - private static bool DrawEntry(ref AtrEntry entry, bool disabled) - { - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var value = entry.Value; - var changes = ImUtf8.Checkbox("##atrEntry"u8, ref value); - if (changes) - entry = new AtrEntry(value); - ImUtf8.HoverTooltip("Whether to enable or disable this attribute for the selected items."); - return changes; - } - - public static bool DrawPrimaryId(ref AtrIdentifier identifier, float unscaledWidth = 100) - { - var allSlots = identifier.Slot is HumanSlot.Unknown; - var all = !identifier.Id.HasValue; - var ret = false; - using (ImRaii.Disabled(allSlots)) - { - if (ImUtf8.Checkbox("##atrAll"u8, ref all)) - { - identifier = identifier with { Id = all ? null : 0 }; - ret = true; - } - } - - ImUtf8.HoverTooltip(allSlots - ? "When using all slots, you also need to use all IDs."u8 - : "Enable this attribute for all model IDs."u8); - - ImGui.SameLine(0, ImGui.GetStyle().ItemInnerSpacing.X); - if (all) - { - using var style = ImRaii.PushStyle(ImGuiStyleVar.ButtonTextAlign, new Vector2(0.05f, 0.5f)); - ImUtf8.TextFramed("All IDs"u8, ImGui.GetColorU32(ImGuiCol.FrameBg, all || allSlots ? ImGui.GetStyle().DisabledAlpha : 1f), - new Vector2(unscaledWidth, 0), ImGui.GetColorU32(ImGuiCol.TextDisabled)); - } - else - { - var max = identifier.Slot.ToSpecificEnum() is BodySlot ? byte.MaxValue : ExpandedEqpGmpBase.Count - 1; - if (IdInput("##atrPrimaryId"u8, unscaledWidth, identifier.Id.GetValueOrDefault(0).Id, out var setId, 0, max, false)) - { - identifier = identifier with { Id = setId }; - ret = true; - } - } - - ImUtf8.HoverTooltip("Primary ID - You can usually find this as the 'e####' part of an item path or similar for customizations."u8); - - return ret; - } - - public bool DrawHumanSlot(ref AtrIdentifier identifier, float unscaledWidth = 150) - { - var ret = false; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - using (var combo = ImUtf8.Combo("##atrSlot"u8, ShpMetaDrawer.SlotName(identifier.Slot))) - { - if (combo) - foreach (var slot in ShpMetaDrawer.AvailableSlots) - { - if (!ImUtf8.Selectable(ShpMetaDrawer.SlotName(slot), slot == identifier.Slot) || slot == identifier.Slot) - continue; - - ret = true; - if (slot is HumanSlot.Unknown) - { - identifier = identifier with - { - Id = null, - Slot = slot, - }; - } - else - { - identifier = identifier with - { - Id = identifier.Id.HasValue - ? (PrimaryId)Math.Clamp(identifier.Id.Value.Id, 0, - slot.ToSpecificEnum() is BodySlot ? byte.MaxValue : ExpandedEqpGmpBase.Count - 1) - : null, - Slot = slot, - }; - ret = true; - } - } - } - - ImUtf8.HoverTooltip("Model Slot"u8); - return ret; - } - - private static bool DrawGenderRaceConditionInput(ref AtrIdentifier identifier, float unscaledWidth = 250) - { - var ret = false; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - - using (var combo = ImUtf8.Combo("##shpGenderRace"u8, - identifier.GenderRaceCondition is GenderRace.Unknown - ? "Any Gender & Race" - : $"{identifier.GenderRaceCondition.ToName()} ({identifier.GenderRaceCondition.ToRaceCode()})")) - { - if (combo) - { - if (ImUtf8.Selectable("Any Gender & Race"u8, identifier.GenderRaceCondition is GenderRace.Unknown) - && identifier.GenderRaceCondition is not GenderRace.Unknown) - { - identifier = identifier with { GenderRaceCondition = GenderRace.Unknown }; - ret = true; - } - - foreach (var gr in ShapeAttributeHashSet.GenderRaceValues.Skip(1)) - { - if (ImUtf8.Selectable($"{gr.ToName()} ({gr.ToRaceCode()})", identifier.GenderRaceCondition == gr) - && identifier.GenderRaceCondition != gr) - { - identifier = identifier with { GenderRaceCondition = gr }; - ret = true; - } - } - } - } - - ImUtf8.HoverTooltip( - "Only activate this attribute for this gender & race code."u8); - - return ret; - } - - public static unsafe bool DrawAttributeKeyInput(ref AtrIdentifier identifier, ref ShapeAttributeString buffer, ref bool valid, - float unscaledWidth = 150) - { - var ret = false; - var ptr = Unsafe.AsPointer(ref buffer); - var span = new Span(ptr, ShapeAttributeString.MaxLength + 1); - using (new ImRaii.ColorStyle().Push(ImGuiCol.Border, Colors.RegexWarningBorder, !valid).Push(ImGuiStyleVar.FrameBorderSize, 1f, !valid)) - { - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - if (ImUtf8.InputText("##atrAttribute"u8, span, out int newLength, "Attribute..."u8)) - { - buffer.ForceLength((byte)newLength); - valid = buffer.ValidateCustomAttributeString(); - if (valid) - identifier = identifier with { Attribute = buffer }; - ret = true; - } - } - - ImUtf8.HoverTooltip("Supported attribute need to have the format `atrx_*` and a maximum length of 30 characters."u8); - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/EqdpMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/EqdpMetaDrawer.cs deleted file mode 100644 index 16af5217..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/EqdpMetaDrawer.cs +++ /dev/null @@ -1,166 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Enums; -using Penumbra.Interop.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class EqdpMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Racial Model Edits (EQDP)###EQDP"u8; - - public override int NumColumns - => 7; - - protected override void Initialize() - { - Identifier = new EqdpIdentifier(1, EquipSlot.Head, GenderRace.MidlanderMale); - UpdateEntry(); - } - - private void UpdateEntry() - => Entry = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(MetaFiles, Identifier), Identifier.Slot); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current EQDP manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Eqdp))); - - ImGui.TableNextColumn(); - var validRaceCode = CharacterUtilityData.EqdpIdx(Identifier.GenderRace, false) >= 0; - var canAdd = validRaceCode && !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : - validRaceCode ? "This entry is already edited."u8 : "This combination of race and gender can not be used."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - DrawEntry(Entry, ref Entry, true); - } - - protected override void DrawEntry(EqdpIdentifier identifier, EqdpEntryInternal entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = new EqdpEntryInternal(ExpandedEqdpFile.GetDefault(MetaFiles, identifier), identifier.Slot); - if (DrawEntry(defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(EqdpIdentifier, EqdpEntryInternal)> Enumerate() - => Editor.Eqdp.OrderBy(kvp => kvp.Key.SetId.Id) - .ThenBy(kvp => kvp.Key.GenderRace) - .ThenBy(kvp => kvp.Key.Slot) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Eqdp.Count; - - private static bool DrawIdentifierInput(ref EqdpIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawRace(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawGender(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawEquipSlot(ref identifier); - return changes; - } - - private static void DrawIdentifier(EqdpIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.SetId.Id}", FrameColor); - ImUtf8.HoverTooltip("Model Set ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Race.ToName(), FrameColor); - ImUtf8.HoverTooltip("Model Race"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Gender.ToName(), FrameColor); - ImUtf8.HoverTooltip("Gender"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Slot.ToName(), FrameColor); - ImUtf8.HoverTooltip("Equip Slot"u8); - } - - private static bool DrawEntry(EqdpEntryInternal defaultEntry, ref EqdpEntryInternal entry, bool disabled) - { - var changes = false; - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - if (Checkmark("Material##eqdp"u8, "\0"u8, entry.Material, defaultEntry.Material, out var newMaterial)) - { - entry = entry with { Material = newMaterial }; - changes = true; - } - - ImGui.SameLine(); - if (Checkmark("Model##eqdp"u8, "\0"u8, entry.Model, defaultEntry.Model, out var newModel)) - { - entry = entry with { Model = newModel }; - changes = true; - } - - return changes; - } - - public static bool DrawPrimaryId(ref EqdpIdentifier identifier, float unscaledWidth = 100) - { - var ret = IdInput("##eqdpPrimaryId"u8, unscaledWidth, identifier.SetId.Id, out var setId, 0, ExpandedEqpGmpBase.Count - 1, - identifier.SetId.Id <= 1); - ImUtf8.HoverTooltip( - "Model Set ID - You can usually find this as the 'e####' part of an item path.\nThis should generally not be left <= 1 unless you explicitly want that."u8); - if (ret) - identifier = identifier with { SetId = setId }; - return ret; - } - - public static bool DrawRace(ref EqdpIdentifier identifier, float unscaledWidth = 100) - { - var ret = Combos.Race("##eqdpRace", identifier.Race, out var race, unscaledWidth); - ImUtf8.HoverTooltip("Model Race"u8); - if (ret) - identifier = identifier with { GenderRace = Names.CombinedRace(identifier.Gender, race) }; - return ret; - } - - public static bool DrawGender(ref EqdpIdentifier identifier, float unscaledWidth = 120) - { - var ret = Combos.Gender("##eqdpGender", identifier.Gender, out var gender, unscaledWidth); - ImUtf8.HoverTooltip("Gender"u8); - if (ret) - identifier = identifier with { GenderRace = Names.CombinedRace(gender, identifier.Race) }; - return ret; - } - - public static bool DrawEquipSlot(ref EqdpIdentifier identifier, float unscaledWidth = 100) - { - var ret = Combos.EqdpEquipSlot("##eqdpSlot", identifier.Slot, out var slot, unscaledWidth); - ImUtf8.HoverTooltip("Equip Slot"u8); - if (ret) - identifier = identifier with { Slot = slot }; - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/EqpMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/EqpMetaDrawer.cs deleted file mode 100644 index 77c2915a..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/EqpMetaDrawer.cs +++ /dev/null @@ -1,141 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class EqpMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Equipment Parameter Edits (EQP)###EQP"u8; - - public override int NumColumns - => 5; - - protected override void Initialize() - { - Identifier = new EqpIdentifier(1, EquipSlot.Body); - UpdateEntry(); - } - - private void UpdateEntry() - => Entry = new EqpEntryInternal(ExpandedEqpFile.GetDefault(MetaFiles, Identifier.SetId), Identifier.Slot); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current EQP manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Eqp))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - DrawEntry(Identifier.Slot, Entry, ref Entry, true); - } - - protected override void DrawEntry(EqpIdentifier identifier, EqpEntryInternal entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = new EqpEntryInternal(ExpandedEqpFile.GetDefault(MetaFiles, identifier.SetId), identifier.Slot); - if (DrawEntry(identifier.Slot, defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(EqpIdentifier, EqpEntryInternal)> Enumerate() - => Editor.Eqp - .OrderBy(kvp => kvp.Key.SetId.Id) - .ThenBy(kvp => kvp.Key.Slot) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Eqp.Count; - - private static bool DrawIdentifierInput(ref EqpIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawEquipSlot(ref identifier); - return changes; - } - - private static void DrawIdentifier(EqpIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.SetId.Id}", FrameColor); - ImUtf8.HoverTooltip("Model Set ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Slot.ToName(), FrameColor); - ImUtf8.HoverTooltip("Equip Slot"u8); - } - - private static bool DrawEntry(EquipSlot slot, EqpEntryInternal defaultEntry, ref EqpEntryInternal entry, bool disabled) - { - var changes = false; - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var offset = Eqp.OffsetAndMask(slot).Item1; - DrawBox(ref entry, 0); - for (var i = 1; i < Eqp.EqpAttributes[slot].Count; ++i) - { - ImUtf8.SameLineInner(); - DrawBox(ref entry, i); - } - - return changes; - - void DrawBox(ref EqpEntryInternal entry, int i) - { - using var id = ImUtf8.PushId(i); - var flag = 1u << i; - var eqpFlag = (EqpEntry)((ulong)flag << offset); - var defaultValue = (flag & defaultEntry.Value) != 0; - var value = (flag & entry.Value) != 0; - if (Checkmark("##eqp"u8, eqpFlag.ToLocalName(), value, defaultValue, out var newValue)) - { - entry = new EqpEntryInternal(newValue ? entry.Value | flag : entry.Value & ~flag); - changes = true; - } - } - } - - public static bool DrawPrimaryId(ref EqpIdentifier identifier, float unscaledWidth = 100) - { - var ret = IdInput("##eqpPrimaryId"u8, unscaledWidth, identifier.SetId.Id, out var setId, 0, ExpandedEqpGmpBase.Count - 1, - identifier.SetId.Id <= 1); - ImUtf8.HoverTooltip( - "Model Set ID - You can usually find this as the 'e####' part of an item path.\nThis should generally not be left <= 1 unless you explicitly want that."u8); - if (ret) - identifier = identifier with { SetId = setId }; - return ret; - } - - public static bool DrawEquipSlot(ref EqpIdentifier identifier, float unscaledWidth = 100) - { - var ret = Combos.EqpEquipSlot("##eqpSlot", identifier.Slot, out var slot, unscaledWidth); - ImUtf8.HoverTooltip("Equip Slot"u8); - if (ret) - identifier = identifier with { Slot = slot }; - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/EstMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/EstMetaDrawer.cs deleted file mode 100644 index 84e09be5..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/EstMetaDrawer.cs +++ /dev/null @@ -1,155 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Enums; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class EstMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Extra Skeleton Parameters (EST)###EST"u8; - - public override int NumColumns - => 7; - - protected override void Initialize() - { - Identifier = new EstIdentifier(1, EstType.Hair, GenderRace.MidlanderMale); - UpdateEntry(); - } - - private void UpdateEntry() - => Entry = EstFile.GetDefault(MetaFiles, Identifier.Slot, Identifier.GenderRace, Identifier.SetId); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current EST manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Est))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - DrawEntry(Entry, ref Entry, true); - } - - protected override void DrawEntry(EstIdentifier identifier, EstEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = EstFile.GetDefault(MetaFiles, identifier.Slot, identifier.GenderRace, identifier.SetId); - if (DrawEntry(defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(EstIdentifier, EstEntry)> Enumerate() - => Editor.Est - .OrderBy(kvp => kvp.Key.SetId.Id) - .ThenBy(kvp => kvp.Key.GenderRace) - .ThenBy(kvp => kvp.Key.Slot) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Est.Count; - - private static bool DrawIdentifierInput(ref EstIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawRace(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawGender(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawSlot(ref identifier); - - return changes; - } - - private static void DrawIdentifier(EstIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.SetId.Id}", FrameColor); - ImUtf8.HoverTooltip("Model Set ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Race.ToName(), FrameColor); - ImUtf8.HoverTooltip("Model Race"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Gender.ToName(), FrameColor); - ImUtf8.HoverTooltip("Gender"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Slot.ToString(), FrameColor); - ImUtf8.HoverTooltip("Extra Skeleton Type"u8); - } - - private static bool DrawEntry(EstEntry defaultEntry, ref EstEntry entry, bool disabled) - { - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var ret = DragInput("##estValue"u8, [], 100f * ImUtf8.GlobalScale, entry.Value, defaultEntry.Value, out var newValue, (ushort)0, - ushort.MaxValue, 0.05f, !disabled); - if (ret) - entry = new EstEntry(newValue); - return ret; - } - - public static bool DrawPrimaryId(ref EstIdentifier identifier, float unscaledWidth = 100) - { - var ret = IdInput("##estPrimaryId"u8, unscaledWidth, identifier.SetId.Id, out var setId, 0, ExpandedEqpGmpBase.Count - 1, - identifier.SetId.Id <= 1); - ImUtf8.HoverTooltip( - "Model Set ID - You can usually find this as the 'e####' part of an item path.\nThis should generally not be left <= 1 unless you explicitly want that."u8); - if (ret) - identifier = identifier with { SetId = setId }; - return ret; - } - - public static bool DrawRace(ref EstIdentifier identifier, float unscaledWidth = 100) - { - var ret = Combos.Race("##estRace", identifier.Race, out var race, unscaledWidth); - ImUtf8.HoverTooltip("Model Race"u8); - if (ret) - identifier = identifier with { GenderRace = Names.CombinedRace(identifier.Gender, race) }; - return ret; - } - - public static bool DrawGender(ref EstIdentifier identifier, float unscaledWidth = 120) - { - var ret = Combos.Gender("##estGender", identifier.Gender, out var gender, unscaledWidth); - ImUtf8.HoverTooltip("Gender"u8); - if (ret) - identifier = identifier with { GenderRace = Names.CombinedRace(gender, identifier.Race) }; - return ret; - } - - public static bool DrawSlot(ref EstIdentifier identifier, float unscaledWidth = 200) - { - var ret = Combos.EstSlot("##estSlot", identifier.Slot, out var slot, unscaledWidth); - ImUtf8.HoverTooltip("Extra Skeleton Type"u8); - if (ret) - identifier = identifier with { Slot = slot }; - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/GlobalEqpMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/GlobalEqpMetaDrawer.cs deleted file mode 100644 index b03f4aa5..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/GlobalEqpMetaDrawer.cs +++ /dev/null @@ -1,118 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class GlobalEqpMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Global Equipment Parameter Edits (Global EQP)###GEQP"u8; - - public override int NumColumns - => 4; - - protected override void Initialize() - { - Identifier = new GlobalEqpManipulation() - { - Condition = 1, - Type = GlobalEqpType.DoNotHideEarrings, - }; - } - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current global EQP manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.GlobalEqp))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier); - - DrawIdentifierInput(ref Identifier); - } - - protected override void DrawEntry(GlobalEqpManipulation identifier, byte _) - { - DrawMetaButtons(identifier, 0); - DrawIdentifier(identifier); - } - - protected override IEnumerable<(GlobalEqpManipulation, byte)> Enumerate() - => Editor.GlobalEqp - .OrderBy(identifier => identifier.Type) - .ThenBy(identifier => identifier.Condition.Id) - .Select(identifier => (identifier, (byte)0)); - - protected override int Count - => Editor.GlobalEqp.Count; - - private static void DrawIdentifierInput(ref GlobalEqpManipulation identifier) - { - ImGui.TableNextColumn(); - DrawType(ref identifier); - - ImGui.TableNextColumn(); - if (identifier.Type.HasCondition()) - DrawCondition(ref identifier); - else - ImUtf8.ScaledDummy(100); - } - - private static void DrawIdentifier(GlobalEqpManipulation identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Type.ToName(), FrameColor); - ImUtf8.HoverTooltip("Global EQP Type"u8); - - ImGui.TableNextColumn(); - if (identifier.Type.HasCondition()) - { - ImUtf8.TextFramed($"{identifier.Condition.Id}", FrameColor); - ImUtf8.HoverTooltip("Conditional Model ID"u8); - } - } - - public static bool DrawType(ref GlobalEqpManipulation identifier, float unscaledWidth = 250) - { - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - using var combo = ImUtf8.Combo("##geqpType"u8, identifier.Type.ToName()); - if (!combo) - return false; - - var ret = false; - foreach (var type in Enum.GetValues()) - { - if (ImUtf8.Selectable(type.ToName(), type == identifier.Type)) - { - identifier = new GlobalEqpManipulation - { - Type = type, - Condition = type.HasCondition() ? identifier.Type.HasCondition() ? identifier.Condition : 1 : 0, - }; - ret = true; - } - - ImUtf8.HoverTooltip(type.ToDescription()); - } - - return ret; - } - - public static void DrawCondition(ref GlobalEqpManipulation identifier, float unscaledWidth = 100) - { - if (IdInput("##geqpCond"u8, unscaledWidth, identifier.Condition.Id, out var newId, 1, ushort.MaxValue, - identifier.Condition.Id <= 1)) - identifier = identifier with { Condition = newId }; - ImUtf8.HoverTooltip("The Model ID for the item that should not be hidden."u8); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/GmpMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/GmpMetaDrawer.cs deleted file mode 100644 index 4053560b..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/GmpMetaDrawer.cs +++ /dev/null @@ -1,154 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Structs; -using Penumbra.Meta.Files; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Newtonsoft.Json.Linq; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class GmpMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Visor/Gimmick Edits (GMP)###GMP"u8; - - public override int NumColumns - => 7; - - protected override void Initialize() - { - Identifier = new GmpIdentifier(1); - UpdateEntry(); - } - - private void UpdateEntry() - => Entry = ExpandedGmpFile.GetDefault(MetaFiles, Identifier.SetId); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current Gmp manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Gmp))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - DrawEntry(Entry, ref Entry, true); - } - - protected override void DrawEntry(GmpIdentifier identifier, GmpEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = ExpandedGmpFile.GetDefault(MetaFiles, identifier.SetId); - if (DrawEntry(defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(GmpIdentifier, GmpEntry)> Enumerate() - => Editor.Gmp - .OrderBy(kvp => kvp.Key.SetId.Id) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Gmp.Count; - - private static bool DrawIdentifierInput(ref GmpIdentifier identifier) - { - ImGui.TableNextColumn(); - return DrawPrimaryId(ref identifier); - } - - private static void DrawIdentifier(GmpIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.SetId.Id}", FrameColor); - ImUtf8.HoverTooltip("Model Set ID"u8); - } - - private static bool DrawEntry(GmpEntry defaultEntry, ref GmpEntry entry, bool disabled) - { - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var changes = false; - if (Checkmark("##gmpEnabled"u8, "Gimmick Enabled", entry.Enabled, defaultEntry.Enabled, out var enabled)) - { - entry = entry with { Enabled = enabled }; - changes = true; - } - - ImGui.TableNextColumn(); - if (Checkmark("##gmpAnimated"u8, "Gimmick Animated", entry.Animated, defaultEntry.Animated, out var animated)) - { - entry = entry with { Animated = animated }; - changes = true; - } - - var rotationWidth = 75 * ImUtf8.GlobalScale; - ImGui.TableNextColumn(); - if (DragInput("##gmpRotationA"u8, "Rotation A in Degrees"u8, rotationWidth, entry.RotationA, defaultEntry.RotationA, out var rotationA, - (ushort)0, (ushort)360, 0.05f, !disabled)) - { - entry = entry with { RotationA = rotationA }; - changes = true; - } - - ImUtf8.SameLineInner(); - if (DragInput("##gmpRotationB"u8, "Rotation B in Degrees"u8, rotationWidth, entry.RotationB, defaultEntry.RotationB, out var rotationB, - (ushort)0, (ushort)360, 0.05f, !disabled)) - { - entry = entry with { RotationB = rotationB }; - changes = true; - } - - ImUtf8.SameLineInner(); - if (DragInput("##gmpRotationC"u8, "Rotation C in Degrees"u8, rotationWidth, entry.RotationC, defaultEntry.RotationC, out var rotationC, - (ushort)0, (ushort)360, 0.05f, !disabled)) - { - entry = entry with { RotationC = rotationC }; - changes = true; - } - - var unkWidth = 50 * ImUtf8.GlobalScale; - ImGui.TableNextColumn(); - if (DragInput("##gmpUnkA"u8, "Animation Type A?"u8, unkWidth, entry.UnknownA, defaultEntry.UnknownA, out var unknownA, - (byte)0, (byte)15, 0.01f, !disabled)) - { - entry = entry with { UnknownA = unknownA }; - changes = true; - } - - ImUtf8.SameLineInner(); - if (DragInput("##gmpUnkB"u8, "Animation Type B?"u8, unkWidth, entry.UnknownB, defaultEntry.UnknownB, out var unknownB, - (byte)0, (byte)15, 0.01f, !disabled)) - { - entry = entry with { UnknownB = unknownB }; - changes = true; - } - - return changes; - } - - public static bool DrawPrimaryId(ref GmpIdentifier identifier, float unscaledWidth = 100) - { - var ret = IdInput("##gmpPrimaryId"u8, unscaledWidth, identifier.SetId.Id, out var setId, 1, ExpandedEqpGmpBase.Count - 1, - identifier.SetId.Id <= 1); - ImUtf8.HoverTooltip( - "Model Set ID - You can usually find this as the 'e####' part of an item path.\nThis should generally not be left <= 1 unless you explicitly want that."u8); - if (ret) - identifier = new GmpIdentifier(setId); - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/ImcMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/ImcMetaDrawer.cs deleted file mode 100644 index bb87cd47..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/ImcMetaDrawer.cs +++ /dev/null @@ -1,304 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class ImcMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Variant Edits (IMC)###IMC"u8; - - public override int NumColumns - => 10; - - private bool _fileExists; - - protected override void Initialize() - { - Identifier = ImcIdentifier.Default; - UpdateEntry(); - } - - private void UpdateEntry() - => (Entry, _fileExists, _) = ImcChecker.GetDefaultEntry(Identifier, true); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current IMC manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Imc))); - ImGui.TableNextColumn(); - var canAdd = _fileExists && !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : !_fileExists ? "This IMC file does not exist."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - using var disabled = ImRaii.Disabled(); - DrawEntry(Entry, ref Entry, false); - } - - protected override void DrawEntry(ImcIdentifier identifier, ImcEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = ImcChecker.GetDefaultEntry(identifier, true).Entry; - if (DrawEntry(defaultEntry, ref entry, true)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - private static bool DrawIdentifierInput(ref ImcIdentifier identifier) - { - ImGui.TableNextColumn(); - var change = DrawObjectType(ref identifier); - - ImGui.TableNextColumn(); - change |= DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - if (identifier.ObjectType is ObjectType.Equipment or ObjectType.Accessory) - change |= DrawSlot(ref identifier); - else - change |= DrawSecondaryId(ref identifier); - - ImGui.TableNextColumn(); - change |= DrawVariant(ref identifier); - - ImGui.TableNextColumn(); - if (identifier.ObjectType is ObjectType.DemiHuman) - change |= DrawSlot(ref identifier, 70f); - else - ImUtf8.ScaledDummy(70f); - return change; - } - - private static void DrawIdentifier(ImcIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.ObjectType.ToName(), FrameColor); - ImUtf8.HoverTooltip("Object Type"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.PrimaryId.Id}", FrameColor); - ImUtf8.HoverTooltip("Primary ID"); - - ImGui.TableNextColumn(); - if (identifier.ObjectType is ObjectType.Equipment or ObjectType.Accessory) - { - ImUtf8.TextFramed(identifier.EquipSlot.ToName(), FrameColor); - ImUtf8.HoverTooltip("Equip Slot"u8); - } - else - { - ImUtf8.TextFramed($"{identifier.SecondaryId.Id}", FrameColor); - ImUtf8.HoverTooltip("Secondary ID"u8); - } - - ImGui.TableNextColumn(); - ImUtf8.TextFramed($"{identifier.Variant.Id}", FrameColor); - ImUtf8.HoverTooltip("Variant"u8); - - ImGui.TableNextColumn(); - if (identifier.ObjectType is ObjectType.DemiHuman) - { - ImUtf8.TextFramed(identifier.EquipSlot.ToName(), FrameColor); - ImUtf8.HoverTooltip("Equip Slot"u8); - } - } - - private static bool DrawEntry(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault) - { - ImGui.TableNextColumn(); - var change = DrawMaterialId(defaultEntry, ref entry, addDefault); - ImUtf8.SameLineInner(); - change |= DrawMaterialAnimationId(defaultEntry, ref entry, addDefault); - - ImGui.TableNextColumn(); - change |= DrawDecalId(defaultEntry, ref entry, addDefault); - ImUtf8.SameLineInner(); - change |= DrawVfxId(defaultEntry, ref entry, addDefault); - ImUtf8.SameLineInner(); - change |= DrawSoundId(defaultEntry, ref entry, addDefault); - - ImGui.TableNextColumn(); - change |= DrawAttributes(defaultEntry, ref entry); - return change; - } - - - protected override IEnumerable<(ImcIdentifier, ImcEntry)> Enumerate() - => Editor.Imc - .OrderBy(kvp => kvp.Key.ObjectType) - .ThenBy(kvp => kvp.Key.PrimaryId.Id) - .ThenBy(kvp => kvp.Key.EquipSlot) - .ThenBy(kvp => kvp.Key.BodySlot) - .ThenBy(kvp => kvp.Key.SecondaryId.Id) - .ThenBy(kvp => kvp.Key.Variant.Id) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Imc.Count; - - public static bool DrawObjectType(ref ImcIdentifier identifier, float width = 110) - { - var ret = Combos.ImcType("##imcType", identifier.ObjectType, out var type, width); - ImUtf8.HoverTooltip("Object Type"u8); - - if (ret) - { - var (equipSlot, secondaryId) = type switch - { - ObjectType.Equipment => (identifier.EquipSlot.IsEquipment() ? identifier.EquipSlot : EquipSlot.Head, (SecondaryId)0), - ObjectType.DemiHuman => (identifier.EquipSlot.IsEquipment() ? identifier.EquipSlot : EquipSlot.Head, - identifier.SecondaryId == 0 ? 1 : identifier.SecondaryId), - ObjectType.Accessory => (identifier.EquipSlot.IsAccessory() ? identifier.EquipSlot : EquipSlot.Ears, (SecondaryId)0), - _ => (EquipSlot.Unknown, identifier.SecondaryId == 0 ? 1 : identifier.SecondaryId), - }; - identifier = identifier with - { - ObjectType = type, - EquipSlot = equipSlot, - SecondaryId = secondaryId, - }; - } - - return ret; - } - - public static bool DrawPrimaryId(ref ImcIdentifier identifier, float unscaledWidth = 80) - { - var ret = IdInput("##imcPrimaryId"u8, unscaledWidth, identifier.PrimaryId.Id, out var newId, 0, ushort.MaxValue, - identifier.PrimaryId.Id <= 1); - ImUtf8.HoverTooltip("Primary ID - You can usually find this as the 'x####' part of an item path.\n"u8 - + "This should generally not be left <= 1 unless you explicitly want that."u8); - if (ret) - identifier = identifier with { PrimaryId = newId }; - return ret; - } - - public static bool DrawSecondaryId(ref ImcIdentifier identifier, float unscaledWidth = 100) - { - var ret = IdInput("##imcSecondaryId"u8, unscaledWidth, identifier.SecondaryId.Id, out var newId, 0, ushort.MaxValue, false); - ImUtf8.HoverTooltip("Secondary ID"u8); - if (ret) - identifier = identifier with { SecondaryId = newId }; - return ret; - } - - public static bool DrawVariant(ref ImcIdentifier identifier, float unscaledWidth = 45) - { - var ret = IdInput("##imcVariant"u8, unscaledWidth, identifier.Variant.Id, out var newId, 0, byte.MaxValue, false); - ImUtf8.HoverTooltip("Variant ID"u8); - if (ret) - identifier = identifier with { Variant = (byte)newId }; - return ret; - } - - public static bool DrawSlot(ref ImcIdentifier identifier, float unscaledWidth = 100) - { - bool ret; - EquipSlot slot; - switch (identifier.ObjectType) - { - case ObjectType.Equipment: - case ObjectType.DemiHuman: - ret = Combos.EqpEquipSlot("##slot", identifier.EquipSlot, out slot, unscaledWidth); - break; - case ObjectType.Accessory: - ret = Combos.AccessorySlot("##slot", identifier.EquipSlot, out slot, unscaledWidth); - break; - default: return false; - } - - ImUtf8.HoverTooltip("Equip Slot"u8); - if (ret) - identifier = identifier with { EquipSlot = slot }; - return ret; - } - - public static bool DrawMaterialId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) - { - if (!DragInput("##materialId"u8, "Material ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.MaterialId, defaultEntry.MaterialId, - out var newValue, (byte)1, byte.MaxValue, 0.01f, addDefault)) - return false; - - entry = entry with { MaterialId = newValue }; - return true; - } - - public static bool DrawMaterialAnimationId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) - { - if (!DragInput("##mAnimId"u8, "Material Animation ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.MaterialAnimationId, - defaultEntry.MaterialAnimationId, out var newValue, (byte)0, byte.MaxValue, 0.01f, addDefault)) - return false; - - entry = entry with { MaterialAnimationId = newValue }; - return true; - } - - public static bool DrawDecalId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) - { - if (!DragInput("##decalId"u8, "Decal ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.DecalId, defaultEntry.DecalId, out var newValue, - (byte)0, byte.MaxValue, 0.01f, addDefault)) - return false; - - entry = entry with { DecalId = newValue }; - return true; - } - - public static bool DrawVfxId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) - { - if (!DragInput("##vfxId"u8, "VFX ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.VfxId, defaultEntry.VfxId, out var newValue, (byte)0, - byte.MaxValue, 0.01f, addDefault)) - return false; - - entry = entry with { VfxId = newValue }; - return true; - } - - public static bool DrawSoundId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) - { - if (!DragInput("##soundId"u8, "Sound ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.SoundId, defaultEntry.SoundId, out var newValue, - (byte)0, byte.MaxValue, 0.01f, addDefault)) - return false; - - entry = entry with { SoundId = newValue }; - return true; - } - - private static bool DrawAttributes(ImcEntry defaultEntry, ref ImcEntry entry) - { - var changes = false; - for (var i = 0; i < ImcEntry.NumAttributes; ++i) - { - using var id = ImRaii.PushId(i); - var flag = 1 << i; - var value = (entry.AttributeMask & flag) != 0; - var def = (defaultEntry.AttributeMask & flag) != 0; - if (Checkmark("##attribute"u8, "ABCDEFGHIJ"u8.Slice(i, 1), value, def, out var newValue)) - { - var newMask = (ushort)(newValue ? entry.AttributeMask | flag : entry.AttributeMask & ~flag); - entry = entry with { AttributeMask = newMask }; - changes = true; - } - - if (i < ImcEntry.NumAttributes - 1) - ImUtf8.SameLineInner(); - } - - return changes; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/MetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/MetaDrawer.cs deleted file mode 100644 index f608a194..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/MetaDrawer.cs +++ /dev/null @@ -1,165 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.Api.Api; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public interface IMetaDrawer -{ - public ReadOnlySpan Label { get; } - public int NumColumns { get; } - public float ColumnHeight { get; } - public void Draw(); -} - -public abstract class MetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) : IMetaDrawer - where TIdentifier : unmanaged, IMetaIdentifier - where TEntry : unmanaged -{ - protected const uint FrameColor = 0; - - protected readonly ModMetaEditor Editor = editor; - protected readonly MetaFileManager MetaFiles = metaFiles; - protected TIdentifier Identifier; - protected TEntry Entry; - private bool _initialized; - - public void Draw() - { - if (!_initialized) - { - Initialize(); - _initialized = true; - } - - using var id = ImUtf8.PushId((int)Identifier.Type); - DrawNew(); - - var height = ColumnHeight; - var skips = ImGuiClip.GetNecessarySkipsAtPos(height, ImGui.GetCursorPosY(), Count); - if (skips < Count) - { - var remainder = ImGuiClip.ClippedTableDraw(Enumerate(), skips, DrawLine, Count); - if (remainder > 0) - ImGuiClip.DrawEndDummy(remainder, height); - } - - void DrawLine((TIdentifier Identifier, TEntry Value) pair) - => DrawEntry(pair.Identifier, pair.Value); - } - - public abstract ReadOnlySpan Label { get; } - public abstract int NumColumns { get; } - - public virtual float ColumnHeight - => ImUtf8.FrameHeightSpacing; - - protected abstract void DrawNew(); - protected abstract void Initialize(); - protected abstract void DrawEntry(TIdentifier identifier, TEntry entry); - - protected abstract IEnumerable<(TIdentifier, TEntry)> Enumerate(); - protected abstract int Count { get; } - - - /// - /// A number input for ids with an optional max id of given width. - /// Returns true if newId changed against currentId. - /// - protected static bool IdInput(ReadOnlySpan label, float unscaledWidth, ushort currentId, out ushort newId, int minId, int maxId, - bool border) - { - int tmp = currentId; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - using var style = ImRaii.PushStyle(ImGuiStyleVar.FrameBorderSize, UiHelpers.Scale, border); - using var color = ImRaii.PushColor(ImGuiCol.Border, Colors.RegexWarningBorder, border); - if (ImUtf8.InputScalar(label, ref tmp)) - tmp = Math.Clamp(tmp, minId, maxId); - - newId = (ushort)tmp; - return newId != currentId; - } - - /// - /// A dragging int input of given width that compares against a default value, shows a tooltip and clamps against min and max. - /// Returns true if newValue changed against currentValue. - /// - protected static bool DragInput(ReadOnlySpan label, ReadOnlySpan tooltip, float width, T currentValue, T defaultValue, - out T newValue, T minValue, T maxValue, float speed, bool addDefault) where T : unmanaged, INumber - { - newValue = currentValue; - using var color = ImRaii.PushColor(ImGuiCol.FrameBg, - defaultValue > currentValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), - defaultValue != currentValue); - ImGui.SetNextItemWidth(width); - if (ImUtf8.DragScalar(label, ref newValue, minValue, maxValue, speed)) - newValue = newValue <= minValue ? minValue : newValue >= maxValue ? maxValue : newValue; - - if (addDefault) - ImUtf8.HoverTooltip($"{tooltip}\nDefault Value: {defaultValue}"); - else - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, tooltip); - - return newValue != currentValue; - } - - /// - /// A checkmark that compares against a default value and shows a tooltip. - /// Returns true if newValue is changed against currentValue. - /// - protected static bool Checkmark(ReadOnlySpan label, ReadOnlySpan tooltip, bool currentValue, bool defaultValue, - out bool newValue) - { - using var color = ImRaii.PushColor(ImGuiCol.FrameBg, - defaultValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), - defaultValue != currentValue); - newValue = currentValue; - ImUtf8.Checkbox(label, ref newValue); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, tooltip); - return newValue != currentValue; - } - - /// - /// A checkmark that compares against a default value and shows a tooltip. - /// Returns true if newValue is changed against currentValue. - /// - protected static bool Checkmark(ReadOnlySpan label, ReadOnlySpan tooltip, bool currentValue, bool defaultValue, - out bool newValue) - { - using var color = ImRaii.PushColor(ImGuiCol.FrameBg, - defaultValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), - defaultValue != currentValue); - newValue = currentValue; - ImUtf8.Checkbox(label, ref newValue); - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, tooltip); - return newValue != currentValue; - } - - protected void DrawMetaButtons(TIdentifier identifier, TEntry entry) - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy this manipulation to clipboard."u8, new Lazy(() => new JArray { MetaDictionary.Serialize(identifier, entry)! })); - - ImGui.TableNextColumn(); - if (ImUtf8.IconButton(FontAwesomeIcon.Trash, "Delete this meta manipulation."u8)) - Editor.Changes |= Editor.Remove(identifier); - } - - protected void CopyToClipboardButton(ReadOnlySpan tooltip, Lazy manipulations) - { - if (!ImUtf8.IconButton(FontAwesomeIcon.Clipboard, tooltip)) - return; - - var text = Functions.ToCompressedBase64(manipulations.Value, 0); - if (text.Length > 0) - ImGui.SetClipboardText(text); - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/MetaDrawers.cs b/Penumbra/UI/AdvancedWindow/Meta/MetaDrawers.cs deleted file mode 100644 index 792611e2..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/MetaDrawers.cs +++ /dev/null @@ -1,44 +0,0 @@ -using OtterGui.Services; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public class MetaDrawers( - EqdpMetaDrawer eqdp, - EqpMetaDrawer eqp, - EstMetaDrawer est, - GlobalEqpMetaDrawer globalEqp, - GmpMetaDrawer gmp, - ImcMetaDrawer imc, - RspMetaDrawer rsp, - AtchMetaDrawer atch, - ShpMetaDrawer shp, - AtrMetaDrawer atr) : IService -{ - public readonly EqdpMetaDrawer Eqdp = eqdp; - public readonly EqpMetaDrawer Eqp = eqp; - public readonly EstMetaDrawer Est = est; - public readonly GmpMetaDrawer Gmp = gmp; - public readonly RspMetaDrawer Rsp = rsp; - public readonly ImcMetaDrawer Imc = imc; - public readonly GlobalEqpMetaDrawer GlobalEqp = globalEqp; - public readonly AtchMetaDrawer Atch = atch; - public readonly ShpMetaDrawer Shp = shp; - public readonly AtrMetaDrawer Atr = atr; - - public IMetaDrawer? Get(MetaManipulationType type) - => type switch - { - MetaManipulationType.Imc => Imc, - MetaManipulationType.Eqdp => Eqdp, - MetaManipulationType.Eqp => Eqp, - MetaManipulationType.Est => Est, - MetaManipulationType.Gmp => Gmp, - MetaManipulationType.Rsp => Rsp, - MetaManipulationType.Atch => Atch, - MetaManipulationType.Shp => Shp, - MetaManipulationType.Atr => Atr, - MetaManipulationType.GlobalEqp => GlobalEqp, - _ => null, - }; -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/RspMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/RspMetaDrawer.cs deleted file mode 100644 index 88abe0cb..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/RspMetaDrawer.cs +++ /dev/null @@ -1,119 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.GameData.Enums; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class RspMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Racial Scaling Edits (RSP)###RSP"u8; - - public override int NumColumns - => 5; - - protected override void Initialize() - { - Identifier = new RspIdentifier(SubRace.Midlander, RspAttribute.MaleMinSize); - UpdateEntry(); - } - - private void UpdateEntry() - => Entry = CmpFile.GetDefault(MetaFiles, Identifier.SubRace, Identifier.Attribute); - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current RSP manipulations to clipboard."u8, new Lazy(() => MetaDictionary.SerializeTo([], Editor.Rsp))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier); - var tt = canAdd ? "Stage this edit."u8 : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, Entry); - - if (DrawIdentifierInput(ref Identifier)) - UpdateEntry(); - - DrawEntry(Entry, ref Entry, true); - } - - protected override void DrawEntry(RspIdentifier identifier, RspEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - var defaultEntry = CmpFile.GetDefault(MetaFiles, identifier.SubRace, identifier.Attribute); - if (DrawEntry(defaultEntry, ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(RspIdentifier, RspEntry)> Enumerate() - => Editor.Rsp - .OrderBy(kvp => kvp.Key.SubRace) - .ThenBy(kvp => kvp.Key.Attribute) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Rsp.Count; - - private static bool DrawIdentifierInput(ref RspIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawSubRace(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawAttribute(ref identifier); - return changes; - } - - private static void DrawIdentifier(RspIdentifier identifier) - { - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.SubRace.ToName(), FrameColor); - ImUtf8.HoverTooltip("Model Set ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Attribute.ToFullString(), FrameColor); - ImUtf8.HoverTooltip("Equip Slot"u8); - } - - private static bool DrawEntry(RspEntry defaultEntry, ref RspEntry entry, bool disabled) - { - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var ret = DragInput("##rspValue"u8, [], ImUtf8.GlobalScale * 150, entry.Value, defaultEntry.Value, out var newValue, - RspEntry.MinValue, RspEntry.MaxValue, 0.001f, !disabled); - if (ret) - entry = new RspEntry(newValue); - return ret; - } - - public static bool DrawSubRace(ref RspIdentifier identifier, float unscaledWidth = 150) - { - var ret = Combos.SubRace("##rspSubRace", identifier.SubRace, out var subRace, unscaledWidth); - ImUtf8.HoverTooltip("Racial Clan"u8); - if (ret) - identifier = identifier with { SubRace = subRace }; - return ret; - } - - public static bool DrawAttribute(ref RspIdentifier identifier, float unscaledWidth = 200) - { - var ret = Combos.RspAttribute("##rspAttribute", identifier.Attribute, out var attribute, unscaledWidth); - ImUtf8.HoverTooltip("Scaling Attribute"u8); - if (ret) - identifier = identifier with { Attribute = attribute }; - return ret; - } -} diff --git a/Penumbra/UI/AdvancedWindow/Meta/ShpMetaDrawer.cs b/Penumbra/UI/AdvancedWindow/Meta/ShpMetaDrawer.cs deleted file mode 100644 index 59692195..00000000 --- a/Penumbra/UI/AdvancedWindow/Meta/ShpMetaDrawer.cs +++ /dev/null @@ -1,366 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Newtonsoft.Json.Linq; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Meta; -using Penumbra.Meta.Files; -using Penumbra.Meta.Manipulations; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow.Meta; - -public sealed class ShpMetaDrawer(ModMetaEditor editor, MetaFileManager metaFiles) - : MetaDrawer(editor, metaFiles), IService -{ - public override ReadOnlySpan Label - => "Shape Keys (SHP)###SHP"u8; - - private ShapeAttributeString _buffer = ShapeAttributeString.TryRead("shpx_"u8, out var s) ? s : ShapeAttributeString.Empty; - private bool _identifierValid; - - public override int NumColumns - => 8; - - public override float ColumnHeight - => ImUtf8.FrameHeightSpacing; - - protected override void Initialize() - { - Identifier = new ShpIdentifier(HumanSlot.Unknown, null, ShapeAttributeString.Empty, ShapeConnectorCondition.None, GenderRace.Unknown); - } - - protected override void DrawNew() - { - ImGui.TableNextColumn(); - CopyToClipboardButton("Copy all current SHP manipulations to clipboard."u8, - new Lazy(() => MetaDictionary.SerializeTo([], Editor.Shp))); - - ImGui.TableNextColumn(); - var canAdd = !Editor.Contains(Identifier) && _identifierValid; - var tt = canAdd - ? "Stage this edit."u8 - : _identifierValid - ? "This entry does not contain a valid shape key."u8 - : "This entry is already edited."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, disabled: !canAdd)) - Editor.Changes |= Editor.TryAdd(Identifier, ShpEntry.True); - - DrawIdentifierInput(ref Identifier); - DrawEntry(ref Entry, true); - } - - protected override void DrawEntry(ShpIdentifier identifier, ShpEntry entry) - { - DrawMetaButtons(identifier, entry); - DrawIdentifier(identifier); - - if (DrawEntry(ref entry, false)) - Editor.Changes |= Editor.Update(identifier, entry); - } - - protected override IEnumerable<(ShpIdentifier, ShpEntry)> Enumerate() - => Editor.Shp - .OrderBy(kvp => kvp.Key.Shape) - .ThenBy(kvp => kvp.Key.Slot) - .ThenBy(kvp => kvp.Key.Id) - .ThenBy(kvp => kvp.Key.ConnectorCondition) - .Select(kvp => (kvp.Key, kvp.Value)); - - protected override int Count - => Editor.Shp.Count; - - private bool DrawIdentifierInput(ref ShpIdentifier identifier) - { - ImGui.TableNextColumn(); - var changes = DrawHumanSlot(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawGenderRaceConditionInput(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawPrimaryId(ref identifier); - - ImGui.TableNextColumn(); - changes |= DrawShapeKeyInput(ref identifier, ref _buffer, ref _identifierValid); - - ImGui.TableNextColumn(); - changes |= DrawConnectorConditionInput(ref identifier); - return changes; - } - - private static void DrawIdentifier(ShpIdentifier identifier) - { - ImGui.TableNextColumn(); - - ImUtf8.TextFramed(SlotName(identifier.Slot), FrameColor); - ImUtf8.HoverTooltip("Model Slot"u8); - - ImGui.TableNextColumn(); - if (identifier.GenderRaceCondition is not GenderRace.Unknown) - { - ImUtf8.TextFramed($"{identifier.GenderRaceCondition.ToName()} ({identifier.GenderRaceCondition.ToRaceCode()})", FrameColor); - ImUtf8.HoverTooltip("Gender & Race Code for this shape key to be set."); - } - else - { - ImUtf8.TextFramed("Any Gender & Race"u8, FrameColor); - } - - ImGui.TableNextColumn(); - if (identifier.Id.HasValue) - ImUtf8.TextFramed($"{identifier.Id.Value.Id}", FrameColor); - else - ImUtf8.TextFramed("All IDs"u8, FrameColor); - ImUtf8.HoverTooltip("Primary ID"u8); - - ImGui.TableNextColumn(); - ImUtf8.TextFramed(identifier.Shape.AsSpan, FrameColor); - - ImGui.TableNextColumn(); - if (identifier.ConnectorCondition is not ShapeConnectorCondition.None) - { - ImUtf8.TextFramed($"{identifier.ConnectorCondition}", FrameColor); - ImUtf8.HoverTooltip("Connector condition for this shape to be activated."); - } - } - - private static bool DrawEntry(ref ShpEntry entry, bool disabled) - { - using var dis = ImRaii.Disabled(disabled); - ImGui.TableNextColumn(); - var value = entry.Value; - var changes = ImUtf8.Checkbox("##shpEntry"u8, ref value); - if (changes) - entry = new ShpEntry(value); - ImUtf8.HoverTooltip("Whether to enable or disable this shape key for the selected items."); - return changes; - } - - public static bool DrawPrimaryId(ref ShpIdentifier identifier, float unscaledWidth = 100) - { - var allSlots = identifier.Slot is HumanSlot.Unknown; - var all = !identifier.Id.HasValue; - var ret = false; - using (ImRaii.Disabled(allSlots)) - { - if (ImUtf8.Checkbox("##shpAll"u8, ref all)) - { - identifier = identifier with { Id = all ? null : 0 }; - ret = true; - } - } - - ImUtf8.HoverTooltip(allSlots ? "When using all slots, you also need to use all IDs."u8 : "Enable this shape key for all model IDs."u8); - - ImGui.SameLine(0, ImGui.GetStyle().ItemInnerSpacing.X); - if (all) - { - using var style = ImRaii.PushStyle(ImGuiStyleVar.ButtonTextAlign, new Vector2(0.05f, 0.5f)); - ImUtf8.TextFramed("All IDs"u8, ImGui.GetColorU32(ImGuiCol.FrameBg, all || allSlots ? ImGui.GetStyle().DisabledAlpha : 1f), - new Vector2(unscaledWidth, 0), ImGui.GetColorU32(ImGuiCol.TextDisabled)); - } - else - { - var max = identifier.Slot.ToSpecificEnum() is BodySlot ? byte.MaxValue : ExpandedEqpGmpBase.Count - 1; - if (IdInput("##shpPrimaryId"u8, unscaledWidth, identifier.Id.GetValueOrDefault(0).Id, out var setId, 0, max, false)) - { - identifier = identifier with { Id = setId }; - ret = true; - } - } - - ImUtf8.HoverTooltip("Primary ID - You can usually find this as the 'e####' part of an item path or similar for customizations."u8); - - return ret; - } - - public bool DrawHumanSlot(ref ShpIdentifier identifier, float unscaledWidth = 170) - { - var ret = false; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - using (var combo = ImUtf8.Combo("##shpSlot"u8, SlotName(identifier.Slot))) - { - if (combo) - foreach (var slot in AvailableSlots) - { - if (!ImUtf8.Selectable(SlotName(slot), slot == identifier.Slot) || slot == identifier.Slot) - continue; - - ret = true; - if (slot is HumanSlot.Unknown) - { - identifier = identifier with - { - Id = null, - Slot = slot, - }; - } - else - { - identifier = identifier with - { - Id = identifier.Id.HasValue - ? (PrimaryId)Math.Clamp(identifier.Id.Value.Id, 0, - slot.ToSpecificEnum() is BodySlot ? byte.MaxValue : ExpandedEqpGmpBase.Count - 1) - : null, - Slot = slot, - ConnectorCondition = Identifier.ConnectorCondition switch - { - ShapeConnectorCondition.Wrists when slot is HumanSlot.Body or HumanSlot.Hands => ShapeConnectorCondition.Wrists, - ShapeConnectorCondition.Waist when slot is HumanSlot.Body or HumanSlot.Legs => ShapeConnectorCondition.Waist, - ShapeConnectorCondition.Ankles when slot is HumanSlot.Legs or HumanSlot.Feet => ShapeConnectorCondition.Ankles, - _ => ShapeConnectorCondition.None, - }, - }; - ret = true; - } - } - } - - ImUtf8.HoverTooltip("Model Slot"u8); - return ret; - } - - public static unsafe bool DrawShapeKeyInput(ref ShpIdentifier identifier, ref ShapeAttributeString buffer, ref bool valid, - float unscaledWidth = 200) - { - var ret = false; - var ptr = Unsafe.AsPointer(ref buffer); - var span = new Span(ptr, ShapeAttributeString.MaxLength + 1); - using (new ImRaii.ColorStyle().Push(ImGuiCol.Border, Colors.RegexWarningBorder, !valid).Push(ImGuiStyleVar.FrameBorderSize, 1f, !valid)) - { - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - if (ImUtf8.InputText("##shpShape"u8, span, out int newLength, "Shape Key..."u8)) - { - buffer.ForceLength((byte)newLength); - valid = buffer.ValidateCustomShapeString(); - if (valid) - identifier = identifier with { Shape = buffer }; - ret = true; - } - } - - ImUtf8.HoverTooltip("Supported shape keys need to have the format `shpx_*` and a maximum length of 30 characters."u8); - return ret; - } - - private static bool DrawConnectorConditionInput(ref ShpIdentifier identifier, float unscaledWidth = 80) - { - var ret = false; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - var (showWrists, showWaist, showAnkles, disable) = identifier.Slot switch - { - HumanSlot.Unknown => (true, true, true, false), - HumanSlot.Body => (true, true, false, false), - HumanSlot.Legs => (false, true, true, false), - HumanSlot.Hands => (true, false, false, false), - HumanSlot.Feet => (false, false, true, false), - _ => (false, false, false, true), - }; - using var disabled = ImRaii.Disabled(disable); - using (var combo = ImUtf8.Combo("##shpCondition"u8, $"{identifier.ConnectorCondition}")) - { - if (combo) - { - if (ImUtf8.Selectable("None"u8, identifier.ConnectorCondition is ShapeConnectorCondition.None)) - identifier = identifier with { ConnectorCondition = ShapeConnectorCondition.None }; - - if (showWrists && ImUtf8.Selectable("Wrists"u8, identifier.ConnectorCondition is ShapeConnectorCondition.Wrists)) - identifier = identifier with { ConnectorCondition = ShapeConnectorCondition.Wrists }; - - if (showWaist && ImUtf8.Selectable("Waist"u8, identifier.ConnectorCondition is ShapeConnectorCondition.Waist)) - identifier = identifier with { ConnectorCondition = ShapeConnectorCondition.Waist }; - - if (showAnkles && ImUtf8.Selectable("Ankles"u8, identifier.ConnectorCondition is ShapeConnectorCondition.Ankles)) - identifier = identifier with { ConnectorCondition = ShapeConnectorCondition.Ankles }; - } - } - - ImUtf8.HoverTooltip( - "Only activate this shape key if any custom connector shape keys (shpx_[wr|wa|an]_*) are also enabled through matching attributes."u8); - return ret; - } - - private static bool DrawGenderRaceConditionInput(ref ShpIdentifier identifier, float unscaledWidth = 250) - { - var ret = false; - ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); - - using (var combo = ImUtf8.Combo("##shpGenderRace"u8, identifier.GenderRaceCondition is GenderRace.Unknown - ? "Any Gender & Race" - : $"{identifier.GenderRaceCondition.ToName()} ({identifier.GenderRaceCondition.ToRaceCode()})")) - { - if (combo) - { - if (ImUtf8.Selectable("Any Gender & Race"u8, identifier.GenderRaceCondition is GenderRace.Unknown) - && identifier.GenderRaceCondition is not GenderRace.Unknown) - { - identifier = identifier with { GenderRaceCondition = GenderRace.Unknown }; - ret = true; - } - - foreach (var gr in ShapeAttributeHashSet.GenderRaceValues.Skip(1)) - { - if (ImUtf8.Selectable($"{gr.ToName()} ({gr.ToRaceCode()})", identifier.GenderRaceCondition == gr) - && identifier.GenderRaceCondition != gr) - { - identifier = identifier with { GenderRaceCondition = gr }; - ret = true; - } - } - } - } - - ImUtf8.HoverTooltip( - "Only activate this shape key for this gender & race code."u8); - - return ret; - } - - public static ReadOnlySpan AvailableSlots - => - [ - HumanSlot.Unknown, - HumanSlot.Head, - HumanSlot.Body, - HumanSlot.Hands, - HumanSlot.Legs, - HumanSlot.Feet, - HumanSlot.Ears, - HumanSlot.Neck, - HumanSlot.Wrists, - HumanSlot.RFinger, - HumanSlot.LFinger, - HumanSlot.Glasses, - HumanSlot.Hair, - HumanSlot.Face, - HumanSlot.Ear, - ]; - - public static ReadOnlySpan SlotName(HumanSlot slot) - => slot switch - { - HumanSlot.Unknown => "All Slots"u8, - HumanSlot.Head => "Equipment: Head"u8, - HumanSlot.Body => "Equipment: Body"u8, - HumanSlot.Hands => "Equipment: Hands"u8, - HumanSlot.Legs => "Equipment: Legs"u8, - HumanSlot.Feet => "Equipment: Feet"u8, - HumanSlot.Ears => "Equipment: Ears"u8, - HumanSlot.Neck => "Equipment: Neck"u8, - HumanSlot.Wrists => "Equipment: Wrists"u8, - HumanSlot.RFinger => "Equipment: Right Finger"u8, - HumanSlot.LFinger => "Equipment: Left Finger"u8, - HumanSlot.Glasses => "Equipment: Glasses"u8, - HumanSlot.Hair => "Customization: Hair"u8, - HumanSlot.Face => "Customization: Face"u8, - HumanSlot.Ear => "Customization: Ears"u8, - _ => "Unknown"u8, - }; -} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Deformers.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Deformers.cs deleted file mode 100644 index 4f7ae8da..00000000 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Deformers.cs +++ /dev/null @@ -1,355 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Interface.Utility.Raii; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Extensions; -using OtterGui.Text; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Files; -using Penumbra.UI.Classes; -using Notification = OtterGui.Classes.Notification; - -namespace Penumbra.UI.AdvancedWindow; - -public partial class ModEditWindow -{ - private readonly FileEditor _pbdTab; - private readonly PbdData _pbdData = new(); - - private bool DrawDeformerPanel(PbdTab tab, bool disabled) - { - _pbdData.Update(tab.File); - DrawGenderRaceSelector(tab); - ImGui.SameLine(); - DrawBoneSelector(); - ImGui.SameLine(); - return DrawBoneData(tab, disabled); - } - - private void DrawGenderRaceSelector(PbdTab tab) - { - using var group = ImUtf8.Group(); - var width = ImUtf8.CalcTextSize("Hellsguard - Female (Child)____0000"u8).X + 2 * ImGui.GetStyle().WindowPadding.X; - using (ImRaii.PushStyle(ImGuiStyleVar.FrameRounding, 0) - .Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero)) - { - ImGui.SetNextItemWidth(width); - ImUtf8.InputText("##grFilter"u8, ref _pbdData.RaceCodeFilter, "Filter..."u8); - } - - using var child = ImUtf8.Child("GenderRace"u8, - new Vector2(width, ImGui.GetContentRegionMax().Y - ImGui.GetFrameHeight() - ImGui.GetStyle().WindowPadding.Y), true); - if (!child) - return; - - var metaColor = ColorId.ItemId.Value(); - foreach (var (deformer, index) in tab.File.Deformers.WithIndex()) - { - var name = deformer.GenderRace.ToName(); - var raceCode = deformer.GenderRace.ToRaceCode(); - // No clipping necessary since this are not that many objects anyway. - if (!name.Contains(_pbdData.RaceCodeFilter) && !raceCode.Contains(_pbdData.RaceCodeFilter)) - continue; - - using var id = ImUtf8.PushId(index); - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), deformer.RacialDeformer.IsEmpty); - if (ImUtf8.Selectable(name, deformer.GenderRace == _pbdData.SelectedRaceCode)) - { - _pbdData.SelectedRaceCode = deformer.GenderRace; - _pbdData.SelectedDeformer = deformer.RacialDeformer; - } - - ImGui.SameLine(); - color.Push(ImGuiCol.Text, metaColor); - ImUtf8.TextRightAligned(raceCode); - } - } - - private void DrawBoneSelector() - { - using var group = ImUtf8.Group(); - var width = 200 * ImUtf8.GlobalScale; - using (ImRaii.PushStyle(ImGuiStyleVar.FrameRounding, 0) - .Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero)) - { - ImGui.SetNextItemWidth(width); - ImUtf8.InputText("##boneFilter"u8, ref _pbdData.BoneFilter, "Filter..."u8); - } - - using var child = ImUtf8.Child("Bone"u8, - new Vector2(width, ImGui.GetContentRegionMax().Y - ImGui.GetFrameHeight() - ImGui.GetStyle().WindowPadding.Y), true); - if (!child) - return; - - if (_pbdData.SelectedDeformer == null) - return; - - if (_pbdData.SelectedDeformer.IsEmpty) - { - ImUtf8.Text(""u8); - } - else - { - var height = ImGui.GetTextLineHeightWithSpacing(); - var skips = ImGuiClip.GetNecessarySkips(height); - var remainder = ImGuiClip.FilteredClippedDraw(_pbdData.SelectedDeformer.DeformMatrices.Keys, skips, - b => b.Contains(_pbdData.BoneFilter), bone - => - { - if (ImUtf8.Selectable(bone, bone == _pbdData.SelectedBone)) - _pbdData.SelectedBone = bone; - }); - ImGuiClip.DrawEndDummy(remainder, height); - } - } - - private bool DrawBoneData(PbdTab tab, bool disabled) - { - using var child = ImUtf8.Child("Data"u8, - ImGui.GetContentRegionAvail() with { Y = ImGui.GetContentRegionMax().Y - ImGui.GetStyle().WindowPadding.Y }, true); - if (!child) - return false; - - if (_pbdData.SelectedBone == null) - return false; - - if (!_pbdData.SelectedDeformer!.DeformMatrices.TryGetValue(_pbdData.SelectedBone, out var matrix)) - return false; - - var width = UiBuilder.MonoFont.GetCharAdvance('0') * 12 + ImGui.GetStyle().FramePadding.X * 2; - var dummyHeight = ImGui.GetTextLineHeight() / 2; - var ret = DrawAddNewBone(tab, disabled, matrix, width); - - ImUtf8.Dummy(0, dummyHeight); - ImGui.Separator(); - ImUtf8.Dummy(0, dummyHeight); - ret |= DrawDeformerMatrix(disabled, matrix, width); - ImUtf8.Dummy(0, dummyHeight); - ret |= DrawCopyPasteButtons(disabled, matrix, width); - - - ImUtf8.Dummy(0, dummyHeight); - ImGui.Separator(); - ImUtf8.Dummy(0, dummyHeight); - ret |= DrawDecomposedData(disabled, matrix, width); - - return ret; - } - - private bool DrawAddNewBone(PbdTab tab, bool disabled, in TransformMatrix matrix, float width) - { - var ret = false; - ImUtf8.TextFrameAligned("Copy the values of the bone "u8); - ImGui.SameLine(0, 0); - using (ImRaii.PushColor(ImGuiCol.Text, ColorId.NewMod.Value())) - { - ImUtf8.TextFrameAligned(_pbdData.SelectedBone); - } - - ImGui.SameLine(0, 0); - ImUtf8.TextFrameAligned(" to a new bone of name"u8); - - var fullWidth = width * 4 + ImGui.GetStyle().ItemSpacing.X * 3; - ImGui.SetNextItemWidth(fullWidth); - ImUtf8.InputText("##newBone"u8, ref _pbdData.NewBoneName, "New Bone Name..."u8); - ImUtf8.TextFrameAligned("for all races that have a corresponding bone."u8); - ImGui.SameLine(0, fullWidth - width - ImGui.GetItemRectSize().X); - if (ImUtf8.ButtonEx("Apply"u8, ""u8, new Vector2(width, 0), - disabled || _pbdData.NewBoneName.Length == 0 || _pbdData.SelectedBone == null)) - { - foreach (var deformer in tab.File.Deformers) - { - if (!deformer.RacialDeformer.DeformMatrices.TryGetValue(_pbdData.SelectedBone!, out var existingMatrix)) - continue; - - if (!deformer.RacialDeformer.DeformMatrices.TryAdd(_pbdData.NewBoneName, existingMatrix) - && deformer.RacialDeformer.DeformMatrices.TryGetValue(_pbdData.NewBoneName, out var newBoneMatrix) - && !newBoneMatrix.Equals(existingMatrix)) - Penumbra.Messager.AddMessage(new Notification( - $"Could not add deformer matrix to {deformer.GenderRace.ToName()}, Bone {_pbdData.NewBoneName} because it already has a deformer that differs from the intended one.", - NotificationType.Warning)); - else - ret = true; - } - - _pbdData.NewBoneName = string.Empty; - } - - if (ImUtf8.ButtonEx("Copy Values to Single New Bone Entry"u8, ""u8, new Vector2(fullWidth, 0), - disabled || _pbdData.NewBoneName.Length == 0 || _pbdData.SelectedDeformer!.DeformMatrices.ContainsKey(_pbdData.NewBoneName))) - { - _pbdData.SelectedDeformer!.DeformMatrices[_pbdData.NewBoneName] = matrix; - ret = true; - _pbdData.NewBoneName = string.Empty; - } - - - return ret; - } - - private bool DrawDeformerMatrix(bool disabled, in TransformMatrix matrix, float width) - { - using var font = ImRaii.PushFont(UiBuilder.MonoFont); - using var _ = ImRaii.Disabled(disabled); - var ret = false; - for (var i = 0; i < 3; ++i) - { - for (var j = 0; j < 4; ++j) - { - using var id = ImUtf8.PushId(i * 4 + j); - ImGui.SetNextItemWidth(width); - var tmp = matrix[i, j]; - if (ImUtf8.InputScalar(""u8, ref tmp, "% 12.8f"u8)) - { - ret = true; - _pbdData.SelectedDeformer!.DeformMatrices[_pbdData.SelectedBone!] = matrix.ChangeValue(i, j, tmp); - } - - ImGui.SameLine(); - } - - ImGui.NewLine(); - } - - return ret; - } - - private bool DrawCopyPasteButtons(bool disabled, in TransformMatrix matrix, float width) - { - var size = new Vector2(width, 0); - if (ImUtf8.Button("Copy Values"u8, size)) - _pbdData.CopiedMatrix = matrix; - - ImGui.SameLine(); - - var ret = false; - if (ImUtf8.ButtonEx("Paste Values"u8, ""u8, size, disabled || !_pbdData.CopiedMatrix.HasValue)) - { - _pbdData.SelectedDeformer!.DeformMatrices[_pbdData.SelectedBone!] = _pbdData.CopiedMatrix!.Value; - ret = true; - } - - var modifier = _config.DeleteModModifier.IsActive(); - ImGui.SameLine(); - if (modifier) - { - if (ImUtf8.ButtonEx("Delete"u8, "Delete this bone entry."u8, size, disabled)) - { - ret |= _pbdData.SelectedDeformer!.DeformMatrices.Remove(_pbdData.SelectedBone!); - _pbdData.SelectedBone = null; - } - } - else - { - ImUtf8.ButtonEx("Delete"u8, $"Delete this bone entry. Hold {_config.DeleteModModifier} to delete.", size, true); - } - - return ret; - } - - private bool DrawDecomposedData(bool disabled, in TransformMatrix matrix, float width) - { - var ret = false; - - - if (!matrix.TryDecompose(out var scale, out var rotation, out var translation)) - return false; - - using (ImUtf8.Group()) - { - using var font = ImRaii.PushFont(UiBuilder.MonoFont); - using var _ = ImRaii.Disabled(disabled); - - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##ScaleX"u8, ref scale.X, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##ScaleY"u8, ref scale.Y, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##ScaleZ"u8, ref scale.Z, "% 12.8f"u8); - - - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##TranslationX"u8, ref translation.X, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##TranslationY"u8, ref translation.Y, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##TranslationZ"u8, ref translation.Z, "% 12.8f"u8); - - - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##RotationR"u8, ref rotation.W, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##RotationI"u8, ref rotation.X, "% 12.8f"u8); - - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##RotationJ"u8, ref rotation.Y, "% 12.8f"u8); - ImGui.SameLine(); - ImGui.SetNextItemWidth(width); - ret |= ImUtf8.InputScalar("##RotationK"u8, ref rotation.Z, "% 12.8f"u8); - } - - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.TextFrameAligned("Scale"u8); - ImUtf8.TextFrameAligned("Translation"u8); - ImUtf8.TextFrameAligned("Rotation (Quaternion, rijk)"u8); - } - - if (ret) - _pbdData.SelectedDeformer!.DeformMatrices[_pbdData.SelectedBone!] = TransformMatrix.Compose(scale, rotation, translation); - return ret; - } - - public class PbdTab(byte[] data, string filePath) : IWritable - { - public readonly string FilePath = filePath; - - public readonly PbdFile File = new(data); - - public bool Valid - => File.Valid; - - public byte[] Write() - => File.Write(); - } - - private class PbdData - { - public GenderRace SelectedRaceCode = GenderRace.Unknown; - public RacialDeformer? SelectedDeformer; - public string? SelectedBone; - public string NewBoneName = string.Empty; - public string BoneFilter = string.Empty; - public string RaceCodeFilter = string.Empty; - - public TransformMatrix? CopiedMatrix; - - public void Update(PbdFile file) - { - if (SelectedRaceCode is GenderRace.Unknown) - { - SelectedDeformer = null; - } - else - { - SelectedDeformer = file.Deformers.FirstOrDefault(p => p.GenderRace == SelectedRaceCode).RacialDeformer; - if (SelectedDeformer is null) - SelectedRaceCode = GenderRace.Unknown; - } - } - } -} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Files.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Files.cs index 63c99b8a..107c56e6 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Files.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Files.cs @@ -1,10 +1,8 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Text; using Penumbra.Mods.Editor; using Penumbra.Mods.SubMods; using Penumbra.String.Classes; @@ -15,7 +13,6 @@ namespace Penumbra.UI.AdvancedWindow; public partial class ModEditWindow { private readonly HashSet _selectedFiles = new(256); - private readonly HashSet _cutPaths = []; private LowerString _fileFilter = LowerString.Empty; private bool _showGamePaths = true; private string _gamePathEdit = string.Empty; @@ -126,7 +123,7 @@ public partial class ModEditWindow using var id = ImRaii.PushId(i); ImGui.TableNextColumn(); - DrawSelectable(registry, i); + DrawSelectable(registry); if (!_showGamePaths) continue; @@ -147,20 +144,22 @@ public partial class ModEditWindow private static string DrawFileTooltip(FileRegistry registry, ColorId color) { + (string, int) GetMulti() + { + var groups = registry.SubModUsage.GroupBy(s => s.Item1).ToArray(); + return (string.Join("\n", groups.Select(g => g.Key.GetName())), groups.Length); + } + var (text, groupCount) = color switch { - ColorId.ConflictingMod => (null, 0), - ColorId.NewMod => ([registry.SubModUsage[0].Item1.GetName()], 1), + ColorId.ConflictingMod => (string.Empty, 0), + ColorId.NewMod => (registry.SubModUsage[0].Item1.GetName(), 1), ColorId.InheritedMod => GetMulti(), - _ => (null, 0), + _ => (string.Empty, 0), }; - if (text != null && ImGui.IsItemHovered()) - { - using var tt = ImUtf8.Tooltip(); - using var c = ImRaii.DefaultColors(); - ImUtf8.Text(string.Join('\n', text)); - } + if (text.Length > 0 && ImGui.IsItemHovered()) + ImGui.SetTooltip(text); return (groupCount, registry.SubModUsage.Count) switch @@ -170,87 +169,26 @@ public partial class ModEditWindow (1, > 1) => $"(used {registry.SubModUsage.Count} times in 1 group)", _ => $"(used {registry.SubModUsage.Count} times over {groupCount} groups)", }; - - (IEnumerable, int) GetMulti() - { - var groups = registry.SubModUsage.GroupBy(s => s.Item1).ToArray(); - return (groups.Select(g => g.Key.GetName()), groups.Length); - } } - private void DrawSelectable(FileRegistry registry, int i) + private void DrawSelectable(FileRegistry registry) { var selected = _selectedFiles.Contains(registry); var color = registry.SubModUsage.Count == 0 ? ColorId.ConflictingMod : registry.CurrentUsage == registry.SubModUsage.Count ? ColorId.NewMod : ColorId.InheritedMod; - using (ImRaii.PushColor(ImGuiCol.Text, color.Value())) + using var c = ImRaii.PushColor(ImGuiCol.Text, color.Value()); + if (UiHelpers.Selectable(registry.RelPath.Path, selected)) { - if (UiHelpers.Selectable(registry.RelPath.Path, selected)) - { - if (selected) - _selectedFiles.Remove(registry); - else - _selectedFiles.Add(registry); - } - - if (ImGui.IsItemClicked(ImGuiMouseButton.Right)) - ImUtf8.OpenPopup("context"u8); - - var rightText = DrawFileTooltip(registry, color); - - ImGui.SameLine(); - ImGuiUtil.RightAlign(rightText); + if (selected) + _selectedFiles.Remove(registry); + else + _selectedFiles.Add(registry); } - DrawContextMenu(registry, i); - } + var rightText = DrawFileTooltip(registry, color); - private void DrawContextMenu(FileRegistry registry, int i) - { - using var context = ImUtf8.Popup("context"u8); - if (!context) - return; - - if (ImUtf8.Selectable("Copy Full File Path")) - ImUtf8.SetClipboardText(registry.File.FullName); - - using (ImRaii.Disabled(registry.CurrentUsage == 0)) - { - if (ImUtf8.Selectable("Copy Game Paths"u8)) - { - _cutPaths.Clear(); - for (var j = 0; j < registry.SubModUsage.Count; ++j) - { - if (registry.SubModUsage[j].Item1 != _editor.Option) - continue; - - _cutPaths.Add(registry.SubModUsage[j].Item2); - } - } - } - - using (ImRaii.Disabled(registry.CurrentUsage == 0)) - { - if (ImUtf8.Selectable("Cut Game Paths"u8)) - { - _cutPaths.Clear(); - for (var j = 0; j < registry.SubModUsage.Count; ++j) - { - if (registry.SubModUsage[j].Item1 != _editor.Option) - continue; - - _cutPaths.Add(registry.SubModUsage[j].Item2); - _editor.FileEditor.SetGamePath(_editor.Option, i, j--, Utf8GamePath.Empty); - } - } - } - - using (ImRaii.Disabled(_cutPaths.Count == 0)) - { - if (ImUtf8.Selectable("Paste Game Paths"u8)) - foreach (var path in _cutPaths) - _editor.FileEditor.SetGamePath(_editor.Option!, i, -1, path); - } + ImGui.SameLine(); + ImGuiUtil.RightAlign(rightText); } private void PrintGamePath(int i, int j, FileRegistry registry, IModDataContainer subMod, Utf8GamePath gamePath) @@ -271,7 +209,7 @@ public partial class ModEditWindow if (ImGui.IsItemDeactivatedAfterEdit()) { - if (Utf8GamePath.FromString(_gamePathEdit, out var path)) + if (Utf8GamePath.FromString(_gamePathEdit, out var path, false)) _editor.FileEditor.SetGamePath(_editor.Option!, _fileIdx, _pathIdx, path); _fileIdx = -1; @@ -279,7 +217,7 @@ public partial class ModEditWindow } else if (_fileIdx == i && _pathIdx == j - && (!Utf8GamePath.FromString(_gamePathEdit, out var path) + && (!Utf8GamePath.FromString(_gamePathEdit, out var path, false) || !path.IsEmpty && !path.Equals(gamePath) && !_editor.FileEditor.CanAddGamePath(path))) { ImGui.SameLine(); @@ -287,17 +225,6 @@ public partial class ModEditWindow using var font = ImRaii.PushFont(UiBuilder.IconFont); ImGuiUtil.TextColored(0xFF0000FF, FontAwesomeIcon.TimesCircle.ToIconString()); } - else if (tmp.Length > 0 && Path.GetExtension(tmp) != registry.File.Extension) - { - ImGui.SameLine(); - ImGui.SetCursorPosX(pos); - using (var font = ImRaii.PushFont(UiBuilder.IconFont)) - { - ImGuiUtil.TextColored(0xFF00B0B0, FontAwesomeIcon.ExclamationCircle.ToIconString()); - } - - ImUtf8.HoverTooltip("The game path and the file do not have the same extension."u8); - } } private void PrintNewGamePath(int i, FileRegistry registry, IModDataContainer subMod) @@ -314,7 +241,7 @@ public partial class ModEditWindow if (ImGui.IsItemDeactivatedAfterEdit()) { - if (Utf8GamePath.FromString(_gamePathEdit, out var path) && !path.IsEmpty) + if (Utf8GamePath.FromString(_gamePathEdit, out var path, false) && !path.IsEmpty) _editor.FileEditor.SetGamePath(_editor.Option!, _fileIdx, _pathIdx, path); _fileIdx = -1; @@ -322,7 +249,7 @@ public partial class ModEditWindow } else if (_fileIdx == i && _pathIdx == -1 - && (!Utf8GamePath.FromString(_gamePathEdit, out var path) + && (!Utf8GamePath.FromString(_gamePathEdit, out var path, false) || !path.IsEmpty && !_editor.FileEditor.CanAddGamePath(path))) { ImGui.SameLine(); @@ -330,17 +257,6 @@ public partial class ModEditWindow using var font = ImRaii.PushFont(UiBuilder.IconFont); ImGuiUtil.TextColored(0xFF0000FF, FontAwesomeIcon.TimesCircle.ToIconString()); } - else if (tmp.Length > 0 && Path.GetExtension(tmp) != registry.File.Extension) - { - ImGui.SameLine(); - ImGui.SetCursorPosX(pos); - using (var font = ImRaii.PushFont(UiBuilder.IconFont)) - { - ImGuiUtil.TextColored(0xFF00B0B0, FontAwesomeIcon.ExclamationCircle.ToIconString()); - } - - ImUtf8.HoverTooltip("The game path and the file do not have the same extension."u8); - } } private void DrawButtonHeader() diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ColorTable.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ColorTable.cs new file mode 100644 index 00000000..15bd7cc9 --- /dev/null +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ColorTable.cs @@ -0,0 +1,538 @@ +using Dalamud.Interface; +using Dalamud.Interface.Utility; +using ImGuiNET; +using OtterGui; +using OtterGui.Raii; +using Penumbra.GameData.Files; +using Penumbra.GameData.Files.MaterialStructs; +using Penumbra.String.Functions; + +namespace Penumbra.UI.AdvancedWindow; + +public partial class ModEditWindow +{ + private static readonly float HalfMinValue = (float)Half.MinValue; + private static readonly float HalfMaxValue = (float)Half.MaxValue; + private static readonly float HalfEpsilon = (float)Half.Epsilon; + + private bool DrawMaterialColorTableChange(MtrlTab tab, bool disabled) + { + if (!tab.SamplerIds.Contains(ShpkFile.TableSamplerId) || !tab.Mtrl.HasTable) + return false; + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + if (!ImGui.CollapsingHeader("Color Table", ImGuiTreeNodeFlags.DefaultOpen)) + return false; + + ColorTableCopyAllClipboardButton(tab.Mtrl); + ImGui.SameLine(); + var ret = ColorTablePasteAllClipboardButton(tab, disabled); + if (!disabled) + { + ImGui.SameLine(); + ImGui.Dummy(ImGuiHelpers.ScaledVector2(20, 0)); + ImGui.SameLine(); + ret |= ColorTableDyeableCheckbox(tab); + } + + var hasDyeTable = tab.Mtrl.HasDyeTable; + if (hasDyeTable) + { + ImGui.SameLine(); + ImGui.Dummy(ImGuiHelpers.ScaledVector2(20, 0)); + ImGui.SameLine(); + ret |= DrawPreviewDye(tab, disabled); + } + + using var table = ImRaii.Table("##ColorTable", hasDyeTable ? 11 : 9, + ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg | ImGuiTableFlags.BordersInnerV); + if (!table) + return false; + + ImGui.TableNextColumn(); + ImGui.TableHeader(string.Empty); + ImGui.TableNextColumn(); + ImGui.TableHeader("Row"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Diffuse"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Specular"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Emissive"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Gloss"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Tile"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Repeat"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Skew"); + if (hasDyeTable) + { + ImGui.TableNextColumn(); + ImGui.TableHeader("Dye"); + ImGui.TableNextColumn(); + ImGui.TableHeader("Dye Preview"); + } + + for (var i = 0; i < ColorTable.NumUsedRows; ++i) + { + ret |= DrawColorTableRow(tab, i, disabled); + ImGui.TableNextRow(); + } + + return ret; + } + + + private static void ColorTableCopyAllClipboardButton(MtrlFile file) + { + if (!ImGui.Button("Export All Rows to Clipboard", ImGuiHelpers.ScaledVector2(200, 0))) + return; + + try + { + var data1 = file.Table.AsBytes(); + var data2 = file.HasDyeTable ? file.DyeTable.AsBytes() : ReadOnlySpan.Empty; + var array = new byte[data1.Length + data2.Length]; + data1.TryCopyTo(array); + data2.TryCopyTo(array.AsSpan(data1.Length)); + var text = Convert.ToBase64String(array); + ImGui.SetClipboardText(text); + } + catch + { + // ignored + } + } + + private bool DrawPreviewDye(MtrlTab tab, bool disabled) + { + var (dyeId, (name, dyeColor, gloss)) = _stainService.StainCombo.CurrentSelection; + var tt = dyeId == 0 + ? "Select a preview dye first." + : "Apply all preview values corresponding to the dye template and chosen dye where dyeing is enabled."; + if (ImGuiUtil.DrawDisabledButton("Apply Preview Dye", Vector2.Zero, tt, disabled || dyeId == 0)) + { + var ret = false; + if (tab.Mtrl.HasDyeTable) + for (var i = 0; i < LegacyColorTable.NumUsedRows; ++i) + ret |= tab.Mtrl.ApplyDyeTemplate(_stainService.StmFile, i, dyeId, 0); + + tab.UpdateColorTablePreview(); + + return ret; + } + + ImGui.SameLine(); + var label = dyeId == 0 ? "Preview Dye###previewDye" : $"{name} (Preview)###previewDye"; + if (_stainService.StainCombo.Draw(label, dyeColor, string.Empty, true, gloss)) + tab.UpdateColorTablePreview(); + return false; + } + + private static unsafe bool ColorTablePasteAllClipboardButton(MtrlTab tab, bool disabled) + { + if (!ImGuiUtil.DrawDisabledButton("Import All Rows from Clipboard", ImGuiHelpers.ScaledVector2(200, 0), string.Empty, disabled) + || !tab.Mtrl.HasTable) + return false; + + try + { + var text = ImGui.GetClipboardText(); + var data = Convert.FromBase64String(text); + if (data.Length < Marshal.SizeOf()) + return false; + + ref var rows = ref tab.Mtrl.Table; + fixed (void* ptr = data, output = &rows) + { + MemoryUtility.MemCpyUnchecked(output, ptr, Marshal.SizeOf()); + if (data.Length >= Marshal.SizeOf() + Marshal.SizeOf() + && tab.Mtrl.HasDyeTable) + { + ref var dyeRows = ref tab.Mtrl.DyeTable; + fixed (void* output2 = &dyeRows) + { + MemoryUtility.MemCpyUnchecked(output2, (byte*)ptr + Marshal.SizeOf(), + Marshal.SizeOf()); + } + } + } + + tab.UpdateColorTablePreview(); + + return true; + } + catch + { + return false; + } + } + + [SkipLocalsInit] + private static unsafe void ColorTableCopyClipboardButton(ColorTable.Row row, ColorDyeTable.Row dye) + { + if (!ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Clipboard.ToIconString(), ImGui.GetFrameHeight() * Vector2.One, + "Export this row to your clipboard.", false, true)) + return; + + try + { + Span data = stackalloc byte[ColorTable.Row.Size + ColorDyeTable.Row.Size]; + fixed (byte* ptr = data) + { + MemoryUtility.MemCpyUnchecked(ptr, &row, ColorTable.Row.Size); + MemoryUtility.MemCpyUnchecked(ptr + ColorTable.Row.Size, &dye, ColorDyeTable.Row.Size); + } + + var text = Convert.ToBase64String(data); + ImGui.SetClipboardText(text); + } + catch + { + // ignored + } + } + + private static bool ColorTableDyeableCheckbox(MtrlTab tab) + { + var dyeable = tab.Mtrl.HasDyeTable; + var ret = ImGui.Checkbox("Dyeable", ref dyeable); + + if (ret) + { + tab.Mtrl.HasDyeTable = dyeable; + tab.UpdateColorTablePreview(); + } + + return ret; + } + + private static unsafe bool ColorTablePasteFromClipboardButton(MtrlTab tab, int rowIdx, bool disabled) + { + if (!ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Paste.ToIconString(), ImGui.GetFrameHeight() * Vector2.One, + "Import an exported row from your clipboard onto this row.", disabled, true)) + return false; + + try + { + var text = ImGui.GetClipboardText(); + var data = Convert.FromBase64String(text); + if (data.Length != ColorTable.Row.Size + ColorDyeTable.Row.Size + || !tab.Mtrl.HasTable) + return false; + + fixed (byte* ptr = data) + { + tab.Mtrl.Table[rowIdx] = *(ColorTable.Row*)ptr; + if (tab.Mtrl.HasDyeTable) + tab.Mtrl.DyeTable[rowIdx] = *(ColorDyeTable.Row*)(ptr + ColorTable.Row.Size); + } + + tab.UpdateColorTableRowPreview(rowIdx); + + return true; + } + catch + { + return false; + } + } + + private static void ColorTableHighlightButton(MtrlTab tab, int rowIdx, bool disabled) + { + ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Crosshairs.ToIconString(), ImGui.GetFrameHeight() * Vector2.One, + "Highlight this row on your character, if possible.", disabled || tab.ColorTablePreviewers.Count == 0, true); + + if (ImGui.IsItemHovered()) + tab.HighlightColorTableRow(rowIdx); + else if (tab.HighlightedColorTableRow == rowIdx) + tab.CancelColorTableHighlight(); + } + + private bool DrawColorTableRow(MtrlTab tab, int rowIdx, bool disabled) + { + static bool FixFloat(ref float val, float current) + { + val = (float)(Half)val; + return val != current; + } + + using var id = ImRaii.PushId(rowIdx); + ref var row = ref tab.Mtrl.Table[rowIdx]; + var hasDye = tab.Mtrl.HasDyeTable; + ref var dye = ref tab.Mtrl.DyeTable[rowIdx]; + var floatSize = 70 * UiHelpers.Scale; + var intSize = 45 * UiHelpers.Scale; + ImGui.TableNextColumn(); + ColorTableCopyClipboardButton(row, dye); + ImGui.SameLine(); + var ret = ColorTablePasteFromClipboardButton(tab, rowIdx, disabled); + ImGui.SameLine(); + ColorTableHighlightButton(tab, rowIdx, disabled); + + ImGui.TableNextColumn(); + ImGui.TextUnformatted($"#{rowIdx + 1:D2}"); + + ImGui.TableNextColumn(); + using var dis = ImRaii.Disabled(disabled); + ret |= ColorPicker("##Diffuse", "Diffuse Color", row.Diffuse, c => + { + tab.Mtrl.Table[rowIdx].Diffuse = c; + tab.UpdateColorTableRowPreview(rowIdx); + }); + if (hasDye) + { + ImGui.SameLine(); + ret |= ImGuiUtil.Checkbox("##dyeDiffuse", "Apply Diffuse Color on Dye", dye.Diffuse, + b => + { + tab.Mtrl.DyeTable[rowIdx].Diffuse = b; + tab.UpdateColorTableRowPreview(rowIdx); + }, ImGuiHoveredFlags.AllowWhenDisabled); + } + + ImGui.TableNextColumn(); + ret |= ColorPicker("##Specular", "Specular Color", row.Specular, c => + { + tab.Mtrl.Table[rowIdx].Specular = c; + tab.UpdateColorTableRowPreview(rowIdx); + }); + ImGui.SameLine(); + var tmpFloat = row.SpecularStrength; + ImGui.SetNextItemWidth(floatSize); + if (ImGui.DragFloat("##SpecularStrength", ref tmpFloat, 0.01f, 0f, HalfMaxValue, "%.2f") + && FixFloat(ref tmpFloat, row.SpecularStrength)) + { + row.SpecularStrength = tmpFloat; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Specular Strength", ImGuiHoveredFlags.AllowWhenDisabled); + + if (hasDye) + { + ImGui.SameLine(); + ret |= ImGuiUtil.Checkbox("##dyeSpecular", "Apply Specular Color on Dye", dye.Specular, + b => + { + tab.Mtrl.DyeTable[rowIdx].Specular = b; + tab.UpdateColorTableRowPreview(rowIdx); + }, ImGuiHoveredFlags.AllowWhenDisabled); + ImGui.SameLine(); + ret |= ImGuiUtil.Checkbox("##dyeSpecularStrength", "Apply Specular Strength on Dye", dye.SpecularStrength, + b => + { + tab.Mtrl.DyeTable[rowIdx].SpecularStrength = b; + tab.UpdateColorTableRowPreview(rowIdx); + }, ImGuiHoveredFlags.AllowWhenDisabled); + } + + ImGui.TableNextColumn(); + ret |= ColorPicker("##Emissive", "Emissive Color", row.Emissive, c => + { + tab.Mtrl.Table[rowIdx].Emissive = c; + tab.UpdateColorTableRowPreview(rowIdx); + }); + if (hasDye) + { + ImGui.SameLine(); + ret |= ImGuiUtil.Checkbox("##dyeEmissive", "Apply Emissive Color on Dye", dye.Emissive, + b => + { + tab.Mtrl.DyeTable[rowIdx].Emissive = b; + tab.UpdateColorTableRowPreview(rowIdx); + }, ImGuiHoveredFlags.AllowWhenDisabled); + } + + ImGui.TableNextColumn(); + tmpFloat = row.GlossStrength; + ImGui.SetNextItemWidth(floatSize); + var glossStrengthMin = ImGui.GetIO().KeyCtrl ? 0.0f : HalfEpsilon; + if (ImGui.DragFloat("##GlossStrength", ref tmpFloat, Math.Max(0.1f, tmpFloat * 0.025f), glossStrengthMin, HalfMaxValue, "%.1f") + && FixFloat(ref tmpFloat, row.GlossStrength)) + { + row.GlossStrength = Math.Max(tmpFloat, glossStrengthMin); + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Gloss Strength", ImGuiHoveredFlags.AllowWhenDisabled); + if (hasDye) + { + ImGui.SameLine(); + ret |= ImGuiUtil.Checkbox("##dyeGloss", "Apply Gloss Strength on Dye", dye.Gloss, + b => + { + tab.Mtrl.DyeTable[rowIdx].Gloss = b; + tab.UpdateColorTableRowPreview(rowIdx); + }, ImGuiHoveredFlags.AllowWhenDisabled); + } + + ImGui.TableNextColumn(); + int tmpInt = row.TileSet; + ImGui.SetNextItemWidth(intSize); + if (ImGui.DragInt("##TileSet", ref tmpInt, 0.25f, 0, 63) && tmpInt != row.TileSet && tmpInt is >= 0 and <= ushort.MaxValue) + { + row.TileSet = (ushort)Math.Clamp(tmpInt, 0, 63); + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Tile Set", ImGuiHoveredFlags.AllowWhenDisabled); + + ImGui.TableNextColumn(); + tmpFloat = row.MaterialRepeat.X; + ImGui.SetNextItemWidth(floatSize); + if (ImGui.DragFloat("##RepeatX", ref tmpFloat, 0.1f, HalfMinValue, HalfMaxValue, "%.2f") + && FixFloat(ref tmpFloat, row.MaterialRepeat.X)) + { + row.MaterialRepeat = row.MaterialRepeat with { X = tmpFloat }; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Repeat X", ImGuiHoveredFlags.AllowWhenDisabled); + ImGui.SameLine(); + tmpFloat = row.MaterialRepeat.Y; + ImGui.SetNextItemWidth(floatSize); + if (ImGui.DragFloat("##RepeatY", ref tmpFloat, 0.1f, HalfMinValue, HalfMaxValue, "%.2f") + && FixFloat(ref tmpFloat, row.MaterialRepeat.Y)) + { + row.MaterialRepeat = row.MaterialRepeat with { Y = tmpFloat }; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Repeat Y", ImGuiHoveredFlags.AllowWhenDisabled); + + ImGui.TableNextColumn(); + tmpFloat = row.MaterialSkew.X; + ImGui.SetNextItemWidth(floatSize); + if (ImGui.DragFloat("##SkewX", ref tmpFloat, 0.1f, HalfMinValue, HalfMaxValue, "%.2f") && FixFloat(ref tmpFloat, row.MaterialSkew.X)) + { + row.MaterialSkew = row.MaterialSkew with { X = tmpFloat }; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Skew X", ImGuiHoveredFlags.AllowWhenDisabled); + + ImGui.SameLine(); + tmpFloat = row.MaterialSkew.Y; + ImGui.SetNextItemWidth(floatSize); + if (ImGui.DragFloat("##SkewY", ref tmpFloat, 0.1f, HalfMinValue, HalfMaxValue, "%.2f") && FixFloat(ref tmpFloat, row.MaterialSkew.Y)) + { + row.MaterialSkew = row.MaterialSkew with { Y = tmpFloat }; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Skew Y", ImGuiHoveredFlags.AllowWhenDisabled); + + if (hasDye) + { + ImGui.TableNextColumn(); + if (_stainService.TemplateCombo.Draw("##dyeTemplate", dye.Template.ToString(), string.Empty, intSize + + ImGui.GetStyle().ScrollbarSize / 2, ImGui.GetTextLineHeightWithSpacing(), ImGuiComboFlags.NoArrowButton)) + { + dye.Template = _stainService.TemplateCombo.CurrentSelection; + ret = true; + tab.UpdateColorTableRowPreview(rowIdx); + } + + ImGuiUtil.HoverTooltip("Dye Template", ImGuiHoveredFlags.AllowWhenDisabled); + + ImGui.TableNextColumn(); + ret |= DrawDyePreview(tab, rowIdx, disabled, dye, floatSize); + } + + + return ret; + } + + private bool DrawDyePreview(MtrlTab tab, int rowIdx, bool disabled, ColorDyeTable.Row dye, float floatSize) + { + var stain = _stainService.StainCombo.CurrentSelection.Key; + if (stain == 0 || !_stainService.StmFile.Entries.TryGetValue(dye.Template, out var entry)) + return false; + + var values = entry[(int)stain]; + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, ImGui.GetStyle().ItemSpacing / 2); + + var ret = ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.PaintBrush.ToIconString(), new Vector2(ImGui.GetFrameHeight()), + "Apply the selected dye to this row.", disabled, true); + + ret = ret && tab.Mtrl.ApplyDyeTemplate(_stainService.StmFile, rowIdx, stain, 0); + if (ret) + tab.UpdateColorTableRowPreview(rowIdx); + + ImGui.SameLine(); + ColorPicker("##diffusePreview", string.Empty, values.Diffuse, _ => { }, "D"); + ImGui.SameLine(); + ColorPicker("##specularPreview", string.Empty, values.Specular, _ => { }, "S"); + ImGui.SameLine(); + ColorPicker("##emissivePreview", string.Empty, values.Emissive, _ => { }, "E"); + ImGui.SameLine(); + using var dis = ImRaii.Disabled(); + ImGui.SetNextItemWidth(floatSize); + ImGui.DragFloat("##gloss", ref values.Gloss, 0, values.Gloss, values.Gloss, "%.1f G"); + ImGui.SameLine(); + ImGui.SetNextItemWidth(floatSize); + ImGui.DragFloat("##specularStrength", ref values.SpecularPower, 0, values.SpecularPower, values.SpecularPower, "%.2f S"); + + return ret; + } + + private static bool ColorPicker(string label, string tooltip, Vector3 input, Action setter, string letter = "") + { + var ret = false; + var inputSqrt = PseudoSqrtRgb(input); + var tmp = inputSqrt; + if (ImGui.ColorEdit3(label, ref tmp, + ImGuiColorEditFlags.NoInputs + | ImGuiColorEditFlags.DisplayRGB + | ImGuiColorEditFlags.InputRGB + | ImGuiColorEditFlags.NoTooltip + | ImGuiColorEditFlags.HDR) + && tmp != inputSqrt) + { + setter(PseudoSquareRgb(tmp)); + ret = true; + } + + if (letter.Length > 0 && ImGui.IsItemVisible()) + { + var textSize = ImGui.CalcTextSize(letter); + var center = ImGui.GetItemRectMin() + (ImGui.GetItemRectSize() - textSize) / 2; + var textColor = input.LengthSquared() < 0.25f ? 0x80FFFFFFu : 0x80000000u; + ImGui.GetWindowDrawList().AddText(center, textColor, letter); + } + + ImGuiUtil.HoverTooltip(tooltip, ImGuiHoveredFlags.AllowWhenDisabled); + + return ret; + } + + // Functions to deal with squared RGB values without making negatives useless. + + private static float PseudoSquareRgb(float x) + => x < 0.0f ? -(x * x) : x * x; + + private static Vector3 PseudoSquareRgb(Vector3 vec) + => new(PseudoSquareRgb(vec.X), PseudoSquareRgb(vec.Y), PseudoSquareRgb(vec.Z)); + + private static Vector4 PseudoSquareRgb(Vector4 vec) + => new(PseudoSquareRgb(vec.X), PseudoSquareRgb(vec.Y), PseudoSquareRgb(vec.Z), vec.W); + + private static float PseudoSqrtRgb(float x) + => x < 0.0f ? -MathF.Sqrt(-x) : MathF.Sqrt(x); + + internal static Vector3 PseudoSqrtRgb(Vector3 vec) + => new(PseudoSqrtRgb(vec.X), PseudoSqrtRgb(vec.Y), PseudoSqrtRgb(vec.Z)); + + private static Vector4 PseudoSqrtRgb(Vector4 vec) + => new(PseudoSqrtRgb(vec.X), PseudoSqrtRgb(vec.Y), PseudoSqrtRgb(vec.Z), vec.W); +} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ConstantEditor.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ConstantEditor.cs new file mode 100644 index 00000000..1f5db38e --- /dev/null +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.ConstantEditor.cs @@ -0,0 +1,247 @@ +using ImGuiNET; +using OtterGui.Raii; +using OtterGui; +using Penumbra.GameData; + +namespace Penumbra.UI.AdvancedWindow; + +public partial class ModEditWindow +{ + private interface IConstantEditor + { + bool Draw(Span values, bool disabled); + } + + private sealed class FloatConstantEditor : IConstantEditor + { + public static readonly FloatConstantEditor Default = new(null, null, 0.1f, 0.0f, 1.0f, 0.0f, 3, string.Empty); + + private readonly float? _minimum; + private readonly float? _maximum; + private readonly float _speed; + private readonly float _relativeSpeed; + private readonly float _factor; + private readonly float _bias; + private readonly string _format; + + public FloatConstantEditor(float? minimum, float? maximum, float speed, float relativeSpeed, float factor, float bias, byte precision, + string unit) + { + _minimum = minimum; + _maximum = maximum; + _speed = speed; + _relativeSpeed = relativeSpeed; + _factor = factor; + _bias = bias; + _format = $"%.{Math.Min(precision, (byte)9)}f"; + if (unit.Length > 0) + _format = $"{_format} {unit.Replace("%", "%%")}"; + } + + public bool Draw(Span values, bool disabled) + { + var spacing = ImGui.GetStyle().ItemInnerSpacing.X; + var fieldWidth = (ImGui.CalcItemWidth() - (values.Length - 1) * spacing) / values.Length; + + var ret = false; + + // Not using DragScalarN because of _relativeSpeed and other points of lost flexibility. + for (var valueIdx = 0; valueIdx < values.Length; ++valueIdx) + { + if (valueIdx > 0) + ImGui.SameLine(0.0f, spacing); + + ImGui.SetNextItemWidth(MathF.Round(fieldWidth * (valueIdx + 1)) - MathF.Round(fieldWidth * valueIdx)); + + var value = (values[valueIdx] - _bias) / _factor; + if (disabled) + { + ImGui.DragFloat($"##{valueIdx}", ref value, Math.Max(_speed, value * _relativeSpeed), value, value, _format); + } + else + { + if (ImGui.DragFloat($"##{valueIdx}", ref value, Math.Max(_speed, value * _relativeSpeed), _minimum ?? 0.0f, + _maximum ?? 0.0f, _format)) + { + values[valueIdx] = Clamp(value) * _factor + _bias; + ret = true; + } + } + } + + return ret; + } + + private float Clamp(float value) + => Math.Clamp(value, _minimum ?? float.NegativeInfinity, _maximum ?? float.PositiveInfinity); + } + + private sealed class IntConstantEditor : IConstantEditor + { + private readonly int? _minimum; + private readonly int? _maximum; + private readonly float _speed; + private readonly float _relativeSpeed; + private readonly float _factor; + private readonly float _bias; + private readonly string _format; + + public IntConstantEditor(int? minimum, int? maximum, float speed, float relativeSpeed, float factor, float bias, string unit) + { + _minimum = minimum; + _maximum = maximum; + _speed = speed; + _relativeSpeed = relativeSpeed; + _factor = factor; + _bias = bias; + _format = "%d"; + if (unit.Length > 0) + _format = $"{_format} {unit.Replace("%", "%%")}"; + } + + public bool Draw(Span values, bool disabled) + { + var spacing = ImGui.GetStyle().ItemInnerSpacing.X; + var fieldWidth = (ImGui.CalcItemWidth() - (values.Length - 1) * spacing) / values.Length; + + var ret = false; + + // Not using DragScalarN because of _relativeSpeed and other points of lost flexibility. + for (var valueIdx = 0; valueIdx < values.Length; ++valueIdx) + { + if (valueIdx > 0) + ImGui.SameLine(0.0f, spacing); + + ImGui.SetNextItemWidth(MathF.Round(fieldWidth * (valueIdx + 1)) - MathF.Round(fieldWidth * valueIdx)); + + var value = (int)Math.Clamp(MathF.Round((values[valueIdx] - _bias) / _factor), int.MinValue, int.MaxValue); + if (disabled) + { + ImGui.DragInt($"##{valueIdx}", ref value, Math.Max(_speed, value * _relativeSpeed), value, value, _format); + } + else + { + if (ImGui.DragInt($"##{valueIdx}", ref value, Math.Max(_speed, value * _relativeSpeed), _minimum ?? 0, _maximum ?? 0, + _format)) + { + values[valueIdx] = Clamp(value) * _factor + _bias; + ret = true; + } + } + } + + return ret; + } + + private int Clamp(int value) + => Math.Clamp(value, _minimum ?? int.MinValue, _maximum ?? int.MaxValue); + } + + private sealed class ColorConstantEditor : IConstantEditor + { + private readonly bool _squaredRgb; + private readonly bool _clamped; + + public ColorConstantEditor(bool squaredRgb, bool clamped) + { + _squaredRgb = squaredRgb; + _clamped = clamped; + } + + public bool Draw(Span values, bool disabled) + { + switch (values.Length) + { + case 3: + { + var value = new Vector3(values); + if (_squaredRgb) + value = PseudoSqrtRgb(value); + if (!ImGui.ColorEdit3("##0", ref value, ImGuiColorEditFlags.Float | (_clamped ? 0 : ImGuiColorEditFlags.HDR)) || disabled) + return false; + + if (_squaredRgb) + value = PseudoSquareRgb(value); + if (_clamped) + value = Vector3.Clamp(value, Vector3.Zero, Vector3.One); + value.CopyTo(values); + return true; + } + case 4: + { + var value = new Vector4(values); + if (_squaredRgb) + value = PseudoSqrtRgb(value); + if (!ImGui.ColorEdit4("##0", ref value, + ImGuiColorEditFlags.Float | ImGuiColorEditFlags.AlphaPreviewHalf | (_clamped ? 0 : ImGuiColorEditFlags.HDR)) + || disabled) + return false; + + if (_squaredRgb) + value = PseudoSquareRgb(value); + if (_clamped) + value = Vector4.Clamp(value, Vector4.Zero, Vector4.One); + value.CopyTo(values); + return true; + } + default: return FloatConstantEditor.Default.Draw(values, disabled); + } + } + } + + private sealed class EnumConstantEditor : IConstantEditor + { + private readonly IReadOnlyList<(string Label, float Value, string Description)> _values; + + public EnumConstantEditor(IReadOnlyList<(string Label, float Value, string Description)> values) + => _values = values; + + public bool Draw(Span values, bool disabled) + { + var spacing = ImGui.GetStyle().ItemInnerSpacing.X; + var fieldWidth = (ImGui.CalcItemWidth() - (values.Length - 1) * spacing) / values.Length; + + var ret = false; + + for (var valueIdx = 0; valueIdx < values.Length; ++valueIdx) + { + using var id = ImRaii.PushId(valueIdx); + if (valueIdx > 0) + ImGui.SameLine(0.0f, spacing); + + ImGui.SetNextItemWidth(MathF.Round(fieldWidth * (valueIdx + 1)) - MathF.Round(fieldWidth * valueIdx)); + + var currentValue = values[valueIdx]; + var currentLabel = _values.FirstOrNull(v => v.Value == currentValue)?.Label + ?? currentValue.ToString(CultureInfo.CurrentCulture); + ret = disabled + ? ImGui.InputText(string.Empty, ref currentLabel, (uint)currentLabel.Length, ImGuiInputTextFlags.ReadOnly) + : DrawCombo(currentLabel, ref values[valueIdx]); + } + + return ret; + } + + private bool DrawCombo(string label, ref float currentValue) + { + using var c = ImRaii.Combo(string.Empty, label); + if (!c) + return false; + + var ret = false; + foreach (var (valueLabel, value, valueDescription) in _values) + { + if (ImGui.Selectable(valueLabel, value == currentValue)) + { + currentValue = value; + ret = true; + } + + if (valueDescription.Length > 0) + ImGuiUtil.SelectableHelpMarker(valueDescription); + } + + return ret; + } + } +} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.MtrlTab.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.MtrlTab.cs new file mode 100644 index 00000000..56e9482b --- /dev/null +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.MtrlTab.cs @@ -0,0 +1,782 @@ +using Dalamud.Interface; +using Dalamud.Interface.Internal.Notifications; +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using ImGuiNET; +using Newtonsoft.Json.Linq; +using OtterGui; +using OtterGui.Classes; +using OtterGui.Raii; +using Penumbra.GameData.Data; +using Penumbra.GameData.Files; +using Penumbra.GameData.Files.MaterialStructs; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Hooks.Objects; +using Penumbra.Interop.MaterialPreview; +using Penumbra.String; +using Penumbra.String.Classes; +using Penumbra.UI.Classes; +using static Penumbra.GameData.Files.ShpkFile; + +namespace Penumbra.UI.AdvancedWindow; + +public partial class ModEditWindow +{ + private sealed class MtrlTab : IWritable, IDisposable + { + private const int ShpkPrefixLength = 16; + + private static readonly ByteString ShpkPrefix = ByteString.FromSpanUnsafe("shader/sm5/shpk/"u8, true, true, true); + + private readonly ModEditWindow _edit; + public readonly MtrlFile Mtrl; + public readonly string FilePath; + public readonly bool Writable; + + private string[]? _shpkNames; + + public string ShaderHeader = "Shader###Shader"; + public FullPath LoadedShpkPath = FullPath.Empty; + public string LoadedShpkPathName = string.Empty; + public string LoadedShpkDevkitPathName = string.Empty; + public string ShaderComment = string.Empty; + public ShpkFile? AssociatedShpk; + public JObject? AssociatedShpkDevkit; + + public readonly string LoadedBaseDevkitPathName; + public readonly JObject? AssociatedBaseDevkit; + + // Shader Key State + public readonly + List<(string Label, int Index, string Description, bool MonoFont, IReadOnlyList<(string Label, uint Value, string Description)> + Values)> ShaderKeys = new(16); + + public readonly HashSet VertexShaders = new(16); + public readonly HashSet PixelShaders = new(16); + public bool ShadersKnown; + public string VertexShadersString = "Vertex Shaders: ???"; + public string PixelShadersString = "Pixel Shaders: ???"; + + // Textures & Samplers + public readonly List<(string Label, int TextureIndex, int SamplerIndex, string Description, bool MonoFont)> Textures = new(4); + + public readonly HashSet UnfoldedTextures = new(4); + public readonly HashSet SamplerIds = new(16); + public float TextureLabelWidth; + + // Material Constants + public readonly + List<(string Header, List<(string Label, int ConstantIndex, Range Slice, string Description, bool MonoFont, IConstantEditor Editor)> + Constants)> Constants = new(16); + + // Live-Previewers + public readonly List MaterialPreviewers = new(4); + public readonly List ColorTablePreviewers = new(4); + public int HighlightedColorTableRow = -1; + public readonly Stopwatch HighlightTime = new(); + + public FullPath FindAssociatedShpk(out string defaultPath, out Utf8GamePath defaultGamePath) + { + defaultPath = GamePaths.Shader.ShpkPath(Mtrl.ShaderPackage.Name); + if (!Utf8GamePath.FromString(defaultPath, out defaultGamePath, true)) + return FullPath.Empty; + + return _edit.FindBestMatch(defaultGamePath); + } + + public string[] GetShpkNames() + { + if (null != _shpkNames) + return _shpkNames; + + var names = new HashSet(StandardShaderPackages); + names.UnionWith(_edit.FindPathsStartingWith(ShpkPrefix).Select(path => path.ToString()[ShpkPrefixLength..])); + + _shpkNames = names.ToArray(); + Array.Sort(_shpkNames); + + return _shpkNames; + } + + public void LoadShpk(FullPath path) + { + ShaderHeader = $"Shader ({Mtrl.ShaderPackage.Name})###Shader"; + + try + { + LoadedShpkPath = path; + var data = LoadedShpkPath.IsRooted + ? File.ReadAllBytes(LoadedShpkPath.FullName) + : _edit._gameData.GetFile(LoadedShpkPath.InternalName.ToString())?.Data; + AssociatedShpk = data?.Length > 0 ? new ShpkFile(data) : throw new Exception("Failure to load file data."); + LoadedShpkPathName = path.ToPath(); + } + catch (Exception e) + { + LoadedShpkPath = FullPath.Empty; + LoadedShpkPathName = string.Empty; + AssociatedShpk = null; + Penumbra.Messager.NotificationMessage(e, $"Could not load {LoadedShpkPath.ToPath()}.", NotificationType.Error, false); + } + + if (LoadedShpkPath.InternalName.IsEmpty) + { + AssociatedShpkDevkit = null; + LoadedShpkDevkitPathName = string.Empty; + } + else + { + AssociatedShpkDevkit = + TryLoadShpkDevkit(Path.GetFileNameWithoutExtension(Mtrl.ShaderPackage.Name), out LoadedShpkDevkitPathName); + } + + UpdateShaderKeys(); + Update(); + } + + private JObject? TryLoadShpkDevkit(string shpkBaseName, out string devkitPathName) + { + try + { + if (!Utf8GamePath.FromString("penumbra/shpk_devkit/" + shpkBaseName + ".json", out var devkitPath)) + throw new Exception("Could not assemble ShPk dev-kit path."); + + var devkitFullPath = _edit.FindBestMatch(devkitPath); + if (!devkitFullPath.IsRooted) + throw new Exception("Could not resolve ShPk dev-kit path."); + + devkitPathName = devkitFullPath.FullName; + return JObject.Parse(File.ReadAllText(devkitFullPath.FullName)); + } + catch + { + devkitPathName = string.Empty; + return null; + } + } + + private T? TryGetShpkDevkitData(string category, uint? id, bool mayVary) where T : class + => TryGetShpkDevkitData(AssociatedShpkDevkit, LoadedShpkDevkitPathName, category, id, mayVary) + ?? TryGetShpkDevkitData(AssociatedBaseDevkit, LoadedBaseDevkitPathName, category, id, mayVary); + + private T? TryGetShpkDevkitData(JObject? devkit, string devkitPathName, string category, uint? id, bool mayVary) where T : class + { + if (devkit == null) + return null; + + try + { + var data = devkit[category]; + if (id.HasValue) + data = data?[id.Value.ToString()]; + + if (mayVary && (data as JObject)?["Vary"] != null) + { + var selector = BuildSelector(data!["Vary"]! + .Select(key => (uint)key) + .Select(key => Mtrl.GetShaderKey(key)?.Value ?? AssociatedShpk!.GetMaterialKeyById(key)!.Value.DefaultValue)); + var index = (int)data["Selectors"]![selector.ToString()]!; + data = data["Items"]![index]; + } + + return data?.ToObject(typeof(T)) as T; + } + catch (Exception e) + { + // Some element in the JSON was undefined or invalid (wrong type, key that doesn't exist in the ShPk, index out of range, …) + Penumbra.Log.Error($"Error while traversing the ShPk dev-kit file at {devkitPathName}: {e}"); + return null; + } + } + + private void UpdateShaderKeys() + { + ShaderKeys.Clear(); + if (AssociatedShpk != null) + foreach (var key in AssociatedShpk.MaterialKeys) + { + var dkData = TryGetShpkDevkitData("ShaderKeys", key.Id, false); + var hasDkLabel = !string.IsNullOrEmpty(dkData?.Label); + + var valueSet = new HashSet(key.Values); + if (dkData != null) + valueSet.UnionWith(dkData.Values.Keys); + + var mtrlKeyIndex = Mtrl.FindOrAddShaderKey(key.Id, key.DefaultValue); + var values = valueSet.Select(value => + { + if (dkData != null && dkData.Values.TryGetValue(value, out var dkValue)) + return (dkValue.Label.Length > 0 ? dkValue.Label : $"0x{value:X8}", value, dkValue.Description); + + return ($"0x{value:X8}", value, string.Empty); + }).ToArray(); + Array.Sort(values, (x, y) => + { + if (x.Value == key.DefaultValue) + return -1; + if (y.Value == key.DefaultValue) + return 1; + + return string.Compare(x.Label, y.Label, StringComparison.Ordinal); + }); + ShaderKeys.Add((hasDkLabel ? dkData!.Label : $"0x{key.Id:X8}", mtrlKeyIndex, dkData?.Description ?? string.Empty, + !hasDkLabel, values)); + } + else + foreach (var (key, index) in Mtrl.ShaderPackage.ShaderKeys.WithIndex()) + ShaderKeys.Add(($"0x{key.Category:X8}", index, string.Empty, true, Array.Empty<(string, uint, string)>())); + } + + private void UpdateShaders() + { + VertexShaders.Clear(); + PixelShaders.Clear(); + if (AssociatedShpk == null) + { + ShadersKnown = false; + } + else + { + ShadersKnown = true; + var systemKeySelectors = AllSelectors(AssociatedShpk.SystemKeys).ToArray(); + var sceneKeySelectors = AllSelectors(AssociatedShpk.SceneKeys).ToArray(); + var subViewKeySelectors = AllSelectors(AssociatedShpk.SubViewKeys).ToArray(); + var materialKeySelector = + BuildSelector(AssociatedShpk.MaterialKeys.Select(key => Mtrl.GetOrAddShaderKey(key.Id, key.DefaultValue).Value)); + foreach (var systemKeySelector in systemKeySelectors) + { + foreach (var sceneKeySelector in sceneKeySelectors) + { + foreach (var subViewKeySelector in subViewKeySelectors) + { + var selector = BuildSelector(systemKeySelector, sceneKeySelector, materialKeySelector, subViewKeySelector); + var node = AssociatedShpk.GetNodeBySelector(selector); + if (node.HasValue) + foreach (var pass in node.Value.Passes) + { + VertexShaders.Add((int)pass.VertexShader); + PixelShaders.Add((int)pass.PixelShader); + } + else + ShadersKnown = false; + } + } + } + } + + var vertexShaders = VertexShaders.OrderBy(i => i).Select(i => $"#{i}"); + var pixelShaders = PixelShaders.OrderBy(i => i).Select(i => $"#{i}"); + + VertexShadersString = $"Vertex Shaders: {string.Join(", ", ShadersKnown ? vertexShaders : vertexShaders.Append("???"))}"; + PixelShadersString = $"Pixel Shaders: {string.Join(", ", ShadersKnown ? pixelShaders : pixelShaders.Append("???"))}"; + + ShaderComment = TryGetShpkDevkitData("Comment", null, true) ?? string.Empty; + } + + private void UpdateTextures() + { + Textures.Clear(); + SamplerIds.Clear(); + if (AssociatedShpk == null) + { + SamplerIds.UnionWith(Mtrl.ShaderPackage.Samplers.Select(sampler => sampler.SamplerId)); + if (Mtrl.HasTable) + SamplerIds.Add(TableSamplerId); + + foreach (var (sampler, index) in Mtrl.ShaderPackage.Samplers.WithIndex()) + Textures.Add(($"0x{sampler.SamplerId:X8}", sampler.TextureIndex, index, string.Empty, true)); + } + else + { + foreach (var index in VertexShaders) + SamplerIds.UnionWith(AssociatedShpk.VertexShaders[index].Samplers.Select(sampler => sampler.Id)); + foreach (var index in PixelShaders) + SamplerIds.UnionWith(AssociatedShpk.PixelShaders[index].Samplers.Select(sampler => sampler.Id)); + if (!ShadersKnown) + { + SamplerIds.UnionWith(Mtrl.ShaderPackage.Samplers.Select(sampler => sampler.SamplerId)); + if (Mtrl.HasTable) + SamplerIds.Add(TableSamplerId); + } + + foreach (var samplerId in SamplerIds) + { + var shpkSampler = AssociatedShpk.GetSamplerById(samplerId); + if (shpkSampler is not { Slot: 2 }) + continue; + + var dkData = TryGetShpkDevkitData("Samplers", samplerId, true); + var hasDkLabel = !string.IsNullOrEmpty(dkData?.Label); + + var sampler = Mtrl.GetOrAddSampler(samplerId, dkData?.DefaultTexture ?? string.Empty, out var samplerIndex); + Textures.Add((hasDkLabel ? dkData!.Label : shpkSampler.Value.Name, sampler.TextureIndex, samplerIndex, + dkData?.Description ?? string.Empty, !hasDkLabel)); + } + + if (SamplerIds.Contains(TableSamplerId)) + Mtrl.HasTable = true; + } + + Textures.Sort((x, y) => string.CompareOrdinal(x.Label, y.Label)); + + TextureLabelWidth = 50f * UiHelpers.Scale; + + float helpWidth; + using (var _ = ImRaii.PushFont(UiBuilder.IconFont)) + { + helpWidth = ImGui.GetStyle().ItemSpacing.X + ImGui.CalcTextSize(FontAwesomeIcon.InfoCircle.ToIconString()).X; + } + + foreach (var (label, _, _, description, monoFont) in Textures) + { + if (!monoFont) + TextureLabelWidth = Math.Max(TextureLabelWidth, ImGui.CalcTextSize(label).X + (description.Length > 0 ? helpWidth : 0.0f)); + } + + using (var _ = ImRaii.PushFont(UiBuilder.MonoFont)) + { + foreach (var (label, _, _, description, monoFont) in Textures) + { + if (monoFont) + TextureLabelWidth = Math.Max(TextureLabelWidth, + ImGui.CalcTextSize(label).X + (description.Length > 0 ? helpWidth : 0.0f)); + } + } + + TextureLabelWidth = TextureLabelWidth / UiHelpers.Scale + 4; + } + + private void UpdateConstants() + { + static List FindOrAddGroup(List<(string, List)> groups, string name) + { + foreach (var (groupName, group) in groups) + { + if (string.Equals(name, groupName, StringComparison.Ordinal)) + return group; + } + + var newGroup = new List(16); + groups.Add((name, newGroup)); + return newGroup; + } + + Constants.Clear(); + if (AssociatedShpk == null) + { + var fcGroup = FindOrAddGroup(Constants, "Further Constants"); + foreach (var (constant, index) in Mtrl.ShaderPackage.Constants.WithIndex()) + { + var values = Mtrl.GetConstantValues(constant); + for (var i = 0; i < values.Length; i += 4) + { + fcGroup.Add(($"0x{constant.Id:X8}", index, i..Math.Min(i + 4, values.Length), string.Empty, true, + FloatConstantEditor.Default)); + } + } + } + else + { + var prefix = AssociatedShpk.GetConstantById(MaterialParamsConstantId)?.Name ?? string.Empty; + foreach (var shpkConstant in AssociatedShpk.MaterialParams) + { + if ((shpkConstant.ByteSize & 0x3) != 0) + continue; + + var constant = Mtrl.GetOrAddConstant(shpkConstant.Id, shpkConstant.ByteSize >> 2, out var constantIndex); + var values = Mtrl.GetConstantValues(constant); + var handledElements = new IndexSet(values.Length, false); + + var dkData = TryGetShpkDevkitData("Constants", shpkConstant.Id, true); + if (dkData != null) + foreach (var dkConstant in dkData) + { + var offset = (int)dkConstant.Offset; + var length = values.Length - offset; + if (dkConstant.Length.HasValue) + length = Math.Min(length, (int)dkConstant.Length.Value); + if (length <= 0) + continue; + + var editor = dkConstant.CreateEditor(); + if (editor != null) + FindOrAddGroup(Constants, dkConstant.Group.Length > 0 ? dkConstant.Group : "Further Constants") + .Add((dkConstant.Label, constantIndex, offset..(offset + length), dkConstant.Description, false, editor)); + handledElements.AddRange(offset, length); + } + + var fcGroup = FindOrAddGroup(Constants, "Further Constants"); + foreach (var (start, end) in handledElements.Ranges(true)) + { + if ((shpkConstant.ByteOffset & 0x3) == 0) + { + var offset = shpkConstant.ByteOffset >> 2; + for (int i = (start & ~0x3) - (offset & 0x3), j = offset >> 2; i < end; i += 4, ++j) + { + var rangeStart = Math.Max(i, start); + var rangeEnd = Math.Min(i + 4, end); + if (rangeEnd > rangeStart) + fcGroup.Add(( + $"{prefix}[{j:D2}]{VectorSwizzle((offset + rangeStart) & 0x3, (offset + rangeEnd - 1) & 0x3)} (0x{shpkConstant.Id:X8})", + constantIndex, rangeStart..rangeEnd, string.Empty, true, FloatConstantEditor.Default)); + } + } + else + { + for (var i = start; i < end; i += 4) + { + fcGroup.Add(($"0x{shpkConstant.Id:X8}", constantIndex, i..Math.Min(i + 4, end), string.Empty, true, + FloatConstantEditor.Default)); + } + } + } + } + } + + Constants.RemoveAll(group => group.Constants.Count == 0); + Constants.Sort((x, y) => + { + if (string.Equals(x.Header, "Further Constants", StringComparison.Ordinal)) + return 1; + if (string.Equals(y.Header, "Further Constants", StringComparison.Ordinal)) + return -1; + + return string.Compare(x.Header, y.Header, StringComparison.Ordinal); + }); + // HACK the Replace makes w appear after xyz, for the cbuffer-location-based naming scheme + foreach (var (_, group) in Constants) + { + group.Sort((x, y) => string.CompareOrdinal( + x.MonoFont ? x.Label.Replace("].w", "].{") : x.Label, + y.MonoFont ? y.Label.Replace("].w", "].{") : y.Label)); + } + } + + public unsafe void BindToMaterialInstances() + { + UnbindFromMaterialInstances(); + + var instances = MaterialInfo.FindMaterials(_edit._resourceTreeFactory.GetLocalPlayerRelatedCharacters().Select(ch => ch.Address), + FilePath); + + var foundMaterials = new HashSet(); + foreach (var materialInfo in instances) + { + var material = materialInfo.GetDrawObjectMaterial(_edit._objects); + if (foundMaterials.Contains((nint)material)) + continue; + + try + { + MaterialPreviewers.Add(new LiveMaterialPreviewer(_edit._objects, materialInfo)); + foundMaterials.Add((nint)material); + } + catch (InvalidOperationException) + { + // Carry on without that previewer. + } + } + + UpdateMaterialPreview(); + + if (!Mtrl.HasTable) + return; + + foreach (var materialInfo in instances) + { + try + { + ColorTablePreviewers.Add(new LiveColorTablePreviewer(_edit._objects, _edit._framework, materialInfo)); + } + catch (InvalidOperationException) + { + // Carry on without that previewer. + } + } + + UpdateColorTablePreview(); + } + + private void UnbindFromMaterialInstances() + { + foreach (var previewer in MaterialPreviewers) + previewer.Dispose(); + MaterialPreviewers.Clear(); + + foreach (var previewer in ColorTablePreviewers) + previewer.Dispose(); + ColorTablePreviewers.Clear(); + } + + private unsafe void UnbindFromDrawObjectMaterialInstances(CharacterBase* characterBase) + { + for (var i = MaterialPreviewers.Count; i-- > 0;) + { + var previewer = MaterialPreviewers[i]; + if (previewer.DrawObject != characterBase) + continue; + + previewer.Dispose(); + MaterialPreviewers.RemoveAt(i); + } + + for (var i = ColorTablePreviewers.Count; i-- > 0;) + { + var previewer = ColorTablePreviewers[i]; + if (previewer.DrawObject != characterBase) + continue; + + previewer.Dispose(); + ColorTablePreviewers.RemoveAt(i); + } + } + + public void SetShaderPackageFlags(uint shPkFlags) + { + foreach (var previewer in MaterialPreviewers) + previewer.SetShaderPackageFlags(shPkFlags); + } + + public void SetMaterialParameter(uint parameterCrc, Index offset, Span value) + { + foreach (var previewer in MaterialPreviewers) + previewer.SetMaterialParameter(parameterCrc, offset, value); + } + + public void SetSamplerFlags(uint samplerCrc, uint samplerFlags) + { + foreach (var previewer in MaterialPreviewers) + previewer.SetSamplerFlags(samplerCrc, samplerFlags); + } + + private void UpdateMaterialPreview() + { + SetShaderPackageFlags(Mtrl.ShaderPackage.Flags); + foreach (var constant in Mtrl.ShaderPackage.Constants) + { + var values = Mtrl.GetConstantValues(constant); + if (values != null) + SetMaterialParameter(constant.Id, 0, values); + } + + foreach (var sampler in Mtrl.ShaderPackage.Samplers) + SetSamplerFlags(sampler.SamplerId, sampler.Flags); + } + + public void HighlightColorTableRow(int rowIdx) + { + var oldRowIdx = HighlightedColorTableRow; + + if (HighlightedColorTableRow != rowIdx) + { + HighlightedColorTableRow = rowIdx; + HighlightTime.Restart(); + } + + if (oldRowIdx >= 0) + UpdateColorTableRowPreview(oldRowIdx); + if (rowIdx >= 0) + UpdateColorTableRowPreview(rowIdx); + } + + public void CancelColorTableHighlight() + { + var rowIdx = HighlightedColorTableRow; + + HighlightedColorTableRow = -1; + HighlightTime.Reset(); + + if (rowIdx >= 0) + UpdateColorTableRowPreview(rowIdx); + } + + public void UpdateColorTableRowPreview(int rowIdx) + { + if (ColorTablePreviewers.Count == 0) + return; + + if (!Mtrl.HasTable) + return; + + var row = new LegacyColorTable.Row(Mtrl.Table[rowIdx]); + if (Mtrl.HasDyeTable) + { + var stm = _edit._stainService.StmFile; + var dye = new LegacyColorDyeTable.Row(Mtrl.DyeTable[rowIdx]); + if (stm.TryGetValue(dye.Template, _edit._stainService.StainCombo.CurrentSelection.Key, out var dyes)) + row.ApplyDyeTemplate(dye, dyes); + } + + if (HighlightedColorTableRow == rowIdx) + ApplyHighlight(ref row, (float)HighlightTime.Elapsed.TotalSeconds); + + foreach (var previewer in ColorTablePreviewers) + { + row.AsHalves().CopyTo(previewer.ColorTable.AsSpan() + .Slice(LiveColorTablePreviewer.TextureWidth * 4 * rowIdx, LiveColorTablePreviewer.TextureWidth * 4)); + previewer.ScheduleUpdate(); + } + } + + public void UpdateColorTablePreview() + { + if (ColorTablePreviewers.Count == 0) + return; + + if (!Mtrl.HasTable) + return; + + var rows = new LegacyColorTable(Mtrl.Table); + var dyeRows = new LegacyColorDyeTable(Mtrl.DyeTable); + if (Mtrl.HasDyeTable) + { + var stm = _edit._stainService.StmFile; + var stainId = (StainId)_edit._stainService.StainCombo.CurrentSelection.Key; + for (var i = 0; i < LegacyColorTable.NumUsedRows; ++i) + { + ref var row = ref rows[i]; + var dye = dyeRows[i]; + if (stm.TryGetValue(dye.Template, stainId, out var dyes)) + row.ApplyDyeTemplate(dye, dyes); + } + } + + if (HighlightedColorTableRow >= 0) + ApplyHighlight(ref rows[HighlightedColorTableRow], (float)HighlightTime.Elapsed.TotalSeconds); + + foreach (var previewer in ColorTablePreviewers) + { + // TODO: Dawntrail + rows.AsHalves().CopyTo(previewer.ColorTable); + previewer.ScheduleUpdate(); + } + } + + private static void ApplyHighlight(ref LegacyColorTable.Row row, float time) + { + var level = (MathF.Sin(time * 2.0f * MathF.PI) + 2.0f) / 3.0f / 255.0f; + var baseColor = ColorId.InGameHighlight.Value(); + var color = level * new Vector3(baseColor & 0xFF, (baseColor >> 8) & 0xFF, (baseColor >> 16) & 0xFF); + + row.Diffuse = Vector3.Zero; + row.Specular = Vector3.Zero; + row.Emissive = color * color; + } + + public void Update() + { + UpdateShaders(); + UpdateTextures(); + UpdateConstants(); + } + + public unsafe MtrlTab(ModEditWindow edit, MtrlFile file, string filePath, bool writable) + { + _edit = edit; + Mtrl = file; + FilePath = filePath; + Writable = writable; + AssociatedBaseDevkit = TryLoadShpkDevkit("_base", out LoadedBaseDevkitPathName); + LoadShpk(FindAssociatedShpk(out _, out _)); + if (writable) + { + _edit._characterBaseDestructor.Subscribe(UnbindFromDrawObjectMaterialInstances, CharacterBaseDestructor.Priority.MtrlTab); + BindToMaterialInstances(); + } + } + + public unsafe void Dispose() + { + UnbindFromMaterialInstances(); + if (Writable) + _edit._characterBaseDestructor.Unsubscribe(UnbindFromDrawObjectMaterialInstances); + } + + public bool Valid + => ShadersKnown && Mtrl.Valid; + + public byte[] Write() + { + var output = Mtrl.Clone(); + output.GarbageCollect(AssociatedShpk, SamplerIds); + + return output.Write(); + } + + private sealed class DevkitShaderKeyValue + { + public string Label = string.Empty; + public string Description = string.Empty; + } + + private sealed class DevkitShaderKey + { + public string Label = string.Empty; + public string Description = string.Empty; + public Dictionary Values = new(); + } + + private sealed class DevkitSampler + { + public string Label = string.Empty; + public string Description = string.Empty; + public string DefaultTexture = string.Empty; + } + + private enum DevkitConstantType + { + Hidden = -1, + Float = 0, + Integer = 1, + Color = 2, + Enum = 3, + } + + private sealed class DevkitConstantValue + { + public string Label = string.Empty; + public string Description = string.Empty; + public float Value = 0; + } + + private sealed class DevkitConstant + { + public uint Offset = 0; + public uint? Length = null; + public string Group = string.Empty; + public string Label = string.Empty; + public string Description = string.Empty; + public DevkitConstantType Type = DevkitConstantType.Float; + + public float? Minimum = null; + public float? Maximum = null; + public float? Speed = null; + public float RelativeSpeed = 0.0f; + public float Factor = 1.0f; + public float Bias = 0.0f; + public byte Precision = 3; + public string Unit = string.Empty; + + public bool SquaredRgb = false; + public bool Clamped = false; + + public DevkitConstantValue[] Values = Array.Empty(); + + public IConstantEditor? CreateEditor() + => Type switch + { + DevkitConstantType.Hidden => null, + DevkitConstantType.Float => new FloatConstantEditor(Minimum, Maximum, Speed ?? 0.1f, RelativeSpeed, Factor, Bias, Precision, + Unit), + DevkitConstantType.Integer => new IntConstantEditor(ToInteger(Minimum), ToInteger(Maximum), Speed ?? 0.25f, RelativeSpeed, + Factor, Bias, Unit), + DevkitConstantType.Color => new ColorConstantEditor(SquaredRgb, Clamped), + DevkitConstantType.Enum => new EnumConstantEditor(Array.ConvertAll(Values, + value => (value.Label, value.Value, value.Description))), + _ => FloatConstantEditor.Default, + }; + + private static int? ToInteger(float? value) + => value.HasValue ? (int)Math.Clamp(MathF.Round(value.Value), int.MinValue, int.MaxValue) : null; + } + } +} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.Shpk.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.Shpk.cs new file mode 100644 index 00000000..3ce10224 --- /dev/null +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.Shpk.cs @@ -0,0 +1,481 @@ +using Dalamud.Interface; +using ImGuiNET; +using OtterGui; +using OtterGui.Raii; +using Penumbra.GameData; +using Penumbra.String.Classes; + +namespace Penumbra.UI.AdvancedWindow; + +public partial class ModEditWindow +{ + private readonly FileDialogService _fileDialog; + + // strings path/to/the.exe | grep --fixed-strings '.shpk' | sort -u | sed -e 's#^shader/sm5/shpk/##' + // Apricot shader packages are unlisted because + // 1. they cause performance/memory issues when calculating the effective shader set + // 2. they probably aren't intended for use with materials anyway + private static readonly IReadOnlyList StandardShaderPackages = new[] + { + "3dui.shpk", + // "apricot_decal_dummy.shpk", + // "apricot_decal_ring.shpk", + // "apricot_decal.shpk", + // "apricot_lightmodel.shpk", + // "apricot_model_dummy.shpk", + // "apricot_model_morph.shpk", + // "apricot_model.shpk", + // "apricot_powder_dummy.shpk", + // "apricot_powder.shpk", + // "apricot_shape_dummy.shpk", + // "apricot_shape.shpk", + "bgcolorchange.shpk", + "bgcrestchange.shpk", + "bgdecal.shpk", + "bg.shpk", + "bguvscroll.shpk", + "channeling.shpk", + "characterglass.shpk", + "charactershadowoffset.shpk", + "character.shpk", + "cloud.shpk", + "createviewposition.shpk", + "crystal.shpk", + "directionallighting.shpk", + "directionalshadow.shpk", + "grass.shpk", + "hair.shpk", + "iris.shpk", + "lightshaft.shpk", + "linelighting.shpk", + "planelighting.shpk", + "pointlighting.shpk", + "river.shpk", + "shadowmask.shpk", + "skin.shpk", + "spotlighting.shpk", + "verticalfog.shpk", + "water.shpk", + "weather.shpk", + }; + + private enum TextureAddressMode : uint + { + Wrap = 0, + Mirror = 1, + Clamp = 2, + Border = 3, + } + + private static readonly IReadOnlyList TextureAddressModeTooltips = new[] + { + "Tile the texture at every UV integer junction.\n\nFor example, for U values between 0 and 3, the texture is repeated three times.", + "Flip the texture at every UV integer junction.\n\nFor U values between 0 and 1, for example, the texture is addressed normally; between 1 and 2, the texture is mirrored; between 2 and 3, the texture is normal again; and so on.", + "Texture coordinates outside the range [0.0, 1.0] are set to the texture color at 0.0 or 1.0, respectively.", + "Texture coordinates outside the range [0.0, 1.0] are set to the border color (generally black).", + }; + + private static bool DrawPackageNameInput(MtrlTab tab, bool disabled) + { + if (disabled) + { + ImGui.TextUnformatted("Shader Package: " + tab.Mtrl.ShaderPackage.Name); + return false; + } + + var ret = false; + ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); + using var c = ImRaii.Combo("Shader Package", tab.Mtrl.ShaderPackage.Name); + if (c) + foreach (var value in tab.GetShpkNames()) + { + if (ImGui.Selectable(value, value == tab.Mtrl.ShaderPackage.Name)) + { + tab.Mtrl.ShaderPackage.Name = value; + ret = true; + tab.AssociatedShpk = null; + tab.LoadedShpkPath = FullPath.Empty; + tab.LoadShpk(tab.FindAssociatedShpk(out _, out _)); + } + } + + return ret; + } + + private static bool DrawShaderFlagsInput(MtrlTab tab, bool disabled) + { + var shpkFlags = (int)tab.Mtrl.ShaderPackage.Flags; + ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); + if (!ImGui.InputInt("Shader Flags", ref shpkFlags, 0, 0, + ImGuiInputTextFlags.CharsHexadecimal | (disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None))) + return false; + + tab.Mtrl.ShaderPackage.Flags = (uint)shpkFlags; + tab.SetShaderPackageFlags((uint)shpkFlags); + return true; + } + + /// + /// Show the currently associated shpk file, if any, and the buttons to associate + /// a specific shpk from your drive, the modded shpk by path or the default shpk. + /// + private void DrawCustomAssociations(MtrlTab tab) + { + const string tooltip = "Click to copy file path to clipboard."; + var text = tab.AssociatedShpk == null + ? "Associated .shpk file: None" + : $"Associated .shpk file: {tab.LoadedShpkPathName}"; + var devkitText = tab.AssociatedShpkDevkit == null + ? "Associated dev-kit file: None" + : $"Associated dev-kit file: {tab.LoadedShpkDevkitPathName}"; + var baseDevkitText = tab.AssociatedBaseDevkit == null + ? "Base dev-kit file: None" + : $"Base dev-kit file: {tab.LoadedBaseDevkitPathName}"; + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + + ImGuiUtil.CopyOnClickSelectable(text, tab.LoadedShpkPathName, tooltip); + ImGuiUtil.CopyOnClickSelectable(devkitText, tab.LoadedShpkDevkitPathName, tooltip); + ImGuiUtil.CopyOnClickSelectable(baseDevkitText, tab.LoadedBaseDevkitPathName, tooltip); + + if (ImGui.Button("Associate Custom .shpk File")) + _fileDialog.OpenFilePicker("Associate Custom .shpk File...", ".shpk", (success, name) => + { + if (success) + tab.LoadShpk(new FullPath(name[0])); + }, 1, Mod!.ModPath.FullName, false); + + var moddedPath = tab.FindAssociatedShpk(out var defaultPath, out var gamePath); + ImGui.SameLine(); + if (ImGuiUtil.DrawDisabledButton("Associate Default .shpk File", Vector2.Zero, moddedPath.ToPath(), + moddedPath.Equals(tab.LoadedShpkPath))) + tab.LoadShpk(moddedPath); + + if (!gamePath.Path.Equals(moddedPath.InternalName)) + { + ImGui.SameLine(); + if (ImGuiUtil.DrawDisabledButton("Associate Unmodded .shpk File", Vector2.Zero, defaultPath, + gamePath.Path.Equals(tab.LoadedShpkPath.InternalName))) + tab.LoadShpk(new FullPath(gamePath)); + } + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + } + + private static bool DrawMaterialShaderKeys(MtrlTab tab, bool disabled) + { + if (tab.ShaderKeys.Count == 0) + return false; + + var ret = false; + foreach (var (label, index, description, monoFont, values) in tab.ShaderKeys) + { + using var font = ImRaii.PushFont(UiBuilder.MonoFont, monoFont); + ref var key = ref tab.Mtrl.ShaderPackage.ShaderKeys[index]; + var shpkKey = tab.AssociatedShpk?.GetMaterialKeyById(key.Category); + var currentValue = key.Value; + var (currentLabel, _, currentDescription) = + values.FirstOrNull(v => v.Value == currentValue) ?? ($"0x{currentValue:X8}", currentValue, string.Empty); + if (!disabled && shpkKey.HasValue) + { + ImGui.SetNextItemWidth(UiHelpers.Scale * 250.0f); + using (var c = ImRaii.Combo($"##{key.Category:X8}", currentLabel)) + { + if (c) + foreach (var (valueLabel, value, valueDescription) in values) + { + if (ImGui.Selectable(valueLabel, value == currentValue)) + { + key.Value = value; + ret = true; + tab.Update(); + } + + if (valueDescription.Length > 0) + ImGuiUtil.SelectableHelpMarker(valueDescription); + } + } + + ImGui.SameLine(); + if (description.Length > 0) + ImGuiUtil.LabeledHelpMarker(label, description); + else + ImGui.TextUnformatted(label); + } + else if (description.Length > 0 || currentDescription.Length > 0) + { + ImGuiUtil.LabeledHelpMarker($"{label}: {currentLabel}", + description + (description.Length > 0 && currentDescription.Length > 0 ? "\n\n" : string.Empty) + currentDescription); + } + else + { + ImGui.TextUnformatted($"{label}: {currentLabel}"); + } + } + + return ret; + } + + private static void DrawMaterialShaders(MtrlTab tab) + { + if (tab.AssociatedShpk == null) + return; + + ImRaii.TreeNode(tab.VertexShadersString, ImGuiTreeNodeFlags.Leaf).Dispose(); + ImRaii.TreeNode(tab.PixelShadersString, ImGuiTreeNodeFlags.Leaf).Dispose(); + + if (tab.ShaderComment.Length > 0) + { + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + ImGui.TextUnformatted(tab.ShaderComment); + } + } + + private static bool DrawMaterialConstants(MtrlTab tab, bool disabled) + { + if (tab.Constants.Count == 0) + return false; + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + if (!ImGui.CollapsingHeader("Material Constants")) + return false; + + using var _ = ImRaii.PushId("MaterialConstants"); + + var ret = false; + foreach (var (header, group) in tab.Constants) + { + using var t = ImRaii.TreeNode(header, ImGuiTreeNodeFlags.DefaultOpen); + if (!t) + continue; + + foreach (var (label, constantIndex, slice, description, monoFont, editor) in group) + { + var constant = tab.Mtrl.ShaderPackage.Constants[constantIndex]; + var buffer = tab.Mtrl.GetConstantValues(constant); + if (buffer.Length > 0) + { + using var id = ImRaii.PushId($"##{constant.Id:X8}:{slice.Start}"); + ImGui.SetNextItemWidth(250.0f); + if (editor.Draw(buffer[slice], disabled)) + { + ret = true; + tab.SetMaterialParameter(constant.Id, slice.Start, buffer[slice]); + } + + ImGui.SameLine(); + using var font = ImRaii.PushFont(UiBuilder.MonoFont, monoFont); + if (description.Length > 0) + ImGuiUtil.LabeledHelpMarker(label, description); + else + ImGui.TextUnformatted(label); + } + } + } + + return ret; + } + + private static bool DrawMaterialSampler(MtrlTab tab, bool disabled, int textureIdx, int samplerIdx) + { + var ret = false; + ref var texture = ref tab.Mtrl.Textures[textureIdx]; + ref var sampler = ref tab.Mtrl.ShaderPackage.Samplers[samplerIdx]; + + // FIXME this probably doesn't belong here + static unsafe bool InputHexUInt16(string label, ref ushort v, ImGuiInputTextFlags flags) + { + fixed (ushort* v2 = &v) + { + return ImGui.InputScalar(label, ImGuiDataType.U16, (nint)v2, IntPtr.Zero, IntPtr.Zero, "%04X", flags); + } + } + + static bool ComboTextureAddressMode(string label, ref uint samplerFlags, int bitOffset) + { + var current = (TextureAddressMode)((samplerFlags >> bitOffset) & 0x3u); + using var c = ImRaii.Combo(label, current.ToString()); + if (!c) + return false; + + var ret = false; + foreach (var value in Enum.GetValues()) + { + if (ImGui.Selectable(value.ToString(), value == current)) + { + samplerFlags = (samplerFlags & ~(0x3u << bitOffset)) | ((uint)value << bitOffset); + ret = true; + } + + ImGuiUtil.SelectableHelpMarker(TextureAddressModeTooltips[(int)value]); + } + + return ret; + } + + var dx11 = texture.DX11; + if (ImGui.Checkbox("Prepend -- to the file name on DirectX 11", ref dx11)) + { + texture.DX11 = dx11; + ret = true; + } + + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (ComboTextureAddressMode("##UAddressMode", ref sampler.Flags, 2)) + { + ret = true; + tab.SetSamplerFlags(sampler.SamplerId, sampler.Flags); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("U Address Mode", "Method to use for resolving a U texture coordinate that is outside the 0 to 1 range."); + + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (ComboTextureAddressMode("##VAddressMode", ref sampler.Flags, 0)) + { + ret = true; + tab.SetSamplerFlags(sampler.SamplerId, sampler.Flags); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("V Address Mode", "Method to use for resolving a V texture coordinate that is outside the 0 to 1 range."); + + var lodBias = ((int)(sampler.Flags << 12) >> 22) / 64.0f; + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (ImGui.DragFloat("##LoDBias", ref lodBias, 0.1f, -8.0f, 7.984375f)) + { + sampler.Flags = (uint)((sampler.Flags & ~0x000FFC00) + | ((uint)((int)Math.Round(Math.Clamp(lodBias, -8.0f, 7.984375f) * 64.0f) & 0x3FF) << 10)); + ret = true; + tab.SetSamplerFlags(sampler.SamplerId, sampler.Flags); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("Level of Detail Bias", + "Offset from the calculated mipmap level.\n\nHigher means that the texture will start to lose detail nearer.\nLower means that the texture will keep its detail until farther."); + + var minLod = (int)((sampler.Flags >> 20) & 0xF); + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (ImGui.DragInt("##MinLoD", ref minLod, 0.1f, 0, 15)) + { + sampler.Flags = (uint)((sampler.Flags & ~0x00F00000) | ((uint)Math.Clamp(minLod, 0, 15) << 20)); + ret = true; + tab.SetSamplerFlags(sampler.SamplerId, sampler.Flags); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("Minimum Level of Detail", + "Most detailed mipmap level to use.\n\n0 is the full-sized texture, 1 is the half-sized texture, 2 is the quarter-sized texture, and so on.\n15 will forcibly reduce the texture to its smallest mipmap."); + + using var t = ImRaii.TreeNode("Advanced Settings"); + if (!t) + return ret; + + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (InputHexUInt16("Texture Flags", ref texture.Flags, + disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None)) + ret = true; + + var samplerFlags = (int)sampler.Flags; + ImGui.SetNextItemWidth(UiHelpers.Scale * 100.0f); + if (ImGui.InputInt("Sampler Flags", ref samplerFlags, 0, 0, + ImGuiInputTextFlags.CharsHexadecimal | (disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None))) + { + sampler.Flags = (uint)samplerFlags; + ret = true; + tab.SetSamplerFlags(sampler.SamplerId, (uint)samplerFlags); + } + + return ret; + } + + private bool DrawMaterialShader(MtrlTab tab, bool disabled) + { + var ret = false; + if (ImGui.CollapsingHeader(tab.ShaderHeader)) + { + ret |= DrawPackageNameInput(tab, disabled); + ret |= DrawShaderFlagsInput(tab, disabled); + DrawCustomAssociations(tab); + ret |= DrawMaterialShaderKeys(tab, disabled); + DrawMaterialShaders(tab); + } + + if (tab.AssociatedShpkDevkit == null) + { + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + GC.KeepAlive(tab); + + var textColor = ImGui.GetColorU32(ImGuiCol.Text); + var textColorWarning = + (textColor & 0xFF000000u) + | ((textColor & 0x00FEFEFE) >> 1) + | (tab.AssociatedShpk == null ? 0x80u : 0x8080u); // Half red or yellow + + using var c = ImRaii.PushColor(ImGuiCol.Text, textColorWarning); + + ImGui.TextUnformatted(tab.AssociatedShpk == null + ? "Unable to find a suitable .shpk file for cross-references. Some functionality will be missing." + : "No dev-kit file found for this material's shaders. Please install one for optimal editing experience, such as actual constant names instead of hexadecimal identifiers."); + } + + return ret; + } + + private static string? MaterialParamName(bool componentOnly, int offset) + { + if (offset < 0) + return null; + + return (componentOnly, offset & 0x3) switch + { + (true, 0) => "x", + (true, 1) => "y", + (true, 2) => "z", + (true, 3) => "w", + (false, 0) => $"[{offset >> 2:D2}].x", + (false, 1) => $"[{offset >> 2:D2}].y", + (false, 2) => $"[{offset >> 2:D2}].z", + (false, 3) => $"[{offset >> 2:D2}].w", + _ => null, + }; + } + + private static string VectorSwizzle(int firstComponent, int lastComponent) + => (firstComponent, lastComponent) switch + { + (0, 4) => " ", + (0, 0) => ".x ", + (0, 1) => ".xy ", + (0, 2) => ".xyz ", + (0, 3) => " ", + (1, 1) => ".y ", + (1, 2) => ".yz ", + (1, 3) => ".yzw ", + (2, 2) => ".z ", + (2, 3) => ".zw ", + (3, 3) => ".w ", + _ => string.Empty, + }; + + private static (string? Name, bool ComponentOnly) MaterialParamRangeName(string prefix, int valueOffset, int valueLength) + { + if (valueLength == 0 || valueOffset < 0) + return (null, false); + + var firstVector = valueOffset >> 2; + var lastVector = (valueOffset + valueLength - 1) >> 2; + var firstComponent = valueOffset & 0x3; + var lastComponent = (valueOffset + valueLength - 1) & 0x3; + if (firstVector == lastVector) + return ($"{prefix}[{firstVector}]{VectorSwizzle(firstComponent, lastComponent)}", true); + + var sb = new StringBuilder(128); + sb.Append($"{prefix}[{firstVector}]{VectorSwizzle(firstComponent, 3).TrimEnd()}"); + for (var i = firstVector + 1; i < lastVector; ++i) + sb.Append($", [{i}]"); + + sb.Append($", [{lastVector}]{VectorSwizzle(0, lastComponent)}"); + return (sb.ToString(), false); + } +} diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.cs index 3caff226..68b3717f 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Materials.cs @@ -1,10 +1,12 @@ using Dalamud.Interface; using Dalamud.Interface.Utility; -using Dalamud.Bindings.ImGui; -using OtterGui.Extensions; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.UI.AdvancedWindow.Materials; +using OtterGui.Widgets; +using Penumbra.GameData.Files; +using Penumbra.String.Classes; +using Penumbra.UI.Classes; namespace Penumbra.UI.AdvancedWindow; @@ -14,10 +16,162 @@ public partial class ModEditWindow private bool DrawMaterialPanel(MtrlTab tab, bool disabled) { - if (tab.DrawVersionUpdate(disabled)) - _materialTab.SaveFile(); + DrawMaterialLivePreviewRebind(tab, disabled); - return tab.DrawPanel(disabled); + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + var ret = DrawBackFaceAndTransparency(tab, disabled); + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + ret |= DrawMaterialShader(tab, disabled); + + ret |= DrawMaterialTextureChange(tab, disabled); + ret |= DrawMaterialColorTableChange(tab, disabled); + ret |= DrawMaterialConstants(tab, disabled); + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + DrawOtherMaterialDetails(tab.Mtrl, disabled); + + return !disabled && ret; + } + + private static void DrawMaterialLivePreviewRebind(MtrlTab tab, bool disabled) + { + if (disabled) + return; + + if (ImGui.Button("Reload live preview")) + tab.BindToMaterialInstances(); + + if (tab.MaterialPreviewers.Count != 0 || tab.ColorTablePreviewers.Count != 0) + return; + + ImGui.SameLine(); + using var c = ImRaii.PushColor(ImGuiCol.Text, Colors.RegexWarningBorder); + ImGui.TextUnformatted( + "The current material has not been found on your character. Please check the Import from Screen tab for more information."); + } + + private static bool DrawMaterialTextureChange(MtrlTab tab, bool disabled) + { + if (tab.Textures.Count == 0) + return false; + + ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); + if (!ImGui.CollapsingHeader("Textures and Samplers", ImGuiTreeNodeFlags.DefaultOpen)) + return false; + + var frameHeight = ImGui.GetFrameHeight(); + var ret = false; + using var table = ImRaii.Table("##Textures", 3); + + ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, frameHeight); + ImGui.TableSetupColumn("Path", ImGuiTableColumnFlags.WidthStretch); + ImGui.TableSetupColumn("Name", ImGuiTableColumnFlags.WidthFixed, tab.TextureLabelWidth * UiHelpers.Scale); + foreach (var (label, textureI, samplerI, description, monoFont) in tab.Textures) + { + using var _ = ImRaii.PushId(samplerI); + var tmp = tab.Mtrl.Textures[textureI].Path; + var unfolded = tab.UnfoldedTextures.Contains(samplerI); + ImGui.TableNextColumn(); + if (ImGuiUtil.DrawDisabledButton((unfolded ? FontAwesomeIcon.CaretDown : FontAwesomeIcon.CaretRight).ToIconString(), + new Vector2(frameHeight), + "Settings for this texture and the associated sampler", false, true)) + { + unfolded = !unfolded; + if (unfolded) + tab.UnfoldedTextures.Add(samplerI); + else + tab.UnfoldedTextures.Remove(samplerI); + } + + ImGui.TableNextColumn(); + ImGui.SetNextItemWidth(ImGui.GetContentRegionAvail().X); + if (ImGui.InputText(string.Empty, ref tmp, Utf8GamePath.MaxGamePathLength, + disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None) + && tmp.Length > 0 + && tmp != tab.Mtrl.Textures[textureI].Path) + { + ret = true; + tab.Mtrl.Textures[textureI].Path = tmp; + } + + ImGui.TableNextColumn(); + using (var font = ImRaii.PushFont(UiBuilder.MonoFont, monoFont)) + { + ImGui.AlignTextToFramePadding(); + if (description.Length > 0) + ImGuiUtil.LabeledHelpMarker(label, description); + else + ImGui.TextUnformatted(label); + } + + if (unfolded) + { + ImGui.TableNextColumn(); + ImGui.TableNextColumn(); + ret |= DrawMaterialSampler(tab, disabled, textureI, samplerI); + ImGui.TableNextColumn(); + } + } + + return ret; + } + + private static bool DrawBackFaceAndTransparency(MtrlTab tab, bool disabled) + { + const uint transparencyBit = 0x10; + const uint backfaceBit = 0x01; + + var ret = false; + + using var dis = ImRaii.Disabled(disabled); + + var tmp = (tab.Mtrl.ShaderPackage.Flags & transparencyBit) != 0; + if (ImGui.Checkbox("Enable Transparency", ref tmp)) + { + tab.Mtrl.ShaderPackage.Flags = + tmp ? tab.Mtrl.ShaderPackage.Flags | transparencyBit : tab.Mtrl.ShaderPackage.Flags & ~transparencyBit; + ret = true; + tab.SetShaderPackageFlags(tab.Mtrl.ShaderPackage.Flags); + } + + ImGui.SameLine(200 * UiHelpers.Scale + ImGui.GetStyle().ItemSpacing.X + ImGui.GetStyle().WindowPadding.X); + tmp = (tab.Mtrl.ShaderPackage.Flags & backfaceBit) != 0; + if (ImGui.Checkbox("Hide Backfaces", ref tmp)) + { + tab.Mtrl.ShaderPackage.Flags = tmp ? tab.Mtrl.ShaderPackage.Flags | backfaceBit : tab.Mtrl.ShaderPackage.Flags & ~backfaceBit; + ret = true; + tab.SetShaderPackageFlags(tab.Mtrl.ShaderPackage.Flags); + } + + return ret; + } + + private static void DrawOtherMaterialDetails(MtrlFile file, bool _) + { + if (!ImGui.CollapsingHeader("Further Content")) + return; + + using (var sets = ImRaii.TreeNode("UV Sets", ImGuiTreeNodeFlags.DefaultOpen)) + { + if (sets) + foreach (var set in file.UvSets) + ImRaii.TreeNode($"#{set.Index:D2} - {set.Name}", ImGuiTreeNodeFlags.Leaf).Dispose(); + } + + using (var sets = ImRaii.TreeNode("Color Sets", ImGuiTreeNodeFlags.DefaultOpen)) + { + if (sets) + foreach (var set in file.ColorSets) + ImRaii.TreeNode($"#{set.Index:D2} - {set.Name}", ImGuiTreeNodeFlags.Leaf).Dispose(); + } + + if (file.AdditionalData.Length <= 0) + return; + + using var t = ImRaii.TreeNode($"Additional Data (Size: {file.AdditionalData.Length})###AdditionalData"); + if (t) + Widget.DrawHexViewer(file.AdditionalData); } private void DrawMaterialReassignmentTab() @@ -25,7 +179,7 @@ public partial class ModEditWindow if (_editor.Files.Mdl.Count == 0) return; - using var tab = ImUtf8.TabItem("Material Reassignment"u8); + using var tab = ImRaii.TabItem("Material Reassignment"); if (!tab) return; @@ -33,43 +187,45 @@ public partial class ModEditWindow MaterialSuffix.Draw(_editor, ImGuiHelpers.ScaledVector2(175, 0)); ImGui.NewLine(); - using var child = ImUtf8.Child("##mdlFiles"u8, -Vector2.One, true); + using var child = ImRaii.Child("##mdlFiles", -Vector2.One, true); if (!child) return; - using var table = ImUtf8.Table("##files"u8, 4, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, -Vector2.One); + using var table = ImRaii.Table("##files", 4, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, -Vector2.One); if (!table) return; + var iconSize = ImGui.GetFrameHeight() * Vector2.One; foreach (var (info, idx) in _editor.MdlMaterialEditor.ModelFiles.WithIndex()) { using var id = ImRaii.PushId(idx); ImGui.TableNextColumn(); - if (ImUtf8.IconButton(FontAwesomeIcon.Save, "Save the changed mdl file.\nUse at own risk!"u8, disabled: !info.Changed)) + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Save.ToIconString(), iconSize, + "Save the changed mdl file.\nUse at own risk!", !info.Changed, true)) info.Save(_editor.Compactor); ImGui.TableNextColumn(); - if (ImUtf8.IconButton(FontAwesomeIcon.Recycle, "Restore current changes to default."u8, disabled: !info.Changed)) + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Recycle.ToIconString(), iconSize, + "Restore current changes to default.", !info.Changed, true)) info.Restore(); ImGui.TableNextColumn(); - ImUtf8.Text(info.Path.InternalName.Span[(Mod!.ModPath.FullName.Length + 1)..]); + ImGui.TextUnformatted(info.Path.FullName[(Mod!.ModPath.FullName.Length + 1)..]); ImGui.TableNextColumn(); ImGui.SetNextItemWidth(400 * UiHelpers.Scale); var tmp = info.CurrentMaterials[0]; - if (ImUtf8.InputText("##0"u8, ref tmp)) + if (ImGui.InputText("##0", ref tmp, 64)) info.SetMaterial(tmp, 0); for (var i = 1; i < info.Count; ++i) { - using var id2 = ImUtf8.PushId(i); ImGui.TableNextColumn(); ImGui.TableNextColumn(); ImGui.TableNextColumn(); ImGui.TableNextColumn(); ImGui.SetNextItemWidth(400 * UiHelpers.Scale); tmp = info.CurrentMaterials[i]; - if (ImUtf8.InputText(""u8, ref tmp)) + if (ImGui.InputText($"##{i}", ref tmp, 64)) info.SetMaterial(tmp, i); } } diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Meta.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Meta.cs index 06cd0763..6f542377 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Meta.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Meta.cs @@ -1,38 +1,54 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Text; -using Penumbra.Api.Api; -using Penumbra.GameData.Data; using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Interop.Structs; +using Penumbra.Meta; +using Penumbra.Meta.Files; using Penumbra.Meta.Manipulations; -using Penumbra.UI.AdvancedWindow.Meta; +using Penumbra.Mods.Editor; using Penumbra.UI.Classes; +using Penumbra.UI.ModsTab; namespace Penumbra.UI.AdvancedWindow; public partial class ModEditWindow { - private readonly MetaDrawers _metaDrawers; + private const string ModelSetIdTooltip = + "Model Set ID - You can usually find this as the 'e####' part of an item path.\nThis should generally not be left <= 1 unless you explicitly want that."; + + private const string ModelSetIdTooltipShort = "Model Set ID"; + private const string EquipSlotTooltip = "Equip Slot"; + private const string ModelRaceTooltip = "Model Race"; + private const string GenderTooltip = "Gender"; + private const string ObjectTypeTooltip = "Object Type"; + private const string SecondaryIdTooltip = "Secondary ID"; + private const string PrimaryIdTooltipShort = "Primary ID"; + private const string VariantIdTooltip = "Variant ID"; + private const string EstTypeTooltip = "EST Type"; + private const string RacialTribeTooltip = "Racial Tribe"; + private const string ScalingTypeTooltip = "Scaling Type"; private void DrawMetaTab() { - using var tab = ImUtf8.TabItem("Meta Manipulations"u8); + using var tab = ImRaii.TabItem("Meta Manipulations"); if (!tab) return; DrawOptionSelectHeader(); var setsEqual = !_editor.MetaEditor.Changes; - var tt = setsEqual ? "No changes staged."u8 : "Apply the currently staged changes to the option."u8; + var tt = setsEqual ? "No changes staged." : "Apply the currently staged changes to the option."; ImGui.NewLine(); - if (ImUtf8.ButtonEx("Apply Changes"u8, tt, Vector2.Zero, setsEqual)) + if (ImGuiUtil.DrawDisabledButton("Apply Changes", Vector2.Zero, tt, setsEqual)) _editor.MetaEditor.Apply(_editor.Option!); ImGui.SameLine(); - tt = setsEqual ? "No changes staged."u8 : "Revert all currently staged changes."u8; - if (ImUtf8.ButtonEx("Revert Changes"u8, tt, Vector2.Zero, setsEqual)) + tt = setsEqual ? "No changes staged." : "Revert all currently staged changes."; + if (ImGuiUtil.DrawDisabledButton("Revert Changes", Vector2.Zero, tt, setsEqual)) _editor.MetaEditor.Load(_editor.Mod!, _editor.Option!); ImGui.SameLine(); @@ -40,159 +56,815 @@ public partial class ModEditWindow ImGui.SameLine(); SetFromClipboardButton(); ImGui.SameLine(); - CopyToClipboardButton("Copy all current manipulations to clipboard.", _iconSize, _editor.MetaEditor); + CopyToClipboardButton("Copy all current manipulations to clipboard.", _iconSize, _editor.MetaEditor.Recombine()); ImGui.SameLine(); - if (ImUtf8.Button("Write as TexTools Files"u8)) + if (ImGui.Button("Write as TexTools Files")) _metaFileManager.WriteAllTexToolsMeta(Mod!); - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Remove All Default-Values"u8, "Delete any entries from all lists that set the value to its default value."u8)) - _editor.MetaEditor.DeleteDefaultValues(); - ImGui.SameLine(); - DrawAtchDragDrop(); using var child = ImRaii.Child("##meta", -Vector2.One, true); if (!child) return; - DrawEditHeader(MetaManipulationType.Eqp); - DrawEditHeader(MetaManipulationType.Eqdp); - DrawEditHeader(MetaManipulationType.Imc); - DrawEditHeader(MetaManipulationType.Est); - DrawEditHeader(MetaManipulationType.Gmp); - DrawEditHeader(MetaManipulationType.Rsp); - DrawEditHeader(MetaManipulationType.Atch); - DrawEditHeader(MetaManipulationType.Shp); - DrawEditHeader(MetaManipulationType.Atr); - DrawEditHeader(MetaManipulationType.GlobalEqp); + DrawEditHeader(_editor.MetaEditor.Eqp, "Equipment Parameter Edits (EQP)###EQP", 5, EqpRow.Draw, EqpRow.DrawNew, + _editor.MetaEditor.OtherEqpCount); + DrawEditHeader(_editor.MetaEditor.Eqdp, "Racial Model Edits (EQDP)###EQDP", 7, EqdpRow.Draw, EqdpRow.DrawNew, + _editor.MetaEditor.OtherEqdpCount); + DrawEditHeader(_editor.MetaEditor.Imc, "Variant Edits (IMC)###IMC", 10, ImcRow.Draw, ImcRow.DrawNew, _editor.MetaEditor.OtherImcCount); + DrawEditHeader(_editor.MetaEditor.Est, "Extra Skeleton Parameters (EST)###EST", 7, EstRow.Draw, EstRow.DrawNew, + _editor.MetaEditor.OtherEstCount); + DrawEditHeader(_editor.MetaEditor.Gmp, "Visor/Gimmick Edits (GMP)###GMP", 7, GmpRow.Draw, GmpRow.DrawNew, + _editor.MetaEditor.OtherGmpCount); + DrawEditHeader(_editor.MetaEditor.Rsp, "Racial Scaling Edits (RSP)###RSP", 5, RspRow.Draw, RspRow.DrawNew, + _editor.MetaEditor.OtherRspCount); + DrawEditHeader(_editor.MetaEditor.GlobalEqp, "Global Equipment Parameter Edits (Global EQP)###GEQP", 4, GlobalEqpRow.Draw, + GlobalEqpRow.DrawNew, _editor.MetaEditor.OtherGlobalEqpCount); } - private void DrawAtchDragDrop() + + /// The headers for the different meta changes all have basically the same structure for different types. + private void DrawEditHeader(IReadOnlyCollection items, string label, int numColumns, + Action draw, + Action drawNew, int otherCount) { - _dragDropManager.CreateImGuiSource("atchDrag", f => f.Extensions.Contains(".atch"), f => - { - var gr = Parser.ParseRaceCode(f.Files.FirstOrDefault() ?? string.Empty); - if (gr is GenderRace.Unknown) - return false; - - ImUtf8.Text($"Dragging .atch for {gr.ToName()}..."); - return true; - }); - var hasAtch = _editor.Files.Atch.Count > 0; - if (ImUtf8.ButtonEx("Import .atch"u8, - _dragDropManager.IsDragging - ? ""u8 - : hasAtch - ? "Drag a .atch file containing its race code in the path here to import its values.\n\nClick to select an .atch file from the mod."u8 - : "Drag a .atch file containing its race code in the path here to import its values."u8, default, - !_dragDropManager.IsDragging && !hasAtch) - && hasAtch) - ImUtf8.OpenPopup("##atchPopup"u8); - if (_dragDropManager.CreateImGuiTarget("atchDrag", out var files, out _) && files.FirstOrDefault() is { } file) - _metaDrawers.Atch.ImportFile(file); - - using var popup = ImUtf8.Popup("##atchPopup"u8); - if (!popup) - return; - - if (!hasAtch) - { - ImGui.CloseCurrentPopup(); - return; - } - - foreach (var atchFile in _editor.Files.Atch) - { - if (ImUtf8.Selectable(atchFile.RelPath.Path.Span) && atchFile.File.Exists) - _metaDrawers.Atch.ImportFile(atchFile.File.FullName); - } - } - - private void DrawEditHeader(MetaManipulationType type) - { - var drawer = _metaDrawers.Get(type); - if (drawer == null) - return; + const ImGuiTableFlags flags = ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.BordersInnerV; var oldPos = ImGui.GetCursorPosY(); - var header = ImUtf8.CollapsingHeader($"{_editor.MetaEditor.GetCount(type)} {drawer.Label}"); - DrawOtherOptionData(type, oldPos, ImGui.GetCursorPos()); + var header = ImGui.CollapsingHeader($"{items.Count} {label}"); + var newPos = ImGui.GetCursorPos(); + if (otherCount > 0) + { + var text = $"{otherCount} Edits in other Options"; + var size = ImGui.CalcTextSize(text).X; + ImGui.SetCursorPos(new Vector2(ImGui.GetContentRegionAvail().X - size, oldPos + ImGui.GetStyle().FramePadding.Y)); + ImGuiUtil.TextColored(ColorId.RedundantAssignment.Value() | 0xFF000000, text); + ImGui.SetCursorPos(newPos); + } + if (!header) return; - DrawTable(drawer); - } + using (var table = ImRaii.Table(label, numColumns, flags)) + { + if (table) + { + drawNew(_metaFileManager, _editor, _iconSize); + foreach (var (item, index) in items.ToArray().WithIndex()) + { + using var id = ImRaii.PushId(index); + draw(_metaFileManager, item, _editor, _iconSize); + } + } + } - private static void DrawTable(IMetaDrawer drawer) - { - const ImGuiTableFlags flags = ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.BordersInnerV; - using var table = ImUtf8.Table(drawer.Label, drawer.NumColumns, flags); - if (!table) - return; - - drawer.Draw(); ImGui.NewLine(); } - private void DrawOtherOptionData(MetaManipulationType type, float oldPos, Vector2 newPos) + private static class EqpRow { - var otherOptionData = _editor.MetaEditor.OtherData[type]; - if (otherOptionData.TotalCount <= 0) - return; + private static EqpManipulation _new = new(Eqp.DefaultEntry, EquipSlot.Head, 1); - var text = $"{otherOptionData.TotalCount} Edits in other Options"; - var size = ImGui.CalcTextSize(text).X; - ImGui.SetCursorPos(new Vector2(ImGui.GetContentRegionAvail().X - size, oldPos + ImGui.GetStyle().FramePadding.Y)); - ImGuiUtil.TextColored(ColorId.RedundantAssignment.Value() | 0xFF000000, text); - if (ImGui.IsItemHovered()) + private static float IdWidth + => 100 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) { - using var tt = ImUtf8.Tooltip(); - foreach (var name in otherOptionData) - ImUtf8.Text(name); + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current EQP manipulations to clipboard.", iconSize, + editor.MetaEditor.Eqp.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var canAdd = editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : "This entry is already edited."; + var defaultEntry = ExpandedEqpFile.GetDefault(metaFileManager, _new.SetId); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new.Copy(defaultEntry)); + + // Identifier + ImGui.TableNextColumn(); + if (IdInput("##eqpId", IdWidth, _new.SetId.Id, out var setId, 1, ExpandedEqpGmpBase.Count - 1, _new.SetId <= 1)) + _new = new EqpManipulation(ExpandedEqpFile.GetDefault(metaFileManager, setId), _new.Slot, setId); + + ImGuiUtil.HoverTooltip(ModelSetIdTooltip); + + ImGui.TableNextColumn(); + if (Combos.EqpEquipSlot("##eqpSlot", _new.Slot, out var slot)) + _new = new EqpManipulation(ExpandedEqpFile.GetDefault(metaFileManager, setId), slot, _new.SetId); + + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, + new Vector2(3 * UiHelpers.Scale, ImGui.GetStyle().ItemSpacing.Y)); + foreach (var flag in Eqp.EqpAttributes[_new.Slot]) + { + var value = defaultEntry.HasFlag(flag); + Checkmark("##eqp", flag.ToLocalName(), value, value, out _); + ImGui.SameLine(); + } + + ImGui.NewLine(); } - ImGui.SetCursorPos(newPos); + public static void Draw(MetaFileManager metaFileManager, EqpManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.SetId.ToString()); + ImGuiUtil.HoverTooltip(ModelSetIdTooltipShort); + var defaultEntry = ExpandedEqpFile.GetDefault(metaFileManager, meta.SetId); + + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Slot.ToName()); + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + + // Values + ImGui.TableNextColumn(); + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, + new Vector2(3 * UiHelpers.Scale, ImGui.GetStyle().ItemSpacing.Y)); + var idx = 0; + foreach (var flag in Eqp.EqpAttributes[meta.Slot]) + { + using var id = ImRaii.PushId(idx++); + var defaultValue = defaultEntry.HasFlag(flag); + var currentValue = meta.Entry.HasFlag(flag); + if (Checkmark("##eqp", flag.ToLocalName(), currentValue, defaultValue, out var value)) + editor.MetaEditor.Change(meta.Copy(value ? meta.Entry | flag : meta.Entry & ~flag)); + + ImGui.SameLine(); + } + + ImGui.NewLine(); + } } - private static void CopyToClipboardButton(string tooltip, Vector2 iconSize, MetaDictionary manipulations) + + private static class EqdpRow + { + private static EqdpManipulation _new = new(EqdpEntry.Invalid, EquipSlot.Head, Gender.Male, ModelRace.Midlander, 1); + + private static float IdWidth + => 100 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current EQDP manipulations to clipboard.", iconSize, + editor.MetaEditor.Eqdp.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var raceCode = Names.CombinedRace(_new.Gender, _new.Race); + var validRaceCode = CharacterUtilityData.EqdpIdx(raceCode, false) >= 0; + var canAdd = validRaceCode && editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : + validRaceCode ? "This entry is already edited." : "This combination of race and gender can not be used."; + var defaultEntry = validRaceCode + ? ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(_new.Gender, _new.Race), _new.Slot.IsAccessory(), _new.SetId) + : 0; + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new.Copy(defaultEntry)); + + // Identifier + ImGui.TableNextColumn(); + if (IdInput("##eqdpId", IdWidth, _new.SetId.Id, out var setId, 0, ExpandedEqpGmpBase.Count - 1, _new.SetId <= 1)) + { + var newDefaultEntry = ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(_new.Gender, _new.Race), + _new.Slot.IsAccessory(), setId); + _new = new EqdpManipulation(newDefaultEntry, _new.Slot, _new.Gender, _new.Race, setId); + } + + ImGuiUtil.HoverTooltip(ModelSetIdTooltip); + + ImGui.TableNextColumn(); + if (Combos.Race("##eqdpRace", _new.Race, out var race)) + { + var newDefaultEntry = ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(_new.Gender, race), + _new.Slot.IsAccessory(), _new.SetId); + _new = new EqdpManipulation(newDefaultEntry, _new.Slot, _new.Gender, race, _new.SetId); + } + + ImGuiUtil.HoverTooltip(ModelRaceTooltip); + + ImGui.TableNextColumn(); + if (Combos.Gender("##eqdpGender", _new.Gender, out var gender)) + { + var newDefaultEntry = ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(gender, _new.Race), + _new.Slot.IsAccessory(), _new.SetId); + _new = new EqdpManipulation(newDefaultEntry, _new.Slot, gender, _new.Race, _new.SetId); + } + + ImGuiUtil.HoverTooltip(GenderTooltip); + + ImGui.TableNextColumn(); + if (Combos.EqdpEquipSlot("##eqdpSlot", _new.Slot, out var slot)) + { + var newDefaultEntry = ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(_new.Gender, _new.Race), + slot.IsAccessory(), _new.SetId); + _new = new EqdpManipulation(newDefaultEntry, slot, _new.Gender, _new.Race, _new.SetId); + } + + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + var (bit1, bit2) = defaultEntry.ToBits(_new.Slot); + Checkmark("Material##eqdpCheck1", string.Empty, bit1, bit1, out _); + ImGui.SameLine(); + Checkmark("Model##eqdpCheck2", string.Empty, bit2, bit2, out _); + } + + public static void Draw(MetaFileManager metaFileManager, EqdpManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.SetId.ToString()); + ImGuiUtil.HoverTooltip(ModelSetIdTooltipShort); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Race.ToName()); + ImGuiUtil.HoverTooltip(ModelRaceTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Gender.ToName()); + ImGuiUtil.HoverTooltip(GenderTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Slot.ToName()); + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + + // Values + var defaultEntry = ExpandedEqdpFile.GetDefault(metaFileManager, Names.CombinedRace(meta.Gender, meta.Race), meta.Slot.IsAccessory(), + meta.SetId); + var (defaultBit1, defaultBit2) = defaultEntry.ToBits(meta.Slot); + var (bit1, bit2) = meta.Entry.ToBits(meta.Slot); + ImGui.TableNextColumn(); + if (Checkmark("Material##eqdpCheck1", string.Empty, bit1, defaultBit1, out var newBit1)) + editor.MetaEditor.Change(meta.Copy(Eqdp.FromSlotAndBits(meta.Slot, newBit1, bit2))); + + ImGui.SameLine(); + if (Checkmark("Model##eqdpCheck2", string.Empty, bit2, defaultBit2, out var newBit2)) + editor.MetaEditor.Change(meta.Copy(Eqdp.FromSlotAndBits(meta.Slot, bit1, newBit2))); + } + } + + private static class ImcRow + { + private static ImcIdentifier _newIdentifier = ImcIdentifier.Default; + + private static float IdWidth + => 80 * UiHelpers.Scale; + + private static float SmallIdWidth + => 45 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current IMC manipulations to clipboard.", iconSize, + editor.MetaEditor.Imc.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var (defaultEntry, fileExists, _) = metaFileManager.ImcChecker.GetDefaultEntry(_newIdentifier, true); + var manip = (MetaManipulation)new ImcManipulation(_newIdentifier, defaultEntry); + var canAdd = fileExists && editor.MetaEditor.CanAdd(manip); + var tt = canAdd ? "Stage this edit." : !fileExists ? "This IMC file does not exist." : "This entry is already edited."; + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(manip); + + // Identifier + ImGui.TableNextColumn(); + var change = ImcManipulationDrawer.DrawObjectType(ref _newIdentifier); + + ImGui.TableNextColumn(); + change |= ImcManipulationDrawer.DrawPrimaryId(ref _newIdentifier); + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, + new Vector2(3 * UiHelpers.Scale, ImGui.GetStyle().ItemSpacing.Y)); + + ImGui.TableNextColumn(); + // Equipment and accessories are slightly different imcs than other types. + if (_newIdentifier.ObjectType is ObjectType.Equipment or ObjectType.Accessory) + change |= ImcManipulationDrawer.DrawSlot(ref _newIdentifier); + else + change |= ImcManipulationDrawer.DrawSecondaryId(ref _newIdentifier); + + ImGui.TableNextColumn(); + change |= ImcManipulationDrawer.DrawVariant(ref _newIdentifier); + + ImGui.TableNextColumn(); + if (_newIdentifier.ObjectType is ObjectType.DemiHuman) + change |= ImcManipulationDrawer.DrawSlot(ref _newIdentifier, 70); + else + ImGui.Dummy(new Vector2(70 * UiHelpers.Scale, 0)); + + if (change) + defaultEntry = metaFileManager.ImcChecker.GetDefaultEntry(_newIdentifier, true).Entry; + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + ImcManipulationDrawer.DrawMaterialId(defaultEntry, ref defaultEntry, false); + ImGui.SameLine(); + ImcManipulationDrawer.DrawMaterialAnimationId(defaultEntry, ref defaultEntry, false); + ImGui.TableNextColumn(); + ImcManipulationDrawer.DrawDecalId(defaultEntry, ref defaultEntry, false); + ImGui.SameLine(); + ImcManipulationDrawer.DrawVfxId(defaultEntry, ref defaultEntry, false); + ImGui.SameLine(); + ImcManipulationDrawer.DrawSoundId(defaultEntry, ref defaultEntry, false); + ImGui.TableNextColumn(); + ImcManipulationDrawer.DrawAttributes(defaultEntry, ref defaultEntry); + } + + public static void Draw(MetaFileManager metaFileManager, ImcManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.ObjectType.ToName()); + ImGuiUtil.HoverTooltip(ObjectTypeTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.PrimaryId.ToString()); + ImGuiUtil.HoverTooltip(PrimaryIdTooltipShort); + + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + if (meta.ObjectType is ObjectType.Equipment or ObjectType.Accessory) + { + ImGui.TextUnformatted(meta.EquipSlot.ToName()); + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + } + else + { + ImGui.TextUnformatted(meta.SecondaryId.ToString()); + ImGuiUtil.HoverTooltip(SecondaryIdTooltip); + } + + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Variant.ToString()); + ImGuiUtil.HoverTooltip(VariantIdTooltip); + + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + if (meta.ObjectType is ObjectType.DemiHuman) + { + ImGui.TextUnformatted(meta.EquipSlot.ToName()); + ImGuiUtil.HoverTooltip(EquipSlotTooltip); + } + + // Values + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, + new Vector2(3 * UiHelpers.Scale, ImGui.GetStyle().ItemSpacing.Y)); + ImGui.TableNextColumn(); + var defaultEntry = metaFileManager.ImcChecker.GetDefaultEntry(meta.Identifier, true).Entry; + var newEntry = meta.Entry; + var changes = ImcManipulationDrawer.DrawMaterialId(defaultEntry, ref newEntry, true); + ImGui.SameLine(); + changes |= ImcManipulationDrawer.DrawMaterialAnimationId(defaultEntry, ref newEntry, true); + ImGui.TableNextColumn(); + changes |= ImcManipulationDrawer.DrawDecalId(defaultEntry, ref newEntry, true); + ImGui.SameLine(); + changes |= ImcManipulationDrawer.DrawVfxId(defaultEntry, ref newEntry, true); + ImGui.SameLine(); + changes |= ImcManipulationDrawer.DrawSoundId(defaultEntry, ref newEntry, true); + ImGui.TableNextColumn(); + changes |= ImcManipulationDrawer.DrawAttributes(defaultEntry, ref newEntry); + + if (changes) + editor.MetaEditor.Change(meta.Copy(newEntry)); + } + } + + private static class EstRow + { + private static EstManipulation _new = new(Gender.Male, ModelRace.Midlander, EstManipulation.EstType.Body, 1, 0); + + private static float IdWidth + => 100 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current EST manipulations to clipboard.", iconSize, + editor.MetaEditor.Est.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var canAdd = editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : "This entry is already edited."; + var defaultEntry = EstFile.GetDefault(metaFileManager, _new.Slot, Names.CombinedRace(_new.Gender, _new.Race), _new.SetId); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new.Copy(defaultEntry)); + + // Identifier + ImGui.TableNextColumn(); + if (IdInput("##estId", IdWidth, _new.SetId.Id, out var setId, 0, ExpandedEqpGmpBase.Count - 1, _new.SetId <= 1)) + { + var newDefaultEntry = EstFile.GetDefault(metaFileManager, _new.Slot, Names.CombinedRace(_new.Gender, _new.Race), setId); + _new = new EstManipulation(_new.Gender, _new.Race, _new.Slot, setId, newDefaultEntry); + } + + ImGuiUtil.HoverTooltip(ModelSetIdTooltip); + + ImGui.TableNextColumn(); + if (Combos.Race("##estRace", _new.Race, out var race)) + { + var newDefaultEntry = EstFile.GetDefault(metaFileManager, _new.Slot, Names.CombinedRace(_new.Gender, race), _new.SetId); + _new = new EstManipulation(_new.Gender, race, _new.Slot, _new.SetId, newDefaultEntry); + } + + ImGuiUtil.HoverTooltip(ModelRaceTooltip); + + ImGui.TableNextColumn(); + if (Combos.Gender("##estGender", _new.Gender, out var gender)) + { + var newDefaultEntry = EstFile.GetDefault(metaFileManager, _new.Slot, Names.CombinedRace(gender, _new.Race), _new.SetId); + _new = new EstManipulation(gender, _new.Race, _new.Slot, _new.SetId, newDefaultEntry); + } + + ImGuiUtil.HoverTooltip(GenderTooltip); + + ImGui.TableNextColumn(); + if (Combos.EstSlot("##estSlot", _new.Slot, out var slot)) + { + var newDefaultEntry = EstFile.GetDefault(metaFileManager, slot, Names.CombinedRace(_new.Gender, _new.Race), _new.SetId); + _new = new EstManipulation(_new.Gender, _new.Race, slot, _new.SetId, newDefaultEntry); + } + + ImGuiUtil.HoverTooltip(EstTypeTooltip); + + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + IntDragInput("##estSkeleton", "Skeleton Index", IdWidth, _new.Entry, defaultEntry, out _, 0, ushort.MaxValue, 0.05f); + } + + public static void Draw(MetaFileManager metaFileManager, EstManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.SetId.ToString()); + ImGuiUtil.HoverTooltip(ModelSetIdTooltipShort); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Race.ToName()); + ImGuiUtil.HoverTooltip(ModelRaceTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Gender.ToName()); + ImGuiUtil.HoverTooltip(GenderTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Slot.ToString()); + ImGuiUtil.HoverTooltip(EstTypeTooltip); + + // Values + var defaultEntry = EstFile.GetDefault(metaFileManager, meta.Slot, Names.CombinedRace(meta.Gender, meta.Race), meta.SetId); + ImGui.TableNextColumn(); + if (IntDragInput("##estSkeleton", $"Skeleton Index\nDefault Value: {defaultEntry}", IdWidth, meta.Entry, defaultEntry, + out var entry, 0, ushort.MaxValue, 0.05f)) + editor.MetaEditor.Change(meta.Copy((ushort)entry)); + } + } + + private static class GmpRow + { + private static GmpManipulation _new = new(GmpEntry.Default, 1); + + private static float RotationWidth + => 75 * UiHelpers.Scale; + + private static float UnkWidth + => 50 * UiHelpers.Scale; + + private static float IdWidth + => 100 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current GMP manipulations to clipboard.", iconSize, + editor.MetaEditor.Gmp.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var canAdd = editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : "This entry is already edited."; + var defaultEntry = ExpandedGmpFile.GetDefault(metaFileManager, _new.SetId); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new.Copy(defaultEntry)); + + // Identifier + ImGui.TableNextColumn(); + if (IdInput("##gmpId", IdWidth, _new.SetId.Id, out var setId, 1, ExpandedEqpGmpBase.Count - 1, _new.SetId <= 1)) + _new = new GmpManipulation(ExpandedGmpFile.GetDefault(metaFileManager, setId), setId); + + ImGuiUtil.HoverTooltip(ModelSetIdTooltip); + + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + Checkmark("##gmpEnabled", "Gimmick Enabled", defaultEntry.Enabled, defaultEntry.Enabled, out _); + ImGui.TableNextColumn(); + Checkmark("##gmpAnimated", "Gimmick Animated", defaultEntry.Animated, defaultEntry.Animated, out _); + ImGui.TableNextColumn(); + IntDragInput("##gmpRotationA", "Rotation A in Degrees", RotationWidth, defaultEntry.RotationA, defaultEntry.RotationA, out _, 0, + 360, 0f); + ImGui.SameLine(); + IntDragInput("##gmpRotationB", "Rotation B in Degrees", RotationWidth, defaultEntry.RotationB, defaultEntry.RotationB, out _, 0, + 360, 0f); + ImGui.SameLine(); + IntDragInput("##gmpRotationC", "Rotation C in Degrees", RotationWidth, defaultEntry.RotationC, defaultEntry.RotationC, out _, 0, + 360, 0f); + ImGui.TableNextColumn(); + IntDragInput("##gmpUnkA", "Animation Type A?", UnkWidth, defaultEntry.UnknownA, defaultEntry.UnknownA, out _, 0, 15, 0f); + ImGui.SameLine(); + IntDragInput("##gmpUnkB", "Animation Type B?", UnkWidth, defaultEntry.UnknownB, defaultEntry.UnknownB, out _, 0, 15, 0f); + } + + public static void Draw(MetaFileManager metaFileManager, GmpManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.SetId.ToString()); + ImGuiUtil.HoverTooltip(ModelSetIdTooltipShort); + + // Values + var defaultEntry = ExpandedGmpFile.GetDefault(metaFileManager, meta.SetId); + ImGui.TableNextColumn(); + if (Checkmark("##gmpEnabled", "Gimmick Enabled", meta.Entry.Enabled, defaultEntry.Enabled, out var enabled)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { Enabled = enabled })); + + ImGui.TableNextColumn(); + if (Checkmark("##gmpAnimated", "Gimmick Animated", meta.Entry.Animated, defaultEntry.Animated, out var animated)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { Animated = animated })); + + ImGui.TableNextColumn(); + if (IntDragInput("##gmpRotationA", $"Rotation A in Degrees\nDefault Value: {defaultEntry.RotationA}", RotationWidth, + meta.Entry.RotationA, defaultEntry.RotationA, out var rotationA, 0, 360, 0.05f)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { RotationA = (ushort)rotationA })); + + ImGui.SameLine(); + if (IntDragInput("##gmpRotationB", $"Rotation B in Degrees\nDefault Value: {defaultEntry.RotationB}", RotationWidth, + meta.Entry.RotationB, defaultEntry.RotationB, out var rotationB, 0, 360, 0.05f)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { RotationB = (ushort)rotationB })); + + ImGui.SameLine(); + if (IntDragInput("##gmpRotationC", $"Rotation C in Degrees\nDefault Value: {defaultEntry.RotationC}", RotationWidth, + meta.Entry.RotationC, defaultEntry.RotationC, out var rotationC, 0, 360, 0.05f)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { RotationC = (ushort)rotationC })); + + ImGui.TableNextColumn(); + if (IntDragInput("##gmpUnkA", $"Animation Type A?\nDefault Value: {defaultEntry.UnknownA}", UnkWidth, meta.Entry.UnknownA, + defaultEntry.UnknownA, out var unkA, 0, 15, 0.01f)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { UnknownA = (byte)unkA })); + + ImGui.SameLine(); + if (IntDragInput("##gmpUnkB", $"Animation Type B?\nDefault Value: {defaultEntry.UnknownB}", UnkWidth, meta.Entry.UnknownB, + defaultEntry.UnknownB, out var unkB, 0, 15, 0.01f)) + editor.MetaEditor.Change(meta.Copy(meta.Entry with { UnknownA = (byte)unkB })); + } + } + + private static class RspRow + { + private static RspManipulation _new = new(SubRace.Midlander, RspAttribute.MaleMinSize, 1f); + + private static float FloatWidth + => 150 * UiHelpers.Scale; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current RSP manipulations to clipboard.", iconSize, + editor.MetaEditor.Rsp.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var canAdd = editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : "This entry is already edited."; + var defaultEntry = CmpFile.GetDefault(metaFileManager, _new.SubRace, _new.Attribute); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new.Copy(defaultEntry)); + + // Identifier + ImGui.TableNextColumn(); + if (Combos.SubRace("##rspSubRace", _new.SubRace, out var subRace)) + _new = new RspManipulation(subRace, _new.Attribute, CmpFile.GetDefault(metaFileManager, subRace, _new.Attribute)); + + ImGuiUtil.HoverTooltip(RacialTribeTooltip); + + ImGui.TableNextColumn(); + if (Combos.RspAttribute("##rspAttribute", _new.Attribute, out var attribute)) + _new = new RspManipulation(_new.SubRace, attribute, CmpFile.GetDefault(metaFileManager, subRace, attribute)); + + ImGuiUtil.HoverTooltip(ScalingTypeTooltip); + + // Values + using var disabled = ImRaii.Disabled(); + ImGui.TableNextColumn(); + ImGui.SetNextItemWidth(FloatWidth); + ImGui.DragFloat("##rspValue", ref defaultEntry, 0f); + } + + public static void Draw(MetaFileManager metaFileManager, RspManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.SubRace.ToName()); + ImGuiUtil.HoverTooltip(RacialTribeTooltip); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImGui.TextUnformatted(meta.Attribute.ToFullString()); + ImGuiUtil.HoverTooltip(ScalingTypeTooltip); + ImGui.TableNextColumn(); + + // Values + var def = CmpFile.GetDefault(metaFileManager, meta.SubRace, meta.Attribute); + var value = meta.Entry; + ImGui.SetNextItemWidth(FloatWidth); + using var color = ImRaii.PushColor(ImGuiCol.FrameBg, + def < value ? ColorId.IncreasedMetaValue.Value() : ColorId.DecreasedMetaValue.Value(), + def != value); + if (ImGui.DragFloat("##rspValue", ref value, 0.001f, RspManipulation.MinValue, RspManipulation.MaxValue) + && value is >= RspManipulation.MinValue and <= RspManipulation.MaxValue) + editor.MetaEditor.Change(meta.Copy(value)); + + ImGuiUtil.HoverTooltip($"Default Value: {def:0.###}"); + } + } + + private static class GlobalEqpRow + { + private static GlobalEqpManipulation _new = new() + { + Type = GlobalEqpType.DoNotHideEarrings, + Condition = 1, + }; + + public static void DrawNew(MetaFileManager metaFileManager, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy all current global EQP manipulations to clipboard.", iconSize, + editor.MetaEditor.GlobalEqp.Select(m => (MetaManipulation)m)); + ImGui.TableNextColumn(); + var canAdd = editor.MetaEditor.CanAdd(_new); + var tt = canAdd ? "Stage this edit." : "This entry is already manipulated."; + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), iconSize, tt, !canAdd, true)) + editor.MetaEditor.Add(_new); + + // Identifier + ImGui.TableNextColumn(); + ImGui.SetNextItemWidth(250 * ImUtf8.GlobalScale); + using (var combo = ImUtf8.Combo("##geqpType"u8, _new.Type.ToName())) + { + if (combo) + foreach (var type in Enum.GetValues()) + { + if (ImUtf8.Selectable(type.ToName(), type == _new.Type)) + _new = new GlobalEqpManipulation + { + Type = type, + Condition = type.HasCondition() ? _new.Type.HasCondition() ? _new.Condition : 1 : 0, + }; + ImUtf8.HoverTooltip(type.ToDescription()); + } + } + + ImUtf8.HoverTooltip(_new.Type.ToDescription()); + + ImGui.TableNextColumn(); + if (!_new.Type.HasCondition()) + return; + + if (IdInput("##geqpCond", 100 * ImUtf8.GlobalScale, _new.Condition.Id, out var newId, 1, ushort.MaxValue, _new.Condition.Id <= 1)) + _new = _new with { Condition = newId }; + } + + public static void Draw(MetaFileManager metaFileManager, GlobalEqpManipulation meta, ModEditor editor, Vector2 iconSize) + { + DrawMetaButtons(meta, editor, iconSize); + ImGui.TableNextColumn(); + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImUtf8.Text(meta.Type.ToName()); + ImUtf8.HoverTooltip(meta.Type.ToDescription()); + ImGui.TableNextColumn(); + if (meta.Type.HasCondition()) + { + ImGui.SetCursorPosX(ImGui.GetCursorPosX() + ImGui.GetStyle().FramePadding.X); + ImUtf8.Text($"{meta.Condition.Id}"); + } + } + } + + // A number input for ids with a optional max id of given width. + // Returns true if newId changed against currentId. + private static bool IdInput(string label, float width, ushort currentId, out ushort newId, int minId, int maxId, bool border) + { + int tmp = currentId; + ImGui.SetNextItemWidth(width); + using var style = ImRaii.PushStyle(ImGuiStyleVar.FrameBorderSize, UiHelpers.Scale, border); + using var color = ImRaii.PushColor(ImGuiCol.Border, Colors.RegexWarningBorder, border); + if (ImGui.InputInt(label, ref tmp, 0)) + tmp = Math.Clamp(tmp, minId, maxId); + + newId = (ushort)tmp; + return newId != currentId; + } + + // A checkmark that compares against a default value and shows a tooltip. + // Returns true if newValue is changed against currentValue. + private static bool Checkmark(string label, string tooltip, bool currentValue, bool defaultValue, out bool newValue) + { + using var color = ImRaii.PushColor(ImGuiCol.FrameBg, + defaultValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), + defaultValue != currentValue); + newValue = currentValue; + ImGui.Checkbox(label, ref newValue); + ImGuiUtil.HoverTooltip(tooltip, ImGuiHoveredFlags.AllowWhenDisabled); + return newValue != currentValue; + } + + // A dragging int input of given width that compares against a default value, shows a tooltip and clamps against min and max. + // Returns true if newValue changed against currentValue. + private static bool IntDragInput(string label, string tooltip, float width, int currentValue, int defaultValue, out int newValue, + int minValue, int maxValue, float speed) + { + newValue = currentValue; + using var color = ImRaii.PushColor(ImGuiCol.FrameBg, + defaultValue > currentValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), + defaultValue != currentValue); + ImGui.SetNextItemWidth(width); + if (ImGui.DragInt(label, ref newValue, speed, minValue, maxValue)) + newValue = Math.Clamp(newValue, minValue, maxValue); + + ImGuiUtil.HoverTooltip(tooltip, ImGuiHoveredFlags.AllowWhenDisabled); + + return newValue != currentValue; + } + + private static void CopyToClipboardButton(string tooltip, Vector2 iconSize, IEnumerable manipulations) { if (!ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Clipboard.ToIconString(), iconSize, tooltip, false, true)) return; - var text = Functions.ToCompressedBase64(manipulations, 0); + var text = Functions.ToCompressedBase64(manipulations, MetaManipulation.CurrentVersion); if (text.Length > 0) ImGui.SetClipboardText(text); } private void AddFromClipboardButton() { - if (ImUtf8.Button("Add from Clipboard"u8)) + if (ImGui.Button("Add from Clipboard")) { var clipboard = ImGuiUtil.GetClipboardText(); - if (MetaApi.ConvertManips(clipboard, out var manips, out _)) - { - _editor.MetaEditor.UpdateTo(manips); - _editor.MetaEditor.Changes = true; - } + var version = Functions.FromCompressedBase64(clipboard, out var manips); + if (version == MetaManipulation.CurrentVersion && manips != null) + foreach (var manip in manips.Where(m => m.ManipulationType != MetaManipulation.Type.Unknown)) + _editor.MetaEditor.Set(manip); } - ImUtf8.HoverTooltip( - "Try to add meta manipulations currently stored in the clipboard to the current manipulations.\nOverwrites already existing manipulations."u8); + ImGuiUtil.HoverTooltip( + "Try to add meta manipulations currently stored in the clipboard to the current manipulations.\nOverwrites already existing manipulations."); } private void SetFromClipboardButton() { - if (ImUtf8.Button("Set from Clipboard"u8)) + if (ImGui.Button("Set from Clipboard")) { var clipboard = ImGuiUtil.GetClipboardText(); - if (MetaApi.ConvertManips(clipboard, out var manips, out _)) + var version = Functions.FromCompressedBase64(clipboard, out var manips); + if (version == MetaManipulation.CurrentVersion && manips != null) { - _editor.MetaEditor.SetTo(manips); - _editor.MetaEditor.Changes = true; + _editor.MetaEditor.Clear(); + foreach (var manip in manips.Where(m => m.ManipulationType != MetaManipulation.Type.Unknown)) + _editor.MetaEditor.Set(manip); } } - ImUtf8.HoverTooltip( - "Try to set the current meta manipulations to the set currently stored in the clipboard.\nRemoves all other manipulations."u8); + ImGuiUtil.HoverTooltip( + "Try to set the current meta manipulations to the set currently stored in the clipboard.\nRemoves all other manipulations."); + } + + private static void DrawMetaButtons(MetaManipulation meta, ModEditor editor, Vector2 iconSize) + { + ImGui.TableNextColumn(); + CopyToClipboardButton("Copy this manipulation to clipboard.", iconSize, Array.Empty().Append(meta)); + + ImGui.TableNextColumn(); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Trash.ToIconString(), iconSize, "Delete this meta manipulation.", false, true)) + editor.MetaEditor.Delete(meta); } } diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.MdlTab.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.MdlTab.cs index fc197bc0..1f935eb6 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.MdlTab.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.MdlTab.cs @@ -1,4 +1,5 @@ -using OtterGui.Extensions; +using Lumina.Data.Parsing; +using OtterGui; using Penumbra.GameData; using Penumbra.GameData.Files; using Penumbra.Import.Models; @@ -94,7 +95,7 @@ public partial class ModEditWindow task.ContinueWith(t => { GamePaths = FinalizeIo(t); }, TaskScheduler.Default); } - private KeyValuePair[] GetCurrentEstManipulations() + private EstManipulation[] GetCurrentEstManipulations() { var mod = _edit._editor.Mod; var option = _edit._editor.Option; @@ -105,7 +106,9 @@ public partial class ModEditWindow return mod.AllDataContainers .Where(subMod => subMod != option) .Prepend(option) - .SelectMany(subMod => subMod.Manipulations.Est) + .SelectMany(subMod => subMod.Manipulations) + .Where(manipulation => manipulation.ManipulationType is MetaManipulation.Type.Est) + .Select(manipulation => manipulation.Est) .ToArray(); } @@ -271,7 +274,7 @@ public partial class ModEditWindow private byte[]? ReadFile(string path) { // TODO: if cross-collection lookups are turned off, this conversion can be skipped - if (!Utf8GamePath.FromString(path, out var utf8Path)) + if (!Utf8GamePath.FromString(path, out var utf8Path, true)) throw new Exception($"Resolved path {path} could not be converted to a game path."); var resolvedPath = _edit._activeCollections.Current.ResolvePath(utf8Path) ?? new FullPath(utf8Path); diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.cs index a7db7f25..a7d39c6e 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Models.cs @@ -1,16 +1,14 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; +using Dalamud.Interface.Components; +using ImGuiNET; using Lumina.Data.Parsing; using OtterGui; using OtterGui.Custom; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.GameData; using Penumbra.GameData.Files; using Penumbra.Import.Models; -using Penumbra.Import.Models.Import; using Penumbra.String.Classes; using Penumbra.UI.Classes; @@ -18,7 +16,7 @@ namespace Penumbra.UI.AdvancedWindow; public partial class ModEditWindow { - private const int MdlMaterialMaximum = ModelImporter.MaterialLimit; + private const int MdlMaterialMaximum = 4; private const string MdlImportDocumentation = @"https://github.com/xivdev/Penumbra/wiki/Model-IO#user-content-9b49d296-23ab-410a-845b-a3be769b71ea"; @@ -29,74 +27,48 @@ public partial class ModEditWindow private readonly FileEditor _modelTab; private readonly ModelManager _models; - private class LoadedData + private string _modelNewMaterial = string.Empty; + private readonly List _subMeshAttributeTagWidgets = []; + private string _customPath = string.Empty; + private Utf8GamePath _customGamePath = Utf8GamePath.Empty; + private MdlFile _lastFile = null!; + private long[] _lodTriCount = []; + + private void UpdateFile(MdlFile file, bool force) { - public MdlFile LastFile = null!; - public readonly List SubMeshAttributeTags = []; - public long[] LodTriCount = []; - } + if (file == _lastFile && !force) + return; - private string _modelNewMaterial = string.Empty; - - private readonly LoadedData _main = new(); - private readonly LoadedData _preview = new(); - - private string _customPath = string.Empty; - private Utf8GamePath _customGamePath = Utf8GamePath.Empty; - - - private LoadedData UpdateFile(MdlFile file, bool force, bool disabled) - { - var data = disabled ? _preview : _main; - if (file == data.LastFile && !force) - return data; - - data.LastFile = file; + _lastFile = file; var subMeshTotal = file.Meshes.Aggregate(0, (count, mesh) => count + mesh.SubMeshCount); - if (data.SubMeshAttributeTags.Count != subMeshTotal) + if (_subMeshAttributeTagWidgets.Count != subMeshTotal) { - data.SubMeshAttributeTags.Clear(); - data.SubMeshAttributeTags.AddRange( + _subMeshAttributeTagWidgets.Clear(); + _subMeshAttributeTagWidgets.AddRange( Enumerable.Range(0, subMeshTotal).Select(_ => new TagButtons()) ); } - data.LodTriCount = Enumerable.Range(0, file.Lods.Length).Select(l => GetTriangleCountForLod(file, l)).ToArray(); - return data; + _lodTriCount = Enumerable.Range(0, file.Lods.Length).Select(l => GetTriangleCountForLod(file, l)).ToArray(); } private bool DrawModelPanel(MdlTab tab, bool disabled) { - var ret = tab.Dirty; - var data = UpdateFile(tab.Mdl, ret, disabled); - DrawVersionUpdate(tab, disabled); + var ret = tab.Dirty; + UpdateFile(tab.Mdl, ret); DrawImportExport(tab, disabled); ret |= DrawModelMaterialDetails(tab, disabled); - if (ImGui.CollapsingHeader($"Meshes ({data.LastFile.Meshes.Length})###meshes")) - for (var i = 0; i < data.LastFile.LodCount; ++i) + if (ImGui.CollapsingHeader($"Meshes ({_lastFile.Meshes.Length})###meshes")) + for (var i = 0; i < _lastFile.LodCount; ++i) ret |= DrawModelLodDetails(tab, i, disabled); - ret |= DrawOtherModelDetails(data); + ret |= DrawOtherModelDetails(disabled); return !disabled && ret; } - private void DrawVersionUpdate(MdlTab tab, bool disabled) - { - if (disabled || tab.Mdl.Version is not MdlFile.V5) - return; - - if (!ImUtf8.ButtonEx("Update MDL Version from V5 to V6"u8, - "Try using this if the bone weights of a pre-Dawntrail model seem wrong.\n\nThis is not revertible."u8, - new Vector2(-0.1f, 0), false, 0, Colors.PressEnterWarningBg)) - return; - - tab.Mdl.ConvertV5ToV6(); - _modelTab.SaveFile(); - } - private void DrawImportExport(MdlTab tab, bool disabled) { if (!ImGui.CollapsingHeader("Import / Export")) @@ -126,7 +98,7 @@ public partial class ModEditWindow return true; }); - using (ImRaii.FramedGroup("Import", size, headerPreIcon: FontAwesomeIcon.FileImport)) + using (var frame = ImRaii.FramedGroup("Import", size, headerPreIcon: FontAwesomeIcon.FileImport)) { ImGui.Checkbox("Keep current materials", ref tab.ImportKeepMaterials); ImGui.Checkbox("Keep current attributes", ref tab.ImportKeepAttributes); @@ -260,7 +232,7 @@ public partial class ModEditWindow if (!ImGui.InputTextWithHint("##customInput", "Enter custom game path...", ref _customPath, 256)) return; - if (!Utf8GamePath.FromString(_customPath, out _customGamePath)) + if (!Utf8GamePath.FromString(_customPath, out _customGamePath, false)) _customGamePath = Utf8GamePath.Empty; } @@ -350,7 +322,7 @@ public partial class ModEditWindow if (!disabled) { ImGui.TableSetupColumn("actions", ImGuiTableColumnFlags.WidthFixed, UiHelpers.IconButtonSize.X); - ImGui.TableSetupColumn("help", ImGuiTableColumnFlags.WidthFixed, UiHelpers.IconButtonSize.X); + ImGui.TableSetupColumn("help", ImGuiTableColumnFlags.WidthFixed, UiHelpers.IconButtonSize.X); } var inputFlags = disabled ? ImGuiInputTextFlags.ReadOnly : ImGuiInputTextFlags.None; @@ -369,11 +341,10 @@ public partial class ModEditWindow ImGui.TableNextColumn(); if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Plus.ToIconString(), UiHelpers.IconButtonSize, string.Empty, !validName, true)) { - ret |= true; - tab.Mdl.Materials = materials.AddItem(_modelNewMaterial); - _modelNewMaterial = string.Empty; + ret |= true; + tab.Mdl.Materials = materials.AddItem(_modelNewMaterial); + _modelNewMaterial = string.Empty; } - ImGui.TableNextColumn(); if (!validName && _modelNewMaterial.Length > 0) DrawInvalidMaterialMarker(); @@ -424,16 +395,14 @@ public partial class ModEditWindow // Add markers to invalid materials. if (!tab.ValidateMaterial(temp)) DrawInvalidMaterialMarker(); - + return ret; } - private static void DrawInvalidMaterialMarker() + private void DrawInvalidMaterialMarker() { - using (ImRaii.PushFont(UiBuilder.IconFont)) - { + using (var font = ImRaii.PushFont(UiBuilder.IconFont)) ImGuiUtil.TextColored(0xFF0000FF, FontAwesomeIcon.TimesCircle.ToIconString()); - } ImGuiUtil.HoverTooltip( "Materials must be either relative (e.g. \"/filename.mtrl\")\n" @@ -501,11 +470,11 @@ public partial class ModEditWindow using var node = ImRaii.TreeNode($"Click to expand"); if (!node) return; - + var flags = ImGuiTableFlags.SizingFixedFit - | ImGuiTableFlags.RowBg - | ImGuiTableFlags.Borders - | ImGuiTableFlags.NoHostExtendX; + | ImGuiTableFlags.RowBg + | ImGuiTableFlags.Borders + | ImGuiTableFlags.NoHostExtendX; using var table = ImRaii.Table(string.Empty, 4, flags); if (!table) return; @@ -565,8 +534,7 @@ public partial class ModEditWindow ImGui.TextUnformatted($"Attributes #{subMeshOffset + 1}"); ImGui.TableNextColumn(); - var data = disabled ? _preview : _main; - var widget = data.SubMeshAttributeTags[subMeshIndex]; + var widget = _subMeshAttributeTagWidgets[subMeshIndex]; var attributes = tab.GetSubMeshAttributes(subMeshIndex); if (attributes == null) @@ -587,56 +555,55 @@ public partial class ModEditWindow return true; } - private bool DrawOtherModelDetails(LoadedData data) + private bool DrawOtherModelDetails(bool _) { using var header = ImRaii.CollapsingHeader("Further Content"); if (!header) return false; - var ret = false; using (var table = ImRaii.Table("##data", 2, ImGuiTableFlags.SizingFixedFit)) { if (table) { ImGuiUtil.DrawTableColumn("Version"); - ImGuiUtil.DrawTableColumn($"0x{data.LastFile.Version:X}"); + ImGuiUtil.DrawTableColumn($"0x{_lastFile.Version:X}"); ImGuiUtil.DrawTableColumn("Radius"); - ImGuiUtil.DrawTableColumn(data.LastFile.Radius.ToString(CultureInfo.InvariantCulture)); + ImGuiUtil.DrawTableColumn(_lastFile.Radius.ToString(CultureInfo.InvariantCulture)); ImGuiUtil.DrawTableColumn("Model Clip Out Distance"); - ImGuiUtil.DrawTableColumn(data.LastFile.ModelClipOutDistance.ToString(CultureInfo.InvariantCulture)); + ImGuiUtil.DrawTableColumn(_lastFile.ModelClipOutDistance.ToString(CultureInfo.InvariantCulture)); ImGuiUtil.DrawTableColumn("Shadow Clip Out Distance"); - ImGuiUtil.DrawTableColumn(data.LastFile.ShadowClipOutDistance.ToString(CultureInfo.InvariantCulture)); + ImGuiUtil.DrawTableColumn(_lastFile.ShadowClipOutDistance.ToString(CultureInfo.InvariantCulture)); ImGuiUtil.DrawTableColumn("LOD Count"); - ImGuiUtil.DrawTableColumn(data.LastFile.LodCount.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.LodCount.ToString()); ImGuiUtil.DrawTableColumn("Enable Index Buffer Streaming"); - ImGuiUtil.DrawTableColumn(data.LastFile.EnableIndexBufferStreaming.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.EnableIndexBufferStreaming.ToString()); ImGuiUtil.DrawTableColumn("Enable Edge Geometry"); - ImGuiUtil.DrawTableColumn(data.LastFile.EnableEdgeGeometry.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.EnableEdgeGeometry.ToString()); ImGuiUtil.DrawTableColumn("Flags 1"); - ImGuiUtil.DrawTableColumn(data.LastFile.Flags1.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.Flags1.ToString()); ImGuiUtil.DrawTableColumn("Flags 2"); - ImGuiUtil.DrawTableColumn(data.LastFile.Flags2.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.Flags2.ToString()); ImGuiUtil.DrawTableColumn("Vertex Declarations"); - ImGuiUtil.DrawTableColumn(data.LastFile.VertexDeclarations.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.VertexDeclarations.Length.ToString()); ImGuiUtil.DrawTableColumn("Bone Bounding Boxes"); - ImGuiUtil.DrawTableColumn(data.LastFile.BoneBoundingBoxes.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.BoneBoundingBoxes.Length.ToString()); ImGuiUtil.DrawTableColumn("Bone Tables"); - ImGuiUtil.DrawTableColumn(data.LastFile.BoneTables.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.BoneTables.Length.ToString()); ImGuiUtil.DrawTableColumn("Element IDs"); - ImGuiUtil.DrawTableColumn(data.LastFile.ElementIds.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.ElementIds.Length.ToString()); ImGuiUtil.DrawTableColumn("Extra LoDs"); - ImGuiUtil.DrawTableColumn(data.LastFile.ExtraLods.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.ExtraLods.Length.ToString()); ImGuiUtil.DrawTableColumn("Meshes"); - ImGuiUtil.DrawTableColumn(data.LastFile.Meshes.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.Meshes.Length.ToString()); ImGuiUtil.DrawTableColumn("Shape Meshes"); - ImGuiUtil.DrawTableColumn(data.LastFile.ShapeMeshes.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.ShapeMeshes.Length.ToString()); ImGuiUtil.DrawTableColumn("LoDs"); - ImGuiUtil.DrawTableColumn(data.LastFile.Lods.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.Lods.Length.ToString()); ImGuiUtil.DrawTableColumn("Vertex Declarations"); - ImGuiUtil.DrawTableColumn(data.LastFile.VertexDeclarations.Length.ToString()); + ImGuiUtil.DrawTableColumn(_lastFile.VertexDeclarations.Length.ToString()); ImGuiUtil.DrawTableColumn("Stack Size"); - ImGuiUtil.DrawTableColumn(data.LastFile.StackSize.ToString()); - foreach (var (triCount, lod) in data.LodTriCount.WithIndex()) + ImGuiUtil.DrawTableColumn(_lastFile.StackSize.ToString()); + foreach (var (triCount, lod) in _lodTriCount.WithIndex()) { ImGuiUtil.DrawTableColumn($"LOD #{lod + 1} Triangle Count"); ImGuiUtil.DrawTableColumn(triCount.ToString()); @@ -647,66 +614,39 @@ public partial class ModEditWindow using (var materials = ImRaii.TreeNode("Materials", ImGuiTreeNodeFlags.DefaultOpen)) { if (materials) - foreach (var material in data.LastFile.Materials) + foreach (var material in _lastFile.Materials) ImRaii.TreeNode(material, ImGuiTreeNodeFlags.Leaf).Dispose(); } using (var attributes = ImRaii.TreeNode("Attributes", ImGuiTreeNodeFlags.DefaultOpen)) { if (attributes) - for (var i = 0; i < data.LastFile.Attributes.Length; ++i) - { - using var id = ImUtf8.PushId(i); - ref var attribute = ref data.LastFile.Attributes[i]; - var name = attribute; - if (ImUtf8.InputText("##attribute"u8, ref name, "Attribute Name..."u8) && name.Length > 0 && name != attribute) - { - attribute = name; - ret = true; - } - } + foreach (var attribute in _lastFile.Attributes) + ImRaii.TreeNode(attribute, ImGuiTreeNodeFlags.Leaf).Dispose(); } using (var bones = ImRaii.TreeNode("Bones", ImGuiTreeNodeFlags.DefaultOpen)) { if (bones) - for (var i = 0; i < data.LastFile.Bones.Length; ++i) - { - using var id = ImUtf8.PushId(i); - ref var bone = ref data.LastFile.Bones[i]; - var name = bone; - if (ImUtf8.InputText("##bone"u8, ref name, "Bone Name..."u8) && name.Length > 0 && name != bone) - { - bone = name; - ret = true; - } - } + foreach (var bone in _lastFile.Bones) + ImRaii.TreeNode(bone, ImGuiTreeNodeFlags.Leaf).Dispose(); } using (var shapes = ImRaii.TreeNode("Shapes", ImGuiTreeNodeFlags.DefaultOpen)) { if (shapes) - for (var i = 0; i < data.LastFile.Shapes.Length; ++i) - { - using var id = ImUtf8.PushId(i); - ref var shape = ref data.LastFile.Shapes[i]; - var name = shape.ShapeName; - if (ImUtf8.InputText("##shape"u8, ref name, "Shape Name..."u8) && name.Length > 0 && name != shape.ShapeName) - { - shape.ShapeName = name; - ret = true; - } - } + foreach (var shape in _lastFile.Shapes) + ImRaii.TreeNode(shape.ShapeName, ImGuiTreeNodeFlags.Leaf).Dispose(); } - if (data.LastFile.RemainingData.Length > 0) + if (_lastFile.RemainingData.Length > 0) { - using var t = ImRaii.TreeNode($"Additional Data (Size: {data.LastFile.RemainingData.Length})###AdditionalData"); + using var t = ImRaii.TreeNode($"Additional Data (Size: {_lastFile.RemainingData.Length})###AdditionalData"); if (t) - Widget.DrawHexViewer(data.LastFile.RemainingData); + Widget.DrawHexViewer(_lastFile.RemainingData); } - return ret; + return false; } private static bool GetFirstModel(IEnumerable files, [NotNullWhen(true)] out string? file) diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.QuickImport.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.QuickImport.cs index f55ae576..55b7e748 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.QuickImport.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.QuickImport.cs @@ -1,7 +1,8 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using Lumina.Data; -using OtterGui.Text; +using OtterGui; +using OtterGui.Raii; using Penumbra.Api.Enums; using Penumbra.GameData.Files; using Penumbra.Interop.ResourceTree; @@ -14,9 +15,9 @@ namespace Penumbra.UI.AdvancedWindow; public partial class ModEditWindow { - private readonly FileDialogService _fileDialog; private readonly ResourceTreeFactory _resourceTreeFactory; private readonly ResourceTreeViewer _quickImportViewer; + private readonly Dictionary _quickImportWritables = new(); private readonly Dictionary<(Utf8GamePath, IWritable?), QuickImportAction> _quickImportActions = new(); private HashSet GetPlayerResourcesOfType(ResourceType type) @@ -41,7 +42,7 @@ public partial class ModEditWindow private void DrawQuickImportTab() { - using var tab = ImUtf8.TabItem("Import from Screen"u8); + using var tab = ImRaii.TabItem("Import from Screen"); if (!tab) { _quickImportActions.Clear(); @@ -55,11 +56,52 @@ public partial class ModEditWindow private void OnQuickImportRefresh() { + _quickImportWritables.Clear(); _quickImportActions.Clear(); } - private void DrawQuickImportActions(ResourceNode resourceNode, IWritable? writable, Vector2 buttonSize) + private void DrawQuickImportActions(ResourceNode resourceNode, Vector2 buttonSize) { + if (!_quickImportWritables!.TryGetValue(resourceNode.FullPath, out var writable)) + { + var path = resourceNode.FullPath.ToPath(); + if (resourceNode.FullPath.IsRooted) + { + writable = new RawFileWritable(path); + } + else + { + var file = _gameData.GetFile(path); + writable = file == null ? null : new RawGameFileWritable(file); + } + + _quickImportWritables.Add(resourceNode.FullPath, writable); + } + + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Save.ToIconString(), buttonSize, "Export this file.", + resourceNode.FullPath.FullName.Length == 0 || writable == null, true)) + { + var fullPathStr = resourceNode.FullPath.FullName; + var ext = resourceNode.PossibleGamePaths.Length == 1 + ? Path.GetExtension(resourceNode.GamePath.ToString()) + : Path.GetExtension(fullPathStr); + _fileDialog.OpenSavePicker($"Export {Path.GetFileName(fullPathStr)} to...", ext, Path.GetFileNameWithoutExtension(fullPathStr), ext, + (success, name) => + { + if (!success) + return; + + try + { + _editor.Compactor.WriteAllBytes(name, writable!.Write()); + } + catch (Exception e) + { + Penumbra.Log.Error($"Could not export {fullPathStr}:\n{e}"); + } + }, null, false); + } + ImGui.SameLine(); if (!_quickImportActions!.TryGetValue((resourceNode.GamePath, writable), out var quickImport)) { @@ -67,18 +109,32 @@ public partial class ModEditWindow _quickImportActions.Add((resourceNode.GamePath, writable), quickImport); } - var canQuickImport = quickImport.CanExecute; - var quickImportEnabled = canQuickImport && (!resourceNode.Protected || _config.DeleteModModifier.IsActive()); - if (ImUtf8.IconButton(FontAwesomeIcon.FileImport, - $"Add a copy of this file to {quickImport.OptionName}.{(canQuickImport && !quickImportEnabled ? $"\nHold {_config.DeleteModModifier} while clicking to add." : string.Empty)}", - buttonSize, - !quickImportEnabled)) + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.FileImport.ToIconString(), buttonSize, + $"Add a copy of this file to {quickImport.OptionName}.", !quickImport.CanExecute, true)) { quickImport.Execute(); _quickImportActions.Remove((resourceNode.GamePath, writable)); } } + private record class RawFileWritable(string Path) : IWritable + { + public bool Valid + => true; + + public byte[] Write() + => File.ReadAllBytes(Path); + } + + private record class RawGameFileWritable(FileResource FileResource) : IWritable + { + public bool Valid + => true; + + public byte[] Write() + => FileResource.Data; + } + public class QuickImportAction { public const string FallbackOptionName = "the current option"; @@ -128,19 +184,19 @@ public partial class ModEditWindow public static QuickImportAction Prepare(ModEditWindow owner, Utf8GamePath gamePath, IWritable? file) { var editor = owner._editor; - if (editor is null) + if (editor == null) return new QuickImportAction(owner._editor, FallbackOptionName, gamePath); var subMod = editor.Option!; var optionName = subMod is IModOption o ? o.FullName : FallbackOptionName; - if (gamePath.IsEmpty || file is null || editor.FileEditor.Changes) + if (gamePath.IsEmpty || file == null || editor.FileEditor.Changes) return new QuickImportAction(editor, optionName, gamePath); if (subMod.Files.ContainsKey(gamePath) || subMod.FileSwaps.ContainsKey(gamePath)) return new QuickImportAction(editor, optionName, gamePath); var mod = owner.Mod; - if (mod is null) + if (mod == null) return new QuickImportAction(editor, optionName, gamePath); var (preferredPath, subDirs) = GetPreferredPath(mod, subMod as IModOption, owner._config.ReplaceNonAsciiOnImport); @@ -175,7 +231,7 @@ public partial class ModEditWindow { var path = mod.ModPath; var subDirs = 0; - if (subMod is null) + if (subMod == null) return (path, subDirs); var name = subMod.Name; diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.ShaderPackages.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.ShaderPackages.cs index baaf4a82..070895b5 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.ShaderPackages.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.ShaderPackages.cs @@ -1,6 +1,7 @@ +using Dalamud.Interface.Internal.Notifications; using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; +using ImGuiNET; +using Lumina.Misc; using OtterGui.Raii; using OtterGui; using OtterGui.Classes; @@ -10,15 +11,12 @@ using Penumbra.GameData.Interop; using Penumbra.String; using static Penumbra.GameData.Files.ShpkFile; using OtterGui.Widgets; -using OtterGui.Text; -using Penumbra.GameData.Structs; -using OtterGui.Extensions; namespace Penumbra.UI.AdvancedWindow; public partial class ModEditWindow { - private static readonly CiByteString DisassemblyLabel = CiByteString.FromSpanUnsafe("##disassembly"u8, true, true, true); + private static readonly ByteString DisassemblyLabel = ByteString.FromSpanUnsafe("##disassembly"u8, true, true, true); private readonly FileEditor _shaderPackageTab; @@ -26,9 +24,6 @@ public partial class ModEditWindow { DrawShaderPackageSummary(file); - ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); - DrawShaderPackageFilterSection(file); - var ret = false; ImGui.Dummy(new Vector2(ImGui.GetTextLineHeight() / 2)); ret |= DrawShaderPackageShaderArray(file, "Vertex Shader", file.Shpk.VertexShaders, disabled); @@ -55,18 +50,21 @@ public partial class ModEditWindow private static void DrawShaderPackageSummary(ShpkTab tab) { - if (tab.Shpk.IsLegacy) - ImUtf8.Text("This legacy shader package will not work in the current version of the game. Do not attempt to load it.", - ImGuiUtil.HalfBlendText(0x80u)); // Half red - ImUtf8.Text(tab.Header); + ImGui.TextUnformatted(tab.Header); if (!tab.Shpk.Disassembled) - ImUtf8.Text("Your system doesn't support disassembling shaders. Some functionality will be missing.", - ImGuiUtil.HalfBlendText(0x80u)); // Half red + { + var textColor = ImGui.GetColorU32(ImGuiCol.Text); + var textColorWarning = (textColor & 0xFF000000u) | ((textColor & 0x00FEFEFE) >> 1) | 0x80u; // Half red + + using var c = ImRaii.PushColor(ImGuiCol.Text, textColorWarning); + + ImGui.TextUnformatted("Your system doesn't support disassembling shaders. Some functionality will be missing."); + } } private static void DrawShaderExportButton(ShpkTab tab, string objectName, Shader shader, int idx) { - if (!ImUtf8.Button($"Export Shader Program Blob ({shader.Blob.Length} bytes)")) + if (!ImGui.Button($"Export Shader Program Blob ({shader.Blob.Length} bytes)")) return; var defaultName = objectName[0] switch @@ -102,7 +100,7 @@ public partial class ModEditWindow private static void DrawShaderImportButton(ShpkTab tab, string objectName, Shader[] shaders, int idx) { - if (!ImUtf8.Button("Replace Shader Program Blob"u8)) + if (!ImGui.Button("Replace Shader Program Blob")) return; tab.FileDialog.OpenFilePicker($"Replace {objectName} #{idx} Program Blob...", "Shader Program Blobs{.o,.cso,.dxbc,.dxil}", @@ -125,7 +123,6 @@ public partial class ModEditWindow { shaders[idx].UpdateResources(tab.Shpk); tab.Shpk.UpdateResources(); - tab.UpdateFilteredUsed(); } catch (Exception e) { @@ -141,125 +138,27 @@ public partial class ModEditWindow private static unsafe void DrawRawDisassembly(Shader shader) { - using var tree = ImUtf8.TreeNode("Raw Program Disassembly"u8); - if (!tree) + using var t2 = ImRaii.TreeNode("Raw Program Disassembly"); + if (!t2) return; using var font = ImRaii.PushFont(UiBuilder.MonoFont); var size = new Vector2(ImGui.GetContentRegionAvail().X, ImGui.GetTextLineHeight() * 20); - ImGuiNative.InputTextMultiline(DisassemblyLabel.Path, shader.Disassembly!.RawDisassembly.Path, + ImGuiNative.igInputTextMultiline(DisassemblyLabel.Path, shader.Disassembly!.RawDisassembly.Path, (uint)shader.Disassembly!.RawDisassembly.Length + 1, size, ImGuiInputTextFlags.ReadOnly, null, null); } - private static void DrawShaderUsage(ShpkTab tab, Shader shader) - { - using (var node = ImUtf8.TreeNode("Used with Shader Keys"u8)) - { - if (node) - { - foreach (var (key, keyIdx) in shader.SystemValues!.WithIndex()) - { - ImUtf8.TreeNode( - $"Used with System Key {tab.TryResolveName(tab.Shpk.SystemKeys[keyIdx].Id)} \u2208 {{ {tab.NameSetToString(key)} }}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - - foreach (var (key, keyIdx) in shader.SceneValues!.WithIndex()) - { - ImUtf8.TreeNode( - $"Used with Scene Key {tab.TryResolveName(tab.Shpk.SceneKeys[keyIdx].Id)} \u2208 {{ {tab.NameSetToString(key)} }}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - - foreach (var (key, keyIdx) in shader.MaterialValues!.WithIndex()) - { - ImUtf8.TreeNode( - $"Used with Material Key {tab.TryResolveName(tab.Shpk.MaterialKeys[keyIdx].Id)} \u2208 {{ {tab.NameSetToString(key)} }}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - - foreach (var (key, keyIdx) in shader.SubViewValues!.WithIndex()) - { - ImUtf8.TreeNode($"Used with Sub-View Key #{keyIdx} \u2208 {{ {tab.NameSetToString(key)} }}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - } - } - - ImUtf8.TreeNode($"Used in Passes: {tab.NameSetToString(shader.Passes)}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - - private static void DrawShaderPackageFilterSection(ShpkTab tab) - { - if (!ImUtf8.CollapsingHeader(tab.FilterPopCount == tab.FilterMaximumPopCount ? "Filters###Filters"u8 : "Filters (ACTIVE)###Filters"u8)) - return; - - foreach (var (key, keyIdx) in tab.Shpk.SystemKeys.WithIndex()) - DrawShaderPackageFilterSet(tab, $"System Key {tab.TryResolveName(key.Id)}", ref tab.FilterSystemValues[keyIdx]); - - foreach (var (key, keyIdx) in tab.Shpk.SceneKeys.WithIndex()) - DrawShaderPackageFilterSet(tab, $"Scene Key {tab.TryResolveName(key.Id)}", ref tab.FilterSceneValues[keyIdx]); - - foreach (var (key, keyIdx) in tab.Shpk.MaterialKeys.WithIndex()) - DrawShaderPackageFilterSet(tab, $"Material Key {tab.TryResolveName(key.Id)}", ref tab.FilterMaterialValues[keyIdx]); - - foreach (var (_, keyIdx) in tab.Shpk.SubViewKeys.WithIndex()) - DrawShaderPackageFilterSet(tab, $"Sub-View Key #{keyIdx}", ref tab.FilterSubViewValues[keyIdx]); - - DrawShaderPackageFilterSet(tab, "Passes", ref tab.FilterPasses); - } - - private static void DrawShaderPackageFilterSet(ShpkTab tab, string label, ref SharedSet values) - { - if (values.PossibleValues == null) - { - ImUtf8.TreeNode(label, ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - return; - } - - using var node = ImUtf8.TreeNode(label); - if (!node) - return; - - foreach (var value in values.PossibleValues) - { - var contains = values.Contains(value); - if (!ImUtf8.Checkbox($"{tab.TryResolveName(value)}", ref contains)) - continue; - - if (contains) - { - if (values.AddExisting(value)) - { - ++tab.FilterPopCount; - tab.UpdateFilteredUsed(); - } - } - else - { - if (values.Remove(value)) - { - --tab.FilterPopCount; - tab.UpdateFilteredUsed(); - } - } - } - } - private static bool DrawShaderPackageShaderArray(ShpkTab tab, string objectName, Shader[] shaders, bool disabled) { - if (shaders.Length == 0 || !ImUtf8.CollapsingHeader($"{objectName}s")) + if (shaders.Length == 0 || !ImGui.CollapsingHeader($"{objectName}s")) return false; var ret = false; for (var idx = 0; idx < shaders.Length; ++idx) { - var shader = shaders[idx]; - if (!tab.IsFilterMatch(shader)) - continue; - - using var t = ImUtf8.TreeNode($"{objectName} #{idx}"); + var shader = shaders[idx]; + using var t = ImRaii.TreeNode($"{objectName} #{idx}"); if (!t) continue; @@ -270,34 +169,30 @@ public partial class ModEditWindow DrawShaderImportButton(tab, objectName, shaders, idx); } - ret |= DrawShaderPackageResourceArray("Constant Buffers", "slot", true, shader.Constants, false, true); - ret |= DrawShaderPackageResourceArray("Samplers", "slot", false, shader.Samplers, false, true); - if (!tab.Shpk.IsLegacy) - ret |= DrawShaderPackageResourceArray("Textures", "slot", false, shader.Textures, false, true); - ret |= DrawShaderPackageResourceArray("Unordered Access Views", "slot", true, shader.Uavs, false, true); + ret |= DrawShaderPackageResourceArray("Constant Buffers", "slot", true, shader.Constants, true); + ret |= DrawShaderPackageResourceArray("Samplers", "slot", false, shader.Samplers, true); + ret |= DrawShaderPackageResourceArray("Unordered Access Views", "slot", true, shader.Uavs, true); if (shader.DeclaredInputs != 0) - ImUtf8.TreeNode($"Declared Inputs: {shader.DeclaredInputs}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); + ImRaii.TreeNode($"Declared Inputs: {shader.DeclaredInputs}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); if (shader.UsedInputs != 0) - ImUtf8.TreeNode($"Used Inputs: {shader.UsedInputs}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); + ImRaii.TreeNode($"Used Inputs: {shader.UsedInputs}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); if (shader.AdditionalHeader.Length > 8) { - using var t2 = ImUtf8.TreeNode($"Additional Header (Size: {shader.AdditionalHeader.Length})###AdditionalHeader"); + using var t2 = ImRaii.TreeNode($"Additional Header (Size: {shader.AdditionalHeader.Length})###AdditionalHeader"); if (t2) Widget.DrawHexViewer(shader.AdditionalHeader); } if (tab.Shpk.Disassembled) DrawRawDisassembly(shader); - - DrawShaderUsage(tab, shader); } return ret; } - private static bool DrawShaderPackageResource(string slotLabel, bool withSize, ref Resource resource, bool hasFilter, bool disabled) + private static bool DrawShaderPackageResource(string slotLabel, bool withSize, ref Resource resource, bool disabled) { var ret = false; if (!disabled) @@ -310,31 +205,16 @@ public partial class ModEditWindow if (resource.Used == null) return ret; - var usedString = UsedComponentString(withSize, false, resource); + var usedString = UsedComponentString(withSize, resource); if (usedString.Length > 0) - { - ImUtf8.TreeNode(hasFilter ? $"Globally Used: {usedString}" : $"Used: {usedString}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - if (hasFilter) - { - var filteredUsedString = UsedComponentString(withSize, true, resource); - if (filteredUsedString.Length > 0) - ImUtf8.TreeNode($"Used within Filters: {filteredUsedString}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet) - .Dispose(); - else - ImUtf8.TreeNode("Unused within Filters"u8, ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } - } + ImRaii.TreeNode($"Used: {usedString}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); else - { - ImUtf8.TreeNode(hasFilter ? "Globally Unused"u8 : "Unused"u8, ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } + ImRaii.TreeNode("Unused", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); return ret; } - private static bool DrawShaderPackageResourceArray(string arrayName, string slotLabel, bool withSize, Resource[] resources, bool hasFilter, - bool disabled) + private static bool DrawShaderPackageResourceArray(string arrayName, string slotLabel, bool withSize, Resource[] resources, bool disabled) { if (resources.Length == 0) return false; @@ -350,10 +230,10 @@ public partial class ModEditWindow var name = $"#{idx}: {buf.Name} (ID: 0x{buf.Id:X8}), {slotLabel}: {buf.Slot}" + (withSize ? $", size: {buf.Size} registers###{idx}: {buf.Name} (ID: 0x{buf.Id:X8})" : string.Empty); using var font = ImRaii.PushFont(UiBuilder.MonoFont); - using var t2 = ImUtf8.TreeNode(name, !disabled || buf.Used != null ? 0 : ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet); - font.Pop(); + using var t2 = ImRaii.TreeNode(name, !disabled || buf.Used != null ? 0 : ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet); + font.Dispose(); if (t2) - ret |= DrawShaderPackageResource(slotLabel, withSize, ref buf, hasFilter, disabled); + ret |= DrawShaderPackageResource(slotLabel, withSize, ref buf, disabled); } return ret; @@ -366,7 +246,7 @@ public partial class ModEditWindow + new Vector2(ImGui.CalcTextSize(label).X + 3 * ImGui.GetStyle().ItemInnerSpacing.X + ImGui.GetFrameHeight(), ImGui.GetStyle().FramePadding.Y); - var ret = ImUtf8.CollapsingHeader(label); + var ret = ImGui.CollapsingHeader(label); ImGui.GetWindowDrawList() .AddText(UiBuilder.DefaultFont, UiBuilder.DefaultFont.FontSize, pos, ImGui.GetColorU32(ImGuiCol.Text), "Layout"); return ret; @@ -379,7 +259,7 @@ public partial class ModEditWindow if (isSizeWellDefined) return true; - ImUtf8.Text(materialParams.HasValue + ImGui.TextUnformatted(materialParams.HasValue ? $"Buffer size mismatch: {file.MaterialParamsSize} bytes ≠ {materialParams.Value.Size} registers ({materialParams.Value.Size << 4} bytes)" : $"Buffer size mismatch: {file.MaterialParamsSize} bytes, not a multiple of 16"); return false; @@ -387,8 +267,8 @@ public partial class ModEditWindow private static bool DrawShaderPackageMaterialMatrix(ShpkTab tab, bool disabled) { - ImUtf8.Text(tab.Shpk.Disassembled - ? "Parameter positions (continuations are grayed out, globally unused values are red, unused values within filters are yellow):" + ImGui.TextUnformatted(tab.Shpk.Disassembled + ? "Parameter positions (continuations are grayed out, unused values are red):" : "Parameter positions (continuations are grayed out):"); using var table = ImRaii.Table("##MaterialParamLayout", 5, @@ -396,14 +276,17 @@ public partial class ModEditWindow if (!table) return false; - ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, 40 * UiHelpers.Scale); - ImGui.TableSetupColumn("x", ImGuiTableColumnFlags.WidthFixed, 250 * UiHelpers.Scale); - ImGui.TableSetupColumn("y", ImGuiTableColumnFlags.WidthFixed, 250 * UiHelpers.Scale); - ImGui.TableSetupColumn("z", ImGuiTableColumnFlags.WidthFixed, 250 * UiHelpers.Scale); - ImGui.TableSetupColumn("w", ImGuiTableColumnFlags.WidthFixed, 250 * UiHelpers.Scale); + ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, 25 * UiHelpers.Scale); + ImGui.TableSetupColumn("x", ImGuiTableColumnFlags.WidthFixed, 100 * UiHelpers.Scale); + ImGui.TableSetupColumn("y", ImGuiTableColumnFlags.WidthFixed, 100 * UiHelpers.Scale); + ImGui.TableSetupColumn("z", ImGuiTableColumnFlags.WidthFixed, 100 * UiHelpers.Scale); + ImGui.TableSetupColumn("w", ImGuiTableColumnFlags.WidthFixed, 100 * UiHelpers.Scale); ImGui.TableHeadersRow(); - var textColorStart = ImGui.GetColorU32(ImGuiCol.Text); + var textColorStart = ImGui.GetColorU32(ImGuiCol.Text); + var textColorCont = (textColorStart & 0x00FFFFFFu) | ((textColorStart & 0xFE000000u) >> 1); // Half opacity + var textColorUnusedStart = (textColorStart & 0xFF000000u) | ((textColorStart & 0x00FEFEFE) >> 1) | 0x80u; // Half red + var textColorUnusedCont = (textColorUnusedStart & 0x00FFFFFFu) | ((textColorUnusedStart & 0xFE000000u) >> 1); var ret = false; for (var i = 0; i < tab.Matrix.GetLength(0); ++i) @@ -413,21 +296,22 @@ public partial class ModEditWindow for (var j = 0; j < 4; ++j) { var (name, tooltip, idx, colorType) = tab.Matrix[i, j]; - var color = textColorStart; - if (!colorType.HasFlag(ShpkTab.ColorType.Used)) - color = ImGuiUtil.HalfBlend(color, 0x80u); // Half red - else if (!colorType.HasFlag(ShpkTab.ColorType.FilteredUsed)) - color = ImGuiUtil.HalfBlend(color, 0x8080u); // Half yellow - if (colorType.HasFlag(ShpkTab.ColorType.Continuation)) - color = ImGuiUtil.HalfTransparent(color); // Half opacity + var color = colorType switch + { + ShpkTab.ColorType.Unused => textColorUnusedStart, + ShpkTab.ColorType.Used => textColorStart, + ShpkTab.ColorType.Continuation => textColorUnusedCont, + ShpkTab.ColorType.Continuation | ShpkTab.ColorType.Used => textColorCont, + _ => textColorStart, + }; using var _ = ImRaii.PushId(i * 4 + j); var deletable = !disabled && idx >= 0; - using (ImRaii.PushFont(UiBuilder.MonoFont, tooltip.Length > 0)) + using (var font = ImRaii.PushFont(UiBuilder.MonoFont, tooltip.Length > 0)) { - using (ImRaii.PushColor(ImGuiCol.Text, color)) + using (var c = ImRaii.PushColor(ImGuiCol.Text, color)) { ImGui.TableNextColumn(); - ImUtf8.Selectable(name); + ImGui.Selectable(name); if (deletable && ImGui.IsItemClicked(ImGuiMouseButton.Right) && ImGui.GetIO().KeyCtrl) { tab.Shpk.MaterialParams = tab.Shpk.MaterialParams.RemoveItems(idx); @@ -436,66 +320,35 @@ public partial class ModEditWindow } } - ImUtf8.HoverTooltip(tooltip); + ImGuiUtil.HoverTooltip(tooltip); } if (deletable) - ImUtf8.HoverTooltip("\nControl + Right-Click to remove."u8); + ImGuiUtil.HoverTooltip("\nControl + Right-Click to remove."); } } return ret; } - private static void DrawShaderPackageMaterialDevkitExport(ShpkTab tab) - { - if (!ImUtf8.Button("Export globally unused parameters as material dev-kit file"u8)) - return; - - tab.FileDialog.OpenSavePicker("Export material dev-kit file", ".json", $"{Path.GetFileNameWithoutExtension(tab.FilePath)}.json", - ".json", DoSave, null, false); - return; - - void DoSave(bool success, string path) - { - if (!success) - return; - - try - { - File.WriteAllText(path, tab.ExportDevkit().ToString()); - } - catch (Exception e) - { - Penumbra.Messager.NotificationMessage(e, $"Could not export dev-kit for {Path.GetFileName(tab.FilePath)} to {path}.", - NotificationType.Error, false); - return; - } - - Penumbra.Messager.NotificationMessage( - $"Material dev-kit file for {Path.GetFileName(tab.FilePath)} exported successfully to {Path.GetFileName(path)}.", - NotificationType.Success, false); - } - } - private static void DrawShaderPackageMisalignedParameters(ShpkTab tab) { - using var t = ImUtf8.TreeNode("Misaligned / Overflowing Parameters"u8); + using var t = ImRaii.TreeNode("Misaligned / Overflowing Parameters"); if (!t) return; using var _ = ImRaii.PushFont(UiBuilder.MonoFont); foreach (var name in tab.MalformedParameters) - ImUtf8.TreeNode(name, ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); + ImRaii.TreeNode(name, ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); } private static void DrawShaderPackageStartCombo(ShpkTab tab) { using var s = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, ImGui.GetStyle().ItemInnerSpacing); - using (ImRaii.PushFont(UiBuilder.MonoFont)) + using (var _ = ImRaii.PushFont(UiBuilder.MonoFont)) { ImGui.SetNextItemWidth(UiHelpers.Scale * 400); - using var c = ImUtf8.Combo("##Start", tab.Orphans[tab.NewMaterialParamStart].Name); + using var c = ImRaii.Combo("##Start", tab.Orphans[tab.NewMaterialParamStart].Name); if (c) foreach (var (start, idx) in tab.Orphans.WithIndex()) { @@ -505,7 +358,7 @@ public partial class ModEditWindow } ImGui.SameLine(); - ImUtf8.Text("Start"u8); + ImGui.TextUnformatted("Start"); } private static void DrawShaderPackageEndCombo(ShpkTab tab) @@ -514,7 +367,7 @@ public partial class ModEditWindow using (var _ = ImRaii.PushFont(UiBuilder.MonoFont)) { ImGui.SetNextItemWidth(UiHelpers.Scale * 400); - using var c = ImUtf8.Combo("##End", tab.Orphans[tab.NewMaterialParamEnd].Name); + using var c = ImRaii.Combo("##End", tab.Orphans[tab.NewMaterialParamEnd].Name); if (c) { var current = tab.Orphans[tab.NewMaterialParamStart].Index; @@ -531,7 +384,7 @@ public partial class ModEditWindow } ImGui.SameLine(); - ImUtf8.Text("End"u8); + ImGui.TextUnformatted("End"); } private static bool DrawShaderPackageNewParameter(ShpkTab tab) @@ -543,24 +396,23 @@ public partial class ModEditWindow DrawShaderPackageEndCombo(tab); ImGui.SetNextItemWidth(UiHelpers.Scale * 400); - var newName = tab.NewMaterialParamName.Value!; - if (ImUtf8.InputText("Name", ref newName)) - tab.NewMaterialParamName = newName; + if (ImGui.InputText("Name", ref tab.NewMaterialParamName, 63)) + tab.NewMaterialParamId = Crc32.Get(tab.NewMaterialParamName, 0xFFFFFFFFu); - var tooltip = tab.UsedIds.Contains(tab.NewMaterialParamName.Crc32) - ? "The ID is already in use. Please choose a different name."u8 - : ""u8; - if (!ImUtf8.ButtonEx($"Add {tab.NewMaterialParamName} (0x{tab.NewMaterialParamName.Crc32:X8})", tooltip, - new Vector2(400 * UiHelpers.Scale, ImGui.GetFrameHeight()), tooltip.Length > 0)) + var tooltip = tab.UsedIds.Contains(tab.NewMaterialParamId) + ? "The ID is already in use. Please choose a different name." + : string.Empty; + if (!ImGuiUtil.DrawDisabledButton($"Add ID 0x{tab.NewMaterialParamId:X8}", new Vector2(400 * UiHelpers.Scale, ImGui.GetFrameHeight()), + tooltip, + tooltip.Length > 0)) return false; tab.Shpk.MaterialParams = tab.Shpk.MaterialParams.AddItem(new MaterialParam { - Id = tab.NewMaterialParamName.Crc32, + Id = tab.NewMaterialParamId, ByteOffset = (ushort)(tab.Orphans[tab.NewMaterialParamStart].Index << 2), ByteSize = (ushort)((tab.NewMaterialParamEnd - tab.NewMaterialParamStart + 1) << 2), }); - tab.AddNameToCache(tab.NewMaterialParamName); tab.Update(); return true; } @@ -582,9 +434,6 @@ public partial class ModEditWindow else if (!disabled && sizeWellDefined) ret |= DrawShaderPackageNewParameter(tab); - if (tab.Shpk.Disassembled) - DrawShaderPackageMaterialDevkitExport(tab); - return ret; } @@ -592,38 +441,34 @@ public partial class ModEditWindow { var ret = false; - if (!ImUtf8.CollapsingHeader("Shader Resources"u8)) + if (!ImGui.CollapsingHeader("Shader Resources")) return false; - var hasFilters = tab.FilterPopCount != tab.FilterMaximumPopCount; - ret |= DrawShaderPackageResourceArray("Constant Buffers", "type", true, tab.Shpk.Constants, hasFilters, disabled); - ret |= DrawShaderPackageResourceArray("Samplers", "type", false, tab.Shpk.Samplers, hasFilters, disabled); - if (!tab.Shpk.IsLegacy) - ret |= DrawShaderPackageResourceArray("Textures", "type", false, tab.Shpk.Textures, hasFilters, disabled); - ret |= DrawShaderPackageResourceArray("Unordered Access Views", "type", false, tab.Shpk.Uavs, hasFilters, disabled); + ret |= DrawShaderPackageResourceArray("Constant Buffers", "type", true, tab.Shpk.Constants, disabled); + ret |= DrawShaderPackageResourceArray("Samplers", "type", false, tab.Shpk.Samplers, disabled); + ret |= DrawShaderPackageResourceArray("Unordered Access Views", "type", false, tab.Shpk.Uavs, disabled); return ret; } - private static void DrawKeyArray(ShpkTab tab, string arrayName, bool withId, IReadOnlyCollection keys) + private static void DrawKeyArray(string arrayName, bool withId, IReadOnlyCollection keys) { if (keys.Count == 0) return; - using var t = ImUtf8.TreeNode(arrayName); + using var t = ImRaii.TreeNode(arrayName); if (!t) return; using var font = ImRaii.PushFont(UiBuilder.MonoFont); foreach (var (key, idx) in keys.WithIndex()) { - using var t2 = ImUtf8.TreeNode(withId ? $"#{idx}: {tab.TryResolveName(key.Id)} (0x{key.Id:X8})" : $"#{idx}"); + using var t2 = ImRaii.TreeNode(withId ? $"#{idx}: ID: 0x{key.Id:X8}" : $"#{idx}"); if (t2) { - ImUtf8.TreeNode($"Default Value: {tab.TryResolveName(key.DefaultValue)} (0x{key.DefaultValue:X8})", + ImRaii.TreeNode($"Default Value: 0x{key.DefaultValue:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); + ImRaii.TreeNode($"Known Values: {string.Join(", ", Array.ConvertAll(key.Values, value => $"0x{value:X8}"))}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - ImUtf8.TreeNode($"Known Values: {tab.NameSetToString(key.Values, true)}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet) - .Dispose(); } } } @@ -633,55 +478,43 @@ public partial class ModEditWindow if (tab.Shpk.Nodes.Length <= 0) return; - using var t = ImUtf8.TreeNode($"Nodes ({tab.Shpk.Nodes.Length})###Nodes"); + using var t = ImRaii.TreeNode($"Nodes ({tab.Shpk.Nodes.Length})###Nodes"); if (!t) return; - using var font = ImRaii.PushFont(UiBuilder.MonoFont); - foreach (var (node, idx) in tab.Shpk.Nodes.WithIndex()) { - if (!tab.IsFilterMatch(node)) - continue; - - using var t2 = ImUtf8.TreeNode($"#{idx:D4}: Selector: 0x{node.Selector:X8}"); + using var font = ImRaii.PushFont(UiBuilder.MonoFont); + using var t2 = ImRaii.TreeNode($"#{idx:D4}: Selector: 0x{node.Selector:X8}"); if (!t2) continue; foreach (var (key, keyIdx) in node.SystemKeys.WithIndex()) { - ImUtf8.TreeNode( - $"System Key {tab.TryResolveName(tab.Shpk.SystemKeys[keyIdx].Id)} = {tab.TryResolveName(key)} / \u2208 {{ {tab.NameSetToString(node.SystemValues![keyIdx])} }}", + ImRaii.TreeNode($"System Key 0x{tab.Shpk.SystemKeys[keyIdx].Id:X8} = 0x{key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); } foreach (var (key, keyIdx) in node.SceneKeys.WithIndex()) { - ImUtf8.TreeNode( - $"Scene Key {tab.TryResolveName(tab.Shpk.SceneKeys[keyIdx].Id)} = {tab.TryResolveName(key)} / \u2208 {{ {tab.NameSetToString(node.SceneValues![keyIdx])} }}", + ImRaii.TreeNode($"Scene Key 0x{tab.Shpk.SceneKeys[keyIdx].Id:X8} = 0x{key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); } foreach (var (key, keyIdx) in node.MaterialKeys.WithIndex()) { - ImUtf8.TreeNode( - $"Material Key {tab.TryResolveName(tab.Shpk.MaterialKeys[keyIdx].Id)} = {tab.TryResolveName(key)} / \u2208 {{ {tab.NameSetToString(node.MaterialValues![keyIdx])} }}", + ImRaii.TreeNode($"Material Key 0x{tab.Shpk.MaterialKeys[keyIdx].Id:X8} = 0x{key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); } foreach (var (key, keyIdx) in node.SubViewKeys.WithIndex()) - { - ImUtf8.TreeNode( - $"Sub-View Key #{keyIdx} = {tab.TryResolveName(key)} / \u2208 {{ {tab.NameSetToString(node.SubViewValues![keyIdx])} }}", - ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - } + ImRaii.TreeNode($"Sub-View Key #{keyIdx} = 0x{key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); - ImUtf8.TreeNode($"Pass Indices: {string.Join(' ', node.PassIndices.Select(c => $"{c:X2}"))}", + ImRaii.TreeNode($"Pass Indices: {string.Join(' ', node.PassIndices.Select(c => $"{c:X2}"))}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); foreach (var (pass, passIdx) in node.Passes.WithIndex()) { - ImUtf8.TreeNode( - $"Pass #{passIdx}: ID: {tab.TryResolveName(pass.Id)}, Vertex Shader #{pass.VertexShader}, Pixel Shader #{pass.PixelShader}", + ImRaii.TreeNode($"Pass #{passIdx}: ID: 0x{pass.Id:X8}, Vertex Shader #{pass.VertexShader}, Pixel Shader #{pass.PixelShader}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet) .Dispose(); } @@ -690,22 +523,22 @@ public partial class ModEditWindow private static void DrawShaderPackageSelection(ShpkTab tab) { - if (!ImUtf8.CollapsingHeader("Shader Selection"u8)) + if (!ImGui.CollapsingHeader("Shader Selection")) return; - DrawKeyArray(tab, "System Keys", true, tab.Shpk.SystemKeys); - DrawKeyArray(tab, "Scene Keys", true, tab.Shpk.SceneKeys); - DrawKeyArray(tab, "Material Keys", true, tab.Shpk.MaterialKeys); - DrawKeyArray(tab, "Sub-View Keys", false, tab.Shpk.SubViewKeys); + DrawKeyArray("System Keys", true, tab.Shpk.SystemKeys); + DrawKeyArray("Scene Keys", true, tab.Shpk.SceneKeys); + DrawKeyArray("Material Keys", true, tab.Shpk.MaterialKeys); + DrawKeyArray("Sub-View Keys", false, tab.Shpk.SubViewKeys); DrawShaderPackageNodes(tab); - using var t = ImUtf8.TreeNode($"Node Selectors ({tab.Shpk.NodeSelectors.Count})###NodeSelectors"); + using var t = ImRaii.TreeNode($"Node Selectors ({tab.Shpk.NodeSelectors.Count})###NodeSelectors"); if (t) { using var font = ImRaii.PushFont(UiBuilder.MonoFont); foreach (var selector in tab.Shpk.NodeSelectors) { - ImUtf8.TreeNode($"#{selector.Value:D4}: Selector: 0x{selector.Key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet) + ImRaii.TreeNode($"#{selector.Value:D4}: Selector: 0x{selector.Key:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet) .Dispose(); } } @@ -713,27 +546,25 @@ public partial class ModEditWindow private static void DrawOtherShaderPackageDetails(ShpkTab tab) { - if (!ImUtf8.CollapsingHeader("Further Content"u8)) + if (!ImGui.CollapsingHeader("Further Content")) return; - ImUtf8.TreeNode($"Version: 0x{tab.Shpk.Version:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); + ImRaii.TreeNode($"Version: 0x{tab.Shpk.Version:X8}", ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet).Dispose(); if (tab.Shpk.AdditionalData.Length > 0) { - using var t = ImUtf8.TreeNode($"Additional Data (Size: {tab.Shpk.AdditionalData.Length})###AdditionalData"); + using var t = ImRaii.TreeNode($"Additional Data (Size: {tab.Shpk.AdditionalData.Length})###AdditionalData"); if (t) Widget.DrawHexViewer(tab.Shpk.AdditionalData); } } - private static string UsedComponentString(bool withSize, bool filtered, in Resource resource) + private static string UsedComponentString(bool withSize, in Resource resource) { - var used = filtered ? resource.FilteredUsed : resource.Used; - var usedDynamically = filtered ? resource.FilteredUsedDynamically : resource.UsedDynamically; - var sb = new StringBuilder(256); + var sb = new StringBuilder(256); if (withSize) { - foreach (var (components, i) in (used ?? Array.Empty()).WithIndex()) + foreach (var (components, i) in (resource.Used ?? Array.Empty()).WithIndex()) { switch (components) { @@ -751,7 +582,7 @@ public partial class ModEditWindow } } - switch (usedDynamically ?? 0) + switch (resource.UsedDynamically ?? 0) { case 0: break; case DisassembledShader.VectorComponents.All: @@ -759,7 +590,7 @@ public partial class ModEditWindow break; default: sb.Append("[*]."); - foreach (var c in usedDynamically!.Value.ToString().Where(char.IsUpper)) + foreach (var c in resource.UsedDynamically!.Value.ToString().Where(char.IsUpper)) sb.Append(char.ToLower(c)); sb.Append(", "); @@ -768,7 +599,7 @@ public partial class ModEditWindow } else { - var components = (used is { Length: > 0 } ? used[0] : 0) | (usedDynamically ?? 0); + var components = (resource.Used is { Length: > 0 } ? resource.Used[0] : 0) | (resource.UsedDynamically ?? 0); if ((components & DisassembledShader.VectorComponents.X) != 0) sb.Append("Red, "); diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.ShpkTab.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.ShpkTab.cs index 6c2953e0..12b8d761 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.ShpkTab.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.ShpkTab.cs @@ -1,12 +1,9 @@ using Dalamud.Utility; -using Newtonsoft.Json.Linq; -using OtterGui.Classes; -using OtterGui.Extensions; +using Lumina.Misc; +using OtterGui; +using Penumbra.GameData.Data; using Penumbra.GameData.Files; -using Penumbra.GameData.Files.ShaderStructs; using Penumbra.GameData.Interop; -using Penumbra.GameData.Structs; -using Penumbra.UI.AdvancedWindow.Materials; namespace Penumbra.UI.AdvancedWindow; @@ -15,27 +12,18 @@ public partial class ModEditWindow private class ShpkTab : IWritable { public readonly ShpkFile Shpk; - public readonly string FilePath; - public Name NewMaterialParamName = string.Empty; - public short NewMaterialParamStart; - public short NewMaterialParamEnd; - - public readonly SharedSet[] FilterSystemValues; - public readonly SharedSet[] FilterSceneValues; - public readonly SharedSet[] FilterMaterialValues; - public readonly SharedSet[] FilterSubViewValues; - public SharedSet FilterPasses; - - public readonly int FilterMaximumPopCount; - public int FilterPopCount; + public string NewMaterialParamName = string.Empty; + public uint NewMaterialParamId = Crc32.Get(string.Empty, 0xFFFFFFFFu); + public short NewMaterialParamStart; + public short NewMaterialParamEnd; public readonly FileDialogService FileDialog; public readonly string Header; public readonly string Extension; - public ShpkTab(FileDialogService fileDialog, byte[] bytes, string filePath) + public ShpkTab(FileDialogService fileDialog, byte[] bytes) { FileDialog = fileDialog; try @@ -47,8 +35,6 @@ public partial class ModEditWindow Shpk = new ShpkFile(bytes, false); } - FilePath = filePath; - Header = $"Shader Package for DirectX {(int)Shpk.DirectXVersion}"; Extension = Shpk.DirectXVersion switch { @@ -56,36 +42,15 @@ public partial class ModEditWindow ShpkFile.DxVersion.DirectX11 => ".dxbc", _ => throw new NotImplementedException(), }; - - FilterSystemValues = Array.ConvertAll(Shpk.SystemKeys, key => key.Values.FullSet()); - FilterSceneValues = Array.ConvertAll(Shpk.SceneKeys, key => key.Values.FullSet()); - FilterMaterialValues = Array.ConvertAll(Shpk.MaterialKeys, key => key.Values.FullSet()); - FilterSubViewValues = Array.ConvertAll(Shpk.SubViewKeys, key => key.Values.FullSet()); - FilterPasses = Shpk.Passes.FullSet(); - - FilterMaximumPopCount = FilterPasses.Count; - foreach (var key in Shpk.SystemKeys) - FilterMaximumPopCount += key.Values.Count; - foreach (var key in Shpk.SceneKeys) - FilterMaximumPopCount += key.Values.Count; - foreach (var key in Shpk.MaterialKeys) - FilterMaximumPopCount += key.Values.Count; - foreach (var key in Shpk.SubViewKeys) - FilterMaximumPopCount += key.Values.Count; - - FilterPopCount = FilterMaximumPopCount; - - UpdateNameCache(); - Shpk.UpdateFilteredUsed(IsFilterMatch); Update(); } [Flags] public enum ColorType : byte { + Unused = 0, Used = 1, - FilteredUsed = 2, - Continuation = 4, + Continuation = 2, } public (string Name, string Tooltip, short Index, ColorType Color)[,] Matrix = null!; @@ -93,89 +58,10 @@ public partial class ModEditWindow public readonly HashSet UsedIds = new(16); public readonly List<(string Name, short Index)> Orphans = new(16); - private readonly Dictionary _nameCache = []; - private readonly Dictionary, string> _nameSetCache = []; - private readonly Dictionary, string> _nameSetWithIdsCache = []; - - public void AddNameToCache(Name name) - { - if (name.Value != null) - _nameCache.TryAdd(name.Crc32, name); - - _nameSetCache.Clear(); - _nameSetWithIdsCache.Clear(); - } - - private void UpdateNameCache() - { - CollectResourceNames(_nameCache, Shpk.Constants); - CollectResourceNames(_nameCache, Shpk.Samplers); - CollectResourceNames(_nameCache, Shpk.Textures); - CollectResourceNames(_nameCache, Shpk.Uavs); - - CollectKeyNames(_nameCache, Shpk.SystemKeys); - CollectKeyNames(_nameCache, Shpk.SceneKeys); - CollectKeyNames(_nameCache, Shpk.MaterialKeys); - CollectKeyNames(_nameCache, Shpk.SubViewKeys); - - _nameSetCache.Clear(); - _nameSetWithIdsCache.Clear(); - return; - - static void CollectKeyNames(Dictionary nameCache, ShpkFile.Key[] keys) - { - foreach (var key in keys) - { - var keyName = nameCache.TryResolve(Names.KnownNames, key.Id); - var valueNames = keyName.WithKnownSuffixes(); - foreach (var value in key.Values) - { - var valueName = valueNames.TryResolve(value); - if (valueName.Value != null) - nameCache.TryAdd(value, valueName); - } - } - } - - static void CollectResourceNames(Dictionary nameCache, ShpkFile.Resource[] resources) - { - foreach (var resource in resources) - nameCache.TryAdd(resource.Id, resource.Name); - } - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - public Name TryResolveName(uint crc32) - => _nameCache.TryResolve(Names.KnownNames, crc32); - - public string NameSetToString(SharedSet nameSet, bool withIds = false) - { - var cache = withIds ? _nameSetWithIdsCache : _nameSetCache; - if (cache.TryGetValue(nameSet, out var nameSetStr)) - return nameSetStr; - - if (withIds) - nameSetStr = string.Join(", ", nameSet.Select(id => $"{TryResolveName(id)} (0x{id:X8})")); - else - nameSetStr = string.Join(", ", nameSet.Select(TryResolveName)); - cache.Add(nameSet, nameSetStr); - return nameSetStr; - } - - public void UpdateFilteredUsed() - { - Shpk.UpdateFilteredUsed(IsFilterMatch); - - var materialParams = Shpk.GetConstantById(ShpkFile.MaterialParamsConstantId); - UpdateColors(materialParams); - } - public void Update() { var materialParams = Shpk.GetConstantById(ShpkFile.MaterialParamsConstantId); var numParameters = ((Shpk.MaterialParamsSize + 0xFu) & ~0xFu) >> 4; - var defaults = Shpk.MaterialParamsDefaults != null ? (ReadOnlySpan)Shpk.MaterialParamsDefaults : []; - var defaultFloats = MemoryMarshal.Cast(defaults); Matrix = new (string Name, string Tooltip, short Index, ColorType Color)[numParameters, 4]; MalformedParameters.Clear(); @@ -189,15 +75,14 @@ public partial class ModEditWindow var jEnd = ((param.ByteOffset + param.ByteSize - 1) >> 2) & 3; if ((param.ByteOffset & 0x3) != 0 || (param.ByteSize & 0x3) != 0) { - MalformedParameters.Add( - $"ID: {TryResolveName(param.Id)} (0x{param.Id:X8}), offset: 0x{param.ByteOffset:X4}, size: 0x{param.ByteSize:X4}"); + MalformedParameters.Add($"ID: 0x{param.Id:X8}, offset: 0x{param.ByteOffset:X4}, size: 0x{param.ByteSize:X4}"); continue; } if (iEnd >= numParameters) { MalformedParameters.Add( - $"{MtrlTab.MaterialParamRangeName(materialParams?.Name ?? string.Empty, param.ByteOffset >> 2, param.ByteSize >> 2)} ({TryResolveName(param.Id)}, 0x{param.Id:X8})"); + $"{MaterialParamRangeName(materialParams?.Name ?? string.Empty, param.ByteOffset >> 2, param.ByteSize >> 2)} (ID: 0x{param.Id:X8})"); continue; } @@ -206,13 +91,9 @@ public partial class ModEditWindow var end = i == iEnd ? jEnd : 3; for (var j = i == iStart ? jStart : 0; j <= end; ++j) { - var component = (i << 2) | j; var tt = - $"{MtrlTab.MaterialParamRangeName(materialParams?.Name ?? string.Empty, param.ByteOffset >> 2, param.ByteSize >> 2).Item1} ({TryResolveName(param.Id)}, 0x{param.Id:X8})"; - if (component < defaultFloats.Length) - tt += - $"\n\nDefault value: {defaultFloats[component]} ({defaults[component << 2]:X2} {defaults[(component << 2) | 1]:X2} {defaults[(component << 2) | 2]:X2} {defaults[(component << 2) | 3]:X2})"; - Matrix[i, j] = (TryResolveName(param.Id).ToString(), tt, (short)idx, 0); + $"{MaterialParamRangeName(materialParams?.Name ?? string.Empty, param.ByteOffset >> 2, param.ByteSize >> 2).Item1} (ID: 0x{param.Id:X8})"; + Matrix[i, j] = ($"0x{param.Id:X8}", tt, (short)idx, 0); } } } @@ -270,8 +151,7 @@ public partial class ModEditWindow if (oldStart == linear) newMaterialParamStart = (short)Orphans.Count; - Orphans.Add(($"{materialParams?.Name ?? ShpkFile.MaterialParamsConstantName}{MtrlTab.MaterialParamName(false, linear)}", - linear)); + Orphans.Add(($"{materialParams?.Name ?? string.Empty}{MaterialParamName(false, linear)}", linear)); } } @@ -288,15 +168,11 @@ public partial class ModEditWindow { var usedComponents = (materialParams?.Used?[i] ?? DisassembledShader.VectorComponents.All) | (materialParams?.UsedDynamically ?? 0); - var filteredUsedComponents = (materialParams?.FilteredUsed?[i] ?? DisassembledShader.VectorComponents.All) - | (materialParams?.FilteredUsedDynamically ?? 0); for (var j = 0; j < 4; ++j) { - ColorType color = 0; - if (((byte)usedComponents & (1 << j)) != 0) - color |= ColorType.Used; - if (((byte)filteredUsedComponents & (1 << j)) != 0) - color |= ColorType.FilteredUsed; + var color = ((byte)usedComponents & (1 << j)) != 0 + ? ColorType.Used + : 0; if (Matrix[i, j].Index == lastIndex || Matrix[i, j].Index < 0) color |= ColorType.Continuation; @@ -306,137 +182,6 @@ public partial class ModEditWindow } } - public bool IsFilterMatch(ShpkFile.Shader shader) - { - if (!FilterPasses.Overlaps(shader.Passes)) - return false; - - for (var i = 0; i < shader.SystemValues!.Length; ++i) - { - if (!FilterSystemValues[i].Overlaps(shader.SystemValues[i])) - return false; - } - - for (var i = 0; i < shader.SceneValues!.Length; ++i) - { - if (!FilterSceneValues[i].Overlaps(shader.SceneValues[i])) - return false; - } - - for (var i = 0; i < shader.MaterialValues!.Length; ++i) - { - if (!FilterMaterialValues[i].Overlaps(shader.MaterialValues[i])) - return false; - } - - for (var i = 0; i < shader.SubViewValues!.Length; ++i) - { - if (!FilterSubViewValues[i].Overlaps(shader.SubViewValues[i])) - return false; - } - - return true; - } - - public bool IsFilterMatch(ShpkFile.Node node) - { - if (!node.Passes.Any(pass => FilterPasses.Contains(pass.Id))) - return false; - - for (var i = 0; i < node.SystemValues!.Length; ++i) - { - if (!FilterSystemValues[i].Overlaps(node.SystemValues[i])) - return false; - } - - for (var i = 0; i < node.SceneValues!.Length; ++i) - { - if (!FilterSceneValues[i].Overlaps(node.SceneValues[i])) - return false; - } - - for (var i = 0; i < node.MaterialValues!.Length; ++i) - { - if (!FilterMaterialValues[i].Overlaps(node.MaterialValues[i])) - return false; - } - - for (var i = 0; i < node.SubViewValues!.Length; ++i) - { - if (!FilterSubViewValues[i].Overlaps(node.SubViewValues[i])) - return false; - } - - return true; - } - - /// - /// Generates a minimal material dev-kit file for the given shader package. - /// - /// This file currently only hides globally unused material constants. - /// - public JObject ExportDevkit() - { - var devkit = new JObject(); - - var maybeMaterialParameter = Shpk.GetConstantById(ShpkFile.MaterialParamsConstantId); - if (maybeMaterialParameter.HasValue) - { - var materialParameter = maybeMaterialParameter.Value; - var materialParameterUsage = new IndexSet(materialParameter.Size << 2, true); - - var used = materialParameter.Used ?? []; - var usedDynamically = materialParameter.UsedDynamically ?? 0; - for (var i = 0; i < used.Length; ++i) - { - for (var j = 0; j < 4; ++j) - { - if (!(used[i] | usedDynamically).HasFlag((DisassembledShader.VectorComponents)(1 << j))) - materialParameterUsage[(i << 2) | j] = false; - } - } - - var dkConstants = new JObject(); - foreach (var param in Shpk.MaterialParams) - { - // Don't handle misaligned parameters. - if ((param.ByteOffset & 0x3) != 0 || (param.ByteSize & 0x3) != 0) - continue; - - var start = param.ByteOffset >> 2; - var length = param.ByteSize >> 2; - - // If the parameter is fully used, don't include it. - if (!materialParameterUsage.Indices(start, length, true).Any()) - continue; - - var unusedSlices = new JArray(); - - if (materialParameterUsage.Indices(start, length).Any()) - foreach (var (rgStart, rgEnd) in materialParameterUsage.Ranges(start, length, true)) - { - unusedSlices.Add(new JObject - { - ["Type"] = "Hidden", - ["Offset"] = rgStart, - ["Length"] = rgEnd - rgStart, - }); - } - else - unusedSlices.Add(new JObject - { - ["Type"] = "Hidden", - }); - - dkConstants[param.Id.ToString()] = unusedSlices; - } - - devkit["Constants"] = dkConstants; - } - - return devkit; - } - public bool Valid => Shpk.Valid; diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.Textures.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.Textures.cs index 34e1e0d4..652ecb49 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.Textures.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.Textures.cs @@ -1,6 +1,5 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; using OtterTex; using Penumbra.Import.Textures; @@ -26,17 +25,11 @@ public partial class ModEditWindow { ("As Is", "Save the current texture with its own format without additional conversion or compression, if possible."), ("RGBA (Uncompressed)", - "Save the current texture as an uncompressed BGRA bitmap.\nThis requires the most space but technically offers the best quality."), - ("BC1 (Simple Compression for Opaque RGB)", - "Save the current texture compressed via BC1/DXT1 compression.\nThis offers a 8:1 compression ratio and is quick with acceptable quality, but only supports RGB, without Alpha.\n\nCan be used for diffuse maps and equipment textures to save extra space."), - ("BC3 (Simple Compression for RGBA)", - "Save the current texture compressed via BC3/DXT5 compression.\nThis offers a 4:1 compression ratio and is quick with acceptable quality, and fully supports RGBA.\n\nGeneric format that can be used for most textures."), - ("BC4 (Simple Compression for Opaque Grayscale)", - "Save the current texture compressed via BC4 compression.\nThis offers a 8:1 compression ratio and has almost indistinguishable quality, but only supports Grayscale, without Alpha.\n\nCan be used for face paints and legacy marks."), - ("BC5 (Simple Compression for Opaque RG)", - "Save the current texture compressed via BC5 compression.\nThis offers a 4:1 compression ratio and has almost indistinguishable quality, but only supports RG, without B or Alpha.\n\nRecommended for index maps, unrecommended for normal maps."), - ("BC7 (Complex Compression for RGBA)", - "Save the current texture compressed via BC7 compression.\nThis offers a 4:1 compression ratio and has almost indistinguishable quality, but may take a while.\n\nGeneric format that can be used for most textures."), + "Save the current texture as an uncompressed BGRA bitmap. This requires the most space but technically offers the best quality."), + ("BC3 (Simple Compression)", + "Save the current texture compressed via BC3/DXT5 compression. This offers a 4:1 compression ratio and is quick with acceptable quality."), + ("BC7 (Complex Compression)", + "Save the current texture compressed via BC7 compression. This offers a 4:1 compression ratio and has almost indistinguishable quality, but may take a while."), }; private void DrawInputChild(string label, Texture tex, Vector2 size, Vector2 imageSize) @@ -92,7 +85,7 @@ public partial class ModEditWindow ImGuiUtil.SelectableHelpMarker(newDesc); } - } + } private void RedrawOnSaveBox() { @@ -135,13 +128,12 @@ public partial class ModEditWindow ? "This saves the texture in place. This is not revertible." : $"This saves the texture in place. This is not revertible. Hold {_config.DeleteModModifier} to save."; - var buttonSize2 = new Vector2((ImGui.GetContentRegionAvail().X - ImGui.GetStyle().ItemSpacing.X) / 2, 0); - var buttonSize3 = new Vector2((ImGui.GetContentRegionAvail().X - ImGui.GetStyle().ItemSpacing.X * 2) / 3, 0); + var buttonSize2 = new Vector2((ImGui.GetContentRegionAvail().X - ImGui.GetStyle().ItemSpacing.X) / 2, 0); if (ImGuiUtil.DrawDisabledButton("Save in place", buttonSize2, tt, !isActive || !canSaveInPlace || _center.IsLeftCopy && _currentSaveAs == (int)CombinedTexture.TextureSaveType.AsIs)) { _center.SaveAs(_left.Type, _textures, _left.Path, (CombinedTexture.TextureSaveType)_currentSaveAs, _addMipMaps); - AddChangeTask(_left.Path); + InvokeChange(Mod, _left.Path); AddReloadTask(_left.Path, false); } @@ -149,24 +141,23 @@ public partial class ModEditWindow if (ImGui.Button("Save as TEX", buttonSize2)) OpenSaveAsDialog(".tex"); - if (ImGui.Button("Export as TGA", buttonSize3)) - OpenSaveAsDialog(".tga"); - ImGui.SameLine(); - if (ImGui.Button("Export as PNG", buttonSize3)) + if (ImGui.Button("Export as PNG", buttonSize2)) OpenSaveAsDialog(".png"); ImGui.SameLine(); - if (ImGui.Button("Export as DDS", buttonSize3)) + if (ImGui.Button("Export as DDS", buttonSize2)) OpenSaveAsDialog(".dds"); + ImGui.NewLine(); var canConvertInPlace = canSaveInPlace && _left.Type is TextureType.Tex && _center.IsLeftCopy; + var buttonSize3 = new Vector2((ImGui.GetContentRegionAvail().X - ImGui.GetStyle().ItemSpacing.X * 2) / 3, 0); if (ImGuiUtil.DrawDisabledButton("Convert to BC7", buttonSize3, "This converts the texture to BC7 format in place. This is not revertible.", !canConvertInPlace || _left.Format is DXGIFormat.BC7Typeless or DXGIFormat.BC7UNorm or DXGIFormat.BC7UNormSRGB)) { _center.SaveAsTex(_textures, _left.Path, CombinedTexture.TextureSaveType.BC7, _left.MipMaps > 1); - AddChangeTask(_left.Path); + InvokeChange(Mod, _left.Path); AddReloadTask(_left.Path, false); } @@ -176,7 +167,7 @@ public partial class ModEditWindow !canConvertInPlace || _left.Format is DXGIFormat.BC3Typeless or DXGIFormat.BC3UNorm or DXGIFormat.BC3UNormSRGB)) { _center.SaveAsTex(_textures, _left.Path, CombinedTexture.TextureSaveType.BC3, _left.MipMaps > 1); - AddChangeTask(_left.Path); + InvokeChange(Mod, _left.Path); AddReloadTask(_left.Path, false); } @@ -187,7 +178,7 @@ public partial class ModEditWindow || _left.Format is DXGIFormat.B8G8R8A8UNorm or DXGIFormat.B8G8R8A8Typeless or DXGIFormat.B8G8R8A8UNormSRGB)) { _center.SaveAsTex(_textures, _left.Path, CombinedTexture.TextureSaveType.Bitmap, _left.MipMaps > 1); - AddChangeTask(_left.Path); + InvokeChange(Mod, _left.Path); AddReloadTask(_left.Path, false); } } @@ -235,14 +226,13 @@ public partial class ModEditWindow private void OpenSaveAsDialog(string defaultExtension) { var fileName = Path.GetFileNameWithoutExtension(_left.Path.Length > 0 ? _left.Path : _right.Path); - _fileDialog.OpenSavePicker("Save Texture as TEX, DDS, PNG or TGA...", "Textures{.png,.dds,.tex,.tga},.tex,.dds,.png,.tga", fileName, - defaultExtension, + _fileDialog.OpenSavePicker("Save Texture as TEX, DDS or PNG...", "Textures{.png,.dds,.tex},.tex,.dds,.png", fileName, defaultExtension, (a, b) => { if (a) { _center.SaveAs(null, _textures, b, (CombinedTexture.TextureSaveType)_currentSaveAs, _addMipMaps); - AddChangeTask(b); + InvokeChange(Mod, b); if (b == _left.Path) AddReloadTask(_left.Path, false); else if (b == _right.Path) @@ -252,17 +242,6 @@ public partial class ModEditWindow _forceTextureStartPath = false; } - private void AddChangeTask(string path) - { - _center.SaveTask.ContinueWith(t => - { - if (!t.IsCompletedSuccessfully) - return; - - _framework.RunOnFrameworkThread(() => InvokeChange(Mod, path)); - }, TaskScheduler.Default); - } - private void AddReloadTask(string path, bool right) { _center.SaveTask.ContinueWith(t => @@ -350,6 +329,5 @@ public partial class ModEditWindow ".png", ".dds", ".tex", - ".tga", }; } diff --git a/Penumbra/UI/AdvancedWindow/ModEditWindow.cs b/Penumbra/UI/AdvancedWindow/ModEditWindow.cs index 5a0fb849..6b48a048 100644 --- a/Penumbra/UI/AdvancedWindow/ModEditWindow.cs +++ b/Penumbra/UI/AdvancedWindow/ModEditWindow.cs @@ -4,21 +4,18 @@ using Dalamud.Interface.DragDrop; using Dalamud.Interface.Utility; using Dalamud.Interface.Windowing; using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; -using OtterGui.Log; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Collections.Manager; using Penumbra.Communication; using Penumbra.GameData.Enums; using Penumbra.GameData.Files; +using Penumbra.GameData.Interop; using Penumbra.Import.Models; using Penumbra.Import.Textures; +using Penumbra.Interop.Hooks.Objects; using Penumbra.Interop.ResourceTree; using Penumbra.Meta; using Penumbra.Mods; @@ -28,96 +25,62 @@ using Penumbra.Mods.SubMods; using Penumbra.Services; using Penumbra.String; using Penumbra.String.Classes; -using Penumbra.UI.AdvancedWindow.Materials; -using Penumbra.UI.AdvancedWindow.Meta; using Penumbra.UI.Classes; using Penumbra.Util; using MdlMaterialEditor = Penumbra.Mods.Editor.MdlMaterialEditor; namespace Penumbra.UI.AdvancedWindow; -public partial class ModEditWindow : Window, IDisposable, IUiService +public partial class ModEditWindow : Window, IDisposable { private const string WindowBaseLabel = "###SubModEdit"; - private readonly PerformanceTracker _performance; - private readonly ModEditor _editor; - private readonly Configuration _config; - private readonly ItemSwapTab _itemSwapTab; - private readonly MetaFileManager _metaFileManager; - private readonly ActiveCollections _activeCollections; - private readonly ModMergeTab _modMergeTab; - private readonly CommunicatorService _communicator; - private readonly IDragDropManager _dragDropManager; - private readonly IDataManager _gameData; - private readonly IFramework _framework; - private readonly OptionSelectCombo _optionSelect; + private readonly PerformanceTracker _performance; + private readonly ModEditor _editor; + private readonly Configuration _config; + private readonly ItemSwapTab _itemSwapTab; + private readonly MetaFileManager _metaFileManager; + private readonly ActiveCollections _activeCollections; + private readonly StainService _stainService; + private readonly ModMergeTab _modMergeTab; + private readonly CommunicatorService _communicator; + private readonly IDragDropManager _dragDropManager; + private readonly IDataManager _gameData; + private readonly IFramework _framework; + private readonly ObjectManager _objects; + private readonly CharacterBaseDestructor _characterBaseDestructor; private Vector2 _iconSize = Vector2.Zero; private bool _allowReduplicate; public Mod? Mod { get; private set; } - - public bool IsLoading - { - get - { - lock (_lock) - { - return _editor.IsLoading || _loadingMod is { IsCompleted: false }; - } - } - } - - private readonly object _lock = new(); - private Task? _loadingMod; - - - private void AppendTask(Action run) - { - lock (_lock) - { - if (_loadingMod == null || _loadingMod.IsCompleted) - _loadingMod = Task.Run(run); - else - _loadingMod = _loadingMod.ContinueWith(_ => run()); - } - } - public void ChangeMod(Mod mod) { if (mod == Mod) return; - WindowName = $"{mod.Name} (LOADING){WindowBaseLabel}"; - AppendTask(() => - { - _editor.LoadMod(mod, -1, 0).Wait(); - Mod = mod; + _editor.LoadMod(mod, -1, 0); + Mod = mod; - SizeConstraints = new WindowSizeConstraints - { - MinimumSize = new Vector2(1240, 600), - MaximumSize = 4000 * Vector2.One, - }; - _selectedFiles.Clear(); - _modelTab.Reset(); - _materialTab.Reset(); - _shaderPackageTab.Reset(); - _itemSwapTab.UpdateMod(mod, _activeCollections.Current.GetInheritedSettings(mod.Index).Settings); - UpdateModels(); - _forceTextureStartPath = true; - }); + SizeConstraints = new WindowSizeConstraints + { + MinimumSize = new Vector2(1240, 600), + MaximumSize = 4000 * Vector2.One, + }; + _selectedFiles.Clear(); + _modelTab.Reset(); + _materialTab.Reset(); + _shaderPackageTab.Reset(); + _itemSwapTab.UpdateMod(mod, _activeCollections.Current[mod.Index].Settings); + UpdateModels(); + _forceTextureStartPath = true; } public void ChangeOption(IModDataContainer? subMod) { - AppendTask(() => - { - var (groupIdx, dataIdx) = subMod?.GetDataIndices() ?? (-1, 0); - _editor.LoadOption(groupIdx, dataIdx).Wait(); - }); + var (groupIdx, dataIdx) = subMod?.GetDataIndices() ?? (-1, 0); + _editor.LoadOption(groupIdx, dataIdx); } public void UpdateModels() @@ -131,9 +94,6 @@ public partial class ModEditWindow : Window, IDisposable, IUiService public override void PreDraw() { - if (IsLoading) - return; - using var performance = _performance.Measure(PerformanceType.UiAdvancedWindow); var sb = new StringBuilder(256); @@ -168,7 +128,7 @@ public partial class ModEditWindow : Window, IDisposable, IUiService sb.Append($" | {unused} Unused Files"); if (_editor.Files.Missing.Count > 0) - sb.Append($" | {_editor.Files.Missing.Count} Missing Files"); + sb.Append($" | {_editor.Files.Available.Count} Missing Files"); if (redirections > 0) sb.Append($" | {redirections} Redirections"); @@ -186,16 +146,13 @@ public partial class ModEditWindow : Window, IDisposable, IUiService public override void OnClose() { + _left.Dispose(); + _right.Dispose(); + _materialTab.Reset(); + _modelTab.Reset(); + _shaderPackageTab.Reset(); _config.Ephemeral.AdvancedEditingOpen = false; _config.Ephemeral.Save(); - AppendTask(() => - { - _left.Dispose(); - _right.Dispose(); - _materialTab.Reset(); - _modelTab.Reset(); - _shaderPackageTab.Reset(); - }); } public override void Draw() @@ -208,18 +165,7 @@ public partial class ModEditWindow : Window, IDisposable, IUiService _config.Ephemeral.Save(); } - if (IsLoading) - { - var radius = 100 * ImUtf8.GlobalScale; - var thickness = (int)(20 * ImUtf8.GlobalScale); - var offsetX = ImGui.GetContentRegionAvail().X / 2 - radius; - var offsetY = ImGui.GetContentRegionAvail().Y / 2 - radius; - ImGui.SetCursorPos(ImGui.GetCursorPos() + new Vector2(offsetX, offsetY)); - ImUtf8.Spinner("##spinner"u8, radius, thickness, ImGui.GetColorU32(ImGuiCol.Text)); - return; - } - - using var tabBar = ImUtf8.TabBar("##tabs"u8); + using var tabBar = ImRaii.TabBar("##tabs"); if (!tabBar) return; @@ -229,21 +175,19 @@ public partial class ModEditWindow : Window, IDisposable, IUiService DrawSwapTab(); _modMergeTab.Draw(); DrawDuplicatesTab(); + DrawMaterialReassignmentTab(); DrawQuickImportTab(); _modelTab.Draw(); _materialTab.Draw(); DrawTextureTab(); _shaderPackageTab.Draw(); - using (var tab = ImUtf8.TabItem("Item Swap"u8)) + using (var tab = ImRaii.TabItem("Item Swap")) { if (tab) _itemSwapTab.DrawContent(); } - _pbdTab.Draw(); - DrawMissingFilesTab(); - DrawMaterialReassignmentTab(); } /// A row of three buttonSizes and a help marker that can be used for material suffix changing. @@ -456,29 +400,41 @@ public partial class ModEditWindow : Window, IDisposable, IUiService private bool DrawOptionSelectHeader() { - using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, Vector2.Zero).Push(ImGuiStyleVar.FrameRounding, 0); - var width = new Vector2(ImGui.GetContentRegionAvail().X / 3, 0); - var ret = false; - if (ImUtf8.ButtonEx("Default Option"u8, "Switch to the default option for the mod.\nThis resets unsaved changes."u8, width, + const string defaultOption = "Default Option"; + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, Vector2.Zero).Push(ImGuiStyleVar.FrameRounding, 0); + var width = new Vector2(ImGui.GetContentRegionAvail().X / 3, 0); + var ret = false; + if (ImGuiUtil.DrawDisabledButton(defaultOption, width, "Switch to the default option for the mod.\nThis resets unsaved changes.", _editor.Option is DefaultSubMod)) { - _editor.LoadOption(-1, 0).Wait(); + _editor.LoadOption(-1, 0); ret = true; } ImGui.SameLine(); - if (ImUtf8.ButtonEx("Refresh Data"u8, "Refresh data for the current option.\nThis resets unsaved changes."u8, width)) + if (ImGuiUtil.DrawDisabledButton("Refresh Data", width, "Refresh data for the current option.\nThis resets unsaved changes.", false)) { - _editor.LoadMod(_editor.Mod!, _editor.GroupIdx, _editor.DataIdx).Wait(); + _editor.LoadMod(_editor.Mod!, _editor.GroupIdx, _editor.DataIdx); ret = true; } ImGui.SameLine(); - if (_optionSelect.Draw(width.X)) + ImGui.SetNextItemWidth(width.X); + style.Push(ImGuiStyleVar.FrameBorderSize, ImGuiHelpers.GlobalScale); + using var color = ImRaii.PushColor(ImGuiCol.Border, ColorId.FolderLine.Value()); + using var combo = ImRaii.Combo("##optionSelector", _editor.Option!.GetFullName()); + if (!combo) + return ret; + + foreach (var (option, idx) in Mod!.AllDataContainers.WithIndex()) { - var (groupIdx, dataIdx) = _optionSelect.CurrentSelection.Index; - _editor.LoadOption(groupIdx, dataIdx).Wait(); - ret = true; + using var id = ImRaii.PushId(idx); + if (ImGui.Selectable(option.GetFullName(), option == _editor.Option)) + { + var (groupIdx, dataIdx) = option.GetDataIndices(); + _editor.LoadOption(groupIdx, dataIdx); + ret = true; + } } return ret; @@ -581,7 +537,7 @@ public partial class ModEditWindow : Window, IDisposable, IUiService /// If none exists, goes through all options in the currently selected mod (if any) in order of priority and resolves in them. /// If no redirection is found in either of those options, returns the original path. /// - internal FullPath FindBestMatch(Utf8GamePath path) + private FullPath FindBestMatch(Utf8GamePath path) { var currentFile = _activeCollections.Current.ResolvePath(path); if (currentFile != null) @@ -602,7 +558,7 @@ public partial class ModEditWindow : Window, IDisposable, IUiService return new FullPath(path); } - internal HashSet FindPathsStartingWith(CiByteString prefix) + private HashSet FindPathsStartingWith(ByteString prefix) { var ret = new HashSet(); @@ -627,51 +583,45 @@ public partial class ModEditWindow : Window, IDisposable, IUiService public ModEditWindow(PerformanceTracker performance, FileDialogService fileDialog, ItemSwapTab itemSwapTab, IDataManager gameData, Configuration config, ModEditor editor, ResourceTreeFactory resourceTreeFactory, MetaFileManager metaFileManager, - ActiveCollections activeCollections, ModMergeTab modMergeTab, + StainService stainService, ActiveCollections activeCollections, ModMergeTab modMergeTab, CommunicatorService communicator, TextureManager textures, ModelManager models, IDragDropManager dragDropManager, - ResourceTreeViewerFactory resourceTreeViewerFactory, IFramework framework, - MetaDrawers metaDrawers, MigrationManager migrationManager, - MtrlTabFactory mtrlTabFactory, ModSelection selection) + ChangedItemDrawer changedItemDrawer, ObjectManager objects, IFramework framework, CharacterBaseDestructor characterBaseDestructor) : base(WindowBaseLabel) { - _performance = performance; - _itemSwapTab = itemSwapTab; - _gameData = gameData; - _config = config; - _editor = editor; - _metaFileManager = metaFileManager; - _activeCollections = activeCollections; - _modMergeTab = modMergeTab; - _communicator = communicator; - _dragDropManager = dragDropManager; - _textures = textures; - _models = models; - _fileDialog = fileDialog; - _framework = framework; - _metaDrawers = metaDrawers; - _optionSelect = new OptionSelectCombo(editor, this); + _performance = performance; + _itemSwapTab = itemSwapTab; + _gameData = gameData; + _config = config; + _editor = editor; + _metaFileManager = metaFileManager; + _stainService = stainService; + _activeCollections = activeCollections; + _modMergeTab = modMergeTab; + _communicator = communicator; + _dragDropManager = dragDropManager; + _textures = textures; + _models = models; + _fileDialog = fileDialog; + _objects = objects; + _framework = framework; + _characterBaseDestructor = characterBaseDestructor; _materialTab = new FileEditor(this, _communicator, gameData, config, _editor.Compactor, _fileDialog, "Materials", ".mtrl", () => PopulateIsOnPlayer(_editor.Files.Mtrl, ResourceType.Mtrl), DrawMaterialPanel, () => Mod?.ModPath.FullName ?? string.Empty, - (bytes, path, writable) => mtrlTabFactory.Create(this, new MtrlFile(bytes), path, writable)); + (bytes, path, writable) => new MtrlTab(this, new MtrlFile(bytes), path, writable)); _modelTab = new FileEditor(this, _communicator, gameData, config, _editor.Compactor, _fileDialog, "Models", ".mdl", () => PopulateIsOnPlayer(_editor.Files.Mdl, ResourceType.Mdl), DrawModelPanel, () => Mod?.ModPath.FullName ?? string.Empty, (bytes, path, _) => new MdlTab(this, bytes, path)); _shaderPackageTab = new FileEditor(this, _communicator, gameData, config, _editor.Compactor, _fileDialog, "Shaders", ".shpk", () => PopulateIsOnPlayer(_editor.Files.Shpk, ResourceType.Shpk), DrawShaderPackagePanel, () => Mod?.ModPath.FullName ?? string.Empty, - (bytes, path, _) => new ShpkTab(_fileDialog, bytes, path)); - _pbdTab = new FileEditor(this, _communicator, gameData, config, _editor.Compactor, _fileDialog, "Deformers", ".pbd", - () => _editor.Files.Pbd, DrawDeformerPanel, - () => Mod?.ModPath.FullName ?? string.Empty, - (bytes, path, _) => new PbdTab(bytes, path)); + (bytes, _, _) => new ShpkTab(_fileDialog, bytes)); _center = new CombinedTexture(_left, _right); _textureSelectCombo = new TextureDrawer.PathSelectCombo(textures, editor, () => GetPlayerResourcesOfType(ResourceType.Tex)); _resourceTreeFactory = resourceTreeFactory; - _quickImportViewer = resourceTreeViewerFactory.Create(1, OnQuickImportRefresh, DrawQuickImportActions); + _quickImportViewer = + new ResourceTreeViewer(_config, resourceTreeFactory, changedItemDrawer, 2, OnQuickImportRefresh, DrawQuickImportActions); _communicator.ModPathChanged.Subscribe(OnModPathChange, ModPathChanged.Priority.ModEditWindow); IsOpen = _config is { OpenWindowAtStart: true, Ephemeral.AdvancedEditingOpen: true }; - if (IsOpen && selection.Mod != null) - ChangeMod(selection.Mod); } public void Dispose() diff --git a/Penumbra/UI/AdvancedWindow/ModMergeTab.cs b/Penumbra/UI/AdvancedWindow/ModMergeTab.cs index bf16fa37..5dad66b4 100644 --- a/Penumbra/UI/AdvancedWindow/ModMergeTab.cs +++ b/Penumbra/UI/AdvancedWindow/ModMergeTab.cs @@ -1,10 +1,7 @@ using Dalamud.Interface.Utility; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using Penumbra.Mods.Editor; using Penumbra.Mods.Manager; using Penumbra.Mods.SubMods; @@ -12,7 +9,7 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.AdvancedWindow; -public class ModMergeTab(ModMerger modMerger) : IUiService +public class ModMergeTab(ModMerger modMerger) { private readonly ModCombo _modCombo = new(() => modMerger.ModsWithoutCurrent.ToList()); private string _newModName = string.Empty; @@ -47,30 +44,9 @@ public class ModMergeTab(ModMerger modMerger) : IUiService private void DrawMergeInto(float size) { - using var bigGroup = ImRaii.Group(); - var minComboSize = 300 * ImGuiHelpers.GlobalScale; - var textSize = ImUtf8.CalcTextSize($"Merge {modMerger.MergeFromMod!.Name} into ").X; - + using var bigGroup = ImRaii.Group(); ImGui.AlignTextToFramePadding(); - - using (ImRaii.Group()) - { - ImUtf8.Text("Merge "u8); - ImGui.SameLine(0, 0); - if (size - textSize < minComboSize) - { - ImUtf8.Text("selected mod"u8, ColorId.FolderLine.Value()); - ImUtf8.HoverTooltip(modMerger.MergeFromMod!.Name.Text); - } - else - { - ImUtf8.Text(modMerger.MergeFromMod!.Name.Text, ColorId.FolderLine.Value()); - } - - ImGui.SameLine(0, 0); - ImUtf8.Text(" into"u8); - } - + ImGui.TextUnformatted($"Merge {modMerger.MergeFromMod!.Name} into "); ImGui.SameLine(); DrawCombo(size - ImGui.GetItemRectSize().X - ImGui.GetStyle().ItemSpacing.X); @@ -207,7 +183,7 @@ public class ModMergeTab(ModMerger modMerger) : IUiService else { ImGuiUtil.DrawTableColumn(option.GetName()); - + ImGui.TableNextColumn(); ImGui.Selectable(group.Name, false); if (ImGui.BeginPopupContextItem("##groupContext")) diff --git a/Penumbra/UI/AdvancedWindow/OptionSelectCombo.cs b/Penumbra/UI/AdvancedWindow/OptionSelectCombo.cs deleted file mode 100644 index c9996a1e..00000000 --- a/Penumbra/UI/AdvancedWindow/OptionSelectCombo.cs +++ /dev/null @@ -1,43 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Raii; -using OtterGui.Text; -using OtterGui.Widgets; -using Penumbra.Mods.Editor; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.AdvancedWindow; - -public sealed class OptionSelectCombo(ModEditor editor, ModEditWindow window) - : FilterComboCache<(string FullName, (int Group, int Data) Index)>( - () => window.Mod!.AllDataContainers.Select(c => (c.GetFullName(), c.GetDataIndices())).ToList(), MouseWheelType.Control, Penumbra.Log) -{ - private ImRaii.ColorStyle _border; - - protected override void DrawCombo(string label, string preview, string tooltip, int currentSelected, float previewWidth, float itemHeight, - ImGuiComboFlags flags) - { - _border = ImRaii.PushFrameBorder(ImUtf8.GlobalScale, ColorId.FolderLine.Value()); - base.DrawCombo(label, preview, tooltip, currentSelected, previewWidth, itemHeight, flags); - _border.Dispose(); - } - - protected override void DrawFilter(int currentSelected, float width) - { - _border.Dispose(); - base.DrawFilter(currentSelected, width); - } - - public bool Draw(float width) - { - var flags = window.Mod!.AllDataContainers.Count() switch - { - 0 => ImGuiComboFlags.NoArrowButton, - > 8 => ImGuiComboFlags.HeightLargest, - _ => ImGuiComboFlags.None, - }; - return Draw("##optionSelector", editor.Option!.GetFullName(), string.Empty, width, ImGui.GetTextLineHeight(), flags); - } - - protected override bool DrawSelectable(int globalIdx, bool selected) - => ImUtf8.Selectable(Items[globalIdx].FullName, selected); -} diff --git a/Penumbra/UI/AdvancedWindow/ResourceTreeViewer.cs b/Penumbra/UI/AdvancedWindow/ResourceTreeViewer.cs index ae450bec..d31f3e52 100644 --- a/Penumbra/UI/AdvancedWindow/ResourceTreeViewer.cs +++ b/Penumbra/UI/AdvancedWindow/ResourceTreeViewer.cs @@ -1,60 +1,50 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; -using Dalamud.Interface.Colors; -using Dalamud.Interface.ImGuiNotification; using Dalamud.Interface.Utility; -using Dalamud.Plugin.Services; -using Lumina.Data; -using OtterGui; -using OtterGui.Classes; -using OtterGui.Compression; -using OtterGui.Extensions; +using ImGuiNET; using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.Api.Enums; -using Penumbra.GameData.Files; -using Penumbra.GameData.Structs; +using OtterGui; using Penumbra.Interop.ResourceTree; -using Penumbra.Services; -using Penumbra.String; -using Penumbra.String.Classes; using Penumbra.UI.Classes; namespace Penumbra.UI.AdvancedWindow; -public class ResourceTreeViewer( - Configuration config, - ResourceTreeFactory treeFactory, - ChangedItemDrawer changedItemDrawer, - IncognitoService incognito, - int actionCapacity, - Action onRefresh, - Action drawActions, - CommunicatorService communicator, - PcpService pcpService, - IDataManager gameData, - FileDialogService fileDialog, - FileCompactor compactor) +public class ResourceTreeViewer { private const ResourceTreeFactory.Flags ResourceTreeFactoryFlags = - ResourceTreeFactory.Flags.WithUiData | ResourceTreeFactory.Flags.WithOwnership; + ResourceTreeFactory.Flags.RedactExternalPaths | ResourceTreeFactory.Flags.WithUiData | ResourceTreeFactory.Flags.WithOwnership; - private readonly HashSet _unfolded = []; + private readonly Configuration _config; + private readonly ResourceTreeFactory _treeFactory; + private readonly ChangedItemDrawer _changedItemDrawer; + private readonly int _actionCapacity; + private readonly Action _onRefresh; + private readonly Action _drawActions; + private readonly HashSet _unfolded; - private readonly Dictionary _filterCache = []; - private readonly Dictionary _writableCache = []; - - private TreeCategory _categoryFilter = AllCategories; - private ChangedItemIconFlag _typeFilter = ChangedItemFlagExtensions.AllFlags; - private string _nameFilter = string.Empty; - private string _nodeFilter = string.Empty; - private string _note = string.Empty; + private TreeCategory _categoryFilter; + private ChangedItemDrawer.ChangedItemIcon _typeFilter; + private string _nameFilter; private Task? _task; + public ResourceTreeViewer(Configuration config, ResourceTreeFactory treeFactory, ChangedItemDrawer changedItemDrawer, + int actionCapacity, Action onRefresh, Action drawActions) + { + _config = config; + _treeFactory = treeFactory; + _changedItemDrawer = changedItemDrawer; + _actionCapacity = actionCapacity; + _onRefresh = onRefresh; + _drawActions = drawActions; + _unfolded = new HashSet(); + + _categoryFilter = AllCategories; + _typeFilter = ChangedItemDrawer.AllFlags; + _nameFilter = string.Empty; + } + public void Draw() { - DrawModifiedGameFilesWarning(); DrawControls(); _task ??= RefreshCharacterList(); @@ -75,7 +65,7 @@ public class ResourceTreeViewer( } else if (_task.IsCompletedSuccessfully) { - var debugMode = config.DebugMode; + var debugMode = _config.DebugMode; foreach (var (tree, index) in _task.Result.WithIndex()) { var category = Classify(tree); @@ -84,8 +74,7 @@ public class ResourceTreeViewer( using (var c = ImRaii.PushColor(ImGuiCol.Text, CategoryColor(category).Value())) { - var isOpen = ImGui.CollapsingHeader($"{(incognito.IncognitoMode ? tree.AnonymizedName : tree.Name)}###{index}", - index == 0 ? ImGuiTreeNodeFlags.DefaultOpen : 0); + var isOpen = ImGui.CollapsingHeader($"{tree.Name}##{index}", index == 0 ? ImGuiTreeNodeFlags.DefaultOpen : 0); if (debugMode) { using var _ = ImRaii.PushFont(UiBuilder.MonoFont); @@ -99,30 +88,9 @@ public class ResourceTreeViewer( using var id = ImRaii.PushId(index); - ImUtf8.TextFrameAligned($"Collection: {(incognito.IncognitoMode ? tree.AnonymizedCollectionName : tree.CollectionName)}"); - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Export Character Pack"u8, - "Note that this recomputes the current data of the actor if it still exists, and does not use the cached data."u8)) - { - pcpService.CreatePcp((ObjectIndex)tree.GameObjectIndex, _note).ContinueWith(t => - { + ImGui.TextUnformatted($"Collection: {tree.CollectionName}"); - var (success, text) = t.Result; - - if (success) - Penumbra.Messager.NotificationMessage($"Created {text}.", NotificationType.Success, false); - else - Penumbra.Messager.NotificationMessage(text, NotificationType.Error, false); - }); - _note = string.Empty; - } - - ImUtf8.SameLineInner(); - ImGui.SetNextItemWidth(ImGui.GetContentRegionAvail().X); - ImUtf8.InputText("##note"u8, ref _note, "Export note..."u8); - - - using var table = ImRaii.Table("##ResourceTree", 4, + using var table = ImRaii.Table("##ResourceTree", _actionCapacity > 0 ? 4 : 3, ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); if (!table) continue; @@ -130,33 +98,16 @@ public class ResourceTreeViewer( ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthStretch, 0.2f); ImGui.TableSetupColumn("Game Path", ImGuiTableColumnFlags.WidthStretch, 0.3f); ImGui.TableSetupColumn("Actual Path", ImGuiTableColumnFlags.WidthStretch, 0.5f); - ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, - actionCapacity * 3 * ImGuiHelpers.GlobalScale + (actionCapacity + 1) * ImGui.GetFrameHeight()); + if (_actionCapacity > 0) + ImGui.TableSetupColumn(string.Empty, ImGuiTableColumnFlags.WidthFixed, + (_actionCapacity - 1) * 3 * ImGuiHelpers.GlobalScale + _actionCapacity * ImGui.GetFrameHeight()); ImGui.TableHeadersRow(); - DrawNodes(tree.Nodes, 0, unchecked(tree.DrawObjectAddress * 31), 0); + DrawNodes(tree.Nodes, 0, unchecked(tree.DrawObjectAddress * 31)); } } } - private void DrawModifiedGameFilesWarning() - { - if (!gameData.HasModifiedGameDataFiles) - return; - - using var style = ImRaii.PushColor(ImGuiCol.Text, ImGuiColors.DalamudOrange); - - ImUtf8.TextWrapped( - "Dalamud is reporting your FFXIV installation has modified game files. Any mods installed through TexTools will produce this message."u8); - ImUtf8.TextWrapped("Penumbra and some other plugins assume your FFXIV installation is unmodified in order to work."u8); - ImUtf8.TextWrapped( - "Data displayed here may be inaccurate because of this, which, in turn, can break functionality relying on it, such as Character Pack exports/imports, or mod synchronization functions provided by other plugins."u8); - ImUtf8.TextWrapped( - "Exit the game, open XIVLauncher, click the arrow next to Log In and select \"repair game files\" to resolve this issue. Afterwards, do not install any mods with TexTools. Your plugin configurations will remain, as will mods enabled in Penumbra."u8); - - ImGui.Separator(); - } - private void DrawControls() { var yOffset = (ChangedItemDrawer.TypeFilterIconSize.Y - ImGui.GetFrameHeight()) / 2f; @@ -185,24 +136,10 @@ public class ResourceTreeViewer( ImGui.SameLine(0, checkPadding); - var filterChanged = false; - ImGui.SetCursorPosY(ImGui.GetCursorPosY() - yOffset); - using (ImRaii.Child("##typeFilter", new Vector2(ImGui.GetContentRegionAvail().X, ChangedItemDrawer.TypeFilterIconSize.Y))) - { - filterChanged |= changedItemDrawer.DrawTypeFilter(ref _typeFilter); - } + _changedItemDrawer.DrawTypeFilter(ref _typeFilter, -yOffset); - var fieldWidth = (ImGui.GetContentRegionAvail().X - checkSpacing * 2.0f - ImGui.GetFrameHeightWithSpacing()) / 2.0f; - ImGui.SetNextItemWidth(fieldWidth); - filterChanged |= ImGui.InputTextWithHint("##TreeNameFilter", "Filter by Character/Entity Name...", ref _nameFilter, 128); - ImGui.SameLine(0, checkSpacing); - ImGui.SetNextItemWidth(fieldWidth); - filterChanged |= ImGui.InputTextWithHint("##NodeFilter", "Filter by Item/Part Name or Path...", ref _nodeFilter, 128); - ImGui.SameLine(0, checkSpacing); - incognito.DrawToggle(ImGui.GetFrameHeightWithSpacing()); - - if (filterChanged) - _filterCache.Clear(); + ImGui.SetNextItemWidth(ImGui.GetContentRegionAvail().X); + ImGui.InputTextWithHint("##TreeNameFilter", "Filter by Character/Entity Name...", ref _nameFilter, 128); } private Task RefreshCharacterList() @@ -210,45 +147,56 @@ public class ResourceTreeViewer( { try { - return treeFactory.FromObjectTable(ResourceTreeFactoryFlags) + return _treeFactory.FromObjectTable(ResourceTreeFactoryFlags) .Select(entry => entry.ResourceTree) .ToArray(); } finally { - _filterCache.Clear(); - _writableCache.Clear(); _unfolded.Clear(); - onRefresh(); + _onRefresh(); } }); - private void DrawNodes(IEnumerable resourceNodes, int level, nint pathHash, - ChangedItemIconFlag parentFilterIconFlag) + private void DrawNodes(IEnumerable resourceNodes, int level, nint pathHash) { - var debugMode = config.DebugMode; + var debugMode = _config.DebugMode; var frameHeight = ImGui.GetFrameHeight(); + var cellHeight = _actionCapacity > 0 ? frameHeight : 0.0f; + + NodeVisibility GetNodeVisibility(ResourceNode node) + { + if (node.Internal && !debugMode) + return NodeVisibility.Hidden; + + if (_typeFilter.HasFlag(node.Icon)) + return NodeVisibility.Visible; + if ((_typeFilter & node.DescendentIcons) != 0) + return NodeVisibility.DescendentsOnly; + + return NodeVisibility.Hidden; + } foreach (var (resourceNode, index) in resourceNodes.WithIndex()) { - var nodePathHash = unchecked(pathHash + resourceNode.ResourceHandle); - - var visibility = GetNodeVisibility(nodePathHash, resourceNode, parentFilterIconFlag); + var visibility = GetNodeVisibility(resourceNode); if (visibility == NodeVisibility.Hidden) continue; - using var mutedColor = ImRaii.PushColor(ImGuiCol.Text, ImGuiUtil.HalfTransparentText(), resourceNode.Internal); + var textColor = ImGui.GetColorU32(ImGuiCol.Text); + var textColorInternal = (textColor & 0x00FFFFFFu) | ((textColor & 0xFE000000u) >> 1); // Half opacity - var filterIcon = resourceNode.IconFlag != 0 ? resourceNode.IconFlag : parentFilterIconFlag; + using var mutedColor = ImRaii.PushColor(ImGuiCol.Text, textColorInternal, resourceNode.Internal); + + var nodePathHash = unchecked(pathHash + resourceNode.ResourceHandle); using var id = ImRaii.PushId(index); ImGui.TableNextColumn(); var unfolded = _unfolded.Contains(nodePathHash); using (var indent = ImRaii.PushIndent(level)) { - var hasVisibleChildren = resourceNode.Children.Any(child - => GetNodeVisibility(unchecked(nodePathHash * 31 + child.ResourceHandle), child, filterIcon) != NodeVisibility.Hidden); - var unfoldable = hasVisibleChildren && visibility != NodeVisibility.DescendentsOnly; + var hasVisibleChildren = resourceNode.Children.Any(child => GetNodeVisibility(child) != NodeVisibility.Hidden); + var unfoldable = hasVisibleChildren && visibility != NodeVisibility.DescendentsOnly; if (unfoldable) { using var font = ImRaii.PushFont(UiBuilder.IconFont); @@ -270,7 +218,7 @@ public class ResourceTreeViewer( ImGui.SameLine(0f, ImGui.GetStyle().ItemInnerSpacing.X); } - changedItemDrawer.DrawCategoryIcon(resourceNode.IconFlag); + _changedItemDrawer.DrawCategoryIcon(resourceNode.Icon); ImGui.SameLine(0f, ImGui.GetStyle().ItemInnerSpacing.X); ImGui.TableHeader(resourceNode.Name); if (ImGui.IsItemClicked() && unfoldable) @@ -297,7 +245,7 @@ public class ResourceTreeViewer( 0 => "(none)", 1 => resourceNode.GamePath.ToString(), _ => "(multiple)", - }, false, hasGamePaths ? 0 : ImGuiSelectableFlags.Disabled, new Vector2(ImGui.GetContentRegionAvail().X, frameHeight)); + }, false, hasGamePaths ? 0 : ImGuiSelectableFlags.Disabled, new Vector2(ImGui.GetContentRegionAvail().X, cellHeight)); if (hasGamePaths) { var allPaths = string.Join('\n', resourceNode.PossibleGamePaths); @@ -309,178 +257,33 @@ public class ResourceTreeViewer( ImGui.TableNextColumn(); if (resourceNode.FullPath.FullName.Length > 0) { - var hasMod = resourceNode.Mod.TryGetTarget(out var mod); - if (resourceNode is { ModName: not null, ModRelativePath: not null }) - { - var modName = $"[{(hasMod ? mod!.Name : resourceNode.ModName)}]"; - var textPos = ImGui.GetCursorPosX() + ImUtf8.CalcTextSize(modName).X + ImGui.GetStyle().ItemInnerSpacing.X; - using var group = ImUtf8.Group(); - using (var color = ImRaii.PushColor(ImGuiCol.Text, (hasMod ? ColorId.NewMod : ColorId.DisabledMod).Value())) - { - ImUtf8.Selectable(modName, false, ImGuiSelectableFlags.AllowItemOverlap, - new Vector2(ImGui.GetContentRegionAvail().X, frameHeight)); - } - - ImGui.SameLine(); - ImGui.SetCursorPosX(textPos); - ImUtf8.Text(resourceNode.ModRelativePath); - } - else if (resourceNode.FullPath.IsRooted) - { - var path = resourceNode.FullPath.FullName; - var lastDirectorySeparator = path.LastIndexOf('\\'); - var secondLastDirectorySeparator = lastDirectorySeparator > 0 - ? path.LastIndexOf('\\', lastDirectorySeparator - 1) - : -1; - if (secondLastDirectorySeparator >= 0) - path = $"…{path.AsSpan(secondLastDirectorySeparator)}"; - ImGui.Selectable(path.AsSpan(), false, ImGuiSelectableFlags.AllowItemOverlap, - new Vector2(ImGui.GetContentRegionAvail().X, frameHeight)); - } - else - { - ImGui.Selectable(resourceNode.FullPath.ToPath(), false, ImGuiSelectableFlags.AllowItemOverlap, - new Vector2(ImGui.GetContentRegionAvail().X, frameHeight)); - } - + ImGui.Selectable(resourceNode.FullPath.ToPath(), false, 0, new Vector2(ImGui.GetContentRegionAvail().X, cellHeight)); if (ImGui.IsItemClicked()) ImGui.SetClipboardText(resourceNode.FullPath.ToPath()); - if (hasMod && ImGui.IsItemClicked(ImGuiMouseButton.Right) && ImGui.GetIO().KeyCtrl) - communicator.SelectTab.Invoke(TabType.Mods, mod); - - ImGuiUtil.HoverTooltip( - $"{resourceNode.FullPath.ToPath()}\n\nClick to copy to clipboard.{(hasMod ? "\nControl + Right-Click to jump to mod." : string.Empty)}{GetAdditionalDataSuffix(resourceNode.AdditionalData)}"); + ImGuiUtil.HoverTooltip($"{resourceNode.FullPath.ToPath()}\n\nClick to copy to clipboard."); } else { - ImUtf8.Selectable(GetPathStatusLabel(resourceNode.FullPathStatus), false, ImGuiSelectableFlags.Disabled, - new Vector2(ImGui.GetContentRegionAvail().X, frameHeight)); - ImGuiUtil.HoverTooltip( - $"{GetPathStatusDescription(resourceNode.FullPathStatus)}{GetAdditionalDataSuffix(resourceNode.AdditionalData)}"); + ImGui.Selectable("(unavailable)", false, ImGuiSelectableFlags.Disabled, + new Vector2(ImGui.GetContentRegionAvail().X, cellHeight)); + ImGuiUtil.HoverTooltip("The actual path to this file is unavailable.\nIt may be managed by another plug-in."); } mutedColor.Dispose(); - ImGui.TableNextColumn(); - using var spacing = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, - ImGui.GetStyle().ItemSpacing with { X = 3 * ImGuiHelpers.GlobalScale }); - DrawActions(resourceNode, new Vector2(frameHeight)); + if (_actionCapacity > 0) + { + ImGui.TableNextColumn(); + using var spacing = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, + ImGui.GetStyle().ItemSpacing with { X = 3 * ImGuiHelpers.GlobalScale }); + _drawActions(resourceNode, new Vector2(frameHeight)); + } if (unfolded) - DrawNodes(resourceNode.Children, level + 1, unchecked(nodePathHash * 31), filterIcon); - } - - return; - - string GetAdditionalDataSuffix(CiByteString data) - => !debugMode || data.IsEmpty ? string.Empty : $"\n\nAdditional Data: {data}"; - - NodeVisibility GetNodeVisibility(nint nodePathHash, ResourceNode node, ChangedItemIconFlag parentFilterIcon) - { - if (!_filterCache.TryGetValue(nodePathHash, out var visibility)) - { - visibility = CalculateNodeVisibility(nodePathHash, node, parentFilterIcon); - _filterCache.Add(nodePathHash, visibility); - } - - return visibility; - } - - NodeVisibility CalculateNodeVisibility(nint nodePathHash, ResourceNode node, ChangedItemIconFlag parentFilterIcon) - { - if (node.Internal && !debugMode) - return NodeVisibility.Hidden; - - var filterIcon = node.IconFlag != 0 ? node.IconFlag : parentFilterIcon; - if (MatchesFilter(node, filterIcon)) - return NodeVisibility.Visible; - - foreach (var child in node.Children) - { - if (GetNodeVisibility(unchecked(nodePathHash * 31 + child.ResourceHandle), child, filterIcon) != NodeVisibility.Hidden) - return NodeVisibility.DescendentsOnly; - } - - return NodeVisibility.Hidden; - } - - bool MatchesFilter(ResourceNode node, ChangedItemIconFlag filterIcon) - { - if (!_typeFilter.HasFlag(filterIcon)) - return false; - - if (_nodeFilter.Length == 0) - return true; - - return node.Name != null && node.Name.Contains(_nodeFilter, StringComparison.OrdinalIgnoreCase) - || node.FullPath.FullName.Contains(_nodeFilter, StringComparison.OrdinalIgnoreCase) - || node.FullPath.InternalName.ToString().Contains(_nodeFilter, StringComparison.OrdinalIgnoreCase) - || Array.Exists(node.PossibleGamePaths, path => path.Path.ToString().Contains(_nodeFilter, StringComparison.OrdinalIgnoreCase)); - } - - void DrawActions(ResourceNode resourceNode, Vector2 buttonSize) - { - if (!_writableCache!.TryGetValue(resourceNode.FullPath, out var writable)) - { - var path = resourceNode.FullPath.ToPath(); - if (resourceNode.FullPath.IsRooted) - { - writable = new RawFileWritable(path); - } - else - { - var file = gameData.GetFile(path); - writable = file is null ? null : new RawGameFileWritable(file); - } - - _writableCache.Add(resourceNode.FullPath, writable); - } - - if (ImUtf8.IconButton(FontAwesomeIcon.Save, "Export this file."u8, buttonSize, - resourceNode.FullPath.FullName.Length is 0 || writable is null)) - { - var fullPathStr = resourceNode.FullPath.FullName; - var ext = resourceNode.PossibleGamePaths.Length == 1 - ? Path.GetExtension(resourceNode.GamePath.ToString()) - : Path.GetExtension(fullPathStr); - fileDialog.OpenSavePicker($"Export {Path.GetFileName(fullPathStr)} to...", ext, Path.GetFileNameWithoutExtension(fullPathStr), ext, - (success, name) => - { - if (!success) - return; - - try - { - compactor.WriteAllBytes(name, writable!.Write()); - } - catch (Exception e) - { - Penumbra.Log.Error($"Could not export {fullPathStr}:\n{e}"); - } - }, null, false); - } - - drawActions(resourceNode, writable, new Vector2(frameHeight)); + DrawNodes(resourceNode.Children, level + 1, unchecked(nodePathHash * 31)); } } - private static ReadOnlySpan GetPathStatusLabel(ResourceNode.PathStatus status) - => status switch - { - ResourceNode.PathStatus.External => "(managed by external tools)"u8, - ResourceNode.PathStatus.NonExistent => "(not found)"u8, - _ => "(unavailable)"u8, - }; - - private static string GetPathStatusDescription(ResourceNode.PathStatus status) - => status switch - { - ResourceNode.PathStatus.External => "The actual path to this file is unavailable, because it is managed by external tools.", - ResourceNode.PathStatus.NonExistent => - "The actual path to this file is unavailable, because it seems to have been moved or deleted since it was loaded.", - _ => "The actual path to this file is unavailable.", - }; - [Flags] private enum TreeCategory : uint { @@ -525,22 +328,4 @@ public class ResourceTreeViewer( Visible = 1, DescendentsOnly = 2, } - - private record RawFileWritable(string Path) : IWritable - { - public bool Valid - => true; - - public byte[] Write() - => File.ReadAllBytes(Path); - } - - private record RawGameFileWritable(FileResource FileResource) : IWritable - { - public bool Valid - => true; - - public byte[] Write() - => FileResource.Data; - } } diff --git a/Penumbra/UI/AdvancedWindow/ResourceTreeViewerFactory.cs b/Penumbra/UI/AdvancedWindow/ResourceTreeViewerFactory.cs deleted file mode 100644 index 6518ae67..00000000 --- a/Penumbra/UI/AdvancedWindow/ResourceTreeViewerFactory.cs +++ /dev/null @@ -1,24 +0,0 @@ -using Dalamud.Plugin.Services; -using OtterGui.Compression; -using OtterGui.Services; -using Penumbra.GameData.Files; -using Penumbra.Interop.ResourceTree; -using Penumbra.Services; - -namespace Penumbra.UI.AdvancedWindow; - -public class ResourceTreeViewerFactory( - Configuration config, - ResourceTreeFactory treeFactory, - ChangedItemDrawer changedItemDrawer, - IncognitoService incognito, - CommunicatorService communicator, - PcpService pcpService, - IDataManager gameData, - FileDialogService fileDialog, - FileCompactor compactor) : IService -{ - public ResourceTreeViewer Create(int actionCapacity, Action onRefresh, Action drawActions) - => new(config, treeFactory, changedItemDrawer, incognito, actionCapacity, onRefresh, drawActions, communicator, pcpService, gameData, - fileDialog, compactor); -} diff --git a/Penumbra/UI/ChangedItemDrawer.cs b/Penumbra/UI/ChangedItemDrawer.cs index db54a8e5..638afef0 100644 --- a/Penumbra/UI/ChangedItemDrawer.cs +++ b/Penumbra/UI/ChangedItemDrawer.cs @@ -1,27 +1,72 @@ using Dalamud.Interface; -using Dalamud.Interface.Textures; -using Dalamud.Interface.Textures.TextureWraps; +using Dalamud.Interface.Internal; using Dalamud.Plugin.Services; using Dalamud.Utility; -using Dalamud.Bindings.ImGui; +using FFXIVClientStructs.FFXIV.Client.Graphics.Scene; +using ImGuiNET; using Lumina.Data.Files; +using Lumina.Excel; +using Lumina.Excel.GeneratedSheets; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using Penumbra.Api.Enums; -using Penumbra.GameData.Data; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; using Penumbra.Services; using Penumbra.UI.Classes; +using ApiChangedItemIcon = Penumbra.Api.Enums.ChangedItemIcon; namespace Penumbra.UI; -public class ChangedItemDrawer : IDisposable, IUiService +public class ChangedItemDrawer : IDisposable { - private static readonly string[] LowerNames = ChangedItemFlagExtensions.Order.Select(f => f.ToDescription().ToLowerInvariant()).ToArray(); + [Flags] + public enum ChangedItemIcon : uint + { + Head = 0x00_00_01, + Body = 0x00_00_02, + Hands = 0x00_00_04, + Legs = 0x00_00_08, + Feet = 0x00_00_10, + Ears = 0x00_00_20, + Neck = 0x00_00_40, + Wrists = 0x00_00_80, + Finger = 0x00_01_00, + Monster = 0x00_02_00, + Demihuman = 0x00_04_00, + Customization = 0x00_08_00, + Action = 0x00_10_00, + Mainhand = 0x00_20_00, + Offhand = 0x00_40_00, + Unknown = 0x00_80_00, + Emote = 0x01_00_00, + } - public static bool TryParseIndex(ReadOnlySpan input, out ChangedItemIconFlag slot) + private static readonly ChangedItemIcon[] Order = + [ + ChangedItemIcon.Head, + ChangedItemIcon.Body, + ChangedItemIcon.Hands, + ChangedItemIcon.Legs, + ChangedItemIcon.Feet, + ChangedItemIcon.Ears, + ChangedItemIcon.Neck, + ChangedItemIcon.Wrists, + ChangedItemIcon.Finger, + ChangedItemIcon.Mainhand, + ChangedItemIcon.Offhand, + ChangedItemIcon.Customization, + ChangedItemIcon.Action, + ChangedItemIcon.Emote, + ChangedItemIcon.Monster, + ChangedItemIcon.Demihuman, + ChangedItemIcon.Unknown, + ]; + + private static readonly string[] LowerNames = Order.Select(f => ToDescription(f).ToLowerInvariant()).ToArray(); + + public static bool TryParseIndex(ReadOnlySpan input, out ChangedItemIcon slot) { // Handle numeric cases before TryParse because numbers // are not logical otherwise. @@ -30,15 +75,15 @@ public class ChangedItemDrawer : IDisposable, IUiService // We assume users will use 1-based index, but if they enter 0, just use the first. if (idx == 0) { - slot = ChangedItemFlagExtensions.Order[0]; + slot = Order[0]; return true; } // Use 1-based index. --idx; - if (idx >= 0 && idx < ChangedItemFlagExtensions.Order.Count) + if (idx >= 0 && idx < Order.Length) { - slot = ChangedItemFlagExtensions.Order[idx]; + slot = Order[idx]; return true; } } @@ -47,33 +92,36 @@ public class ChangedItemDrawer : IDisposable, IUiService return false; } - public static bool TryParsePartial(string lowerInput, out ChangedItemIconFlag slot) + public static bool TryParsePartial(string lowerInput, out ChangedItemIcon slot) { if (TryParseIndex(lowerInput, out slot)) return true; slot = 0; - foreach (var (item, flag) in LowerNames.Zip(ChangedItemFlagExtensions.Order)) - { + foreach (var (item, flag) in LowerNames.Zip(Order)) if (item.Contains(lowerInput, StringComparison.Ordinal)) slot |= flag; - } return slot != 0; } + public const ChangedItemIcon AllFlags = (ChangedItemIcon)0x01FFFF; + public static readonly int NumCategories = Order.Length; + public const ChangedItemIcon DefaultFlags = AllFlags & ~ChangedItemIcon.Offhand; - private readonly Configuration _config; - private readonly CommunicatorService _communicator; - private readonly Dictionary _icons = new(16); - private float _smallestIconWidth; + private readonly Configuration _config; + private readonly ExcelSheet _items; + private readonly CommunicatorService _communicator; + private readonly Dictionary _icons = new(16); + private float _smallestIconWidth; public static Vector2 TypeFilterIconSize => new(2 * ImGui.GetTextLineHeight()); - public ChangedItemDrawer(IUiBuilder uiBuilder, IDataManager gameData, ITextureProvider textureProvider, CommunicatorService communicator, + public ChangedItemDrawer(UiBuilder uiBuilder, IDataManager gameData, ITextureProvider textureProvider, CommunicatorService communicator, Configuration config) { + _items = gameData.GetExcelSheet()!; uiBuilder.RunWhenUiPrepared(() => CreateEquipSlotIcons(uiBuilder, gameData, textureProvider), true); _communicator = communicator; _config = config; @@ -87,80 +135,74 @@ public class ChangedItemDrawer : IDisposable, IUiService } /// Check if a changed item should be drawn based on its category. - public bool FilterChangedItem(string name, IIdentifiedObjectData data, LowerString filter) - => (_config.Ephemeral.ChangedItemFilter == ChangedItemFlagExtensions.AllFlags - || _config.Ephemeral.ChangedItemFilter.HasFlag(data.GetIcon().ToFlag())) - && (filter.IsEmpty || !data.IsFilteredOut(name, filter)); + public bool FilterChangedItem(string name, object? data, LowerString filter) + => (_config.Ephemeral.ChangedItemFilter == AllFlags || _config.Ephemeral.ChangedItemFilter.HasFlag(GetCategoryIcon(name, data))) + && (filter.IsEmpty || filter.IsContained(ChangedItemFilterName(name, data))); /// Draw the icon corresponding to the category of a changed item. - public void DrawCategoryIcon(IIdentifiedObjectData data, float height) - => DrawCategoryIcon(data.GetIcon().ToFlag(), height); + public void DrawCategoryIcon(string name, object? data) + => DrawCategoryIcon(GetCategoryIcon(name, data)); - public void DrawCategoryIcon(ChangedItemIconFlag iconFlagType) - => DrawCategoryIcon(iconFlagType, ImGui.GetFrameHeight()); - - public void DrawCategoryIcon(ChangedItemIconFlag iconFlagType, float height) + public void DrawCategoryIcon(ChangedItemIcon iconType) { - if (!_icons.TryGetValue(iconFlagType, out var icon)) + var height = ImGui.GetFrameHeight(); + if (!_icons.TryGetValue(iconType, out var icon)) { ImGui.Dummy(new Vector2(height)); return; } - ImGui.Image(icon.Handle, new Vector2(height)); + ImGui.Image(icon.ImGuiHandle, new Vector2(height)); if (ImGui.IsItemHovered()) { using var tt = ImRaii.Tooltip(); - ImGui.Image(icon.Handle, new Vector2(_smallestIconWidth)); + ImGui.Image(icon.ImGuiHandle, new Vector2(_smallestIconWidth)); ImGui.SameLine(); - ImGuiUtil.DrawTextButton(iconFlagType.ToDescription(), new Vector2(0, _smallestIconWidth), 0); + ImGuiUtil.DrawTextButton(ToDescription(iconType), new Vector2(0, _smallestIconWidth), 0); } } - public void ChangedItemHandling(IIdentifiedObjectData data, bool leftClicked) + /// + /// Draw a changed item, invoking the Api-Events for clicks and tooltips. + /// Also draw the item Id in grey if requested. + /// + public void DrawChangedItem(string name, object? data) { - var ret = leftClicked ? MouseButton.Left : MouseButton.None; - ret = ImGui.IsItemClicked(ImGuiMouseButton.Right) ? MouseButton.Right : ret; - ret = ImGui.IsItemClicked(ImGuiMouseButton.Middle) ? MouseButton.Middle : ret; - if (ret != MouseButton.None) - _communicator.ChangedItemClick.Invoke(ret, data); - if (!ImGui.IsItemHovered()) - return; + name = ChangedItemName(name, data); + using (var style = ImRaii.PushStyle(ImGuiStyleVar.SelectableTextAlign, new Vector2(0, 0.5f)) + .Push(ImGuiStyleVar.ItemSpacing, new Vector2(ImGui.GetStyle().ItemSpacing.X, ImGui.GetStyle().CellPadding.Y * 2))) + { + var ret = ImGui.Selectable(name, false, ImGuiSelectableFlags.None, new Vector2(0, ImGui.GetFrameHeight())) + ? MouseButton.Left + : MouseButton.None; + ret = ImGui.IsItemClicked(ImGuiMouseButton.Right) ? MouseButton.Right : ret; + ret = ImGui.IsItemClicked(ImGuiMouseButton.Middle) ? MouseButton.Middle : ret; + if (ret != MouseButton.None) + _communicator.ChangedItemClick.Invoke(ret, Convert(data)); + } - using var tt = ImUtf8.Tooltip(); - if (data.Count == 1) - ImUtf8.Text("This item is changed through a single effective change.\n"); - else - ImUtf8.Text($"This item is changed through {data.Count} distinct effective changes.\n"); - ImGui.SetCursorPosY(ImGui.GetCursorPosY() + 3 * ImUtf8.GlobalScale); - ImGui.Separator(); - ImGui.SetCursorPosY(ImGui.GetCursorPosY() + 3 * ImUtf8.GlobalScale); - _communicator.ChangedItemHover.Invoke(data); + if (_communicator.ChangedItemHover.HasTooltip && ImGui.IsItemHovered()) + { + // We can not be sure that any subscriber actually prints something in any case. + // Circumvent ugly blank tooltip with less-ugly useless tooltip. + using var tt = ImRaii.Tooltip(); + using var group = ImRaii.Group(); + _communicator.ChangedItemHover.Invoke(Convert(data)); + group.Dispose(); + if (ImGui.GetItemRectSize() == Vector2.Zero) + ImGui.TextUnformatted("No actions available."); + } } /// Draw the model information, right-justified. - public static void DrawModelData(IIdentifiedObjectData data, float height) + public void DrawModelData(object? data) { - var additionalData = data.AdditionalData; - if (additionalData.Length == 0) + if (!GetChangedItemObject(data, out var text)) return; - ImGui.SameLine(); - using var color = ImRaii.PushColor(ImGuiCol.Text, ColorId.ItemId.Value()); - ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (height - ImGui.GetTextLineHeight()) / 2); - ImUtf8.TextRightAligned(additionalData, ImGui.GetStyle().ItemInnerSpacing.X); - } - - /// Draw the model information, right-justified. - public static void DrawModelData(ReadOnlySpan text, float height) - { - if (text.Length == 0) - return; - - ImGui.SameLine(); - using var color = ImRaii.PushColor(ImGuiCol.Text, ColorId.ItemId.Value()); - ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (height - ImGui.GetTextLineHeight()) / 2); - ImUtf8.TextRightAligned(text, ImGui.GetStyle().ItemInnerSpacing.X); + ImGui.SameLine(ImGui.GetContentRegionAvail().X); + ImGui.AlignTextToFramePadding(); + ImGuiUtil.RightJustify(text, ColorId.ItemId.Value()); } /// Draw a header line with the different icon types to filter them. @@ -170,7 +212,7 @@ public class ChangedItemDrawer : IDisposable, IUiService return; var typeFilter = _config.Ephemeral.ChangedItemFilter; - if (DrawTypeFilter(ref typeFilter)) + if (DrawTypeFilter(ref typeFilter, 0.0f)) { _config.Ephemeral.ChangedItemFilter = typeFilter; _config.Ephemeral.Save(); @@ -178,7 +220,7 @@ public class ChangedItemDrawer : IDisposable, IUiService } /// Draw a header line with the different icon types to filter them. - public bool DrawTypeFilter(ref ChangedItemIconFlag typeFilter) + public bool DrawTypeFilter(ref ChangedItemIcon typeFilter, float yOffset) { var ret = false; using var _ = ImRaii.PushId("ChangedItemIconFilter"); @@ -186,38 +228,17 @@ public class ChangedItemDrawer : IDisposable, IUiService using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, Vector2.Zero); - foreach (var iconType in ChangedItemFlagExtensions.Order) + bool DrawIcon(ChangedItemIcon type, ref ChangedItemIcon typeFilter) { - ret |= DrawIcon(iconType, ref typeFilter); - ImGui.SameLine(); - } - - ImGui.SetCursorPosX(ImGui.GetContentRegionMax().X - size.X); - ImGui.Image(_icons[ChangedItemFlagExtensions.AllFlags].Handle, size, Vector2.Zero, Vector2.One, - typeFilter switch - { - 0 => new Vector4(0.6f, 0.3f, 0.3f, 1f), - ChangedItemFlagExtensions.AllFlags => new Vector4(0.75f, 0.75f, 0.75f, 1f), - _ => new Vector4(0.5f, 0.5f, 1f, 1f), - }); - if (ImGui.IsItemClicked()) - { - typeFilter = typeFilter == ChangedItemFlagExtensions.AllFlags ? 0 : ChangedItemFlagExtensions.AllFlags; - ret = true; - } - - return ret; - - bool DrawIcon(ChangedItemIconFlag type, ref ChangedItemIconFlag typeFilter) - { - var localRet = false; - var icon = _icons[type]; - var flag = typeFilter.HasFlag(type); - ImGui.Image(icon.Handle, size, Vector2.Zero, Vector2.One, flag ? Vector4.One : new Vector4(0.6f, 0.3f, 0.3f, 1f)); + var ret = false; + var icon = _icons[type]; + var flag = typeFilter.HasFlag(type); + ImGui.SetCursorPosY(ImGui.GetCursorPosY() + yOffset); + ImGui.Image(icon.ImGuiHandle, size, Vector2.Zero, Vector2.One, flag ? Vector4.One : new Vector4(0.6f, 0.3f, 0.3f, 1f)); if (ImGui.IsItemClicked(ImGuiMouseButton.Left)) { typeFilter = flag ? typeFilter & ~type : typeFilter | type; - localRet = true; + ret = true; } using var popup = ImRaii.ContextPopupItem(type.ToString()); @@ -225,61 +246,213 @@ public class ChangedItemDrawer : IDisposable, IUiService if (ImGui.MenuItem("Enable Only This")) { typeFilter = type; - localRet = true; + ret = true; ImGui.CloseCurrentPopup(); } if (ImGui.IsItemHovered()) { using var tt = ImRaii.Tooltip(); - ImGui.Image(icon.Handle, new Vector2(_smallestIconWidth)); + ImGui.Image(icon.ImGuiHandle, new Vector2(_smallestIconWidth)); ImGui.SameLine(); - ImGuiUtil.DrawTextButton(type.ToDescription(), new Vector2(0, _smallestIconWidth), 0); + ImGuiUtil.DrawTextButton(ToDescription(type), new Vector2(0, _smallestIconWidth), 0); } - return localRet; + return ret; + } + + foreach (var iconType in Order) + { + ret |= DrawIcon(iconType, ref typeFilter); + ImGui.SameLine(); + } + + ImGui.SetCursorPos(new Vector2(ImGui.GetContentRegionMax().X - size.X, ImGui.GetCursorPosY() + yOffset)); + ImGui.Image(_icons[AllFlags].ImGuiHandle, size, Vector2.Zero, Vector2.One, + typeFilter == 0 ? new Vector4(0.6f, 0.3f, 0.3f, 1f) : + typeFilter == AllFlags ? new Vector4(0.75f, 0.75f, 0.75f, 1f) : new Vector4(0.5f, 0.5f, 1f, 1f)); + if (ImGui.IsItemClicked()) + { + typeFilter = typeFilter == AllFlags ? 0 : AllFlags; + ret = true; + } + + return ret; + } + + /// Obtain the icon category corresponding to a changed item. + internal static ChangedItemIcon GetCategoryIcon(string name, object? obj) + { + var iconType = ChangedItemIcon.Unknown; + switch (obj) + { + case EquipItem it: + iconType = GetCategoryIcon(it.Type.ToSlot()); + break; + case ModelChara m: + iconType = (CharacterBase.ModelType)m.Type switch + { + CharacterBase.ModelType.DemiHuman => ChangedItemIcon.Demihuman, + CharacterBase.ModelType.Monster => ChangedItemIcon.Monster, + _ => ChangedItemIcon.Unknown, + }; + break; + default: + { + if (name.StartsWith("Action: ")) + iconType = ChangedItemIcon.Action; + else if (name.StartsWith("Emote: ")) + iconType = ChangedItemIcon.Emote; + else if (name.StartsWith("Customization: ")) + iconType = ChangedItemIcon.Customization; + break; + } + } + + return iconType; + } + + internal static ChangedItemIcon GetCategoryIcon(EquipSlot slot) + => slot switch + { + EquipSlot.MainHand => ChangedItemIcon.Mainhand, + EquipSlot.OffHand => ChangedItemIcon.Offhand, + EquipSlot.Head => ChangedItemIcon.Head, + EquipSlot.Body => ChangedItemIcon.Body, + EquipSlot.Hands => ChangedItemIcon.Hands, + EquipSlot.Legs => ChangedItemIcon.Legs, + EquipSlot.Feet => ChangedItemIcon.Feet, + EquipSlot.Ears => ChangedItemIcon.Ears, + EquipSlot.Neck => ChangedItemIcon.Neck, + EquipSlot.Wrists => ChangedItemIcon.Wrists, + EquipSlot.RFinger => ChangedItemIcon.Finger, + _ => ChangedItemIcon.Unknown, + }; + + /// Return more detailed object information in text, if it exists. + private static bool GetChangedItemObject(object? obj, out string text) + { + switch (obj) + { + case EquipItem it: + text = it.ModelString; + return true; + case ModelChara m: + text = $"({((CharacterBase.ModelType)m.Type).ToName()} {m.Model}-{m.Base}-{m.Variant})"; + return true; + default: + text = string.Empty; + return false; } } + /// We need to transform the internal EquipItem type to the Lumina Item type for API-events. + private object? Convert(object? data) + { + if (data is EquipItem it) + return (_items.GetRow(it.ItemId.Id), it.Type); + + return data; + } + + private static string ToDescription(ChangedItemIcon icon) + => icon switch + { + ChangedItemIcon.Head => EquipSlot.Head.ToName(), + ChangedItemIcon.Body => EquipSlot.Body.ToName(), + ChangedItemIcon.Hands => EquipSlot.Hands.ToName(), + ChangedItemIcon.Legs => EquipSlot.Legs.ToName(), + ChangedItemIcon.Feet => EquipSlot.Feet.ToName(), + ChangedItemIcon.Ears => EquipSlot.Ears.ToName(), + ChangedItemIcon.Neck => EquipSlot.Neck.ToName(), + ChangedItemIcon.Wrists => EquipSlot.Wrists.ToName(), + ChangedItemIcon.Finger => "Ring", + ChangedItemIcon.Monster => "Monster", + ChangedItemIcon.Demihuman => "Demi-Human", + ChangedItemIcon.Customization => "Customization", + ChangedItemIcon.Action => "Action", + ChangedItemIcon.Emote => "Emote", + ChangedItemIcon.Mainhand => "Weapon (Mainhand)", + ChangedItemIcon.Offhand => "Weapon (Offhand)", + _ => "Other", + }; + + internal static ApiChangedItemIcon ToApiIcon(ChangedItemIcon icon) + => icon switch + { + ChangedItemIcon.Head => ApiChangedItemIcon.Head, + ChangedItemIcon.Body => ApiChangedItemIcon.Body, + ChangedItemIcon.Hands => ApiChangedItemIcon.Hands, + ChangedItemIcon.Legs => ApiChangedItemIcon.Legs, + ChangedItemIcon.Feet => ApiChangedItemIcon.Feet, + ChangedItemIcon.Ears => ApiChangedItemIcon.Ears, + ChangedItemIcon.Neck => ApiChangedItemIcon.Neck, + ChangedItemIcon.Wrists => ApiChangedItemIcon.Wrists, + ChangedItemIcon.Finger => ApiChangedItemIcon.Finger, + ChangedItemIcon.Monster => ApiChangedItemIcon.Monster, + ChangedItemIcon.Demihuman => ApiChangedItemIcon.Demihuman, + ChangedItemIcon.Customization => ApiChangedItemIcon.Customization, + ChangedItemIcon.Action => ApiChangedItemIcon.Action, + ChangedItemIcon.Emote => ApiChangedItemIcon.Emote, + ChangedItemIcon.Mainhand => ApiChangedItemIcon.Mainhand, + ChangedItemIcon.Offhand => ApiChangedItemIcon.Offhand, + ChangedItemIcon.Unknown => ApiChangedItemIcon.Unknown, + _ => ApiChangedItemIcon.None, + }; + + /// Apply Changed Item Counters to the Name if necessary. + private static string ChangedItemName(string name, object? data) + => data is int counter ? $"{counter} Files Manipulating {name}s" : name; + + /// Add filterable information to the string. + private static string ChangedItemFilterName(string name, object? data) + => data switch + { + int counter => $"{counter} Files Manipulating {name}s", + EquipItem it => $"{name}\0{(GetChangedItemObject(it, out var t) ? t : string.Empty)}", + ModelChara m => $"{name}\0{(GetChangedItemObject(m, out var t) ? t : string.Empty)}", + _ => name, + }; + /// Initialize the icons. - private bool CreateEquipSlotIcons(IUiBuilder uiBuilder, IDataManager gameData, ITextureProvider textureProvider) + private bool CreateEquipSlotIcons(UiBuilder uiBuilder, IDataManager gameData, ITextureProvider textureProvider) { using var equipTypeIcons = uiBuilder.LoadUld("ui/uld/ArmouryBoard.uld"); if (!equipTypeIcons.Valid) return false; - void Add(ChangedItemIconFlag icon, IDalamudTextureWrap? tex) + void Add(ChangedItemIcon icon, IDalamudTextureWrap? tex) { if (tex != null) _icons.Add(icon, tex); } - Add(ChangedItemIconFlag.Mainhand, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 0)); - Add(ChangedItemIconFlag.Head, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 1)); - Add(ChangedItemIconFlag.Body, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 2)); - Add(ChangedItemIconFlag.Hands, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 3)); - Add(ChangedItemIconFlag.Legs, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 5)); - Add(ChangedItemIconFlag.Feet, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 6)); - Add(ChangedItemIconFlag.Offhand, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 7)); - Add(ChangedItemIconFlag.Ears, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 8)); - Add(ChangedItemIconFlag.Neck, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 9)); - Add(ChangedItemIconFlag.Wrists, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 10)); - Add(ChangedItemIconFlag.Finger, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 11)); - Add(ChangedItemIconFlag.Monster, textureProvider.CreateFromTexFile(gameData.GetFile("ui/icon/062000/062044_hr1.tex")!)); - Add(ChangedItemIconFlag.Demihuman, textureProvider.CreateFromTexFile(gameData.GetFile("ui/icon/062000/062043_hr1.tex")!)); - Add(ChangedItemIconFlag.Customization, textureProvider.CreateFromTexFile(gameData.GetFile("ui/icon/062000/062045_hr1.tex")!)); - Add(ChangedItemIconFlag.Action, textureProvider.CreateFromTexFile(gameData.GetFile("ui/icon/062000/062001_hr1.tex")!)); - Add(ChangedItemIconFlag.Emote, LoadEmoteTexture(gameData, textureProvider)); - Add(ChangedItemIconFlag.Unknown, LoadUnknownTexture(gameData, textureProvider)); - Add(ChangedItemFlagExtensions.AllFlags, textureProvider.CreateFromTexFile(gameData.GetFile("ui/icon/114000/114052_hr1.tex")!)); + Add(ChangedItemIcon.Mainhand, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 0)); + Add(ChangedItemIcon.Head, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 1)); + Add(ChangedItemIcon.Body, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 2)); + Add(ChangedItemIcon.Hands, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 3)); + Add(ChangedItemIcon.Legs, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 5)); + Add(ChangedItemIcon.Feet, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 6)); + Add(ChangedItemIcon.Offhand, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 7)); + Add(ChangedItemIcon.Ears, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 8)); + Add(ChangedItemIcon.Neck, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 9)); + Add(ChangedItemIcon.Wrists, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 10)); + Add(ChangedItemIcon.Finger, equipTypeIcons.LoadTexturePart("ui/uld/ArmouryBoard_hr1.tex", 11)); + Add(ChangedItemIcon.Monster, textureProvider.GetTextureFromGame("ui/icon/062000/062042_hr1.tex", true)); + Add(ChangedItemIcon.Demihuman, textureProvider.GetTextureFromGame("ui/icon/062000/062041_hr1.tex", true)); + Add(ChangedItemIcon.Customization, textureProvider.GetTextureFromGame("ui/icon/062000/062043_hr1.tex", true)); + Add(ChangedItemIcon.Action, textureProvider.GetTextureFromGame("ui/icon/062000/062001_hr1.tex", true)); + Add(ChangedItemIcon.Emote, LoadEmoteTexture(gameData, uiBuilder)); + Add(ChangedItemIcon.Unknown, LoadUnknownTexture(gameData, uiBuilder)); + Add(AllFlags, textureProvider.GetTextureFromGame("ui/icon/114000/114052_hr1.tex", true)); _smallestIconWidth = _icons.Values.Min(i => i.Width); return true; } - private static IDalamudTextureWrap? LoadUnknownTexture(IDataManager gameData, ITextureProvider textureProvider) + private static unsafe IDalamudTextureWrap? LoadUnknownTexture(IDataManager gameData, UiBuilder uiBuilder) { var unk = gameData.GetFile("ui/uld/levelup2_hr1.tex"); if (unk == null) @@ -291,10 +464,10 @@ public class ChangedItemDrawer : IDisposable, IUiService for (var y = 0; y < unk.Header.Height; ++y) image.AsSpan(4 * y * unk.Header.Width, 4 * unk.Header.Width).CopyTo(bytes.AsSpan(4 * y * unk.Header.Height + diff)); - return textureProvider.CreateFromRaw(RawImageSpecification.Rgba32(unk.Header.Height, unk.Header.Height), bytes, "Penumbra.UnkItemIcon"); + return uiBuilder.LoadImageRaw(bytes, unk.Header.Height, unk.Header.Height, 4); } - private static unsafe IDalamudTextureWrap? LoadEmoteTexture(IDataManager gameData, ITextureProvider textureProvider) + private static unsafe IDalamudTextureWrap? LoadEmoteTexture(IDataManager gameData, UiBuilder uiBuilder) { var emote = gameData.GetFile("ui/icon/000000/000019_hr1.tex"); if (emote == null) @@ -311,7 +484,6 @@ public class ChangedItemDrawer : IDisposable, IUiService } } - return textureProvider.CreateFromRaw(RawImageSpecification.Rgba32(emote.Header.Width, emote.Header.Height), image2, - "Penumbra.EmoteItemIcon"); + return uiBuilder.LoadImageRaw(image2, emote.Header.Width, emote.Header.Height, 4); } } diff --git a/Penumbra/UI/ChangedItemIconFlag.cs b/Penumbra/UI/ChangedItemIconFlag.cs deleted file mode 100644 index fc7073f2..00000000 --- a/Penumbra/UI/ChangedItemIconFlag.cs +++ /dev/null @@ -1,122 +0,0 @@ -using Penumbra.Api.Enums; -using Penumbra.GameData.Enums; - -namespace Penumbra.UI; - -[Flags] -public enum ChangedItemIconFlag : uint -{ - Head = 0x00_00_01, - Body = 0x00_00_02, - Hands = 0x00_00_04, - Legs = 0x00_00_08, - Feet = 0x00_00_10, - Ears = 0x00_00_20, - Neck = 0x00_00_40, - Wrists = 0x00_00_80, - Finger = 0x00_01_00, - Monster = 0x00_02_00, - Demihuman = 0x00_04_00, - Customization = 0x00_08_00, - Action = 0x00_10_00, - Mainhand = 0x00_20_00, - Offhand = 0x00_40_00, - Unknown = 0x00_80_00, - Emote = 0x01_00_00, -} - -public static class ChangedItemFlagExtensions -{ - public static readonly IReadOnlyList Order = - [ - ChangedItemIconFlag.Head, - ChangedItemIconFlag.Body, - ChangedItemIconFlag.Hands, - ChangedItemIconFlag.Legs, - ChangedItemIconFlag.Feet, - ChangedItemIconFlag.Ears, - ChangedItemIconFlag.Neck, - ChangedItemIconFlag.Wrists, - ChangedItemIconFlag.Finger, - ChangedItemIconFlag.Mainhand, - ChangedItemIconFlag.Offhand, - ChangedItemIconFlag.Customization, - ChangedItemIconFlag.Action, - ChangedItemIconFlag.Emote, - ChangedItemIconFlag.Monster, - ChangedItemIconFlag.Demihuman, - ChangedItemIconFlag.Unknown, - ]; - - public const ChangedItemIconFlag AllFlags = (ChangedItemIconFlag)0x01FFFF; - public static readonly int NumCategories = Order.Count; - public const ChangedItemIconFlag DefaultFlags = AllFlags & ~ChangedItemIconFlag.Offhand; - - public static string ToDescription(this ChangedItemIconFlag iconFlag) - => iconFlag switch - { - ChangedItemIconFlag.Head => EquipSlot.Head.ToName(), - ChangedItemIconFlag.Body => EquipSlot.Body.ToName(), - ChangedItemIconFlag.Hands => EquipSlot.Hands.ToName(), - ChangedItemIconFlag.Legs => EquipSlot.Legs.ToName(), - ChangedItemIconFlag.Feet => EquipSlot.Feet.ToName(), - ChangedItemIconFlag.Ears => EquipSlot.Ears.ToName(), - ChangedItemIconFlag.Neck => EquipSlot.Neck.ToName(), - ChangedItemIconFlag.Wrists => EquipSlot.Wrists.ToName(), - ChangedItemIconFlag.Finger => "Ring", - ChangedItemIconFlag.Monster => "Monster", - ChangedItemIconFlag.Demihuman => "Demi-Human", - ChangedItemIconFlag.Customization => "Customization", - ChangedItemIconFlag.Action => "Action", - ChangedItemIconFlag.Emote => "Emote", - ChangedItemIconFlag.Mainhand => "Weapon (Mainhand)", - ChangedItemIconFlag.Offhand => "Weapon (Offhand)", - _ => "Other", - }; - - public static ChangedItemIcon ToApiIcon(this ChangedItemIconFlag iconFlag) - => iconFlag switch - { - ChangedItemIconFlag.Head => ChangedItemIcon.Head, - ChangedItemIconFlag.Body => ChangedItemIcon.Body, - ChangedItemIconFlag.Hands => ChangedItemIcon.Hands, - ChangedItemIconFlag.Legs => ChangedItemIcon.Legs, - ChangedItemIconFlag.Feet => ChangedItemIcon.Feet, - ChangedItemIconFlag.Ears => ChangedItemIcon.Ears, - ChangedItemIconFlag.Neck => ChangedItemIcon.Neck, - ChangedItemIconFlag.Wrists => ChangedItemIcon.Wrists, - ChangedItemIconFlag.Finger => ChangedItemIcon.Finger, - ChangedItemIconFlag.Monster => ChangedItemIcon.Monster, - ChangedItemIconFlag.Demihuman => ChangedItemIcon.Demihuman, - ChangedItemIconFlag.Customization => ChangedItemIcon.Customization, - ChangedItemIconFlag.Action => ChangedItemIcon.Action, - ChangedItemIconFlag.Emote => ChangedItemIcon.Emote, - ChangedItemIconFlag.Mainhand => ChangedItemIcon.Mainhand, - ChangedItemIconFlag.Offhand => ChangedItemIcon.Offhand, - ChangedItemIconFlag.Unknown => ChangedItemIcon.Unknown, - _ => ChangedItemIcon.None, - }; - - public static ChangedItemIconFlag ToFlag(this ChangedItemIcon icon) - => icon switch - { - ChangedItemIcon.Unknown => ChangedItemIconFlag.Unknown, - ChangedItemIcon.Head => ChangedItemIconFlag.Head, - ChangedItemIcon.Body => ChangedItemIconFlag.Body, - ChangedItemIcon.Hands => ChangedItemIconFlag.Hands, - ChangedItemIcon.Legs => ChangedItemIconFlag.Legs, - ChangedItemIcon.Feet => ChangedItemIconFlag.Feet, - ChangedItemIcon.Ears => ChangedItemIconFlag.Ears, - ChangedItemIcon.Neck => ChangedItemIconFlag.Neck, - ChangedItemIcon.Wrists => ChangedItemIconFlag.Wrists, - ChangedItemIcon.Finger => ChangedItemIconFlag.Finger, - ChangedItemIcon.Mainhand => ChangedItemIconFlag.Mainhand, - ChangedItemIcon.Offhand => ChangedItemIconFlag.Offhand, - ChangedItemIcon.Customization => ChangedItemIconFlag.Customization, - ChangedItemIcon.Monster => ChangedItemIconFlag.Monster, - ChangedItemIcon.Demihuman => ChangedItemIconFlag.Demihuman, - ChangedItemIcon.Action => ChangedItemIconFlag.Action, - ChangedItemIcon.Emote => ChangedItemIconFlag.Emote, - _ => ChangedItemIconFlag.Unknown, - }; -} diff --git a/Penumbra/UI/Changelog.cs b/Penumbra/UI/Changelog.cs index 306dcc79..2b2cfa99 100644 --- a/Penumbra/UI/Changelog.cs +++ b/Penumbra/UI/Changelog.cs @@ -1,9 +1,8 @@ -using OtterGui.Services; using OtterGui.Widgets; namespace Penumbra.UI; -public class PenumbraChangelog : IUiService +public class PenumbraChangelog { public const int LastChangelogVersion = 0; @@ -48,399 +47,19 @@ public class PenumbraChangelog : IUiService Add8_2_0(Changelog); Add8_3_0(Changelog); Add1_0_0_0(Changelog); - AddDummy(Changelog); - AddDummy(Changelog); - Add1_1_0_0(Changelog); - Add1_1_1_0(Changelog); - Add1_2_1_0(Changelog); - Add1_3_0_0(Changelog); - Add1_3_1_0(Changelog); - Add1_3_2_0(Changelog); - Add1_3_3_0(Changelog); - Add1_3_4_0(Changelog); - Add1_3_5_0(Changelog); - Add1_3_6_0(Changelog); - Add1_3_6_4(Changelog); - Add1_4_0_0(Changelog); - Add1_5_0_0(Changelog); - Add1_5_1_0(Changelog); - } - + Add1_0_2_0(Changelog); + Add1_0_3_0(Changelog); + } + #region Changelogs - private static void Add1_5_1_0(Changelog log) - => log.NextVersion("Version 1.5.1.0") - .RegisterHighlight("Added the option to export a characters current data as a .pcp modpack in the On-Screen tab.") - .RegisterEntry("Other plugins can attach to this functionality and package and interpret their own data.", 1) - .RegisterEntry("When a .pcp modpack is installed, it can create and assign collections for the corresponding character it was created for.", 1) - .RegisterEntry("This basically provides an easier way to manually synchronize other players, but does not contain any automation.", 1) - .RegisterEntry("The settings provide some fine control about what happens when a PCP is installed, as well as buttons to cleanup any PCP-created data.", 1) - .RegisterEntry("Added a warning message when the game's integrity is corrupted to the On-Screen tab.") - .RegisterEntry("Added .kdb files to the On-Screen tab and associated functionality (thanks Ny!).") - .RegisterEntry("Updated the creation of temporary collections to require a passed identity.") - .RegisterEntry("Added the option to change the skin material suffix in models using the stockings shader by adding specific attributes (thanks Ny!).") - .RegisterEntry("Added predefined tag utility to the multi-mod selection.") - .RegisterEntry("Fixed an issue with the automatic collection selection on character login when no mods are assigned.") - .RegisterImportant( - "Fixed issue with new deformer data that makes modded deformers not containing this data work implicitly. Updates are still recommended (1.5.0.5).") - .RegisterEntry("Fixed various issues after patch (1.5.0.1 - 1.5.0.4)."); - - private static void Add1_5_0_0(Changelog log) - => log.NextVersion("Version 1.5.0.0") - .RegisterImportant("Updated for game version 7.30 and Dalamud API13, which uses a new GUI backend. Some things may not work as expected. Please let me know any issues you encounter.") - .RegisterEntry("Added support for exporting models using two vertex color schemes (thanks zeroeightysix!).") - .RegisterEntry("Possibly improved the color accuracy of the basecolor texture created when exporting models (thanks zeroeightysix!).") - .RegisterEntry("Disabled enabling transparency for materials that use the characterstockings shader due to crashes (thanks zeroeightysix!).") - .RegisterEntry("Fixed some issues with model i/o and invalid tangents (thanks PassiveModding!)") - .RegisterEntry("Changed the behavior for default directory names when using the mod normalizer with combining groups.") - .RegisterEntry("Added jumping to specific mods to the HTTP API.") - .RegisterEntry("Fixed an issue with character sound modding (1.4.0.6).") - .RegisterHighlight("Added support for IMC-toggle attributes to accessories beyond the first toggle (1.4.0.5).") - .RegisterEntry("Fixed up some slot-specific attributes and shapes in models when swapping items between slots (1.4.0.5).") - .RegisterEntry("Added handling for human skin materials to the OnScreen tab and similar functionality (thanks Ny!) (1.4.0.5).") - .RegisterEntry("The OS thread ID a resource was loaded from was added to the resource logger (1.4.0.5).") - .RegisterEntry("A button linking to my (Ottermandias') Ko-Fi and Patreon was added in the settings tab. Feel free, but not pressured, to use it! :D ") - .RegisterHighlight("Mod setting combos now support mouse-wheel scrolling with Control and have filters (1.4.0.4).") - .RegisterEntry("Using the middle mouse button to toggle designs now works correctly with temporary settings (1.4.0.4).") - .RegisterEntry("Updated some BNPC associations (1.4.0.3).") - .RegisterEntry("Fixed further issues with shapes and attributes (1.4.0.4).") - .RegisterEntry("Penumbra now handles textures with MipMap offsets broken by TexTools on import and removes unnecessary MipMaps (1.4.0.3).") - .RegisterEntry("Updated the Mod Merger for the new group types (1.4.0.3).") - .RegisterEntry("Added querying Penumbra for supported features via IPC (1.4.0.3).") - .RegisterEntry("Shape names can now be edited in Penumbras model editor (1.4.0.2).") - .RegisterEntry("Attributes and Shapes can be fully toggled (1.4.0.2).") - .RegisterEntry("Fixed several issues with attributes and shapes (1.4.0.1)."); - - private static void Add1_4_0_0(Changelog log) - => log.NextVersion("Version 1.4.0.0") - .RegisterHighlight("Added two types of new Meta Changes, SHP and ATR (Thanks Karou!).") - .RegisterEntry("Those allow mod creators to toggle custom shape keys and attributes for models on and off, respectively.", 1) - .RegisterEntry("Custom shape keys need to have the format 'shpx_*' and custom attributes need 'atrx_*'.", 1) - .RegisterHighlight( - "Shapes of the following formats will automatically be toggled on if both relevant slots contain the same shape key:", 1) - .RegisterEntry("'shpx_wa_*', for the waist seam between the body and leg slot,", 2) - .RegisterEntry("'shpx_wr_*', for the wrist seams between the body and hands slot,", 2) - .RegisterEntry("'shpx_an_*', for the ankle seams between the leg and feet slot.", 2) - .RegisterEntry( - "Custom shape key and attributes can be turned off in the advanced settings section for the moment, but this is not recommended.", - 1) - .RegisterHighlight("The mod selector width is now draggable within certain restrictions that depend on the total window width.") - .RegisterEntry("The current behavior may not be final, let me know if you have any comments.", 1) - .RegisterEntry("Improved the naming of NPCs for identifiers by using Haselnussbombers new naming functionality (Thanks Hasel!).") - .RegisterEntry("Added global EQP entries to always hide Au Ra horns, Viera ears, or Miqo'te ears, respectively.") - .RegisterEntry("This will leave holes in the heads of the respective race if not modded in some way.", 1) - .RegisterEntry("Added a filter for mods that have temporary settings in the mod selector panel (Thanks Caraxi).") - .RegisterEntry("Made the checkbox for toggling Temporary Settings Mode in the mod tab more visible.") - .RegisterEntry("Improved the option select combo in advanced editing.") - .RegisterEntry("Fixed some issues with item identification for EST changes.") - .RegisterEntry("Fixed the sizing of the mod panel being off by 1 pixel sometimes.") - .RegisterEntry("Fixed an issue with redrawing while in GPose when other plugins broke some assumptions about the game state.") - .RegisterEntry("Fixed a clipping issue within the Meta Manipulations tab in advanced editing.") - .RegisterEntry("Fixed an issue with empty and temporary settings.") - .RegisterHighlight( - "In the Item Swap tab, items changed by this mod are now sorted and highlighted before items changed in the current collection before other items for the source, and inversely for the target. (1.3.6.8)") - .RegisterHighlight( - "Default-valued meta edits should now be kept on import and only removed when the option to keep them is not set AND no other options in the mod edit the same entry. (1.3.6.8)") - .RegisterEntry("Added a right-click context menu on file redirections to copy the full file path. (1.3.6.8)") - .RegisterEntry( - "Added a right-click context menu on the mod export button to open the backup directory in your file explorer. (1.3.6.8)") - .RegisterEntry("Fixed some issues when redrawing characters from other plugins. (1.3.6.8)") - .RegisterEntry( - "Added a modifier key separate from the delete modifier key that is used for less important key-checks, specifically toggling incognito mode. (1.3.6.7)") - .RegisterEntry("Fixed some issues with the Material Editor (Thanks Ny). (1.3.6.6)"); - - private static void Add1_3_6_4(Changelog log) - => log.NextVersion("Version 1.3.6.4") - .RegisterEntry("The material editor should be functional again."); - - private static void Add1_3_6_0(Changelog log) - => log.NextVersion("Version 1.3.6.0") - .RegisterImportant("Updated Penumbra for update 7.20 and Dalamud API 12.") - .RegisterEntry( - "This is not thoroughly tested, but I decided to push to stable instead of testing because otherwise a lot of people would just go to testing just for early access again despite having no business doing so.", - 1) - .RegisterEntry( - "I also do not use most of the functionality of Penumbra myself, so I am unable to even encounter most issues myself.", 1) - .RegisterEntry("If you encounter any issues, please report them quickly on the discord.", 1) - .RegisterHighlight( - "The texture editor now has encoding support for Block Compression 1, 4 and 5 and tooltips explaining when to use which format.") - .RegisterEntry("It also is able to use GPU compression and thus has become much faster for BC7 in particular. (Thanks Ny!)", 1) - .RegisterEntry( - "Added the option to import .atch files found in the particular mod via right-click context menu on the import drag & drop button.") - .RegisterEntry("Added a chat command to clear temporary settings done manually in Penumbra.") - .RegisterEntry( - "The changed item star to select the preferred changed item is a bit more noticeable by default, and its color can be configured.") - .RegisterEntry("Some minor fixes for computing changed items. (Thanks Anna!)") - .RegisterEntry("The EQP entry previously named Unknown 4 was renamed to 'Hide Glove Cuffs'.") - .RegisterEntry("Fixed the changed item identification for EST changes.") - .RegisterEntry("Fixed clipping issues in the changed items panel when no grouping was active."); - - - private static void Add1_3_5_0(Changelog log) - => log.NextVersion("Version 1.3.5.0") - .RegisterImportant( - "Redirections of unsupported file types like .atch will now produce warnings when they are enabled. Please update mods still containing them or request updates from their creators.") - .RegisterEntry("You can now import .atch in the Meta section of advanced editing to add their non-default changes to the mod.") - .RegisterHighlight("Added an option in settings and in the collection bar in the mod tab to always use temporary settings.") - .RegisterEntry( - "While this option is enabled, all changes you make in the current collection will be applied as temporary changes, and you have to use Turn Permanent to make them permanent.", - 1) - .RegisterEntry( - "This should be useful for trying out new mods without needing to reset their settings later, or for creating mod associations in Glamourer from them.", - 1) - .RegisterEntry( - "Added a context menu entry on the mod selector blank-space context menu to clear all temporary settings made manually.") - .RegisterHighlight( - "Resource Trees now consider some additional files like decals, and improved the quick-import behaviour for some files that should not generally be modded.") - .RegisterHighlight("The Changed Item display for single mods has been heavily improved.") - .RegisterEntry("Any changed item will now show how many individual edits are affecting it in the mod in its tooltip.", 1) - .RegisterEntry("Equipment pieces are now grouped by their model id, reducing clutter.", 1) - .RegisterEntry( - "The primary equipment piece displayed is the one with the most changes affecting it, but can be configured to a specific item by the mod creator and locally.", - 1) - .RegisterEntry( - "Preferred changed items stored in the mod will be shared when exporting the mod, and used as the default for local preferences, which will not be shared.", - 2) - .RegisterEntry( - "You can configure whether groups are automatically collapsed or expanded, or remove grouping entirely in the settings.", 1) - .RegisterHighlight("Fixed support for model import/export with more than one UV.") - .RegisterEntry("Added some IPC relating to changed items.") - .RegisterEntry("Skeleton and Physics changes should now be identified in Changed Items.") - .RegisterEntry("Item Swaps will now also correctly swap EQP entries of multi-slot pieces.") - .RegisterEntry("Meta edit transmission through IPC should be a lot more efficient than before.") - .RegisterEntry("Fixed an issue with incognito names in some cutscenes.") - .RegisterEntry("Newly extracted mod folders will now try to rename themselves three times before being considered a failure."); - - private static void Add1_3_4_0(Changelog log) - => log.NextVersion("Version 1.3.4.0") - .RegisterHighlight( - "Added HDR functionality to diffuse buffers. This allows more accurate representation of non-standard color values for e.g. skin or hair colors when used with advanced customizations in Glamourer.") - .RegisterEntry( - "This option requires Wait For Plugins On Load to be enabled in Dalamud and to be enabled on start to work. It is on by default but can be turned off.", - 1) - .RegisterHighlight("Added a new option group type: Combining Groups.") - .RegisterEntry( - "A combining group behaves similarly to a multi group for the user, but instead of enabling the different options separately, it results in exactly one option per choice of settings.", - 1) - .RegisterEntry( - "Example: The user sees 2 checkboxes [+25%, +50%], but the 4 different selection states result in +0%, +25%, +50% or +75% if both are toggled on. Every choice of settings can be configured separately by the mod creator.", - 1) - .RegisterEntry( - "Added new functionality to better track copies of the player character in cutscenes if they get forced to specific clothing, like in the Margrat cutscene. Might improve tracking in wedding ceremonies, too, let me know.") - .RegisterEntry("Added a display of the number of selected files and folders to the multi mod selection.") - .RegisterEntry( - "Added cleaning functionality to remove outdated or unused files or backups from the config and mod folders via manual action.") - .RegisterEntry("Updated the Bone and Material limits in the Model Importer.") - .RegisterEntry("Improved handling of IMC and Material files loaded asynchronously.") - .RegisterEntry("Added IPC functionality to query temporary settings.") - .RegisterEntry("Improved some mod setting IPC functions.") - .RegisterEntry("Fixed some path detection issues in the OnScreen tab.") - .RegisterEntry("Fixed some issues with temporary mod settings.") - .RegisterEntry("Fixed issues with IPC calls before the game has finished loading.") - .RegisterEntry("Fixed using the wrong dye channel in the material editor previews.") - .RegisterEntry("Added some log warnings if outdated materials are loaded by the game.") - .RegisterEntry("Added Schemas for some of the json files generated and read by Penumbra to the solution."); - - private static void Add1_3_3_0(Changelog log) - => log.NextVersion("Version 1.3.3.0") - .RegisterHighlight("Added Temporary Settings to collections.") - .RegisterEntry( - "Settings can be manually turned temporary (and turned back) while editing mod settings via right-click context on the mod or buttons in the settings panel.", - 1) - .RegisterEntry( - "This can be used to test mods or changes without saving those changes permanently or having to reinstate the old settings afterwards.", - 1) - .RegisterEntry( - "More importantly, this can be set via IPC by other plugins, allowing Glamourer to only set and reset temporary settings when applying Mod Associations.", - 1) - .RegisterEntry( - "As an extreme example, it would be possible to only enable the consistent mods for your character in the collection, and let Glamourer handle all outfit mods itself via temporary settings only.", - 1) - .RegisterEntry( - "This required some pretty big changes that were in testing for a while now, but nobody talked about it much so it may still have some bugs or usability issues. Let me know!", - 1) - .RegisterHighlight( - "Added an option to automatically select the collection assigned to the current character on login events. This is off by default.") - .RegisterEntry( - "Added partial copying of color tables in material editing via right-click context menu entries on the import buttons.") - .RegisterHighlight( - "Added handling for TMB files cached by the game that should resolve issues of leaky TMBs from animation and VFX mods.") - .RegisterEntry( - "The enabled checkbox, Priority and Inheriting buttons now stick at the top of the Mod Settings panel even when scrolling down for specific settings.") - .RegisterEntry("When creating new mods with Item Swap, the attributed author of the resulting mod was improved.") - .RegisterEntry("Fixed an issue with rings in the On-Screen tab and in the data sent over to other plugins via IPC.") - .RegisterEntry( - "Fixed some issues when writing material files that resulted in technically valid files that still caused some issues with the game for unknown reasons.") - .RegisterEntry("Fixed some ImGui assertions."); - - private static void Add1_3_2_0(Changelog log) - => log.NextVersion("Version 1.3.2.0") - .RegisterHighlight("Added ATCH meta manipulations that allow the composite editing of attachment points across multiple mods.") - .RegisterEntry("Those ATCH manipulations should be shared via Mare Synchronos.", 1) - .RegisterEntry( - "This is an early implementation and might be bug-prone. Let me know of any issues. It was in testing for quite a while without reports.", - 1) - .RegisterEntry( - "Added jumping to identified mods in the On-Screen tab via Control + Right-Click and improved their display slightly.") - .RegisterEntry("Added some right-click context menu copy options in the File Redirections editor for paths.") - .RegisterHighlight("Added the option to change a specific mod's settings via chat commands by using '/penumbra mod settings'.") - .RegisterEntry("Fixed issues with the copy-pasting of meta manipulations.") - .RegisterEntry("Fixed some other issues related to meta manipulations.") - .RegisterEntry( - "Updated available NPC names and fixed an issue with some supposedly invisible characters in names showing in ImGui."); - - - private static void Add1_3_1_0(Changelog log) - => log.NextVersion("Version 1.3.1.0") - .RegisterEntry("Penumbra has been updated for Dalamud API 11 and patch 7.1.") - .RegisterImportant( - "There are some known issues with potential crashes using certain VFX/SFX mods, probably related to sound files.") - .RegisterEntry( - "If you encounter those issues, please report them in the discord and potentially disable the corresponding mods for the time being.", - 1) - .RegisterImportant( - "The modding of .atch files has been disabled. Outdated modded versions of these files cause crashes when loaded.") - .RegisterEntry("A better way for modular modding of .atch files via meta changes will release to the testing branch soonish.", 1) - .RegisterHighlight("Temporary collections (as created by Mare) will now always respect ownership.") - .RegisterEntry( - "This means that you can toggle this setting off if you do not want it, and Mare will still work for minions and mounts of other players.", - 1) - .RegisterEntry( - "The new physics and animation engine files (.kdb and .bnmb) should now be correctly redirected and respect EST changes.") - .RegisterEntry("Fixed issues with EQP entries being labeled wrongly and global EQP not changing all required values for earrings.") - .RegisterEntry("Fixed an issue with global EQP changes of a mod being reset upon reloading the mod.") - .RegisterEntry("Fixed another issue with left rings and mare synchronization / the on-screen tab.") - .RegisterEntry("Maybe fixed some issues with characters appearing in the login screen being misidentified.") - .RegisterEntry("Some improvements for debug visualization have been made."); - - - private static void Add1_3_0_0(Changelog log) - => log.NextVersion("Version 1.3.0.0") - .RegisterHighlight("The textures tab in the advanced editing window can now import and export .tga files.") - .RegisterEntry("BC4 and BC6 textures can now also be imported.", 1) - .RegisterHighlight("Added item swapping from and to the Glasses slot.") - .RegisterEntry("Reworked quite a bit of things around face wear / bonus items. Please let me know if anything broke.", 1) - .RegisterEntry("The import date of a mod is now shown in the Edit Mod tab, and can be reset via button.") - .RegisterEntry("A button to open the file containing local mod data for a mod was also added.", 1) - .RegisterHighlight( - "IMC groups can now be configured to only apply the attribute flags for their entry, and take the other values from the default value.") - .RegisterEntry("This allows keeping the material index of every IMC entry of a group, while setting the attributes.", 1) - .RegisterHighlight("Model Import/Export was fixed and re-enabled (thanks ackwell and ramen).") - .RegisterHighlight("Added a hack to allow bonus items (face wear, glasses) to have VFX.") - .RegisterEntry("Also fixed the hack that allowed accessories to have VFX not working anymore.", 1) - .RegisterHighlight("Added rudimentary options to edit PBD files in the advanced editing window.") - .RegisterEntry("Preparing the advanced editing window for a mod now does not freeze the game until it is ready.") - .RegisterEntry( - "Meta Manipulations in the advanced editing window are now ordered and do not eat into performance as much when drawn.") - .RegisterEntry("Added a button to the advanced editing window to remove all default-valued meta manipulations from a mod") - .RegisterEntry( - "Default-valued manipulations will now also be removed on import from archives and .pmps, not just .ttmps, if not configured otherwise.", - 1) - .RegisterEntry("Checkbox-based mod filters are now tri-state checkboxes instead of two disjoint checkboxes.") - .RegisterEntry("Paths from the resource logger can now be copied.") - .RegisterEntry("Silenced some redundant error logs when updating mods via Heliosphere.") - .RegisterEntry("Added 'Page' to imported mod data for TexTools interop. The value is not used in Penumbra, just persisted.") - .RegisterEntry("Updated all external dependencies.") - .RegisterEntry("Fixed issue with Demihuman IMC entries.") - .RegisterEntry("Fixed some off-by-one errors on the mod import window.") - .RegisterEntry("Fixed a race-condition concerning the first-time creation of mod-meta files.") - .RegisterEntry("Fixed an issue with long mod titles in the merge mods tab.") - .RegisterEntry("A bunch of other miscellaneous fixes."); - - - private static void Add1_2_1_0(Changelog log) - => log.NextVersion("Version 1.2.1.0") - .RegisterHighlight("Penumbra is now released for Dawntrail!") - .RegisterEntry("Mods themselves may have to be updated. TexTools provides options for this.", 1) - .RegisterEntry("For model files, Penumbra provides a rudimentary update function, but prefer using TexTools if possible.", 1) - .RegisterEntry("Other files, like materials and textures, will have to go through TexTools for the moment.", 1) - .RegisterEntry( - "Some outdated mods can be identified by Penumbra and are prevented from loading entirely (specifically shaders, by Ny).", 1) - .RegisterImportant("I am sorry that it took this long, but there was an immense amount of work to be done from the start.") - .RegisterImportant( - "Since Penumbra has been in Testing for quite a while, multitudes of bugs and issues cropped up that needed to be dealt with.", - 1) - .RegisterEntry("There very well may still be a lot of issues, so please report any you find.", 1) - .RegisterImportant("BUT, please make sure that those issues are not caused by outdated mods before reporting them.", 1) - .RegisterEntry( - "This changelog may seem rather short for the timespan, but I omitted hundreds of smaller fixes and the details of getting Penumbra to work in Dawntrail.", - 1) - .RegisterHighlight("The Material Editing tab in the Advanced Editing Window has been heavily improved (by Ny).") - .RegisterEntry( - "Especially for Dawntrail materials using the new shaders, the window provides much more in-depth and user-friendly editing options.", - 1) - .RegisterHighlight("Many advancements regarding modded shaders, and modding bone deformers have been made.") - .RegisterHighlight("IMC groups now allow their options to toggle attributes off that are on in the default entry.") - .RegisterImportant( - "The 'Update Bibo' button was removed. The functionality is redundant since any mods that old need to be updated anyway.") - .RegisterEntry("Clicking the button on modern mods generally caused more harm than benefit.", 1) - .RegisterEntry( - "If you somehow still need to mass-migrate materials in your models, the Material Reassignment tab in Advanced Editing is still available for this.", - 1) - .RegisterEntry("The On-Screen tab was updated and improved and can now display modded actual paths in more useful form.") - .RegisterImportant("Model Import/Export is temporarily disabled until Dawntrail-related changes can be made.") - .RegisterHighlight("You can now change a mods state in any collection from its Collections tab via right-clicking the state.") - .RegisterHighlight("Items changed in a mod now sort before other items in the Item Swap tab, and are highlighted.") - .RegisterEntry("Path handling was improved in regards to case-sensitivity.") - .RegisterEntry("Fixed an issue with negative search matching on folders with no matches") - .RegisterEntry("Mod option groups on the same priority are now applied in reverse index order. (1.2.0.12)") - .RegisterEntry("Fixed the display of missing files in the Advanced Editing Window's header. (1.2.0.8)") - .RegisterEntry( - "Fixed some, but not all soft-locks that occur when your character gets redrawn while fishing. Just do not do that. (1.2.0.7)") - .RegisterEntry("Improved handling of invalid Offhand IMC files for certain jobs. (1.2.0.6)") - .RegisterEntry("Added automatic reduplication for files in the UI category, as they cause crashes when not unique. (1.2.0.5)") - .RegisterEntry("The mod import popup can now be closed by clicking outside of it, if it is finished. (1.2.0.5)") - .RegisterEntry("Fixed an issue with Mod Normalization skipping the default option. (1.2.0.5)") - .RegisterEntry("Improved the Support Info output. (1.1.1.5)") - .RegisterEntry("Reworked the handling of Meta Manipulations entirely. (1.1.1.3)") - .RegisterEntry("Added a configuration option to disable showing mods in the character lobby and at the aesthetician. (1.1.1.1)") - .RegisterEntry("Fixed an issue with the AddMods API and the root directory. (1.1.1.2)") - .RegisterEntry("Fixed an issue with the Mod Merger file lookup and casing. (1.1.1.2)") - .RegisterEntry("Fixed an issue with file saving not happening when merging mods or swapping items in some cases. (1.1.1.2)"); - - private static void Add1_1_1_0(Changelog log) - => log.NextVersion("Version 1.1.1.0") - .RegisterHighlight("Filtering for mods is now tokenized and can filter for multiple things at once, or exclude specific things.") - .RegisterEntry("Hover over the filter to see the new available options in the tooltip.", 1) - .RegisterEntry("Be aware that the tokenization changed the prior behavior slightly.", 1) - .RegisterEntry("This is open to improvements, if you have any ideas, let me know!", 1) - .RegisterHighlight("Added initial identification of characters in the login-screen by name.") - .RegisterEntry( - "Those characters can not be redrawn and re-use some things, so this may not always behave as expected, but should work in general. Let me know if you encounter edge cases!", - 1) - .RegisterEntry("Added functionality for IMC groups to apply to all variants for a model instead of a specific one.") - .RegisterEntry("Improved the resource tree view with filters and incognito mode. (by Ny)") - .RegisterEntry("Added a tooltip to the global EQP condition.") - .RegisterEntry("Fixed the new worlds not being identified correctly because Square Enix could not be bothered to turn them public.") - .RegisterEntry("Fixed model import getting stuck when doing weight adjustments. (by ackwell)") - .RegisterEntry("Fixed an issue with dye previews in the material editor not applying.") - .RegisterEntry("Fixed an issue with collections not saving on renames.") - .RegisterEntry("Fixed an issue parsing collections with settings set to negative values, which should now be set to 0.") - .RegisterEntry("Fixed an issue with the accessory VFX addition.") - .RegisterEntry("Fixed an issue with GMP animation type entries.") - .RegisterEntry("Fixed another issue with the mod merger.") - .RegisterEntry("Fixed an issue with IMC groups and IPC.") - .RegisterEntry("Fixed some issues with the capitalization of the root directory.") - .RegisterEntry("Fixed IMC attribute tooltips not appearing for disabled checkboxes.") - .RegisterEntry("Added GetChangedItems IPC for single mods. (1.1.0.2)") - .RegisterEntry("Fixed an issue with creating unnamed collections. (1.1.0.2)") - .RegisterEntry("Fixed an issue with the mod merger. (1.1.0.2)") - .RegisterEntry("Fixed the global EQP entry for rings checking for bracelets instead of rings. (1.1.0.2)") - .RegisterEntry("Fixed an issue with newly created collections not being added to the collection list. (1.1.0.1)"); - - private static void Add1_1_0_0(Changelog log) - => log.NextVersion("Version 1.1.0.0") + private static void Add1_0_3_0(Changelog log) + => log.NextVersion("Version 1.0.3.0") .RegisterImportant( "This update comes, again, with a lot of very heavy backend changes (collections and groups) and thus may introduce new issues.") - .RegisterEntry("Updated to .net8 and XIV 6.58, using some new framework facilities to improve performance and stability.") - .RegisterHighlight( - "Added an experimental crash handler that is supposed to write a Penumbra.log file when the game crashes, containing Penumbra-specific information.") - .RegisterEntry("This is disabled by default. It can be enabled in Advanced Settings.", 1) .RegisterHighlight("Collections now have associated GUIDs as identifiers instead of their names, so they can now be renamed.") .RegisterEntry("Migrating those collections may introduce issues, please let me know as soon as possible if you encounter any.", 1) .RegisterEntry("A permanent (non-rolling) backup should be created before the migration in case of any issues.", 1) - .RegisterHighlight( - "Added predefined tags that can be setup in the Settings tab and can be more easily applied or removed from mods. (by DZD)") .RegisterHighlight( "A total rework of how options and groups are handled internally, and introduction of the first new group type, the IMC Group.") .RegisterEntry( @@ -456,14 +75,9 @@ public class PenumbraChangelog : IUiService .RegisterEntry( "This can be used if something like a jacket or a stole is put onto an accessory to prevent it from being hidden in general.", 1) - .RegisterEntry( - "The first empty option in a single-select option group imported from a TTMP will now keep its location instead of being moved to the first option.") - .RegisterEntry("Further empty options are still removed.", 1) .RegisterHighlight( "Added a field to rename mods directly from the mod selector context menu, instead of moving them in the filesystem.") .RegisterEntry("You can choose which rename field (none, either one or both) to display in the settings.", 1) - .RegisterEntry("Added the characterglass.shpk shader file to special shader treatment to fix issues when replacing it. (By Ny)") - .RegisterEntry("Made it more obvious if a user has not set their root directory yet.") .RegisterEntry( "You can now paste your current clipboard text into the mod selector filter with a simple right-click as long as it is not focused.") .RegisterHighlight( @@ -474,18 +88,29 @@ public class PenumbraChangelog : IUiService .RegisterEntry("Removed the auto-generated descriptions for newly created groups in Penumbra.") .RegisterEntry( "Made some improvements to the Advanced Editing window, for example a much better and more performant Hex Viewer for unstructured data was added.") - .RegisterEntry("Various improvements to model import/export by ackwell (throughout all patches).") - .RegisterEntry( - "Hovering over meta manipulations in other options in the advanced editing window now shows a list of those options.") + .RegisterEntry("Made a lot of further improvements on Model import/export (by ackwell).") .RegisterEntry("Reworked the API and IPC structure heavily.") - .RegisterImportant("This means some plugins interacting with Penumbra may not work correctly until they update.", 1) .RegisterEntry("Worked around the UI IPC possibly displacing all settings when the drawn additions became too big.") - .RegisterEntry("Fixed an issue where reloading a mod did not ensure settings for that mod being correct afterwards.") - .RegisterEntry("Fixed some issues with the file sizes of compressed files.") .RegisterEntry("Fixed an issue with merging and deduplicating mods.") .RegisterEntry("Fixed a crash when scanning for mods without access rights to the folder.") .RegisterEntry( - "Made plugin conform to Dalamud requirements by adding a punchline and another button to open the menu from the installer.") + "Made plugin conform to Dalamud requirements by adding a punchline and another button to open the menu from the installer."); + + private static void Add1_0_2_0(Changelog log) + => log.NextVersion("Version 1.0.2.0") + .RegisterEntry("Updated to .net8 and XIV 6.58, using some new framework facilities to improve performance and stability.") + .RegisterHighlight( + "Added an experimental crash handler that is supposed to write a Penumbra.log file when the game crashes, containing Penumbra-specific information.") + .RegisterEntry("Various improvements to model import/export by ackwell (throughout all patches).") + .RegisterHighlight( + "Added predefined tags that can be setup in the Settings tab and can be more easily applied or removed from mods. (by DZD)") + .RegisterEntry( + "The first empty option in a single-select option group imported from a TTMP will now keep its location instead of being moved to the first option.") + .RegisterEntry("Further empty options are still removed.", 1) + .RegisterEntry("Made it more obvious if a user has not set their root directory yet.") + .RegisterEntry("Added the characterglass.shpk shader file to special shader treatment to fix issues when replacing it. (By Ny)") + .RegisterEntry("Fixed some issues with the file sizes of compressed files.") + .RegisterEntry("Fixed an issue where reloading a mod did not ensure settings for that mod being correct afterwards.") .RegisterEntry("Added an option to automatically redraw the player character when saving files. (1.0.0.8)") .RegisterEntry("Fixed issue with manipulating mods not triggering some events. (1.0.0.7)") .RegisterEntry("Fixed issue with temporary mods not triggering some events. (1.0.0.6)") @@ -1137,9 +762,6 @@ public class PenumbraChangelog : IUiService #endregion - private static void AddDummy(Changelog log) - => log.NextVersion(string.Empty); - private (int, ChangeLogDisplayType) ConfigData() => (_config.Ephemeral.LastSeenVersion, _config.ChangeLogDisplayType); diff --git a/Penumbra/UI/Classes/CollectionSelectHeader.cs b/Penumbra/UI/Classes/CollectionSelectHeader.cs index 355a6106..bff0092a 100644 --- a/Penumbra/UI/Classes/CollectionSelectHeader.cs +++ b/Penumbra/UI/Classes/CollectionSelectHeader.cs @@ -1,35 +1,30 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui; +using ImGuiNET; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; +using OtterGui; using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.Interop.PathResolving; -using Penumbra.Mods; using Penumbra.UI.CollectionTab; +using Penumbra.UI.ModsTab; namespace Penumbra.UI.Classes; -public class CollectionSelectHeader : IUiService +public class CollectionSelectHeader { - private readonly CollectionCombo _collectionCombo; - private readonly ActiveCollections _activeCollections; - private readonly TutorialService _tutorial; - private readonly ModSelection _selection; - private readonly CollectionResolver _resolver; - private readonly Configuration _config; + private readonly CollectionCombo _collectionCombo; + private readonly ActiveCollections _activeCollections; + private readonly TutorialService _tutorial; + private readonly ModFileSystemSelector _selector; + private readonly CollectionResolver _resolver; - public CollectionSelectHeader(CollectionManager collectionManager, TutorialService tutorial, ModSelection selection, - CollectionResolver resolver, Configuration config) + public CollectionSelectHeader(CollectionManager collectionManager, TutorialService tutorial, ModFileSystemSelector selector, + CollectionResolver resolver) { _tutorial = tutorial; - _selection = selection; + _selector = selector; _resolver = resolver; - _config = config; _activeCollections = collectionManager.Active; - _collectionCombo = new CollectionCombo(collectionManager, () => collectionManager.Storage.OrderBy(c => c.Identity.Name).ToList()); + _collectionCombo = new CollectionCombo(collectionManager, () => collectionManager.Storage.OrderBy(c => c.Name).ToList()); } /// Draw the header line that can quick switch between collections. @@ -37,15 +32,13 @@ public class CollectionSelectHeader : IUiService { using var style = ImRaii.PushStyle(ImGuiStyleVar.FrameRounding, 0) .Push(ImGuiStyleVar.ItemSpacing, new Vector2(0, spacing ? ImGui.GetStyle().ItemSpacing.Y : 0)); - DrawTemporaryCheckbox(); - ImGui.SameLine(); var comboWidth = ImGui.GetContentRegionAvail().X / 4f; var buttonSize = new Vector2(comboWidth * 3f / 4f, 0f); using (var _ = ImRaii.Group()) { - DrawCollectionButton(buttonSize, GetDefaultCollectionInfo(), 1); + DrawCollectionButton(buttonSize, GetDefaultCollectionInfo(), 1); DrawCollectionButton(buttonSize, GetInterfaceCollectionInfo(), 2); - DrawCollectionButton(buttonSize, GetPlayerCollectionInfo(), 3); + DrawCollectionButton(buttonSize, GetPlayerCollectionInfo(), 3); DrawCollectionButton(buttonSize, GetInheritedCollectionInfo(), 4); _collectionCombo.Draw("##collectionSelector", comboWidth, ColorId.SelectedCollection.Value()); @@ -57,30 +50,6 @@ public class CollectionSelectHeader : IUiService ImGuiUtil.DrawTextButton("The currently selected collection is not used in any way.", -Vector2.UnitX, Colors.PressEnterWarningBg); } - private void DrawTemporaryCheckbox() - { - var hold = _config.IncognitoModifier.IsActive(); - using (ImRaii.PushStyle(ImGuiStyleVar.FrameBorderSize, ImUtf8.GlobalScale)) - { - var tint = _config.DefaultTemporaryMode - ? ImGuiCol.Text.Tinted(ColorId.TemporaryModSettingsTint) - : ImGui.GetColorU32(ImGuiCol.TextDisabled); - using var color = ImRaii.PushColor(ImGuiCol.ButtonHovered, ImGui.GetColorU32(ImGuiCol.FrameBg), !hold) - .Push(ImGuiCol.ButtonActive, ImGui.GetColorU32(ImGuiCol.FrameBg), !hold) - .Push(ImGuiCol.Border, tint, _config.DefaultTemporaryMode); - if (ImUtf8.IconButton(FontAwesomeIcon.Stopwatch, ""u8, default, false, tint, ImGui.GetColorU32(ImGuiCol.FrameBg)) && hold) - { - _config.DefaultTemporaryMode = !_config.DefaultTemporaryMode; - _config.Save(); - } - } - - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, - "Toggle the temporary settings mode, where all changes you do create temporary settings first and need to be made permanent if desired."u8); - if (!hold) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"\nHold {_config.IncognitoModifier} while clicking to toggle."); - } - private enum CollectionState { Empty, @@ -107,10 +76,10 @@ public class CollectionSelectHeader : IUiService return CheckCollection(collection) switch { CollectionState.Empty => (collection, "None", "The base collection is configured to use no mods.", true), - CollectionState.Selected => (collection, collection.Identity.Name, + CollectionState.Selected => (collection, collection.Name, "The configured base collection is already selected as the current collection.", true), - CollectionState.Available => (collection, collection.Identity.Name, - $"Select the configured base collection {collection.Identity.Name} as the current collection.", false), + CollectionState.Available => (collection, collection.Name, + $"Select the configured base collection {collection.Name} as the current collection.", false), _ => throw new Exception("Can not happen."), }; } @@ -121,11 +90,10 @@ public class CollectionSelectHeader : IUiService return CheckCollection(collection) switch { CollectionState.Empty => (collection, "None", "The loaded player character is configured to use no mods.", true), - CollectionState.Selected => (collection, collection.Identity.Name, + CollectionState.Selected => (collection, collection.Name, "The collection configured to apply to the loaded player character is already selected as the current collection.", true), - CollectionState.Available => (collection, collection.Identity.Name, - $"Select the collection {collection.Identity.Name} that applies to the loaded player character as the current collection.", - false), + CollectionState.Available => (collection, collection.Name, + $"Select the collection {collection.Name} that applies to the loaded player character as the current collection.", false), _ => throw new Exception("Can not happen."), }; } @@ -136,23 +104,23 @@ public class CollectionSelectHeader : IUiService return CheckCollection(collection) switch { CollectionState.Empty => (collection, "None", "The interface collection is configured to use no mods.", true), - CollectionState.Selected => (collection, collection.Identity.Name, + CollectionState.Selected => (collection, collection.Name, "The configured interface collection is already selected as the current collection.", true), - CollectionState.Available => (collection, collection.Identity.Name, - $"Select the configured interface collection {collection.Identity.Name} as the current collection.", false), + CollectionState.Available => (collection, collection.Name, + $"Select the configured interface collection {collection.Name} as the current collection.", false), _ => throw new Exception("Can not happen."), }; } private (ModCollection?, string, string, bool) GetInheritedCollectionInfo() { - var collection = _selection.Mod == null ? null : _selection.Collection; + var collection = _selector.Selected == null ? null : _selector.SelectedSettingCollection; return CheckCollection(collection, true) switch { CollectionState.Unavailable => (null, "Not Inherited", "The settings of the selected mod are not inherited from another collection.", true), - CollectionState.Available => (collection, collection!.Identity.Name, - $"Select the collection {collection!.Identity.Name} from which the selected mod inherits its settings as the current collection.", + CollectionState.Available => (collection, collection!.Name, + $"Select the collection {collection!.Name} from which the selected mod inherits its settings as the current collection.", false), _ => throw new Exception("Can not happen."), }; diff --git a/Penumbra/UI/Classes/Colors.cs b/Penumbra/UI/Classes/Colors.cs index 90ef0591..4d0c62af 100644 --- a/Penumbra/UI/Classes/Colors.cs +++ b/Penumbra/UI/Classes/Colors.cs @@ -1,9 +1,8 @@ -using Dalamud.Bindings.ImGui; using OtterGui.Custom; namespace Penumbra.UI.Classes; -public enum ColorId : short +public enum ColorId { EnabledMod, DisabledMod, @@ -11,7 +10,6 @@ public enum ColorId : short InheritedMod, InheritedDisabledMod, NewMod, - NewModTint, ConflictingMod, HandledConflictMod, FolderExpanded, @@ -26,16 +24,12 @@ public enum ColorId : short NoAssignment, SelectorPriority, InGameHighlight, - InGameHighlight2, ResTreeLocalPlayer, ResTreePlayer, ResTreeNetworked, ResTreeNonNetworked, PredefinedTagAdd, PredefinedTagRemove, - TemporaryModSettingsTint, - ChangedItemPreferenceStar, - NoTint, } public static class Colors @@ -53,66 +47,37 @@ public static class Colors public const uint ReniColorHovered = CustomGui.ReniColorHovered; public const uint ReniColorActive = CustomGui.ReniColorActive; - public static uint Tinted(this ColorId color, ColorId tint) - { - var tintValue = ImGui.ColorConvertU32ToFloat4(tint.Value()); - var value = ImGui.ColorConvertU32ToFloat4(color.Value()); - return ImGui.ColorConvertFloat4ToU32(TintColor(value, tintValue)); - } - - public static unsafe uint Tinted(this ImGuiCol color, ColorId tint) - { - var tintValue = ImGui.ColorConvertU32ToFloat4(tint.Value()); - ref var value = ref *ImGui.GetStyleColorVec4(color); - return ImGui.ColorConvertFloat4ToU32(TintColor(value, tintValue)); - } - - private static unsafe Vector4 TintColor(in Vector4 color, in Vector4 tint) - { - var negAlpha = 1 - tint.W; - var newAlpha = negAlpha * color.W + tint.W; - var newR = (negAlpha * color.W * color.X + tint.W * tint.X) / newAlpha; - var newG = (negAlpha * color.W * color.Y + tint.W * tint.Y) / newAlpha; - var newB = (negAlpha * color.W * color.Z + tint.W * tint.Z) / newAlpha; - return new Vector4(newR, newG, newB, newAlpha); - } - public static (uint DefaultColor, string Name, string Description) Data(this ColorId color) => color switch { // @formatter:off - ColorId.EnabledMod => ( 0xFFFFFFFF, "Enabled Mod", "A mod that is enabled by the currently selected collection." ), - ColorId.DisabledMod => ( 0xFF686880, "Disabled Mod", "A mod that is disabled by the currently selected collection." ), - ColorId.UndefinedMod => ( 0xFF808080, "Mod With No Settings", "A mod that is not configured in the currently selected collection or any of the collections it inherits from, and thus implicitly disabled." ), - ColorId.InheritedMod => ( 0xFFD0FFFF, "Mod Enabled By Inheritance", "A mod that is not configured in the currently selected collection, but enabled in a collection it inherits from." ), - ColorId.InheritedDisabledMod => ( 0xFF688080, "Mod Disabled By Inheritance", "A mod that is not configured in the currently selected collection, but disabled in a collection it inherits from."), - ColorId.NewMod => ( 0xFF66DD66, "New Mod", "A mod that was newly imported or created during this session and has not been enabled yet." ), - ColorId.ConflictingMod => ( 0xFFAAAAFF, "Mod With Unresolved Conflicts", "An enabled mod that has conflicts with another enabled mod on the same priority level." ), - ColorId.HandledConflictMod => ( 0xFFD0FFD0, "Mod With Resolved Conflicts", "An enabled mod that has conflicts with another enabled mod on a different priority level." ), - ColorId.FolderExpanded => ( 0xFFFFF0C0, "Expanded Mod Folder", "A mod folder that is currently expanded." ), - ColorId.FolderCollapsed => ( 0xFFFFF0C0, "Collapsed Mod Folder", "A mod folder that is currently collapsed." ), - ColorId.FolderLine => ( 0xFFFFF0C0, "Expanded Mod Folder Line", "The line signifying which descendants belong to an expanded mod folder." ), - ColorId.ItemId => ( 0xFF808080, "Item Id", "The numeric model id of the given item to the right of changed items." ), - ColorId.IncreasedMetaValue => ( 0x80008000, "Increased Meta Manipulation Value", "An increased meta manipulation value for floats or an enabled toggle where the default is disabled."), - ColorId.DecreasedMetaValue => ( 0x80000080, "Decreased Meta Manipulation Value", "A decreased meta manipulation value for floats or a disabled toggle where the default is enabled."), - ColorId.SelectedCollection => ( 0x6069C056, "Currently Selected Collection", "The collection that is currently selected and being edited."), - ColorId.RedundantAssignment => ( 0x6050D0D0, "Redundant Collection Assignment", "A collection assignment that currently has no effect as it is redundant with more general assignments."), - ColorId.NoModsAssignment => ( 0x50000080, "'Use No Mods' Collection Assignment", "A collection assignment set to not use any mods at all."), - ColorId.NoAssignment => ( 0x00000000, "Unassigned Collection Assignment", "A collection assignment that is not configured to any collection and thus just has no specific treatment."), - ColorId.SelectorPriority => ( 0xFF808080, "Mod Selector Priority", "The priority displayed for non-zero priority mods in the mod selector."), - ColorId.InGameHighlight => ( 0xFFEBCF89, "In-Game Highlight (Primary)", "An in-game element that has been highlighted for ease of editing."), - ColorId.InGameHighlight2 => ( 0xFF446CC0, "In-Game Highlight (Secondary)", "Another in-game element that has been highlighted for ease of editing."), - ColorId.ResTreeLocalPlayer => ( 0xFFFFE0A0, "On-Screen: You", "You and what you own (mount, minion, accessory, pets and so on), in the On-Screen tab." ), - ColorId.ResTreePlayer => ( 0xFFC0FFC0, "On-Screen: Other Players", "Other players and what they own, in the On-Screen tab." ), - ColorId.ResTreeNetworked => ( 0xFFFFFFFF, "On-Screen: Non-Players (Networked)", "Non-player entities handled by the game server, in the On-Screen tab." ), - ColorId.ResTreeNonNetworked => ( 0xFFC0C0FF, "On-Screen: Non-Players (Local)", "Non-player entities handled locally, in the On-Screen tab." ), - ColorId.PredefinedTagAdd => ( 0xFF44AA44, "Predefined Tags: Add Tag", "A predefined tag that is not present on the current mod and can be added." ), - ColorId.PredefinedTagRemove => ( 0xFF2222AA, "Predefined Tags: Remove Tag", "A predefined tag that is already present on the current mod and can be removed." ), - ColorId.TemporaryModSettingsTint => ( 0x30FF0000, "Mod with Temporary Settings", "A mod that has temporary settings. This color is used as a tint for the regular state colors." ), - ColorId.NewModTint => ( 0x8000FF00, "New Mod Tint", "A mod that was newly imported or created during this session and has not been enabled yet. This color is used as a tint for the regular state colors."), - ColorId.NoTint => ( 0x00000000, "No Tint", "The default tint for all mods."), - ColorId.ChangedItemPreferenceStar => ( 0x30FFFFFF, "Preferred Changed Item Star", "The color of the star button in the mod panel's changed items tab to prioritize specific items."), - _ => throw new ArgumentOutOfRangeException( nameof( color ), color, null ), + ColorId.EnabledMod => ( 0xFFFFFFFF, "Enabled Mod", "A mod that is enabled by the currently selected collection." ), + ColorId.DisabledMod => ( 0xFF686880, "Disabled Mod", "A mod that is disabled by the currently selected collection." ), + ColorId.UndefinedMod => ( 0xFF808080, "Mod With No Settings", "A mod that is not configured in the currently selected collection or any of the collections it inherits from, and thus implicitly disabled." ), + ColorId.InheritedMod => ( 0xFFD0FFFF, "Mod Enabled By Inheritance", "A mod that is not configured in the currently selected collection, but enabled in a collection it inherits from." ), + ColorId.InheritedDisabledMod => ( 0xFF688080, "Mod Disabled By Inheritance", "A mod that is not configured in the currently selected collection, but disabled in a collection it inherits from."), + ColorId.NewMod => ( 0xFF66DD66, "New Mod", "A mod that was newly imported or created during this session and has not been enabled yet." ), + ColorId.ConflictingMod => ( 0xFFAAAAFF, "Mod With Unresolved Conflicts", "An enabled mod that has conflicts with another enabled mod on the same priority level." ), + ColorId.HandledConflictMod => ( 0xFFD0FFD0, "Mod With Resolved Conflicts", "An enabled mod that has conflicts with another enabled mod on a different priority level." ), + ColorId.FolderExpanded => ( 0xFFFFF0C0, "Expanded Mod Folder", "A mod folder that is currently expanded." ), + ColorId.FolderCollapsed => ( 0xFFFFF0C0, "Collapsed Mod Folder", "A mod folder that is currently collapsed." ), + ColorId.FolderLine => ( 0xFFFFF0C0, "Expanded Mod Folder Line", "The line signifying which descendants belong to an expanded mod folder." ), + ColorId.ItemId => ( 0xFF808080, "Item Id", "The numeric model id of the given item to the right of changed items." ), + ColorId.IncreasedMetaValue => ( 0x80008000, "Increased Meta Manipulation Value", "An increased meta manipulation value for floats or an enabled toggle where the default is disabled."), + ColorId.DecreasedMetaValue => ( 0x80000080, "Decreased Meta Manipulation Value", "A decreased meta manipulation value for floats or a disabled toggle where the default is enabled."), + ColorId.SelectedCollection => ( 0x6069C056, "Currently Selected Collection", "The collection that is currently selected and being edited."), + ColorId.RedundantAssignment => ( 0x6050D0D0, "Redundant Collection Assignment", "A collection assignment that currently has no effect as it is redundant with more general assignments."), + ColorId.NoModsAssignment => ( 0x50000080, "'Use No Mods' Collection Assignment", "A collection assignment set to not use any mods at all."), + ColorId.NoAssignment => ( 0x00000000, "Unassigned Collection Assignment", "A collection assignment that is not configured to any collection and thus just has no specific treatment."), + ColorId.SelectorPriority => ( 0xFF808080, "Mod Selector Priority", "The priority displayed for non-zero priority mods in the mod selector."), + ColorId.InGameHighlight => ( 0xFFEBCF89, "In-Game Highlight", "An in-game element that has been highlighted for ease of editing."), + ColorId.ResTreeLocalPlayer => ( 0xFFFFE0A0, "On-Screen: You", "You and what you own (mount, minion, accessory, pets and so on), in the On-Screen tab." ), + ColorId.ResTreePlayer => ( 0xFFC0FFC0, "On-Screen: Other Players", "Other players and what they own, in the On-Screen tab." ), + ColorId.ResTreeNetworked => ( 0xFFFFFFFF, "On-Screen: Non-Players (Networked)", "Non-player entities handled by the game server, in the On-Screen tab." ), + ColorId.ResTreeNonNetworked => ( 0xFFC0C0FF, "On-Screen: Non-Players (Local)", "Non-player entities handled locally, in the On-Screen tab." ), + ColorId.PredefinedTagAdd => ( 0xFF44AA44, "Predefined Tags: Add Tag", "A predefined tag that is not present on the current mod and can be added." ), + ColorId.PredefinedTagRemove => ( 0xFF2222AA, "Predefined Tags: Remove Tag", "A predefined tag that is already present on the current mod and can be removed." ), + _ => throw new ArgumentOutOfRangeException( nameof( color ), color, null ), // @formatter:on }; diff --git a/Penumbra/UI/Classes/Combos.cs b/Penumbra/UI/Classes/Combos.cs index 234f7a3e..253bf0e0 100644 --- a/Penumbra/UI/Classes/Combos.cs +++ b/Penumbra/UI/Classes/Combos.cs @@ -33,7 +33,7 @@ public static class Combos => ImGuiUtil.GenericEnumCombo(label, unscaledWidth * UiHelpers.Scale, current, out attribute, RspAttributeExtensions.ToFullString, 0, 1); - public static bool EstSlot(string label, EstType current, out EstType attribute, float unscaledWidth = 200) + public static bool EstSlot(string label, EstManipulation.EstType current, out EstManipulation.EstType attribute, float unscaledWidth = 200) => ImGuiUtil.GenericEnumCombo(label, unscaledWidth * UiHelpers.Scale, current, out attribute); public static bool ImcType(string label, ObjectType current, out ObjectType type, float unscaledWidth = 110) diff --git a/Penumbra/UI/Classes/MigrationSectionDrawer.cs b/Penumbra/UI/Classes/MigrationSectionDrawer.cs deleted file mode 100644 index 98a59a5b..00000000 --- a/Penumbra/UI/Classes/MigrationSectionDrawer.cs +++ /dev/null @@ -1,163 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Services; - -namespace Penumbra.UI.Classes; - -public class MigrationSectionDrawer(MigrationManager migrationManager, Configuration config) : IUiService -{ - private bool _createBackups = true; - private Vector2 _buttonSize; - - public void Draw() - { - using var header = ImUtf8.CollapsingHeaderId("Migration"u8); - if (!header) - return; - - _buttonSize = UiHelpers.InputTextWidth; - DrawSettings(); - ImGui.Separator(); - DrawMdlMigration(); - DrawMdlRestore(); - DrawMdlCleanup(); - // TODO enable when this works - ImGui.Separator(); - //DrawMtrlMigration(); - DrawMtrlRestore(); - DrawMtrlCleanup(); - } - - private void DrawSettings() - { - var value = config.MigrateImportedModelsToV6; - if (ImUtf8.Checkbox("Automatically Migrate V5 Models to V6 on Import"u8, ref value)) - { - config.MigrateImportedModelsToV6 = value; - config.Save(); - } - - ImUtf8.HoverTooltip("This increments the version marker and restructures the bone table to the new version."u8); - - // TODO enable when this works - //value = config.MigrateImportedMaterialsToLegacy; - //if (ImUtf8.Checkbox("Automatically Migrate Materials to Dawntrail on Import"u8, ref value)) - //{ - // config.MigrateImportedMaterialsToLegacy = value; - // config.Save(); - //} - // - //ImUtf8.HoverTooltip( - // "This currently only increases the color-table size and switches the shader from 'character.shpk' to 'characterlegacy.shpk', if the former is used."u8); - - ImUtf8.Checkbox("Create Backups During Manual Migration", ref _createBackups); - } - - private static ReadOnlySpan MigrationTooltip - => "Cancel the migration. This does not revert already finished migrations."u8; - - private void DrawMdlMigration() - { - if (ImUtf8.ButtonEx("Migrate Model Files From V5 to V6"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.MigrateMdlDirectory(config.ModDirectory, _createBackups); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MdlMigration, "Cancel the migration. This does not revert already finished migrations."u8); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MdlMigration, IsRunning: true }); - DrawData(migrationManager.MdlMigration, "No model files found."u8, "migrated"u8); - } - - private void DrawMtrlMigration() - { - if (ImUtf8.ButtonEx("Migrate Material Files to Dawntrail"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.MigrateMtrlDirectory(config.ModDirectory, _createBackups); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MtrlMigration, MigrationTooltip); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MtrlMigration, IsRunning: true }); - DrawData(migrationManager.MtrlMigration, "No material files found."u8, "migrated"u8); - } - - - private static ReadOnlySpan CleanupTooltip - => "Cancel the cleanup. This is not revertible."u8; - - private void DrawMdlCleanup() - { - if (ImUtf8.ButtonEx("Delete Existing Model Backup Files"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.CleanMdlBackups(config.ModDirectory); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MdlCleanup, CleanupTooltip); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MdlCleanup, IsRunning: true }); - DrawData(migrationManager.MdlCleanup, "No model backup files found."u8, "deleted"u8); - } - - private void DrawMtrlCleanup() - { - if (ImUtf8.ButtonEx("Delete Existing Material Backup Files"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.CleanMtrlBackups(config.ModDirectory); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MtrlCleanup, CleanupTooltip); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MtrlCleanup, IsRunning: true }); - DrawData(migrationManager.MtrlCleanup, "No material backup files found."u8, "deleted"u8); - } - - private static ReadOnlySpan RestorationTooltip - => "Cancel the restoration. This does not revert already finished restoration."u8; - - private void DrawMdlRestore() - { - if (ImUtf8.ButtonEx("Restore Model Backups"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.RestoreMdlBackups(config.ModDirectory); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MdlRestoration, RestorationTooltip); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MdlRestoration, IsRunning: true }); - DrawData(migrationManager.MdlRestoration, "No model backup files found."u8, "restored"u8); - } - - private void DrawMtrlRestore() - { - if (ImUtf8.ButtonEx("Restore Material Backups"u8, "\0"u8, _buttonSize, migrationManager.IsRunning)) - migrationManager.RestoreMtrlBackups(config.ModDirectory); - - ImUtf8.SameLineInner(); - DrawCancelButton(MigrationManager.TaskType.MtrlRestoration, RestorationTooltip); - DrawSpinner(migrationManager is { CurrentTask: MigrationManager.TaskType.MtrlRestoration, IsRunning: true }); - DrawData(migrationManager.MtrlRestoration, "No material backup files found."u8, "restored"u8); - } - - private static void DrawSpinner(bool enabled) - { - if (!enabled) - return; - - ImGui.SameLine(); - ImUtf8.Spinner("Spinner"u8, ImGui.GetTextLineHeight() / 2, 2, ImGui.GetColorU32(ImGuiCol.Text)); - } - - private void DrawCancelButton(MigrationManager.TaskType task, ReadOnlySpan tooltip) - { - using var _ = ImUtf8.PushId((int)task); - if (ImUtf8.ButtonEx("Cancel"u8, tooltip, disabled: !migrationManager.IsRunning || task != migrationManager.CurrentTask)) - migrationManager.Cancel(); - } - - private static void DrawData(MigrationManager.MigrationData data, ReadOnlySpan empty, ReadOnlySpan action) - { - if (!data.HasData) - { - ImUtf8.IconDummy(); - return; - } - - var total = data.Total; - if (total == 0) - ImUtf8.TextFrameAligned(empty); - else - ImUtf8.TextFrameAligned($"{data.Changed} files {action}, {data.Failed} files failed, {total} files found."); - } -} diff --git a/Penumbra/UI/CollectionTab/CollectionCombo.cs b/Penumbra/UI/CollectionTab/CollectionCombo.cs index bf97f178..9d195eed 100644 --- a/Penumbra/UI/CollectionTab/CollectionCombo.cs +++ b/Penumbra/UI/CollectionTab/CollectionCombo.cs @@ -1,15 +1,14 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Extensions; +using ImGuiNET; using OtterGui.Raii; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Collections; using Penumbra.Collections.Manager; +using Penumbra.GameData.Actors; namespace Penumbra.UI.CollectionTab; public sealed class CollectionCombo(CollectionManager manager, Func> items) - : FilterComboCache(items, MouseWheelType.Control, Penumbra.Log) + : FilterComboCache(items, MouseWheelType.None, Penumbra.Log) { private readonly ImRaii.Color _color = new(); @@ -21,26 +20,14 @@ public sealed class CollectionCombo(CollectionManager manager, Func obj.Identity.Name; - - protected override void DrawCombo(string label, string preview, string tooltip, int currentSelected, float previewWidth, float itemHeight, - ImGuiComboFlags flags) - { - base.DrawCombo(label, preview, tooltip, currentSelected, previewWidth, itemHeight, flags); - ImUtf8.HoverTooltip("Control and mouse wheel to scroll."u8); - } + => obj.Name; } diff --git a/Penumbra/UI/CollectionTab/CollectionPanel.cs b/Penumbra/UI/CollectionTab/CollectionPanel.cs index 7a8ca032..bb22e6a7 100644 --- a/Penumbra/UI/CollectionTab/CollectionPanel.cs +++ b/Penumbra/UI/CollectionTab/CollectionPanel.cs @@ -2,17 +2,14 @@ using Dalamud.Game.ClientState.Objects; using Dalamud.Interface; using Dalamud.Interface.Components; using Dalamud.Interface.GameFonts; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Interface.ManagedFontAtlas; using Dalamud.Interface.Utility; using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; -using Dalamud.Plugin.Services; +using ImGuiNET; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Text; using Penumbra.Collections; using Penumbra.Collections.Manager; using Penumbra.GameData.Actors; @@ -23,23 +20,18 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.CollectionTab; -public sealed class CollectionPanel( - IDalamudPluginInterface pi, - CommunicatorService communicator, - CollectionManager manager, - CollectionSelector selector, - ActorManager actors, - ITargetManager targets, - ModStorage mods, - SaveService saveService, - IncognitoService incognito) - : IDisposable +public sealed class CollectionPanel : IDisposable { - private readonly CollectionStorage _collections = manager.Storage; - private readonly ActiveCollections _active = manager.Active; - private readonly IndividualAssignmentUi _individualAssignmentUi = new(communicator, actors, manager); - private readonly InheritanceUi _inheritanceUi = new(manager, incognito); - private readonly IFontHandle _nameFont = pi.UiBuilder.FontAtlas.NewGameFontHandle(new GameFontStyle(GameFontFamilyAndSize.Jupiter23)); + private readonly CollectionStorage _collections; + private readonly ActiveCollections _active; + private readonly CollectionSelector _selector; + private readonly ActorManager _actors; + private readonly ITargetManager _targets; + private readonly IndividualAssignmentUi _individualAssignmentUi; + private readonly InheritanceUi _inheritanceUi; + private readonly ModStorage _mods; + private readonly FilenameService _fileNames; + private readonly IFontHandle _nameFont; private static readonly IReadOnlyDictionary Buttons = CreateButtons(); private static readonly IReadOnlyList<(CollectionType, bool, bool, string, uint)> AdvancedTree = CreateTree(); @@ -48,6 +40,21 @@ public sealed class CollectionPanel( private int _draggedIndividualAssignment = -1; + public CollectionPanel(DalamudPluginInterface pi, CommunicatorService communicator, CollectionManager manager, + CollectionSelector selector, ActorManager actors, ITargetManager targets, ModStorage mods, FilenameService fileNames) + { + _collections = manager.Storage; + _active = manager.Active; + _selector = selector; + _actors = actors; + _targets = targets; + _mods = mods; + _fileNames = fileNames; + _individualAssignmentUi = new IndividualAssignmentUi(communicator, actors, manager); + _inheritanceUi = new InheritanceUi(manager, _selector); + _nameFont = pi.UiBuilder.FontAtlas.NewGameFontHandle(new GameFontStyle(GameFontFamilyAndSize.Jupiter23)); + } + public void Dispose() { _individualAssignmentUi.Dispose(); @@ -223,34 +230,24 @@ public sealed class CollectionPanel( ImGui.EndGroup(); ImGui.SameLine(); ImGui.BeginGroup(); - var width = ImGui.GetContentRegionAvail().X; - using (ImRaii.Disabled(_collections.DefaultNamed == collection)) + using var style = ImRaii.PushStyle(ImGuiStyleVar.ButtonTextAlign, new Vector2(0, 0.5f)); + var name = _newName ?? collection.Name; + var identifier = collection.Identifier; + var width = ImGui.GetContentRegionAvail().X; + var fileName = _fileNames.CollectionFile(collection); + ImGui.SetNextItemWidth(width); + if (ImGui.InputText("##name", ref name, 128)) + _newName = name; + if (ImGui.IsItemDeactivatedAfterEdit() && _newName != null) { - using var style = ImRaii.PushStyle(ImGuiStyleVar.ButtonTextAlign, new Vector2(0, 0.5f)); - var name = _newName ?? collection.Identity.Name; - ImGui.SetNextItemWidth(width); - if (ImGui.InputText("##name", ref name, 128)) - _newName = name; - if (ImGui.IsItemDeactivatedAfterEdit() && _newName != null && _newName != collection.Identity.Name) - { - collection.Identity.Name = _newName; - saveService.QueueSave(new ModCollectionSave(mods, collection)); - selector.RestoreCollections(); - _newName = null; - } - else if (ImGui.IsItemDeactivated()) - { - _newName = null; - } + collection.Name = _newName; + _newName = null; } - if (_collections.DefaultNamed == collection) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "The Default collection can not be renamed."u8); - - var identifier = collection.Identity.Identifier; - var fileName = saveService.FileNames.CollectionFile(collection); + else if (ImGui.IsItemDeactivated()) + _newName = null; using (ImRaii.PushFont(UiBuilder.MonoFont)) { - if (ImGui.Button(collection.Identity.Identifier, new Vector2(width, 0))) + if (ImGui.Button(collection.Identifier, new Vector2(width, 0))) try { Process.Start(new ProcessStartInfo(fileName) { UseShellExecute = true }); @@ -297,9 +294,9 @@ public sealed class CollectionPanel( _active.SetCollection(null, type, _active.Individuals.GetGroup(identifier)); } - foreach (var coll in _collections.OrderBy(c => c.Identity.Name)) + foreach (var coll in _collections.OrderBy(c => c.Name)) { - if (coll != collection && ImGui.MenuItem($"Use {coll.Identity.Name}.")) + if (coll != collection && ImGui.MenuItem($"Use {coll.Name}.")) _active.SetCollection(coll, type, _active.Individuals.GetGroup(identifier)); } } @@ -326,10 +323,10 @@ public sealed class CollectionPanel( var button = ImGui.Button(text, width) || ImGui.IsItemClicked(ImGuiMouseButton.Right); var hovered = redundancy.Length > 0 && ImGui.IsItemHovered(); DrawIndividualDragSource(text, id); - DrawIndividualDragTarget(id); + DrawIndividualDragTarget(text, id); if (!invalid) { - selector.DragTargetAssignment(type, id); + _selector.DragTargetAssignment(type, id); var name = Name(collection); var size = ImGui.CalcTextSize(name); var textPos = ImGui.GetItemRectMax() - size - ImGui.GetStyle().FramePadding; @@ -352,12 +349,12 @@ public sealed class CollectionPanel( if (!source) return; - ImGui.SetDragDropPayload("DragIndividual", null, 0); + ImGui.SetDragDropPayload("DragIndividual", nint.Zero, 0); ImGui.TextUnformatted($"Re-ordering {text}..."); _draggedIndividualAssignment = _active.Individuals.Index(id); } - private void DrawIndividualDragTarget(ActorIdentifier id) + private void DrawIndividualDragTarget(string text, ActorIdentifier id) { if (!id.IsValid) return; @@ -381,7 +378,9 @@ public sealed class CollectionPanel( ImGuiUtil.TextWrapped(type.ToDescription()); switch (type) { - case CollectionType.Default: ImGui.TextUnformatted("Overruled by any other Assignment."); break; + case CollectionType.Default: + ImGui.TextUnformatted("Overruled by any other Assignment."); + break; case CollectionType.Yourself: ImGuiUtil.DrawColoredText(("Overruled by ", 0), ("Individual ", ColorId.NewMod.Value()), ("Assignments.", 0)); break; @@ -416,7 +415,7 @@ public sealed class CollectionPanel( /// Respect incognito mode for names of identifiers. private string Name(ActorIdentifier id, string? name) - => incognito.IncognitoMode && id.Type is IdentifierType.Player or IdentifierType.Owned + => _selector.IncognitoMode && id.Type is IdentifierType.Player or IdentifierType.Owned ? id.Incognito(name) : name ?? id.ToString(); @@ -424,7 +423,7 @@ public sealed class CollectionPanel( private string Name(ModCollection? collection) => collection == null ? "Unassigned" : collection == ModCollection.Empty ? "Use No Mods" : - incognito.IncognitoMode ? collection.Identity.AnonymizedName : collection.Identity.Name; + _selector.IncognitoMode ? collection.AnonymizedName : collection.Name; private void DrawIndividualButton(string intro, Vector2 width, string tooltip, char suffix, params ActorIdentifier[] identifiers) { @@ -443,11 +442,11 @@ public sealed class CollectionPanel( } private void DrawCurrentCharacter(Vector2 width) - => DrawIndividualButton("Current Character", width, string.Empty, 'c', actors.GetCurrentPlayer()); + => DrawIndividualButton("Current Character", width, string.Empty, 'c', _actors.GetCurrentPlayer()); private void DrawCurrentTarget(Vector2 width) => DrawIndividualButton("Current Target", width, string.Empty, 't', - actors.FromObject(targets.Target, false, true, true)); + _actors.FromObject(_targets.Target, false, true, true)); private void DrawNewPlayer(Vector2 width) => DrawIndividualButton("New Player", width, _individualAssignmentUi.PlayerTooltip, 'p', @@ -503,7 +502,7 @@ public sealed class CollectionPanel( ImGui.Separator(); var buttonHeight = 2 * ImGui.GetTextLineHeightWithSpacing(); - if (_inUseCache.Count == 0 && collection.Inheritance.DirectlyInheritedBy.Count == 0) + if (_inUseCache.Count == 0 && collection.DirectParentOf.Count == 0) { ImGui.Dummy(Vector2.One); using var f = _nameFont.Push(); @@ -565,7 +564,7 @@ public sealed class CollectionPanel( private void DrawInheritanceStatistics(ModCollection collection, Vector2 buttonWidth) { - if (collection.Inheritance.DirectlyInheritedBy.Count <= 0) + if (collection.DirectParentOf.Count <= 0) return; using (var _ = ImRaii.PushStyle(ImGuiStyleVar.FramePadding, Vector2.Zero)) @@ -576,11 +575,11 @@ public sealed class CollectionPanel( using var f = _nameFont.Push(); using var style = ImRaii.PushStyle(ImGuiStyleVar.FrameBorderSize, ImGuiHelpers.GlobalScale); using var color = ImRaii.PushColor(ImGuiCol.Border, Colors.MetaInfoText); - ImGuiUtil.DrawTextButton(Name(collection.Inheritance.DirectlyInheritedBy[0]), Vector2.Zero, 0); + ImGuiUtil.DrawTextButton(Name(collection.DirectParentOf[0]), Vector2.Zero, 0); var constOffset = (ImGui.GetStyle().FramePadding.X + ImGuiHelpers.GlobalScale) * 2 + ImGui.GetStyle().ItemSpacing.X + ImGui.GetStyle().WindowPadding.X; - foreach (var parent in collection.Inheritance.DirectlyInheritedBy.Skip(1)) + foreach (var parent in collection.DirectParentOf.Skip(1)) { var name = Name(parent); var size = ImGui.CalcTextSize(name).X; @@ -608,7 +607,7 @@ public sealed class CollectionPanel( ImGui.TableSetupColumn("State", ImGuiTableColumnFlags.WidthFixed, 1.75f * ImGui.GetFrameHeight()); ImGui.TableSetupColumn("Priority", ImGuiTableColumnFlags.WidthFixed, 2.5f * ImGui.GetFrameHeight()); ImGui.TableHeadersRow(); - foreach (var (mod, (settings, parent)) in mods.Select(m => (m, collection.GetInheritedSettings(m.Index))) + foreach (var (mod, (settings, parent)) in _mods.Select(m => (m, collection[m.Index])) .Where(t => t.Item2.Settings != null) .OrderBy(t => t.m.Name)) { @@ -631,12 +630,12 @@ public sealed class CollectionPanel( private void DrawInactiveSettingsList(ModCollection collection) { - if (collection.Settings.Unused.Count == 0) + if (collection.UnusedSettings.Count == 0) return; ImGui.Dummy(Vector2.One); - var text = collection.Settings.Unused.Count > 1 - ? $"Clear all {collection.Settings.Unused.Count} unused settings from deleted mods." + var text = collection.UnusedSettings.Count > 1 + ? $"Clear all {collection.UnusedSettings.Count} unused settings from deleted mods." : "Clear the currently unused setting from a deleted mods."; if (ImGui.Button(text, new Vector2(ImGui.GetContentRegionAvail().X, 0))) _collections.CleanUnavailableSettings(collection); @@ -644,7 +643,7 @@ public sealed class CollectionPanel( ImGui.Dummy(Vector2.One); var size = new Vector2(ImGui.GetContentRegionAvail().X, - Math.Min(10, collection.Settings.Unused.Count + 1) * ImGui.GetFrameHeightWithSpacing()); + Math.Min(10, collection.UnusedSettings.Count + 1) * ImGui.GetFrameHeightWithSpacing()); using var table = ImRaii.Table("##inactiveSettings", 4, ImGuiTableFlags.RowBg | ImGuiTableFlags.ScrollY, size); if (!table) return; @@ -656,7 +655,7 @@ public sealed class CollectionPanel( ImGui.TableSetupColumn("Priority", ImGuiTableColumnFlags.WidthFixed, 2.5f * ImGui.GetFrameHeight()); ImGui.TableHeadersRow(); string? delete = null; - foreach (var (name, settings) in collection.Settings.Unused.OrderBy(n => n.Key)) + foreach (var (name, settings) in collection.UnusedSettings.OrderBy(n => n.Key)) { using var id = ImRaii.PushId(name); ImGui.TableNextColumn(); diff --git a/Penumbra/UI/CollectionTab/CollectionSelector.cs b/Penumbra/UI/CollectionTab/CollectionSelector.cs index 79254090..fac85d4d 100644 --- a/Penumbra/UI/CollectionTab/CollectionSelector.cs +++ b/Penumbra/UI/CollectionTab/CollectionSelector.cs @@ -1,4 +1,4 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using Penumbra.Collections; @@ -17,12 +17,13 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl private readonly CollectionStorage _storage; private readonly ActiveCollections _active; private readonly TutorialService _tutorial; - private readonly IncognitoService _incognito; private ModCollection? _dragging; + public bool IncognitoMode; + public CollectionSelector(Configuration config, CommunicatorService communicator, CollectionStorage storage, ActiveCollections active, - TutorialService tutorial, IncognitoService incognito) + TutorialService tutorial) : base([], Flags.Delete | Flags.Add | Flags.Duplicate | Flags.Filter) { _config = config; @@ -30,7 +31,6 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl _storage = storage; _active = active; _tutorial = tutorial; - _incognito = incognito; _communicator.CollectionChange.Subscribe(OnCollectionChange, CollectionChange.Priority.CollectionSelector); // Set items. @@ -44,9 +44,7 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl if (idx < 0 || idx >= Items.Count) return false; - // Always return false since we handle the selection update ourselves. - _storage.RemoveCollection(Items[idx]); - return false; + return _storage.RemoveCollection(Items[idx]); } protected override bool DeleteButtonEnabled() @@ -69,7 +67,7 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl } protected override bool Filtered(int idx) - => !Items[idx].Identity.Name.Contains(Filter, StringComparison.OrdinalIgnoreCase); + => !Items[idx].Name.Contains(Filter, StringComparison.OrdinalIgnoreCase); private const string PayloadString = "Collection"; @@ -85,7 +83,7 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl if (source) { _dragging = Items[idx]; - ImGui.SetDragDropPayload(PayloadString, null, 0); + ImGui.SetDragDropPayload(PayloadString, nint.Zero, 0); ImGui.TextUnformatted($"Assigning {Name(_dragging)} to..."); } @@ -111,17 +109,7 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl } private string Name(ModCollection collection) - => _incognito.IncognitoMode || collection.Identity.Name.Length == 0 ? collection.Identity.AnonymizedName : collection.Identity.Name; - - public void RestoreCollections() - { - Items.Clear(); - Items.Add(_storage.DefaultNamed); - foreach (var c in _storage.OrderBy(c => c.Identity.Name).Where(c => c != _storage.DefaultNamed)) - Items.Add(c); - SetFilterDirty(); - SetCurrent(_active.Current); - } + => IncognitoMode ? collection.AnonymizedName : collection.Name; private void OnCollectionChange(CollectionType type, ModCollection? old, ModCollection? @new, string _3) { @@ -134,7 +122,14 @@ public sealed class CollectionSelector : ItemSelector, IDisposabl SetFilterDirty(); return; case CollectionType.Inactive: - RestoreCollections(); + Items.Clear(); + foreach (var c in _storage.OrderBy(c => c.Name)) + Items.Add(c); + + if (old == Current) + ClearCurrentSelection(); + else + TryRestoreCurrent(); SetFilterDirty(); return; default: diff --git a/Penumbra/UI/CollectionTab/IndividualAssignmentUi.cs b/Penumbra/UI/CollectionTab/IndividualAssignmentUi.cs index f472e346..fd8f9b25 100644 --- a/Penumbra/UI/CollectionTab/IndividualAssignmentUi.cs +++ b/Penumbra/UI/CollectionTab/IndividualAssignmentUi.cs @@ -1,5 +1,5 @@ using Dalamud.Game.ClientState.Objects.Enums; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Custom; using Penumbra.Collections; using Penumbra.Collections.Manager; diff --git a/Penumbra/UI/CollectionTab/InheritanceUi.cs b/Penumbra/UI/CollectionTab/InheritanceUi.cs index 2053f269..2290592d 100644 --- a/Penumbra/UI/CollectionTab/InheritanceUi.cs +++ b/Penumbra/UI/CollectionTab/InheritanceUi.cs @@ -1,7 +1,6 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; using OtterGui.Services; using Penumbra.Collections; @@ -10,7 +9,7 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.CollectionTab; -public class InheritanceUi(CollectionManager collectionManager, IncognitoService incognito) : IUiService +public class InheritanceUi(CollectionManager collectionManager, CollectionSelector selector) : IUiService { private const int InheritedCollectionHeight = 9; private const string InheritanceDragDropLabel = "##InheritanceMove"; @@ -94,7 +93,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService /// private void DrawInheritedChildren(ModCollection collection) { - using var id = ImRaii.PushId(collection.Identity.Index); + using var id = ImRaii.PushId(collection.Index); using var indent = ImRaii.PushIndent(); // Get start point for the lines (top of the selector). @@ -108,14 +107,14 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService var lineEnd = lineStart; // Skip the collection itself. - foreach (var inheritance in collection.Inheritance.FlatHierarchy.Skip(1)) + foreach (var inheritance in collection.GetFlattenedInheritance().Skip(1)) { // Draw the child, already seen collections are colored as conflicts. using var color = ImRaii.PushColor(ImGuiCol.Text, ColorId.HandledConflictMod.Value(), _seenInheritedCollections.Contains(inheritance)); _seenInheritedCollections.Add(inheritance); - ImRaii.TreeNode($"{Name(inheritance)}###{inheritance.Identity.Id}", + ImRaii.TreeNode($"{Name(inheritance)}###{inheritance.Id}", ImGuiTreeNodeFlags.NoTreePushOnOpen | ImGuiTreeNodeFlags.Leaf | ImGuiTreeNodeFlags.Bullet); var (minRect, maxRect) = (ImGui.GetItemRectMin(), ImGui.GetItemRectMax()); DrawInheritanceTreeClicks(inheritance, false); @@ -141,7 +140,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService using var color = ImRaii.PushColor(ImGuiCol.Text, ColorId.HandledConflictMod.Value(), _seenInheritedCollections.Contains(collection)); _seenInheritedCollections.Add(collection); - using var tree = ImRaii.TreeNode($"{Name(collection)}###{collection.Identity.Name}", ImGuiTreeNodeFlags.NoTreePushOnOpen); + using var tree = ImRaii.TreeNode($"{Name(collection)}###{collection.Name}", ImGuiTreeNodeFlags.NoTreePushOnOpen); color.Pop(); DrawInheritanceTreeClicks(collection, true); DrawInheritanceDropSource(collection); @@ -151,7 +150,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService DrawInheritedChildren(collection); else // We still want to keep track of conflicts. - _seenInheritedCollections.UnionWith(collection.Inheritance.FlatHierarchy); + _seenInheritedCollections.UnionWith(collection.GetFlattenedInheritance()); } /// Draw the list box containing the current inheritance information. @@ -164,7 +163,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService _seenInheritedCollections.Clear(); _seenInheritedCollections.Add(_active.Current); - foreach (var collection in _active.Current.Inheritance.DirectlyInheritsFrom.ToList()) + foreach (var collection in _active.Current.DirectlyInheritsFrom.ToList()) DrawInheritance(collection); } @@ -181,7 +180,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService using var target = ImRaii.DragDropTarget(); if (target.Success && ImGuiUtil.IsDropping(InheritanceDragDropLabel)) - _inheritanceAction = (_active.Current.Inheritance.DirectlyInheritsFrom.IndexOf(_movedInheritance!), -1); + _inheritanceAction = (_active.Current.DirectlyInheritsFrom.IndexOf(_movedInheritance!), -1); } /// @@ -245,7 +244,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService { ImGui.SetNextItemWidth(UiHelpers.InputTextMinusButton); _newInheritance ??= _collections.FirstOrDefault(c - => c != _active.Current && !_active.Current.Inheritance.DirectlyInheritsFrom.Contains(c)) + => c != _active.Current && !_active.Current.DirectlyInheritsFrom.Contains(c)) ?? ModCollection.Empty; using var combo = ImRaii.Combo("##newInheritance", Name(_newInheritance)); if (!combo) @@ -253,7 +252,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService foreach (var collection in _collections .Where(c => InheritanceManager.CheckValidInheritance(_active.Current, c) == InheritanceManager.ValidInheritance.Valid) - .OrderBy(c => c.Identity.Name)) + .OrderBy(c => c.Name)) { if (ImGui.Selectable(Name(collection), _newInheritance == collection)) _newInheritance = collection; @@ -272,8 +271,8 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService if (_movedInheritance != null) { - var idx1 = _active.Current.Inheritance.DirectlyInheritsFrom.IndexOf(_movedInheritance); - var idx2 = _active.Current.Inheritance.DirectlyInheritsFrom.IndexOf(collection); + var idx1 = _active.Current.DirectlyInheritsFrom.IndexOf(_movedInheritance); + var idx2 = _active.Current.DirectlyInheritsFrom.IndexOf(collection); if (idx1 >= 0 && idx2 >= 0) _inheritanceAction = (idx1, idx2); } @@ -288,7 +287,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService if (!source) return; - ImGui.SetDragDropPayload(InheritanceDragDropLabel, null, 0); + ImGui.SetDragDropPayload(InheritanceDragDropLabel, nint.Zero, 0); _movedInheritance = collection; ImGui.TextUnformatted($"Moving {(_movedInheritance != null ? Name(_movedInheritance) : "Unknown")}..."); } @@ -303,7 +302,7 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService if (ImGui.GetIO().KeyCtrl && ImGui.IsItemClicked(ImGuiMouseButton.Right)) { if (withDelete && ImGui.GetIO().KeyShift) - _inheritanceAction = (_active.Current.Inheritance.DirectlyInheritsFrom.IndexOf(collection), -1); + _inheritanceAction = (_active.Current.DirectlyInheritsFrom.IndexOf(collection), -1); else _newCurrentCollection = collection; } @@ -313,5 +312,5 @@ public class InheritanceUi(CollectionManager collectionManager, IncognitoService } private string Name(ModCollection collection) - => incognito.IncognitoMode ? collection.Identity.AnonymizedName : collection.Identity.Name; + => selector.IncognitoMode ? collection.AnonymizedName : collection.Name; } diff --git a/Penumbra/UI/ConfigWindow.cs b/Penumbra/UI/ConfigWindow.cs index 55d0bc19..9ae11fc3 100644 --- a/Penumbra/UI/ConfigWindow.cs +++ b/Penumbra/UI/ConfigWindow.cs @@ -1,11 +1,9 @@ using Dalamud.Interface.Windowing; using Dalamud.Plugin; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Custom; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using Penumbra.Api.Enums; using Penumbra.Services; using Penumbra.UI.Classes; @@ -14,17 +12,17 @@ using Penumbra.Util; namespace Penumbra.UI; -public sealed class ConfigWindow : Window, IUiService +public sealed class ConfigWindow : Window { - private readonly IDalamudPluginInterface _pluginInterface; - private readonly Configuration _config; - private readonly PerformanceTracker _tracker; - private readonly ValidityChecker _validityChecker; - private Penumbra? _penumbra; - private ConfigTabBar _configTabs = null!; - private string? _lastException; + private readonly DalamudPluginInterface _pluginInterface; + private readonly Configuration _config; + private readonly PerformanceTracker _tracker; + private readonly ValidityChecker _validityChecker; + private Penumbra? _penumbra; + private ConfigTabBar _configTabs = null!; + private string? _lastException; - public ConfigWindow(PerformanceTracker tracker, IDalamudPluginInterface pi, Configuration config, ValidityChecker checker, + public ConfigWindow(PerformanceTracker tracker, DalamudPluginInterface pi, Configuration config, ValidityChecker checker, TutorialService tutorial) : base(GetLabel(checker)) { @@ -146,7 +144,7 @@ public sealed class ConfigWindow : Window, IUiService using var color = ImRaii.PushColor(ImGuiCol.Text, Colors.RegexWarningBorder); ImGui.NewLine(); ImGui.NewLine(); - ImUtf8.TextWrapped(text); + ImGuiUtil.TextWrapped(text); color.Pop(); ImGui.NewLine(); diff --git a/Penumbra/UI/FileDialogService.cs b/Penumbra/UI/FileDialogService.cs index 3bbc4ba8..e5b0fa19 100644 --- a/Penumbra/UI/FileDialogService.cs +++ b/Penumbra/UI/FileDialogService.cs @@ -1,16 +1,14 @@ using Dalamud.Interface; using Dalamud.Interface.ImGuiFileDialog; using Dalamud.Utility; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; -using OtterGui.Services; using Penumbra.Communication; using Penumbra.Services; namespace Penumbra.UI; -public class FileDialogService : IDisposable, IUiService +public class FileDialogService : IDisposable { private readonly CommunicatorService _communicator; private readonly FileDialogManager _manager; @@ -103,7 +101,7 @@ public class FileDialogService : IDisposable, IUiService private static string HandleRoot(string path) { - if (path is [_, ':']) + if (path.Length == 2 && path[1] == ':') return path + '\\'; return path; diff --git a/Penumbra/UI/ImportPopup.cs b/Penumbra/UI/ImportPopup.cs index 59ed0308..71164d1d 100644 --- a/Penumbra/UI/ImportPopup.cs +++ b/Penumbra/UI/ImportPopup.cs @@ -1,16 +1,13 @@ -using Dalamud.Game.ClientState.Keys; using Dalamud.Interface.Windowing; -using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; -using OtterGui.Services; using Penumbra.Import.Structs; using Penumbra.Mods.Manager; namespace Penumbra.UI; /// Draw the progress information for import. -public sealed class ImportPopup : Window, IUiService +public sealed class ImportPopup : Window { public const string WindowLabel = "Penumbra Import Status"; @@ -70,16 +67,13 @@ public sealed class ImportPopup : Window, IUiService ImGui.SetNextWindowSize(size); using var popup = ImRaii.Popup(importPopup, ImGuiWindowFlags.Modal); PopupWasDrawn = true; - var terminate = false; using (var child = ImRaii.Child("##import", new Vector2(-1, size.Y - ImGui.GetFrameHeight() * 2))) { - if (child.Success && import.DrawProgressInfo(new Vector2(-1, ImGui.GetFrameHeight()))) - if (!ImGui.IsMouseHoveringRect(ImGui.GetWindowPos(), ImGui.GetWindowPos() + ImGui.GetWindowSize()) - && ImGui.IsMouseClicked(ImGuiMouseButton.Left)) - terminate = true; + if (child) + import.DrawProgressInfo(new Vector2(-1, ImGui.GetFrameHeight())); } - terminate |= import.State == ImporterState.Done + var terminate = import.State == ImporterState.Done ? ImGui.Button("Close", -Vector2.UnitX) : import.DrawCancelButton(-Vector2.UnitX); if (terminate) diff --git a/Penumbra/UI/IncognitoService.cs b/Penumbra/UI/IncognitoService.cs deleted file mode 100644 index 678e072e..00000000 --- a/Penumbra/UI/IncognitoService.cs +++ /dev/null @@ -1,35 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using Penumbra.UI.Classes; -using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; - -namespace Penumbra.UI; - -public class IncognitoService(TutorialService tutorial, Configuration config) : IService -{ - public bool IncognitoMode - => config.Ephemeral.IncognitoMode; - - public void DrawToggle(float width) - { - var hold = config.IncognitoModifier.IsActive(); - var color = ColorId.FolderExpanded.Value(); - using (ImRaii.PushFrameBorder(ImUtf8.GlobalScale, color)) - { - var tt = IncognitoMode ? "Toggle incognito mode off."u8 : "Toggle incognito mode on."u8; - var icon = IncognitoMode ? FontAwesomeIcon.EyeSlash : FontAwesomeIcon.Eye; - if (ImUtf8.IconButton(icon, tt, new Vector2(width, ImUtf8.FrameHeight), false, color) && hold) - { - config.Ephemeral.IncognitoMode = !IncognitoMode; - config.Ephemeral.Save(); - } - - if (!hold) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"\nHold {config.IncognitoModifier} while clicking to toggle."); - } - - tutorial.OpenTutorial(BasicTutorialSteps.Incognito); - } -} diff --git a/Penumbra/UI/Integration/IntegrationSettingsRegistry.cs b/Penumbra/UI/Integration/IntegrationSettingsRegistry.cs deleted file mode 100644 index 2d3da488..00000000 --- a/Penumbra/UI/Integration/IntegrationSettingsRegistry.cs +++ /dev/null @@ -1,115 +0,0 @@ -using Dalamud.Plugin; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Api.Enums; - -namespace Penumbra.UI.Integration; - -public sealed class IntegrationSettingsRegistry : IService, IDisposable -{ - private readonly IDalamudPluginInterface _pluginInterface; - - private readonly List<(string InternalName, string Name, Action Draw)> _sections = []; - - private bool _disposed = false; - - public IntegrationSettingsRegistry(IDalamudPluginInterface pluginInterface) - { - _pluginInterface = pluginInterface; - - _pluginInterface.ActivePluginsChanged += OnActivePluginsChanged; - } - - public void Dispose() - { - _disposed = true; - - _pluginInterface.ActivePluginsChanged -= OnActivePluginsChanged; - - _sections.Clear(); - } - - public void Draw() - { - foreach (var (internalName, name, draw) in _sections) - { - if (!ImUtf8.CollapsingHeader($"Integration with {name}###IntegrationSettingsHeader.{internalName}")) - continue; - - using var id = ImUtf8.PushId($"IntegrationSettings.{internalName}"); - try - { - draw(); - } - catch (Exception e) - { - Penumbra.Log.Error($"Error while drawing {internalName} integration settings: {e}"); - } - } - } - - public PenumbraApiEc RegisterSection(Action draw) - { - if (_disposed) - return PenumbraApiEc.SystemDisposed; - - var plugin = GetPlugin(draw); - if (plugin is null) - return PenumbraApiEc.InvalidArgument; - - var section = (plugin.InternalName, plugin.Name, draw); - - var index = FindSectionIndex(plugin.InternalName); - if (index >= 0) - { - if (_sections[index] == section) - return PenumbraApiEc.NothingChanged; - _sections[index] = section; - } - else - _sections.Add(section); - _sections.Sort((lhs, rhs) => string.Compare(lhs.Name, rhs.Name, StringComparison.CurrentCultureIgnoreCase)); - - return PenumbraApiEc.Success; - } - - public bool UnregisterSection(Action draw) - { - var index = FindSectionIndex(draw); - if (index < 0) - return false; - - _sections.RemoveAt(index); - return true; - } - - private void OnActivePluginsChanged(IActivePluginsChangedEventArgs args) - { - if (args.Kind is PluginListInvalidationKind.Loaded) - return; - - foreach (var internalName in args.AffectedInternalNames) - { - var index = FindSectionIndex(internalName); - if (index >= 0 && GetPlugin(_sections[index].Draw) is null) - { - _sections.RemoveAt(index); - Penumbra.Log.Warning($"Removed stale integration setting section of {internalName} (reason: {args.Kind})"); - } - } - } - - private IExposedPlugin? GetPlugin(Delegate @delegate) - => @delegate.Method.DeclaringType - switch - { - null => null, - var type => _pluginInterface.GetPlugin(type.Assembly), - }; - - private int FindSectionIndex(string internalName) - => _sections.FindIndex(section => section.InternalName.Equals(internalName, StringComparison.Ordinal)); - - private int FindSectionIndex(Action draw) - => _sections.FindIndex(section => section.Draw == draw); -} diff --git a/Penumbra/UI/Knowledge/IKnowledgeTab.cs b/Penumbra/UI/Knowledge/IKnowledgeTab.cs deleted file mode 100644 index 568d5fda..00000000 --- a/Penumbra/UI/Knowledge/IKnowledgeTab.cs +++ /dev/null @@ -1,8 +0,0 @@ -namespace Penumbra.UI.Knowledge; - -public interface IKnowledgeTab -{ - public ReadOnlySpan Name { get; } - public ReadOnlySpan SearchTags { get; } - public void Draw(); -} diff --git a/Penumbra/UI/Knowledge/KnowledgeWindow.cs b/Penumbra/UI/Knowledge/KnowledgeWindow.cs deleted file mode 100644 index 118ed479..00000000 --- a/Penumbra/UI/Knowledge/KnowledgeWindow.cs +++ /dev/null @@ -1,78 +0,0 @@ -using Dalamud.Interface.Utility.Raii; -using Dalamud.Interface.Windowing; -using Dalamud.Bindings.ImGui; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.String; - -namespace Penumbra.UI.Knowledge; - -/// Draw the progress information for import. -public sealed class KnowledgeWindow : Window, IUiService -{ - private readonly IReadOnlyList _tabs = - [ - new RaceCodeTab(), - ]; - - private IKnowledgeTab? _selected; - private readonly byte[] _filterStore = new byte[256]; - - private ByteString _lower = ByteString.Empty; - - /// Draw the progress information for import. - public KnowledgeWindow() - : base("Penumbra Knowledge Window") - => SizeConstraints = new WindowSizeConstraints - { - MaximumSize = new Vector2(10000, 10000), - MinimumSize = new Vector2(400, 200), - }; - - public override void Draw() - { - DrawSelector(); - ImUtf8.SameLineInner(); - DrawMain(); - } - - private void DrawSelector() - { - using var group = ImUtf8.Group(); - using (ImRaii.PushStyle(ImGuiStyleVar.FrameRounding, 0).Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero)) - { - ImGui.SetNextItemWidth(200 * ImUtf8.GlobalScale); - if (ImUtf8.InputText("##Filter"u8, _filterStore, out TerminatedByteString filter, "Filter..."u8)) - _lower = ByteString.FromSpanUnsafe(filter, true, null, null).AsciiToLowerClone(); - } - - using var child = ImUtf8.Child("KnowledgeSelector"u8, new Vector2(200 * ImUtf8.GlobalScale, ImGui.GetContentRegionAvail().Y), true); - if (!child) - return; - - foreach (var tab in _tabs) - { - if (!_lower.IsEmpty && tab.SearchTags.IndexOf(_lower.Span) < 0) - continue; - - if (ImUtf8.Selectable(tab.Name, _selected == tab)) - _selected = tab; - } - } - - private void DrawMain() - { - using var group = ImUtf8.Group(); - using (ImRaii.PushStyle(ImGuiStyleVar.FrameRounding, 0).Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero)) - { - ImUtf8.TextFramed(_selected == null ? "No Selection"u8 : _selected.Name, ImGui.GetColorU32(ImGuiCol.FrameBg), - new Vector2(ImGui.GetContentRegionAvail().X, 0)); - } - - using var child = ImUtf8.Child("KnowledgeMain"u8, ImGui.GetContentRegionAvail(), true); - if (!child || _selected == null) - return; - - _selected.Draw(); - } -} diff --git a/Penumbra/UI/Knowledge/RaceCodeTab.cs b/Penumbra/UI/Knowledge/RaceCodeTab.cs deleted file mode 100644 index 44b544eb..00000000 --- a/Penumbra/UI/Knowledge/RaceCodeTab.cs +++ /dev/null @@ -1,82 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Text; -using Penumbra.GameData.Enums; - -namespace Penumbra.UI.Knowledge; - -public sealed class RaceCodeTab() : IKnowledgeTab -{ - public ReadOnlySpan Name - => "Race Codes"u8; - - public ReadOnlySpan SearchTags - => "deformersracecodesmodel"u8; - - public void Draw() - { - var size = new Vector2((ImGui.GetContentRegionAvail().X - ImUtf8.ItemSpacing.X) / 2, 0); - using (var table = ImUtf8.Table("adults"u8, 4, ImGuiTableFlags.BordersOuter, size)) - { - if (!table) - return; - - DrawHeaders(); - foreach (var gr in Enum.GetValues()) - { - var (gender, race) = gr.Split(); - if (gender is not Gender.Male and not Gender.Female || race is ModelRace.Unknown) - continue; - - DrawRow(gender, race, false); - } - } - - ImGui.SameLine(); - - using (var table = ImUtf8.Table("children"u8, 4, ImGuiTableFlags.BordersOuter, size)) - { - if (!table) - return; - - DrawHeaders(); - foreach (var race in (ReadOnlySpan) - [ModelRace.Midlander, ModelRace.Elezen, ModelRace.Miqote, ModelRace.AuRa, ModelRace.Unknown]) - { - foreach (var gender in (ReadOnlySpan) [Gender.Male, Gender.Female]) - DrawRow(gender, race, true); - } - } - - return; - - static void DrawHeaders() - { - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Race"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Gender"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Age"u8); - ImGui.TableNextColumn(); - ImUtf8.TableHeader("Race Code"u8); - } - - static void DrawRow(Gender gender, ModelRace race, bool child) - { - var gr = child - ? Names.CombinedRace(gender is Gender.Male ? Gender.MaleNpc : Gender.FemaleNpc, race) - : Names.CombinedRace(gender, race); - ImGui.TableNextColumn(); - ImUtf8.Text(race.ToName()); - - ImGui.TableNextColumn(); - ImUtf8.Text(gender.ToName()); - - ImGui.TableNextColumn(); - ImUtf8.Text(child ? "Child"u8 : "Adult"u8); - - ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable(gr.ToRaceCode()); - } - } -} diff --git a/Penumbra/UI/LaunchButton.cs b/Penumbra/UI/LaunchButton.cs index 49161c31..9650ccf8 100644 --- a/Penumbra/UI/LaunchButton.cs +++ b/Penumbra/UI/LaunchButton.cs @@ -1,9 +1,7 @@ using Dalamud.Interface; -using Dalamud.Interface.Textures; -using Dalamud.Interface.Textures.TextureWraps; +using Dalamud.Interface.Internal; using Dalamud.Plugin; using Dalamud.Plugin.Services; -using OtterGui.Services; namespace Penumbra.UI; @@ -11,26 +9,26 @@ namespace Penumbra.UI; /// A Launch Button used in the title screen of the game, /// using the Dalamud-provided collapsible submenu. /// -public class LaunchButton : IDisposable, IUiService +public class LaunchButton : IDisposable { private readonly ConfigWindow _configWindow; - private readonly IUiBuilder _uiBuilder; + private readonly UiBuilder _uiBuilder; private readonly ITitleScreenMenu _title; private readonly string _fileName; - private readonly ITextureProvider _textureProvider; - private IReadOnlyTitleScreenMenuEntry? _entry; + private IDalamudTextureWrap? _icon; + private TitleScreenMenuEntry? _entry; /// /// Register the launch button to be created on the next draw event. /// - public LaunchButton(IDalamudPluginInterface pi, ITitleScreenMenu title, ConfigWindow ui, ITextureProvider textureProvider) + public LaunchButton(DalamudPluginInterface pi, ITitleScreenMenu title, ConfigWindow ui) { - _uiBuilder = pi.UiBuilder; - _configWindow = ui; - _textureProvider = textureProvider; - _title = title; - _entry = null; + _uiBuilder = pi.UiBuilder; + _configWindow = ui; + _title = title; + _icon = null; + _entry = null; _fileName = Path.Combine(pi.AssemblyLocation.DirectoryName!, "tsmLogo.png"); _uiBuilder.Draw += CreateEntry; @@ -38,6 +36,7 @@ public class LaunchButton : IDisposable, IUiService public void Dispose() { + _icon?.Dispose(); if (_entry != null) _title.RemoveEntry(_entry); } @@ -49,9 +48,9 @@ public class LaunchButton : IDisposable, IUiService { try { - // TODO: update when API updated. - var icon = _textureProvider.GetFromFile(_fileName); - _entry = _title.AddEntry("Manage Penumbra", icon, OnTriggered); + _icon = _uiBuilder.LoadImage(_fileName); + if (_icon != null) + _entry = _title.AddEntry("Manage Penumbra", _icon, OnTriggered); _uiBuilder.Draw -= CreateEntry; } diff --git a/Penumbra/UI/ModsTab/DescriptionEditPopup.cs b/Penumbra/UI/ModsTab/DescriptionEditPopup.cs index 7d7a6967..c284afc3 100644 --- a/Penumbra/UI/ModsTab/DescriptionEditPopup.cs +++ b/Penumbra/UI/ModsTab/DescriptionEditPopup.cs @@ -1,5 +1,5 @@ using Dalamud.Interface.Utility; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Services; using OtterGui.Text; using Penumbra.Mods; diff --git a/Penumbra/UI/ModsTab/Groups/AddGroupDrawer.cs b/Penumbra/UI/ModsTab/Groups/AddGroupDrawer.cs index 1430f17b..3ac10cd0 100644 --- a/Penumbra/UI/ModsTab/Groups/AddGroupDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/AddGroupDrawer.cs @@ -1,4 +1,4 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Services; using OtterGui.Text; using Penumbra.Api.Enums; @@ -9,7 +9,6 @@ using Penumbra.Meta.Manipulations; using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Mods.Manager.OptionEditor; -using Penumbra.UI.AdvancedWindow.Meta; using Penumbra.UI.Classes; namespace Penumbra.UI.ModsTab.Groups; @@ -24,11 +23,13 @@ public class AddGroupDrawer : IUiService private bool _imcFileExists; private bool _entryExists; private bool _entryInvalid; + private readonly ImcChecker _imcChecker; private readonly ModManager _modManager; - public AddGroupDrawer(ModManager modManager) + public AddGroupDrawer(ModManager modManager, ImcChecker imcChecker) { _modManager = modManager; + _imcChecker = imcChecker; UpdateEntry(); } @@ -48,7 +49,6 @@ public class AddGroupDrawer : IUiService DrawSingleGroupButton(mod, buttonWidth); ImUtf8.SameLineInner(); DrawMultiGroupButton(mod, buttonWidth); - DrawCombiningGroupButton(mod, buttonWidth); } private void DrawSingleGroupButton(Mod mod, Vector2 width) @@ -77,43 +77,31 @@ public class AddGroupDrawer : IUiService _groupNameValid = false; } - private void DrawCombiningGroupButton(Mod mod, Vector2 width) - { - if (!ImUtf8.ButtonEx("Add Combining Group"u8, _groupNameValid - ? "Add a new combining option group to this mod."u8 - : "Can not add a new group of this name."u8, - width, !_groupNameValid)) - return; - - _modManager.OptionEditor.AddModGroup(mod, GroupType.Combining, _groupName); - _groupName = string.Empty; - _groupNameValid = false; - } private void DrawImcInput(float width) { - var change = ImcMetaDrawer.DrawObjectType(ref _imcIdentifier, width); + var change = ImcManipulationDrawer.DrawObjectType(ref _imcIdentifier, width); ImUtf8.SameLineInner(); - change |= ImcMetaDrawer.DrawPrimaryId(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawPrimaryId(ref _imcIdentifier, width); if (_imcIdentifier.ObjectType is ObjectType.Weapon or ObjectType.Monster) { - change |= ImcMetaDrawer.DrawSecondaryId(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawSecondaryId(ref _imcIdentifier, width); ImUtf8.SameLineInner(); - change |= ImcMetaDrawer.DrawVariant(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawVariant(ref _imcIdentifier, width); } else if (_imcIdentifier.ObjectType is ObjectType.DemiHuman) { var quarterWidth = (width - ImUtf8.ItemInnerSpacing.X / ImUtf8.GlobalScale) / 2; - change |= ImcMetaDrawer.DrawSecondaryId(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawSecondaryId(ref _imcIdentifier, width); ImUtf8.SameLineInner(); - change |= ImcMetaDrawer.DrawSlot(ref _imcIdentifier, quarterWidth); + change |= ImcManipulationDrawer.DrawSlot(ref _imcIdentifier, quarterWidth); ImUtf8.SameLineInner(); - change |= ImcMetaDrawer.DrawVariant(ref _imcIdentifier, quarterWidth); + change |= ImcManipulationDrawer.DrawVariant(ref _imcIdentifier, quarterWidth); } else { - change |= ImcMetaDrawer.DrawSlot(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawSlot(ref _imcIdentifier, width); ImUtf8.SameLineInner(); - change |= ImcMetaDrawer.DrawVariant(ref _imcIdentifier, width); + change |= ImcManipulationDrawer.DrawVariant(ref _imcIdentifier, width); } if (change) @@ -153,7 +141,7 @@ public class AddGroupDrawer : IUiService private void UpdateEntry() { - (_defaultEntry, _imcFileExists, _entryExists) = ImcChecker.GetDefaultEntry(_imcIdentifier, false); + (_defaultEntry, _imcFileExists, _entryExists) = _imcChecker.GetDefaultEntry(_imcIdentifier, false); _entryInvalid = !_imcIdentifier.Validate() || _defaultEntry.MaterialId == 0 || !_entryExists; } } diff --git a/Penumbra/UI/ModsTab/Groups/CombiningModGroupEditDrawer.cs b/Penumbra/UI/ModsTab/Groups/CombiningModGroupEditDrawer.cs deleted file mode 100644 index e9840e6c..00000000 --- a/Penumbra/UI/ModsTab/Groups/CombiningModGroupEditDrawer.cs +++ /dev/null @@ -1,112 +0,0 @@ -using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui; -using OtterGui.Extensions; -using OtterGui.Raii; -using OtterGui.Text; -using Penumbra.Mods.Groups; -using Penumbra.Mods.SubMods; - -namespace Penumbra.UI.ModsTab.Groups; - -public readonly struct CombiningModGroupEditDrawer(ModGroupEditDrawer editor, CombiningModGroup group) : IModGroupEditDrawer -{ - public void Draw() - { - foreach (var (option, optionIdx) in group.OptionData.WithIndex()) - { - using var id = ImUtf8.PushId(optionIdx); - editor.DrawOptionPosition(group, option, optionIdx); - - ImUtf8.SameLineInner(); - editor.DrawOptionDefaultMultiBehaviour(group, option, optionIdx); - - ImUtf8.SameLineInner(); - editor.DrawOptionName(option); - - ImUtf8.SameLineInner(); - editor.DrawOptionDescription(option); - - ImUtf8.SameLineInner(); - editor.DrawOptionDelete(option); - } - - DrawNewOption(); - DrawContainerNames(); - } - - private void DrawNewOption() - { - var count = group.OptionData.Count; - if (count >= IModGroup.MaxCombiningOptions) - return; - - var name = editor.DrawNewOptionBase(group, count); - - var validName = name.Length > 0; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, validName - ? "Add a new option to this group."u8 - : "Please enter a name for the new option."u8, default, !validName)) - { - editor.ModManager.OptionEditor.CombiningEditor.AddOption(group, name); - editor.NewOptionName = null; - } - } - - private unsafe void DrawContainerNames() - { - if (ImUtf8.ButtonEx("Edit Container Names"u8, - "Add optional names to separate data containers of the combining group.\nThose are just for easier identification while editing the mod, and are not generally displayed to the user."u8, - new Vector2(400 * ImUtf8.GlobalScale, 0))) - ImUtf8.OpenPopup("DataContainerNames"u8); - - var sizeX = group.OptionData.Count * (ImGui.GetStyle().ItemInnerSpacing.X + ImGui.GetFrameHeight()) + 300 * ImUtf8.GlobalScale; - ImGui.SetNextWindowSize(new Vector2(sizeX, ImGui.GetFrameHeightWithSpacing() * Math.Min(16, group.Data.Count) + 200 * ImUtf8.GlobalScale)); - using var popup = ImUtf8.Popup("DataContainerNames"u8); - if (!popup) - return; - - foreach (var option in group.OptionData) - { - ImUtf8.RotatedText(option.Name, true); - ImUtf8.SameLineInner(); - } - - ImGui.NewLine(); - ImGui.Separator(); - using var child = ImUtf8.Child("##Child"u8, ImGui.GetContentRegionAvail()); - ImGuiClip.ClippedDraw(group.Data, DrawRow, ImGui.GetFrameHeightWithSpacing()); - } - - private void DrawRow(CombinedDataContainer container, int index) - { - using var id = ImUtf8.PushId(index); - using (ImRaii.Disabled()) - { - for (var i = 0; i < group.OptionData.Count; ++i) - { - id.Push(i); - var check = (index & (1 << i)) != 0; - ImUtf8.Checkbox(""u8, ref check); - ImUtf8.SameLineInner(); - id.Pop(); - } - } - - var name = editor.CombiningDisplayIndex == index ? editor.CombiningDisplayName ?? container.Name : container.Name; - if (ImUtf8.InputText("##Nothing"u8, ref name, "Optional Display Name..."u8)) - { - editor.CombiningDisplayIndex = index; - editor.CombiningDisplayName = name; - } - - if (ImGui.IsItemDeactivatedAfterEdit()) - editor.ModManager.OptionEditor.CombiningEditor.SetDisplayName(container, name); - - if (ImGui.IsItemDeactivated()) - { - editor.CombiningDisplayIndex = -1; - editor.CombiningDisplayName = null; - } - } -} diff --git a/Penumbra/UI/ModsTab/Groups/ImcModGroupEditDrawer.cs b/Penumbra/UI/ModsTab/Groups/ImcModGroupEditDrawer.cs index fa5b0ef6..b10f123c 100644 --- a/Penumbra/UI/ModsTab/Groups/ImcModGroupEditDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/ImcModGroupEditDrawer.cs @@ -1,16 +1,12 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui.Extensions; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; using OtterGui.Text; -using OtterGui.Text.Widget; -using OtterGuiInternal.Utility; using Penumbra.GameData.Structs; -using Penumbra.Meta; using Penumbra.Mods.Groups; using Penumbra.Mods.Manager.OptionEditor; using Penumbra.Mods.SubMods; -using Penumbra.UI.AdvancedWindow.Meta; namespace Penumbra.UI.ModsTab.Groups; @@ -19,24 +15,11 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr public void Draw() { var identifier = group.Identifier; - var defaultEntry = ImcChecker.GetDefaultEntry(identifier, true).Entry; + var defaultEntry = editor.ImcChecker.GetDefaultEntry(identifier, true).Entry; var entry = group.DefaultEntry; var changes = false; - var width = editor.AvailableWidth.X - 3 * ImUtf8.ItemInnerSpacing.X - ImUtf8.ItemSpacing.X - ImUtf8.CalcTextSize("All Variants"u8).X - ImUtf8.CalcTextSize("Only Attributes"u8).X - 2 * ImUtf8.FrameHeight; - ImUtf8.TextFramed(identifier.ToString(), 0, new Vector2(width, 0), borderColor: ImGui.GetColorU32(ImGuiCol.Border)); - - ImUtf8.SameLineInner(); - var allVariants = group.AllVariants; - if (ImUtf8.Checkbox("All Variants"u8, ref allVariants)) - editor.ModManager.OptionEditor.ImcEditor.ChangeAllVariants(group, allVariants); - ImUtf8.HoverTooltip("Make this group overwrite all corresponding variants for this identifier, not just the one specified."u8); - - ImGui.SameLine(); - var onlyAttributes = group.OnlyAttributes; - if (ImUtf8.Checkbox("Only Attributes"u8, ref onlyAttributes)) - editor.ModManager.OptionEditor.ImcEditor.ChangeOnlyAttributes(group, onlyAttributes); - ImUtf8.HoverTooltip("Only overwrite the attribute flags and take all the other values from the game's default entry instead of the one configured here.\n\nMainly useful if used with All Variants to keep the material IDs for each variant."u8); + ImUtf8.TextFramed(identifier.ToString(), 0, editor.AvailableWidth, borderColor: ImGui.GetColorU32(ImGuiCol.Border)); using (ImUtf8.Group()) { @@ -48,9 +31,9 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr ImGui.SameLine(); using (ImUtf8.Group()) { - changes |= ImcMetaDrawer.DrawMaterialId(defaultEntry, ref entry, true); - changes |= ImcMetaDrawer.DrawVfxId(defaultEntry, ref entry, true); - changes |= ImcMetaDrawer.DrawDecalId(defaultEntry, ref entry, true); + changes |= ImcManipulationDrawer.DrawMaterialId(defaultEntry, ref entry, true); + changes |= ImcManipulationDrawer.DrawVfxId(defaultEntry, ref entry, true); + changes |= ImcManipulationDrawer.DrawDecalId(defaultEntry, ref entry, true); } ImGui.SameLine(0, editor.PriorityWidth); @@ -65,8 +48,8 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr using (ImUtf8.Group()) { - changes |= ImcMetaDrawer.DrawMaterialAnimationId(defaultEntry, ref entry, true); - changes |= ImcMetaDrawer.DrawSoundId(defaultEntry, ref entry, true); + changes |= ImcManipulationDrawer.DrawMaterialAnimationId(defaultEntry, ref entry, true); + changes |= ImcManipulationDrawer.DrawSoundId(defaultEntry, ref entry, true); var canBeDisabled = group.CanBeDisabled; if (ImUtf8.Checkbox("##disabled"u8, ref canBeDisabled)) editor.ModManager.OptionEditor.ImcEditor.ChangeCanBeDisabled(group, canBeDisabled); @@ -96,8 +79,7 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr foreach (var (option, idx) in group.OptionData.WithIndex().Where(o => !o.Value.IsDisableSubMod)) { using var id = ImUtf8.PushId(idx); - DrawAttributes(editor.ModManager.OptionEditor.ImcEditor, attributeCache, option.AttributeMask, option, - group.DefaultEntry.AttributeMask); + DrawAttributes(editor.ModManager.OptionEditor.ImcEditor, attributeCache, option.AttributeMask, option); } } } @@ -136,25 +118,22 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr : validName ? "Add a new option to this group."u8 : "Please enter a name for the new option."u8; - if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, default, !validName || dis)) + if (ImUtf8.IconButton(FontAwesomeIcon.Plus, tt, !validName || dis)) { editor.ModManager.OptionEditor.ImcEditor.AddOption(group, cache, name); editor.NewOptionName = null; } } - private static void DrawAttributes(ImcModGroupEditor editor, in ImcAttributeCache cache, ushort mask, object data, - ushort? defaultMask = null) + private static void DrawAttributes(ImcModGroupEditor editor, in ImcAttributeCache cache, ushort mask, object data) { for (var i = 0; i < ImcEntry.NumAttributes; ++i) { - using var id = ImRaii.PushId(i); - var flag = 1 << i; - var value = (mask & flag) != 0; - var inDefault = defaultMask.HasValue && (defaultMask & flag) != 0; - using (ImRaii.Disabled(defaultMask != null && !cache.CanChange(i))) + using var id = ImRaii.PushId(i); + var value = (mask & (1 << i)) != 0; + using (ImRaii.Disabled(!cache.CanChange(i))) { - if (inDefault ? NegativeCheckbox.Instance.Draw(""u8, ref value) : ImUtf8.Checkbox(""u8, ref value)) + if (ImUtf8.Checkbox(TerminatedByteString.Empty, ref value)) { if (data is ImcModGroup g) editor.ChangeDefaultAttribute(g, cache, i, value); @@ -163,26 +142,9 @@ public readonly struct ImcModGroupEditDrawer(ModGroupEditDrawer editor, ImcModGr } } - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, "ABCDEFGHIJ"u8.Slice(i, 1)); + ImUtf8.HoverTooltip("ABCDEFGHIJ"u8.Slice(i, 1)); if (i != 9) ImUtf8.SameLineInner(); } } - - private sealed class NegativeCheckbox : MultiStateCheckbox - { - public static readonly NegativeCheckbox Instance = new(); - - protected override void RenderSymbol(bool value, Vector2 position, float size) - { - if (value) - SymbolHelpers.RenderCross(ImGui.GetWindowDrawList(), position, ImGui.GetColorU32(ImGuiCol.CheckMark), size); - } - - protected override bool NextValue(bool value) - => !value; - - protected override bool PreviousValue(bool value) - => !value; - } } diff --git a/Penumbra/UI/ModsTab/Groups/ModGroupDrawer.cs b/Penumbra/UI/ModsTab/Groups/ModGroupDrawer.cs index 3d8409ad..dec77430 100644 --- a/Penumbra/UI/ModsTab/Groups/ModGroupDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/ModGroupDrawer.cs @@ -1,10 +1,8 @@ using Dalamud.Interface.Components; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -15,66 +13,16 @@ using Penumbra.Mods.SubMods; namespace Penumbra.UI.ModsTab.Groups; -public sealed class ModGroupDrawer : IUiService +public sealed class ModGroupDrawer(Configuration config, CollectionManager collectionManager) : IUiService { private readonly List<(IModGroup, int)> _blockGroupCache = []; - private bool _temporary; - private bool _locked; - private TemporaryModSettings? _tempSettings; - private ModSettings? _settings; - private readonly SingleGroupCombo _combo; - private readonly Configuration _config; - private readonly CollectionManager _collectionManager; - public ModGroupDrawer(Configuration config, CollectionManager collectionManager) - { - _config = config; - _collectionManager = collectionManager; - _combo = new SingleGroupCombo(this); - } - - private sealed class SingleGroupCombo(ModGroupDrawer parent) - : FilterComboCache(() => _group!.Options, MouseWheelType.Control, Penumbra.Log) - { - private static IModGroup? _group; - private static int _groupIdx; - - protected override bool DrawSelectable(int globalIdx, bool selected) - { - var option = _group!.Options[globalIdx]; - var ret = ImUtf8.Selectable(option.Name, globalIdx == CurrentSelectionIdx); - - if (option.Description.Length > 0) - ImUtf8.SelectableHelpMarker(option.Description); - - return ret; - } - - protected override string ToString(IModOption obj) - => obj.Name; - - public void Draw(IModGroup group, int groupIndex, int currentOption) - { - _group = group; - _groupIdx = groupIndex; - CurrentSelectionIdx = currentOption; - CurrentSelection = _group.Options[CurrentSelectionIdx]; - if (Draw(string.Empty, CurrentSelection.Name, string.Empty, ref CurrentSelectionIdx, UiHelpers.InputTextWidth.X * 3 / 4, - ImGui.GetTextLineHeightWithSpacing())) - parent.SetModSetting(_group, _groupIdx, Setting.Single(CurrentSelectionIdx)); - } - } - - public void Draw(Mod mod, ModSettings settings, TemporaryModSettings? tempSettings) + public void Draw(Mod mod, ModSettings settings) { if (mod.Groups.Count <= 0) return; _blockGroupCache.Clear(); - _settings = settings; - _tempSettings = tempSettings; - _temporary = tempSettings != null; - _locked = (tempSettings?.Lock ?? 0) > 0; var useDummy = true; foreach (var (group, idx) in mod.Groups.WithIndex()) { @@ -83,7 +31,7 @@ public sealed class ModGroupDrawer : IUiService switch (group.Behaviour) { - case GroupDrawBehaviour.SingleSelection when group.Options.Count <= _config.SingleGroupRadioMax: + case GroupDrawBehaviour.SingleSelection when group.Options.Count <= config.SingleGroupRadioMax: case GroupDrawBehaviour.MultiSelection: _blockGroupCache.Add((group, idx)); break; @@ -91,7 +39,7 @@ public sealed class ModGroupDrawer : IUiService case GroupDrawBehaviour.SingleSelection: ImGuiUtil.Dummy(UiHelpers.DefaultSpace, useDummy); useDummy = false; - DrawSingleGroupCombo(group, idx, settings.IsEmpty ? group.DefaultSettings : settings.Settings[idx]); + DrawSingleGroupCombo(group, idx, settings == ModSettings.Empty ? group.DefaultSettings : settings.Settings[idx]); break; } } @@ -101,7 +49,7 @@ public sealed class ModGroupDrawer : IUiService { ImGuiUtil.Dummy(UiHelpers.DefaultSpace, useDummy); useDummy = false; - var option = settings.IsEmpty ? group.DefaultSettings : settings.Settings[idx]; + var option = settings == ModSettings.Empty ? group.DefaultSettings : settings.Settings[idx]; if (group.Behaviour is GroupDrawBehaviour.MultiSelection) DrawMultiGroup(group, idx, option); else @@ -115,15 +63,32 @@ public sealed class ModGroupDrawer : IUiService /// private void DrawSingleGroupCombo(IModGroup group, int groupIdx, Setting setting) { - using var id = ImUtf8.PushId(groupIdx); - var selectedOption = setting.AsIndex; - using var disabled = ImRaii.Disabled(_locked); - _combo.Draw(group, groupIdx, selectedOption); + using var id = ImRaii.PushId(groupIdx); + var selectedOption = setting.AsIndex; + ImGui.SetNextItemWidth(UiHelpers.InputTextWidth.X * 3 / 4); + var options = group.Options; + using (var combo = ImRaii.Combo(string.Empty, options[selectedOption].Name)) + { + if (combo) + for (var idx2 = 0; idx2 < options.Count; ++idx2) + { + id.Push(idx2); + var option = options[idx2]; + if (ImGui.Selectable(option.Name, idx2 == selectedOption)) + SetModSetting(group, groupIdx, Setting.Single(idx2)); + + if (option.Description.Length > 0) + ImGuiUtil.SelectableHelpMarker(option.Description); + + id.Pop(); + } + } + ImGui.SameLine(); if (group.Description.Length > 0) - ImUtf8.LabeledHelpMarker(group.Name, group.Description); + ImGuiUtil.LabeledHelpMarker(group.Name, group.Description); else - ImUtf8.Text(group.Name); + ImGui.TextUnformatted(group.Name); } /// @@ -132,10 +97,10 @@ public sealed class ModGroupDrawer : IUiService /// private void DrawSingleGroupRadio(IModGroup group, int groupIdx, Setting setting) { - using var id = ImUtf8.PushId(groupIdx); - var selectedOption = setting.AsIndex; - var minWidth = Widget.BeginFramedGroup(group.Name, group.Description); - var options = group.Options; + using var id = ImRaii.PushId(groupIdx); + var selectedOption = setting.AsIndex; + var minWidth = Widget.BeginFramedGroup(group.Name, group.Description); + var options = group.Options; DrawCollapseHandling(options, minWidth, DrawOptions); Widget.EndFramedGroup(); @@ -143,12 +108,11 @@ public sealed class ModGroupDrawer : IUiService void DrawOptions() { - using var disabled = ImRaii.Disabled(_locked); for (var idx = 0; idx < group.Options.Count; ++idx) { - using var i = ImUtf8.PushId(idx); - var option = options[idx]; - if (ImUtf8.RadioButton(option.Name, selectedOption == idx)) + using var i = ImRaii.PushId(idx); + var option = options[idx]; + if (ImGui.RadioButton(option.Name, selectedOption == idx)) SetModSetting(group, groupIdx, Setting.Single(idx)); if (option.Description.Length <= 0) @@ -166,29 +130,28 @@ public sealed class ModGroupDrawer : IUiService /// private void DrawMultiGroup(IModGroup group, int groupIdx, Setting setting) { - using var id = ImUtf8.PushId(groupIdx); - var minWidth = Widget.BeginFramedGroup(group.Name, group.Description); - var options = group.Options; + using var id = ImRaii.PushId(groupIdx); + var minWidth = Widget.BeginFramedGroup(group.Name, group.Description); + var options = group.Options; DrawCollapseHandling(options, minWidth, DrawOptions); Widget.EndFramedGroup(); var label = $"##multi{groupIdx}"; if (ImGui.IsItemClicked(ImGuiMouseButton.Right)) - ImUtf8.OpenPopup($"##multi{groupIdx}"); + ImGui.OpenPopup($"##multi{groupIdx}"); DrawMultiPopup(group, groupIdx, label); return; void DrawOptions() { - using var disabled = ImRaii.Disabled(_locked); for (var idx = 0; idx < options.Count; ++idx) { - using var i = ImUtf8.PushId(idx); - var option = options[idx]; - var enabled = setting.HasFlag(idx); + using var i = ImRaii.PushId(idx); + var option = options[idx]; + var enabled = setting.HasFlag(idx); - if (ImUtf8.Checkbox(option.Name, ref enabled)) + if (ImGui.Checkbox(option.Name, ref enabled)) SetModSetting(group, groupIdx, setting.SetBit(idx, enabled)); if (option.Description.Length > 0) @@ -208,28 +171,27 @@ public sealed class ModGroupDrawer : IUiService return; ImGui.TextUnformatted(group.Name); - using var disabled = ImRaii.Disabled(_locked); ImGui.Separator(); - if (ImUtf8.Selectable("Enable All"u8)) + if (ImGui.Selectable("Enable All")) SetModSetting(group, groupIdx, Setting.AllBits(group.Options.Count)); - if (ImUtf8.Selectable("Disable All"u8)) + if (ImGui.Selectable("Disable All")) SetModSetting(group, groupIdx, Setting.Zero); } private void DrawCollapseHandling(IReadOnlyList options, float minWidth, Action draw) { - if (options.Count <= _config.OptionGroupCollapsibleMin) + if (options.Count <= config.OptionGroupCollapsibleMin) { draw(); } else { - var collapseId = ImUtf8.GetId("Collapse"); - var shown = ImGui.GetStateStorage().GetBool(collapseId, true); + var collapseId = ImGui.GetID("Collapse"); + var shown = ImGui.GetStateStorage().GetBool(collapseId, true); var buttonTextShow = $"Show {options.Count} Options"; var buttonTextHide = $"Hide {options.Count} Options"; - var buttonWidth = Math.Max(ImUtf8.CalcTextSize(buttonTextShow).X, ImUtf8.CalcTextSize(buttonTextHide).X) + var buttonWidth = Math.Max(ImGui.CalcTextSize(buttonTextShow).X, ImGui.CalcTextSize(buttonTextHide).X) + 2 * ImGui.GetStyle().FramePadding.X; minWidth = Math.Max(buttonWidth, minWidth); if (shown) @@ -242,43 +204,30 @@ public sealed class ModGroupDrawer : IUiService } - var width = Math.Max(ImGui.GetItemRectSize().X, minWidth); + var width = Math.Max(ImGui.GetItemRectSize().X, minWidth); var endPos = ImGui.GetCursorPos(); ImGui.SetCursorPos(pos); - if (ImUtf8.Button(buttonTextHide, new Vector2(width, 0))) + if (ImGui.Button(buttonTextHide, new Vector2(width, 0))) ImGui.GetStateStorage().SetBool(collapseId, !shown); ImGui.SetCursorPos(endPos); } else { - var optionWidth = options.Max(o => ImUtf8.CalcTextSize(o.Name).X) + var optionWidth = options.Max(o => ImGui.CalcTextSize(o.Name).X) + ImGui.GetStyle().ItemInnerSpacing.X + ImGui.GetFrameHeight() + ImGui.GetStyle().FramePadding.X; var width = Math.Max(optionWidth, minWidth); - if (ImUtf8.Button(buttonTextShow, new Vector2(width, 0))) + if (ImGui.Button(buttonTextShow, new Vector2(width, 0))) ImGui.GetStateStorage().SetBool(collapseId, !shown); } } } private ModCollection Current - => _collectionManager.Active.Current; + => collectionManager.Active.Current; - [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)] private void SetModSetting(IModGroup group, int groupIdx, Setting setting) - { - if (_temporary || _config.DefaultTemporaryMode) - { - _tempSettings ??= new TemporaryModSettings(group.Mod, _settings); - _tempSettings!.ForceInherit = false; - _tempSettings!.Settings[groupIdx] = setting; - _collectionManager.Editor.SetTemporarySettings(Current, group.Mod, _tempSettings); - } - else - { - _collectionManager.Editor.SetModSetting(Current, group.Mod, groupIdx, setting); - } - } + => collectionManager.Editor.SetModSetting(Current, group.Mod, groupIdx, setting); } diff --git a/Penumbra/UI/ModsTab/Groups/ModGroupEditDrawer.cs b/Penumbra/UI/ModsTab/Groups/ModGroupEditDrawer.cs index 9610f173..e8a27a74 100644 --- a/Penumbra/UI/ModsTab/Groups/ModGroupEditDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/ModGroupEditDrawer.cs @@ -1,9 +1,8 @@ using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; +using Dalamud.Interface.Internal.Notifications; +using ImGuiNET; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Raii; using OtterGui.Services; using OtterGui.Text; @@ -59,9 +58,6 @@ public sealed class ModGroupEditDrawer( private IModOption? _dragDropOption; private bool _draggingAcross; - internal string? CombiningDisplayName; - internal int CombiningDisplayIndex; - public void Draw(Mod mod) { PrepareStyle(); @@ -279,7 +275,6 @@ public sealed class ModGroupEditDrawer( [MethodImpl(MethodImplOptions.AggressiveInlining)] internal string DrawNewOptionBase(IModGroup group, int count) { - ImGui.AlignTextToFramePadding(); ImUtf8.Selectable($"Option #{count + 1}", false, size: OptionIdxSelectable); Target(group, count); @@ -326,8 +321,8 @@ public sealed class ModGroupEditDrawer( && (!_draggingAcross || (_dragDropGroup != null && group is MultiModGroup { Options.Count: >= IModGroup.MaxMultiOptions }))) return; - using var target = ImUtf8.DragDropTarget(); - if (!target.IsDropping(_draggingAcross ? AcrossGroupsLabel : InsideGroupLabel)) + using var target = ImRaii.DragDropTarget(); + if (!target.Success || !DragDropTarget.CheckPayload(_draggingAcross ? AcrossGroupsLabel : InsideGroupLabel)) return; if (_dragDropGroup != null && _dragDropOption != null) diff --git a/Penumbra/UI/ModsTab/Groups/MultiModGroupEditDrawer.cs b/Penumbra/UI/ModsTab/Groups/MultiModGroupEditDrawer.cs index 04ca6c82..e6701a03 100644 --- a/Penumbra/UI/ModsTab/Groups/MultiModGroupEditDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/MultiModGroupEditDrawer.cs @@ -1,5 +1,5 @@ using Dalamud.Interface; -using OtterGui.Extensions; +using OtterGui; using OtterGui.Raii; using OtterGui.Text; using Penumbra.Mods.Groups; @@ -54,7 +54,7 @@ public readonly struct MultiModGroupEditDrawer(ModGroupEditDrawer editor, MultiM var validName = name.Length > 0; if (ImUtf8.IconButton(FontAwesomeIcon.Plus, validName ? "Add a new option to this group."u8 - : "Please enter a name for the new option."u8, default, !validName)) + : "Please enter a name for the new option."u8, !validName)) { editor.ModManager.OptionEditor.MultiEditor.AddOption(group, name); editor.NewOptionName = null; diff --git a/Penumbra/UI/ModsTab/Groups/SingleModGroupEditDrawer.cs b/Penumbra/UI/ModsTab/Groups/SingleModGroupEditDrawer.cs index 8fa6a377..75fbc63a 100644 --- a/Penumbra/UI/ModsTab/Groups/SingleModGroupEditDrawer.cs +++ b/Penumbra/UI/ModsTab/Groups/SingleModGroupEditDrawer.cs @@ -1,6 +1,6 @@ using Dalamud.Interface; -using Dalamud.Bindings.ImGui; -using OtterGui.Extensions; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; using OtterGui.Text; using Penumbra.Mods.Groups; @@ -59,7 +59,7 @@ public readonly struct SingleModGroupEditDrawer(ModGroupEditDrawer editor, Singl var validName = name.Length > 0; if (ImUtf8.IconButton(FontAwesomeIcon.Plus, validName ? "Add a new option to this group."u8 - : "Please enter a name for the new option."u8, default, !validName)) + : "Please enter a name for the new option."u8, !validName)) { editor.ModManager.OptionEditor.SingleEditor.AddOption(group, name); editor.NewOptionName = null; diff --git a/Penumbra/UI/ModsTab/ImcManipulationDrawer.cs b/Penumbra/UI/ModsTab/ImcManipulationDrawer.cs new file mode 100644 index 00000000..694ae11c --- /dev/null +++ b/Penumbra/UI/ModsTab/ImcManipulationDrawer.cs @@ -0,0 +1,219 @@ +using ImGuiNET; +using OtterGui.Raii; +using OtterGui.Text; +using Penumbra.GameData.Enums; +using Penumbra.GameData.Structs; +using Penumbra.Meta.Manipulations; +using Penumbra.UI.Classes; + +namespace Penumbra.UI.ModsTab; + +public static class ImcManipulationDrawer +{ + public static bool DrawObjectType(ref ImcIdentifier identifier, float width = 110) + { + var ret = Combos.ImcType("##imcType", identifier.ObjectType, out var type, width); + ImUtf8.HoverTooltip("Object Type"u8); + + if (ret) + { + var equipSlot = type switch + { + ObjectType.Equipment => identifier.EquipSlot.IsEquipment() ? identifier.EquipSlot : EquipSlot.Head, + ObjectType.DemiHuman => identifier.EquipSlot.IsEquipment() ? identifier.EquipSlot : EquipSlot.Head, + ObjectType.Accessory => identifier.EquipSlot.IsAccessory() ? identifier.EquipSlot : EquipSlot.Ears, + _ => EquipSlot.Unknown, + }; + identifier = identifier with + { + ObjectType = type, + EquipSlot = equipSlot, + SecondaryId = identifier.SecondaryId == 0 ? 1 : identifier.SecondaryId, + }; + } + + return ret; + } + + public static bool DrawPrimaryId(ref ImcIdentifier identifier, float unscaledWidth = 80) + { + var ret = IdInput("##imcPrimaryId"u8, unscaledWidth, identifier.PrimaryId.Id, out var newId, 0, ushort.MaxValue, + identifier.PrimaryId.Id <= 1); + ImUtf8.HoverTooltip("Primary ID - You can usually find this as the 'x####' part of an item path.\n"u8 + + "This should generally not be left <= 1 unless you explicitly want that."u8); + if (ret) + identifier = identifier with { PrimaryId = newId }; + return ret; + } + + public static bool DrawSecondaryId(ref ImcIdentifier identifier, float unscaledWidth = 100) + { + var ret = IdInput("##imcSecondaryId"u8, unscaledWidth, identifier.SecondaryId.Id, out var newId, 0, ushort.MaxValue, false); + ImUtf8.HoverTooltip("Secondary ID"u8); + if (ret) + identifier = identifier with { SecondaryId = newId }; + return ret; + } + + public static bool DrawVariant(ref ImcIdentifier identifier, float unscaledWidth = 45) + { + var ret = IdInput("##imcVariant"u8, unscaledWidth, identifier.Variant.Id, out var newId, 0, byte.MaxValue, false); + ImUtf8.HoverTooltip("Variant ID"u8); + if (ret) + identifier = identifier with { Variant = (byte)newId }; + return ret; + } + + public static bool DrawSlot(ref ImcIdentifier identifier, float unscaledWidth = 100) + { + bool ret; + EquipSlot slot; + switch (identifier.ObjectType) + { + case ObjectType.Equipment: + case ObjectType.DemiHuman: + ret = Combos.EqpEquipSlot("##slot", identifier.EquipSlot, out slot, unscaledWidth); + break; + case ObjectType.Accessory: + ret = Combos.AccessorySlot("##slot", identifier.EquipSlot, out slot, unscaledWidth); + break; + default: return false; + } + + ImUtf8.HoverTooltip("Equip Slot"u8); + if (ret) + identifier = identifier with { EquipSlot = slot }; + return ret; + } + + public static bool DrawMaterialId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) + { + if (!DragInput("##materialId"u8, "Material ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.MaterialId, defaultEntry.MaterialId, + out var newValue, (byte)1, byte.MaxValue, 0.01f, addDefault)) + return false; + + entry = entry with { MaterialId = newValue }; + return true; + } + + public static bool DrawMaterialAnimationId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) + { + if (!DragInput("##mAnimId"u8, "Material Animation ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.MaterialAnimationId, + defaultEntry.MaterialAnimationId, out var newValue, (byte)0, byte.MaxValue, 0.01f, addDefault)) + return false; + + entry = entry with { MaterialAnimationId = newValue }; + return true; + } + + public static bool DrawDecalId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) + { + if (!DragInput("##decalId"u8, "Decal ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.DecalId, defaultEntry.DecalId, out var newValue, + (byte)0, byte.MaxValue, 0.01f, addDefault)) + return false; + + entry = entry with { DecalId = newValue }; + return true; + } + + public static bool DrawVfxId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) + { + if (!DragInput("##vfxId"u8, "VFX ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.VfxId, defaultEntry.VfxId, out var newValue, (byte)0, + byte.MaxValue, 0.01f, addDefault)) + return false; + + entry = entry with { VfxId = newValue }; + return true; + } + + public static bool DrawSoundId(ImcEntry defaultEntry, ref ImcEntry entry, bool addDefault, float unscaledWidth = 45) + { + if (!DragInput("##soundId"u8, "Sound ID"u8, unscaledWidth * ImUtf8.GlobalScale, entry.SoundId, defaultEntry.SoundId, out var newValue, + (byte)0, byte.MaxValue, 0.01f, addDefault)) + return false; + + entry = entry with { SoundId = newValue }; + return true; + } + + public static bool DrawAttributes(ImcEntry defaultEntry, ref ImcEntry entry) + { + var changes = false; + for (var i = 0; i < ImcEntry.NumAttributes; ++i) + { + using var id = ImRaii.PushId(i); + var flag = 1 << i; + var value = (entry.AttributeMask & flag) != 0; + var def = (defaultEntry.AttributeMask & flag) != 0; + if (Checkmark("##attribute"u8, "ABCDEFGHIJ"u8.Slice(i, 1), value, def, out var newValue)) + { + var newMask = (ushort)(newValue ? entry.AttributeMask | flag : entry.AttributeMask & ~flag); + entry = entry with { AttributeMask = newMask }; + changes = true; + } + + if (i < ImcEntry.NumAttributes - 1) + ImGui.SameLine(); + } + + return changes; + } + + + /// + /// A number input for ids with an optional max id of given width. + /// Returns true if newId changed against currentId. + /// + private static bool IdInput(ReadOnlySpan label, float unscaledWidth, ushort currentId, out ushort newId, int minId, int maxId, + bool border) + { + int tmp = currentId; + ImGui.SetNextItemWidth(unscaledWidth * ImUtf8.GlobalScale); + using var style = ImRaii.PushStyle(ImGuiStyleVar.FrameBorderSize, UiHelpers.Scale, border); + using var color = ImRaii.PushColor(ImGuiCol.Border, Colors.RegexWarningBorder, border); + if (ImUtf8.InputScalar(label, ref tmp)) + tmp = Math.Clamp(tmp, minId, maxId); + + newId = (ushort)tmp; + return newId != currentId; + } + + /// + /// A dragging int input of given width that compares against a default value, shows a tooltip and clamps against min and max. + /// Returns true if newValue changed against currentValue. + /// + private static bool DragInput(ReadOnlySpan label, ReadOnlySpan tooltip, float width, T currentValue, T defaultValue, + out T newValue, T minValue, T maxValue, float speed, bool addDefault) where T : unmanaged, INumber + { + newValue = currentValue; + using var color = ImRaii.PushColor(ImGuiCol.FrameBg, + defaultValue > currentValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), + defaultValue != currentValue); + ImGui.SetNextItemWidth(width); + if (ImUtf8.DragScalar(label, ref newValue, minValue, maxValue, speed)) + newValue = newValue <= minValue ? minValue : newValue >= maxValue ? maxValue : newValue; + + if (addDefault) + ImUtf8.HoverTooltip($"{tooltip}\nDefault Value: {defaultValue}"); + else + ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, tooltip); + + return newValue != currentValue; + } + + /// + /// A checkmark that compares against a default value and shows a tooltip. + /// Returns true if newValue is changed against currentValue. + /// + private static bool Checkmark(ReadOnlySpan label, ReadOnlySpan tooltip, bool currentValue, bool defaultValue, + out bool newValue) + { + using var color = ImRaii.PushColor(ImGuiCol.FrameBg, + defaultValue ? ColorId.DecreasedMetaValue.Value() : ColorId.IncreasedMetaValue.Value(), + defaultValue != currentValue); + newValue = currentValue; + ImUtf8.Checkbox(label, ref newValue); + ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, tooltip); + return newValue != currentValue; + } +} diff --git a/Penumbra/UI/ModsTab/ModFileSystemSelector.cs b/Penumbra/UI/ModsTab/ModFileSystemSelector.cs index 3f3c82aa..5b6cfa99 100644 --- a/Penumbra/UI/ModsTab/ModFileSystemSelector.cs +++ b/Penumbra/UI/ModsTab/ModFileSystemSelector.cs @@ -1,16 +1,13 @@ using Dalamud.Interface; using Dalamud.Interface.DragDrop; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Plugin.Services; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Filesystem; using OtterGui.FileSystem.Selector; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using OtterGui.Text.Widget; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -24,22 +21,23 @@ using MessageService = Penumbra.Services.MessageService; namespace Penumbra.UI.ModsTab; -public sealed class ModFileSystemSelector : FileSystemSelector, IUiService +public sealed class ModFileSystemSelector : FileSystemSelector { - private readonly CommunicatorService _communicator; - private readonly Configuration _config; - private readonly FileDialogService _fileDialog; - private readonly ModManager _modManager; - private readonly CollectionManager _collectionManager; - private readonly TutorialService _tutorial; - private readonly ModImportManager _modImportManager; - private readonly IDragDropManager _dragDrop; - private readonly ModSearchStringSplitter _filter = new(); - private readonly ModSelection _selection; + private readonly CommunicatorService _communicator; + private readonly MessageService _messager; + private readonly Configuration _config; + private readonly FileDialogService _fileDialog; + private readonly ModManager _modManager; + private readonly CollectionManager _collectionManager; + private readonly TutorialService _tutorial; + private readonly ModImportManager _modImportManager; + private readonly IDragDropManager _dragDrop; + public ModSettings SelectedSettings { get; private set; } = ModSettings.Empty; + public ModCollection SelectedSettingCollection { get; private set; } = ModCollection.Empty; public ModFileSystemSelector(IKeyState keyState, CommunicatorService communicator, ModFileSystem fileSystem, ModManager modManager, CollectionManager collectionManager, Configuration config, TutorialService tutorial, FileDialogService fileDialog, - MessageService messager, ModImportManager modImportManager, IDragDropManager dragDrop, ModSelection selection) + MessageService messager, ModImportManager modImportManager, IDragDropManager dragDrop) : base(fileSystem, keyState, Penumbra.Log, HandleException, allowMultipleSelection: true) { _communicator = communicator; @@ -48,9 +46,9 @@ public sealed class ModFileSystemSelector : FileSystemSelector SetQuickMove(f, 1, _config.QuickMoveFolder2, s => { _config.QuickMoveFolder2 = s; _config.Save(); }), 120); SubscribeRightClickFolder(f => SetQuickMove(f, 2, _config.QuickMoveFolder3, s => { _config.QuickMoveFolder3 = s; _config.Save(); }), 130); SubscribeRightClickLeaf(ToggleLeafFavorite); - SubscribeRightClickLeaf(DrawTemporaryOptions); SubscribeRightClickLeaf(l => QuickMove(l, _config.QuickMoveFolder1, _config.QuickMoveFolder2, _config.QuickMoveFolder3)); - SubscribeRightClickMain(ClearTemporarySettings, 105); SubscribeRightClickMain(ClearDefaultImportFolder, 100); SubscribeRightClickMain(() => ClearQuickMove(0, _config.QuickMoveFolder1, () => {_config.QuickMoveFolder1 = string.Empty; _config.Save();}), 110); SubscribeRightClickMain(() => ClearQuickMove(1, _config.QuickMoveFolder2, () => {_config.QuickMoveFolder2 = string.Empty; _config.Save();}), 120); @@ -78,16 +74,22 @@ public sealed class ModFileSystemSelector : FileSystemSelector 0) + { + var mod = _modManager.FirstOrDefault(m + => string.Equals(m.Identifier, _config.Ephemeral.LastModPath, StringComparison.OrdinalIgnoreCase)); + if (mod != null) + SelectByValue(mod); + } + _communicator.CollectionChange.Subscribe(OnCollectionChange, CollectionChange.Priority.ModFileSystemSelector); _communicator.ModSettingChanged.Subscribe(OnSettingChange, ModSettingChanged.Priority.ModFileSystemSelector); _communicator.CollectionInheritanceChanged.Subscribe(OnInheritanceChange, CollectionInheritanceChanged.Priority.ModFileSystemSelector); _communicator.ModDataChanged.Subscribe(OnModDataChange, ModDataChanged.Priority.ModFileSystemSelector); _communicator.ModDiscoveryStarted.Subscribe(StoreCurrentSelection, ModDiscoveryStarted.Priority.ModFileSystemSelector); _communicator.ModDiscoveryFinished.Subscribe(RestoreLastSelection, ModDiscoveryFinished.Priority.ModFileSystemSelector); - SetFilterDirty(); - SelectionChanged += OnSelectionChanged; + OnCollectionChange(CollectionType.Current, null, _collectionManager.Active.Current, ""); } public void SetRenameSearchPath(RenameField value) @@ -126,47 +128,23 @@ public sealed class ModFileSystemSelector : FileSystemSelector m.Extensions.Any(e => ValidModExtensions.Contains(e.ToLowerInvariant())), m => { - ImUtf8.Text($"Dragging mods for import:\n\t{string.Join("\n\t", m.Files.Select(Path.GetFileName))}"); + ImGui.TextUnformatted($"Dragging mods for import:\n\t{string.Join("\n\t", m.Files.Select(Path.GetFileName))}"); return true; }); - base.Draw(); + base.Draw(width); if (_dragDrop.CreateImGuiTarget("ModDragDrop", out var files, out _)) _modImportManager.AddUnpack(files.Where(f => ValidModExtensions.Contains(Path.GetExtension(f.ToLowerInvariant())))); } - protected override float CurrentWidth - => _config.Ephemeral.CurrentModSelectorWidth * ImUtf8.GlobalScale; - - protected override float MinimumAbsoluteRemainder - => 550 * ImUtf8.GlobalScale; - - protected override float MinimumScaling - => _config.Ephemeral.ModSelectorMinimumScale; - - protected override float MaximumScaling - => _config.Ephemeral.ModSelectorMaximumScale; - - protected override void SetSize(Vector2 size) - { - base.SetSize(size); - var adaptedSize = MathF.Round(size.X / ImUtf8.GlobalScale); - if (adaptedSize == _config.Ephemeral.CurrentModSelectorWidth) - return; - - _config.Ephemeral.CurrentModSelectorWidth = adaptedSize; - _config.Ephemeral.Save(); - } - public override void Dispose() { base.Dispose(); @@ -208,49 +186,39 @@ public sealed class ModFileSystemSelector : FileSystemSelector.Leaf leaf, in ModState state, bool selected) { var flags = selected ? ImGuiTreeNodeFlags.Selected | LeafFlags : LeafFlags; - using var c = ImRaii.PushColor(ImGuiCol.Text, state.Color.Tinted(state.Tint)) + using var c = ImRaii.PushColor(ImGuiCol.Text, state.Color.Value()) .Push(ImGuiCol.HeaderHovered, 0x4000FFFF, leaf.Value.Favorite); - using var id = ImUtf8.PushId(leaf.Value.Index); - ImUtf8.TreeNode(leaf.Value.Name.Text, flags).Dispose(); + using var id = ImRaii.PushId(leaf.Value.Index); + ImRaii.TreeNode(leaf.Value.Name, flags).Dispose(); if (ImGui.IsItemClicked(ImGuiMouseButton.Middle)) { _modManager.SetKnown(leaf.Value); - var (setting, collection) = _collectionManager.Active.Current.GetActualSettings(leaf.Value.Index); + var (setting, collection) = _collectionManager.Active.Current[leaf.Value.Index]; if (_config.DeleteModModifier.ForcedModifier(new DoubleModifier(ModifierHotkey.Control, ModifierHotkey.Shift)).IsActive()) { - // Delete temporary settings if they exist, regardless of mode, or set to inheriting if none exist. - if (_collectionManager.Active.Current.GetTempSettings(leaf.Value.Index) is not null) - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, leaf.Value, null); - else - _collectionManager.Editor.SetModInheritance(_collectionManager.Active.Current, leaf.Value, true); + _collectionManager.Editor.SetModInheritance(_collectionManager.Active.Current, leaf.Value, true); } else { - if (_config.DefaultTemporaryMode) - { - var settings = new TemporaryModSettings(leaf.Value, setting) { ForceInherit = false }; - settings.Enabled = !settings.Enabled; - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, leaf.Value, settings); - } - else - { - var inherited = collection != _collectionManager.Active.Current; - if (inherited) - _collectionManager.Editor.SetModInheritance(_collectionManager.Active.Current, leaf.Value, false); - _collectionManager.Editor.SetModState(_collectionManager.Active.Current, leaf.Value, setting is not { Enabled: true }); - } + var inherited = collection != _collectionManager.Active.Current; + if (inherited) + _collectionManager.Editor.SetModInheritance(_collectionManager.Active.Current, leaf.Value, false); + _collectionManager.Editor.SetModState(_collectionManager.Active.Current, leaf.Value, setting is not { Enabled: true }); } } @@ -275,69 +243,37 @@ public sealed class ModFileSystemSelector : FileSystemSelector.Leaf mod) { - if (ImUtf8.MenuItem(mod.Value.Favorite ? "Remove Favorite"u8 : "Mark as Favorite"u8)) + if (ImGui.MenuItem(mod.Value.Favorite ? "Remove Favorite" : "Mark as Favorite")) _modManager.DataEditor.ChangeModFavorite(mod.Value, !mod.Value.Favorite); } - private void DrawTemporaryOptions(FileSystem.Leaf mod) - { - var tempSettings = _collectionManager.Active.Current.GetTempSettings(mod.Value.Index); - if (tempSettings is { Lock: > 0 }) - return; - - if (tempSettings is { Lock: <= 0 } && ImUtf8.MenuItem("Remove Temporary Settings"u8)) - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, mod.Value, null); - var actual = _collectionManager.Active.Current.GetActualSettings(mod.Value.Index).Settings; - if (actual?.Enabled is true && ImUtf8.MenuItem("Disable Temporarily"u8)) - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, mod.Value, - new TemporaryModSettings(mod.Value, actual) { Enabled = false }); - - if (actual is not { Enabled: true } && ImUtf8.MenuItem("Enable Temporarily"u8)) - { - var newSettings = actual is null - ? TemporaryModSettings.DefaultSettings(mod.Value, TemporaryModSettings.OwnSource, true) - : new TemporaryModSettings(mod.Value, actual) { Enabled = true }; - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, mod.Value, newSettings); - } - - if (tempSettings is null && ImUtf8.MenuItem("Turn Temporary"u8)) - _collectionManager.Editor.SetTemporarySettings(_collectionManager.Active.Current, mod.Value, - new TemporaryModSettings(mod.Value, actual)); - } - private void SetDefaultImportFolder(ModFileSystem.Folder folder) { - if (!ImUtf8.MenuItem("Set As Default Import Folder"u8)) + if (!ImGui.MenuItem("Set As Default Import Folder")) return; var newName = folder.FullName(); @@ -350,7 +286,7 @@ public sealed class ModFileSystemSelector : FileSystemSelector Add an import mods button that opens a file selector. private void AddImportModButton(Vector2 size) { - var button = ImUtf8.IconButton(FontAwesomeIcon.FileImport, - "Import one or multiple mods from Tex Tools Mod Pack Files or Penumbra Mod Pack Files."u8, size, !_modManager.Valid); + var button = ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.FileImport.ToIconString(), size, + "Import one or multiple mods from Tex Tools Mod Pack Files or Penumbra Mod Pack Files.", !_modManager.Valid, true); _tutorial.OpenTutorial(BasicTutorialSteps.ModImport); if (!button) return; @@ -381,7 +318,7 @@ public sealed class ModFileSystemSelector : FileSystemSelector + "Mod Packs{.ttmp,.ttmp2,.pmp},TexTools Mod Packs{.ttmp,.ttmp2},Penumbra Mod Packs{.pmp},Archives{.zip,.7z,.rar}", (s, f) => { if (!s) return; @@ -402,14 +339,14 @@ public sealed class ModFileSystemSelector : FileSystemSelector + /// If a default import folder is setup, try to move the given mod in there. + /// If the folder does not exist, create it if possible. + /// + /// + private void MoveModToDefaultDirectory(Mod mod) + { + if (_config.DefaultImportFolder.Length == 0) + return; + + try + { + var leaf = FileSystem.Root.GetChildren(ISortMode.Lexicographical) + .FirstOrDefault(f => f is FileSystem.Leaf l && l.Value == mod); + if (leaf == null) + throw new Exception("Mod was not found at root."); + + var folder = FileSystem.FindOrCreateAllFolders(_config.DefaultImportFolder); + FileSystem.Move(leaf, folder); + } + catch (Exception e) + { + _messager.NotificationMessage(e, + $"Could not move newly imported mod {mod.Name} to default import folder {_config.DefaultImportFolder}.", + NotificationType.Warning); + } + } + private void DrawHelpPopup() { ImGuiUtil.HelpPopup("ExtendedHelp", new Vector2(1000 * UiHelpers.Scale, 38.5f * ImGui.GetTextLineHeightWithSpacing()), () => { ImGui.Dummy(Vector2.UnitY * ImGui.GetTextLineHeight()); - ImUtf8.Text("Mod Management"u8); - ImUtf8.BulletText("You can create empty mods or import mods with the buttons in this row."u8); + ImGui.TextUnformatted("Mod Management"); + ImGui.BulletText("You can create empty mods or import mods with the buttons in this row."); using var indent = ImRaii.PushIndent(); - ImUtf8.BulletText("Supported formats for import are: .ttmp, .ttmp2, .pmp, .pcp."u8); - ImUtf8.BulletText( - "You can also support .zip, .7z or .rar archives, but only if they already contain Penumbra-styled mods with appropriate metadata."u8); + ImGui.BulletText("Supported formats for import are: .ttmp, .ttmp2, .pmp."); + ImGui.BulletText( + "You can also support .zip, .7z or .rar archives, but only if they already contain Penumbra-styled mods with appropriate metadata."); indent.Pop(1); - ImUtf8.BulletText("You can also create empty mod folders and delete mods."u8); - ImUtf8.BulletText( - "For further editing of mods, select them and use the Edit Mod tab in the panel or the Advanced Editing popup."u8); + ImGui.BulletText("You can also create empty mod folders and delete mods."); + ImGui.BulletText("For further editing of mods, select them and use the Edit Mod tab in the panel or the Advanced Editing popup."); ImGui.Dummy(Vector2.UnitY * ImGui.GetTextLineHeight()); - ImUtf8.Text("Mod Selector"u8); - ImUtf8.BulletText("Select a mod to obtain more information or change settings."u8); - ImUtf8.BulletText("Names are colored according to your config and their current state in the collection:"u8); + ImGui.TextUnformatted("Mod Selector"); + ImGui.BulletText("Select a mod to obtain more information or change settings."); + ImGui.BulletText("Names are colored according to your config and their current state in the collection:"); indent.Push(); - ImUtf8.BulletTextColored(ColorId.EnabledMod.Value(), "enabled in the current collection."u8); - ImUtf8.BulletTextColored(ColorId.DisabledMod.Value(), "disabled in the current collection."u8); - ImUtf8.BulletTextColored(ColorId.InheritedMod.Value(), "enabled due to inheritance from another collection."u8); - ImUtf8.BulletTextColored(ColorId.InheritedDisabledMod.Value(), "disabled due to inheritance from another collection."u8); - ImUtf8.BulletTextColored(ColorId.UndefinedMod.Value(), "unconfigured in all inherited collections."u8); - ImUtf8.BulletTextColored(ColorId.HandledConflictMod.Value(), - "enabled and conflicting with another enabled Mod, but on different priorities (i.e. the conflict is solved)."u8); - ImUtf8.BulletTextColored(ColorId.ConflictingMod.Value(), - "enabled and conflicting with another enabled Mod on the same priority."u8); - ImUtf8.BulletTextColored(ColorId.FolderExpanded.Value(), "expanded mod folder."u8); - ImUtf8.BulletTextColored(ColorId.FolderCollapsed.Value(), "collapsed mod folder"u8); + ImGuiUtil.BulletTextColored(ColorId.EnabledMod.Value(), "enabled in the current collection."); + ImGuiUtil.BulletTextColored(ColorId.DisabledMod.Value(), "disabled in the current collection."); + ImGuiUtil.BulletTextColored(ColorId.InheritedMod.Value(), "enabled due to inheritance from another collection."); + ImGuiUtil.BulletTextColored(ColorId.InheritedDisabledMod.Value(), "disabled due to inheritance from another collection."); + ImGuiUtil.BulletTextColored(ColorId.UndefinedMod.Value(), "unconfigured in all inherited collections."); + ImGuiUtil.BulletTextColored(ColorId.NewMod.Value(), + "newly imported during this session. Will go away when first enabling a mod or when Penumbra is reloaded."); + ImGuiUtil.BulletTextColored(ColorId.HandledConflictMod.Value(), + "enabled and conflicting with another enabled Mod, but on different priorities (i.e. the conflict is solved)."); + ImGuiUtil.BulletTextColored(ColorId.ConflictingMod.Value(), + "enabled and conflicting with another enabled Mod on the same priority."); + ImGuiUtil.BulletTextColored(ColorId.FolderExpanded.Value(), "expanded mod folder."); + ImGuiUtil.BulletTextColored(ColorId.FolderCollapsed.Value(), "collapsed mod folder"); indent.Pop(1); - ImUtf8.BulletText("Middle-click a mod to disable it if it is enabled or enable it if it is disabled."u8); + ImGui.BulletText("Middle-click a mod to disable it if it is enabled or enable it if it is disabled."); indent.Push(); - ImUtf8.BulletText( + ImGui.BulletText( $"Holding {_config.DeleteModModifier.ForcedModifier(new DoubleModifier(ModifierHotkey.Control, ModifierHotkey.Shift))} while middle-clicking lets it inherit, discarding settings."); indent.Pop(1); - ImUtf8.BulletText("Right-click a mod to enter its sort order, which is its name by default, possibly with a duplicate number."u8); + ImGui.BulletText("Right-click a mod to enter its sort order, which is its name by default, possibly with a duplicate number."); indent.Push(); - ImUtf8.BulletText("A sort order differing from the mods name will not be displayed, it will just be used for ordering."u8); - ImUtf8.BulletText( - "If the sort order string contains Forward-Slashes ('/'), the preceding substring will be turned into folders automatically."u8); + ImGui.BulletText("A sort order differing from the mods name will not be displayed, it will just be used for ordering."); + ImGui.BulletText( + "If the sort order string contains Forward-Slashes ('/'), the preceding substring will be turned into folders automatically."); indent.Pop(1); - ImUtf8.BulletText( - "You can drag and drop mods and subfolders into existing folders. Dropping them onto mods is the same as dropping them onto the parent of the mod."u8); + ImGui.BulletText( + "You can drag and drop mods and subfolders into existing folders. Dropping them onto mods is the same as dropping them onto the parent of the mod."); indent.Push(); - ImUtf8.BulletText( - "You can select multiple mods and folders by holding Control while clicking them, and then drag all of them at once."u8); - ImUtf8.BulletText( - "Selected mods inside an also selected folder will be ignored when dragging and move inside their folder instead of directly into the target."u8); + ImGui.BulletText( + "You can select multiple mods and folders by holding Control while clicking them, and then drag all of them at once."); + ImGui.BulletText( + "Selected mods inside an also selected folder will be ignored when dragging and move inside their folder instead of directly into the target."); indent.Pop(1); - ImUtf8.BulletText("Right-clicking a folder opens a context menu."u8); - ImUtf8.BulletText("Right-clicking empty space allows you to expand or collapse all folders at once."u8); - ImUtf8.BulletText("Use the Filter Mods... input at the top to filter the list for mods whose name or path contain the text."u8); + ImGui.BulletText("Right-clicking a folder opens a context menu."); + ImGui.BulletText("Right-clicking empty space allows you to expand or collapse all folders at once."); + ImGui.BulletText("Use the Filter Mods... input at the top to filter the list for mods whose name or path contain the text."); indent.Push(); - ImUtf8.BulletText("You can enter n:[string] to filter only for names, without path."u8); - ImUtf8.BulletText("You can enter c:[string] to filter for Changed Items instead."u8); - ImUtf8.BulletText("You can enter a:[string] to filter for Mod Authors instead."u8); + ImGui.BulletText("You can enter n:[string] to filter only for names, without path."); + ImGui.BulletText("You can enter c:[string] to filter for Changed Items instead."); + ImGui.BulletText("You can enter a:[string] to filter for Mod Authors instead."); indent.Pop(1); - ImUtf8.BulletText("Use the expandable menu beside the input to filter for mods fulfilling specific criteria."u8); + ImGui.BulletText("Use the expandable menu beside the input to filter for mods fulfilling specific criteria."); }); } @@ -510,33 +476,65 @@ public sealed class ModFileSystemSelector : FileSystemSelector _selection.SelectMod(newSelection); - #endregion #region Filters @@ -570,53 +565,81 @@ public sealed class ModFileSystemSelector : FileSystemSelector Appropriately identify and set the string filter and its type. protected override bool ChangeFilter(string filterValue) { - _filter.Parse(filterValue); + (_modFilter, _filterType) = filterValue.Length switch + { + 0 => (LowerString.Empty, -1), + > 1 when filterValue[1] == ':' => + filterValue[0] switch + { + 'n' => filterValue.Length == 2 ? (LowerString.Empty, -1) : (new LowerString(filterValue[2..]), 1), + 'N' => filterValue.Length == 2 ? (LowerString.Empty, -1) : (new LowerString(filterValue[2..]), 1), + 'a' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 2), + 'A' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 2), + 'c' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 3), + 'C' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 3), + 't' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 4), + 'T' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 4), + 's' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 5), + 'S' => filterValue.Length == 2 ? (LowerString.Empty, -1) : ParseFilter(filterValue, 5), + _ => (new LowerString(filterValue), 0), + }, + _ => (new LowerString(filterValue), 0), + }; + return true; } + private const int EmptyOffset = 128; + + private (LowerString, int) ParseFilter(string value, int id) + { + value = value[2..]; + var lower = new LowerString(value); + if (id == 5 && !ChangedItemDrawer.TryParsePartial(lower.Lower, out _slotFilter)) + _slotFilter = 0; + + return (lower, lower.Lower is "none" ? id + EmptyOffset : id); + } + + /// /// Check the state filter for a specific pair of has/has-not flags. /// Uses count == 0 to check for has-not and count != 0 for has. /// Returns true if it should be filtered and false if not. /// private bool CheckFlags(int count, ModFilter hasNoFlag, ModFilter hasFlag) - => count switch + { + return count switch { 0 when _stateFilter.HasFlag(hasNoFlag) => false, 0 => true, _ when _stateFilter.HasFlag(hasFlag) => false, _ => true, }; + } /// /// The overwritten filter method also computes the state. @@ -630,7 +653,7 @@ public sealed class ModFileSystemSelector : FileSystemSelector 0 && !f.FullName().Contains(FilterValue, IgnoreCase); } return ApplyFiltersAndState((ModFileSystem.Leaf)path, out state); @@ -638,34 +661,43 @@ public sealed class ModFileSystemSelector : FileSystemSelector Apply the string filters. private bool ApplyStringFilters(ModFileSystem.Leaf leaf, Mod mod) - => !_filter.IsVisible(leaf); + { + return _filterType switch + { + -1 => false, + 0 => !(leaf.FullName().Contains(_modFilter.Lower, IgnoreCase) || mod.Name.Contains(_modFilter)), + 1 => !mod.Name.Contains(_modFilter), + 2 => !mod.Author.Contains(_modFilter), + 3 => !mod.LowerChangedItemsString.Contains(_modFilter.Lower), + 4 => !mod.AllTagsLower.Contains(_modFilter.Lower), + 5 => mod.ChangedItems.All(p => (ChangedItemDrawer.GetCategoryIcon(p.Key, p.Value) & _slotFilter) == 0), + 2 + EmptyOffset => !mod.Author.IsEmpty, + 3 + EmptyOffset => mod.LowerChangedItemsString.Length > 0, + 4 + EmptyOffset => mod.AllTagsLower.Length > 0, + 5 + EmptyOffset => mod.ChangedItems.Count == 0, + _ => false, // Should never happen + }; + } /// Only get the text color for a mod if no filters are set. - private (ColorId Color, ColorId Tint) GetTextColor(Mod mod, ModSettings? settings, ModCollection collection) + private ColorId GetTextColor(Mod mod, ModSettings? settings, ModCollection collection) { - var tint = settings.IsTemporary() - ? ColorId.TemporaryModSettingsTint - : _modManager.IsNew(mod) - ? ColorId.NewModTint - : ColorId.NoTint; - if (settings.IsTemporary()) - tint = ColorId.TemporaryModSettingsTint; + if (_modManager.IsNew(mod)) + return ColorId.NewMod; if (settings == null) - return (ColorId.UndefinedMod, tint); + return ColorId.UndefinedMod; if (!settings.Enabled) - return (collection != _collectionManager.Active.Current - ? ColorId.InheritedDisabledMod - : ColorId.DisabledMod, tint); + return collection != _collectionManager.Active.Current ? ColorId.InheritedDisabledMod : ColorId.DisabledMod; var conflicts = _collectionManager.Active.Current.Conflicts(mod); if (conflicts.Count == 0) - return (collection != _collectionManager.Active.Current ? ColorId.InheritedMod : ColorId.EnabledMod, tint); + return collection != _collectionManager.Active.Current ? ColorId.InheritedMod : ColorId.EnabledMod; - return (conflicts.Any(c => !c.Solved) + return conflicts.Any(c => !c.Solved) ? ColorId.ConflictingMod - : ColorId.HandledConflictMod, tint); + : ColorId.HandledConflictMod; } private bool CheckStateFilters(Mod mod, ModSettings? settings, ModCollection collection, ref ModState state) @@ -684,16 +716,6 @@ public sealed class ModFileSystemSelector : FileSystemSelector TriStatePairs = - [ - (ModFilter.Enabled, ModFilter.Disabled, "Enabled"), - (ModFilter.IsNew, ModFilter.NotNew, "Newly Imported"), - (ModFilter.Favorite, ModFilter.NotFavorite, "Favorite"), - (ModFilter.HasConfig, ModFilter.HasNoConfig, "Has Options"), - (ModFilter.HasFiles, ModFilter.HasNoFiles, "Has Redirections"), - (ModFilter.HasMetaManipulations, ModFilter.HasNoMetaManipulations, "Has Meta Manipulations"), - (ModFilter.HasFileSwaps, ModFilter.HasNoFileSwaps, "Has File Swaps"), - (ModFilter.Temporary, ModFilter.NotTemporary, "Temporary"), - ]; - - public static IReadOnlyList> Groups = - [ - [ - (ModFilter.NoConflict, "Has No Conflicts"), - (ModFilter.SolvedConflict, "Has Solved Conflicts"), - (ModFilter.UnsolvedConflict, "Has Unsolved Conflicts"), - ], - [ - (ModFilter.Undefined, "Not Configured"), - (ModFilter.Inherited, "Inherited Configuration"), - (ModFilter.Uninherited, "Own Configuration"), - ], - ]; + public static string ToName(this ModFilter filter) + => filter switch + { + ModFilter.Enabled => "Enabled", + ModFilter.Disabled => "Disabled", + ModFilter.Favorite => "Favorite", + ModFilter.NotFavorite => "No Favorite", + ModFilter.NoConflict => "No Conflicts", + ModFilter.SolvedConflict => "Solved Conflicts", + ModFilter.UnsolvedConflict => "Unsolved Conflicts", + ModFilter.HasNoMetaManipulations => "No Meta Manipulations", + ModFilter.HasMetaManipulations => "Meta Manipulations", + ModFilter.HasNoFileSwaps => "No File Swaps", + ModFilter.HasFileSwaps => "File Swaps", + ModFilter.HasNoConfig => "No Configuration", + ModFilter.HasConfig => "Configuration", + ModFilter.HasNoFiles => "No Files", + ModFilter.HasFiles => "Files", + ModFilter.IsNew => "Newly Imported", + ModFilter.NotNew => "Not Newly Imported", + ModFilter.Inherited => "Inherited Configuration", + ModFilter.Uninherited => "Own Configuration", + ModFilter.Undefined => "Not Configured", + _ => throw new ArgumentOutOfRangeException(nameof(filter), filter, null), + }; } diff --git a/Penumbra/UI/ModsTab/ModPanel.cs b/Penumbra/UI/ModsTab/ModPanel.cs index b7546699..b5542e43 100644 --- a/Penumbra/UI/ModsTab/ModPanel.cs +++ b/Penumbra/UI/ModsTab/ModPanel.cs @@ -1,32 +1,30 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface.Utility.Raii; using Dalamud.Plugin; -using OtterGui.Services; +using ImGuiNET; using Penumbra.Mods; using Penumbra.Services; using Penumbra.UI.AdvancedWindow; namespace Penumbra.UI.ModsTab; -public class ModPanel : IDisposable, IUiService +public class ModPanel : IDisposable { - private readonly MultiModPanel _multiModPanel; - private readonly ModSelection _selection; - private readonly ModEditWindow _editWindow; - private readonly ModPanelHeader _header; - private readonly ModPanelTabBar _tabs; - private bool _resetCursor; + private readonly MultiModPanel _multiModPanel; + private readonly ModFileSystemSelector _selector; + private readonly ModEditWindow _editWindow; + private readonly ModPanelHeader _header; + private readonly ModPanelTabBar _tabs; + private bool _resetCursor; - public ModPanel(IDalamudPluginInterface pi, ModSelection selection, ModEditWindow editWindow, ModPanelTabBar tabs, + public ModPanel(DalamudPluginInterface pi, ModFileSystemSelector selector, ModEditWindow editWindow, ModPanelTabBar tabs, MultiModPanel multiModPanel, CommunicatorService communicator) { - _selection = selection; - _editWindow = editWindow; - _tabs = tabs; - _multiModPanel = multiModPanel; - _header = new ModPanelHeader(pi, communicator); - _selection.Subscribe(OnSelectionChange, ModSelection.Priority.ModPanel); - OnSelectionChange(null, _selection.Mod); + _selector = selector; + _editWindow = editWindow; + _tabs = tabs; + _multiModPanel = multiModPanel; + _header = new ModPanelHeader(pi, communicator); + _selector.SelectionChanged += OnSelectionChange; } public void Draw() @@ -53,17 +51,17 @@ public class ModPanel : IDisposable, IUiService public void Dispose() { - _selection.Unsubscribe(OnSelectionChange); + _selector.SelectionChanged -= OnSelectionChange; _header.Dispose(); } private bool _valid; private Mod _mod = null!; - private void OnSelectionChange(Mod? old, Mod? mod) + private void OnSelectionChange(Mod? old, Mod? mod, in ModFileSystemSelector.ModState _) { _resetCursor = true; - if (mod == null || _selection.Mod == null) + if (mod == null || _selector.Selected == null) { _editWindow.IsOpen = false; _valid = false; @@ -74,7 +72,7 @@ public class ModPanel : IDisposable, IUiService _editWindow.ChangeMod(mod); _valid = true; _mod = mod; - _header.ChangeMod(_mod); + _header.UpdateModData(_mod); _tabs.Settings.Reset(); _tabs.Edit.Reset(); } diff --git a/Penumbra/UI/ModsTab/ModPanelChangedItemsTab.cs b/Penumbra/UI/ModsTab/ModPanelChangedItemsTab.cs index 332b64f0..e897f940 100644 --- a/Penumbra/UI/ModsTab/ModPanelChangedItemsTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelChangedItemsTab.cs @@ -1,348 +1,56 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; +using ImGuiNET; using OtterGui; using OtterGui.Classes; -using OtterGui.Services; -using OtterGui.Text; +using OtterGui.Raii; using OtterGui.Widgets; -using Penumbra.GameData.Data; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Structs; -using Penumbra.Mods; -using Penumbra.Mods.Manager; -using Penumbra.String; -using Penumbra.UI.Classes; namespace Penumbra.UI.ModsTab; -public class ModPanelChangedItemsTab( - ModFileSystemSelector selector, - ChangedItemDrawer drawer, - ImGuiCacheService cacheService, - Configuration config, - ModDataEditor dataEditor) - : ITab, IUiService +public class ModPanelChangedItemsTab : ITab { - private readonly ImGuiCacheService.CacheId _cacheId = cacheService.GetNewId(); + private readonly ModFileSystemSelector _selector; + private readonly ChangedItemDrawer _drawer; - private class ChangedItemsCache - { - private Mod? _lastSelected; - private ushort _lastUpdate; - private ChangedItemIconFlag _filter = ChangedItemFlagExtensions.DefaultFlags; - private ChangedItemMode _lastMode; - private bool _reset; - public readonly List Data = []; - public bool AnyExpandable { get; private set; } - - public record struct Container - { - public IIdentifiedObjectData Data; - public ByteString Text; - public ByteString ModelData; - public uint Id; - public int Children; - public ChangedItemIconFlag Icon; - public bool Expandable; - public bool Expanded; - public bool Child; - - public static Container Single(string text, IIdentifiedObjectData data) - => new() - { - Child = false, - Text = ByteString.FromStringUnsafe(data.ToName(text), false), - ModelData = ByteString.FromStringUnsafe(data.AdditionalData, false), - Icon = data.GetIcon().ToFlag(), - Expandable = false, - Expanded = false, - Data = data, - Id = 0, - Children = 0, - }; - - public static Container Parent(string text, IIdentifiedObjectData data, uint id, int children, bool expanded) - => new() - { - Child = false, - Text = ByteString.FromStringUnsafe(data.ToName(text), false), - ModelData = ByteString.FromStringUnsafe(data.AdditionalData, false), - Icon = data.GetIcon().ToFlag(), - Expandable = true, - Expanded = expanded, - Data = data, - Id = id, - Children = children, - }; - - public static Container Indent(string text, IIdentifiedObjectData data) - => new() - { - Child = true, - Text = ByteString.FromStringUnsafe(data.ToName(text), false), - ModelData = ByteString.FromStringUnsafe(data.AdditionalData, false), - Icon = data.GetIcon().ToFlag(), - Expandable = false, - Expanded = false, - Data = data, - Id = 0, - Children = 0, - }; - } - - public void Reset() - => _reset = true; - - public void Update(Mod? mod, ChangedItemDrawer drawer, ChangedItemIconFlag filter, ChangedItemMode mode) - { - if (mod == _lastSelected - && _lastSelected!.LastChangedItemsUpdate == _lastUpdate - && _filter == filter - && !_reset - && _lastMode == mode) - return; - - _reset = false; - Data.Clear(); - AnyExpandable = false; - _lastSelected = mod; - _filter = filter; - _lastMode = mode; - if (_lastSelected == null) - return; - - _lastUpdate = _lastSelected.LastChangedItemsUpdate; - - if (mode is ChangedItemMode.Alphabetical) - { - foreach (var (s, i) in _lastSelected.ChangedItems) - { - if (drawer.FilterChangedItem(s, i, LowerString.Empty)) - Data.Add(Container.Single(s, i)); - } - - return; - } - - var tmp = new Dictionary<(PrimaryId, FullEquipType), List>(); - var defaultExpansion = _lastMode is ChangedItemMode.GroupedExpanded; - foreach (var (s, i) in _lastSelected.ChangedItems) - { - if (i is not IdentifiedItem item) - continue; - - if (!drawer.FilterChangedItem(s, item, LowerString.Empty)) - continue; - - if (tmp.TryGetValue((item.Item.PrimaryId, item.Item.Type), out var p)) - p.Add(item); - else - tmp[(item.Item.PrimaryId, item.Item.Type)] = [item]; - } - - foreach (var list in tmp.Values) - { - list.Sort((i1, i2) => - { - // reversed - var preferred = _lastSelected.PreferredChangedItems.Contains(i2.Item.Id) - .CompareTo(_lastSelected.PreferredChangedItems.Contains(i1.Item.Id)); - if (preferred != 0) - return preferred; - - // reversed - var count = i2.Count.CompareTo(i1.Count); - if (count != 0) - return count; - - return string.Compare(i1.Item.Name, i2.Item.Name, StringComparison.Ordinal); - }); - } - - var sortedTmp = tmp.Values.OrderBy(s => s[0].Item.Name).ToArray(); - - var sortedTmpIdx = 0; - foreach (var (s, i) in _lastSelected.ChangedItems) - { - if (i is IdentifiedItem) - continue; - - if (!drawer.FilterChangedItem(s, i, LowerString.Empty)) - continue; - - while (sortedTmpIdx < sortedTmp.Length - && string.Compare(sortedTmp[sortedTmpIdx][0].Item.Name, s, StringComparison.Ordinal) <= 0) - AddList(sortedTmp[sortedTmpIdx++]); - - Data.Add(Container.Single(s, i)); - } - - for (; sortedTmpIdx < sortedTmp.Length; ++sortedTmpIdx) - AddList(sortedTmp[sortedTmpIdx]); - return; - - void AddList(List list) - { - var mainItem = list[0]; - if (list.Count == 1) - { - Data.Add(Container.Single(mainItem.Item.Name, mainItem)); - } - else - { - var id = ImUtf8.GetId($"{mainItem.Item.PrimaryId}{(int)mainItem.Item.Type}"); - var expanded = ImGui.GetStateStorage().GetBool(id, defaultExpansion); - Data.Add(Container.Parent(mainItem.Item.Name, mainItem, id, list.Count - 1, expanded)); - AnyExpandable = true; - if (!expanded) - return; - - foreach (var item in list.Skip(1)) - Data.Add(Container.Indent(item.Item.Name, item)); - } - } - } - } + private ChangedItemDrawer.ChangedItemIcon _filter = Enum.GetValues().Aggregate((a, b) => a | b); public ReadOnlySpan Label => "Changed Items"u8; + public ModPanelChangedItemsTab(ModFileSystemSelector selector, ChangedItemDrawer drawer) + { + _selector = selector; + _drawer = drawer; + } + public bool IsVisible - => selector.Selected!.ChangedItems.Count > 0; - - private ImGuiStoragePtr _stateStorage; - - private Vector2 _buttonSize; - private uint _starColor; + => _selector.Selected!.ChangedItems.Count > 0; public void DrawContent() { - if (cacheService.Cache(_cacheId, () => (new ChangedItemsCache(), "ModPanelChangedItemsCache")) is not { } cache) - return; - - drawer.DrawTypeFilter(); - - _stateStorage = ImGui.GetStateStorage(); - cache.Update(selector.Selected, drawer, config.Ephemeral.ChangedItemFilter, config.ChangedItemDisplay); + _drawer.DrawTypeFilter(); ImGui.Separator(); - _buttonSize = new Vector2(ImGui.GetStyle().ItemSpacing.Y + ImGui.GetFrameHeight()); - using var style = ImRaii.PushStyle(ImGuiStyleVar.CellPadding, Vector2.Zero) - .Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero) - .Push(ImGuiStyleVar.FramePadding, Vector2.Zero) - .Push(ImGuiStyleVar.SelectableTextAlign, new Vector2(0.01f, 0.5f)); - using var color = ImRaii.PushColor(ImGuiCol.Button, 0); - - using var table = ImUtf8.Table("##changedItems"u8, cache.AnyExpandable ? 2 : 1, ImGuiTableFlags.RowBg | ImGuiTableFlags.ScrollY, + using var table = ImRaii.Table("##changedItems", 1, ImGuiTableFlags.RowBg | ImGuiTableFlags.ScrollY, new Vector2(ImGui.GetContentRegionAvail().X, -1)); if (!table) return; - _starColor = ColorId.ChangedItemPreferenceStar.Value(); - if (cache.AnyExpandable) - { - ImUtf8.TableSetupColumn("##exp"u8, ImGuiTableColumnFlags.WidthFixed, _buttonSize.Y); - ImUtf8.TableSetupColumn("##text"u8, ImGuiTableColumnFlags.WidthStretch); - ImGuiClip.ClippedDraw(cache.Data, DrawContainerExpandable, _buttonSize.Y); - } - else - { - ImGuiClip.ClippedDraw(cache.Data, DrawContainer, _buttonSize.Y); - } - } - - private void DrawContainerExpandable(ChangedItemsCache.Container obj, int idx) - { - using var id = ImUtf8.PushId(idx); + var zipList = ZipList.FromSortedList((SortedList)_selector.Selected!.ChangedItems); + var height = ImGui.GetFrameHeightWithSpacing(); ImGui.TableNextColumn(); - if (obj.Expandable) - { - if (ImUtf8.IconButton(obj.Expanded ? FontAwesomeIcon.CaretDown : FontAwesomeIcon.CaretRight, - obj.Expanded ? "Hide the other items using the same model." : - obj.Children > 1 ? $"Show {obj.Children} other items using the same model." : - "Show one other item using the same model.", - _buttonSize)) - { - _stateStorage.SetBool(obj.Id, !obj.Expanded); - if (cacheService.TryGetCache(_cacheId, out var cache)) - cache.Reset(); - } - } - else if (obj is { Child: true, Data: IdentifiedItem item }) - { - DrawPreferredButton(item, idx); - } - else - { - ImGui.Dummy(_buttonSize); - } - - DrawBaseContainer(obj, idx); + var skips = ImGuiClip.GetNecessarySkips(height); + var remainder = ImGuiClip.FilteredClippedDraw(zipList, skips, CheckFilter, DrawChangedItem); + ImGuiClip.DrawEndDummy(remainder, height); } - private void DrawContainer(ChangedItemsCache.Container obj, int idx) - { - using var id = ImUtf8.PushId(idx); - DrawBaseContainer(obj, idx); - } + private bool CheckFilter((string Name, object? Data) kvp) + => _drawer.FilterChangedItem(kvp.Name, kvp.Data, LowerString.Empty); - private void DrawPreferredButton(IdentifiedItem item, int idx) - { - if (ImUtf8.IconButton(FontAwesomeIcon.Star, "Prefer displaying this item instead of the current primary item.\n\nRight-click for more options."u8, _buttonSize, - false, _starColor)) - dataEditor.AddPreferredItem(selector.Selected!, item.Item.Id, false, true); - using var context = ImUtf8.PopupContextItem("StarContext"u8, ImGuiPopupFlags.MouseButtonRight); - if (!context) - return; - - if (cacheService.TryGetCache(_cacheId, out var cache)) - for (--idx; idx >= 0; --idx) - { - if (!cache.Data[idx].Expanded) - continue; - - if (cache.Data[idx].Data is IdentifiedItem it) - { - if (selector.Selected!.PreferredChangedItems.Contains(it.Item.Id) - && ImUtf8.MenuItem("Remove Parent from Local Preferred Items"u8)) - dataEditor.RemovePreferredItem(selector.Selected!, it.Item.Id, false); - if (selector.Selected!.DefaultPreferredItems.Contains(it.Item.Id) - && ImUtf8.MenuItem("Remove Parent from Default Preferred Items"u8)) - dataEditor.RemovePreferredItem(selector.Selected!, it.Item.Id, true); - } - - break; - } - - var enabled = !selector.Selected!.DefaultPreferredItems.Contains(item.Item.Id); - if (enabled) - { - if (ImUtf8.MenuItem("Add to Local and Default Preferred Changed Items"u8)) - dataEditor.AddPreferredItem(selector.Selected!, item.Item.Id, true, true); - } - else - { - if (ImUtf8.MenuItem("Remove from Default Preferred Changed Items"u8)) - dataEditor.RemovePreferredItem(selector.Selected!, item.Item.Id, true); - } - - if (ImUtf8.MenuItem("Reset Local Preferred Items to Default"u8)) - dataEditor.ResetPreferredItems(selector.Selected!); - - if (ImUtf8.MenuItem("Clear Local and Default Preferred Items not Changed by the Mod"u8)) - dataEditor.ClearInvalidPreferredItems(selector.Selected!); - } - - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private void DrawBaseContainer(in ChangedItemsCache.Container obj, int idx) + private void DrawChangedItem((string Name, object? Data) kvp) { ImGui.TableNextColumn(); - using var indent = ImRaii.PushIndent(1, obj.Child); - drawer.DrawCategoryIcon(obj.Icon, _buttonSize.Y); - ImGui.SameLine(0, 0); - var clicked = ImUtf8.Selectable(obj.Text.Span, false, ImGuiSelectableFlags.None, _buttonSize with { X = 0 }); - drawer.ChangedItemHandling(obj.Data, clicked); - ChangedItemDrawer.DrawModelData(obj.ModelData.Span, _buttonSize.Y); + _drawer.DrawCategoryIcon(kvp.Name, kvp.Data); + ImGui.SameLine(); + _drawer.DrawChangedItem(kvp.Name, kvp.Data); + _drawer.DrawModelData(kvp.Data); } } diff --git a/Penumbra/UI/ModsTab/ModPanelCollectionsTab.cs b/Penumbra/UI/ModsTab/ModPanelCollectionsTab.cs index 70cad148..aa598557 100644 --- a/Penumbra/UI/ModsTab/ModPanelCollectionsTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelCollectionsTab.cs @@ -1,9 +1,7 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface.Utility; -using OtterGui.Extensions; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -12,102 +10,66 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.ModsTab; -public class ModPanelCollectionsTab(CollectionManager manager, ModFileSystemSelector selector) : ITab, IUiService +public class ModPanelCollectionsTab : ITab { - private enum ModState - { - Enabled, - Disabled, - Unconfigured, - } + private readonly ModFileSystemSelector _selector; + private readonly CollectionStorage _collections; - private readonly List<(ModCollection, ModCollection, uint, ModState)> _cache = []; + private readonly List<(ModCollection, ModCollection, uint, string)> _cache = new(); + + public ModPanelCollectionsTab(CollectionStorage storage, ModFileSystemSelector selector) + { + _collections = storage; + _selector = selector; + } public ReadOnlySpan Label => "Collections"u8; public void DrawContent() { - var (direct, inherited) = CountUsage(selector.Selected!); + var (direct, inherited) = CountUsage(_selector.Selected!); ImGui.NewLine(); if (direct == 1) - ImUtf8.Text("This Mod is directly configured in 1 collection."u8); + ImGui.TextUnformatted("This Mod is directly configured in 1 collection."); else if (direct == 0) - ImUtf8.Text("This mod is entirely unused."u8, Colors.RegexWarningBorder); + ImGuiUtil.TextColored(Colors.RegexWarningBorder, "This mod is entirely unused."); else - ImUtf8.Text($"This Mod is directly configured in {direct} collections."); + ImGui.TextUnformatted($"This Mod is directly configured in {direct} collections."); if (inherited > 0) - ImUtf8.Text($"It is also implicitly used in {inherited} {(inherited == 1 ? "collection" : "collections")} through inheritance."); + ImGui.TextUnformatted( + $"It is also implicitly used in {inherited} {(inherited == 1 ? "collection" : "collections")} through inheritance."); ImGui.NewLine(); ImGui.Separator(); ImGui.NewLine(); - using var table = ImUtf8.Table("##modCollections"u8, 3, ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); + using var table = ImRaii.Table("##modCollections", 3, ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); if (!table) return; - var size = ImUtf8.CalcTextSize(ToText(ModState.Unconfigured)).X + 20 * ImGuiHelpers.GlobalScale; + var size = ImGui.CalcTextSize("Unconfigured").X + 20 * ImGuiHelpers.GlobalScale; var collectionSize = 200 * ImGuiHelpers.GlobalScale; ImGui.TableSetupColumn("Collection", ImGuiTableColumnFlags.WidthFixed, collectionSize); ImGui.TableSetupColumn("State", ImGuiTableColumnFlags.WidthFixed, size); ImGui.TableSetupColumn("Inherited From", ImGuiTableColumnFlags.WidthFixed, collectionSize); ImGui.TableHeadersRow(); - foreach (var ((collection, parent, color, state), idx) in _cache.WithIndex()) + foreach (var (collection, parent, color, text) in _cache) { - using var id = ImUtf8.PushId(idx); - ImUtf8.DrawTableColumn(collection.Identity.Name); + ImGui.TableNextColumn(); + ImGui.TextUnformatted(collection.Name); ImGui.TableNextColumn(); - ImUtf8.Text(ToText(state), color); - - using (var context = ImUtf8.PopupContextItem("Context"u8, ImGuiPopupFlags.MouseButtonRight)) + using (var c = ImRaii.PushColor(ImGuiCol.Text, color)) { - if (context) - { - ImUtf8.Text(collection.Identity.Name); - ImGui.Separator(); - using (ImRaii.Disabled(state is ModState.Enabled && parent == collection)) - { - if (ImUtf8.MenuItem("Enable"u8)) - { - if (parent != collection) - manager.Editor.SetModInheritance(collection, selector.Selected!, false); - manager.Editor.SetModState(collection, selector.Selected!, true); - } - } - - using (ImRaii.Disabled(state is ModState.Disabled && parent == collection)) - { - if (ImUtf8.MenuItem("Disable"u8)) - { - if (parent != collection) - manager.Editor.SetModInheritance(collection, selector.Selected!, false); - manager.Editor.SetModState(collection, selector.Selected!, false); - } - } - - using (ImRaii.Disabled(parent != collection)) - { - if (ImUtf8.MenuItem("Inherit"u8)) - manager.Editor.SetModInheritance(collection, selector.Selected!, true); - } - } + ImGui.TextUnformatted(text); } - ImUtf8.DrawTableColumn(parent == collection ? string.Empty : parent.Identity.Name); + ImGui.TableNextColumn(); + ImGui.TextUnformatted(parent == collection ? string.Empty : parent.Name); } } - private static ReadOnlySpan ToText(ModState state) - => state switch - { - ModState.Unconfigured => "Unconfigured"u8, - ModState.Enabled => "Enabled"u8, - ModState.Disabled => "Disabled"u8, - _ => "Unknown"u8, - }; - private (int Direct, int Inherited) CountUsage(Mod mod) { _cache.Clear(); @@ -118,14 +80,14 @@ public class ModPanelCollectionsTab(CollectionManager manager, ModFileSystemSele var disInherited = ColorId.InheritedDisabledMod.Value(); var directCount = 0; var inheritedCount = 0; - foreach (var collection in manager.Storage) + foreach (var collection in _collections) { - var (settings, parent) = collection.GetInheritedSettings(mod.Index); + var (settings, parent) = collection[mod.Index]; var (color, text) = settings == null - ? (undefined, ModState.Unconfigured) + ? (undefined, "Unconfigured") : settings.Enabled - ? (parent == collection ? enabled : inherited, ModState.Enabled) - : (parent == collection ? disabled : disInherited, ModState.Disabled); + ? (parent == collection ? enabled : inherited, "Enabled") + : (parent == collection ? disabled : disInherited, "Disabled"); _cache.Add((collection, parent, color, text)); if (color == enabled) diff --git a/Penumbra/UI/ModsTab/ModPanelConflictsTab.cs b/Penumbra/UI/ModsTab/ModPanelConflictsTab.cs index 1002d8ca..5e3aac48 100644 --- a/Penumbra/UI/ModsTab/ModPanelConflictsTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelConflictsTab.cs @@ -1,11 +1,8 @@ using Dalamud.Interface; using Dalamud.Interface.Utility; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Collections.Cache; using Penumbra.Collections.Manager; @@ -18,7 +15,7 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.ModsTab; -public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSystemSelector selector) : ITab, IUiService +public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSystemSelector selector) : ITab { private int? _currentPriority; @@ -26,7 +23,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy => "Conflicts"u8; public bool IsVisible - => collectionManager.Active.Current.Conflicts(selector.Selected!).Any(c => !GetPriority(c).IsHidden); + => collectionManager.Active.Current.Conflicts(selector.Selected!).Count > 0; private readonly ConditionalWeakTable _expandedMods = []; @@ -35,7 +32,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy if (conflicts.Mod2.Index < 0) return conflicts.Mod2.Priority; - return collectionManager.Active.Current.GetActualSettings(conflicts.Mod2.Index).Settings?.Priority ?? ModPriority.Default; + return collectionManager.Active.Current[conflicts.Mod2.Index].Settings?.Priority ?? ModPriority.Default; } public void DrawContent() @@ -59,8 +56,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy // Can not be null because otherwise the tab bar is never drawn. var mod = selector.Selected!; - foreach (var (conflict, index) in collectionManager.Active.Current.Conflicts(mod).Where(c => !c.Mod2.Priority.IsHidden) - .OrderByDescending(GetPriority) + foreach (var (conflict, index) in collectionManager.Active.Current.Conflicts(mod).OrderByDescending(GetPriority) .ThenBy(c => c.Mod2.Name.Lower).WithIndex()) { using var id = ImRaii.PushId(index); @@ -73,29 +69,24 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy ImGui.TableNextColumn(); using var c = ImRaii.PushColor(ImGuiCol.Text, ColorId.FolderLine.Value()); ImGui.AlignTextToFramePadding(); - ImGui.TextUnformatted(selector.Selected!.Name.Text); + ImGui.TextUnformatted(selector.Selected!.Name); ImGui.TableNextColumn(); - var actualSettings = collectionManager.Active.Current.GetActualSettings(selector.Selected!.Index).Settings!; - var priority = actualSettings.Priority.Value; - // TODO - using (ImRaii.Disabled(actualSettings is TemporaryModSettings)) + var priority = collectionManager.Active.Current[selector.Selected!.Index].Settings!.Priority.Value; + ImGui.SetNextItemWidth(priorityWidth); + if (ImGui.InputInt("##priority", ref priority, 0, 0, ImGuiInputTextFlags.EnterReturnsTrue)) + _currentPriority = priority; + + if (ImGui.IsItemDeactivatedAfterEdit() && _currentPriority.HasValue) { - ImGui.SetNextItemWidth(priorityWidth); - if (ImGui.InputInt("##priority", ref priority, 0, 0, flags: ImGuiInputTextFlags.EnterReturnsTrue)) - _currentPriority = priority; + if (_currentPriority != collectionManager.Active.Current[selector.Selected!.Index].Settings!.Priority.Value) + collectionManager.Editor.SetModPriority(collectionManager.Active.Current, selector.Selected!, + new ModPriority(_currentPriority.Value)); - if (ImGui.IsItemDeactivatedAfterEdit() && _currentPriority.HasValue) - { - if (_currentPriority != actualSettings.Priority.Value) - collectionManager.Editor.SetModPriority(collectionManager.Active.Current, selector.Selected!, - new ModPriority(_currentPriority.Value)); - - _currentPriority = null; - } - else if (ImGui.IsItemDeactivated()) - { - _currentPriority = null; - } + _currentPriority = null; + } + else if (ImGui.IsItemDeactivated()) + { + _currentPriority = null; } ImGui.TableNextColumn(); @@ -104,7 +95,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy private void DrawConflictSelectable(ModConflicts conflict) { ImGui.AlignTextToFramePadding(); - if (ImGui.Selectable(conflict.Mod2.Name.Text) && conflict.Mod2 is Mod otherMod) + if (ImGui.Selectable(conflict.Mod2.Name) && conflict.Mod2 is Mod otherMod) selector.SelectByValue(otherMod); var hovered = ImGui.IsItemHovered(); var rightClicked = ImGui.IsItemClicked(ImGuiMouseButton.Right); @@ -125,12 +116,15 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy using var indent = ImRaii.PushIndent(30f); foreach (var data in conflict.Conflicts) { - _ = data switch + unsafe { - Utf8GamePath p => ImUtf8.Selectable(p.Path.Span, false), - IMetaIdentifier m => ImUtf8.Selectable(m.ToString(), false), - _ => false, - }; + var _ = data switch + { + Utf8GamePath p => ImGuiNative.igSelectable_Bool(p.Path.Path, 0, ImGuiSelectableFlags.None, Vector2.Zero) > 0, + MetaManipulation m => ImGui.Selectable(m.Manipulation?.ToString() ?? string.Empty), + _ => false, + }; + } } return true; @@ -144,7 +138,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy ImGui.TableNextColumn(); var conflictPriority = DrawPriorityInput(conflict, priorityWidth); ImGui.SameLine(); - var selectedPriority = collectionManager.Active.Current.GetActualSettings(selector.Selected!.Index).Settings!.Priority.Value; + var selectedPriority = collectionManager.Active.Current[selector.Selected!.Index].Settings!.Priority.Value; DrawPriorityButtons(conflict.Mod2 as Mod, conflictPriority, selectedPriority, buttonSize); ImGui.TableNextColumn(); DrawExpandButton(conflict.Mod2, expanded, buttonSize); @@ -172,7 +166,7 @@ public class ModPanelConflictsTab(CollectionManager collectionManager, ModFileSy var priority = _currentPriority ?? GetPriority(conflict).Value; ImGui.SetNextItemWidth(priorityWidth); - if (ImGui.InputInt("##priority", ref priority, 0, 0, flags: ImGuiInputTextFlags.EnterReturnsTrue)) + if (ImGui.InputInt("##priority", ref priority, 0, 0, ImGuiInputTextFlags.EnterReturnsTrue)) _currentPriority = priority; if (ImGui.IsItemDeactivatedAfterEdit() && _currentPriority.HasValue) diff --git a/Penumbra/UI/ModsTab/ModPanelDescriptionTab.cs b/Penumbra/UI/ModsTab/ModPanelDescriptionTab.cs index b8710707..ed6340ab 100644 --- a/Penumbra/UI/ModsTab/ModPanelDescriptionTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelDescriptionTab.cs @@ -1,8 +1,7 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface.Utility; +using ImGuiNET; using OtterGui.Raii; using OtterGui; -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Mods.Manager; @@ -13,7 +12,7 @@ public class ModPanelDescriptionTab( TutorialService tutorial, ModManager modManager, PredefinedTagManager predefinedTagsConfig) - : ITab, IUiService + : ITab { private readonly TagButtons _localTags = new(); private readonly TagButtons _modTags = new(); @@ -30,7 +29,7 @@ public class ModPanelDescriptionTab( ImGui.Dummy(ImGuiHelpers.ScaledVector2(2)); ImGui.Dummy(ImGuiHelpers.ScaledVector2(2)); - var (predefinedTagsEnabled, predefinedTagButtonOffset) = predefinedTagsConfig.Enabled + var (predefinedTagsEnabled, predefinedTagButtonOffset) = predefinedTagsConfig.Count > 0 ? (true, ImGui.GetFrameHeight() + ImGui.GetStyle().WindowPadding.X + (ImGui.GetScrollMaxY() > 0 ? ImGui.GetStyle().ScrollbarSize : 0)) : (false, 0); var tagIdx = _localTags.Draw("Local Tags: ", diff --git a/Penumbra/UI/ModsTab/ModPanelEditTab.cs b/Penumbra/UI/ModsTab/ModPanelEditTab.cs index c3737b40..468e97b9 100644 --- a/Penumbra/UI/ModsTab/ModPanelEditTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelEditTab.cs @@ -1,18 +1,18 @@ using Dalamud.Interface; using Dalamud.Interface.Components; -using Dalamud.Interface.ImGuiNotification; -using Dalamud.Bindings.ImGui; +using Dalamud.Interface.Internal.Notifications; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Widgets; using OtterGui.Classes; -using OtterGui.Services; -using OtterGui.Text; using Penumbra.Mods; using Penumbra.Mods.Editor; using Penumbra.Mods.Manager; using Penumbra.Services; +using Penumbra.UI.AdvancedWindow; using Penumbra.Mods.Settings; +using Penumbra.Mods.Manager.OptionEditor; using Penumbra.UI.ModsTab.Groups; namespace Penumbra.UI.ModsTab; @@ -22,6 +22,8 @@ public class ModPanelEditTab( ModFileSystemSelector selector, ModFileSystem fileSystem, Services.MessageService messager, + ModEditWindow editWindow, + ModEditor editor, FilenameService filenames, ModExportManager modExportManager, Configuration config, @@ -29,7 +31,7 @@ public class ModPanelEditTab( ModGroupEditDrawer groupEditDrawer, DescriptionEditPopup descriptionPopup, AddGroupDrawer addGroupDrawer) - : ITab, IUiService + : ITab { private readonly TagButtons _modTags = new(); @@ -51,8 +53,6 @@ public class ModPanelEditTab( EditButtons(); EditRegularMeta(); UiHelpers.DefaultLineSpace(); - EditLocalData(); - UiHelpers.DefaultLineSpace(); if (Input.Text("Mod Path", Input.Path, Input.None, _leaf.FullName(), out var newPath, 256, UiHelpers.InputTextWidth.X)) try @@ -65,11 +65,7 @@ public class ModPanelEditTab( } UiHelpers.DefaultLineSpace(); - - FeatureChecker.DrawFeatureFlagInput(modManager.DataEditor, _mod, UiHelpers.InputTextWidth.X); - - UiHelpers.DefaultLineSpace(); - var sharedTagsEnabled = predefinedTagManager.Enabled; + var sharedTagsEnabled = predefinedTagManager.Count > 0; var sharedTagButtonOffset = sharedTagsEnabled ? ImGui.GetFrameHeight() + ImGui.GetStyle().FramePadding.X : 0; var tagIdx = _modTags.Draw("Mod Tags: ", "Edit tags by clicking them, or add new tags. Empty tags are removed.", _mod.ModTags, out var editedTag, rightEndOffset: sharedTagButtonOffset); @@ -80,7 +76,6 @@ public class ModPanelEditTab( predefinedTagManager.DrawAddFromSharedTagsAndUpdateTags(selector.Selected!.LocalTags, selector.Selected!.ModTags, false, selector.Selected!); - UiHelpers.DefaultLineSpace(); addGroupDrawer.Draw(_mod, UiHelpers.InputTextWidth.X); UiHelpers.DefaultLineSpace(); @@ -116,6 +111,27 @@ public class ModPanelEditTab( MoveDirectory.Draw(modManager, _mod, buttonSize); UiHelpers.DefaultLineSpace(); + DrawUpdateBibo(buttonSize); + + UiHelpers.DefaultLineSpace(); + } + + private void DrawUpdateBibo(Vector2 buttonSize) + { + if (ImGui.Button("Update Bibo Material", buttonSize)) + { + editor.LoadMod(_mod); + editor.MdlMaterialEditor.ReplaceAllMaterials("bibo", "b"); + editor.MdlMaterialEditor.ReplaceAllMaterials("bibopube", "c"); + editor.MdlMaterialEditor.SaveAllModels(editor.Compactor); + editWindow.UpdateModels(); + } + + ImGuiUtil.HoverTooltip( + "For every model in this mod, change all material names that end in a _b or _c suffix to a _bibo or _bibopube suffix respectively.\n" + + "Does nothing if the mod does not contain any such models or no model contains such materials.\n" + + "Use this for outdated mods made for old Bibo bodies.\n" + + "Go to Advanced Editing for more fine-tuned control over material assignment."); } private void BackupButtons(Vector2 buttonSize) @@ -126,42 +142,32 @@ public class ModPanelEditTab( : backup.Exists ? $"Overwrite current exported mod \"{backup.Name}\" with current mod." : $"Create exported archive of current mod at \"{backup.Name}\"."; - if (ImUtf8.ButtonEx("Export Mod"u8, tt, buttonSize, ModBackup.CreatingBackup)) + if (ImGuiUtil.DrawDisabledButton("Export Mod", buttonSize, tt, ModBackup.CreatingBackup)) backup.CreateAsync(); - if (ImGui.IsItemClicked(ImGuiMouseButton.Right)) - ImUtf8.OpenPopup("context"u8); - ImGui.SameLine(); tt = backup.Exists ? $"Delete existing mod export \"{backup.Name}\" (hold {config.DeleteModModifier} while clicking)." : $"Exported mod \"{backup.Name}\" does not exist."; - if (ImUtf8.ButtonEx("Delete Export"u8, tt, buttonSize, !backup.Exists || !config.DeleteModModifier.IsActive())) + if (ImGuiUtil.DrawDisabledButton("Delete Export", buttonSize, tt, !backup.Exists || !config.DeleteModModifier.IsActive())) backup.Delete(); tt = backup.Exists ? $"Restore mod from exported file \"{backup.Name}\" (hold {config.DeleteModModifier} while clicking)." : $"Exported mod \"{backup.Name}\" does not exist."; ImGui.SameLine(); - if (ImUtf8.ButtonEx("Restore From Export"u8, tt, buttonSize, !backup.Exists || !config.DeleteModModifier.IsActive())) + if (ImGuiUtil.DrawDisabledButton("Restore From Export", buttonSize, tt, !backup.Exists || !config.DeleteModModifier.IsActive())) backup.Restore(modManager); if (backup.Exists) { ImGui.SameLine(); - using (ImRaii.PushFont(UiBuilder.IconFont)) + using (var font = ImRaii.PushFont(UiBuilder.IconFont)) { - ImUtf8.Text(FontAwesomeIcon.CheckCircle.ToIconString()); + ImGui.TextUnformatted(FontAwesomeIcon.CheckCircle.ToIconString()); } - ImUtf8.HoverTooltip($"Export exists in \"{backup.Name}\"."); + ImGuiUtil.HoverTooltip($"Export exists in \"{backup.Name}\"."); } - - using var context = ImUtf8.Popup("context"u8); - if (!context) - return; - - if (ImUtf8.Selectable("Open Backup Directory"u8)) - Process.Start(new ProcessStartInfo(modExportManager.ExportDirectory.FullName) { UseShellExecute = true }); } /// Anything about editing the regular meta information about the mod. @@ -200,40 +206,6 @@ public class ModPanelEditTab( DrawOpenDefaultMod(); } - private void EditLocalData() - { - DrawImportDate(); - DrawOpenLocalData(); - } - - private void DrawImportDate() - { - ImUtf8.TextFramed($"{DateTimeOffset.FromUnixTimeMilliseconds(_mod.ImportDate).ToLocalTime():yyyy/MM/dd HH:mm}", - ImGui.GetColorU32(ImGuiCol.FrameBg, 0.5f), new Vector2(UiHelpers.InputTextMinusButton3, 0)); - ImGui.SameLine(0, 3 * ImUtf8.GlobalScale); - - var canRefresh = config.DeleteModModifier.IsActive(); - var tt = canRefresh - ? "Reset the import date to the current date and time." - : $"Reset the import date to the current date and time.\nHold {config.DeleteModModifier} while clicking to refresh."; - - if (ImUtf8.IconButton(FontAwesomeIcon.Sync, tt, disabled: !canRefresh)) - modManager.DataEditor.ResetModImportDate(_mod); - ImUtf8.SameLineInner(); - ImUtf8.Text("Import Date"u8); - } - - private void DrawOpenLocalData() - { - var file = filenames.LocalDataFile(_mod); - var fileExists = File.Exists(file); - var tt = fileExists - ? "Open the local mod data file in the text editor of your choice."u8 - : "The local mod data file does not exist."u8; - if (ImUtf8.ButtonEx("Open Local Data"u8, tt, UiHelpers.InputTextWidth, !fileExists)) - Process.Start(new ProcessStartInfo(file) { UseShellExecute = true }); - } - private void DrawOpenDefaultMod() { var file = filenames.OptionGroupFile(_mod, -1, false); @@ -325,7 +297,7 @@ public class ModPanelEditTab( var tmp = field == _currentField && option == _optionIndex ? _currentEdit ?? oldValue : oldValue; ImGui.SetNextItemWidth(width); - if (ImGui.InputText(label, ref tmp)) + if (ImGui.InputText(label, ref tmp, maxLength)) { _currentEdit = tmp; _optionIndex = option; diff --git a/Penumbra/UI/ModsTab/ModPanelHeader.cs b/Penumbra/UI/ModsTab/ModPanelHeader.cs index b42ac680..a8b393b1 100644 --- a/Penumbra/UI/ModsTab/ModPanelHeader.cs +++ b/Penumbra/UI/ModsTab/ModPanelHeader.cs @@ -1,7 +1,7 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface.GameFonts; using Dalamud.Interface.ManagedFontAtlas; using Dalamud.Plugin; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using Penumbra.Communication; @@ -18,10 +18,9 @@ public class ModPanelHeader : IDisposable private readonly IFontHandle _nameFont; private readonly CommunicatorService _communicator; - private float _lastPreSettingsHeight; - private bool _dirty = true; + private float _lastPreSettingsHeight = 0; - public ModPanelHeader(IDalamudPluginInterface pi, CommunicatorService communicator) + public ModPanelHeader(DalamudPluginInterface pi, CommunicatorService communicator) { _communicator = communicator; _nameFont = pi.UiBuilder.FontAtlas.NewGameFontHandle(new GameFontStyle(GameFontFamilyAndSize.Jupiter23)); @@ -34,7 +33,6 @@ public class ModPanelHeader : IDisposable /// public void Draw() { - UpdateModData(); var height = ImGui.GetContentRegionAvail().Y; var maxHeight = 3 * height / 4; using var child = _lastPreSettingsHeight > maxHeight && _communicator.PreSettingsTabBarDraw.HasSubscribers @@ -51,25 +49,16 @@ public class ModPanelHeader : IDisposable _lastPreSettingsHeight = ImGui.GetCursorPosY(); } - public void ChangeMod(Mod mod) - { - _mod = mod; - _dirty = true; - } - /// /// Update all mod header data. Should someone change frame padding or item spacing, /// or his default font, this will break, but he will just have to select a different mod to restore. /// - private void UpdateModData() + public void UpdateModData(Mod mod) { - if (!_dirty) - return; - - _dirty = false; _lastPreSettingsHeight = 0; + _mod = mod; // Name - var name = $" {_mod.Name} "; + var name = $" {mod.Name} "; if (name != _modName) { using var f = _nameFont.Push(); @@ -78,16 +67,16 @@ public class ModPanelHeader : IDisposable } // Author - if (_mod.Author != _modAuthor) + if (mod.Author != _modAuthor) { - var author = _mod.Author.IsEmpty ? string.Empty : $"by {_mod.Author}"; - _modAuthor = _mod.Author.Text; + var author = mod.Author.IsEmpty ? string.Empty : $"by {mod.Author}"; + _modAuthor = mod.Author.Text; _modAuthorWidth = ImGui.CalcTextSize(author).X; _secondRowWidth = _modAuthorWidth + _modWebsiteButtonWidth + ImGui.GetStyle().ItemSpacing.X; } // Version - var version = _mod.Version.Length > 0 ? $"({_mod.Version})" : string.Empty; + var version = mod.Version.Length > 0 ? $"({mod.Version})" : string.Empty; if (version != _modVersion) { _modVersion = version; @@ -95,9 +84,9 @@ public class ModPanelHeader : IDisposable } // Website - if (_modWebsite != _mod.Website) + if (_modWebsite != mod.Website) { - _modWebsite = _mod.Website; + _modWebsite = mod.Website; _websiteValid = Uri.TryCreate(_modWebsite, UriKind.Absolute, out var uriResult) && (uriResult.Scheme == Uri.UriSchemeHttps || uriResult.Scheme == Uri.UriSchemeHttp); _modWebsiteButton = _websiteValid ? "Open Website" : _modWebsite.Length == 0 ? string.Empty : $"from {_modWebsite}"; @@ -264,6 +253,7 @@ public class ModPanelHeader : IDisposable { const ModDataChangeType relevantChanges = ModDataChangeType.Author | ModDataChangeType.Name | ModDataChangeType.Website | ModDataChangeType.Version; - _dirty = (changeType & relevantChanges) != 0; + if ((changeType & relevantChanges) != 0) + UpdateModData(mod); } } diff --git a/Penumbra/UI/ModsTab/ModPanelSettingsTab.cs b/Penumbra/UI/ModsTab/ModPanelSettingsTab.cs index 84f69bcb..7e3b8a95 100644 --- a/Penumbra/UI/ModsTab/ModPanelSettingsTab.cs +++ b/Penumbra/UI/ModsTab/ModPanelSettingsTab.cs @@ -1,33 +1,31 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui.Raii; +using OtterGui; using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; +using Penumbra.Collections; using Penumbra.UI.Classes; using Penumbra.Collections.Manager; -using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Services; using Penumbra.Mods.Settings; using Penumbra.UI.ModsTab.Groups; -using OtterGui.Extensions; namespace Penumbra.UI.ModsTab; public class ModPanelSettingsTab( CollectionManager collectionManager, ModManager modManager, - ModSelection selection, + ModFileSystemSelector selector, TutorialService tutorial, CommunicatorService communicator, - ModGroupDrawer modGroupDrawer, - Configuration config) + ModGroupDrawer modGroupDrawer) : ITab, IUiService { - private bool _inherited; - private bool _temporary; - private bool _locked; - private int? _currentPriority; + private bool _inherited; + private ModSettings _settings = null!; + private ModCollection _collection = null!; + private int? _currentPriority; public ReadOnlySpan Label => "Settings"u8; @@ -40,20 +38,16 @@ public class ModPanelSettingsTab( public void DrawContent() { - using var table = ImUtf8.Table("##settings"u8, 1, ImGuiTableFlags.ScrollY, ImGui.GetContentRegionAvail()); - if (!table) + using var child = ImRaii.Child("##settings"); + if (!child) return; - _inherited = selection.Collection != collectionManager.Active.Current; - _temporary = selection.TemporarySettings != null; - _locked = (selection.TemporarySettings?.Lock ?? 0) > 0; - - ImGui.TableSetupScrollFreeze(0, 1); - ImGui.TableNextColumn(); - DrawTemporaryWarning(); + _settings = selector.SelectedSettings; + _collection = selector.SelectedSettingCollection; + _inherited = _collection != collectionManager.Active.Current; DrawInheritedWarning(); - ImGui.Dummy(Vector2.Zero); - communicator.PreSettingsPanelDraw.Invoke(selection.Mod!.Identifier); + UiHelpers.DefaultLineSpace(); + communicator.PreSettingsPanelDraw.Invoke(selector.Selected!.Identifier); DrawEnabledInput(); tutorial.OpenTutorial(BasicTutorialSteps.EnablingMods); ImGui.SameLine(); @@ -61,29 +55,11 @@ public class ModPanelSettingsTab( tutorial.OpenTutorial(BasicTutorialSteps.Priority); DrawRemoveSettings(); - ImGui.TableNextColumn(); - communicator.PostEnabledDraw.Invoke(selection.Mod!.Identifier); + communicator.PostEnabledDraw.Invoke(selector.Selected!.Identifier); - modGroupDrawer.Draw(selection.Mod!, selection.Settings, selection.TemporarySettings); + modGroupDrawer.Draw(selector.Selected!, _settings); UiHelpers.DefaultLineSpace(); - communicator.PostSettingsPanelDraw.Invoke(selection.Mod!.Identifier); - } - - /// Draw a big tinted bar if the current setting is temporary. - private void DrawTemporaryWarning() - { - if (!_temporary) - return; - - using var color = ImRaii.PushColor(ImGuiCol.Button, ImGuiCol.Button.Tinted(ColorId.TemporaryModSettingsTint)); - var width = new Vector2(ImGui.GetContentRegionAvail().X, 0); - if (ImUtf8.ButtonEx($"These settings are temporarily set by {selection.TemporarySettings!.Source}{(_locked ? " and locked." : ".")}", - width, - _locked)) - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, null); - - ImUtf8.HoverTooltip("Changing settings in temporary settings will not save them across sessions.\n"u8 - + "You can click this button to remove the temporary settings and return to your normal settings."u8); + communicator.PostSettingsPanelDraw.Invoke(selector.Selected!.Identifier); } /// Draw a big red bar if the current setting is inherited. @@ -94,43 +70,22 @@ public class ModPanelSettingsTab( using var color = ImRaii.PushColor(ImGuiCol.Button, Colors.PressEnterWarningBg); var width = new Vector2(ImGui.GetContentRegionAvail().X, 0); - if (ImUtf8.ButtonEx($"These settings are inherited from {selection.Collection.Identity.Name}.", width, _locked)) - { - if (_temporary) - { - selection.TemporarySettings!.ForceInherit = false; - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, selection.TemporarySettings); - } - else - { - collectionManager.Editor.SetModInheritance(collectionManager.Active.Current, selection.Mod!, false); - } - } + if (ImGui.Button($"These settings are inherited from {_collection.Name}.", width)) + collectionManager.Editor.SetModInheritance(collectionManager.Active.Current, selector.Selected!, false); - ImUtf8.HoverTooltip("You can click this button to copy the current settings to the current selection.\n"u8 - + "You can also just change any setting, which will copy the settings with the single setting changed to the current selection."u8); + ImGuiUtil.HoverTooltip("You can click this button to copy the current settings to the current selection.\n" + + "You can also just change any setting, which will copy the settings with the single setting changed to the current selection."); } /// Draw a checkbox for the enabled status of the mod. private void DrawEnabledInput() { - var enabled = selection.Settings.Enabled; - using var disabled = ImRaii.Disabled(_locked); - if (!ImUtf8.Checkbox("Enabled"u8, ref enabled)) + var enabled = _settings.Enabled; + if (!ImGui.Checkbox("Enabled", ref enabled)) return; - modManager.SetKnown(selection.Mod!); - if (_temporary || config.DefaultTemporaryMode) - { - var temporarySettings = selection.TemporarySettings ?? new TemporaryModSettings(selection.Mod!, selection.Settings); - temporarySettings.ForceInherit = false; - temporarySettings.Enabled = enabled; - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, temporarySettings); - } - else - { - collectionManager.Editor.SetModState(collectionManager.Active.Current, selection.Mod!, enabled); - } + modManager.SetKnown(selector.Selected!); + collectionManager.Editor.SetModState(collectionManager.Active.Current, selector.Selected!, enabled); } /// @@ -139,123 +94,41 @@ public class ModPanelSettingsTab( /// private void DrawPriorityInput() { - using var group = ImUtf8.Group(); - var settings = selection.Settings; - var priority = _currentPriority ?? settings.Priority.Value; + using var group = ImRaii.Group(); + var priority = _currentPriority ?? _settings.Priority.Value; ImGui.SetNextItemWidth(50 * UiHelpers.Scale); - using var disabled = ImRaii.Disabled(_locked); - if (ImUtf8.InputScalar("##Priority"u8, ref priority)) + if (ImGui.InputInt("##Priority", ref priority, 0, 0)) _currentPriority = priority; - if (new ModPriority(priority).IsHidden) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, - $"This priority is special-cased to hide this mod in conflict tabs ({ModPriority.HiddenMin}, {ModPriority.HiddenMax})."); - if (ImGui.IsItemDeactivatedAfterEdit() && _currentPriority.HasValue) { - if (_currentPriority != settings.Priority.Value) - { - if (_temporary || config.DefaultTemporaryMode) - { - var temporarySettings = selection.TemporarySettings ?? new TemporaryModSettings(selection.Mod!, selection.Settings); - temporarySettings.ForceInherit = false; - temporarySettings.Priority = new ModPriority(_currentPriority.Value); - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, - temporarySettings); - } - else - { - collectionManager.Editor.SetModPriority(collectionManager.Active.Current, selection.Mod!, - new ModPriority(_currentPriority.Value)); - } - } + if (_currentPriority != _settings.Priority.Value) + collectionManager.Editor.SetModPriority(collectionManager.Active.Current, selector.Selected!, + new ModPriority(_currentPriority.Value)); _currentPriority = null; } - ImUtf8.LabeledHelpMarker("Priority"u8, "Mods with a higher number here take precedence before Mods with a lower number.\n"u8 - + "That means, if Mod A should overwrite changes from Mod B, Mod A should have a higher priority number than Mod B."u8); + ImGuiUtil.LabeledHelpMarker("Priority", "Mods with a higher number here take precedence before Mods with a lower number.\n" + + "That means, if Mod A should overwrite changes from Mod B, Mod A should have a higher priority number than Mod B."); } /// /// Draw a button to remove the current settings and inherit them instead - /// in the top-right corner of the window/tab. + /// on the top-right corner of the window/tab. /// private void DrawRemoveSettings() { - var drawInherited = !_inherited && !selection.Settings.IsEmpty; - var scroll = ImGui.GetScrollMaxY() > 0 ? ImGui.GetStyle().ScrollbarSize + ImGui.GetStyle().ItemInnerSpacing.X : 0; - var buttonSize = ImUtf8.CalcTextSize("Turn Permanent_"u8).X; - var offset = drawInherited - ? buttonSize + ImUtf8.CalcTextSize("Inherit Settings"u8).X + ImGui.GetStyle().FramePadding.X * 4 + ImGui.GetStyle().ItemSpacing.X - : buttonSize + ImGui.GetStyle().FramePadding.X * 2; - ImGui.SameLine(ImGui.GetWindowWidth() - offset - scroll); - var enabled = config.DeleteModModifier.IsActive(); - if (drawInherited) - { - var inherit = (enabled, _locked) switch - { - (true, false) => ImUtf8.ButtonEx("Inherit Settings"u8, - "Remove current settings from this collection so that it can inherit them.\n"u8 - + "If no inherited collection has settings for this mod, it will be disabled."u8, default, false), - (false, false) => ImUtf8.ButtonEx("Inherit Settings"u8, - $"Remove current settings from this collection so that it can inherit them.\nHold {config.DeleteModModifier} to inherit.", - default, true), - (_, true) => ImUtf8.ButtonEx("Inherit Settings"u8, - "Remove current settings from this collection so that it can inherit them.\nThe settings are currently locked and can not be changed."u8, - default, true), - }; - if (inherit) - { - if (_temporary || config.DefaultTemporaryMode) - { - var temporarySettings = selection.TemporarySettings ?? new TemporaryModSettings(selection.Mod!, selection.Settings); - temporarySettings.ForceInherit = true; - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, - temporarySettings); - } - else - { - collectionManager.Editor.SetModInheritance(collectionManager.Active.Current, selection.Mod!, true); - } - } + const string text = "Inherit Settings"; + if (_inherited || _settings == ModSettings.Empty) + return; - ImGui.SameLine(); - } + var scroll = ImGui.GetScrollMaxY() > 0 ? ImGui.GetStyle().ScrollbarSize : 0; + ImGui.SameLine(ImGui.GetWindowWidth() - ImGui.CalcTextSize(text).X - ImGui.GetStyle().FramePadding.X * 2 - scroll); + if (ImGui.Button(text)) + collectionManager.Editor.SetModInheritance(collectionManager.Active.Current, selector.Selected!, true); - if (_temporary) - { - var overwrite = enabled - ? ImUtf8.ButtonEx("Turn Permanent"u8, - "Overwrite the actual settings for this mod in this collection with the current temporary settings."u8, - new Vector2(buttonSize, 0)) - : ImUtf8.ButtonEx("Turn Permanent"u8, - $"Overwrite the actual settings for this mod in this collection with the current temporary settings.\nHold {config.DeleteModModifier} to overwrite.", - new Vector2(buttonSize, 0), true); - if (overwrite) - { - var settings = collectionManager.Active.Current.GetTempSettings(selection.Mod!.Index)!; - if (settings.ForceInherit) - { - collectionManager.Editor.SetModInheritance(collectionManager.Active.Current, selection.Mod, true); - } - else - { - collectionManager.Editor.SetModState(collectionManager.Active.Current, selection.Mod, settings.Enabled); - collectionManager.Editor.SetModPriority(collectionManager.Active.Current, selection.Mod, settings.Priority); - foreach (var (setting, index) in settings.Settings.WithIndex()) - collectionManager.Editor.SetModSetting(collectionManager.Active.Current, selection.Mod, index, setting); - } - - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod, null); - } - } - else - { - var actual = collectionManager.Active.Current.GetActualSettings(selection.Mod!.Index).Settings; - if (ImUtf8.ButtonEx("Turn Temporary"u8, "Copy the current settings over to temporary settings to experiment with them."u8)) - collectionManager.Editor.SetTemporarySettings(collectionManager.Active.Current, selection.Mod!, - new TemporaryModSettings(selection.Mod!, actual)); - } + ImGuiUtil.HoverTooltip("Remove current settings from this collection so that it can inherit them.\n" + + "If no inherited collection has settings for this mod, it will be disabled."); } } diff --git a/Penumbra/UI/ModsTab/ModPanelTabBar.cs b/Penumbra/UI/ModsTab/ModPanelTabBar.cs index 5981d979..8b09d8b9 100644 --- a/Penumbra/UI/ModsTab/ModPanelTabBar.cs +++ b/Penumbra/UI/ModsTab/ModPanelTabBar.cs @@ -1,8 +1,7 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; +using ImGuiNET; using OtterGui; using OtterGui.Raii; -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Mods; using Penumbra.Mods.Manager; @@ -10,7 +9,7 @@ using Penumbra.UI.AdvancedWindow; namespace Penumbra.UI.ModsTab; -public class ModPanelTabBar : IUiService +public class ModPanelTabBar { private enum ModPanelTabType { @@ -34,7 +33,7 @@ public class ModPanelTabBar : IUiService public readonly ITab[] Tabs; private ModPanelTabType _preferredTab = ModPanelTabType.Settings; - private Mod? _lastMod; + private Mod? _lastMod = null; public ModPanelTabBar(ModEditWindow modEditWindow, ModPanelSettingsTab settings, ModPanelDescriptionTab description, ModPanelConflictsTab conflicts, ModPanelChangedItemsTab changedItems, ModPanelEditTab edit, ModManager modManager, @@ -50,15 +49,15 @@ public class ModPanelTabBar : IUiService _tutorial = tutorial; Collections = collections; - Tabs = - [ + Tabs = new ITab[] + { Settings, Description, Conflicts, ChangedItems, Collections, Edit, - ]; + }; } public void Draw(Mod mod) diff --git a/Penumbra/UI/ModsTab/ModSearchStringSplitter.cs b/Penumbra/UI/ModsTab/ModSearchStringSplitter.cs deleted file mode 100644 index 1eff1919..00000000 --- a/Penumbra/UI/ModsTab/ModSearchStringSplitter.cs +++ /dev/null @@ -1,138 +0,0 @@ -using OtterGui.Filesystem; -using OtterGui.Filesystem.Selector; -using Penumbra.Mods; -using Penumbra.Mods.Manager; - -namespace Penumbra.UI.ModsTab; - -public enum ModSearchType : byte -{ - Default = 0, - ChangedItem, - Tag, - Name, - Author, - Category, -} - -public sealed class ModSearchStringSplitter : SearchStringSplitter.Leaf, ModSearchStringSplitter.Entry> -{ - public readonly struct Entry : ISplitterEntry - { - public string Needle { get; init; } - public ModSearchType Type { get; init; } - public ChangedItemIconFlag IconFlagFilter { get; init; } - - public bool Contains(Entry other) - { - if (Type != other.Type) - return false; - if (Type is ModSearchType.Category) - return IconFlagFilter == other.IconFlagFilter; - - return Needle.Contains(other.Needle); - } - } - - protected override bool ConvertToken(char token, out ModSearchType val) - { - val = token switch - { - 'c' or 'C' => ModSearchType.ChangedItem, - 't' or 'T' => ModSearchType.Tag, - 'n' or 'N' => ModSearchType.Name, - 'a' or 'A' => ModSearchType.Author, - 's' or 'S' => ModSearchType.Category, - _ => ModSearchType.Default, - }; - return val is not ModSearchType.Default; - } - - protected override bool AllowsNone(ModSearchType val) - => val switch - { - ModSearchType.Author => true, - ModSearchType.ChangedItem => true, - ModSearchType.Tag => true, - ModSearchType.Category => true, - _ => false, - }; - - protected override void PostProcessing() - { - base.PostProcessing(); - HandleList(General); - HandleList(Forced); - HandleList(Negated); - return; - - static void HandleList(List list) - { - for (var i = 0; i < list.Count; ++i) - { - var entry = list[i]; - if (entry.Type is not ModSearchType.Category) - continue; - - if (ChangedItemDrawer.TryParsePartial(entry.Needle, out var icon)) - list[i] = entry with - { - IconFlagFilter = icon, - Needle = string.Empty, - }; - else - list.RemoveAt(i--); - } - } - } - - public bool IsVisible(ModFileSystem.Folder folder) - { - switch (State) - { - case FilterState.NoFilters: return true; - case FilterState.NoMatches: return false; - } - - var fullName = folder.FullName(); - return Forced.All(i => MatchesName(i, folder.Name, fullName, false)) - && !Negated.Any(i => MatchesName(i, folder.Name, fullName, true)) - && (General.Count == 0 || General.Any(i => MatchesName(i, folder.Name, fullName, false))); - } - - protected override bool Matches(Entry entry, ModFileSystem.Leaf leaf) - => entry.Type switch - { - ModSearchType.Default => leaf.FullName().AsSpan().Contains(entry.Needle, StringComparison.OrdinalIgnoreCase) - || leaf.Value.Name.Lower.AsSpan().Contains(entry.Needle, StringComparison.Ordinal), - ModSearchType.ChangedItem => leaf.Value.LowerChangedItemsString.AsSpan().Contains(entry.Needle, StringComparison.Ordinal), - ModSearchType.Tag => leaf.Value.AllTagsLower.AsSpan().Contains(entry.Needle, StringComparison.Ordinal), - ModSearchType.Name => leaf.Value.Name.Lower.AsSpan().Contains(entry.Needle, StringComparison.Ordinal), - ModSearchType.Author => leaf.Value.Author.Lower.AsSpan().Contains(entry.Needle, StringComparison.Ordinal), - ModSearchType.Category => leaf.Value.ChangedItems.Any(p - => ((p.Value?.Icon.ToFlag() ?? ChangedItemIconFlag.Unknown) & entry.IconFlagFilter) != 0), - _ => true, - }; - - protected override bool MatchesNone(ModSearchType type, bool negated, ModFileSystem.Leaf haystack) - => type switch - { - ModSearchType.Author when negated => !haystack.Value.Author.IsEmpty, - ModSearchType.Author => haystack.Value.Author.IsEmpty, - ModSearchType.ChangedItem when negated => haystack.Value.LowerChangedItemsString.Length > 0, - ModSearchType.ChangedItem => haystack.Value.LowerChangedItemsString.Length == 0, - ModSearchType.Tag when negated => haystack.Value.AllTagsLower.Length > 0, - ModSearchType.Tag => haystack.Value.AllTagsLower.Length == 0, - ModSearchType.Category when negated => haystack.Value.ChangedItems.Count > 0, - ModSearchType.Category => haystack.Value.ChangedItems.Count == 0, - _ => true, - }; - - private static bool MatchesName(Entry entry, ReadOnlySpan name, ReadOnlySpan fullName, bool defaultValue) - => entry.Type switch - { - ModSearchType.Default => fullName.Contains(entry.Needle, StringComparison.OrdinalIgnoreCase), - ModSearchType.Name => name.Contains(entry.Needle, StringComparison.OrdinalIgnoreCase), - _ => defaultValue, - }; -} diff --git a/Penumbra/UI/ModsTab/MultiModPanel.cs b/Penumbra/UI/ModsTab/MultiModPanel.cs index 947ede14..595240f4 100644 --- a/Penumbra/UI/ModsTab/MultiModPanel.cs +++ b/Penumbra/UI/ModsTab/MultiModPanel.cs @@ -1,110 +1,81 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; using Dalamud.Interface.Utility; -using OtterGui.Extensions; -using OtterGui.Filesystem; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using Penumbra.Mods; using Penumbra.Mods.Manager; namespace Penumbra.UI.ModsTab; -public class MultiModPanel(ModFileSystemSelector selector, ModDataEditor editor, PredefinedTagManager tagManager) : IUiService +public class MultiModPanel(ModFileSystemSelector _selector, ModDataEditor _editor) { public void Draw() { - if (selector.SelectedPaths.Count == 0) + if (_selector.SelectedPaths.Count == 0) return; ImGui.NewLine(); - var treeNodePos = ImGui.GetCursorPos(); - var numLeaves = DrawModList(); - DrawCounts(treeNodePos, numLeaves); + DrawModList(); DrawMultiTagger(); } - private void DrawCounts(Vector2 treeNodePos, int numLeaves) + private void DrawModList() { - var startPos = ImGui.GetCursorPos(); - var numFolders = selector.SelectedPaths.Count - numLeaves; - var text = (numLeaves, numFolders) switch - { - (0, 0) => string.Empty, // should not happen - (> 0, 0) => $"{numLeaves} Mods", - (0, > 0) => $"{numFolders} Folders", - _ => $"{numLeaves} Mods, {numFolders} Folders", - }; - ImGui.SetCursorPos(treeNodePos); - ImUtf8.TextRightAligned(text); - ImGui.SetCursorPos(startPos); - } - - private int DrawModList() - { - using var tree = ImUtf8.TreeNode("Currently Selected Objects###Selected"u8, - ImGuiTreeNodeFlags.DefaultOpen | ImGuiTreeNodeFlags.NoTreePushOnOpen); + using var tree = ImRaii.TreeNode("Currently Selected Objects", ImGuiTreeNodeFlags.DefaultOpen | ImGuiTreeNodeFlags.NoTreePushOnOpen); ImGui.Separator(); - - if (!tree) - return selector.SelectedPaths.Count(l => l is ModFileSystem.Leaf); + return; - var sizeType = new Vector2(ImGui.GetFrameHeight()); - var availableSizePercent = (ImGui.GetContentRegionAvail().X - sizeType.X - 4 * ImGui.GetStyle().CellPadding.X) / 100; + var sizeType = ImGui.GetFrameHeight(); + var availableSizePercent = (ImGui.GetContentRegionAvail().X - sizeType - 4 * ImGui.GetStyle().CellPadding.X) / 100; var sizeMods = availableSizePercent * 35; var sizeFolders = availableSizePercent * 65; - var leaves = 0; - using (var table = ImUtf8.Table("mods"u8, 3, ImGuiTableFlags.RowBg)) + using (var table = ImRaii.Table("mods", 3, ImGuiTableFlags.RowBg)) { if (!table) - return selector.SelectedPaths.Count(l => l is ModFileSystem.Leaf); + return; - ImUtf8.TableSetupColumn("type"u8, ImGuiTableColumnFlags.WidthFixed, sizeType.X); - ImUtf8.TableSetupColumn("mod"u8, ImGuiTableColumnFlags.WidthFixed, sizeMods); - ImUtf8.TableSetupColumn("path"u8, ImGuiTableColumnFlags.WidthFixed, sizeFolders); + ImGui.TableSetupColumn("type", ImGuiTableColumnFlags.WidthFixed, sizeType); + ImGui.TableSetupColumn("mod", ImGuiTableColumnFlags.WidthFixed, sizeMods); + ImGui.TableSetupColumn("path", ImGuiTableColumnFlags.WidthFixed, sizeFolders); var i = 0; - foreach (var (fullName, path) in selector.SelectedPaths.Select(p => (p.FullName(), p)) + foreach (var (fullName, path) in _selector.SelectedPaths.Select(p => (p.FullName(), p)) .OrderBy(p => p.Item1, StringComparer.OrdinalIgnoreCase)) { using var id = ImRaii.PushId(i++); - var (icon, text) = path is ModFileSystem.Leaf l - ? (FontAwesomeIcon.FileCircleMinus, l.Value.Name.Text) - : (FontAwesomeIcon.FolderMinus, string.Empty); ImGui.TableNextColumn(); - if (ImUtf8.IconButton(icon, "Remove from selection."u8, sizeType)) - selector.RemovePathFromMultiSelection(path); + var icon = (path is ModFileSystem.Leaf ? FontAwesomeIcon.FileCircleMinus : FontAwesomeIcon.FolderMinus).ToIconString(); + if (ImGuiUtil.DrawDisabledButton(icon, new Vector2(sizeType), "Remove from selection.", false, true)) + _selector.RemovePathFromMultiSelection(path); - ImUtf8.DrawFrameColumn(text); - ImUtf8.DrawFrameColumn(fullName); - if (path is ModFileSystem.Leaf) - ++leaves; + ImGui.TableNextColumn(); + ImGui.AlignTextToFramePadding(); + ImGui.TextUnformatted(path is ModFileSystem.Leaf l ? l.Value.Name : string.Empty); + + ImGui.TableNextColumn(); + ImGui.AlignTextToFramePadding(); + ImGui.TextUnformatted(fullName); } } ImGui.Separator(); - return leaves; } private string _tag = string.Empty; - private readonly List _addMods = []; - private readonly List<(Mod, int)> _removeMods = []; + private readonly List _addMods = []; + private readonly List<(Mod, int)> _removeMods = []; private void DrawMultiTagger() { var width = ImGuiHelpers.ScaledVector2(150, 0); - ImUtf8.TextFrameAligned("Multi Tagger:"u8); + ImGui.AlignTextToFramePadding(); + ImGui.TextUnformatted("Multi Tagger:"); ImGui.SameLine(); - - var predefinedTagsEnabled = tagManager.Enabled; - var inputWidth = predefinedTagsEnabled - ? ImGui.GetContentRegionAvail().X - 2 * width.X - 3 * ImGui.GetStyle().ItemInnerSpacing.X - ImGui.GetFrameHeight() - : ImGui.GetContentRegionAvail().X - 2 * (width.X + ImGui.GetStyle().ItemInnerSpacing.X); - ImGui.SetNextItemWidth(inputWidth); - ImUtf8.InputText("##tag"u8, ref _tag, "Local Tag Name..."u8); + ImGui.SetNextItemWidth(ImGui.GetContentRegionAvail().X - 2 * (width.X + ImGui.GetStyle().ItemSpacing.X)); + ImGui.InputTextWithHint("##tag", "Local Tag Name...", ref _tag, 128); UpdateTagCache(); var label = _addMods.Count > 0 @@ -115,10 +86,10 @@ public class MultiModPanel(ModFileSystemSelector selector, ModDataEditor editor, ? "No tag specified." : $"All mods selected already contain the tag \"{_tag}\", either locally or as mod data." : $"Add the tag \"{_tag}\" to {_addMods.Count} mods as a local tag:\n\n\t{string.Join("\n\t", _addMods.Select(m => m.Name.Text))}"; - ImUtf8.SameLineInner(); - if (ImUtf8.ButtonEx(label, tooltip, width, _addMods.Count == 0)) + ImGui.SameLine(); + if (ImGuiUtil.DrawDisabledButton(label, width, tooltip, _addMods.Count == 0)) foreach (var mod in _addMods) - editor.ChangeLocalTag(mod, mod.LocalTags.Count, _tag); + _editor.ChangeLocalTag(mod, mod.LocalTags.Count, _tag); label = _removeMods.Count > 0 ? $"Remove from {_removeMods.Count} Mods" @@ -128,18 +99,10 @@ public class MultiModPanel(ModFileSystemSelector selector, ModDataEditor editor, ? "No tag specified." : $"No selected mod contains the tag \"{_tag}\" locally." : $"Remove the local tag \"{_tag}\" from {_removeMods.Count} mods:\n\n\t{string.Join("\n\t", _removeMods.Select(m => m.Item1.Name.Text))}"; - ImUtf8.SameLineInner(); - if (ImUtf8.ButtonEx(label, tooltip, width, _removeMods.Count == 0)) + ImGui.SameLine(); + if (ImGuiUtil.DrawDisabledButton(label, width, tooltip, _removeMods.Count == 0)) foreach (var (mod, index) in _removeMods) - editor.ChangeLocalTag(mod, index, string.Empty); - - if (predefinedTagsEnabled) - { - ImUtf8.SameLineInner(); - tagManager.DrawToggleButton(); - tagManager.DrawListMulti(selector.SelectedPaths.OfType().Select(l => l.Value)); - } - + _editor.ChangeLocalTag(mod, index, string.Empty); ImGui.Separator(); } @@ -150,7 +113,7 @@ public class MultiModPanel(ModFileSystemSelector selector, ModDataEditor editor, if (_tag.Length == 0) return; - foreach (var leaf in selector.SelectedPaths.OfType()) + foreach (var leaf in _selector.SelectedPaths.OfType()) { var index = leaf.Value.LocalTags.IndexOf(_tag); if (index >= 0) diff --git a/Penumbra/UI/PredefinedTagManager.cs b/Penumbra/UI/PredefinedTagManager.cs index 5a3a4b62..0e5377d6 100644 --- a/Penumbra/UI/PredefinedTagManager.cs +++ b/Penumbra/UI/PredefinedTagManager.cs @@ -1,22 +1,19 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface; -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface; +using Dalamud.Interface.Internal.Notifications; +using ImGuiNET; using Newtonsoft.Json; using Newtonsoft.Json.Linq; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Mods; using Penumbra.Mods.Manager; using Penumbra.Services; using Penumbra.UI.Classes; +using ErrorEventArgs = Newtonsoft.Json.Serialization.ErrorEventArgs; namespace Penumbra.UI; -public sealed class PredefinedTagManager : ISavable, IReadOnlyList, IService +public sealed class PredefinedTagManager : ISavable, IReadOnlyList { public const int Version = 1; @@ -54,9 +51,6 @@ public sealed class PredefinedTagManager : ISavable, IReadOnlyList, ISer jObj.WriteTo(jWriter); } - public bool Enabled - => Count > 0; - public void Save() => _saveService.DelaySave(this, TimeSpan.FromSeconds(5)); @@ -103,9 +97,9 @@ public sealed class PredefinedTagManager : ISavable, IReadOnlyList, ISer } public void DrawAddFromSharedTagsAndUpdateTags(IReadOnlyCollection localTags, IReadOnlyCollection modTags, bool editLocal, - Mod mod) + Mods.Mod mod) { - DrawToggleButtonTopRight(); + DrawToggleButton(); if (!DrawList(localTags, modTags, editLocal, out var changedTag, out var index)) return; @@ -115,20 +109,15 @@ public sealed class PredefinedTagManager : ISavable, IReadOnlyList, ISer _modManager.DataEditor.ChangeModTag(mod, index, changedTag); } - public void DrawToggleButton() - { - using var color = ImRaii.PushColor(ImGuiCol.Button, ImGui.GetColorU32(ImGuiCol.ButtonActive), _isListOpen); - if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Tags.ToIconString(), new Vector2(ImGui.GetFrameHeight()), - "Add Predefined Tags...", false, true)) - _isListOpen = !_isListOpen; - } - - private void DrawToggleButtonTopRight() + private void DrawToggleButton() { ImGui.SameLine(ImGui.GetContentRegionMax().X - ImGui.GetFrameHeight() - (ImGui.GetScrollMaxY() > 0 ? ImGui.GetStyle().ItemInnerSpacing.X : 0)); - DrawToggleButton(); + using var color = ImRaii.PushColor(ImGuiCol.Button, ImGui.GetColorU32(ImGuiCol.ButtonActive), _isListOpen); + if (ImGuiUtil.DrawDisabledButton(FontAwesomeIcon.Tags.ToIconString(), new Vector2(ImGui.GetFrameHeight()), + "Add Predefined Tags...", false, true)) + _isListOpen = !_isListOpen; } private bool DrawList(IReadOnlyCollection localTags, IReadOnlyCollection modTags, bool editLocal, out string changedTag, @@ -140,7 +129,7 @@ public sealed class PredefinedTagManager : ISavable, IReadOnlyList, ISer if (!_isListOpen) return false; - ImUtf8.Text("Predefined Tags"u8); + ImGui.TextUnformatted("Predefined Tags"); ImGui.Separator(); var ret = false; @@ -165,101 +154,6 @@ public sealed class PredefinedTagManager : ISavable, IReadOnlyList, ISer return ret; } - private readonly List _selectedMods = []; - private readonly List<(int Index, int DataIndex)> _countedMods = []; - - private void PrepareLists(IEnumerable selection) - { - _selectedMods.Clear(); - _selectedMods.AddRange(selection); - _countedMods.EnsureCapacity(_selectedMods.Count); - while (_countedMods.Count < _selectedMods.Count) - _countedMods.Add((-1, -1)); - } - - public void DrawListMulti(IEnumerable selection) - { - if (!_isListOpen) - return; - - ImUtf8.Text("Predefined Tags"u8); - PrepareLists(selection); - - _enabledColor = ColorId.PredefinedTagAdd.Value(); - _disabledColor = ColorId.PredefinedTagRemove.Value(); - using var color = new ImRaii.Color(); - foreach (var (tag, idx) in _predefinedTags.Keys.WithIndex()) - { - var alreadyContained = 0; - var inModData = 0; - var missing = 0; - - foreach (var (modIndex, mod) in _selectedMods.Index()) - { - var tagIdx = mod.LocalTags.IndexOf(tag); - if (tagIdx >= 0) - { - ++alreadyContained; - _countedMods[modIndex] = (tagIdx, -1); - } - else - { - var dataIdx = mod.ModTags.IndexOf(tag); - if (dataIdx >= 0) - { - ++inModData; - _countedMods[modIndex] = (-1, dataIdx); - } - else - { - ++missing; - _countedMods[modIndex] = (-1, -1); - } - } - } - - using var id = ImRaii.PushId(idx); - var buttonWidth = CalcTextButtonWidth(tag); - // Prevent adding a new tag past the right edge of the popup - if (buttonWidth + ImGui.GetStyle().ItemSpacing.X >= ImGui.GetContentRegionAvail().X) - ImGui.NewLine(); - - var (usedColor, disabled, tt) = (missing, alreadyContained) switch - { - (> 0, _) => (_enabledColor, false, - $"Add this tag to {missing} mods.{(inModData > 0 ? $" {inModData} mods contain it in their mod tags and are untouched." : string.Empty)}"), - (_, > 0) => (_disabledColor, false, - $"Remove this tag from {alreadyContained} mods.{(inModData > 0 ? $" {inModData} mods contain it in their mod tags and are untouched." : string.Empty)}"), - _ => (_disabledColor, true, "This tag is already present in the mod tags of all selected mods."), - }; - color.Push(ImGuiCol.Button, usedColor); - if (ImUtf8.ButtonEx(tag, tt, new Vector2(buttonWidth, 0), disabled)) - { - if (missing > 0) - foreach (var (mod, (localIdx, _)) in _selectedMods.Zip(_countedMods)) - { - if (localIdx >= 0) - continue; - - _modManager.DataEditor.ChangeLocalTag(mod, mod.LocalTags.Count, tag); - } - else - foreach (var (mod, (localIdx, _)) in _selectedMods.Zip(_countedMods)) - { - if (localIdx < 0) - continue; - - _modManager.DataEditor.ChangeLocalTag(mod, localIdx, string.Empty); - } - } - ImGui.SameLine(); - - color.Pop(); - } - - ImGui.NewLine(); - } - private bool DrawColoredButton(string buttonLabel, int index, int tagIdx, bool inOther) { using var id = ImRaii.PushId(index); diff --git a/Penumbra/UI/ResourceWatcher/Record.cs b/Penumbra/UI/ResourceWatcher/Record.cs index ba718bc9..0fc51f26 100644 --- a/Penumbra/UI/ResourceWatcher/Record.cs +++ b/Penumbra/UI/ResourceWatcher/Record.cs @@ -1,49 +1,43 @@ using OtterGui.Classes; using Penumbra.Collections; using Penumbra.Enums; -using Penumbra.Interop; using Penumbra.Interop.Structs; using Penumbra.String; -using Penumbra.String.Classes; namespace Penumbra.UI.ResourceWatcher; [Flags] public enum RecordType : byte { - Request = 0x01, - ResourceLoad = 0x02, - FileLoad = 0x04, - Destruction = 0x08, - ResourceComplete = 0x10, + Request = 0x01, + ResourceLoad = 0x02, + FileLoad = 0x04, + Destruction = 0x08, } internal unsafe struct Record { public DateTime Time; - public CiByteString Path; - public CiByteString OriginalPath; + public ByteString Path; + public ByteString OriginalPath; public string AssociatedGameObject; public ModCollection? Collection; public ResourceHandle* Handle; public ResourceTypeFlag ResourceType; - public ulong Crc64; - public uint RefCount; public ResourceCategoryFlag Category; + public uint RefCount; public RecordType RecordType; public OptionalBool Synchronously; public OptionalBool ReturnValue; public OptionalBool CustomLoad; public LoadState LoadState; - public uint OsThreadId; - - public static Record CreateRequest(CiByteString path, bool sync) + public static Record CreateRequest(ByteString path, bool sync) => new() { Time = DateTime.UtcNow, Path = path.IsOwned ? path : path.Clone(), - OriginalPath = CiByteString.Empty, + OriginalPath = ByteString.Empty, Collection = null, Handle = null, ResourceType = ResourceExtensions.Type(path).ToFlag(), @@ -55,32 +49,9 @@ internal unsafe struct Record CustomLoad = OptionalBool.Null, AssociatedGameObject = string.Empty, LoadState = LoadState.None, - Crc64 = 0, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), }; - public static Record CreateRequest(CiByteString path, bool sync, FullPath fullPath, ResolveData resolve) - => new() - { - Time = DateTime.UtcNow, - Path = fullPath.InternalName.IsOwned ? fullPath.InternalName : fullPath.InternalName.Clone(), - OriginalPath = path.IsOwned ? path : path.Clone(), - Collection = resolve.Valid ? resolve.ModCollection : null, - Handle = null, - ResourceType = ResourceExtensions.Type(path).ToFlag(), - Category = ResourceExtensions.Category(path).ToFlag(), - RefCount = 0, - RecordType = RecordType.Request, - Synchronously = sync, - ReturnValue = OptionalBool.Null, - CustomLoad = fullPath.InternalName != path, - AssociatedGameObject = string.Empty, - LoadState = LoadState.None, - Crc64 = fullPath.Crc64, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), - }; - - public static Record CreateDefaultLoad(CiByteString path, ResourceHandle* handle, ModCollection collection, string associatedGameObject) + public static Record CreateDefaultLoad(ByteString path, ResourceHandle* handle, ModCollection collection, string associatedGameObject) { path = path.IsOwned ? path : path.Clone(); return new Record @@ -99,17 +70,15 @@ internal unsafe struct Record CustomLoad = false, AssociatedGameObject = associatedGameObject, LoadState = handle->LoadState, - Crc64 = 0, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), }; } - public static Record CreateLoad(FullPath path, CiByteString originalPath, ResourceHandle* handle, ModCollection collection, + public static Record CreateLoad(ByteString path, ByteString originalPath, ResourceHandle* handle, ModCollection collection, string associatedGameObject) => new() { Time = DateTime.UtcNow, - Path = path.InternalName.IsOwned ? path.InternalName : path.InternalName.Clone(), + Path = path.IsOwned ? path : path.Clone(), OriginalPath = originalPath.IsOwned ? originalPath : originalPath.Clone(), Collection = collection, Handle = handle, @@ -122,8 +91,6 @@ internal unsafe struct Record CustomLoad = true, AssociatedGameObject = associatedGameObject, LoadState = handle->LoadState, - Crc64 = path.Crc64, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), }; public static Record CreateDestruction(ResourceHandle* handle) @@ -133,7 +100,7 @@ internal unsafe struct Record { Time = DateTime.UtcNow, Path = path, - OriginalPath = CiByteString.Empty, + OriginalPath = ByteString.Empty, Collection = null, Handle = handle, ResourceType = handle->FileType.ToFlag(), @@ -145,17 +112,15 @@ internal unsafe struct Record CustomLoad = OptionalBool.Null, AssociatedGameObject = string.Empty, LoadState = handle->LoadState, - Crc64 = 0, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), }; } - public static Record CreateFileLoad(CiByteString path, ResourceHandle* handle, bool ret, bool custom) + public static Record CreateFileLoad(ByteString path, ResourceHandle* handle, bool ret, bool custom) => new() { Time = DateTime.UtcNow, Path = path.IsOwned ? path : path.Clone(), - OriginalPath = CiByteString.Empty, + OriginalPath = ByteString.Empty, Collection = null, Handle = handle, ResourceType = handle->FileType.ToFlag(), @@ -167,41 +132,5 @@ internal unsafe struct Record CustomLoad = custom, AssociatedGameObject = string.Empty, LoadState = handle->LoadState, - Crc64 = 0, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), }; - - public static Record CreateResourceComplete(CiByteString path, ResourceHandle* handle, Utf8GamePath originalPath, ReadOnlySpan additionalData) - => new() - { - Time = DateTime.UtcNow, - Path = CombinedPath(path, additionalData), - OriginalPath = originalPath.Path.IsOwned ? originalPath.Path : originalPath.Path.Clone(), - Collection = null, - Handle = handle, - ResourceType = handle->FileType.ToFlag(), - Category = handle->Category.ToFlag(), - RefCount = handle->RefCount, - RecordType = RecordType.ResourceComplete, - Synchronously = false, - ReturnValue = OptionalBool.Null, - CustomLoad = OptionalBool.Null, - AssociatedGameObject = string.Empty, - LoadState = handle->LoadState, - Crc64 = 0, - OsThreadId = ProcessThreadApi.GetCurrentThreadId(), - }; - - private static CiByteString CombinedPath(CiByteString path, ReadOnlySpan additionalData) - { - if (additionalData.Length is 0) - return path.IsOwned ? path : path.Clone(); - - fixed (byte* ptr = additionalData) - { - // If a path has additional data and is split, it is always in the form of |{additionalData}|{path}, - // so we can just read from the start of additional data - 1 and sum their length +2 for the pipes. - return new CiByteString(new ReadOnlySpan(ptr - 1, additionalData.Length + 2 + path.Length)).Clone(); - } - } } diff --git a/Penumbra/UI/ResourceWatcher/ResourceWatcher.cs b/Penumbra/UI/ResourceWatcher/ResourceWatcher.cs index ee3613fc..d5ff1abd 100644 --- a/Penumbra/UI/ResourceWatcher/ResourceWatcher.cs +++ b/Penumbra/UI/ResourceWatcher/ResourceWatcher.cs @@ -1,15 +1,13 @@ -using Dalamud.Bindings.ImGui; using FFXIVClientStructs.FFXIV.Client.Game.Object; using FFXIVClientStructs.FFXIV.Client.System.Resource; +using ImGuiNET; using OtterGui.Raii; -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Collections; using Penumbra.GameData.Actors; using Penumbra.GameData.Enums; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.Interop.Hooks.Resources; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Structs; using Penumbra.String; using Penumbra.String.Classes; @@ -17,74 +15,47 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.ResourceWatcher; -public sealed class ResourceWatcher : IDisposable, ITab, IUiService +public sealed class ResourceWatcher : IDisposable, ITab { public const int DefaultMaxEntries = 1024; public const RecordType AllRecords = RecordType.Request | RecordType.ResourceLoad | RecordType.FileLoad | RecordType.Destruction; - private readonly Configuration _config; - private readonly EphemeralConfig _ephemeral; - private readonly ResourceService _resources; - private readonly ResourceLoader _loader; - private readonly ResourceHandleDestructor _destructor; - private readonly ActorManager _actors; - private readonly List _records = []; - private readonly ConcurrentQueue _newRecords = []; - private readonly ResourceWatcherTable _table; - private string _logFilter = string.Empty; - private Regex? _logRegex; - private int _newMaxEntries; + private readonly Configuration _config; + private readonly EphemeralConfig _ephemeral; + private readonly ResourceService _resources; + private readonly ResourceLoader _loader; + private readonly ActorManager _actors; + private readonly List _records = []; + private readonly ConcurrentQueue _newRecords = []; + private readonly ResourceWatcherTable _table; + private string _logFilter = string.Empty; + private Regex? _logRegex; + private int _newMaxEntries; - public unsafe ResourceWatcher(ActorManager actors, Configuration config, ResourceService resources, ResourceLoader loader, - ResourceHandleDestructor destructor) + public unsafe ResourceWatcher(ActorManager actors, Configuration config, ResourceService resources, ResourceLoader loader) { - _actors = actors; - _config = config; - _ephemeral = config.Ephemeral; - _resources = resources; - _destructor = destructor; - _loader = loader; - _table = new ResourceWatcherTable(config.Ephemeral, _records); - _resources.ResourceRequested += OnResourceRequested; - _destructor.Subscribe(OnResourceDestroyed, ResourceHandleDestructor.Priority.ResourceWatcher); - _loader.ResourceLoaded += OnResourceLoaded; - _loader.ResourceComplete += OnResourceComplete; - _loader.FileLoaded += OnFileLoaded; - _loader.PapRequested += OnPapRequested; + _actors = actors; + _config = config; + _ephemeral = config.Ephemeral; + _resources = resources; + _loader = loader; + _table = new ResourceWatcherTable(config.Ephemeral, _records); + _resources.ResourceRequested += OnResourceRequested; + _resources.ResourceHandleDestructor += OnResourceDestroyed; + _loader.ResourceLoaded += OnResourceLoaded; + _loader.FileLoaded += OnFileLoaded; UpdateFilter(_ephemeral.ResourceLoggingFilter, false); _newMaxEntries = _config.MaxResourceWatcherRecords; } - private void OnPapRequested(Utf8GamePath original, FullPath? _1, ResolveData _2) - { - if (_ephemeral.EnableResourceLogging && FilterMatch(original.Path, out var match)) - { - Penumbra.Log.Information($"[ResourceLoader] [REQ] {match} was requested asynchronously."); - if (_1.HasValue) - Penumbra.Log.Information( - $"[ResourceLoader] [LOAD] Resolved {_1.Value.FullName} for {match} from collection {_2.ModCollection} for object 0x{_2.AssociatedGameObject:X}."); - } - - if (!_ephemeral.EnableResourceWatcher) - return; - - var record = _1.HasValue - ? Record.CreateRequest(original.Path, false, _1.Value, _2) - : Record.CreateRequest(original.Path, false); - if (!_ephemeral.OnlyAddMatchingResources || _table.WouldBeVisible(record)) - _newRecords.Enqueue(record); - } - public unsafe void Dispose() { Clear(); _records.TrimExcess(); - _resources.ResourceRequested -= OnResourceRequested; - _destructor.Unsubscribe(OnResourceDestroyed); - _loader.ResourceLoaded -= OnResourceLoaded; - _loader.ResourceComplete -= OnResourceComplete; - _loader.FileLoaded -= OnFileLoaded; - _loader.PapRequested -= OnPapRequested; + _resources.ResourceRequested -= OnResourceRequested; + _resources.ResourceHandleDestructor -= OnResourceDestroyed; + _loader.ResourceLoaded -= OnResourceLoaded; + _loader.FileLoaded -= OnFileLoaded; } private void Clear() @@ -172,7 +143,7 @@ public sealed class ResourceWatcher : IDisposable, ITab, IUiService } } - private bool FilterMatch(CiByteString path, out string match) + private bool FilterMatch(ByteString path, out string match) { match = path.ToString(); return _logFilter.Length == 0 || (_logRegex?.IsMatch(match) ?? false) || match.Contains(_logFilter, StringComparison.OrdinalIgnoreCase); @@ -224,7 +195,8 @@ public sealed class ResourceWatcher : IDisposable, ITab, IUiService private unsafe void OnResourceRequested(ref ResourceCategory category, ref ResourceType type, ref int hash, ref Utf8GamePath path, - Utf8GamePath original, GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue) + Utf8GamePath original, + GetResourceParameters* parameters, ref bool sync, ref ResourceHandle* returnValue) { if (_ephemeral.EnableResourceLogging && FilterMatch(original.Path, out var match)) Penumbra.Log.Information($"[ResourceLoader] [REQ] {match} was requested {(sync ? "synchronously." : "asynchronously.")}"); @@ -250,7 +222,7 @@ public sealed class ResourceWatcher : IDisposable, ITab, IUiService { var pathString = manipulatedPath != null ? $"custom file {name2} instead of {name}" : name; Penumbra.Log.Information( - $"[ResourceLoader] [LOAD] [{handle->FileType}] Loaded {pathString} to 0x{(ulong)handle:X} using collection {data.ModCollection.Identity.AnonymizedName} for {Name(data, "no associated object.")} (Refcount {handle->RefCount}) "); + $"[ResourceLoader] [LOAD] [{handle->FileType}] Loaded {pathString} to 0x{(ulong)handle:X} using collection {data.ModCollection.AnonymizedName} for {Name(data, "no associated object.")} (Refcount {handle->RefCount}) "); } } @@ -259,30 +231,12 @@ public sealed class ResourceWatcher : IDisposable, ITab, IUiService var record = manipulatedPath == null ? Record.CreateDefaultLoad(path.Path, handle, data.ModCollection, Name(data)) - : Record.CreateLoad(manipulatedPath.Value, path.Path, handle, data.ModCollection, Name(data)); + : Record.CreateLoad(manipulatedPath.Value.InternalName, path.Path, handle, data.ModCollection, Name(data)); if (!_ephemeral.OnlyAddMatchingResources || _table.WouldBeVisible(record)) _newRecords.Enqueue(record); } - private unsafe void OnResourceComplete(ResourceHandle* resource, CiByteString path, Utf8GamePath original, - ReadOnlySpan additionalData, bool isAsync) - { - if (!isAsync) - return; - - if (_ephemeral.EnableResourceLogging && FilterMatch(path, out var match)) - Penumbra.Log.Information( - $"[ResourceLoader] [DONE] [{resource->FileType}] Finished loading {match} into 0x{(ulong)resource:X}, state {resource->LoadState}."); - - if (!_ephemeral.EnableResourceWatcher) - return; - - var record = Record.CreateResourceComplete(path, resource, original, additionalData); - if (!_ephemeral.OnlyAddMatchingResources || _table.WouldBeVisible(record)) - _newRecords.Enqueue(record); - } - - private unsafe void OnFileLoaded(ResourceHandle* resource, CiByteString path, bool success, bool custom, ReadOnlySpan _) + private unsafe void OnFileLoaded(ResourceHandle* resource, ByteString path, bool success, bool custom, ByteString _) { if (_ephemeral.EnableResourceLogging && FilterMatch(path, out var match)) Penumbra.Log.Information( @@ -312,7 +266,7 @@ public sealed class ResourceWatcher : IDisposable, ITab, IUiService public unsafe string Name(ResolveData resolve, string none = "") { - if (resolve.AssociatedGameObject == nint.Zero || !_actors.Awaiter.IsCompletedSuccessfully) + if (resolve.AssociatedGameObject == IntPtr.Zero || !_actors.Awaiter.IsCompletedSuccessfully) return none; try diff --git a/Penumbra/UI/ResourceWatcher/ResourceWatcherTable.cs b/Penumbra/UI/ResourceWatcher/ResourceWatcherTable.cs index 97df095e..b47574d0 100644 --- a/Penumbra/UI/ResourceWatcher/ResourceWatcherTable.cs +++ b/Penumbra/UI/ResourceWatcher/ResourceWatcherTable.cs @@ -1,10 +1,9 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; using OtterGui.Table; -using OtterGui.Text; using Penumbra.Enums; using Penumbra.Interop.Structs; using Penumbra.String; @@ -29,9 +28,7 @@ internal sealed class ResourceWatcherTable : Table new HandleColumn { Label = "Resource" }, new LoadStateColumn { Label = "State" }, new RefCountColumn { Label = "#Ref" }, - new DateColumn { Label = "Time" }, - new Crc64Column { Label = "Crc64" }, - new OsThreadColumn { Label = "TID" } + new DateColumn { Label = "Time" } ) { } @@ -53,43 +50,38 @@ internal sealed class ResourceWatcherTable : Table => DrawByteString(item.Path, 280 * UiHelpers.Scale); } - private static unsafe void DrawByteString(CiByteString path, float length) + private static unsafe void DrawByteString(ByteString path, float length) { - if (path.IsEmpty) - return; - - var size = ImUtf8.CalcTextSize(path.Span); - var clicked = false; - if (size.X <= length) + Vector2 vec; + ImGuiNative.igCalcTextSize(&vec, path.Path, path.Path + path.Length, 0, 0); + if (vec.X <= length) { - clicked = ImUtf8.Selectable(path.Span); + ImGuiNative.igTextUnformatted(path.Path, path.Path + path.Length); } else { - var fileName = path.LastIndexOf((byte)'/'); - using (ImRaii.Group()) + var fileName = path.LastIndexOf((byte)'/'); + ByteString shortPath; + if (fileName != -1) { - CiByteString shortPath; - if (fileName != -1) - { - using var font = ImRaii.PushFont(UiBuilder.IconFont); - clicked = ImUtf8.Selectable(FontAwesomeIcon.EllipsisH.ToIconString()); - ImUtf8.SameLineInner(); - shortPath = path.Substring(fileName, path.Length - fileName); - } - else - { - shortPath = path; - } - - clicked |= ImUtf8.Selectable(shortPath.Span, false, ImGuiSelectableFlags.AllowItemOverlap); + using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, new Vector2(2 * UiHelpers.Scale)); + using var font = ImRaii.PushFont(UiBuilder.IconFont); + ImGui.TextUnformatted(FontAwesomeIcon.EllipsisH.ToIconString()); + ImGui.SameLine(); + shortPath = path.Substring(fileName, path.Length - fileName); + } + else + { + shortPath = path; } - ImUtf8.HoverTooltip(path.Span); - } + ImGuiNative.igTextUnformatted(shortPath.Path, shortPath.Path + shortPath.Length); + if (ImGui.IsItemClicked()) + ImGuiNative.igSetClipboardText(path.Path); - if (clicked) - ImUtf8.SetClipboardText(path.Span); + if (ImGui.IsItemHovered()) + ImGuiNative.igSetTooltip(path.Path); + } } private sealed class RecordTypeColumn : ColumnFlags @@ -125,12 +117,11 @@ internal sealed class ResourceWatcherTable : Table { ImGui.TextUnformatted(item.RecordType switch { - RecordType.Request => "REQ", - RecordType.ResourceLoad => "LOAD", - RecordType.FileLoad => "FILE", - RecordType.Destruction => "DEST", - RecordType.ResourceComplete => "DONE", - _ => string.Empty, + RecordType.Request => "REQ", + RecordType.ResourceLoad => "LOAD", + RecordType.FileLoad => "FILE", + RecordType.Destruction => "DEST", + _ => string.Empty, }); } } @@ -147,21 +138,6 @@ internal sealed class ResourceWatcherTable : Table => ImGui.TextUnformatted($"{item.Time.ToLongTimeString()}.{item.Time.Millisecond:D4}"); } - private sealed class Crc64Column : ColumnString - { - public override float Width - => UiBuilder.MonoFont.GetCharAdvance('0') * 17; - - public override unsafe string ToName(Record item) - => item.Crc64 != 0 ? $"{item.Crc64:X16}" : string.Empty; - - public override unsafe void DrawColumn(Record item, int _) - { - using var font = ImRaii.PushFont(UiBuilder.MonoFont, item.Handle != null); - ImUtf8.Text(ToName(item)); - } - } - private sealed class CollectionColumn : ColumnString { @@ -169,7 +145,7 @@ internal sealed class ResourceWatcherTable : Table => 80 * UiHelpers.Scale; public override string ToName(Record item) - => (item.Collection != null ? item.Collection.Identity.Name : null) ?? string.Empty; + => item.Collection?.Name ?? string.Empty; } private sealed class ObjectColumn : ColumnString @@ -319,10 +295,10 @@ internal sealed class ResourceWatcherTable : Table { LoadState.None => FilterValue.HasFlag(LoadStateFlag.None), LoadState.Success => FilterValue.HasFlag(LoadStateFlag.Success), + LoadState.Async => FilterValue.HasFlag(LoadStateFlag.Async), + LoadState.Failure => FilterValue.HasFlag(LoadStateFlag.Failed), LoadState.FailedSubResource => FilterValue.HasFlag(LoadStateFlag.FailedSub), - <= LoadState.Constructed => FilterValue.HasFlag(LoadStateFlag.Unknown), - < LoadState.Success => FilterValue.HasFlag(LoadStateFlag.Async), - > LoadState.Success => FilterValue.HasFlag(LoadStateFlag.Failed), + _ => FilterValue.HasFlag(LoadStateFlag.Unknown), }; public override void DrawColumn(Record item, int _) @@ -334,12 +310,12 @@ internal sealed class ResourceWatcherTable : Table { LoadState.Success => (FontAwesomeIcon.CheckCircle, ColorId.IncreasedMetaValue.Value(), $"Successfully loaded ({(byte)item.LoadState})."), + LoadState.Async => (FontAwesomeIcon.Clock, ColorId.FolderLine.Value(), $"Loading asynchronously ({(byte)item.LoadState})."), + LoadState.Failure => (FontAwesomeIcon.Times, ColorId.DecreasedMetaValue.Value(), + $"Failed to load ({(byte)item.LoadState})."), LoadState.FailedSubResource => (FontAwesomeIcon.ExclamationCircle, ColorId.DecreasedMetaValue.Value(), $"Dependencies failed to load ({(byte)item.LoadState})."), - <= LoadState.Constructed => (FontAwesomeIcon.QuestionCircle, ColorId.UndefinedMod.Value(), $"Not yet loaded ({(byte)item.LoadState})."), - < LoadState.Success => (FontAwesomeIcon.Clock, ColorId.FolderLine.Value(), $"Loading asynchronously ({(byte)item.LoadState})."), - > LoadState.Success => (FontAwesomeIcon.Times, ColorId.DecreasedMetaValue.Value(), - $"Failed to load ({(byte)item.LoadState})."), + _ => (FontAwesomeIcon.QuestionCircle, ColorId.UndefinedMod.Value(), $"Unknown state ({(byte)item.LoadState})."), }; using (var font = ImRaii.PushFont(UiBuilder.IconFont)) { @@ -454,19 +430,4 @@ internal sealed class ResourceWatcherTable : Table public override int Compare(Record lhs, Record rhs) => lhs.RefCount.CompareTo(rhs.RefCount); } - - private sealed class OsThreadColumn : ColumnString - { - public override float Width - => 60 * UiHelpers.Scale; - - public override string ToName(Record item) - => item.OsThreadId.ToString(); - - public override void DrawColumn(Record item, int _) - => ImGuiUtil.RightAlign(ToName(item)); - - public override int Compare(Record lhs, Record rhs) - => lhs.OsThreadId.CompareTo(rhs.OsThreadId); - } } diff --git a/Penumbra/UI/Tabs/ChangedItemsTab.cs b/Penumbra/UI/Tabs/ChangedItemsTab.cs index 4dc9474f..ab0badf4 100644 --- a/Penumbra/UI/Tabs/ChangedItemsTab.cs +++ b/Penumbra/UI/Tabs/ChangedItemsTab.cs @@ -1,13 +1,10 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Collections.Manager; -using Penumbra.GameData.Data; using Penumbra.Mods; using Penumbra.Mods.Editor; using Penumbra.Services; @@ -20,43 +17,37 @@ public class ChangedItemsTab( CollectionSelectHeader collectionHeader, ChangedItemDrawer drawer, CommunicatorService communicator) - : ITab, IUiService + : ITab { public ReadOnlySpan Label => "Changed Items"u8; private LowerString _changedItemFilter = LowerString.Empty; private LowerString _changedItemModFilter = LowerString.Empty; - private Vector2 _buttonSize; public void DrawContent() { collectionHeader.Draw(true); drawer.DrawTypeFilter(); var varWidth = DrawFilters(); - using var child = ImUtf8.Child("##changedItemsChild"u8, -Vector2.One); + using var child = ImRaii.Child("##changedItemsChild", -Vector2.One); if (!child) return; - _buttonSize = new Vector2(ImGui.GetStyle().ItemSpacing.Y + ImGui.GetFrameHeight()); - using var style = ImRaii.PushStyle(ImGuiStyleVar.CellPadding, Vector2.Zero) - .Push(ImGuiStyleVar.ItemSpacing, Vector2.Zero) - .Push(ImGuiStyleVar.FramePadding, Vector2.Zero) - .Push(ImGuiStyleVar.SelectableTextAlign, new Vector2(0.01f, 0.5f)); - - var skips = ImGuiClip.GetNecessarySkips(_buttonSize.Y); - using var list = ImUtf8.Table("##changedItems"u8, 3, ImGuiTableFlags.RowBg, -Vector2.One); + var height = ImGui.GetFrameHeight() + 2 * ImGui.GetStyle().CellPadding.Y; + var skips = ImGuiClip.GetNecessarySkips(height); + using var list = ImRaii.Table("##changedItems", 3, ImGuiTableFlags.RowBg, -Vector2.One); if (!list) return; const ImGuiTableColumnFlags flags = ImGuiTableColumnFlags.NoResize | ImGuiTableColumnFlags.WidthFixed; - ImUtf8.TableSetupColumn("items"u8, flags, 450 * UiHelpers.Scale); - ImUtf8.TableSetupColumn("mods"u8, flags, varWidth - 140 * UiHelpers.Scale); - ImUtf8.TableSetupColumn("id"u8, flags, 140 * UiHelpers.Scale); + ImGui.TableSetupColumn("items", flags, 450 * UiHelpers.Scale); + ImGui.TableSetupColumn("mods", flags, varWidth - 130 * UiHelpers.Scale); + ImGui.TableSetupColumn("id", flags, 130 * UiHelpers.Scale); var items = collectionManager.Active.Current.ChangedItems; var rest = ImGuiClip.FilteredClippedDraw(items, skips, FilterChangedItem, DrawChangedItemColumn); - ImGuiClip.DrawEndDummy(rest, _buttonSize.Y); + ImGuiClip.DrawEndDummy(rest, height); } /// Draw a pair of filters and return the variable width of the flexible column. @@ -74,25 +65,22 @@ public class ChangedItemsTab( } /// Apply the current filters. - private bool FilterChangedItem(KeyValuePair, IIdentifiedObjectData)> item) + private bool FilterChangedItem(KeyValuePair, object?)> item) => drawer.FilterChangedItem(item.Key, item.Value.Item2, _changedItemFilter) && (_changedItemModFilter.IsEmpty || item.Value.Item1.Any(m => m.Name.Contains(_changedItemModFilter))); /// Draw a full column for a changed item. - private void DrawChangedItemColumn(KeyValuePair, IIdentifiedObjectData)> item) + private void DrawChangedItemColumn(KeyValuePair, object?)> item) { ImGui.TableNextColumn(); - drawer.DrawCategoryIcon(item.Value.Item2, _buttonSize.Y); - ImGui.SameLine(0, 0); - var name = item.Value.Item2.ToName(item.Key); - var clicked = ImUtf8.Selectable(name, false, ImGuiSelectableFlags.None, _buttonSize with { X = 0 }); - drawer.ChangedItemHandling(item.Value.Item2, clicked); - + drawer.DrawCategoryIcon(item.Key, item.Value.Item2); + ImGui.SameLine(); + drawer.DrawChangedItem(item.Key, item.Value.Item2); ImGui.TableNextColumn(); DrawModColumn(item.Value.Item1); ImGui.TableNextColumn(); - ChangedItemDrawer.DrawModelData(item.Value.Item2, _buttonSize.Y); + drawer.DrawModelData(item.Value.Item2); } private void DrawModColumn(SingleArray mods) @@ -100,18 +88,19 @@ public class ChangedItemsTab( if (mods.Count <= 0) return; - var first = mods[0]; - if (ImUtf8.Selectable(first.Name.Text, false, ImGuiSelectableFlags.None, _buttonSize with { X = 0 }) + var first = mods[0]; + using var style = ImRaii.PushStyle(ImGuiStyleVar.SelectableTextAlign, new Vector2(0, 0.5f)); + if (ImGui.Selectable(first.Name, false, ImGuiSelectableFlags.None, new Vector2(0, ImGui.GetFrameHeight())) && ImGui.GetIO().KeyCtrl && first is Mod mod) communicator.SelectTab.Invoke(TabType.Mods, mod); - if (!ImGui.IsItemHovered()) - return; - - using var _ = ImRaii.Tooltip(); - ImUtf8.Text("Hold Control and click to jump to mod.\n"u8); - if (mods.Count > 1) - ImUtf8.Text("Other mods affecting this item:\n" + string.Join("\n", mods.Skip(1).Select(m => m.Name))); + if (ImGui.IsItemHovered()) + { + using var _ = ImRaii.Tooltip(); + ImGui.TextUnformatted("Hold Control and click to jump to mod.\n"); + if (mods.Count > 1) + ImGui.TextUnformatted("Other mods affecting this item:\n" + string.Join("\n", mods.Skip(1).Select(m => m.Name))); + } } } diff --git a/Penumbra/UI/Tabs/CollectionsTab.cs b/Penumbra/UI/Tabs/CollectionsTab.cs index b458fc16..fe1471b3 100644 --- a/Penumbra/UI/Tabs/CollectionsTab.cs +++ b/Penumbra/UI/Tabs/CollectionsTab.cs @@ -1,24 +1,26 @@ -using Dalamud.Bindings.ImGui; +using Dalamud.Game.ClientState.Objects; +using Dalamud.Interface; +using Dalamud.Interface.Utility; using Dalamud.Plugin; -using Dalamud.Plugin.Services; +using ImGuiNET; +using OtterGui; using OtterGui.Raii; -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Collections.Manager; using Penumbra.GameData.Actors; using Penumbra.Mods.Manager; using Penumbra.Services; +using Penumbra.UI.Classes; using Penumbra.UI.CollectionTab; namespace Penumbra.UI.Tabs; -public sealed class CollectionsTab : IDisposable, ITab, IUiService +public sealed class CollectionsTab : IDisposable, ITab { private readonly EphemeralConfig _config; private readonly CollectionSelector _selector; private readonly CollectionPanel _panel; private readonly TutorialService _tutorial; - private readonly IncognitoService _incognito; public enum PanelMode { @@ -38,14 +40,13 @@ public sealed class CollectionsTab : IDisposable, ITab, IUiService } } - public CollectionsTab(IDalamudPluginInterface pi, Configuration configuration, CommunicatorService communicator, IncognitoService incognito, - CollectionManager collectionManager, ModStorage modStorage, ActorManager actors, ITargetManager targets, TutorialService tutorial, SaveService saveService) + public CollectionsTab(DalamudPluginInterface pi, Configuration configuration, CommunicatorService communicator, + CollectionManager collectionManager, ModStorage modStorage, ActorManager actors, ITargetManager targets, TutorialService tutorial, FilenameService fileNames) { - _config = configuration.Ephemeral; - _tutorial = tutorial; - _incognito = incognito; - _selector = new CollectionSelector(configuration, communicator, collectionManager.Storage, collectionManager.Active, _tutorial, incognito); - _panel = new CollectionPanel(pi, communicator, collectionManager, _selector, actors, targets, modStorage, saveService, incognito); + _config = configuration.Ephemeral; + _tutorial = tutorial; + _selector = new CollectionSelector(configuration, communicator, collectionManager.Storage, collectionManager.Active, _tutorial); + _panel = new CollectionPanel(pi, communicator, collectionManager, _selector, actors, targets, modStorage, fileNames); } public void Dispose() @@ -115,7 +116,18 @@ public sealed class CollectionsTab : IDisposable, ITab, IUiService _tutorial.OpenTutorial(BasicTutorialSteps.CollectionDetails); ImGui.SameLine(); - _incognito.DrawToggle(withSpacing); + style.Push(ImGuiStyleVar.FrameBorderSize, ImGuiHelpers.GlobalScale); + color.Push(ImGuiCol.Text, ColorId.FolderExpanded.Value()) + .Push(ImGuiCol.Border, ColorId.FolderExpanded.Value()); + if (ImGuiUtil.DrawDisabledButton( + $"{(_selector.IncognitoMode ? FontAwesomeIcon.Eye : FontAwesomeIcon.EyeSlash).ToIconString()}###IncognitoMode", + buttonSize with { X = withSpacing }, string.Empty, false, true)) + _selector.IncognitoMode = !_selector.IncognitoMode; + var hovered = ImGui.IsItemHovered(); + _tutorial.OpenTutorial(BasicTutorialSteps.Incognito); + color.Pop(2); + if (hovered) + ImGui.SetTooltip(_selector.IncognitoMode ? "Toggle incognito mode off." : "Toggle incognito mode on."); } private void DrawPanel() diff --git a/Penumbra/UI/Tabs/ConfigTabBar.cs b/Penumbra/UI/Tabs/ConfigTabBar.cs index 43ae2488..9fd07f27 100644 --- a/Penumbra/UI/Tabs/ConfigTabBar.cs +++ b/Penumbra/UI/Tabs/ConfigTabBar.cs @@ -1,5 +1,4 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Services; +using ImGuiNET; using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Mods; @@ -9,7 +8,7 @@ using Watcher = Penumbra.UI.ResourceWatcher.ResourceWatcher; namespace Penumbra.UI.Tabs; -public class ConfigTabBar : IDisposable, IUiService +public class ConfigTabBar : IDisposable { private readonly CommunicatorService _communicator; diff --git a/Penumbra/UI/Tabs/Debug/AtchDrawer.cs b/Penumbra/UI/Tabs/Debug/AtchDrawer.cs deleted file mode 100644 index f136bacd..00000000 --- a/Penumbra/UI/Tabs/Debug/AtchDrawer.cs +++ /dev/null @@ -1,57 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Extensions; -using OtterGui.Text; -using Penumbra.GameData.Files; -using Penumbra.GameData.Files.AtchStructs; - -namespace Penumbra.UI.Tabs.Debug; - -public static class AtchDrawer -{ - public static void Draw(AtchFile file) - { - using (ImUtf8.Group()) - { - ImUtf8.Text("Entries: "u8); - ImUtf8.Text("States: "u8); - } - - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.Text($"{file.Points.Count}"); - if (file.Points.Count == 0) - { - ImUtf8.Text("0"u8); - return; - } - - ImUtf8.Text($"{file.Points[0].Entries.Length}"); - } - - foreach (var (entry, index) in file.Points.WithIndex()) - { - using var id = ImUtf8.PushId(index); - using var tree = ImUtf8.TreeNode($"{index:D3}: {entry.Type.ToName()}"); - if (tree) - { - ImUtf8.TreeNode(entry.Accessory ? "Accessory"u8 : "Weapon"u8, ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - foreach (var (state, i) in entry.Entries.WithIndex()) - { - id.Push(i); - using var t = ImUtf8.TreeNode(state.Bone); - if (t) - { - ImUtf8.TreeNode($"Scale: {state.Scale}", ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - ImUtf8.TreeNode($"Offset: {state.Offset.X} | {state.Offset.Y} | {state.Offset.Z}", - ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - ImUtf8.TreeNode($"Rotation: {state.Rotation.X} | {state.Rotation.Y} | {state.Rotation.Z}", - ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - } - - id.Pop(); - } - } - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/CrashDataExtensions.cs b/Penumbra/UI/Tabs/Debug/CrashDataExtensions.cs index 471d770a..4649e548 100644 --- a/Penumbra/UI/Tabs/Debug/CrashDataExtensions.cs +++ b/Penumbra/UI/Tabs/Debug/CrashDataExtensions.cs @@ -1,4 +1,4 @@ -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using Penumbra.CrashHandler; @@ -96,7 +96,7 @@ public static class CrashDataExtensions if (!table) return; - ImGuiClip.ClippedDraw(data.LastVFXFuncsInvoked, vfx => + ImGuiClip.ClippedDraw(data.LastVfxFuncsInvoked, vfx => { ImGuiUtil.DrawTableColumn(vfx.Age.ToString(CultureInfo.InvariantCulture)); ImGuiUtil.DrawTableColumn(vfx.ThreadId.ToString()); diff --git a/Penumbra/UI/Tabs/Debug/CrashHandlerPanel.cs b/Penumbra/UI/Tabs/Debug/CrashHandlerPanel.cs index 672b8c79..c8e7f001 100644 --- a/Penumbra/UI/Tabs/Debug/CrashHandlerPanel.cs +++ b/Penumbra/UI/Tabs/Debug/CrashHandlerPanel.cs @@ -1,6 +1,6 @@ using System.Text.Json; -using Dalamud.Bindings.ImGui; using Dalamud.Interface.DragDrop; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using OtterGui.Services; diff --git a/Penumbra/UI/Tabs/Debug/DebugConfigurationDrawer.cs b/Penumbra/UI/Tabs/Debug/DebugConfigurationDrawer.cs deleted file mode 100644 index 087670c1..00000000 --- a/Penumbra/UI/Tabs/Debug/DebugConfigurationDrawer.cs +++ /dev/null @@ -1,16 +0,0 @@ -using OtterGui.Text; - -namespace Penumbra.UI.Tabs.Debug; - -public static class DebugConfigurationDrawer -{ - public static void Draw() - { - using var id = ImUtf8.CollapsingHeaderId("Debugging Options"u8); - if (!id) - return; - - ImUtf8.Checkbox("Log IMC File Replacements"u8, ref DebugConfiguration.WriteImcBytesToLog); - ImUtf8.Checkbox("Scan for Skin Material Attributes"u8, ref DebugConfiguration.UseSkinMaterialProcessing); - } -} diff --git a/Penumbra/UI/Tabs/Debug/DebugTab.cs b/Penumbra/UI/Tabs/Debug/DebugTab.cs index c7f0635d..1813a7e3 100644 --- a/Penumbra/UI/Tabs/Debug/DebugTab.cs +++ b/Penumbra/UI/Tabs/Debug/DebugTab.cs @@ -1,4 +1,5 @@ using Dalamud.Interface; +using Dalamud.Interface.Utility; using Dalamud.Interface.Utility.Raii; using Dalamud.Interface.Windowing; using Dalamud.Plugin.Services; @@ -6,17 +7,14 @@ using Dalamud.Utility; using FFXIVClientStructs.FFXIV.Client.Game.Character; using FFXIVClientStructs.FFXIV.Client.Game.Group; using FFXIVClientStructs.FFXIV.Client.Game.Object; +using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; using FFXIVClientStructs.FFXIV.Client.System.Resource; using FFXIVClientStructs.FFXIV.Client.UI.Agent; -using Dalamud.Bindings.ImGui; -using Dalamud.Game.ClientState.Objects.SubKinds; -using Dalamud.Interface.Colors; +using ImGuiNET; using Microsoft.Extensions.DependencyInjection; using OtterGui; using OtterGui.Classes; -using OtterGui.Extensions; using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Api; using Penumbra.Collections.Manager; @@ -27,6 +25,7 @@ using Penumbra.GameData.Interop; using Penumbra.Import.Structs; using Penumbra.Import.Textures; using Penumbra.Interop.PathResolving; +using Penumbra.Interop.ResourceLoading; using Penumbra.Interop.Services; using Penumbra.Interop.Structs; using Penumbra.Mods; @@ -37,19 +36,15 @@ using Penumbra.UI.Classes; using Penumbra.Util; using static OtterGui.Raii.ImRaii; using CharacterBase = FFXIVClientStructs.FFXIV.Client.Graphics.Scene.CharacterBase; +using CharacterUtility = Penumbra.Interop.Services.CharacterUtility; +using ObjectKind = Dalamud.Game.ClientState.Objects.Enums.ObjectKind; +using ResidentResourceManager = Penumbra.Interop.Services.ResidentResourceManager; using ImGuiClip = OtterGui.ImGuiClip; using Penumbra.Api.IpcTester; -using Penumbra.GameData.Data; -using Penumbra.Interop.Hooks.PostProcessing; -using Penumbra.Interop.Hooks.ResourceLoading; -using Penumbra.GameData.Files.StainMapStructs; -using Penumbra.Interop; -using Penumbra.String.Classes; -using Penumbra.UI.AdvancedWindow.Materials; namespace Penumbra.UI.Tabs.Debug; -public class Diagnostics(ServiceManager provider) : IUiService +public class Diagnostics(IServiceProvider provider) { public void DrawDiagnostics() { @@ -57,13 +52,10 @@ public class Diagnostics(ServiceManager provider) : IUiService return; using var table = ImRaii.Table("##data", 4, ImGuiTableFlags.RowBg); - if (!table) - return; - foreach (var type in typeof(ActorManager).Assembly.GetTypes() .Where(t => t is { IsAbstract: false, IsInterface: false } && t.IsAssignableTo(typeof(IAsyncDataContainer)))) { - var container = (IAsyncDataContainer)provider.Provider!.GetRequiredService(type); + var container = (IAsyncDataContainer)provider.GetRequiredService(type); ImGuiUtil.DrawTableColumn(container.Name); ImGuiUtil.DrawTableColumn(container.Time.ToString()); ImGuiUtil.DrawTableColumn(Functions.HumanReadableSize(container.Memory)); @@ -72,58 +64,47 @@ public class Diagnostics(ServiceManager provider) : IUiService } } -public class DebugTab : Window, ITab, IUiService +public class DebugTab : Window, ITab { - private readonly PerformanceTracker _performance; - private readonly Configuration _config; - private readonly CollectionManager _collectionManager; - private readonly ModManager _modManager; - private readonly ValidityChecker _validityChecker; - private readonly HttpApi _httpApi; - private readonly ActorManager _actors; - private readonly StainService _stains; - private readonly GlobalVariablesDrawer _globalVariablesDrawer; - private readonly ResourceManagerService _resourceManager; - private readonly ResourceLoader _resourceLoader; - private readonly CollectionResolver _collectionResolver; - private readonly DrawObjectState _drawObjectState; - private readonly PathState _pathState; - private readonly SubfileHelper _subfileHelper; - private readonly IdentifiedCollectionCache _identifiedCollectionCache; - private readonly CutsceneService _cutsceneService; - private readonly ModImportManager _modImporter; - private readonly ImportPopup _importPopup; - private readonly FrameworkManager _framework; - private readonly TextureManager _textureManager; - private readonly ShaderReplacementFixer _shaderReplacementFixer; - private readonly RedrawService _redraws; - private readonly DictEmote _emotes; - private readonly Diagnostics _diagnostics; - private readonly ObjectManager _objects; - private readonly IClientState _clientState; - private readonly IDataManager _dataManager; - private readonly IpcTester _ipcTester; - private readonly CrashHandlerPanel _crashHandlerPanel; - private readonly TexHeaderDrawer _texHeaderDrawer; - private readonly HookOverrideDrawer _hookOverrides; - private readonly RsfService _rsfService; - private readonly SchedulerResourceManagementService _schedulerService; - private readonly ObjectIdentification _objectIdentification; - private readonly RenderTargetDrawer _renderTargetDrawer; - private readonly ModMigratorDebug _modMigratorDebug; - private readonly ShapeInspector _shapeInspector; + private readonly PerformanceTracker _performance; + private readonly Configuration _config; + private readonly CollectionManager _collectionManager; + private readonly ModManager _modManager; + private readonly ValidityChecker _validityChecker; + private readonly HttpApi _httpApi; + private readonly ActorManager _actors; + private readonly StainService _stains; + private readonly CharacterUtility _characterUtility; + private readonly ResidentResourceManager _residentResources; + private readonly ResourceManagerService _resourceManager; + private readonly CollectionResolver _collectionResolver; + private readonly DrawObjectState _drawObjectState; + private readonly PathState _pathState; + private readonly SubfileHelper _subfileHelper; + private readonly IdentifiedCollectionCache _identifiedCollectionCache; + private readonly CutsceneService _cutsceneService; + private readonly ModImportManager _modImporter; + private readonly ImportPopup _importPopup; + private readonly FrameworkManager _framework; + private readonly TextureManager _textureManager; + private readonly ShaderReplacementFixer _shaderReplacementFixer; + private readonly RedrawService _redraws; + private readonly DictEmote _emotes; + private readonly Diagnostics _diagnostics; + private readonly ObjectManager _objects; + private readonly IClientState _clientState; + private readonly IpcTester _ipcTester; + private readonly CrashHandlerPanel _crashHandlerPanel; public DebugTab(PerformanceTracker performance, Configuration config, CollectionManager collectionManager, ObjectManager objects, - IClientState clientState, IDataManager dataManager, + IClientState clientState, ValidityChecker validityChecker, ModManager modManager, HttpApi httpApi, ActorManager actors, StainService stains, - ResourceManagerService resourceManager, ResourceLoader resourceLoader, CollectionResolver collectionResolver, + CharacterUtility characterUtility, ResidentResourceManager residentResources, + ResourceManagerService resourceManager, CollectionResolver collectionResolver, DrawObjectState drawObjectState, PathState pathState, SubfileHelper subfileHelper, IdentifiedCollectionCache identifiedCollectionCache, CutsceneService cutsceneService, ModImportManager modImporter, ImportPopup importPopup, FrameworkManager framework, TextureManager textureManager, ShaderReplacementFixer shaderReplacementFixer, RedrawService redraws, DictEmote emotes, - Diagnostics diagnostics, IpcTester ipcTester, CrashHandlerPanel crashHandlerPanel, TexHeaderDrawer texHeaderDrawer, - HookOverrideDrawer hookOverrides, RsfService rsfService, GlobalVariablesDrawer globalVariablesDrawer, - SchedulerResourceManagementService schedulerService, ObjectIdentification objectIdentification, RenderTargetDrawer renderTargetDrawer, - ModMigratorDebug modMigratorDebug, ShapeInspector shapeInspector) + Diagnostics diagnostics, IpcTester ipcTester, CrashHandlerPanel crashHandlerPanel) : base("Penumbra Debug Window", ImGuiWindowFlags.NoCollapse) { IsOpen = true; @@ -140,8 +121,9 @@ public class DebugTab : Window, ITab, IUiService _httpApi = httpApi; _actors = actors; _stains = stains; + _characterUtility = characterUtility; + _residentResources = residentResources; _resourceManager = resourceManager; - _resourceLoader = resourceLoader; _collectionResolver = collectionResolver; _drawObjectState = drawObjectState; _pathState = pathState; @@ -158,18 +140,8 @@ public class DebugTab : Window, ITab, IUiService _diagnostics = diagnostics; _ipcTester = ipcTester; _crashHandlerPanel = crashHandlerPanel; - _texHeaderDrawer = texHeaderDrawer; - _hookOverrides = hookOverrides; - _rsfService = rsfService; - _globalVariablesDrawer = globalVariablesDrawer; - _schedulerService = schedulerService; - _objectIdentification = objectIdentification; - _renderTargetDrawer = renderTargetDrawer; - _modMigratorDebug = modMigratorDebug; - _shapeInspector = shapeInspector; _objects = objects; _clientState = clientState; - _dataManager = dataManager; } public ReadOnlySpan Label @@ -191,30 +163,36 @@ public class DebugTab : Window, ITab, IUiService return; DrawDebugTabGeneral(); + ImGui.NewLine(); _crashHandlerPanel.Draw(); - DebugConfigurationDrawer.Draw(); + ImGui.NewLine(); _diagnostics.DrawDiagnostics(); DrawPerformanceTab(); + ImGui.NewLine(); DrawPathResolverDebug(); + ImGui.NewLine(); DrawActorsDebug(); + ImGui.NewLine(); DrawCollectionCaches(); - _texHeaderDrawer.Draw(); - _modMigratorDebug.Draw(); - DrawShaderReplacementFixer(); + ImGui.NewLine(); + DrawDebugCharacterUtility(); + ImGui.NewLine(); DrawData(); - DrawCrcCache(); - DrawResourceLoader(); + ImGui.NewLine(); + DrawDebugTabMetaLists(); + ImGui.NewLine(); DrawResourceProblems(); - _renderTargetDrawer.Draw(); - _hookOverrides.Draw(); + ImGui.NewLine(); DrawPlayerModelInfo(); - _globalVariablesDrawer.Draw(); - DrawCloudApi(); + ImGui.NewLine(); + DrawGlobalVariableInfo(); + ImGui.NewLine(); DrawDebugTabIpc(); + ImGui.NewLine(); } - private unsafe void DrawCollectionCaches() + private void DrawCollectionCaches() { if (!ImGui.CollapsingHeader( $"Collections ({_collectionManager.Caches.Count}/{_collectionManager.Storage.Count - 1} Caches)###Collections")) @@ -225,76 +203,30 @@ public class DebugTab : Window, ITab, IUiService if (collection.HasCache) { using var color = PushColor(ImGuiCol.Text, ColorId.FolderExpanded.Value()); - using var node = - TreeNode($"{collection.Identity.Name} (Change Counter {collection.Counters.Change})###{collection.Identity.Name}"); + using var node = TreeNode($"{collection.AnonymizedName} (Change Counter {collection.ChangeCounter})"); if (!node) continue; color.Pop(); - using (var inheritanceNode = ImUtf8.TreeNode("Inheritance"u8)) + foreach (var (mod, paths, manips) in collection._cache!.ModData.Data.OrderBy(t => t.Item1.Name)) { - if (inheritanceNode) - { - using var table = ImUtf8.Table("table"u8, 3, - ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg | ImGuiTableFlags.BordersInnerV); - if (table) - { - var max = Math.Max( - Math.Max(collection.Inheritance.DirectlyInheritedBy.Count, collection.Inheritance.DirectlyInheritsFrom.Count), - collection.Inheritance.FlatHierarchy.Count); - for (var i = 0; i < max; ++i) - { - ImGui.TableNextColumn(); - if (i < collection.Inheritance.DirectlyInheritsFrom.Count) - ImUtf8.Text(collection.Inheritance.DirectlyInheritsFrom[i].Identity.Name); - else - ImGui.Dummy(new Vector2(200 * ImUtf8.GlobalScale, ImGui.GetTextLineHeight())); - ImGui.TableNextColumn(); - if (i < collection.Inheritance.DirectlyInheritedBy.Count) - ImUtf8.Text(collection.Inheritance.DirectlyInheritedBy[i].Identity.Name); - else - ImGui.Dummy(new Vector2(200 * ImUtf8.GlobalScale, ImGui.GetTextLineHeight())); - ImGui.TableNextColumn(); - if (i < collection.Inheritance.FlatHierarchy.Count) - ImUtf8.Text(collection.Inheritance.FlatHierarchy[i].Identity.Name); - else - ImGui.Dummy(new Vector2(200 * ImUtf8.GlobalScale, ImGui.GetTextLineHeight())); - } - } - } + using var id = mod is TemporaryMod t ? PushId(t.Priority.Value) : PushId(((Mod)mod).ModPath.Name); + using var node2 = TreeNode(mod.Name.Text); + if (!node2) + continue; + + foreach (var path in paths) + + TreeNode(path.ToString(), ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); + + foreach (var manip in manips) + TreeNode(manip.ToString(), ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); } - - using (var resourceNode = ImUtf8.TreeNode("Custom Resources"u8)) - { - if (resourceNode) - foreach (var (path, resource) in collection._cache!.CustomResources) - { - ImUtf8.TreeNode($"{path} -> 0x{(ulong)resource.ResourceHandle:X}", - ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - } - } - - using var modNode = ImUtf8.TreeNode("Enabled Mods"u8); - if (modNode) - foreach (var (mod, paths, manips) in collection._cache!.ModData.Data.OrderBy(t => t.Item1.Name)) - { - using var id = mod is TemporaryMod t ? PushId(t.Priority.Value) : PushId(((Mod)mod).ModPath.Name); - using var node2 = TreeNode(mod.Name.Text); - if (!node2) - continue; - - foreach (var path in paths) - - TreeNode(path.ToString(), ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - - foreach (var manip in manips) - TreeNode(manip.ToString(), ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); - } } else { using var color = PushColor(ImGuiCol.Text, ColorId.UndefinedMod.Value()); - TreeNode($"{collection.Identity.Name} (Change Counter {collection.Counters.Change})", + TreeNode($"{collection.AnonymizedName} (Change Counter {collection.ChangeCounter})", ImGuiTreeNodeFlags.Bullet | ImGuiTreeNodeFlags.Leaf).Dispose(); } } @@ -320,9 +252,9 @@ public class DebugTab : Window, ITab, IUiService { PrintValue("Penumbra Version", $"{_validityChecker.Version} {DebugVersionString}"); PrintValue("Git Commit Hash", _validityChecker.CommitHash); - PrintValue(TutorialService.SelectedCollection, _collectionManager.Active.Current.Identity.Name); + PrintValue(TutorialService.SelectedCollection, _collectionManager.Active.Current.Name); PrintValue(" has Cache", _collectionManager.Active.Current.HasCache.ToString()); - PrintValue(TutorialService.DefaultCollection, _collectionManager.Active.Default.Identity.Name); + PrintValue(TutorialService.DefaultCollection, _collectionManager.Active.Default.Name); PrintValue(" has Cache", _collectionManager.Active.Default.HasCache.ToString()); PrintValue("Mod Manager BasePath", _modManager.BasePath.Name); PrintValue("Mod Manager BasePath-Full", _modManager.BasePath.FullName); @@ -466,37 +398,11 @@ public class DebugTab : Window, ITab, IUiService } } } - - using (var tree = ImUtf8.TreeNode("String Memory"u8)) - { - if (tree) - { - using (ImUtf8.Group()) - { - ImUtf8.Text("Currently Allocated Strings"u8); - ImUtf8.Text("Total Allocated Strings"u8); - ImUtf8.Text("Free'd Allocated Strings"u8); - ImUtf8.Text("Currently Allocated Bytes"u8); - ImUtf8.Text("Total Allocated Bytes"u8); - ImUtf8.Text("Free'd Allocated Bytes"u8); - } - - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.Text($"{PenumbraStringMemory.CurrentStrings}"); - ImUtf8.Text($"{PenumbraStringMemory.AllocatedStrings}"); - ImUtf8.Text($"{PenumbraStringMemory.FreedStrings}"); - ImUtf8.Text($"{PenumbraStringMemory.CurrentBytes}"); - ImUtf8.Text($"{PenumbraStringMemory.AllocatedBytes}"); - ImUtf8.Text($"{PenumbraStringMemory.FreedBytes}"); - } - } - } } private void DrawPerformanceTab() { + ImGui.NewLine(); if (!ImGui.CollapsingHeader("Performance")) return; @@ -514,50 +420,29 @@ public class DebugTab : Window, ITab, IUiService if (!ImGui.CollapsingHeader("Actors")) return; - using (var objectTree = ImUtf8.TreeNode("Object Manager"u8)) + using var table = Table("##actors", 5, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, + -Vector2.UnitX); + if (!table) + return; + + DrawSpecial("Current Player", _actors.GetCurrentPlayer()); + DrawSpecial("Current Inspect", _actors.GetInspectPlayer()); + DrawSpecial("Current Card", _actors.GetCardPlayer()); + DrawSpecial("Current Glamour", _actors.GetGlamourPlayer()); + + foreach (var obj in _objects) { - if (objectTree) - { - _objects.DrawDebug(); - - using var table = Table("##actors", 8, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, - -Vector2.UnitX); - if (!table) - return; - - DrawSpecial("Current Player", _actors.GetCurrentPlayer()); - DrawSpecial("Current Inspect", _actors.GetInspectPlayer()); - DrawSpecial("Current Card", _actors.GetCardPlayer()); - DrawSpecial("Current Glamour", _actors.GetGlamourPlayer()); - - foreach (var obj in _objects) - { - ImGuiUtil.DrawTableColumn(obj.Address != nint.Zero ? $"{((GameObject*)obj.Address)->ObjectIndex}" : "NULL"); - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(obj.Address); - ImGui.TableNextColumn(); - if (obj.Address != nint.Zero) - Penumbra.Dynamis.DrawPointer((nint)((Character*)obj.Address)->GameObject.GetDrawObject()); - var identifier = _actors.FromObject(obj, out _, false, true, false); - ImGuiUtil.DrawTableColumn(_actors.ToString(identifier)); - var id = obj.AsObject->ObjectKind is ObjectKind.BattleNpc - ? $"{identifier.DataId} | {obj.AsObject->BaseId}" - : identifier.DataId.ToString(); - ImGuiUtil.DrawTableColumn(id); - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(obj.Address != nint.Zero ? *(nint*)obj.Address : nint.Zero); - ImGuiUtil.DrawTableColumn(obj.Address != nint.Zero ? $"0x{obj.AsObject->EntityId:X}" : "NULL"); - ImGuiUtil.DrawTableColumn(obj.Address != nint.Zero - ? obj.AsObject->IsCharacter() ? $"Character: {obj.AsCharacter->ObjectKind}" : "No Character" - : "NULL"); - } - } - } - - using (var shapeTree = ImUtf8.TreeNode("Shape Inspector"u8)) - { - if (shapeTree) - _shapeInspector.Draw(); + ImGuiUtil.DrawTableColumn($"{((GameObject*)obj.Address)->ObjectIndex}"); + ImGuiUtil.DrawTableColumn($"0x{obj.Address:X}"); + ImGuiUtil.DrawTableColumn(obj.Address == nint.Zero + ? string.Empty + : $"0x{(nint)((Character*)obj.Address)->GameObject.GetDrawObject():X}"); + var identifier = _actors.FromObject(obj, out _, false, true, false); + ImGuiUtil.DrawTableColumn(_actors.ToString(identifier)); + var id = obj.AsObject->ObjectKind == (byte)ObjectKind.BattleNpc + ? $"{identifier.DataId} | {obj.AsObject->DataID}" + : identifier.DataId.ToString(); + ImGuiUtil.DrawTableColumn(id); } return; @@ -572,9 +457,6 @@ public class DebugTab : Window, ITab, IUiService ImGuiUtil.DrawTableColumn(string.Empty); ImGuiUtil.DrawTableColumn(_actors.ToString(id)); ImGuiUtil.DrawTableColumn(string.Empty); - ImGuiUtil.DrawTableColumn(string.Empty); - ImGuiUtil.DrawTableColumn(string.Empty); - ImGuiUtil.DrawTableColumn(string.Empty); } } @@ -588,37 +470,33 @@ public class DebugTab : Window, ITab, IUiService return; ImGui.TextUnformatted( - $"Last Game Object: 0x{_collectionResolver.IdentifyLastGameObjectCollection(true).AssociatedGameObject:X} ({_collectionResolver.IdentifyLastGameObjectCollection(true).ModCollection.Identity.Name})"); + $"Last Game Object: 0x{_collectionResolver.IdentifyLastGameObjectCollection(true).AssociatedGameObject:X} ({_collectionResolver.IdentifyLastGameObjectCollection(true).ModCollection.Name})"); using (var drawTree = TreeNode("Draw Object to Object")) { if (drawTree) { - using var table = Table("###DrawObjectResolverTable", 8, ImGuiTableFlags.SizingFixedFit); + using var table = Table("###DrawObjectResolverTable", 6, ImGuiTableFlags.SizingFixedFit); if (table) - foreach (var (drawObject, (gameObjectPtr, idx, child)) in _drawObjectState - .OrderBy(kvp => kvp.Value.Item2.Index) - .ThenBy(kvp => kvp.Value.Item3) - .ThenBy(kvp => kvp.Key.Address)) + foreach (var (drawObject, (gameObjectPtr, child)) in _drawObjectState + .OrderBy(kvp => ((GameObject*)kvp.Value.Item1)->ObjectIndex) + .ThenBy(kvp => kvp.Value.Item2) + .ThenBy(kvp => kvp.Key)) { + var gameObject = (GameObject*)gameObjectPtr; ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable($"{drawObject}"); - ImUtf8.DrawTableColumn($"{gameObjectPtr.Index}"); - using (ImRaii.PushColor(ImGuiCol.Text, 0xFF0000FF, gameObjectPtr.Index != idx)) - { - ImUtf8.DrawTableColumn($"{idx}"); - } - - ImUtf8.DrawTableColumn(child ? "Child"u8 : "Main"u8); + ImGui.TextUnformatted($"0x{drawObject:X}"); ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable($"{gameObjectPtr}"); - using (ImRaii.PushColor(ImGuiCol.Text, 0xFF0000FF, _objects[idx] != gameObjectPtr)) - { - ImUtf8.DrawTableColumn($"{_objects[idx]}"); - } - - ImUtf8.DrawTableColumn(gameObjectPtr.Utf8Name.Span); - var collection = _collectionResolver.IdentifyCollection(gameObjectPtr.AsObject, true); - ImUtf8.DrawTableColumn(collection.ModCollection.Identity.Name); + ImGui.TextUnformatted(gameObject->ObjectIndex.ToString()); + ImGui.TableNextColumn(); + ImGui.TextUnformatted(child ? "Child" : "Main"); + ImGui.TableNextColumn(); + var (address, name) = ($"0x{gameObjectPtr:X}", new ByteString(gameObject->Name).ToString()); + ImGui.TextUnformatted(address); + ImGui.TableNextColumn(); + ImGui.TextUnformatted(name); + ImGui.TableNextColumn(); + var collection = _collectionResolver.IdentifyCollection(gameObject, true); + ImGui.TextUnformatted(collection.ModCollection.Name); } } } @@ -634,7 +512,7 @@ public class DebugTab : Window, ITab, IUiService ImGui.TableNextColumn(); ImGui.TextUnformatted($"{data.AssociatedGameObject:X}"); ImGui.TableNextColumn(); - ImGui.TextUnformatted(data.ModCollection.Identity.Name); + ImGui.TextUnformatted(data.ModCollection.Name); } } } @@ -647,12 +525,12 @@ public class DebugTab : Window, ITab, IUiService if (table) { ImGuiUtil.DrawTableColumn("Current Mtrl Data"); - ImGuiUtil.DrawTableColumn(_subfileHelper.MtrlData.ModCollection.Identity.Name); + ImGuiUtil.DrawTableColumn(_subfileHelper.MtrlData.ModCollection.Name); ImGuiUtil.DrawTableColumn($"0x{_subfileHelper.MtrlData.AssociatedGameObject:X}"); ImGui.TableNextColumn(); ImGuiUtil.DrawTableColumn("Current Avfx Data"); - ImGuiUtil.DrawTableColumn(_subfileHelper.AvfxData.ModCollection.Identity.Name); + ImGuiUtil.DrawTableColumn(_subfileHelper.AvfxData.ModCollection.Name); ImGuiUtil.DrawTableColumn($"0x{_subfileHelper.AvfxData.AssociatedGameObject:X}"); ImGui.TableNextColumn(); @@ -664,7 +542,7 @@ public class DebugTab : Window, ITab, IUiService foreach (var (resource, resolve) in _subfileHelper) { ImGuiUtil.DrawTableColumn($"0x{resource:X}"); - ImGuiUtil.DrawTableColumn(resolve.ModCollection.Identity.Name); + ImGuiUtil.DrawTableColumn(resolve.ModCollection.Name); ImGuiUtil.DrawTableColumn($"0x{resolve.AssociatedGameObject:X}"); ImGuiUtil.DrawTableColumn($"{((ResourceHandle*)resource)->FileName()}"); } @@ -684,7 +562,7 @@ public class DebugTab : Window, ITab, IUiService ImGuiUtil.DrawTableColumn($"{((GameObject*)address)->ObjectIndex}"); ImGuiUtil.DrawTableColumn($"0x{address:X}"); ImGuiUtil.DrawTableColumn(identifier.ToString()); - ImGuiUtil.DrawTableColumn(collection.Identity.Name); + ImGuiUtil.DrawTableColumn(collection.Name); } } } @@ -711,11 +589,11 @@ public class DebugTab : Window, ITab, IUiService if (table) { ImGuiUtil.DrawTableColumn("Group Members"); - ImGuiUtil.DrawTableColumn(GroupManager.Instance()->MainGroup.MemberCount.ToString()); + ImGuiUtil.DrawTableColumn(GroupManager.Instance()->MemberCount.ToString()); for (var i = 0; i < 8; ++i) { ImGuiUtil.DrawTableColumn($"Member #{i}"); - var member = GroupManager.Instance()->MainGroup.GetPartyMemberByIndex(i); + var member = GroupManager.Instance()->GetPartyMemberByIndex(i); ImGuiUtil.DrawTableColumn(member == null ? "NULL" : new ByteString(member->Name).ToString()); } } @@ -730,16 +608,13 @@ public class DebugTab : Window, ITab, IUiService if (agent->Data == null) agent = &AgentBannerMIP.Instance()->AgentBannerInterface; - ImUtf8.Text("Agent: "); - ImGui.SameLine(0, 0); - Penumbra.Dynamis.DrawPointer((nint)agent); if (agent->Data != null) { using var table = Table("###PBannerTable", 2, ImGuiTableFlags.SizingFixedFit); if (table) for (var i = 0; i < 8; ++i) { - ref var c = ref agent->Data->Characters[i]; + ref var c = ref agent->Data->CharacterArraySpan[i]; ImGuiUtil.DrawTableColumn($"Character {i}"); var name = c.Name1.ToString(); ImGuiUtil.DrawTableColumn(name.Length == 0 ? "NULL" : $"{name} ({c.WorldId})"); @@ -751,20 +626,6 @@ public class DebugTab : Window, ITab, IUiService } } } - - using (var tmbCache = TreeNode("TMB Cache")) - { - if (tmbCache) - { - using var table = Table("###TmbTable", 2, ImGuiTableFlags.SizingFixedFit); - if (table) - foreach (var (id, name) in _schedulerService.ListedTmbs.OrderBy(kvp => kvp.Key)) - { - ImUtf8.DrawTableColumn($"{id:D6}"); - ImUtf8.DrawTableColumn(name.Span); - } - } - } } private void DrawData() @@ -773,67 +634,12 @@ public class DebugTab : Window, ITab, IUiService return; DrawEmotes(); - DrawActionTmbs(); DrawStainTemplates(); - DrawAtch(); - DrawChangedItemTest(); } - private string _changedItemPath = string.Empty; - private readonly Dictionary _changedItems = []; - - private void DrawChangedItemTest() - { - using var node = TreeNode("Changed Item Test"); - if (!node) - return; - - if (ImUtf8.InputText("##ChangedItemTest"u8, ref _changedItemPath, "Changed Item File Path..."u8)) - { - _changedItems.Clear(); - _objectIdentification.Identify(_changedItems, _changedItemPath); - } - - if (_changedItems.Count == 0) - return; - - using var list = ImUtf8.ListBox("##ChangedItemList"u8, - new Vector2(ImGui.GetContentRegionAvail().X, 8 * ImGui.GetTextLineHeightWithSpacing())); - if (!list) - return; - - foreach (var item in _changedItems) - ImUtf8.Selectable(item.Key); - } - - private string _emoteSearchFile = string.Empty; private string _emoteSearchName = string.Empty; - - private AtchFile? _atchFile; - - private void DrawAtch() - { - try - { - _atchFile ??= new AtchFile(_dataManager.GetFile("chara/xls/attachOffset/c0101.atch")!.Data); - } - catch - { - // ignored - } - - if (_atchFile == null) - return; - - using var mainTree = ImUtf8.TreeNode("Atch File C0101"u8); - if (!mainTree) - return; - - AtchDrawer.Draw(_atchFile); - } - private void DrawEmotes() { using var mainTree = TreeNode("Emotes"); @@ -862,197 +668,204 @@ public class DebugTab : Window, ITab, IUiService ImGuiClip.DrawEndDummy(dummy, ImGui.GetTextLineHeightWithSpacing()); } - private string _tmbKeyFilter = string.Empty; - private CiByteString _tmbKeyFilterU8 = CiByteString.Empty; - - private void DrawActionTmbs() - { - using var mainTree = TreeNode("Action TMBs"); - if (!mainTree) - return; - - if (ImGui.InputText("Key", ref _tmbKeyFilter, 256)) - _tmbKeyFilterU8 = CiByteString.FromString(_tmbKeyFilter, out var r, MetaDataComputation.All) ? r : CiByteString.Empty; - using var table = Table("##table", 2, ImGuiTableFlags.RowBg | ImGuiTableFlags.ScrollY | ImGuiTableFlags.SizingFixedFit, - new Vector2(-1, 12 * ImGui.GetTextLineHeightWithSpacing())); - if (!table) - return; - - var skips = ImGuiClip.GetNecessarySkips(ImGui.GetTextLineHeightWithSpacing()); - var dummy = ImGuiClip.FilteredClippedDraw(_schedulerService.ActionTmbs.OrderBy(r => r.Value), skips, - kvp => kvp.Key.Contains(_tmbKeyFilterU8), - p => - { - ImUtf8.DrawTableColumn($"{p.Value}"); - ImUtf8.DrawTableColumn(p.Key.Span); - }); - ImGuiClip.DrawEndDummy(dummy, ImGui.GetTextLineHeightWithSpacing()); - } - private void DrawStainTemplates() { using var mainTree = TreeNode("Staining Templates"); if (!mainTree) return; - using (var legacyTree = TreeNode("stainingtemplate.stm")) - { - if (legacyTree) - DrawStainTemplatesFile(_stains.LegacyStmFile); - } - - using (var gudTree = TreeNode("stainingtemplate_gud.stm")) - { - if (gudTree) - DrawStainTemplatesFile(_stains.GudStmFile); - } - } - - private static void DrawStainTemplatesFile(StmFile stmFile) where TDyePack : unmanaged, IDyePack - { - foreach (var (key, data) in stmFile.Entries) + foreach (var (key, data) in _stains.StmFile.Entries) { using var tree = TreeNode($"Template {key}"); if (!tree) continue; - using var table = Table("##table", data.Colors.Length + data.Scalars.Length, - ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); + using var table = Table("##table", 5, ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); if (!table) continue; - for (var i = 0; i < StmFile.StainingTemplateEntry.NumElements; ++i) + for (var i = 0; i < StmFile.StainingTemplateEntry.NumElements; ++i) { - foreach (var list in data.Colors) - { - var color = list[i]; - ImGui.TableNextColumn(); - var frame = new Vector2(ImGui.GetTextLineHeight()); - ImGui.ColorButton("###color", new Vector4(MtrlTab.PseudoSqrtRgb((Vector3)color), 1), 0, frame); - ImGui.SameLine(); - ImGui.TextUnformatted($"{color.Red:F6} | {color.Green:F6} | {color.Blue:F6}"); - } + var (r, g, b) = data.DiffuseEntries[i]; + ImGuiUtil.DrawTableColumn($"{r:F6} | {g:F6} | {b:F6}"); - foreach (var list in data.Scalars) - { - var scalar = list[i]; - ImGuiUtil.DrawTableColumn($"{scalar:F6}"); - } + (r, g, b) = data.SpecularEntries[i]; + ImGuiUtil.DrawTableColumn($"{r:F6} | {g:F6} | {b:F6}"); + + (r, g, b) = data.EmissiveEntries[i]; + ImGuiUtil.DrawTableColumn($"{r:F6} | {g:F6} | {b:F6}"); + + var a = data.SpecularPowerEntries[i]; + ImGuiUtil.DrawTableColumn($"{a:F6}"); + + a = data.GlossEntries[i]; + ImGuiUtil.DrawTableColumn($"{a:F6}"); } } } - - private void DrawShaderReplacementFixer() + /// + /// Draw information about the character utility class from SE, + /// displaying all files, their sizes, the default files and the default sizes. + /// + private unsafe void DrawDebugCharacterUtility() { - if (!ImGui.CollapsingHeader("Shader Replacement Fixer")) + if (!ImGui.CollapsingHeader("Character Utility")) return; var enableShaderReplacementFixer = _shaderReplacementFixer.Enabled; if (ImGui.Checkbox("Enable Shader Replacement Fixer", ref enableShaderReplacementFixer)) _shaderReplacementFixer.Enabled = enableShaderReplacementFixer; - if (!enableShaderReplacementFixer) - return; + if (enableShaderReplacementFixer) + { + ImGui.SameLine(); + ImGui.Dummy(ImGuiHelpers.ScaledVector2(20, 0)); + var slowPathCallDeltas = _shaderReplacementFixer.GetAndResetSlowPathCallDeltas(); + ImGui.SameLine(); + ImGui.TextUnformatted($"\u0394 Slow-Path Calls for skin.shpk: {slowPathCallDeltas.Skin}"); + ImGui.SameLine(); + ImGui.TextUnformatted($"characterglass.shpk: {slowPathCallDeltas.CharacterGlass}"); + ImGui.SameLine(); + ImGui.Dummy(ImGuiHelpers.ScaledVector2(20, 0)); + ImGui.SameLine(); + ImGui.TextUnformatted($"Materials with Modded skin.shpk: {_shaderReplacementFixer.ModdedSkinShpkCount}"); + ImGui.SameLine(); + ImGui.TextUnformatted($"characterglass.shpk: {_shaderReplacementFixer.ModdedCharacterGlassShpkCount}"); + } - using var table = Table("##ShaderReplacementFixer", 3, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, + using var table = Table("##CharacterUtility", 7, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, -Vector2.UnitX); if (!table) return; - var slowPathCallDeltas = _shaderReplacementFixer.GetAndResetSlowPathCallDeltas(); + for (var idx = 0; idx < CharacterUtility.ReverseIndices.Length; ++idx) + { + var intern = CharacterUtility.ReverseIndices[idx]; + var resource = _characterUtility.Address->Resource(idx); + ImGui.TableNextColumn(); + ImGui.TextUnformatted($"[{idx}]"); + ImGui.TableNextColumn(); + ImGui.TextUnformatted($"0x{(ulong)resource:X}"); + ImGui.TableNextColumn(); + if (resource == null) + { + ImGui.TableNextRow(); + continue; + } - ImGui.TableSetupColumn("Shader Package Name", ImGuiTableColumnFlags.WidthStretch, 0.6f); - ImGui.TableSetupColumn("Materials with Modded ShPk", ImGuiTableColumnFlags.WidthStretch, 0.2f); - ImGui.TableSetupColumn("\u0394 Slow-Path Calls", ImGuiTableColumnFlags.WidthStretch, 0.2f); - ImGui.TableHeadersRow(); + UiHelpers.Text(resource); + ImGui.TableNextColumn(); + var data = (nint)resource->CsHandle.GetData(); + var length = resource->CsHandle.GetLength(); + if (ImGui.Selectable($"0x{data:X}")) + if (data != nint.Zero && length > 0) + ImGui.SetClipboardText(string.Join("\n", + new ReadOnlySpan((byte*)data, (int)length).ToArray().Select(b => b.ToString("X2")))); - ImGui.TableNextColumn(); - ImGui.TextUnformatted("characterglass.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterGlassShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterGlass}"); + ImGuiUtil.HoverTooltip("Click to copy bytes to clipboard."); + ImGui.TableNextColumn(); + ImGui.TextUnformatted(length.ToString()); - ImGui.TableNextColumn(); - ImGui.TextUnformatted("characterlegacy.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterLegacyShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterLegacy}"); + ImGui.TableNextColumn(); + if (intern.Value != -1) + { + ImGui.Selectable($"0x{_characterUtility.DefaultResource(intern).Address:X}"); + if (ImGui.IsItemClicked()) + ImGui.SetClipboardText(string.Join("\n", + new ReadOnlySpan((byte*)_characterUtility.DefaultResource(intern).Address, + _characterUtility.DefaultResource(intern).Size).ToArray().Select(b => b.ToString("X2")))); - ImGui.TableNextColumn(); - ImGui.TextUnformatted("characterocclusion.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterOcclusionShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterOcclusion}"); + ImGuiUtil.HoverTooltip("Click to copy bytes to clipboard."); - ImGui.TableNextColumn(); - ImGui.TextUnformatted("characterstockings.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterStockingsShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterStockings}"); - - ImGui.TableNextColumn(); - ImGui.TextUnformatted("charactertattoo.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterTattooShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterTattoo}"); - - ImGui.TableNextColumn(); - ImGui.TextUnformatted("charactertransparency.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedCharacterTransparencyShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.CharacterTransparency}"); - - ImGui.TableNextColumn(); - ImGui.TextUnformatted("hairmask.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedHairMaskShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.HairMask}"); - - ImGui.TableNextColumn(); - ImGui.TextUnformatted("iris.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedIrisShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.Iris}"); - - ImGui.TableNextColumn(); - ImGui.TextUnformatted("skin.shpk"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{_shaderReplacementFixer.ModdedSkinShpkCount}"); - ImGui.TableNextColumn(); - ImGui.TextUnformatted($"{slowPathCallDeltas.Skin}"); + ImGui.TableNextColumn(); + ImGui.TextUnformatted($"{_characterUtility.DefaultResource(intern).Size}"); + } + else + { + ImGui.TableNextColumn(); + } + } } + private void DrawDebugTabMetaLists() + { + if (!ImGui.CollapsingHeader("Metadata Changes")) + return; + + using var table = Table("##DebugMetaTable", 3, ImGuiTableFlags.SizingFixedFit); + if (!table) + return; + + foreach (var list in _characterUtility.Lists) + { + ImGuiUtil.DrawTableColumn(list.GlobalMetaIndex.ToString()); + ImGuiUtil.DrawTableColumn(list.Entries.Count.ToString()); + ImGuiUtil.DrawTableColumn(string.Join(", ", list.Entries.Select(e => $"0x{e.Data:X}"))); + } + } + + /// Draw information about the resident resource files. + private unsafe void DrawDebugResidentResources() + { + using var tree = TreeNode("Resident Resources"); + if (!tree) + return; + + if (_residentResources.Address == null || _residentResources.Address->NumResources == 0) + return; + + using var table = Table("##ResidentResources", 2, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, + -Vector2.UnitX); + if (!table) + return; + + for (var i = 0; i < _residentResources.Address->NumResources; ++i) + { + var resource = _residentResources.Address->ResourceList[i]; + ImGui.TableNextColumn(); + ImGui.TextUnformatted($"0x{(ulong)resource:X}"); + ImGui.TableNextColumn(); + UiHelpers.Text(resource); + } + } + + private static void DrawCopyableAddress(string label, nint address) + { + using (var _ = PushFont(UiBuilder.MonoFont)) + { + if (ImGui.Selectable($"0x{address:X16} {label}")) + ImGui.SetClipboardText($"{address:X16}"); + } + + ImGuiUtil.HoverTooltip("Click to copy address to clipboard."); + } + + private static unsafe void DrawCopyableAddress(string label, void* address) + => DrawCopyableAddress(label, (nint)address); + /// Draw information about the models, materials and resources currently loaded by the local player. private unsafe void DrawPlayerModelInfo() { - var player = _objects.Objects.LocalPlayer; + var player = _clientState.LocalPlayer; var name = player?.Name.ToString() ?? "NULL"; if (!ImGui.CollapsingHeader($"Player Model Info: {name}##Draw") || player == null) return; - DrawCopyableAddress("PlayerCharacter"u8, player.Address); + DrawCopyableAddress("PlayerCharacter", player.Address); var model = (CharacterBase*)((Character*)player.Address)->GameObject.GetDrawObject(); if (model == null) return; - DrawCopyableAddress("CharacterBase"u8, model); + DrawCopyableAddress("CharacterBase", model); using (var t1 = Table("##table", 2, ImGuiTableFlags.SizingFixedFit)) { if (t1) { ImGuiUtil.DrawTableColumn("Flags"); - ImGuiUtil.DrawTableColumn($"{model->StateFlags}"); + ImGuiUtil.DrawTableColumn($"{model->UnkFlags_01:X2}"); ImGuiUtil.DrawTableColumn("Has Model In Slot Loaded"); ImGuiUtil.DrawTableColumn($"{model->HasModelInSlotLoaded:X8}"); ImGuiUtil.DrawTableColumn("Has Model Files In Slot Loaded"); @@ -1082,14 +895,14 @@ public class DebugTab : Window, ITab, IUiService ImGui.TableNextColumn(); ImGui.TextUnformatted($"Slot {i}"); ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer((nint)imc); + ImGui.TextUnformatted(imc == null ? "NULL" : $"0x{(ulong)imc:X}"); ImGui.TableNextColumn(); if (imc != null) UiHelpers.Text(imc); var mdl = (RenderModel*)model->Models[i]; ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer((nint)mdl); + ImGui.TextUnformatted(mdl == null ? "NULL" : $"0x{(ulong)mdl:X}"); if (mdl == null || mdl->ResourceHandle == null || mdl->ResourceHandle->Category != ResourceCategory.Chara) continue; @@ -1100,67 +913,18 @@ public class DebugTab : Window, ITab, IUiService } } - private string _crcInput = string.Empty; - private FullPath _crcPath = FullPath.Empty; - - private unsafe void DrawCrcCache() + /// Draw information about some game global variables. + private unsafe void DrawGlobalVariableInfo() { - var header = ImUtf8.CollapsingHeader("CRC Cache"u8); + var header = ImGui.CollapsingHeader("Global Variables"); + ImGuiUtil.HoverTooltip("Draw information about global variables. Can provide useful starting points for a memory viewer."); if (!header) return; - if (ImUtf8.InputText("##crcInput"u8, ref _crcInput, "Input path for CRC..."u8)) - _crcPath = new FullPath(_crcInput); - - using var font = ImRaii.PushFont(UiBuilder.MonoFont); - ImUtf8.Text($" CRC32: {_crcPath.InternalName.CiCrc32:X8}"); - ImUtf8.Text($"CI CRC32: {_crcPath.InternalName.Crc32:X8}"); - ImUtf8.Text($" CRC64: {_crcPath.Crc64:X16}"); - - using var table = ImUtf8.Table("table"u8, 2); - if (!table) - return; - - ImUtf8.TableSetupColumn("Hash"u8, ImGuiTableColumnFlags.WidthFixed, 18 * UiBuilder.MonoFont.GetCharAdvance('0')); - ImUtf8.TableSetupColumn("Type"u8, ImGuiTableColumnFlags.WidthFixed, 5 * UiBuilder.MonoFont.GetCharAdvance('0')); - ImGui.TableHeadersRow(); - - foreach (var (hash, type) in _rsfService.CustomCache) - { - ImGui.TableNextColumn(); - ImUtf8.Text($"{hash:X16}"); - ImGui.TableNextColumn(); - ImUtf8.Text($"{type}"); - } - } - - private unsafe void DrawResourceLoader() - { - if (!ImUtf8.CollapsingHeader("Resource Loader"u8)) - return; - - var ongoingLoads = _resourceLoader.OngoingLoads; - var ongoingLoadCount = ongoingLoads.Count; - ImUtf8.Text($"Ongoing Loads: {ongoingLoadCount}"); - - if (ongoingLoadCount == 0) - return; - - using var table = ImUtf8.Table("ongoingLoadTable"u8, 3); - if (!table) - return; - - ImUtf8.TableSetupColumn("Resource Handle"u8, ImGuiTableColumnFlags.WidthStretch, 0.2f); - ImUtf8.TableSetupColumn("Actual Path"u8, ImGuiTableColumnFlags.WidthStretch, 0.4f); - ImUtf8.TableSetupColumn("Original Path"u8, ImGuiTableColumnFlags.WidthStretch, 0.4f); - ImGui.TableHeadersRow(); - - foreach (var (handle, original) in ongoingLoads) - { - ImUtf8.DrawTableColumn($"0x{handle:X}"); - ImUtf8.DrawTableColumn(((ResourceHandle*)handle)->CsHandle.FileName); - ImUtf8.DrawTableColumn(original.Path.Span); - } + DrawCopyableAddress("CharacterUtility", _characterUtility.Address); + DrawCopyableAddress("ResidentResourceManager", _residentResources.Address); + DrawCopyableAddress("Device", Device.Instance()); + DrawDebugResidentResources(); } /// Draw resources with unusual reference count. @@ -1203,55 +967,11 @@ public class DebugTab : Window, ITab, IUiService } - private string _cloudTesterPath = string.Empty; - private bool? _cloudTesterReturn; - private Exception? _cloudTesterError; - - private void DrawCloudApi() - { - if (!ImUtf8.CollapsingHeader("Cloud API"u8)) - return; - - using var id = ImRaii.PushId("CloudApiTester"u8); - - if (ImUtf8.InputText("Path"u8, ref _cloudTesterPath, flags: ImGuiInputTextFlags.EnterReturnsTrue)) - { - try - { - _cloudTesterReturn = CloudApi.IsCloudSynced(_cloudTesterPath); - _cloudTesterError = null; - } - catch (Exception e) - { - _cloudTesterReturn = null; - _cloudTesterError = e; - } - } - - if (_cloudTesterReturn.HasValue) - ImUtf8.Text($"Is Cloud Synced? {_cloudTesterReturn}"); - - if (_cloudTesterError is not null) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGuiColors.DalamudRed); - ImUtf8.Text($"{_cloudTesterError}"); - } - } - - /// Draw information about IPC options and availability. private void DrawDebugTabIpc() { - if (!ImUtf8.CollapsingHeader("IPC"u8)) - return; - - using (var tree = ImUtf8.TreeNode("Dynamis"u8)) - { - if (tree) - Penumbra.Dynamis.DrawDebugInfo(); - } - - _ipcTester.Draw(); + if (ImGui.CollapsingHeader("IPC")) + _ipcTester.Draw(); } /// Helper to print a property and its value in a 2-column table. @@ -1274,14 +994,4 @@ public class DebugTab : Window, ITab, IUiService _config.Ephemeral.DebugSeparateWindow = false; _config.Ephemeral.Save(); } - - public static unsafe void DrawCopyableAddress(ReadOnlySpan label, void* address) - => DrawCopyableAddress(label, (nint)address); - - public static unsafe void DrawCopyableAddress(ReadOnlySpan label, nint address) - { - Penumbra.Dynamis.DrawPointer(address); - ImUtf8.SameLineInner(); - ImUtf8.Text(label); - } } diff --git a/Penumbra/UI/Tabs/Debug/GlobalVariablesDrawer.cs b/Penumbra/UI/Tabs/Debug/GlobalVariablesDrawer.cs deleted file mode 100644 index bc5f0765..00000000 --- a/Penumbra/UI/Tabs/Debug/GlobalVariablesDrawer.cs +++ /dev/null @@ -1,253 +0,0 @@ -using Dalamud.Bindings.ImGui; -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.System.Scheduler; -using FFXIVClientStructs.FFXIV.Client.System.Scheduler.Resource; -using FFXIVClientStructs.Interop; -using FFXIVClientStructs.STD; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Interop.Services; -using Penumbra.Interop.Structs; -using Penumbra.String; -using Penumbra.Util; -using ResidentResourceManager = Penumbra.Interop.Services.ResidentResourceManager; - -namespace Penumbra.UI.Tabs.Debug; - -public unsafe class GlobalVariablesDrawer( - CharacterUtility characterUtility, - ResidentResourceManager residentResources, - SchedulerResourceManagementService scheduler) : IUiService -{ - /// Draw information about some game global variables. - public void Draw() - { - var header = ImUtf8.CollapsingHeader("Global Variables"u8); - ImUtf8.HoverTooltip("Draw information about global variables. Can provide useful starting points for a memory viewer."u8); - if (!header) - return; - - var actionManager = (ActionTimelineManager**)ActionTimelineManager.Instance(); - using (ImUtf8.Group()) - { - Penumbra.Dynamis.DrawPointer(characterUtility.Address); - Penumbra.Dynamis.DrawPointer(residentResources.Address); - Penumbra.Dynamis.DrawPointer(ScheduleManagement.Instance()); - Penumbra.Dynamis.DrawPointer(actionManager); - Penumbra.Dynamis.DrawPointer(actionManager != null ? *actionManager : null); - Penumbra.Dynamis.DrawPointer(scheduler.Address); - Penumbra.Dynamis.DrawPointer(scheduler.Address != null ? *scheduler.Address : null); - Penumbra.Dynamis.DrawPointer(Device.Instance()); - } - - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.Text("CharacterUtility"u8); - ImUtf8.Text("ResidentResourceManager"u8); - ImUtf8.Text("ScheduleManagement"u8); - ImUtf8.Text("ActionTimelineManager*"u8); - ImUtf8.Text("ActionTimelineManager"u8); - ImUtf8.Text("SchedulerResourceManagement*"u8); - ImUtf8.Text("SchedulerResourceManagement"u8); - ImUtf8.Text("Device"u8); - } - - DrawCharacterUtility(); - DrawResidentResources(); - DrawSchedulerResourcesMap(); - DrawSchedulerResourcesList(); - } - - - /// - /// Draw information about the character utility class from SE, - /// displaying all files, their sizes, the default files and the default sizes. - /// - private void DrawCharacterUtility() - { - using var tree = ImUtf8.TreeNode("Character Utility"u8); - if (!tree) - return; - - using var table = ImUtf8.Table("##CharacterUtility"u8, 7, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, - -Vector2.UnitX); - if (!table) - return; - - for (var idx = 0; idx < CharacterUtility.ReverseIndices.Length; ++idx) - { - var intern = CharacterUtility.ReverseIndices[idx]; - var resource = characterUtility.Address->Resource(idx); - ImUtf8.DrawTableColumn($"[{idx}]"); - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(resource); - if (resource == null) - { - ImGui.TableNextRow(); - continue; - } - - ImUtf8.DrawTableColumn(resource->CsHandle.FileName.AsSpan()); - ImGui.TableNextColumn(); - var data = (nint)resource->CsHandle.GetData(); - var length = resource->CsHandle.GetLength(); - Penumbra.Dynamis.DrawPointer(data); - ImUtf8.DrawTableColumn(length.ToString()); - ImGui.TableNextColumn(); - if (intern.Value != -1) - { - Penumbra.Dynamis.DrawPointer(characterUtility.DefaultResource(intern).Address); - ImUtf8.DrawTableColumn($"{characterUtility.DefaultResource(intern).Size}"); - } - else - { - ImGui.TableNextColumn(); - } - } - } - - /// Draw information about the resident resource files. - private void DrawResidentResources() - { - using var tree = ImUtf8.TreeNode("Resident Resources"u8); - if (!tree) - return; - - if (residentResources.Address == null || residentResources.Address->NumResources == 0) - return; - - using var table = ImUtf8.Table("##ResidentResources"u8, 5, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, - -Vector2.UnitX); - if (!table) - return; - - for (var idx = 0; idx < residentResources.Address->NumResources; ++idx) - { - var resource = residentResources.Address->ResourceList[idx]; - ImUtf8.DrawTableColumn($"[{idx}]"); - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(resource); - if (resource == null) - { - ImGui.TableNextRow(); - continue; - } - - ImUtf8.DrawTableColumn(resource->CsHandle.FileName.AsSpan()); - ImGui.TableNextColumn(); - var data = (nint)resource->CsHandle.GetData(); - var length = resource->CsHandle.GetLength(); - Penumbra.Dynamis.DrawPointer(data); - ImUtf8.DrawTableColumn(length.ToString()); - } - } - - private string _schedulerFilterList = string.Empty; - private string _schedulerFilterMap = string.Empty; - private CiByteString _schedulerFilterListU8 = CiByteString.Empty; - private CiByteString _schedulerFilterMapU8 = CiByteString.Empty; - private int _shownResourcesList = 0; - private int _shownResourcesMap = 0; - - private void DrawSchedulerResourcesMap() - { - using var tree = ImUtf8.TreeNode("Scheduler Resources (Map)"u8); - if (!tree) - return; - - if (scheduler.Address == null || scheduler.Scheduler == null) - return; - - if (ImUtf8.InputText("##SchedulerMapFilter"u8, ref _schedulerFilterMap, "Filter..."u8)) - _schedulerFilterMapU8 = CiByteString.FromString(_schedulerFilterMap, out var t, MetaDataComputation.All, false) - ? t - : CiByteString.Empty; - ImUtf8.Text($"{_shownResourcesMap} / {scheduler.Scheduler->Resources.LongCount}"); - using var table = ImUtf8.Table("##SchedulerMapResources"u8, 10, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, - -Vector2.UnitX); - if (!table) - return; - - // TODO Remove cast when it'll have the right type in CS. - var map = (StdMap>*)&scheduler.Scheduler->Resources; - var total = 0; - _shownResourcesMap = 0; - foreach (var (key, resourcePtr) in *map) - { - var resource = resourcePtr.Value; - if (_schedulerFilterMap.Length is 0 || resource->Name.Buffer.IndexOf(_schedulerFilterMapU8.Span) >= 0) - { - ImUtf8.DrawTableColumn($"[{total:D4}]"); - ImUtf8.DrawTableColumn($"{resource->Name.GetField(16)}"); // Unk1 - ImUtf8.DrawTableColumn(new CiByteString(resource->Name.Buffer, MetaDataComputation.None).Span); - ImUtf8.DrawTableColumn($"{resource->Consumers}"); - ImUtf8.DrawTableColumn($"{PointerExtensions.GetField(resource, 120)}"); // key, Unk1 - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(resource); - ImGui.TableNextColumn(); - var resourceHandle = *((ResourceHandle**)resource + 3); - Penumbra.Dynamis.DrawPointer(resourceHandle); - ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable(resourceHandle->FileName().Span); - ImGui.TableNextColumn(); - uint dataLength = 0; - Penumbra.Dynamis.DrawPointer(resource->GetResourceData(&dataLength)); - ImUtf8.DrawTableColumn($"{dataLength}"); - ++_shownResourcesMap; - } - - ++total; - } - } - - private void DrawSchedulerResourcesList() - { - using var tree = ImUtf8.TreeNode("Scheduler Resources (List)"u8); - if (!tree) - return; - - if (scheduler.Address == null || scheduler.Scheduler == null) - return; - - if (ImUtf8.InputText("##SchedulerListFilter"u8, ref _schedulerFilterList, "Filter..."u8)) - _schedulerFilterListU8 = CiByteString.FromString(_schedulerFilterList, out var t, MetaDataComputation.All, false) - ? t - : CiByteString.Empty; - ImUtf8.Text($"{_shownResourcesList} / {scheduler.Scheduler->Resources.LongCount}"); - using var table = ImUtf8.Table("##SchedulerListResources"u8, 10, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit, - -Vector2.UnitX); - if (!table) - return; - - var resource = scheduler.Scheduler->Begin; - var total = 0; - _shownResourcesList = 0; - while (resource != null && total < scheduler.Scheduler->Resources.Count) - { - if (_schedulerFilterList.Length is 0 || resource->Name.Buffer.IndexOf(_schedulerFilterListU8.Span) >= 0) - { - ImUtf8.DrawTableColumn($"[{total:D4}]"); - ImUtf8.DrawTableColumn($"{resource->Name.GetField(16)}"); // Unk1 - ImUtf8.DrawTableColumn(new CiByteString(resource->Name.Buffer, MetaDataComputation.None).Span); - ImUtf8.DrawTableColumn($"{resource->Consumers}"); - ImUtf8.DrawTableColumn($"{PointerExtensions.GetField(resource, 120)}"); // key, Unk1 - ImGui.TableNextColumn(); - Penumbra.Dynamis.DrawPointer(resource); - ImGui.TableNextColumn(); - var resourceHandle = *((ResourceHandle**)resource + 3); - Penumbra.Dynamis.DrawPointer(resourceHandle); - ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable(resourceHandle->FileName().Span); - ImGui.TableNextColumn(); - uint dataLength = 0; - Penumbra.Dynamis.DrawPointer(resource->GetResourceData(&dataLength)); - ImUtf8.DrawTableColumn($"{dataLength}"); - ++_shownResourcesList; - } - - resource = resource->Previous; - ++total; - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/HookOverrideDrawer.cs b/Penumbra/UI/Tabs/Debug/HookOverrideDrawer.cs deleted file mode 100644 index f1024950..00000000 --- a/Penumbra/UI/Tabs/Debug/HookOverrideDrawer.cs +++ /dev/null @@ -1,84 +0,0 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Plugin; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Interop.Hooks; - -namespace Penumbra.UI.Tabs.Debug; - -public class HookOverrideDrawer(IDalamudPluginInterface pluginInterface) : IUiService -{ - private HookOverrides? _overrides; - - public void Draw() - { - using var header = ImUtf8.CollapsingHeaderId("Generate Hook Override"u8); - if (!header) - return; - - _overrides ??= HookOverrides.Instance.Clone(); - - if (ImUtf8.Button("Save"u8)) - _overrides.Write(pluginInterface); - - ImGui.SameLine(); - var path = Path.Combine(pluginInterface.GetPluginConfigDirectory(), HookOverrides.FileName); - var exists = File.Exists(path); - if (ImUtf8.ButtonEx("Delete"u8, disabled: !exists, tooltip: exists ? ""u8 : "File does not exist."u8)) - try - { - File.Delete(path); - } - catch (Exception ex) - { - Penumbra.Log.Error($"Could not delete hook override file at {path}:\n{ex}"); - } - - bool? allVisible = null; - ImGui.SameLine(); - if (ImUtf8.Button("Disable All Visible Hooks"u8)) - allVisible = true; - ImGui.SameLine(); - if (ImUtf8.Button("Enable All VisibleHooks"u8)) - allVisible = false; - - bool? all = null; - ImGui.SameLine(); - if (ImUtf8.Button("Disable All Hooks")) - all = true; - ImGui.SameLine(); - if (ImUtf8.Button("Enable All Hooks")) - all = false; - - foreach (var propertyField in typeof(HookOverrides).GetFields().Where(f => f is { IsStatic: false, FieldType.IsValueType: true })) - { - using var tree = ImUtf8.TreeNode(propertyField.Name); - if (!tree) - { - if (all.HasValue) - { - var property = propertyField.GetValue(_overrides); - foreach (var valueField in propertyField.FieldType.GetFields()) - { - valueField.SetValue(property, all.Value); - propertyField.SetValue(_overrides, property); - } - } - } - else - { - allVisible ??= all; - var property = propertyField.GetValue(_overrides); - foreach (var valueField in propertyField.FieldType.GetFields()) - { - var value = valueField.GetValue(property) as bool? ?? false; - if (ImUtf8.Checkbox($"Disable {valueField.Name}", ref value) || allVisible.HasValue) - { - valueField.SetValue(property, allVisible ?? value); - propertyField.SetValue(_overrides, property); - } - } - } - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/ModMigratorDebug.cs b/Penumbra/UI/Tabs/Debug/ModMigratorDebug.cs deleted file mode 100644 index e6e01107..00000000 --- a/Penumbra/UI/Tabs/Debug/ModMigratorDebug.cs +++ /dev/null @@ -1,55 +0,0 @@ -using Dalamud.Bindings.ImGui; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Services; - -namespace Penumbra.UI.Tabs.Debug; - -public class ModMigratorDebug(ModMigrator migrator) : IUiService -{ - private string _inputPath = string.Empty; - private string _outputPath = string.Empty; - private Task? _indexTask; - private Task? _mdlTask; - - public void Draw() - { - if (!ImUtf8.CollapsingHeaderId("Mod Migrator"u8)) - return; - - ImUtf8.InputText("##input"u8, ref _inputPath, "Input Path..."u8); - ImUtf8.InputText("##output"u8, ref _outputPath, "Output Path..."u8); - - if (ImUtf8.ButtonEx("Create Index Texture"u8, "Requires input to be a path to a normal texture."u8, default, _inputPath.Length == 0 - || _outputPath.Length == 0 - || _indexTask is - { - IsCompleted: false, - })) - _indexTask = migrator.CreateIndexFile(_inputPath, _outputPath); - - if (_indexTask is not null) - { - ImGui.SameLine(); - ImUtf8.TextFrameAligned($"{_indexTask.Status}"); - } - - if (ImUtf8.ButtonEx("Update Model File"u8, "Requires input to be a path to a mdl."u8, default, _inputPath.Length == 0 - || _outputPath.Length == 0 - || _mdlTask is - { - IsCompleted: false, - })) - _mdlTask = Task.Run(() => - { - File.Copy(_inputPath, _outputPath, true); - MigrationManager.TryMigrateSingleModel(_outputPath, false); - }); - - if (_mdlTask is not null) - { - ImGui.SameLine(); - ImUtf8.TextFrameAligned($"{_mdlTask.Status}"); - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/RenderTargetDrawer.cs b/Penumbra/UI/Tabs/Debug/RenderTargetDrawer.cs deleted file mode 100644 index d497f90a..00000000 --- a/Penumbra/UI/Tabs/Debug/RenderTargetDrawer.cs +++ /dev/null @@ -1,98 +0,0 @@ -using Dalamud.Bindings.ImGui; -using FFXIVClientStructs.FFXIV.Client.Graphics.Kernel; -using FFXIVClientStructs.FFXIV.Client.Graphics.Render; -using OtterGui; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Interop.Hooks; -using Penumbra.Interop.Hooks.PostProcessing; -using Penumbra.Services; - -namespace Penumbra.UI.Tabs.Debug; - -public class RenderTargetDrawer(RenderTargetHdrEnabler renderTargetHdrEnabler, DalamudConfigService dalamudConfig, Configuration config) : IUiService -{ - private void DrawStatistics() - { - using (ImUtf8.Group()) - { - ImUtf8.Text("Wait For Plugins (Now)"); - ImUtf8.Text("Wait For Plugins (First Launch)"); - - ImUtf8.Text("HDR Enabled (Now)"); - ImUtf8.Text("HDR Enabled (First Launch)"); - - ImUtf8.Text("HDR Hook Overriden (Now)"); - ImUtf8.Text("HDR Hook Overriden (First Launch)"); - - ImUtf8.Text("HDR Detour Called"); - ImUtf8.Text("Penumbra Reload Count"); - } - ImGui.SameLine(); - using (ImUtf8.Group()) - { - ImUtf8.Text($"{(dalamudConfig.GetDalamudConfig(DalamudConfigService.WaitingForPluginsOption, out bool w) ? w.ToString() : "Unknown")}"); - ImUtf8.Text($"{renderTargetHdrEnabler.FirstLaunchWaitForPluginsState?.ToString() ?? "Unknown"}"); - - ImUtf8.Text($"{config.HdrRenderTargets}"); - ImUtf8.Text($"{renderTargetHdrEnabler.FirstLaunchHdrState}"); - - ImUtf8.Text($"{HookOverrides.Instance.PostProcessing.RenderTargetManagerInitialize}"); - ImUtf8.Text($"{!renderTargetHdrEnabler.FirstLaunchHdrHookOverrideState}"); - - ImUtf8.Text($"{renderTargetHdrEnabler.HdrEnabledSuccess}"); - ImUtf8.Text($"{renderTargetHdrEnabler.PenumbraReloadCount}"); - } - } - - /// Draw information about render targets. - public unsafe void Draw() - { - if (!ImUtf8.CollapsingHeader("Render Targets"u8)) - return; - - DrawStatistics(); - ImUtf8.Dummy(0); - ImGui.Separator(); - ImUtf8.Dummy(0); - var report = renderTargetHdrEnabler.TextureReport; - if (report == null) - { - ImUtf8.Text("The RenderTargetManager report has not been gathered."u8); - ImUtf8.Text("Please restart the game with Debug Mode and Wait for Plugins on Startup enabled to fill this section."u8); - return; - } - - using var table = ImUtf8.Table("##RenderTargetTable"u8, 5, ImGuiTableFlags.RowBg | ImGuiTableFlags.SizingFixedFit); - if (!table) - return; - - ImUtf8.TableSetupColumn("Offset"u8, ImGuiTableColumnFlags.WidthStretch, 0.15f); - ImUtf8.TableSetupColumn("Creation Order"u8, ImGuiTableColumnFlags.WidthStretch, 0.15f); - ImUtf8.TableSetupColumn("Original Texture Format"u8, ImGuiTableColumnFlags.WidthStretch, 0.2f); - ImUtf8.TableSetupColumn("Current Texture Format"u8, ImGuiTableColumnFlags.WidthStretch, 0.2f); - ImUtf8.TableSetupColumn("Comment"u8, ImGuiTableColumnFlags.WidthStretch, 0.3f); - ImGui.TableHeadersRow(); - - foreach (var record in report) - { - ImUtf8.DrawTableColumn($"0x{record.Offset:X}"); - ImUtf8.DrawTableColumn($"{record.CreationOrder}"); - ImUtf8.DrawTableColumn($"{record.OriginalTextureFormat}"); - ImGui.TableNextColumn(); - var texture = *(Texture**)((nint)RenderTargetManager.Instance() - + record.Offset); - if (texture != null) - { - using var color = Dalamud.Interface.Utility.Raii.ImRaii.PushColor(ImGuiCol.Text, ImGuiUtil.HalfBlendText(0xFF), - texture->TextureFormat != record.OriginalTextureFormat); - ImUtf8.Text($"{texture->TextureFormat}"); - } - - ImGui.TableNextColumn(); - var forcedConfig = RenderTargetHdrEnabler.GetForcedTextureConfig(record.CreationOrder); - if (forcedConfig.HasValue) - ImUtf8.Text(forcedConfig.Value.Comment); - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/ShapeInspector.cs b/Penumbra/UI/Tabs/Debug/ShapeInspector.cs deleted file mode 100644 index 4c3b43bf..00000000 --- a/Penumbra/UI/Tabs/Debug/ShapeInspector.cs +++ /dev/null @@ -1,284 +0,0 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface; -using Dalamud.Interface.Utility.Raii; -using OtterGui.Extensions; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.Collections.Cache; -using Penumbra.GameData.Enums; -using Penumbra.GameData.Interop; -using Penumbra.Interop.PathResolving; -using Penumbra.Meta; -using Penumbra.Meta.Manipulations; - -namespace Penumbra.UI.Tabs.Debug; - -public class ShapeInspector(ObjectManager objects, CollectionResolver resolver) : IUiService -{ - private int _objectIndex; - - public void Draw() - { - ImUtf8.InputScalar("Object Index"u8, ref _objectIndex); - var actor = objects[0]; - if (!actor.IsCharacter) - { - ImUtf8.Text("No valid character."u8); - return; - } - - var human = actor.Model; - if (!human.IsHuman) - { - ImUtf8.Text("No valid character."u8); - return; - } - - DrawCollectionShapeCache(actor); - DrawCharacterShapes(human); - DrawCollectionAttributeCache(actor); - DrawCharacterAttributes(human); - } - - private unsafe void DrawCollectionAttributeCache(Actor actor) - { - var data = resolver.IdentifyCollection(actor.AsObject, true); - using var treeNode1 = ImUtf8.TreeNode($"Collection Attribute Cache ({data.ModCollection})"); - if (!treeNode1.Success || !data.ModCollection.HasCache) - return; - - using var table = ImUtf8.Table("##aCache"u8, 2, ImGuiTableFlags.RowBg); - if (!table) - return; - - ImUtf8.TableSetupColumn("Attribute"u8, ImGuiTableColumnFlags.WidthFixed, 150 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("State"u8, ImGuiTableColumnFlags.WidthStretch); - - ImGui.TableHeadersRow(); - foreach (var (attribute, set) in data.ModCollection.MetaCache!.Atr.Data.OrderBy(a => a.Key)) - { - ImUtf8.DrawTableColumn(attribute.AsSpan); - DrawValues(attribute, set); - } - } - - private unsafe void DrawCollectionShapeCache(Actor actor) - { - var data = resolver.IdentifyCollection(actor.AsObject, true); - using var treeNode1 = ImUtf8.TreeNode($"Collection Shape Cache ({data.ModCollection})"); - if (!treeNode1.Success || !data.ModCollection.HasCache) - return; - - using var table = ImUtf8.Table("##sCache"u8, 3, ImGuiTableFlags.RowBg); - if (!table) - return; - - ImUtf8.TableSetupColumn("Condition"u8, ImGuiTableColumnFlags.WidthFixed, 150 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Shape"u8, ImGuiTableColumnFlags.WidthFixed, 150 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("State"u8, ImGuiTableColumnFlags.WidthStretch); - - ImGui.TableHeadersRow(); - foreach (var condition in Enum.GetValues()) - { - foreach (var (shape, set) in data.ModCollection.MetaCache!.Shp.State(condition).OrderBy(shp => shp.Key)) - { - ImUtf8.DrawTableColumn(condition.ToString()); - ImUtf8.DrawTableColumn(shape.AsSpan); - DrawValues(shape, set); - } - } - } - - private static void DrawValues(in ShapeAttributeString shapeAttribute, ShapeAttributeHashSet set) - { - ImGui.TableNextColumn(); - - if (set.All is { } value) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !value); - ImUtf8.Text("All, "u8); - ImGui.SameLine(0, 0); - } - - foreach (var slot in ShapeAttributeManager.UsedModels) - { - if (set[slot] is not { } value2) - continue; - - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !value2); - ImUtf8.Text($"All {slot.ToName()}, "); - ImGui.SameLine(0, 0); - } - - foreach (var gr in ShapeAttributeHashSet.GenderRaceValues.Skip(1)) - { - if (set[gr] is { } value3) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !value3); - ImUtf8.Text($"All {gr.ToName()}, "); - ImGui.SameLine(0, 0); - } - else - { - foreach (var slot in ShapeAttributeManager.UsedModels) - { - if (set[slot, gr] is not { } value4) - continue; - - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !value4); - ImUtf8.Text($"All {gr.ToName()} {slot.ToName()}, "); - ImGui.SameLine(0, 0); - } - } - } - - foreach (var ((slot, id), flags) in set) - { - if ((flags & 3) is not 0) - { - var enabled = (flags & 1) is 1; - - if (set[slot, GenderRace.Unknown] != enabled) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !enabled); - ImUtf8.Text($"{slot.ToName()} {id.Id:D4}, "); - ImGui.SameLine(0, 0); - } - } - else - { - var currentIndex = BitOperations.TrailingZeroCount(flags) / 2; - var currentFlags = flags >> (2 * currentIndex); - while (currentIndex < ShapeAttributeHashSet.GenderRaceValues.Count) - { - var enabled = (currentFlags & 1) is 1; - var gr = ShapeAttributeHashSet.GenderRaceValues[currentIndex]; - if (set[slot, gr] != enabled) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, ImGui.GetColorU32(ImGuiCol.TextDisabled), !enabled); - ImUtf8.Text($"{gr.ToName()} {slot.ToName()} #{id.Id:D4}, "); - ImGui.SameLine(0, 0); - } - - currentFlags &= ~0x3u; - currentIndex += BitOperations.TrailingZeroCount(currentFlags) / 2; - currentFlags = flags >> (2 * currentIndex); - } - } - } - } - - private unsafe void DrawCharacterShapes(Model human) - { - using var treeNode2 = ImUtf8.TreeNode("Character Model Shapes"u8); - if (!treeNode2) - return; - - using var table = ImUtf8.Table("##shapes"u8, 7, ImGuiTableFlags.RowBg); - if (!table) - return; - - ImUtf8.TableSetupColumn("#"u8, ImGuiTableColumnFlags.WidthFixed, 25 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Slot"u8, ImGuiTableColumnFlags.WidthFixed, 150 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Address"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 14); - ImUtf8.TableSetupColumn("Mask"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 8); - ImUtf8.TableSetupColumn("ID"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 4); - ImUtf8.TableSetupColumn("Count"u8, ImGuiTableColumnFlags.WidthFixed, 30 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Shapes"u8, ImGuiTableColumnFlags.WidthStretch); - - ImGui.TableHeadersRow(); - - var disabledColor = ImGui.GetColorU32(ImGuiCol.TextDisabled); - for (var i = 0; i < human.AsHuman->SlotCount; ++i) - { - ImUtf8.DrawTableColumn($"{(uint)i:D2}"); - ImUtf8.DrawTableColumn(((HumanSlot)i).ToName()); - - ImGui.TableNextColumn(); - var model = human.AsHuman->Models[i]; - Penumbra.Dynamis.DrawPointer((nint)model); - if (model is not null) - { - var mask = model->EnabledShapeKeyIndexMask; - ImUtf8.DrawTableColumn($"{mask:X8}"); - ImUtf8.DrawTableColumn($"{human.GetModelId((HumanSlot)i):D4}"); - ImUtf8.DrawTableColumn($"{model->ModelResourceHandle->Shapes.Count}"); - ImGui.TableNextColumn(); - foreach (var ((shape, flag), idx) in model->ModelResourceHandle->Shapes.WithIndex()) - { - var disabled = (mask & (1u << flag)) is 0; - using var color = ImRaii.PushColor(ImGuiCol.Text, disabledColor, disabled); - ImUtf8.Text(shape.AsSpan()); - ImGui.SameLine(0, 0); - ImUtf8.Text(", "u8); - if (idx % 8 < 7) - ImGui.SameLine(0, 0); - } - } - else - { - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - } - } - } - - private unsafe void DrawCharacterAttributes(Model human) - { - using var treeNode2 = ImUtf8.TreeNode("Character Model Attributes"u8); - if (!treeNode2) - return; - - using var table = ImUtf8.Table("##attributes"u8, 7, ImGuiTableFlags.RowBg); - if (!table) - return; - - ImUtf8.TableSetupColumn("#"u8, ImGuiTableColumnFlags.WidthFixed, 25 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Slot"u8, ImGuiTableColumnFlags.WidthFixed, 150 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Address"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 14); - ImUtf8.TableSetupColumn("Mask"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 8); - ImUtf8.TableSetupColumn("ID"u8, ImGuiTableColumnFlags.WidthFixed, UiBuilder.MonoFont.GetCharAdvance('0') * 4); - ImUtf8.TableSetupColumn("Count"u8, ImGuiTableColumnFlags.WidthFixed, 30 * ImUtf8.GlobalScale); - ImUtf8.TableSetupColumn("Attributes"u8, ImGuiTableColumnFlags.WidthStretch); - - ImGui.TableHeadersRow(); - - var disabledColor = ImGui.GetColorU32(ImGuiCol.TextDisabled); - for (var i = 0; i < human.AsHuman->SlotCount; ++i) - { - ImUtf8.DrawTableColumn($"{(uint)i:D2}"); - ImUtf8.DrawTableColumn(((HumanSlot)i).ToName()); - - ImGui.TableNextColumn(); - var model = human.AsHuman->Models[i]; - Penumbra.Dynamis.DrawPointer((nint)model); - if (model is not null) - { - var mask = model->EnabledAttributeIndexMask; - ImUtf8.DrawTableColumn($"{mask:X8}"); - ImUtf8.DrawTableColumn($"{human.GetModelId((HumanSlot)i):D4}"); - ImUtf8.DrawTableColumn($"{model->ModelResourceHandle->Attributes.Count}"); - ImGui.TableNextColumn(); - foreach (var ((attribute, flag), idx) in model->ModelResourceHandle->Attributes.WithIndex()) - { - var disabled = (mask & (1u << flag)) is 0; - using var color = ImRaii.PushColor(ImGuiCol.Text, disabledColor, disabled); - ImUtf8.Text(attribute.AsSpan()); - ImGui.SameLine(0, 0); - ImUtf8.Text(", "u8); - if (idx % 8 < 7) - ImGui.SameLine(0, 0); - } - } - else - { - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - ImGui.TableNextColumn(); - } - } - } -} diff --git a/Penumbra/UI/Tabs/Debug/TexHeaderDrawer.cs b/Penumbra/UI/Tabs/Debug/TexHeaderDrawer.cs deleted file mode 100644 index 4244e455..00000000 --- a/Penumbra/UI/Tabs/Debug/TexHeaderDrawer.cs +++ /dev/null @@ -1,117 +0,0 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Interface.DragDrop; -using Dalamud.Interface.Utility.Raii; -using Lumina.Data.Files; -using OtterGui.Services; -using OtterGui.Text; -using Penumbra.UI.Classes; - -namespace Penumbra.UI.Tabs.Debug; - -public class TexHeaderDrawer(IDragDropManager dragDrop) : IUiService -{ - private string? _path; - private TexFile.TexHeader _header; - private byte[]? _tex; - private Exception? _exception; - - public void Draw() - { - using var header = ImUtf8.CollapsingHeaderId("Tex Header"u8); - if (!header) - return; - - DrawDragDrop(); - DrawData(); - } - - private void DrawDragDrop() - { - dragDrop.CreateImGuiSource("TexFileDragDrop", m => m.Files.Count == 1 && m.Extensions.Contains(".tex"), m => - { - ImUtf8.Text($"Dragging {m.Files[0]}..."); - return true; - }); - - ImUtf8.Button("Drag .tex here..."); - if (dragDrop.CreateImGuiTarget("TexFileDragDrop", out var files, out _)) - ReadTex(files[0]); - } - - private void DrawData() - { - if (_path == null) - return; - - ImUtf8.TextFramed(_path, 0, borderColor: 0xFFFFFFFF); - - - if (_exception != null) - { - using var color = ImRaii.PushColor(ImGuiCol.Text, Colors.RegexWarningBorder); - ImUtf8.TextWrapped($"Failure to load file:\n{_exception}"); - } - else if (_tex != null) - { - using var table = ImRaii.Table("table", 2, ImGuiTableFlags.SizingFixedFit | ImGuiTableFlags.RowBg); - if (!table) - return; - - TableLine("Format"u8, _header.Format); - TableLine("Width"u8, _header.Width); - TableLine("Height"u8, _header.Height); - TableLine("Depth"u8, _header.Depth); - TableLine("Mip Levels"u8, _header.MipCount); - TableLine("Array Size"u8, _header.ArraySize); - TableLine("Type"u8, _header.Type); - TableLine("Mip Flag"u8, _header.MipUnknownFlag); - TableLine("Byte Size"u8, _tex.Length); - unsafe - { - TableLine("LoD Offset 0"u8, _header.LodOffset[0]); - TableLine("LoD Offset 1"u8, _header.LodOffset[1]); - TableLine("LoD Offset 2"u8, _header.LodOffset[2]); - TableLine("LoD Offset 0"u8, _header.OffsetToSurface[0]); - TableLine("LoD Offset 1"u8, _header.OffsetToSurface[1]); - TableLine("LoD Offset 2"u8, _header.OffsetToSurface[2]); - TableLine("LoD Offset 3"u8, _header.OffsetToSurface[3]); - TableLine("LoD Offset 4"u8, _header.OffsetToSurface[4]); - TableLine("LoD Offset 5"u8, _header.OffsetToSurface[5]); - TableLine("LoD Offset 6"u8, _header.OffsetToSurface[6]); - TableLine("LoD Offset 7"u8, _header.OffsetToSurface[7]); - TableLine("LoD Offset 8"u8, _header.OffsetToSurface[8]); - TableLine("LoD Offset 9"u8, _header.OffsetToSurface[9]); - TableLine("LoD Offset 10"u8, _header.OffsetToSurface[10]); - TableLine("LoD Offset 11"u8, _header.OffsetToSurface[11]); - TableLine("LoD Offset 12"u8, _header.OffsetToSurface[12]); - } - } - } - - private static void TableLine(ReadOnlySpan text, T value) - { - ImGui.TableNextColumn(); - ImUtf8.Text(text); - ImGui.TableNextColumn(); - ImUtf8.Text($"{value}"); - } - - private unsafe void ReadTex(string path) - { - try - { - _path = path; - _tex = File.ReadAllBytes(_path); - if (_tex.Length < sizeof(TexFile.TexHeader)) - throw new Exception($"Size {_tex.Length} does not include a header."); - - _header = MemoryMarshal.Read(_tex); - _exception = null; - } - catch (Exception ex) - { - _tex = null; - _exception = ex; - } - } -} diff --git a/Penumbra/UI/Tabs/EffectiveTab.cs b/Penumbra/UI/Tabs/EffectiveTab.cs index 5691f821..37561000 100644 --- a/Penumbra/UI/Tabs/EffectiveTab.cs +++ b/Penumbra/UI/Tabs/EffectiveTab.cs @@ -1,10 +1,8 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Collections; using Penumbra.Collections.Cache; @@ -17,7 +15,7 @@ using Penumbra.UI.Classes; namespace Penumbra.UI.Tabs; public class EffectiveTab(CollectionManager collectionManager, CollectionSelectHeader collectionHeader) - : ITab, IUiService + : ITab { public ReadOnlySpan Label => "Effective Changes"u8; @@ -27,7 +25,7 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH SetupEffectiveSizes(); collectionHeader.Draw(true); DrawFilters(); - using var child = ImRaii.Child("##EffectiveChangesTab", ImGui.GetContentRegionAvail(), false); + using var child = ImRaii.Child("##EffectiveChangesTab", -Vector2.One, false); if (!child) return; @@ -100,7 +98,7 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH // Filters mean we can not use the known counts. if (hasFilters) { - var it2 = m.IdentifierSources.Select(p => (p.Item1.ToString(), p.Item2.Name)); + var it2 = m.Select(p => (p.Key.ToString(), p.Value.Name)); if (stop >= 0) { ImGuiClip.DrawEndDummy(stop + it2.Count(CheckFilters), height); @@ -119,7 +117,7 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH } else { - stop = ImGuiClip.ClippedDraw(m.IdentifierSources, skips, DrawLine, m.Count, ~stop); + stop = ImGuiClip.ClippedDraw(m, skips, DrawLine, m.Count, ~stop); ImGuiClip.DrawEndDummy(stop, height); } } @@ -135,12 +133,12 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH { var (path, name) = pair; ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable(path.Path.Span); + UiHelpers.CopyOnClickSelectable(path.Path); ImGui.TableNextColumn(); ImGuiUtil.PrintIcon(FontAwesomeIcon.LongArrowAltLeft); ImGui.TableNextColumn(); - ImUtf8.CopyOnClickSelectable(name.Path.InternalName.Span); + UiHelpers.CopyOnClickSelectable(name.Path.InternalName); ImGuiUtil.HoverTooltip($"\nChanged by {name.Mod.Name}."); } @@ -154,11 +152,11 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH ImGui.TableNextColumn(); ImGuiUtil.PrintIcon(FontAwesomeIcon.LongArrowAltLeft); ImGui.TableNextColumn(); - ImGuiUtil.CopyOnClickSelectable(name.Text); + ImGuiUtil.CopyOnClickSelectable(name); } /// Draw a line for a unfiltered/unconverted manipulation and mod-index pair. - private static void DrawLine((IMetaIdentifier, IMod) pair) + private static void DrawLine(KeyValuePair pair) { var (manipulation, mod) = pair; ImGui.TableNextColumn(); @@ -167,7 +165,7 @@ public class EffectiveTab(CollectionManager collectionManager, CollectionSelectH ImGui.TableNextColumn(); ImGuiUtil.PrintIcon(FontAwesomeIcon.LongArrowAltLeft); ImGui.TableNextColumn(); - ImGuiUtil.CopyOnClickSelectable(mod.Name.Text); + ImGuiUtil.CopyOnClickSelectable(mod.Name); } /// Check filters for file replacements. diff --git a/Penumbra/UI/Tabs/MessagesTab.cs b/Penumbra/UI/Tabs/MessagesTab.cs index 190f9407..abaf2ba6 100644 --- a/Penumbra/UI/Tabs/MessagesTab.cs +++ b/Penumbra/UI/Tabs/MessagesTab.cs @@ -1,10 +1,9 @@ -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Services; namespace Penumbra.UI.Tabs; -public class MessagesTab(MessageService messages) : ITab, IUiService +public class MessagesTab(MessageService messages) : ITab { public ReadOnlySpan Label => "Messages"u8; diff --git a/Penumbra/UI/Tabs/ModsTab.cs b/Penumbra/UI/Tabs/ModsTab.cs index 1d24c597..e4d94bb5 100644 --- a/Penumbra/UI/Tabs/ModsTab.cs +++ b/Penumbra/UI/Tabs/ModsTab.cs @@ -1,12 +1,11 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Game.ClientState.Objects; +using ImGuiNET; using OtterGui; using OtterGui.Raii; using Penumbra.UI.Classes; using Dalamud.Interface; using Dalamud.Plugin.Services; -using FFXIVClientStructs.FFXIV.Client.Game; -using OtterGui.Services; +using FFXIVClientStructs.FFXIV.Client.Game.Housing; using OtterGui.Widgets; using Penumbra.Api.Enums; using Penumbra.Interop.Services; @@ -27,10 +26,11 @@ public class ModsTab( TutorialService tutorial, RedrawService redrawService, Configuration config, + IClientState clientState, CollectionSelectHeader collectionHeader, ITargetManager targets, ObjectManager objects) - : ITab, IUiService + : ITab { private readonly ActiveCollections _activeCollections = collectionManager.Active; @@ -52,14 +52,14 @@ public class ModsTab( { try { - selector.Draw(); + selector.Draw(GetModSelectorSize(config)); ImGui.SameLine(); - ImGui.SetCursorPosX(MathF.Round(ImGui.GetCursorPosX())); using var group = ImRaii.Group(); collectionHeader.Draw(false); using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, Vector2.Zero); - using (var child = ImRaii.Child("##ModsTabMod", new Vector2(ImGui.GetContentRegionAvail().X, config.HideRedrawBar ? 0 : -ImGui.GetFrameHeight()), + + using (var child = ImRaii.Child("##ModsTabMod", new Vector2(-1, config.HideRedrawBar ? 0 : -ImGui.GetFrameHeight()), true, ImGuiWindowFlags.HorizontalScrollbar)) { style.Pop(); @@ -76,15 +76,29 @@ public class ModsTab( { Penumbra.Log.Error($"Exception thrown during ModPanel Render:\n{e}"); Penumbra.Log.Error($"{modManager.Count} Mods\n" - + $"{_activeCollections.Current.Identity.AnonymizedName} Current Collection\n" + + $"{_activeCollections.Current.AnonymizedName} Current Collection\n" + $"{_activeCollections.Current.Settings.Count} Settings\n" + $"{selector.SortMode.Name} Sort Mode\n" + $"{selector.SelectedLeaf?.Name ?? "NULL"} Selected Leaf\n" + $"{selector.Selected?.Name ?? "NULL"} Selected Mod\n" - + $"{string.Join(", ", _activeCollections.Current.Inheritance.DirectlyInheritsFrom.Select(c => c.Identity.AnonymizedName))} Inheritances\n"); + + $"{string.Join(", ", _activeCollections.Current.DirectlyInheritsFrom.Select(c => c.AnonymizedName))} Inheritances\n" + + $"{selector.SelectedSettingCollection.AnonymizedName} Collection\n"); } } + /// Get the correct size for the mod selector based on current config. + public static float GetModSelectorSize(Configuration config) + { + var absoluteSize = Math.Clamp(config.ModSelectorAbsoluteSize, Configuration.Constants.MinAbsoluteSize, + Math.Min(Configuration.Constants.MaxAbsoluteSize, ImGui.GetContentRegionAvail().X - 100)); + var relativeSize = config.ScaleModSelector + ? Math.Clamp(config.ModSelectorScaledSize, Configuration.Constants.MinScaledSize, Configuration.Constants.MaxScaledSize) + : 0; + return !config.ScaleModSelector + ? absoluteSize + : Math.Max(absoluteSize, relativeSize * ImGui.GetContentRegionAvail().X / 100); + } + private void DrawRedrawLine() { if (config.HideRedrawBar) @@ -112,7 +126,7 @@ public class ModsTab( ImGui.SetTooltip($"The supported modifiers for '/penumbra redraw' are:\n{TutorialService.SupportedRedrawModifiers}"); using var id = ImRaii.PushId("Redraw"); - using var disabled = ImRaii.Disabled(objects.Objects.LocalPlayer is null); + using var disabled = ImRaii.Disabled(clientState.LocalPlayer == null); ImGui.SameLine(); var buttonWidth = frameHeight with { X = ImGui.GetContentRegionAvail().X / 5 }; var tt = !objects[0].Valid diff --git a/Penumbra/UI/Tabs/OnScreenTab.cs b/Penumbra/UI/Tabs/OnScreenTab.cs index fa33f702..09772d8e 100644 --- a/Penumbra/UI/Tabs/OnScreenTab.cs +++ b/Penumbra/UI/Tabs/OnScreenTab.cs @@ -1,12 +1,19 @@ -using OtterGui.Services; using OtterGui.Widgets; +using Penumbra.Interop.ResourceTree; using Penumbra.UI.AdvancedWindow; namespace Penumbra.UI.Tabs; -public class OnScreenTab(ResourceTreeViewerFactory resourceTreeViewerFactory) : ITab, IUiService +public class OnScreenTab : ITab { - private readonly ResourceTreeViewer _viewer = resourceTreeViewerFactory.Create(0, delegate { }, delegate { }); + private readonly Configuration _config; + private readonly ResourceTreeViewer _viewer; + + public OnScreenTab(Configuration config, ResourceTreeFactory treeFactory, ChangedItemDrawer changedItemDrawer) + { + _config = config; + _viewer = new ResourceTreeViewer(_config, treeFactory, changedItemDrawer, 0, delegate { }, delegate { }); + } public ReadOnlySpan Label => "On-Screen"u8; diff --git a/Penumbra/UI/Tabs/ResourceTab.cs b/Penumbra/UI/Tabs/ResourceTab.cs index 2223075d..bbb0561b 100644 --- a/Penumbra/UI/Tabs/ResourceTab.cs +++ b/Penumbra/UI/Tabs/ResourceTab.cs @@ -1,20 +1,19 @@ -using Dalamud.Bindings.ImGui; -using Dalamud.Plugin.Services; +using Dalamud.Game; using FFXIVClientStructs.FFXIV.Client.System.Resource; using FFXIVClientStructs.FFXIV.Client.System.Resource.Handle; using FFXIVClientStructs.Interop; using FFXIVClientStructs.STD; +using ImGuiNET; using OtterGui; using OtterGui.Raii; -using OtterGui.Services; using OtterGui.Widgets; -using Penumbra.Interop.Hooks.ResourceLoading; +using Penumbra.Interop.ResourceLoading; using Penumbra.String.Classes; namespace Penumbra.UI.Tabs; public class ResourceTab(Configuration config, ResourceManagerService resourceManager, ISigScanner sigScanner) - : ITab, IUiService + : ITab { public ReadOnlySpan Label => "Resource Manager"u8; @@ -81,7 +80,7 @@ public class ResourceTab(Configuration config, ResourceManagerService resourceMa return; var address = $"0x{(ulong)r:X}"; - ImGuiUtil.DrawTableColumn($"0x{hash:X8}"); + ImGuiUtil.TextNextColumn($"0x{hash:X8}"); ImGui.TableNextColumn(); ImGuiUtil.CopyOnClickSelectable(address); @@ -101,7 +100,7 @@ public class ResourceTab(Configuration config, ResourceManagerService resourceMa ImGuiUtil.HoverTooltip("Click to copy byte-wise file data to clipboard, if any."); - ImGuiUtil.DrawTableColumn(r->RefCount.ToString()); + ImGuiUtil.TextNextColumn(r->RefCount.ToString()); }); } @@ -121,7 +120,7 @@ public class ResourceTab(Configuration config, ResourceManagerService resourceMa } /// Obtain a label for an extension node. - private static string GetNodeLabel(uint label, uint type, int count) + private static string GetNodeLabel(uint label, uint type, ulong count) { var (lowest, mid1, mid2, highest) = Functions.SplitBytes(type); return highest == 0 diff --git a/Penumbra/UI/Tabs/SettingsTab.cs b/Penumbra/UI/Tabs/SettingsTab.cs index 09c7c58d..30384538 100644 --- a/Penumbra/UI/Tabs/SettingsTab.cs +++ b/Penumbra/UI/Tabs/SettingsTab.cs @@ -1,31 +1,25 @@ -using Dalamud.Bindings.ImGui; using Dalamud.Interface; using Dalamud.Interface.Components; using Dalamud.Interface.Utility; using Dalamud.Plugin; using Dalamud.Plugin.Services; using Dalamud.Utility; +using ImGuiNET; using OtterGui; using OtterGui.Compression; using OtterGui.Custom; using OtterGui.Raii; -using OtterGui.Services; -using OtterGui.Text; using OtterGui.Widgets; using Penumbra.Api; -using Penumbra.Collections; -using Penumbra.Interop; -using Penumbra.Interop.Hooks.PostProcessing; using Penumbra.Interop.Services; using Penumbra.Mods.Manager; using Penumbra.Services; using Penumbra.UI.Classes; -using Penumbra.UI.Integration; using Penumbra.UI.ModsTab; namespace Penumbra.UI.Tabs; -public class SettingsTab : ITab, IUiService +public class SettingsTab : ITab { public const int RootDirectoryMaxLength = 64; @@ -38,7 +32,6 @@ public class SettingsTab : ITab, IUiService private readonly Penumbra _penumbra; private readonly FileDialogService _fileDialog; private readonly ModManager _modManager; - private readonly FileWatcher _fileWatcher; private readonly ModExportManager _modExportManager; private readonly ModFileSystemSelector _selector; private readonly CharacterUtility _characterUtility; @@ -47,33 +40,21 @@ public class SettingsTab : ITab, IUiService private readonly DalamudSubstitutionProvider _dalamudSubstitutionProvider; private readonly FileCompactor _compactor; private readonly DalamudConfigService _dalamudConfig; - private readonly IDalamudPluginInterface _pluginInterface; + private readonly DalamudPluginInterface _pluginInterface; private readonly IDataManager _gameData; private readonly PredefinedTagManager _predefinedTagManager; private readonly CrashHandlerService _crashService; - private readonly MigrationSectionDrawer _migrationDrawer; - private readonly CollectionAutoSelector _autoSelector; - private readonly CleanupService _cleanupService; - private readonly AttributeHook _attributeHook; - private readonly PcpService _pcpService; - private readonly IntegrationSettingsRegistry _integrationSettings; private int _minimumX = int.MaxValue; private int _minimumY = int.MaxValue; private readonly TagButtons _sharedTags = new(); - private string _lastCloudSyncTestedPath = string.Empty; - private bool _lastCloudSyncTestResult = false; - - public SettingsTab(IDalamudPluginInterface pluginInterface, Configuration config, FontReloader fontReloader, TutorialService tutorial, + public SettingsTab(DalamudPluginInterface pluginInterface, Configuration config, FontReloader fontReloader, TutorialService tutorial, Penumbra penumbra, FileDialogService fileDialog, ModManager modManager, ModFileSystemSelector selector, - CharacterUtility characterUtility, ResidentResourceManager residentResources, ModExportManager modExportManager, - FileWatcher fileWatcher, HttpApi httpApi, + CharacterUtility characterUtility, ResidentResourceManager residentResources, ModExportManager modExportManager, HttpApi httpApi, DalamudSubstitutionProvider dalamudSubstitutionProvider, FileCompactor compactor, DalamudConfigService dalamudConfig, - IDataManager gameData, PredefinedTagManager predefinedTagConfig, CrashHandlerService crashService, - MigrationSectionDrawer migrationDrawer, CollectionAutoSelector autoSelector, CleanupService cleanupService, - AttributeHook attributeHook, PcpService pcpService, IntegrationSettingsRegistry integrationSettings) + IDataManager gameData, PredefinedTagManager predefinedTagConfig, CrashHandlerService crashService) { _pluginInterface = pluginInterface; _config = config; @@ -86,7 +67,6 @@ public class SettingsTab : ITab, IUiService _characterUtility = characterUtility; _residentResources = residentResources; _modExportManager = modExportManager; - _fileWatcher = fileWatcher; _httpApi = httpApi; _dalamudSubstitutionProvider = dalamudSubstitutionProvider; _compactor = compactor; @@ -96,12 +76,6 @@ public class SettingsTab : ITab, IUiService _compactor.Enabled = _config.UseFileSystemCompression; _predefinedTagManager = predefinedTagConfig; _crashService = crashService; - _migrationDrawer = migrationDrawer; - _autoSelector = autoSelector; - _cleanupService = cleanupService; - _attributeHook = attributeHook; - _pcpService = pcpService; - _integrationSettings = integrationSettings; } public void DrawHeader() @@ -125,14 +99,11 @@ public class SettingsTab : ITab, IUiService DrawRootFolder(); DrawDirectoryButtons(); ImGui.NewLine(); - ImGui.NewLine(); DrawGeneralSettings(); - _migrationDrawer.Draw(); DrawColorSettings(); DrawPredefinedTagsSection(); DrawAdvancedSettings(); - _integrationSettings.Draw(); DrawSupportButtons(); } @@ -219,15 +190,6 @@ public class SettingsTab : ITab, IUiService if (IsSubPathOf(gameDir, newName)) return ("Path is not allowed to be inside your game folder.", false); - if (_lastCloudSyncTestedPath != newName) - { - _lastCloudSyncTestResult = CloudApi.IsCloudSynced(newName); - _lastCloudSyncTestedPath = newName; - } - - if (_lastCloudSyncTestResult) - return ("Path is not allowed to be cloud-synced.", false); - return selected ? ($"Press Enter or Click Here to Save (Current Directory: {old})", true) : ($"Click Here to Save (Current Directory: {old})", true); @@ -307,7 +269,7 @@ public class SettingsTab : ITab, IUiService if (_config.ModDirectory != _newModDirectory && _newModDirectory.Length != 0 && DrawPressEnterWarning(_newModDirectory, _config.ModDirectory, pos, save, selected)) - _modManager.DiscoverMods(_newModDirectory, out _newModDirectory); + _modManager.DiscoverMods(_newModDirectory); } /// Draw the Open Directory and Rediscovery buttons. @@ -360,9 +322,6 @@ public class SettingsTab : ITab, IUiService UiHelpers.DefaultLineSpace(); DrawModHandlingSettings(); - UiHelpers.DefaultLineSpace(); - - DrawModEditorSettings(); ImGui.NewLine(); } @@ -454,9 +413,6 @@ public class SettingsTab : ITab, IUiService /// Draw all settings that do not fit into other categories. private void DrawMiscSettings() { - Checkbox("Automatically Select Character-Associated Collection", - "On every login, automatically select the collection associated with the current character as the current collection for editing.", - _config.AutoSelectCollection, _autoSelector.SetAutomaticSelection); Checkbox("Print Chat Command Success Messages to Chat", "Chat Commands usually print messages on failure but also on success to confirm your action. You can disable this here.", _config.PrintSuccessfulCommandsToChat, v => _config.PrintSuccessfulCommandsToChat = v); @@ -468,19 +424,10 @@ public class SettingsTab : ITab, IUiService _config.HideChangedItemFilters = v; if (v) { - _config.Ephemeral.ChangedItemFilter = ChangedItemFlagExtensions.AllFlags; + _config.Ephemeral.ChangedItemFilter = ChangedItemDrawer.AllFlags; _config.Ephemeral.Save(); } }); - - ChangedItemModeExtensions.DrawCombo("##ChangedItemMode"u8, _config.ChangedItemDisplay, UiHelpers.InputTextWidth.X, v => - { - _config.ChangedItemDisplay = v; - _config.Save(); - }); - ImUtf8.LabeledHelpMarker("Mod Changed Item Display"u8, - "Configure how to display the changed items of a single mod in the mods info panel."u8); - Checkbox("Omit Machinist Offhands in Changed Items", "Omits all Aetherotransformers (machinist offhands) in the changed items tabs because any change on them changes all of them at the moment.\n\n" + "Changing this triggers a rediscovery of your mods so all changed items can be updated.", @@ -502,9 +449,6 @@ public class SettingsTab : ITab, IUiService Checkbox("Use Interface Collection for other Plugin UIs", "Use the collection assigned to your interface for other plugins requesting UI-textures and icons through Dalamud.", _dalamudSubstitutionProvider.Enabled, _dalamudSubstitutionProvider.Set); - Checkbox($"Use {TutorialService.AssignedCollections} in Lobby", - "If this is disabled, no mods are applied to characters in the lobby or at the aesthetician.", - _config.ShowModsInLobby, v => _config.ShowModsInLobby = v); Checkbox($"Use {TutorialService.AssignedCollections} in Character Window", "Use the individual collection for your characters name or the Your Character collection in your main character window, if it is set.", _config.UseCharacterCollectionInMainWindow, v => _config.UseCharacterCollectionInMainWindow = v); @@ -529,25 +473,74 @@ public class SettingsTab : ITab, IUiService { var sortMode = _config.SortMode; ImGui.SetNextItemWidth(UiHelpers.InputTextWidth.X); - using (var combo = ImUtf8.Combo("##sortMode", sortMode.Name)) + using (var combo = ImRaii.Combo("##sortMode", sortMode.Name)) { if (combo) foreach (var val in Configuration.Constants.ValidSortModes) { - if (ImUtf8.Selectable(val.Name, val.GetType() == sortMode.GetType()) && val.GetType() != sortMode.GetType()) + if (ImGui.Selectable(val.Name, val.GetType() == sortMode.GetType()) && val.GetType() != sortMode.GetType()) { _config.SortMode = val; _selector.SetFilterDirty(); _config.Save(); } - ImUtf8.HoverTooltip(val.Description); + ImGuiUtil.HoverTooltip(val.Description); } } ImGuiUtil.LabeledHelpMarker("Sort Mode", "Choose the sort mode for the mod selector in the mods tab."); } + private float _absoluteSelectorSize = float.NaN; + + /// Draw a selector for the absolute size of the mod selector in pixels. + private void DrawAbsoluteSizeSelector() + { + if (float.IsNaN(_absoluteSelectorSize)) + _absoluteSelectorSize = _config.ModSelectorAbsoluteSize; + + if (ImGuiUtil.DragFloat("##absoluteSize", ref _absoluteSelectorSize, UiHelpers.InputTextWidth.X, 1, + Configuration.Constants.MinAbsoluteSize, Configuration.Constants.MaxAbsoluteSize, "%.0f") + && _absoluteSelectorSize != _config.ModSelectorAbsoluteSize) + { + _config.ModSelectorAbsoluteSize = _absoluteSelectorSize; + _config.Save(); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("Mod Selector Absolute Size", + "The minimal absolute size of the mod selector in the mod tab in pixels."); + } + + private int _relativeSelectorSize = int.MaxValue; + + /// Draw a selector for the relative size of the mod selector as a percentage and a toggle to enable relative sizing. + private void DrawRelativeSizeSelector() + { + var scaleModSelector = _config.ScaleModSelector; + if (ImGui.Checkbox("Scale Mod Selector With Window Size", ref scaleModSelector)) + { + _config.ScaleModSelector = scaleModSelector; + _config.Save(); + } + + ImGui.SameLine(); + if (_relativeSelectorSize == int.MaxValue) + _relativeSelectorSize = _config.ModSelectorScaledSize; + if (ImGuiUtil.DragInt("##relativeSize", ref _relativeSelectorSize, UiHelpers.InputTextWidth.X - ImGui.GetCursorPosX(), 0.1f, + Configuration.Constants.MinScaledSize, Configuration.Constants.MaxScaledSize, "%i%%") + && _relativeSelectorSize != _config.ModSelectorScaledSize) + { + _config.ModSelectorScaledSize = _relativeSelectorSize; + _config.Save(); + } + + ImGui.SameLine(); + ImGuiUtil.LabeledHelpMarker("Mod Selector Relative Size", + "Instead of keeping the mod-selector in the Installed Mods tab a fixed width, this will let it scale with the total size of the Penumbra window."); + } + private void DrawRenameSettings() { ImGui.SetNextItemWidth(UiHelpers.InputTextWidth.X); @@ -581,6 +574,8 @@ public class SettingsTab : ITab, IUiService private void DrawModSelectorSettings() { DrawFolderSortType(); + DrawAbsoluteSizeSelector(); + DrawRelativeSizeSelector(); DrawRenameSettings(); Checkbox("Open Folders by Default", "Whether to start with all folders collapsed or expanded in the mod selector.", _config.OpenFoldersByDefault, v => @@ -597,70 +592,21 @@ public class SettingsTab : ITab, IUiService _config.DeleteModModifier = v; _config.Save(); }); - Widget.DoubleModifierSelector("Incognito Modifier", - "A modifier you need to hold while clicking the Incognito or Temporary Settings Mode button for it to take effect.", - UiHelpers.InputTextWidth.X, - _config.IncognitoModifier, - v => - { - _config.IncognitoModifier = v; - _config.Save(); - }); } /// Draw all settings pertaining to import and export of mods. private void DrawModHandlingSettings() { - Checkbox("Use Temporary Settings Per Default", - "When you make any changes to your collection, apply them as temporary changes first and require a click to 'turn permanent' if you want to keep them.", - _config.DefaultTemporaryMode, v => _config.DefaultTemporaryMode = v); Checkbox("Replace Non-Standard Symbols On Import", "Replace all non-ASCII symbols in mod and option names with underscores when importing mods.", _config.ReplaceNonAsciiOnImport, v => _config.ReplaceNonAsciiOnImport = v); Checkbox("Always Open Import at Default Directory", "Open the import window at the location specified here every time, forgetting your previous path.", _config.AlwaysOpenDefaultImport, v => _config.AlwaysOpenDefaultImport = v); - Checkbox("Handle PCP Files", - "When encountering specific mods, usually but not necessarily denoted by a .pcp file ending, Penumbra will automatically try to create an associated collection and assign it to a specific character for this mod package. This can turn this behaviour off if unwanted.", - !_config.PcpSettings.DisableHandling, v => _config.PcpSettings.DisableHandling = !v); - - var active = _config.DeleteModModifier.IsActive(); - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Delete all PCP Mods"u8, "Deletes all mods tagged with 'PCP' from the mod list."u8, disabled: !active)) - _pcpService.CleanPcpMods(); - if (!active) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"Hold {_config.DeleteModModifier} while clicking."); - - ImGui.SameLine(); - if (ImUtf8.ButtonEx("Delete all PCP Collections"u8, "Deletes all collections whose name starts with 'PCP/' from the collection list."u8, - disabled: !active)) - _pcpService.CleanPcpCollections(); - if (!active) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"Hold {_config.DeleteModModifier} while clicking."); - - Checkbox("Allow Other Plugins Access to PCP Handling", - "When creating or importing PCP files, other plugins can add and interpret their own data to the character.json file.", - _config.PcpSettings.AllowIpc, v => _config.PcpSettings.AllowIpc = v); - - Checkbox("Create PCP Collections", - "When importing PCP files, create the associated collection.", - _config.PcpSettings.CreateCollection, v => _config.PcpSettings.CreateCollection = v); - - Checkbox("Assign PCP Collections", - "When importing PCP files and creating the associated collection, assign it to the associated character.", - _config.PcpSettings.AssignCollection, v => _config.PcpSettings.AssignCollection = v); DrawDefaultModImportPath(); DrawDefaultModAuthor(); DrawDefaultModImportFolder(); - DrawPcpFolder(); DrawDefaultModExportPath(); - Checkbox("Enable Directory Watcher", - "Enables a File Watcher that automatically listens for Mod files that enter a specified directory, causing Penumbra to open a popup to import these mods.", - _config.EnableDirectoryWatch, _fileWatcher.Toggle); - Checkbox("Enable Fully Automatic Import", - "Uses the File Watcher in order to skip the query popup and automatically import any new mods.", - _config.EnableAutomaticModImport, v => _config.EnableAutomaticModImport = v); - DrawFileWatcherPath(); } @@ -740,46 +686,6 @@ public class SettingsTab : ITab, IUiService + "Keep this empty to use the root directory."); } - private string? _tempWatchDirectory; - - /// Draw input for the Automatic Mod import path. - private void DrawFileWatcherPath() - { - var tmp = _tempWatchDirectory ?? _config.WatchDirectory; - var spacing = new Vector2(UiHelpers.ScaleX3); - using var style = ImRaii.PushStyle(ImGuiStyleVar.ItemSpacing, spacing); - ImGui.SetNextItemWidth(UiHelpers.InputTextMinusButton3); - if (ImGui.InputText("##fileWatchPath", ref tmp, 256)) - _tempWatchDirectory = tmp; - - if (ImGui.IsItemDeactivated() && _tempWatchDirectory is not null) - { - if (ImGui.IsItemDeactivatedAfterEdit()) - _fileWatcher.UpdateDirectory(_tempWatchDirectory); - _tempWatchDirectory = null; - } - - ImGui.SameLine(); - if (ImGuiUtil.DrawDisabledButton($"{FontAwesomeIcon.Folder.ToIconString()}##fileWatch", UiHelpers.IconButtonSize, - "Select a directory via dialog.", false, true)) - { - var startDir = _config.WatchDirectory.Length > 0 && Directory.Exists(_config.WatchDirectory) - ? _config.WatchDirectory - : Directory.Exists(_config.ModDirectory) - ? _config.ModDirectory - : null; - _fileDialog.OpenFolderPicker("Choose Automatic Import Directory", (b, s) => - { - if (b) - _fileWatcher.UpdateDirectory(s); - }, startDir, false); - } - - style.Pop(); - ImGuiUtil.LabeledHelpMarker("Automatic Import Director", - "Choose the Directory the File Watcher listens to."); - } - /// Draw input for the default name to input as author into newly generated mods. private void DrawDefaultModAuthor() { @@ -809,30 +715,6 @@ public class SettingsTab : ITab, IUiService "Set the default Penumbra mod folder to place newly imported mods into.\nLeave blank to import into Root."); } - /// Draw input for the default folder to sort put newly imported mods into. - private void DrawPcpFolder() - { - var tmp = _config.PcpSettings.FolderName; - ImGui.SetNextItemWidth(UiHelpers.InputTextWidth.X); - if (ImUtf8.InputText("##pcpFolder"u8, ref tmp)) - _config.PcpSettings.FolderName = tmp; - - if (ImGui.IsItemDeactivatedAfterEdit()) - _config.Save(); - - ImGuiUtil.LabeledHelpMarker("Default PCP Organizational Folder", - "The folder any penumbra character packs are moved to on import.\nLeave blank to import into Root."); - } - - - /// Draw all settings pertaining to advanced editing of mods. - private void DrawModEditorSettings() - { - Checkbox("Advanced Editing: Edit Raw Tile UV Transforms", - "Edit the raw matrix components of tile UV transforms, instead of having them decomposed into scale, rotation and shear.", - _config.EditRawTileTransforms, v => _config.EditRawTileTransforms = v); - } - #endregion /// Draw the entire Color subsection. @@ -864,29 +746,19 @@ public class SettingsTab : ITab, IUiService DrawCrashHandler(); DrawMinimumDimensionConfig(); - DrawHdrRenderTargets(); Checkbox("Auto Deduplicate on Import", "Automatically deduplicate mod files on import. This will make mod file sizes smaller, but deletes (binary identical) files.", _config.AutoDeduplicateOnImport, v => _config.AutoDeduplicateOnImport = v); - Checkbox("Auto Reduplicate UI Files on PMP Import", - "Automatically reduplicate and normalize UI-specific files on import from PMP files. This is STRONGLY recommended because deduplicated UI files crash the game.", - _config.AutoReduplicateUiOnImport, v => _config.AutoReduplicateUiOnImport = v); DrawCompressionBox(); Checkbox("Keep Default Metadata Changes on Import", "Normally, metadata changes that equal their default values, which are sometimes exported by TexTools, are discarded. " + "Toggle this to keep them, for example if an option in a mod is supposed to disable a metadata change from a prior option.", _config.KeepDefaultMetaChanges, v => _config.KeepDefaultMetaChanges = v); - Checkbox("Enable Custom Shape and Attribute Support", - "Penumbra will allow for custom shape keys and attributes for modded models to be considered and combined.", - _config.EnableCustomShapes, _attributeHook.SetState); DrawWaitForPluginsReflection(); DrawEnableHttpApiBox(); DrawEnableDebugModeBox(); - ImGui.Separator(); DrawReloadResourceButton(); DrawReloadFontsButton(); - ImGui.Separator(); - DrawCleanupButtons(); ImGui.NewLine(); } @@ -921,15 +793,13 @@ public class SettingsTab : ITab, IUiService if (ImGuiUtil.DrawDisabledButton("Compress Existing Files", Vector2.Zero, "Try to compress all files in your root directory. This will take a while.", _compactor.MassCompactRunning || !_modManager.Valid)) - _compactor.StartMassCompact(_modManager.BasePath.EnumerateFiles("*.*", SearchOption.AllDirectories), CompressionAlgorithm.Xpress8K, - true); + _compactor.StartMassCompact(_modManager.BasePath.EnumerateFiles("*.*", SearchOption.AllDirectories), CompressionAlgorithm.Xpress8K); ImGui.SameLine(); if (ImGuiUtil.DrawDisabledButton("Decompress Existing Files", Vector2.Zero, "Try to decompress all files in your root directory. This will take a while.", _compactor.MassCompactRunning || !_modManager.Valid)) - _compactor.StartMassCompact(_modManager.BasePath.EnumerateFiles("*.*", SearchOption.AllDirectories), CompressionAlgorithm.None, - true); + _compactor.StartMassCompact(_modManager.BasePath.EnumerateFiles("*.*", SearchOption.AllDirectories), CompressionAlgorithm.None); if (_compactor.MassCompactRunning) { @@ -1000,33 +870,6 @@ public class SettingsTab : ITab, IUiService _config.Save(); } - private void DrawHdrRenderTargets() - { - ImGui.SetNextItemWidth(ImUtf8.CalcTextSize("M"u8).X * 5.0f + ImGui.GetFrameHeight()); - using (var combo = ImUtf8.Combo("##hdrRenderTarget"u8, _config.HdrRenderTargets ? "HDR"u8 : "SDR"u8)) - { - if (combo) - { - if (ImUtf8.Selectable("HDR"u8, _config.HdrRenderTargets) && !_config.HdrRenderTargets) - { - _config.HdrRenderTargets = true; - _config.Save(); - } - - if (ImUtf8.Selectable("SDR"u8, !_config.HdrRenderTargets) && _config.HdrRenderTargets) - { - _config.HdrRenderTargets = false; - _config.Save(); - } - } - } - - ImGui.SameLine(); - ImUtf8.LabeledHelpMarker("Diffuse Dynamic Range"u8, - "Set the dynamic range that can be used for diffuse colors in materials without causing visual artifacts.\n"u8 - + "Changing this setting requires a game restart. It also only works if Wait for Plugins on Startup is enabled."u8); - } - /// Draw a checkbox for the HTTP API that creates and destroys the web server when toggled. private void DrawEnableHttpApiBox() { @@ -1078,44 +921,6 @@ public class SettingsTab : ITab, IUiService _fontReloader.Reload(); } - private void DrawCleanupButtons() - { - var enabled = _config.DeleteModModifier.IsActive(); - if (_cleanupService.Progress is not 0.0 and not 1.0) - { - ImUtf8.ProgressBar((float)_cleanupService.Progress, new Vector2(200 * ImUtf8.GlobalScale, ImGui.GetFrameHeight()), - $"{_cleanupService.Progress * 100}%"); - ImGui.SameLine(); - if (ImUtf8.Button("Cancel##FileCleanup"u8)) - _cleanupService.Cancel(); - } - else - { - ImGui.NewLine(); - } - - if (ImUtf8.ButtonEx("Clear Unused Local Mod Data Files"u8, - "Delete all local mod data files that do not correspond to currently installed mods."u8, default, - !enabled || _cleanupService.IsRunning)) - _cleanupService.CleanUnusedLocalData(); - if (!enabled) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"Hold {_config.DeleteModModifier} while clicking to delete files."); - - if (ImUtf8.ButtonEx("Clear Backup Files"u8, - "Delete all backups of .json configuration files in your configuration folder and all backups of mod group files in your mod directory."u8, - default, !enabled || _cleanupService.IsRunning)) - _cleanupService.CleanBackupFiles(); - if (!enabled) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"Hold {_config.DeleteModModifier} while clicking to delete files."); - - if (ImUtf8.ButtonEx("Clear All Unused Settings"u8, - "Remove all mod settings in all of your collections that do not correspond to currently installed mods."u8, default, - !enabled || _cleanupService.IsRunning)) - _cleanupService.CleanupAllUnusedSettings(); - if (!enabled) - ImUtf8.HoverTooltip(ImGuiHoveredFlags.AllowWhenDisabled, $"Hold {_config.DeleteModModifier} while clicking to remove settings."); - } - /// Draw a checkbox that toggles the dalamud setting to wait for plugins on open. private void DrawWaitForPluginsReflection() { @@ -1137,7 +942,7 @@ public class SettingsTab : ITab, IUiService } #endregion - + /// Draw the support button group on the right-hand side of the window. private void DrawSupportButtons() { @@ -1166,9 +971,6 @@ public class SettingsTab : ITab, IUiService ImGui.SetCursorPos(new Vector2(xPos, 4 * ImGui.GetFrameHeightWithSpacing())); if (ImGui.Button("Show Changelogs", new Vector2(width, 0))) _penumbra.ForceChangelogOpen(); - - ImGui.SetCursorPos(new Vector2(xPos, 5 * ImGui.GetFrameHeightWithSpacing())); - CustomGui.DrawKofiPatreonButton(Penumbra.Messager, new Vector2(width, 0)); } private void DrawPredefinedTagsSection() diff --git a/Penumbra/UI/TutorialService.cs b/Penumbra/UI/TutorialService.cs index 69f2b616..d87df19e 100644 --- a/Penumbra/UI/TutorialService.cs +++ b/Penumbra/UI/TutorialService.cs @@ -1,4 +1,3 @@ -using OtterGui.Services; using OtterGui.Widgets; using Penumbra.Collections; using Penumbra.Collections.Manager; @@ -41,7 +40,7 @@ public enum BasicTutorialSteps } /// Service for the in-game tutorial. -public class TutorialService : IUiService +public class TutorialService { public const string SelectedCollection = "Selected Collection"; public const string DefaultCollection = "Base Collection"; @@ -83,14 +82,14 @@ public class TutorialService : IUiService + "Go here after setting up your root folder to continue the tutorial!") .Register("Initial Setup, Step 4: Managing Collections", "On the left, we have the collection selector. Here, we can create new collections - either empty ones or by duplicating existing ones - and delete any collections not needed anymore.\n" - + $"There will always be one collection called {ModCollectionIdentity.DefaultCollectionName} that can not be deleted.") + + $"There will always be one collection called {ModCollection.DefaultCollectionName} that can not be deleted.") .Register($"Initial Setup, Step 5: {SelectedCollection}", $"The {SelectedCollection} is the one we highlighted in the selector. It is the collection we are currently looking at and editing.\nAny changes we make in our mod settings later in the next tab will edit this collection.\n" - + $"We should already have the collection named {ModCollectionIdentity.DefaultCollectionName} selected, and for our simple setup, we do not need to do anything here.\n\n") + + $"We should already have the collection named {ModCollection.DefaultCollectionName} selected, and for our simple setup, we do not need to do anything here.\n\n") .Register("Initial Setup, Step 6: Simple Assignments", "Aside from being a collection of settings, we can also assign collections to different functions. This is used to make different mods apply to different characters.\n" + "The Simple Assignments panel shows you the possible assignments that are enough for most people along with descriptions.\n" - + $"If you are just starting, you can see that the {ModCollectionIdentity.DefaultCollectionName} is currently assigned to {CollectionType.Default.ToName()} and {CollectionType.Interface.ToName()}.\n" + + $"If you are just starting, you can see that the {ModCollection.DefaultCollectionName} is currently assigned to {CollectionType.Default.ToName()} and {CollectionType.Interface.ToName()}.\n" + "You can also assign 'Use No Mods' instead of a collection by clicking on the function buttons.") .Register("Individual Assignments", "In the Individual Assignments panel, you can manually create assignments for very specific characters or monsters, not just yourself or ones you can currently target.") diff --git a/Penumbra/UI/UiHelpers.cs b/Penumbra/UI/UiHelpers.cs index 9fe90ee8..8fbce6d0 100644 --- a/Penumbra/UI/UiHelpers.cs +++ b/Penumbra/UI/UiHelpers.cs @@ -1,6 +1,6 @@ -using Dalamud.Interface.ImGuiNotification; +using Dalamud.Interface.Internal.Notifications; using Dalamud.Interface.Utility; -using Dalamud.Bindings.ImGui; +using ImGuiNET; using OtterGui; using OtterGui.Classes; using OtterGui.Raii; @@ -13,11 +13,11 @@ public static class UiHelpers { /// Draw text given by a ByteString. public static unsafe void Text(ByteString s) - => ImGuiNative.TextUnformatted(s.Path, s.Path + s.Length); + => ImGuiNative.igTextUnformatted(s.Path, s.Path + s.Length); /// Draw text given by a byte pointer and length. public static unsafe void Text(byte* s, int length) - => ImGuiNative.TextUnformatted(s, s + length); + => ImGuiNative.igTextUnformatted(s, s + length); /// Draw text given by a byte span. public static unsafe void Text(ReadOnlySpan s) @@ -36,7 +36,7 @@ public static class UiHelpers public static unsafe bool Selectable(ByteString s, bool selected) { var tmp = (byte)(selected ? 1 : 0); - return ImGuiNative.Selectable(s.Path, tmp, ImGuiSelectableFlags.None, Vector2.Zero) != 0; + return ImGuiNative.igSelectable_Bool(s.Path, tmp, ImGuiSelectableFlags.None, Vector2.Zero) != 0; } /// @@ -45,8 +45,8 @@ public static class UiHelpers /// public static unsafe void CopyOnClickSelectable(ByteString text) { - if (ImGuiNative.Selectable(text.Path, 0, ImGuiSelectableFlags.None, Vector2.Zero) != 0) - ImGuiNative.SetClipboardText(text.Path); + if (ImGuiNative.igSelectable_Bool(text.Path, 0, ImGuiSelectableFlags.None, Vector2.Zero) != 0) + ImGuiNative.igSetClipboardText(text.Path); if (ImGui.IsItemHovered()) ImGui.SetTooltip("Click to copy to clipboard."); diff --git a/Penumbra/UI/WindowSystem.cs b/Penumbra/UI/WindowSystem.cs index 575a381f..c5418eb3 100644 --- a/Penumbra/UI/WindowSystem.cs +++ b/Penumbra/UI/WindowSystem.cs @@ -1,46 +1,36 @@ using Dalamud.Interface; using Dalamud.Interface.Windowing; using Dalamud.Plugin; -using OtterGui.Services; -using Penumbra.Interop.Services; using Penumbra.UI.AdvancedWindow; -using Penumbra.UI.Knowledge; using Penumbra.UI.Tabs.Debug; namespace Penumbra.UI; -public class PenumbraWindowSystem : IDisposable, IUiService +public class PenumbraWindowSystem : IDisposable { - private readonly IUiBuilder _uiBuilder; - private readonly WindowSystem _windowSystem; - private readonly FileDialogService _fileDialog; - private readonly TextureArraySlicer _textureArraySlicer; - public readonly ConfigWindow Window; - public readonly PenumbraChangelog Changelog; - public readonly KnowledgeWindow KnowledgeWindow; + private readonly UiBuilder _uiBuilder; + private readonly WindowSystem _windowSystem; + private readonly FileDialogService _fileDialog; + public readonly ConfigWindow Window; + public readonly PenumbraChangelog Changelog; - public PenumbraWindowSystem(IDalamudPluginInterface pi, Configuration config, PenumbraChangelog changelog, ConfigWindow window, - LaunchButton _, ModEditWindow editWindow, FileDialogService fileDialog, ImportPopup importPopup, DebugTab debugTab, - KnowledgeWindow knowledgeWindow, TextureArraySlicer textureArraySlicer) + public PenumbraWindowSystem(DalamudPluginInterface pi, Configuration config, PenumbraChangelog changelog, ConfigWindow window, + LaunchButton _, ModEditWindow editWindow, FileDialogService fileDialog, ImportPopup importPopup, DebugTab debugTab) { - _uiBuilder = pi.UiBuilder; - _fileDialog = fileDialog; - _textureArraySlicer = textureArraySlicer; - KnowledgeWindow = knowledgeWindow; - Changelog = changelog; - Window = window; - _windowSystem = new WindowSystem("Penumbra"); + _uiBuilder = pi.UiBuilder; + _fileDialog = fileDialog; + Changelog = changelog; + Window = window; + _windowSystem = new WindowSystem("Penumbra"); _windowSystem.AddWindow(changelog.Changelog); _windowSystem.AddWindow(window); _windowSystem.AddWindow(editWindow); _windowSystem.AddWindow(importPopup); _windowSystem.AddWindow(debugTab); - _windowSystem.AddWindow(KnowledgeWindow); _uiBuilder.OpenMainUi += Window.Toggle; _uiBuilder.OpenConfigUi += Window.OpenSettings; _uiBuilder.Draw += _windowSystem.Draw; _uiBuilder.Draw += _fileDialog.Draw; - _uiBuilder.Draw += _textureArraySlicer.Tick; _uiBuilder.DisableGposeUiHide = !config.HideUiInGPose; _uiBuilder.DisableCutsceneUiHide = !config.HideUiInCutscenes; _uiBuilder.DisableUserUiHide = !config.HideUiWhenUiHidden; @@ -55,6 +45,5 @@ public class PenumbraWindowSystem : IDisposable, IUiService _uiBuilder.OpenConfigUi -= Window.OpenSettings; _uiBuilder.Draw -= _windowSystem.Draw; _uiBuilder.Draw -= _fileDialog.Draw; - _uiBuilder.Draw -= _textureArraySlicer.Tick; } } diff --git a/Penumbra/Util/DictionaryExtensions.cs b/Penumbra/Util/DictionaryExtensions.cs index f7aa5598..abf715e6 100644 --- a/Penumbra/Util/DictionaryExtensions.cs +++ b/Penumbra/Util/DictionaryExtensions.cs @@ -45,18 +45,6 @@ public static class DictionaryExtensions lhs.Add(key, value); } - /// Set all entries in the right-hand dictionary to the same values in the left-hand dictionary, ensuring capacity beforehand. - public static void UpdateTo(this Dictionary lhs, IReadOnlyDictionary rhs) - where TKey : notnull - { - if (ReferenceEquals(lhs, rhs)) - return; - - lhs.EnsureCapacity(rhs.Count); - foreach (var (key, value) in rhs) - lhs[key] = value; - } - /// Set one set to the other, deleting previous entries and ensuring capacity beforehand. public static void SetTo(this HashSet lhs, IReadOnlySet rhs) { diff --git a/Penumbra/Util/IdentifierExtensions.cs b/Penumbra/Util/IdentifierExtensions.cs index f744e940..7368c7c8 100644 --- a/Penumbra/Util/IdentifierExtensions.cs +++ b/Penumbra/Util/IdentifierExtensions.cs @@ -2,6 +2,7 @@ using OtterGui.Classes; using Penumbra.GameData.Data; using Penumbra.GameData.Enums; using Penumbra.GameData.Structs; +using Penumbra.Meta.Manipulations; using Penumbra.Mods.Editor; using Penumbra.Mods.SubMods; @@ -9,35 +10,124 @@ namespace Penumbra.Util; public static class IdentifierExtensions { + /// Compute the items changed by a given meta manipulation and put them into the changedItems dictionary. + public static void MetaChangedItems(this ObjectIdentification identifier, IDictionary changedItems, + MetaManipulation manip) + { + switch (manip.ManipulationType) + { + case MetaManipulation.Type.Imc: + switch (manip.Imc.ObjectType) + { + case ObjectType.Equipment: + case ObjectType.Accessory: + identifier.Identify(changedItems, + GamePaths.Equipment.Mtrl.Path(manip.Imc.PrimaryId, GenderRace.MidlanderMale, manip.Imc.EquipSlot, manip.Imc.Variant, + "a")); + break; + case ObjectType.Weapon: + identifier.Identify(changedItems, + GamePaths.Weapon.Mtrl.Path(manip.Imc.PrimaryId, manip.Imc.SecondaryId, manip.Imc.Variant, "a")); + break; + case ObjectType.DemiHuman: + identifier.Identify(changedItems, + GamePaths.DemiHuman.Mtrl.Path(manip.Imc.PrimaryId, manip.Imc.SecondaryId, manip.Imc.EquipSlot, manip.Imc.Variant, + "a")); + break; + case ObjectType.Monster: + identifier.Identify(changedItems, + GamePaths.Monster.Mtrl.Path(manip.Imc.PrimaryId, manip.Imc.SecondaryId, manip.Imc.Variant, "a")); + break; + } + + break; + case MetaManipulation.Type.Eqdp: + identifier.Identify(changedItems, + GamePaths.Equipment.Mdl.Path(manip.Eqdp.SetId, Names.CombinedRace(manip.Eqdp.Gender, manip.Eqdp.Race), manip.Eqdp.Slot)); + break; + case MetaManipulation.Type.Eqp: + identifier.Identify(changedItems, GamePaths.Equipment.Mdl.Path(manip.Eqp.SetId, GenderRace.MidlanderMale, manip.Eqp.Slot)); + break; + case MetaManipulation.Type.Est: + switch (manip.Est.Slot) + { + case EstManipulation.EstType.Hair: + changedItems.TryAdd($"Customization: {manip.Est.Race} {manip.Est.Gender} Hair (Hair) {manip.Est.SetId}", null); + break; + case EstManipulation.EstType.Face: + changedItems.TryAdd($"Customization: {manip.Est.Race} {manip.Est.Gender} Face (Face) {manip.Est.SetId}", null); + break; + case EstManipulation.EstType.Body: + identifier.Identify(changedItems, + GamePaths.Equipment.Mdl.Path(manip.Est.SetId, Names.CombinedRace(manip.Est.Gender, manip.Est.Race), + EquipSlot.Body)); + break; + case EstManipulation.EstType.Head: + identifier.Identify(changedItems, + GamePaths.Equipment.Mdl.Path(manip.Est.SetId, Names.CombinedRace(manip.Est.Gender, manip.Est.Race), + EquipSlot.Head)); + break; + } + + break; + case MetaManipulation.Type.Gmp: + identifier.Identify(changedItems, GamePaths.Equipment.Mdl.Path(manip.Gmp.SetId, GenderRace.MidlanderMale, EquipSlot.Head)); + break; + case MetaManipulation.Type.Rsp: + changedItems.TryAdd($"{manip.Rsp.SubRace.ToName()} {manip.Rsp.Attribute.ToFullString()}", null); + break; + case MetaManipulation.Type.GlobalEqp: + var path = manip.GlobalEqp.Type switch + { + GlobalEqpType.DoNotHideEarrings => GamePaths.Accessory.Mdl.Path(manip.GlobalEqp.Condition, GenderRace.MidlanderMale, + EquipSlot.Ears), + GlobalEqpType.DoNotHideNecklace => GamePaths.Accessory.Mdl.Path(manip.GlobalEqp.Condition, GenderRace.MidlanderMale, + EquipSlot.Neck), + GlobalEqpType.DoNotHideBracelets => GamePaths.Accessory.Mdl.Path(manip.GlobalEqp.Condition, GenderRace.MidlanderMale, + EquipSlot.Wrists), + GlobalEqpType.DoNotHideRingR => GamePaths.Accessory.Mdl.Path(manip.GlobalEqp.Condition, GenderRace.MidlanderMale, + EquipSlot.RFinger), + GlobalEqpType.DoNotHideRingL => GamePaths.Accessory.Mdl.Path(manip.GlobalEqp.Condition, GenderRace.MidlanderMale, + EquipSlot.LFinger), + GlobalEqpType.DoNotHideHrothgarHats => string.Empty, + GlobalEqpType.DoNotHideVieraHats => string.Empty, + _ => string.Empty, + }; + if (path.Length > 0) + identifier.Identify(changedItems, path); + break; + } + } + public static void AddChangedItems(this ObjectIdentification identifier, IModDataContainer container, - IDictionary changedItems) + IDictionary changedItems) { foreach (var gamePath in container.Files.Keys.Concat(container.FileSwaps.Keys)) identifier.Identify(changedItems, gamePath.ToString()); - foreach (var manip in container.Manipulations.Identifiers) - manip.AddChangedItems(identifier, changedItems); + foreach (var manip in container.Manipulations) + MetaChangedItems(identifier, changedItems, manip); } - public static void RemoveMachinistOffhands(this SortedList changedItems) + public static void RemoveMachinistOffhands(this SortedList changedItems) { for (var i = 0; i < changedItems.Count; i++) { { var value = changedItems.Values[i]; - if (value is IdentifiedItem { Item.Type: FullEquipType.GunOff }) + if (value is EquipItem { Type: FullEquipType.GunOff }) changedItems.RemoveAt(i--); } } } - public static void RemoveMachinistOffhands(this SortedList, IIdentifiedObjectData)> changedItems) + public static void RemoveMachinistOffhands(this SortedList, object?)> changedItems) { for (var i = 0; i < changedItems.Count; i++) { { var value = changedItems.Values[i].Item2; - if (value is IdentifiedItem { Item.Type: FullEquipType.GunOff }) + if (value is EquipItem { Type: FullEquipType.GunOff }) changedItems.RemoveAt(i--); } } diff --git a/Penumbra/Util/PointerExtensions.cs b/Penumbra/Util/PointerExtensions.cs deleted file mode 100644 index c70e2177..00000000 --- a/Penumbra/Util/PointerExtensions.cs +++ /dev/null @@ -1,20 +0,0 @@ -namespace Penumbra.Util; - -public static class PointerExtensions -{ - public static unsafe ref TField GetField(this ref TPointer reference, int offset) - where TPointer : unmanaged - where TField : unmanaged - { - var pointer = (byte*)Unsafe.AsPointer(ref reference) + offset; - return ref *(TField*)pointer; - } - - public static unsafe ref TField GetField(TPointer* itemPointer, int offset) - where TPointer : unmanaged - where TField : unmanaged - { - var pointer = (byte*)itemPointer + offset; - return ref *(TField*)pointer; - } -} diff --git a/Penumbra/lib/OtterTex.dll b/Penumbra/lib/OtterTex.dll index c137aee1..29912e62 100644 Binary files a/Penumbra/lib/OtterTex.dll and b/Penumbra/lib/OtterTex.dll differ diff --git a/Penumbra/packages.lock.json b/Penumbra/packages.lock.json index c904870a..b431e595 100644 --- a/Penumbra/packages.lock.json +++ b/Penumbra/packages.lock.json @@ -1,123 +1,87 @@ { "version": 1, "dependencies": { - "net10.0-windows7.0": { - "DotNet.ReproducibleBuilds": { - "type": "Direct", - "requested": "[1.2.39, )", - "resolved": "1.2.39", - "contentHash": "fcFN01tDTIQqDuTwr1jUQK/geofiwjG5DycJQOnC72i1SsLAk1ELe+apBOuZ11UMQG8YKFZG1FgvjZPbqHyatg==" - }, + "net8.0-windows7.0": { "EmbedIO": { "type": "Direct", - "requested": "[3.5.2, )", - "resolved": "3.5.2", - "contentHash": "YU4j+3XvuO8/VPkNf7KWOF1TpMhnyVhXnPsG1mvnDhTJ9D5BZOFXVDvCpE/SkQ1AJ0Aa+dXOVSW3ntgmLL7aJg==", + "requested": "[3.4.3, )", + "resolved": "3.4.3", + "contentHash": "YM6hpZNAfvbbixfG9T4lWDGfF0D/TqutbTROL4ogVcHKwPF1hp+xS3ABwd3cxxTxvDFkj/zZl57QgWuFA8Igxw==", "dependencies": { - "Unosquare.Swan.Lite": "3.1.0" - } - }, - "PeNet": { - "type": "Direct", - "requested": "[5.1.0, )", - "resolved": "5.1.0", - "contentHash": "XSd1PUwWo5uI8iqVHk7Mm02RT1bjndtAYsaRwLmdYZoHOAmb4ohkvRcZiqxJ7iLfBfdiwm+PHKQIMqDmOavBtw==", - "dependencies": { - "PeNet.Asn1": "2.0.1", - "System.Security.Cryptography.Pkcs": "8.0.1" + "Unosquare.Swan.Lite": "3.0.0" } }, "SharpCompress": { "type": "Direct", - "requested": "[0.40.0, )", - "resolved": "0.40.0", - "contentHash": "yP/aFX1jqGikVF7u2f05VEaWN4aCaKNLxSas82UgA2GGVECxq/BcqZx3STHCJ78qilo1azEOk1XpBglIuGMb7w==", - "dependencies": { - "ZstdSharp.Port": "0.8.5" - } + "requested": "[0.33.0, )", + "resolved": "0.33.0", + "contentHash": "FlHfpTAADzaSlVCBF33iKJk9UhOr3Xj+r5LXbW2GzqYr0SrhiOf6shLX2LC2fqs7g7d+YlwKbBXqWFtb+e7icw==" }, "SharpGLTF.Core": { "type": "Direct", - "requested": "[1.0.5, )", - "resolved": "1.0.5", - "contentHash": "HNHKPqaHXm7R1nlXZ764K5UI02IeDOQ5DQKLjwYUVNTsSW27jJpw+wLGQx6ZFoiFYqUlyZjmsu+WfEak2GmJAg==" + "requested": "[1.0.0-alpha0030, )", + "resolved": "1.0.0-alpha0030", + "contentHash": "HVL6PcrM0H/uEk96nRZfhtPeYvSFGHnni3g1aIckot2IWVp0jLMH5KWgaWfsatEz4Yds3XcdSLUWmJZivDBUPA==" }, "SharpGLTF.Toolkit": { "type": "Direct", - "requested": "[1.0.5, )", - "resolved": "1.0.5", - "contentHash": "piQKk7PH2pSWQSQmCSd8cYPaDtAy/ppAD+Mrh2RUhhHI8awl81HqqLyAauwQhJwea3LNaiJ6f4ehZuOGk89TlA==", + "requested": "[1.0.0-alpha0030, )", + "resolved": "1.0.0-alpha0030", + "contentHash": "nsoJWAFhXgEky9bVCY0zLeZVDx+S88u7VjvuebvMb6dJiNyFOGF6FrrMHiJe+x5pcVBxxlc3VoXliBF7r/EqYA==", "dependencies": { - "SharpGLTF.Runtime": "1.0.5" + "SharpGLTF.Runtime": "1.0.0-alpha0030" } }, "SixLabors.ImageSharp": { "type": "Direct", - "requested": "[3.1.11, )", - "resolved": "3.1.11", - "contentHash": "JfPLyigLthuE50yi6tMt7Amrenr/fA31t2CvJyhy/kQmfulIBAqo5T/YFUSRHtuYPXRSaUHygFeh6Qd933EoSw==" - }, - "FlatSharp.Compiler": { - "type": "Transitive", - "resolved": "7.9.0", - "contentHash": "MU6808xvdbWJ3Ev+5PKalqQuzvVbn1DzzQH8txRDHGFUNDvHjd+ejqpvnYc9BSJ8Qp8VjkkpJD8OzRYilbPp3A==" - }, - "FlatSharp.Runtime": { - "type": "Transitive", - "resolved": "7.9.0", - "contentHash": "Bm8+WqzEsWNpxqrD5x4x+zQ8dyINlToCreM5FI2oNSfUVc9U9ZB+qztX/jd8rlJb3r0vBSlPwVLpw0xBtPa3Vw==" + "requested": "[3.1.4, )", + "resolved": "3.1.4", + "contentHash": "lFIdxgGDA5iYkUMRFOze7BGLcdpoLFbR+a20kc1W7NepvzU7ejtxtWOg9RvgG7kb9tBoJ3ONYOK6kLil/dgF1w==" }, "JetBrains.Annotations": { "type": "Transitive", - "resolved": "2024.3.0", - "contentHash": "ox5pkeLQXjvJdyAB4b2sBYAlqZGLh3PjSnP1bQNVx72ONuTJ9+34/+Rq91Fc0dG29XG9RgZur9+NcP4riihTug==" + "resolved": "2023.3.0", + "contentHash": "PHfnvdBUdGaTVG9bR/GEfxgTwWM0Z97Y6X3710wiljELBISipSfF5okn/vz+C2gfO+ihoEyVPjaJwn8ZalVukA==" }, "Microsoft.Extensions.DependencyInjection": { "type": "Transitive", - "resolved": "9.0.2", - "contentHash": "ZffbJrskOZ40JTzcTyKwFHS5eACSWp2bUQBBApIgGV+es8RaTD4OxUG7XxFr3RIPLXtYQ1jQzF2DjKB5fZn7Qg==", + "resolved": "8.0.0", + "contentHash": "V8S3bsm50ig6JSyrbcJJ8bW2b9QLGouz+G1miK3UTaOWmMtFwNNNzUf4AleyDWUmTrWMLNnFSLEQtxmxgNQnNQ==", "dependencies": { - "Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2" + "Microsoft.Extensions.DependencyInjection.Abstractions": "8.0.0" } }, "Microsoft.Extensions.DependencyInjection.Abstractions": { "type": "Transitive", - "resolved": "9.0.2", - "contentHash": "MNe7GSTBf3jQx5vYrXF0NZvn6l7hUKF6J54ENfAgCO8y6xjN1XUmKKWG464LP2ye6QqDiA1dkaWEZBYnhoZzjg==" - }, - "PeNet.Asn1": { - "type": "Transitive", - "resolved": "2.0.1", - "contentHash": "YR2O2YokSAYB+7CXkCDN3bd6/p0K3/AicCPkOJHKUz500v1D/hulCuVlggguqNc3M0LgSfOZKGvVYg2ud1GA9A==" + "resolved": "8.0.0", + "contentHash": "cjWrLkJXK0rs4zofsK4bSdg+jhDLTaxrkXu4gS6Y7MAlCvRyNNgwY/lJi5RDlQOnSZweHqoyvgvbdvQsRIW+hg==" }, "SharpGLTF.Runtime": { "type": "Transitive", - "resolved": "1.0.5", - "contentHash": "EVP32k4LqERxSVICiupT8xQvhHSHJCiXajBjNpqdfdajtREHayuVhH0Jmk6uSjTLX8/IIH9XfT34sw3TwvCziw==", + "resolved": "1.0.0-alpha0030", + "contentHash": "Ysn+fyj9EVXj6mfG0BmzSTBGNi/QvcnTrMd54dBMOlI/TsMRvnOY3JjTn0MpeH2CgHXX4qogzlDt4m+rb3n4Og==", "dependencies": { - "SharpGLTF.Core": "1.0.5" + "SharpGLTF.Core": "1.0.0-alpha0030" } }, - "System.Security.Cryptography.Pkcs": { + "System.ValueTuple": { "type": "Transitive", - "resolved": "8.0.1", - "contentHash": "CoCRHFym33aUSf/NtWSVSZa99dkd0Hm7OCZUxORBjRB16LNhIEOf8THPqzIYlvKM0nNDAPTRBa1FxEECrgaxxA==" + "resolved": "4.5.0", + "contentHash": "okurQJO6NRE/apDIP23ajJ0hpiNmJ+f0BwOlB/cSqTLQlw5upkf+5+96+iG2Jw40G1fCVCyPz/FhIABUjMR+RQ==" }, "Unosquare.Swan.Lite": { "type": "Transitive", - "resolved": "3.1.0", - "contentHash": "X3s5QE/KMj3WAPFqFve7St+Ds10BB50u8kW8PmKIn7FVkn7yEXe9Yxr2htt1WV85DRqfFR0MN/BUNHkGHtL4OQ==" - }, - "ZstdSharp.Port": { - "type": "Transitive", - "resolved": "0.8.5", - "contentHash": "TR4j17WeVSEb3ncgL2NqlXEqcy04I+Kk9CaebNDplUeL8XOgjkZ7fP4Wg4grBdPLIqsV86p2QaXTkZoRMVOsew==" + "resolved": "3.0.0", + "contentHash": "noPwJJl1Q9uparXy1ogtkmyAPGNfSGb0BLT1292nFH1jdMKje6o2kvvrQUvF9Xklj+IoiAI0UzF6Aqxlvo10lw==", + "dependencies": { + "System.ValueTuple": "4.5.0" + } }, "ottergui": { "type": "Project", "dependencies": { - "JetBrains.Annotations": "[2024.3.0, )", - "Microsoft.Extensions.DependencyInjection": "[9.0.2, )" + "JetBrains.Annotations": "[2023.3.0, )", + "Microsoft.Extensions.DependencyInjection": "[8.0.0, )" } }, "penumbra.api": { @@ -129,11 +93,9 @@ "penumbra.gamedata": { "type": "Project", "dependencies": { - "FlatSharp.Compiler": "[7.9.0, )", - "FlatSharp.Runtime": "[7.9.0, )", "OtterGui": "[1.0.0, )", - "Penumbra.Api": "[5.13.0, )", - "Penumbra.String": "[1.0.6, )" + "Penumbra.Api": "[5.0.0, )", + "Penumbra.String": "[1.0.4, )" } }, "penumbra.string": { diff --git a/repo.json b/repo.json index 22a682ee..1cf9c104 100644 --- a/repo.json +++ b/repo.json @@ -1,16 +1,15 @@ [ { - "Author": "Ottermandias, Nylfae, Adam, Wintermute", + "Author": "Ottermandias, Adam, Wintermute", "Name": "Penumbra", "Punchline": "Runtime mod loader and manager.", "Description": "Runtime mod loader and manager.", "InternalName": "Penumbra", - "AssemblyVersion": "1.5.1.13", - "TestingAssemblyVersion": "1.5.1.13", + "AssemblyVersion": "1.0.1.0", + "TestingAssemblyVersion": "1.0.3.1", "RepoUrl": "https://github.com/xivdev/Penumbra", "ApplicableVersion": "any", - "DalamudApiLevel": 14, - "TestingDalamudApiLevel": 14, + "DalamudApiLevel": 9, "IsHide": "False", "IsTestingExclusive": "False", "DownloadCount": 0, @@ -18,9 +17,9 @@ "LoadPriority": 69420, "LoadRequiredState": 2, "LoadSync": true, - "DownloadLinkInstall": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.13/Penumbra.zip", - "DownloadLinkTesting": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.13/Penumbra.zip", - "DownloadLinkUpdate": "https://github.com/xivdev/Penumbra/releases/download/1.5.1.13/Penumbra.zip", + "DownloadLinkInstall": "https://github.com/xivdev/Penumbra/releases/download/1.0.1.0/Penumbra.zip", + "DownloadLinkTesting": "https://github.com/xivdev/Penumbra/releases/download/testing_1.0.3.1/Penumbra.zip", + "DownloadLinkUpdate": "https://github.com/xivdev/Penumbra/releases/download/1.0.1.0/Penumbra.zip", "IconUrl": "https://raw.githubusercontent.com/xivdev/Penumbra/master/images/icon.png" } ] diff --git a/schemas/default_mod.json b/schemas/default_mod.json deleted file mode 100644 index 8f50c5db..00000000 --- a/schemas/default_mod.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "allOf": [ - { - "type": "object", - "properties": { - "Version": { - "description": "Mod Container version, currently unused.", - "type": "integer", - "minimum": 0, - "maximum": 0 - } - } - }, - { - "$ref": "structs/container.json" - } - ] -} diff --git a/schemas/group.json b/schemas/group.json deleted file mode 100644 index 4c37b631..00000000 --- a/schemas/group.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Version": { - "description": "Mod Container version, currently unused.", - "type": "integer" - }, - "Name": { - "description": "Name of the group.", - "type": "string", - "minLength": 1 - }, - "Description": { - "description": "Description of the group.", - "type": [ "string", "null" ] - }, - "Image": { - "description": "Relative path to a preview image for the group. Unused by Penumbra, present for round-trip import/export of TexTools-generated mods.", - "type": ["string", "null" ] - }, - "Page": { - "description": "TexTools page of the group. Unused by Penumbra, present for round-trip import/export of TexTools-generated mods.", - "type": "integer" - }, - "Priority": { - "description": "Priority of the group. If several groups define conflicting files or manipulations, the highest priority wins.", - "type": "integer" - }, - "Type": { - "description": "Group type. Single groups have one and only one of their options active at any point. Multi groups can have zero, one or many of their options active. Combining groups have n options, 2^n containers, and will have one and only one container active depending on the selected options.", - "enum": [ "Single", "Multi", "Imc", "Combining" ] - }, - "DefaultSettings": { - "description": "Default configuration for the group.", - "type": "integer" - } - }, - "required": [ - "Name", - "Type" - ], - "oneOf": [ - { - "$ref": "structs/group_combining.json" - }, - { - "$ref": "structs/group_imc.json" - }, - { - "$ref": "structs/group_multi.json" - }, - { - "$ref": "structs/group_single.json" - } - ] -} diff --git a/schemas/local_mod_data-v3.json b/schemas/local_mod_data-v3.json deleted file mode 100644 index c50e130e..00000000 --- a/schemas/local_mod_data-v3.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Local Penumbra Mod Data", - "description": "The locally stored data for an installed mod in Penumbra", - "type": "object", - "properties": { - "FileVersion": { - "description": "Major version of the local data schema used.", - "type": "integer", - "minimum": 3, - "maximum": 3 - }, - "ImportDate": { - "description": "The date and time of the installation of the mod as a Unix Epoch millisecond timestamp.", - "type": "integer" - }, - "LocalTags": { - "description": "User-defined local tags for the mod.", - "type": "array", - "items": { - "type": "string", - "minLength": 1 - }, - "uniqueItems": true - }, - "Favorite": { - "description": "Whether the mod is favourited by the user.", - "type": "boolean" - }, - "PreferredChangedItems": { - "description": "Preferred items to list as the main item of a group.", - "type": "array", - "items": { - "minimum": 0, - "type": "integer" - }, - "uniqueItems": true - } - }, - "required": [ "FileVersion" ] -} diff --git a/schemas/mod_meta-v3.json b/schemas/mod_meta-v3.json deleted file mode 100644 index 6fc68714..00000000 --- a/schemas/mod_meta-v3.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Penumbra Mod Metadata", - "description": "Metadata of a Penumbra mod.", - "type": "object", - "properties": { - "FileVersion": { - "description": "Major version of the metadata schema used.", - "type": "integer", - "minimum": 3, - "maximum": 3 - }, - "Name": { - "description": "Name of the mod.", - "type": "string", - "minLength": 1 - }, - "Author": { - "description": "Author of the mod.", - "type": [ "string", "null" ] - }, - "Description": { - "description": "Description of the mod. Can span multiple paragraphs.", - "type": [ "string", "null" ] - }, - "Image": { - "description": "Relative path to a preview image for the mod. Unused by Penumbra, present for round-trip import/export of TexTools-generated mods.", - "type": [ "string", "null" ] - }, - "Version": { - "description": "Version of the mod. Can be an arbitrary string.", - "type": [ "string", "null" ] - }, - "Website": { - "description": "URL of the web page of the mod.", - "type": [ "string", "null" ] - }, - "ModTags": { - "description": "Author-defined tags for the mod.", - "type": "array", - "items": { - "type": "string", - "minLength": 1 - }, - "uniqueItems": true - }, - "DefaultPreferredItems": { - "description": "Default preferred items to list as the main item of a group managed by the mod creator.", - "type": "array", - "items": { - "minimum": 0, - "type": "integer" - }, - "uniqueItems": true - }, - "RequiredFeatures": { - "description": "A list of required features by name.", - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - } - }, - "required": [ - "FileVersion", - "Name" - ] -} diff --git a/schemas/shpk_devkit.json b/schemas/shpk_devkit.json deleted file mode 100644 index f03fbb05..00000000 --- a/schemas/shpk_devkit.json +++ /dev/null @@ -1,499 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "ShaderKeys": { - "type": "object", - "patternProperties": { - "^\\d+$": { - "$ref": "#/$defs/ShaderKey" - } - }, - "additionalProperties": false - }, - "Comment": { - "$ref": "#/$defs/MayVary" - }, - "Samplers": { - "type": "object", - "patternProperties": { - "^\\d+$": { - "$ref": "#/$defs/MayVary" - } - }, - "additionalProperties": false - }, - "Constants": { - "type": "object", - "patternProperties": { - "^\\d+$": { - "$ref": "#/$defs/MayVary" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false, - "$defs": { - "ShaderKeyValue": { - "type": "object", - "properties": { - "Label": { - "type": "string" - }, - "Description": { - "type": "string" - } - }, - "additionalProperties": false - }, - "ShaderKey": { - "type": "object", - "properties": { - "Label": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Values": { - "type": "object", - "patternProperties": { - "^\\d+$": { - "$ref": "#/$defs/ShaderKeyValue" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "Varying": { - "type": "object", - "properties": { - "Vary": { - "type": "array", - "items": { - "$ref": "#/$defs/LaxInteger" - } - }, - "Selectors": { - "description": "Keys are Σ 31^i shaderKey(Vary[i]).", - "type": "object", - "patternProperties": { - "^\\d+$": { - "type": "integer" - } - }, - "additionalProperties": false - }, - "Items": { - "type": "array", - "$comment": "Varying is defined by constraining this array's items to T" - } - }, - "required": [ - "Vary", - "Selectors", - "Items" - ], - "additionalProperties": false - }, - "MayVary": { - "oneOf": [ - { - "type": ["string", "null"] - }, { - "allOf": [ - { - "$ref": "#/$defs/Varying" - }, { - "type": "object", - "properties": { - "Items": { - "type": "array", - "items": { - "type": ["string", "null"] - } - } - } - } - ] - } - ] - }, - "Sampler": { - "type": ["object", "null"], - "properties": { - "Label": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DefaultTexture": { - "type": "string", - "pattern": "^[^/\\\\][^\\\\]*$" - } - }, - "additionalProperties": false - }, - "MayVary": { - "oneOf": [ - { - "$ref": "#/$defs/Sampler" - }, { - "allOf": [ - { - "$ref": "#/$defs/Varying" - }, { - "type": "object", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/$defs/Sampler" - } - } - } - } - ] - } - ] - }, - "ConstantBase": { - "type": "object", - "properties": { - "Offset": { - "description": "Defaults to 0. Mutually exclusive with ByteOffset.", - "type": "integer", - "minimum": 0 - }, - "Length": { - "description": "Defaults to up to the end. Mutually exclusive with ByteLength.", - "type": "integer", - "minimum": 0 - }, - "ByteOffset": { - "description": "Defaults to 0. Mutually exclusive with Offset.", - "type": "integer", - "minimum": 0 - }, - "ByteLength": { - "description": "Defaults to up to the end. Mutually exclusive with Length.", - "type": "integer", - "minimum": 0 - }, - "Group": { - "description": "Defaults to \"Further Constants\".", - "type": "string" - }, - "Label": { - "type": "string" - }, - "Description": { - "description": "Defaults to empty.", - "type": "string" - }, - "Type": { - "description": "Defaults to Float.", - "enum": ["Hidden", "Float", "Integer", "Color", "Enum", "Int32", "Int32Enum", "Int8", "Int8Enum", "Int16", "Int16Enum", "Int64", "Int64Enum", "Half", "Double", "TileIndex", "SphereMapIndex"] - } - }, - "not": { - "anyOf": [ - { - "required": ["Offset", "ByteOffset"] - }, { - "required": ["Length", "ByteLenngth"] - } - ] - } - }, - "HiddenConstant": { - "type": "object", - "properties": { - "Type": { - "const": "Hidden" - } - }, - "required": [ - "Type" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "FloatConstant": { - "type": "object", - "properties": { - "Type": { - "enum": ["Float", "Half", "Double"] - }, - "Minimum": { - "description": "Defaults to -∞.", - "type": "number" - }, - "Maximum": { - "description": "Defaults to ∞.", - "type": "number" - }, - "Speed": { - "description": "Defaults to 0.1.", - "type": "number", - "minimum": 0 - }, - "RelativeSpeed": { - "description": "Defaults to 0.", - "type": "number", - "minimum": 0 - }, - "Exponent": { - "description": "Defaults to 1. Uses an odd pseudo-power function, f(x) = sgn(x) |x|^n.", - "type": "number" - }, - "Factor": { - "description": "Defaults to 1.", - "type": "number" - }, - "Bias": { - "description": "Defaults to 0.", - "type": "number" - }, - "Precision": { - "description": "Defaults to 3.", - "type": "integer", - "minimum": 0, - "maximum": 9 - }, - "Slider": { - "description": "Defaults to true. Drag has priority over this.", - "type": "boolean" - }, - "Drag": { - "description": "Defaults to true. Has priority over Slider.", - "type": "boolean" - }, - "Unit": { - "description": "Defaults to no unit.", - "type": "string" - } - }, - "required": [ - "Label" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "IntConstant": { - "type": "object", - "properties": { - "Type": { - "enum": ["Integer", "Int32", "Int8", "Int16", "Int64"] - }, - "Minimum": { - "description": "Defaults to -2^N, N being the explicit integer width specified in the type, or 32 for Int.", - "type": "number" - }, - "Maximum": { - "description": "Defaults to 2^N - 1, N being the explicit integer width specified in the type, or 32 for Int.", - "type": "number" - }, - "Speed": { - "description": "Defaults to 0.25.", - "type": "number", - "minimum": 0 - }, - "RelativeSpeed": { - "description": "Defaults to 0.", - "type": "number", - "minimum": 0 - }, - "Factor": { - "description": "Defaults to 1.", - "type": "number" - }, - "Bias": { - "description": "Defaults to 0.", - "type": "number" - }, - "Hex": { - "description": "Defaults to false. Has priority over Slider and Drag.", - "type": "boolean" - }, - "Slider": { - "description": "Defaults to true. Hex and Drag have priority over this.", - "type": "boolean" - }, - "Drag": { - "description": "Defaults to true. Has priority over Slider, but Hex has priority over this.", - "type": "boolean" - }, - "Unit": { - "description": "Defaults to no unit.", - "type": "string" - } - }, - "required": [ - "Label", - "Type" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "ColorConstant": { - "type": "object", - "properties": { - "Type": { - "const": "Color" - }, - "SquaredRgb": { - "description": "Defaults to false. Uses an odd pseudo-square function, f(x) = sgn(x) |x|².", - "type": "boolean" - }, - "Clamped": { - "description": "Defaults to false.", - "type": "boolean" - } - }, - "required": [ - "Label", - "Type" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "EnumValue": { - "type": "object", - "properties": { - "Label": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Label", - "Value" - ], - "additionalProperties": false - }, - "EnumConstant": { - "type": "object", - "properties": { - "Type": { - "enum": ["Enum", "Int32Enum", "Int8Enum", "Int16Enum", "Int64Enum"] - }, - "Values": { - "type": "array", - "items": { - "$ref": "#/$defs/EnumValue" - } - } - }, - "required": [ - "Label", - "Type" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "SpecialConstant": { - "type": "object", - "properties": { - "Type": { - "enum": ["TileIndex", "SphereMapIndex"] - } - }, - "required": [ - "Label", - "Type" - ], - "allOf": [ - { - "$ref": "#/$defs/ConstantBase" - } - ], - "unevaluatedProperties": false - }, - "Constant": { - "oneOf": [ - { - "$ref": "#/$defs/HiddenConstant" - }, { - "$ref": "#/$defs/FloatConstant" - }, { - "$ref": "#/$defs/IntConstant" - }, { - "$ref": "#/$defs/ColorConstant" - }, { - "$ref": "#/$defs/EnumConstant" - }, { - "$ref": "#/$defs/SpecialConstant" - } - ] - }, - "MayVary": { - "oneOf": [ - { - "type": ["array", "null"], - "items": { - "$ref": "#/$defs/Constant" - } - }, { - "allOf": [ - { - "$ref": "#/$defs/Varying" - }, { - "type": "object", - "properties": { - "Items": { - "type": "array", - "items": { - "type": ["array", "null"], - "items": { - "$ref": "#/$defs/Constant" - } - } - } - } - } - ] - } - ] - }, - "LaxInteger": { - "oneOf": [ - { - "type": "integer" - }, { - "type": "string", - "pattern": "^\\d+$" - } - ] - } - } -} diff --git a/schemas/structs/container.json b/schemas/structs/container.json deleted file mode 100644 index 74db4a23..00000000 --- a/schemas/structs/container.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Files": { - "description": "File redirections in this container. Keys are game paths, values are relative file paths.", - "type": [ "object", "null" ], - "patternProperties": { - "^[^/\\\\.:?][^\\\\?:]+$": { - "type": "string", - "pattern": "^[^/\\\\.:?][^?:]+$" - } - }, - "additionalProperties": false - }, - "FileSwaps": { - "description": "File swaps in this container. Keys are original game paths, values are actual game paths.", - "type": [ "object", "null" ], - "patternProperties": { - "^[^/\\\\.?:][^\\\\?:]+$": { - "type": "string", - "pattern": "^[^/\\\\.:?][^?:]+$" - } - }, - "additionalProperties": false - }, - "Manipulations": { - "type": [ "array", "null" ], - "items": { - "$ref": "manipulation.json" - } - } - } -} diff --git a/schemas/structs/group_combining.json b/schemas/structs/group_combining.json deleted file mode 100644 index e42edcb8..00000000 --- a/schemas/structs/group_combining.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "properties": { - "Type": { - "const": "Combining" - }, - "Options": { - "type": "array", - "items": { - "$ref": "option.json" - } - }, - "Containers": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "container.json" - }, - { - "properties": { - "Name": { - "type": [ "string", "null" ] - } - } - } - ] - } - } - } -} diff --git a/schemas/structs/group_imc.json b/schemas/structs/group_imc.json deleted file mode 100644 index 48a04bd9..00000000 --- a/schemas/structs/group_imc.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "properties": { - "Type": { - "const": "Imc" - }, - "AllVariants": { - "type": "boolean" - }, - "OnlyAttributes": { - "type": "boolean" - }, - "Identifier": { - "$ref": "meta_imc.json#ImcIdentifier" - }, - "DefaultEntry": { - "$ref": "meta_imc.json#ImcEntry" - }, - "Options": { - "type": "array", - "items": { - "$ref": "option.json", - "oneOf": [ - { - "properties": { - "AttributeMask": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - } - }, - "required": [ - "AttributeMask" - ] - }, - { - "properties": { - "IsDisableSubMod": { - "const": true - } - }, - "required": [ - "IsDisableSubMod" - ] - } - ] - } - } - } -} diff --git a/schemas/structs/group_multi.json b/schemas/structs/group_multi.json deleted file mode 100644 index ca7d4dfa..00000000 --- a/schemas/structs/group_multi.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Type": { - "const": "Multi" - }, - "Options": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "option.json" - }, - { - "$ref": "container.json" - }, - { - "properties": { - "Priority": { - "type": "integer" - } - } - } - ] - } - } - } -} - - - diff --git a/schemas/structs/group_single.json b/schemas/structs/group_single.json deleted file mode 100644 index 24cda88d..00000000 --- a/schemas/structs/group_single.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Type": { - "const": "Single" - }, - "Options": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "option.json" - }, - { - "$ref": "container.json" - } - ] - } - } - } -} diff --git a/schemas/structs/manipulation.json b/schemas/structs/manipulation.json deleted file mode 100644 index 81f2cef3..00000000 --- a/schemas/structs/manipulation.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Type": { - "enum": [ "Unknown", "Imc", "Eqdp", "Eqp", "Est", "Gmp", "Rsp", "GlobalEqp", "Atch", "Shp", "Atr" ] - }, - "Manipulation": { - "type": "object" - } - }, - "required": [ "Type", "Manipulation" ], - "oneOf": [ - { - "properties": { - "Type": { - "const": "Imc" - }, - "Manipulation": { - "$ref": "meta_imc.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Eqdp" - }, - "Manipulation": { - "$ref": "meta_eqdp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Eqp" - }, - "Manipulation": { - "$ref": "meta_eqp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Est" - }, - "Manipulation": { - "$ref": "meta_est.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Gmp" - }, - "Manipulation": { - "$ref": "meta_gmp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Rsp" - }, - "Manipulation": { - "$ref": "meta_rsp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "GlobalEqp" - }, - "Manipulation": { - "$ref": "meta_geqp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Atch" - }, - "Manipulation": { - "$ref": "meta_atch.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Shp" - }, - "Manipulation": { - "$ref": "meta_shp.json" - } - } - }, - { - "properties": { - "Type": { - "const": "Atr" - }, - "Manipulation": { - "$ref": "meta_atr.json" - } - } - } - ] -} diff --git a/schemas/structs/meta_atch.json b/schemas/structs/meta_atch.json deleted file mode 100644 index 3c9cbef5..00000000 --- a/schemas/structs/meta_atch.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "object", - "properties": { - "Bone": { - "type": "string", - "maxLength": 34 - }, - "Scale": { - "type": "number" - }, - "OffsetX": { - "type": "number" - }, - "OffsetY": { - "type": "number" - }, - "OffsetZ": { - "type": "number" - }, - "RotationX": { - "type": "number" - }, - "RotationY": { - "type": "number" - }, - "RotationZ": { - "type": "number" - } - }, - "required": [ - "Bone", - "Scale", - "OffsetX", - "OffsetY", - "OffsetZ", - "RotationX", - "RotationY", - "RotationZ" - ] - }, - "Gender": { - "$ref": "meta_enums.json#Gender" - }, - "Race": { - "$ref": "meta_enums.json#ModelRace" - }, - "Type": { - "type": "string", - "minLength": 1, - "maxLength": 4 - }, - "Index": { - "$ref": "meta_enums.json#U16" - } - }, - "required": [ - "Entry", - "Gender", - "Race", - "Type", - "Index" - ] -} diff --git a/schemas/structs/meta_atr.json b/schemas/structs/meta_atr.json deleted file mode 100644 index 479d4127..00000000 --- a/schemas/structs/meta_atr.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "boolean" - }, - "Slot": { - "$ref": "meta_enums.json#HumanSlot" - }, - "Id": { - "$ref": "meta_enums.json#U16" - }, - "Attribute": { - "type": "string", - "minLength": 5, - "maxLength": 30, - "pattern": "^atrx_" - }, - "GenderRaceCondition": { - "enum": [ 0, 101, 201, 301, 401, 501, 601, 701, 801, 901, 1001, 1101, 1201, 1301, 1401, 1501, 1601, 1701, 1801 ] - } - }, - "required": [ - "Attribute" - ] -} diff --git a/schemas/structs/meta_enums.json b/schemas/structs/meta_enums.json deleted file mode 100644 index bad184e0..00000000 --- a/schemas/structs/meta_enums.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "$defs": { - "EquipSlot": { - "$anchor": "EquipSlot", - "enum": [ "Unknown", "MainHand", "OffHand", "Head", "Body", "Hands", "Belt", "Legs", "Feet", "Ears", "Neck", "Wrists", "RFinger", "BothHand", "LFinger", "HeadBody", "BodyHandsLegsFeet", "SoulCrystal", "LegsFeet", "FullBody", "BodyHands", "BodyLegsFeet", "ChestHands", "Nothing", "All" ] - }, - "HumanSlot": { - "$anchor": "HumanSlot", - "enum": [ "Head", "Body", "Hands", "Legs", "Feet", "Ears", "Neck", "Wrists", "RFinger", "LFinger", "Hair", "Face", "Ear", "Glasses", "Unknown" ] - }, - "Gender": { - "$anchor": "Gender", - "enum": [ "Unknown", "Male", "Female", "MaleNpc", "FemaleNpc" ] - }, - "ModelRace": { - "$anchor": "ModelRace", - "enum": [ "Unknown", "Midlander", "Highlander", "Elezen", "Lalafell", "Miqote", "Roegadyn", "AuRa", "Hrothgar", "Viera" ] - }, - "ObjectType": { - "$anchor": "ObjectType", - "enum": [ "Unknown", "Vfx", "DemiHuman", "Accessory", "World", "Housing", "Monster", "Icon", "LoadingScreen", "Map", "Interface", "Equipment", "Character", "Weapon", "Font" ] - }, - "BodySlot": { - "$anchor": "BodySlot", - "enum": [ "Unknown", "Hair", "Face", "Tail", "Body", "Zear" ] - }, - "SubRace": { - "$anchor": "SubRace", - "enum": [ "Unknown", "Midlander", "Highlander", "Wildwood", "Duskwight", "Plainsfolk", "Dunesfolk", "SeekerOfTheSun", "KeeperOfTheMoon", "Seawolf", "Hellsguard", "Raen", "Xaela", "Helion", "Lost", "Rava", "Veena" ] - }, - "ShapeConnectorCondition": { - "$anchor": "ShapeConnectorCondition", - "enum": [ "None", "Wrists", "Waist", "Ankles" ] - }, - "U8": { - "$anchor": "U8", - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - { - "type": "string", - "pattern": "^0*(1[0-9][0-9]|[0-9]?[0-9]|2[0-4][0-9]|25[0-5])$" - } - ] - }, - "U16": { - "$anchor": "U16", - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - { - "type": "string", - "pattern": "^0*([1-5][0-9]{4}|[0-9]{0,4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$" - } - ] - } - } -} diff --git a/schemas/structs/meta_eqdp.json b/schemas/structs/meta_eqdp.json deleted file mode 100644 index f27606b9..00000000 --- a/schemas/structs/meta_eqdp.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - }, - "Gender": { - "$ref": "meta_enums.json#Gender" - }, - "Race": { - "$ref": "meta_enums.json#ModelRace" - }, - "SetId": { - "$ref": "meta_enums.json#U16" - }, - "Slot": { - "$ref": "meta_enums.json#EquipSlot" - } - }, - "required": [ - "Entry", - "Gender", - "Race", - "SetId", - "Slot" - ] -} diff --git a/schemas/structs/meta_eqp.json b/schemas/structs/meta_eqp.json deleted file mode 100644 index c829d7a7..00000000 --- a/schemas/structs/meta_eqp.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "integer" - }, - "SetId": { - "$ref": "meta_enums.json#U16" - }, - "Slot": { - "$ref": "meta_enums.json#EquipSlot" - } - }, - "required": [ - "Entry", - "SetId", - "Slot" - ] -} diff --git a/schemas/structs/meta_est.json b/schemas/structs/meta_est.json deleted file mode 100644 index 22bce12b..00000000 --- a/schemas/structs/meta_est.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "$ref": "meta_enums.json#U16" - }, - "Gender": { - "$ref": "meta_enums.json#Gender" - }, - "Race": { - "$ref": "meta_enums.json#ModelRace" - }, - "SetId": { - "$ref": "meta_enums.json#U16" - }, - "Slot": { - "enum": [ "Hair", "Face", "Body", "Head" ] - } - }, - "required": [ - "Entry", - "Gender", - "Race", - "SetId", - "Slot" - ] -} diff --git a/schemas/structs/meta_geqp.json b/schemas/structs/meta_geqp.json deleted file mode 100644 index e38fbb86..00000000 --- a/schemas/structs/meta_geqp.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Condition": { - "$ref": "meta_enums.json#U16" - }, - "Type": { - "enum": [ "DoNotHideEarrings", "DoNotHideNecklace", "DoNotHideBracelets", "DoNotHideRingR", "DoNotHideRingL", "DoNotHideHrothgarHats", "DoNotHideVieraHats", "HideHorns", "HideVieraEars", "HideMiqoteEars" ] - } - }, - "required": [ "Type" ], - "oneOf": [ - { - "properties": { - "Type": { - "const": [ "DoNotHideHrothgarHats", "DoNotHideVieraHats", "HideHorns", "HideVieraEars", "HideMiqoteEars" ] - }, - "Condition": { - "const": 0 - } - } - }, - { - "properties": { - "Type": { - "const": [ "DoNotHideHrothgarHats", "DoNotHideVieraHats", "HideHorns", "HideVieraEars", "HideMiqoteEars" ] - } - } - }, - { - "properties": { - "Type": { - "const": [ "DoNotHideEarrings", "DoNotHideNecklace", "DoNotHideBracelets", "DoNotHideRingR", "DoNotHideRingL" ] - }, - "Condition": {} - } - } - ] -} diff --git a/schemas/structs/meta_gmp.json b/schemas/structs/meta_gmp.json deleted file mode 100644 index bf1fb1df..00000000 --- a/schemas/structs/meta_gmp.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "object", - "properties": { - "Enabled": { - "type": "boolean" - }, - "Animated": { - "type": "boolean" - }, - "RotationA": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - }, - "RotationB": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - }, - "RotationC": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - }, - "UnknownA": { - "type": "integer", - "minimum": 0, - "maximum": 15 - }, - "UnknownB": { - "type": "integer", - "minimum": 0, - "maximum": 15 - } - }, - "required": [ - "Enabled", - "Animated", - "RotationA", - "RotationB", - "RotationC", - "UnknownA", - "UnknownB" - ], - "additionalProperties": false - }, - "SetId": { - "$ref": "meta_enums.json#U16" - } - }, - "required": [ - "Entry", - "SetId" - ] -} diff --git a/schemas/structs/meta_imc.json b/schemas/structs/meta_imc.json deleted file mode 100644 index aa9a4fca..00000000 --- a/schemas/structs/meta_imc.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "$ref": "#ImcEntry" - } - }, - "required": [ - "Entry" - ], - "allOf": [ - { - "$ref": "#ImcIdentifier" - } - ], - "$defs": { - "ImcIdentifier": { - "type": "object", - "properties": { - "PrimaryId": { - "$ref": "meta_enums.json#U16" - }, - "SecondaryId": { - "$ref": "meta_enums.json#U16" - }, - "Variant": { - "$ref": "meta_enums.json#U8" - }, - "ObjectType": { - "$ref": "meta_enums.json#ObjectType" - }, - "EquipSlot": { - "$ref": "meta_enums.json#EquipSlot" - }, - "BodySlot": { - "$ref": "meta_enums.json#BodySlot" - } - }, - "$anchor": "ImcIdentifier", - "required": [ - "PrimaryId", - "SecondaryId", - "Variant", - "ObjectType", - "EquipSlot", - "BodySlot" - ] - }, - "ImcEntry": { - "type": "object", - "properties": { - "MaterialId": { - "$ref": "meta_enums.json#U8" - }, - "DecalId": { - "$ref": "meta_enums.json#U8" - }, - "VfxId": { - "$ref": "meta_enums.json#U8" - }, - "MaterialAnimationId": { - "$ref": "meta_enums.json#U8" - }, - "AttributeMask": { - "type": "integer", - "minimum": 0, - "maximum": 1023 - }, - "SoundId": { - "type": "integer", - "minimum": 0, - "maximum": 63 - } - }, - "$anchor": "ImcEntry", - "required": [ - "MaterialId", - "DecalId", - "VfxId", - "MaterialAnimationId", - "AttributeMask", - "SoundId" - ] - } - } -} diff --git a/schemas/structs/meta_rsp.json b/schemas/structs/meta_rsp.json deleted file mode 100644 index 3354281b..00000000 --- a/schemas/structs/meta_rsp.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "number" - }, - "SubRace": { - "$ref": "meta_enums.json#SubRace" - }, - "Attribute": { - "enum": [ "MaleMinSize", "MaleMaxSize", "MaleMinTail", "MaleMaxTail", "FemaleMinSize", "FemaleMaxSize", "FemaleMinTail", "FemaleMaxTail", "BustMinX", "BustMinY", "BustMinZ", "BustMaxX", "BustMaxY", "BustMaxZ" ] - } - }, - "required": [ - "Entry", - "SubRace", - "Attribute" - ] -} diff --git a/schemas/structs/meta_shp.json b/schemas/structs/meta_shp.json deleted file mode 100644 index cb7fd0ec..00000000 --- a/schemas/structs/meta_shp.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Entry": { - "type": "boolean" - }, - "Slot": { - "$ref": "meta_enums.json#HumanSlot" - }, - "Id": { - "$ref": "meta_enums.json#U16" - }, - "Shape": { - "type": "string", - "minLength": 5, - "maxLength": 30, - "pattern": "^shpx_" - }, - "ConnectorCondition": { - "$ref": "meta_enums.json#ShapeConnectorCondition" - }, - "GenderRaceCondition": { - "enum": [ 0, 101, 201, 301, 401, 501, 601, 701, 801, 901, 1001, 1101, 1201, 1301, 1401, 1501, 1601, 1701, 1801 ] - } - }, - "required": [ - "Shape" - ] -} diff --git a/schemas/structs/option.json b/schemas/structs/option.json deleted file mode 100644 index c45ccfdb..00000000 --- a/schemas/structs/option.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "type": "object", - "properties": { - "Name": { - "description": "Name of the option.", - "type": "string", - "minLength": 1 - }, - "Description": { - "description": "Description of the option.", - "type": [ "string", "null" ] - }, - "Priority": { - "description": "Priority of the option. If several enabled options within the group define conflicting files or manipulations, the highest priority wins.", - "type": "integer" - }, - "Image": { - "description": "Unused by Penumbra.", - "type": [ "string", "null" ] - } - }, - "required": [ "Name" ] -}