Full Linux support

.github/workflows/release.yml

@@ -47,6 +47,8 @@ jobs:
       - name: Create Net Core Release
         # use publish for .NET Core
         run:  dotnet publish ${{ env.TOOL_PROJ_PATH }} --configuration Release -f net10.0 --output ./releases/net10.0 /p:DebugType=None /p:DebugSymbols=false
+      - name: Create Linux Release
+        run:  dotnet publish ${{ env.TOOL_PROJ_PATH }} --configuration Release -f net10.0 --runtime linux-x64 --self-contained true --output ./releases/linux-x64 /p:DebugType=None /p:DebugSymbols=false
       - name: Upload a Build Artifact
         uses: actions/upload-artifact@v7
         with:
@@ -117,4 +119,5 @@ jobs:
           generate_release_notes: true
           files: | 
             ./releases/net481/ModVerify.exe
-            ./releases/ModVerify-Net10.zip
+            ./releases/ModVerify-Net10.zip
+            ./releases/linux-x64/ModVerify

ModVerify.slnx

@@ -17,6 +17,8 @@
     <Project Path="modules/ModdingToolBase/src/Updater/ExternalUpdater.Core/ExternalUpdater.Core.csproj" />
   </Folder>
   <Folder Name="/PetroglyphTools/">
+    <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem.Test/PG.StarWarsGame.Engine.FileSystem.Test.csproj" />
+    <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem/PG.StarWarsGame.Engine.FileSystem.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine/PG.StarWarsGame.Engine.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Files.ALO/PG.StarWarsGame.Files.ALO.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Files.ChunkFiles/PG.StarWarsGame.Files.ChunkFiles.csproj" />

README.md

@@ -80,13 +80,42 @@ In general ModVerify has two operation mods.
 1. `verify` Verifying a game or mod 
 2. `createBaseline` Creating a baseline for a game or mod, that can be used for further verifications in order to verify you did not add more errors to your mods.
 
-### Example
-This is an example run configuration that analyzes a specific mod, uses a the FoC basline and writes the output into a dedicated directory: 
+### Examples
 
-```bash
+#### Example 1: Auto-detection with a custom baseline
+Analyzes a specific mod, uses the FoC baseline and writes the output into a dedicated directory:
+
+**Windows:**
+```bat
 .\ModVerify.exe verify --path "C:\My Games\FoC\Mods\MyMod" --outDir "C:\My Games\FoC\Mods\MyMod\verifyResults" --baseline ./focBaseline.json
 ```
 
+**Linux:**
+```bash
+./ModVerify verify \
+  --path "/home/user/games/FoC/Mods/MyMod" \
+  --outDir "/home/user/games/FoC/Mods/MyMod/verifyResults" \
+  --baseline ./focBaseline.json
+```
+
+#### Example 2: Manual mod setup with sub-mods, EaW fallback and default baseline
+Uses manual mod setup, including sub-mods and the EaW fallback game, and uses the default embedded baseline:
+
+**Windows:**
+```bat
+.\ModVerify.exe verify --mods "C:\My Games\FoC\Mods\MySubMod;C:\My Games\FoC\Mods\MyMod" --game "C:\My Games\FoC" --fallbackGame "C:\My Games\EaW" --engine FOC --useDefaultBaseline
+```
+
+**Linux:**
+```bash
+./ModVerify verify \
+  --mods "/home/user/games/FoC/Mods/MySubMod:/home/user/games/FoC/Mods/MyMod" \
+  --game "/home/user/games/FoC" \
+  --fallbackGame "/home/user/games/EaW" \
+  --engine FOC \
+  --useDefaultBaseline
+```
+
 ---
 
 ## Available Checks
@@ -116,6 +145,14 @@ The following verifiers are currently implemented:
 If you want to create your own baseline use the `createBaseline` option. 
 
 ### Example
+
+**Windows**
 ```bash
 ModVerify.exe createBaseline --outFile myBaseline.json --path "C:\My Games\FoC\Mods\MyMod"
 ```
+**Linux**
+```bash
+./ModVerify createBaseline \
+  --outFile myBaseline.json \
+  --path "C:\My Games\FoC\Mods\MyMod"
+```

src/ModVerify.CliApp/App/VerifyAction.cs

@@ -61,7 +61,8 @@ protected override VerificationBaseline GetBaseline(VerificationTarget verificat
         {
             Console.WriteLine();
             ModVerifyConsoleUtilities.WriteBaselineInfo(baseline, baselinePath);
-            Logger?.LogDebug("Using baseline {Baseline} from location '{Path}'", baseline.ToString(), baselinePath);
+            Logger?.LogDebug("Using baseline {Baseline} from location '{Path}'", 
+                baseline.ToString(), baselinePath ?? "Embedded");
             Console.WriteLine();
         }
         return baseline;

src/ModVerify.CliApp/ModVerify.CliApp.csproj

@@ -37,11 +37,11 @@
 		<PackageReference Include="Serilog.Extensions.Logging" Version="10.0.0" />
 		<PackageReference Include="AlamoEngineTools.SteamAbstraction" Version="5.0.7" />
 		<PackageReference Include="CommandLineParser" Version="2.9.1" />
-		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.5" />
-		<PackageReference Include="Microsoft.Extensions.Logging" Version="10.0.5" />
-		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.5" />
-		<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="10.0.5" />
-		<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="10.0.5" />
+		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.6" />
+		<PackageReference Include="Microsoft.Extensions.Logging" Version="10.0.6" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.6" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="10.0.6" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="10.0.6" />
 		<PackageReference Include="Serilog.Sinks.Console" Version="6.1.1" />
 		<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
 		<PackageReference Include="Serilog.Extensions.Logging.File" Version="3.0.0" />
@@ -62,15 +62,15 @@
 
 	<!-- Exclude System.Index from all dependencies, excluding Microsoft.Bcl.Memory -->
 	<ItemGroup>
-		<PackageReference Include="Vanara.Core" Version="5.0.1" Condition="'$(TargetFramework)' == 'net481'">
+		<PackageReference Include="Vanara.Core" Version="5.0.4" Condition="'$(TargetFramework)' == 'net481'">
 			<ExcludeAssets>compile</ExcludeAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
-		<PackageReference Include="IndexRange" Version="1.1.0" Condition="'$(TargetFramework)' == 'net481'">
+		<PackageReference Include="IndexRange" Version="1.1.1" Condition="'$(TargetFramework)' == 'net481'">
 			<ExcludeAssets>compile</ExcludeAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
-		<PackageReference Include="Microsoft.Bcl.Memory" Version="10.0.5" Condition="'$(TargetFramework)' == 'net481'" />
+		<PackageReference Include="Microsoft.Bcl.Memory" Version="10.0.6" Condition="'$(TargetFramework)' == 'net481'" />
 	</ItemGroup>
 
 	<ItemGroup>
@@ -82,6 +82,10 @@
 	  <ProjectReference Include="..\ModVerify\ModVerify.csproj" />
 	</ItemGroup>
 
+	<ItemGroup>
+	  <PackageReference Update="Microsoft.SourceLink.GitHub" Version="10.0.202" />
+	</ItemGroup>
+
 	<PropertyGroup Condition="'$(Configuration)' == 'Release'">
 		<WeaverConfiguration>
 			<Weavers>

src/ModVerify.CliApp/Reporting/BaselineSelector.cs

@@ -42,7 +42,7 @@ public VerificationBaseline SelectBaseline(VerificationTarget verificationTarget
             }
         }
 
-        if (!settings.ReportSettings.SearchBaselineLocally)
+        if (settings.ReportSettings is { SearchBaselineLocally: false, UseDefaultBaseline: false })
         {
             _logger?.LogDebug(ModVerifyConstants.ConsoleEventId, 
                 "No baseline path specified and local search is not enabled. Using empty baseline.");
@@ -134,7 +134,7 @@ internal static VerificationBaseline LoadEmbeddedBaseline(GameEngineType engineT
     private VerificationBaseline FindBaselineNonInteractive(VerificationTarget target, out string? usedPath)
     {
         if (_baselineFactory.TryFindBaselineInDirectory(
-                target.Location.TargetPath, 
+                target.Location.TargetPath,
                 b => IsBaselineCompatible(b, target),
                 out var baseline,
                 out usedPath))
@@ -144,6 +144,20 @@ private VerificationBaseline FindBaselineNonInteractive(VerificationTarget targe
         }
         _logger?.LogTrace("No baseline file found in taget path '{TargetPath}'.", target.Location.TargetPath);
         usedPath = null;
+        if (settings.ReportSettings.UseDefaultBaseline)
+        {
+            try
+            {
+                var defaultBaseline = LoadEmbeddedBaseline(target.Engine);
+                _logger?.LogInformation(ModVerifyConstants.ConsoleEventId, "Automatically applying default embedded baseline for engine '{Engine}'.", target.Engine);
+                return defaultBaseline;
+            }
+            catch (InvalidBaselineException)
+            {
+                throw new InvalidOperationException(
+                    "Invalid baseline packed along ModVerify App. Please reach out to the creators. Thanks!");
+            }
+        }
         return VerificationBaseline.Empty;
     }
 

src/ModVerify.CliApp/Settings/CommandLine/BaseModVerifyOptions.cs

@@ -25,10 +25,10 @@ internal abstract class BaseModVerifyOptions
                    "The argument cannot be combined with any of --mods, --game or --fallbackGame")]
     public string? TargetPath { get; init; }
 
-    [Option("mods", SetName = "manualPaths", Required = false, Default = null, Separator = ';',
-        HelpText = "The path of the mod to verify. To support submods, multiple paths can be separated using the ';' (semicolon) character. " +
+    [Option("mods", SetName = "manualPaths", Required = false, Default = null,
+        HelpText = "The path of the mod to verify. To support submods, multiple paths can be separated using the platform-specific path separator (';' on Windows, ':' on Linux). " +
                    "Leave empty, if you want to verify a game. If you want to use the interactive mode, leave this, --game and --fallbackGame empty.")]
-    public IList<string>? ModPaths { get; init; }
+    public string? ModPaths { get; init; }
 
     [Option("game", SetName = "manualPaths", Required = false, Default = null,
         HelpText = "The path of the base game. For FoC mods this points to the FoC installation, for EaW mods this points to the EaW installation. " +
@@ -47,10 +47,10 @@ internal abstract class BaseModVerifyOptions
     public GameEngineType? Engine { get; init; }
 
 
-    [Option("additionalFallbackPaths", Required = false, Separator = ';',
+    [Option("additionalFallbackPaths", Required = false,
         HelpText = "Additional fallback paths, which may contain assets that shall be included when doing the verification. Do not add EaW here. " +
-                   "Multiple paths can be separated using the ';' (semicolon) character.")]
-    public IList<string>? AdditionalFallbackPath { get; init; }
+                   "Multiple paths can be separated using the platform-specific path separator (';' on Windows, ':' on Linux).")]
+    public string? AdditionalFallbackPath { get; init; }
 
     [Option("parallel", Default = false,
         HelpText = "When set, game verifiers will run in parallel. " +

src/ModVerify.CliApp/Settings/CommandLine/VerifyVerbOption.cs

@@ -29,13 +29,17 @@ internal sealed class VerifyVerbOption : BaseModVerifyOptions
     public bool IgnoreAsserts { get; init; }
 
 
-    [Option("baseline", SetName = "baselineSelection", Required = false, 
-        HelpText = "Path to a JSON baseline file. Cannot be used together with --searchBaseline.")]
+    [Option("baseline", Required = false, 
+        HelpText = "Path to a JSON baseline file. Cannot be used together with --searchBaseline or --useDefaultBaseline.")]
     public string? Baseline { get; init; }
 
-    [Option("searchBaseline", SetName = "baselineSelection", Required = false,
-        HelpText = "When set, the application will search for baseline files and use them for verification. Cannot be used together with --baseline")]
+    [Option("searchBaseline", Required = false,
+        HelpText = "When set, the application will search for baseline files and use them for verification. Cannot be used together with --baseline or --useDefaultBaseline")]
     public bool SearchBaselineLocally { get; init; }
 
+    [Option("useDefaultBaseline", Required = false,
+        HelpText = "When set, the application will use the default embedded baseline for the detected game engine. Cannot be used together with --baseline or --searchBaseline.")]
+    public bool UseDefaultBaseline { get; init; }
+
     public bool IsRunningWithoutArguments { get; init; }
 }

src/ModVerify.CliApp/Settings/ModVerifyAppSettings.cs

@@ -17,6 +17,7 @@ public sealed class VerifyReportSettings : AppReportSettings
 {
     public string? BaselinePath { get; init; }
     public bool SearchBaselineLocally { get; init; }
+    public bool UseDefaultBaseline { get; init; }
 }
 
 internal abstract class AppSettingsBase(AppReportSettings reportSettings)

src/ModVerify.CliApp/Settings/SettingsBuilder.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO.Abstractions;
+using System.Linq;
 
 namespace AET.ModVerify.App.Settings;
 
@@ -57,6 +58,20 @@ void ValidateVerb()
                 throw new AppArgumentException($"Options {searchOption} and {baselineOption} cannot be used together.");
             }
 
+            if (verifyOptions.UseDefaultBaseline && !string.IsNullOrEmpty(verifyOptions.Baseline))
+            {
+                var useDefaultOption = typeof(VerifyVerbOption).GetOptionName(nameof(VerifyVerbOption.UseDefaultBaseline));
+                var baselineOption = typeof(VerifyVerbOption).GetOptionName(nameof(VerifyVerbOption.Baseline));
+                throw new AppArgumentException($"Options {useDefaultOption} and {baselineOption} cannot be used together.");
+            }
+
+            if (verifyOptions is { UseDefaultBaseline: true, SearchBaselineLocally: true })
+            {
+                var useDefaultOption = typeof(VerifyVerbOption).GetOptionName(nameof(VerifyVerbOption.UseDefaultBaseline));
+                var searchOption = typeof(VerifyVerbOption).GetOptionName(nameof(VerifyVerbOption.SearchBaselineLocally));
+                throw new AppArgumentException($"Options {useDefaultOption} and {searchOption} cannot be used together.");
+            }
+
             if (verifyOptions is { FailFast: true, MinimumFailureSeverity: null })
             {
                 var failFast = typeof(VerifyVerbOption).GetOptionName(nameof(VerifyVerbOption.FailFast));
@@ -86,6 +101,7 @@ VerifyReportSettings BuildReportSettings()
                 BaselinePath = verifyOptions.Baseline,
                 MinimumReportSeverity = verifyOptions.MinimumSeverity,
                 SearchBaselineLocally = verifyOptions.SearchBaselineLocally,
+                UseDefaultBaseline = verifyOptions.UseDefaultBaseline,
                 SuppressionsPath = verifyOptions.Suppressions,
                 Verbose = verifyOptions.Verbose
             };
@@ -121,24 +137,20 @@ AppReportSettings BuildReportSettings()
 
     private VerificationTargetSettings BuildTargetSettings(BaseModVerifyOptions options)
     {
+        var separator = _fileSystem.Path.PathSeparator;
+
         var modPaths = new List<string>();
-        if (options.ModPaths is not null)
+        if (!string.IsNullOrEmpty(options.ModPaths))
         {
-            foreach (var mod in options.ModPaths)
-            {
-                if (!string.IsNullOrEmpty(mod))
-                    modPaths.Add(_fileSystem.Path.GetFullPath(mod));
-            }
+            var split = options.ModPaths!.Split([separator], StringSplitOptions.RemoveEmptyEntries);
+            modPaths.AddRange(split.Select(s => _fileSystem.Path.GetFullPath(s)));
         }
 
         var fallbackPaths = new List<string>();
-        if (options.AdditionalFallbackPath is not null)
+        if (!string.IsNullOrEmpty(options.AdditionalFallbackPath))
         {
-            foreach (var fallback in options.AdditionalFallbackPath)
-            {
-                if (!string.IsNullOrEmpty(fallback))
-                    fallbackPaths.Add(_fileSystem.Path.GetFullPath(fallback));
-            }
+            var split = options.AdditionalFallbackPath!.Split([separator], StringSplitOptions.RemoveEmptyEntries);
+            fallbackPaths.AddRange(split.Select(s => _fileSystem.Path.GetFullPath(s)));
         }
 
         var gamePath = options.GamePath;

src/ModVerify/ModVerify.csproj

@@ -27,8 +27,8 @@
 
 	<ItemGroup>
 		<PackageReference Include="AnakinRaW.CommonUtilities.SimplePipeline" Version="13.0.18" />
-		<PackageReference Include="System.Text.Json" Version="10.0.5" />
-		<PackageReference Include="JsonSchema.Net" Version="9.1.3" />
+		<PackageReference Include="System.Text.Json" Version="10.0.6" />
+		<PackageReference Include="JsonSchema.Net" Version="9.2.0" />
 	</ItemGroup>
 
 	<ItemGroup>
@@ -42,4 +42,8 @@
 		<ProjectReference Include="..\PetroglyphTools\PG.StarWarsGame.Engine\PG.StarWarsGame.Engine.csproj" />
 		<ProjectReference Include="..\PetroglyphTools\PG.StarWarsGame.Files.ALO\PG.StarWarsGame.Files.ALO.csproj" />
 	</ItemGroup>
+
+	<ItemGroup>
+	  <PackageReference Update="Microsoft.SourceLink.GitHub" Version="10.0.202" />
+	</ItemGroup>
 </Project>

src/ModVerify/Verifiers/Commons/AudioFileVerifier.cs

@@ -14,6 +14,8 @@ public class AudioFileVerifier : GameVerifier<AudioFileInfo>
 {
     private readonly IAlreadyVerifiedCache? _alreadyVerifiedCache;
 
+    public override string FriendlyName => "Audio File format";
+
     public AudioFileVerifier(GameVerifierBase parent) : base(parent)
     {
         _alreadyVerifiedCache = Services.GetService<IAlreadyVerifiedCache>();
@@ -27,8 +29,6 @@ public AudioFileVerifier(IGameVerifierInfo? parent,
         _alreadyVerifiedCache = serviceProvider.GetService<IAlreadyVerifiedCache>();
     }
 
-    public override string FriendlyName => "Audio File format";
-
     public override void Verify(AudioFileInfo sampleInfo, IReadOnlyCollection<string> contextInfo, CancellationToken token)
     {
         var cached = _alreadyVerifiedCache?.GetEntry(sampleInfo.SampleName);