Skip to content

Make material name parsing more lax #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NotAdam merged 2 commits into from
May 11, 2026
Merged

Make material name parsing more lax #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13bcd11
Make material name parsing more lax
Exter-N May 10, 2026
bff0ff7
Make strictness of name parsing an option
Exter-N May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions src/Lumina/Models/Materials/Material.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text.RegularExpressions;
using Lumina.Data;
using Lumina.Data.Files;
Expand Down Expand Up @@ -137,6 +138,12 @@ public Material Update( GameData data )
return this;
}

/// <inheritdoc cref="ResolveRelativeMaterialPath(string,int,bool)"/>
/// <remarks>This overload is present to maintain compatibility with already compiled binaries and will eventually be removed.</remarks>
[OverloadResolutionPriority( 0 )]
public static string? ResolveRelativeMaterialPath( string relativePath, int variantId )
=> ResolveRelativeMaterialPath( relativePath, variantId, true );

/// <summary>
/// Resolves a relative material path in the form <c>/mt_c0101e0001_top_a.mtrl</c>
/// into its full path, <c>chara/equipment/e0001/material/v{variantId}/mt_c0101e0001_top_a.mtrl</c>.
Expand All @@ -145,20 +152,22 @@ public Material Update( GameData data )
/// </summary>
/// <param name="relativePath">The relative path of the provided material.</param>
/// <param name="variantId">The variant to use in material resolution.</param>
/// <param name="strictSuffixValidation">Whether to strictly validate suffixes. If dealing with mods, you may want to turn this off.</param>
/// <returns>The resolved, absolute path to the requested material, or null if unsuccessful.</returns>
public static string? ResolveRelativeMaterialPath( string relativePath, int variantId )
[OverloadResolutionPriority( 1 )]
public static string? ResolveRelativeMaterialPath( string relativePath, int variantId, bool strictSuffixValidation = true )
{
Regex rx = MatNameRegex();
Regex rx = strictSuffixValidation ? MatNameRegexStrictSuffix() : MatNameRegexLaxSuffix();
var result = rx.Match( relativePath );
if( !result.Success )
return null;

var id1 = result.Groups["id1"].Value[0];
var val1 = result.Groups["val1"].Value;
var id2 = result.Groups["id2"].Value[0];
var val2 = result.Groups["val2"].Value;
var id1 = result.Groups[ "id1" ].Value[ 0 ];
var val1 = result.Groups[ "val1" ].Value;
var id2 = result.Groups[ "id2" ].Value[ 0 ];
var val2 = result.Groups[ "val2" ].Value;

return (id1, id2) switch
return ( id1, id2 ) switch
{
('c', 'a') => $"chara/accessory/a{val2}/material/v{variantId:D4}{relativePath}",
('c', 'b') => $"chara/human/c{val1}/obj/body/b{val2}/material/v{variantId:D4}{relativePath}",
Expand All @@ -173,11 +182,14 @@ public Material Update( GameData data )
(_, _) => null
};
}

[GeneratedRegex(@"/mt_(?'id1'[cdmw])(?'val1'\d{4})(?'id2'[abefhtze])(?'val2'\d{4})_(?:\w{3}(?:_\w)|(?:\w))\.mtrl")]
private static partial Regex MatNameRegex();



[GeneratedRegex( @"/mt_(?'id1'[cdmw])(?'val1'\d{4})(?'id2'[abefhtze])(?'val2'\d{4})_(?:\w{3}_\w|\w)\.mtrl$" )]
private static partial Regex MatNameRegexStrictSuffix();

[GeneratedRegex( @"/mt_(?'id1'[cdmw])(?'val1'\d{4})(?'id2'[abefhtze])(?'val2'\d{4})_\w+\.mtrl$" )]
private static partial Regex MatNameRegexLaxSuffix();


/// <summary>
/// Parse the variant ID out of an existing absolute path to a .mtrl file.
/// </summary>
Expand Down Expand Up @@ -242,4 +254,4 @@ private void ReadStrings()
br.Dispose();
}
}
}
}
Loading