WIP: Rework Load Order support for Red mods:

- separate sorting data from the items being sorted, allowing more control
- Use ObservableList as base, and persist when it changes

Author: Al12rs

Directory.Packages.props

@@ -26,8 +26,8 @@
     <PackageVersion Include="FetchBannerlordVersion" Version="1.0.6.45" />
     <PackageVersion Include="NLog" Version="5.2.8" />
     <PackageVersion Include="Noggog.CSharpExt" Version="2.64.0" />
-    <PackageVersion Include="ObservableCollections" Version="2.2.0" />
-    <PackageVersion Include="ObservableCollections.R3" Version="3.1.0" />
+    <PackageVersion Include="ObservableCollections" Version="3.3.1" />
+    <PackageVersion Include="ObservableCollections.R3" Version="3.3.1" />
     <PackageVersion Include="QoiSharp" Version="1.0.0" />
     <PackageVersion Include="R3" Version="1.2.9" />
     <PackageVersion Include="R3Extensions.Avalonia" Version="1.2.9" />

NexusMods.App.sln

@@ -268,8 +268,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.Reso
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.Resources.Resilience", "src\Abstractions\NexusMods.Abstractions.Resources.Resilience\NexusMods.Abstractions.Resources.Resilience.csproj", "{04219A58-C99C-4C3B-A477-5E4B29D1F275}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.Games.UI", "src\Abstractions\NexusMods.Abstractions.Games.UI\NexusMods.Abstractions.Games.UI.csproj", "{9303B42B-9525-4106-B60A-5AFAFB8944E7}"
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.UI", "src\Abstractions\NexusMods.Abstractions.UI\NexusMods.Abstractions.UI.csproj", "{A7417BB1-7E2C-413A-A999-546F021F683B}"
 EndProject
 Global
@@ -702,10 +700,6 @@ Global
 		{04219A58-C99C-4C3B-A477-5E4B29D1F275}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{04219A58-C99C-4C3B-A477-5E4B29D1F275}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{04219A58-C99C-4C3B-A477-5E4B29D1F275}.Release|Any CPU.Build.0 = Release|Any CPU
-		{9303B42B-9525-4106-B60A-5AFAFB8944E7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{9303B42B-9525-4106-B60A-5AFAFB8944E7}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{9303B42B-9525-4106-B60A-5AFAFB8944E7}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{9303B42B-9525-4106-B60A-5AFAFB8944E7}.Release|Any CPU.Build.0 = Release|Any CPU
 		{A7417BB1-7E2C-413A-A999-546F021F683B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{A7417BB1-7E2C-413A-A999-546F021F683B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A7417BB1-7E2C-413A-A999-546F021F683B}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -834,7 +828,6 @@ Global
 		{BE8C17C4-E3B0-4D07-8CD0-0D15C3CCA9D5} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
 		{D3BA5B5A-668A-443B-872C-3116CBB0BC0D} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
 		{04219A58-C99C-4C3B-A477-5E4B29D1F275} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
-		{9303B42B-9525-4106-B60A-5AFAFB8944E7} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
 		{A7417BB1-7E2C-413A-A999-546F021F683B} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution

benchmarks/NexusMods.Benchmarks/Benchmarks/Sorting.cs

@@ -1,6 +1,6 @@
 using BenchmarkDotNet.Attributes;
-using NexusMods.Abstractions.DataModel.Entities;
-using NexusMods.Abstractions.DataModel.Entities.Sorting;
+using NexusMods.Abstractions.Loadouts;
+using NexusMods.Abstractions.Loadouts.Sorting;
 using NexusMods.Benchmarks.Interfaces;
 using NexusMods.DataModel.Sorting;
 

src/Abstractions/NexusMods.Abstractions.GameLocators/GameInstallation.cs

@@ -1,5 +1,4 @@
 using NexusMods.Abstractions.GameLocators.GameCapabilities;
-using NexusMods.Abstractions.Games;
 using NexusMods.MnemonicDB.Abstractions;
 using NexusMods.Paths;
 

src/Abstractions/NexusMods.Abstractions.GameLocators/GameLocatorResult.cs

@@ -1,4 +1,3 @@
-using NexusMods.Abstractions.Games;
 using NexusMods.Paths;
 
 namespace NexusMods.Abstractions.GameLocators;

src/Abstractions/NexusMods.Abstractions.GameLocators/IGameLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators;
 
-namespace NexusMods.Abstractions.Games;
+namespace NexusMods.Abstractions.GameLocators;
 
 /// <summary>
 /// Additional store specific metadata for <see cref="GameLocatorResult"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/EADesktop/EADesktopLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.EADesktop;
 
-namespace NexusMods.Abstractions.Games.Stores.EADesktop;
+namespace NexusMods.Abstractions.GameLocators.Stores.EADesktop;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="IEADesktopGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/EGS/EpicLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.EGS;
 
-namespace NexusMods.Abstractions.Games.Stores.EGS;
+namespace NexusMods.Abstractions.GameLocators.Stores.EGS;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="IEpicGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/GOG/GOGLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.GOG;
 
-namespace NexusMods.Abstractions.Games.Stores.GOG;
+namespace NexusMods.Abstractions.GameLocators.Stores.GOG;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="IGogGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/Origin/OriginLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.Origin;
 
-namespace NexusMods.Abstractions.Games.Stores.Origin;
+namespace NexusMods.Abstractions.GameLocators.Stores.Origin;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="IOriginGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/Steam/SteamLocatorResultMetadata.cs

@@ -1,8 +1,7 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.Steam;
 using NexusMods.Paths;
 
-namespace NexusMods.Abstractions.Games.Stores.Steam;
+namespace NexusMods.Abstractions.GameLocators.Stores.Steam;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="ISteamGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/Xbox/XboxLocatorResultMetadata.cs

@@ -1,7 +1,6 @@
 using JetBrains.Annotations;
-using NexusMods.Abstractions.GameLocators.Stores.Xbox;
 
-namespace NexusMods.Abstractions.Games.Stores.Xbox;
+namespace NexusMods.Abstractions.GameLocators.Stores.Xbox;
 
 /// <summary>
 /// Metadata for games found that implement <see cref="IXboxGame"/>.

src/Abstractions/NexusMods.Abstractions.GameLocators/Trees/AGamePathNodeTree.cs

@@ -1,5 +1,4 @@
 using System.Diagnostics.CodeAnalysis;
-using NexusMods.Abstractions.Games.Trees;
 using NexusMods.Paths;
 using NexusMods.Paths.Trees;
 using NexusMods.Paths.Trees.Traits;

src/Abstractions/NexusMods.Abstractions.GameLocators/Trees/GamePathNode.cs

@@ -1,10 +1,8 @@
-using System.Runtime.CompilerServices;
-using NexusMods.Abstractions.GameLocators;
 using NexusMods.Paths;
 using NexusMods.Paths.Trees;
 using NexusMods.Paths.Trees.Traits;
 
-namespace NexusMods.Abstractions.Games.Trees;
+namespace NexusMods.Abstractions.GameLocators.Trees;
 
 /// <summary>
 ///     Represents a tree node used for storing a game pathed location.

src/Abstractions/NexusMods.Abstractions.Games.UI/NexusMods.Abstractions.Games.UI.csproj

@@ -3,10 +3,8 @@
 using NexusMods.Abstractions.Diagnostics.Emitters;
 using NexusMods.Abstractions.GameLocators;
 using NexusMods.Abstractions.GameLocators.GameCapabilities;
-using NexusMods.Abstractions.Games.UI;
 using NexusMods.Abstractions.IO;
 using NexusMods.Abstractions.Library.Installers;
-using NexusMods.Abstractions.Loadouts;
 using NexusMods.Abstractions.Loadouts.Synchronizers;
 using NexusMods.Abstractions.NexusWebApi.Types.V2;
 using NexusMods.MnemonicDB.Abstractions;
@@ -68,7 +66,7 @@ protected virtual ILoadoutSynchronizer MakeSynchronizer(IServiceProvider provide
     public virtual IDiagnosticEmitter[] DiagnosticEmitters { get; } = [];
 
     /// <inheritdoc/>
-    public virtual IObservableSortableItemProvider[] SortableItemProviders { get; } = [];
+    public virtual ISortableItemProviderFactory[] SortableItemProviderFactories { get; } = [];
 
     /// <inheritdoc />
     public virtual ILoadoutSynchronizer Synchronizer => _synchronizer.Value;

src/Abstractions/NexusMods.Abstractions.Games/AGame.cs

@@ -1,6 +1,5 @@
 using NexusMods.Abstractions.Diagnostics.Emitters;
 using NexusMods.Abstractions.GameLocators;
-using NexusMods.Abstractions.Games.UI;
 using NexusMods.Abstractions.IO;
 using NexusMods.Abstractions.Library.Installers;
 using NexusMods.Abstractions.Loadouts.Synchronizers;
@@ -37,10 +36,10 @@ public interface IGame : ILocatableGame
     public IDiagnosticEmitter[] DiagnosticEmitters { get; }
 
     /// <summary>
-    /// An array of all instances of <see cref="ISortableItemProvider"/> supported
+    /// An array of all instances of <see cref="ISortableItemProviderFactory"/> supported
     /// by the game.
     /// </summary>
-    public IObservableSortableItemProvider[] SortableItemProviders { get; }
+    public ISortableItemProviderFactory[] SortableItemProviderFactories { get; }
 
     /// <summary>
     /// The synchronizer for this game.

src/Abstractions/NexusMods.Abstractions.Games/IGame.cs

@@ -0,0 +1,31 @@
+using NexusMods.Abstractions.Loadouts;
+using ObservableCollections;
+
+namespace NexusMods.Abstractions.Games;
+
+/// <summary>
+/// A loadout specific provider and manager of sortable items.
+/// </summary>
+public interface ILoadoutSortableItemProvider 
+{
+    /// <summary>
+    /// The ISortableItemProviderFactory that created this provider
+    /// </summary>
+    public ISortableItemProviderFactory ParentFactory { get; }
+    
+    /// <summary>
+    /// The id of the loadout that the sortable items are associated with
+    /// </summary>
+    public LoadoutId LoadoutId { get; }
+    
+    
+    public ObservableList<ISortableItem> SortableItems { get; }
+    
+    /// <summary>
+    /// Sets the relative position of a sortable item in the load order
+    /// </summary>
+    /// <param name="sortableItem">item to move</param>
+    /// <param name="delta">positive or negative index delta</param>
+    /// <returns></returns>
+    Task SetRelativePosition(ISortableItem sortableItem, int delta);
+}

src/Abstractions/NexusMods.Abstractions.Games/ILoadoutSortableItemProvider.cs

@@ -7,25 +7,34 @@ namespace NexusMods.Abstractions.Games;
 /// All items in the list will have a non-gaming sort index. If a item is moved the other items will
 /// adjust to compensate for the positional change.
 /// </summary>
-public interface ISortableItem
+public interface ISortableItem : IComparable<ISortableItem>
 {
     /// <summary>
-    /// The provider that contains all the items that can be sorted
+    /// Reference to the provider that manages this item
     /// </summary>
-    public ISortableItemProvider Provider { get; }
+    public ILoadoutSortableItemProvider SortableItemProvider { get; }
 
     /// <summary>
     /// The index of the item in a sorted list of item as given by the provider
     /// </summary>
-    public int SortIndex { get; }
+    public int SortIndex { get; set; }
 
     /// <summary>
-    /// This is used as the unique identifier for the entity.
+    /// Name of the item for display purposes
     /// </summary>
-    public EntityId EntityId { get; }
+    public string DisplayName { get; }
 
     /// <summary>
-    /// Moves the item relative to other items by the sepecified amount
+    /// The name of the winning mod containing the item
     /// </summary>
-    public Task SetRelativePosition(int delta);
+    public string ModName { get; set; }
+    
+    /// <summary>
+    /// Represents whether the item is active in the load order or not
+    /// An item is considered active if it is part of the load order and will be loaded by the game
+    /// An item is considered inactive if it is for some reason not going to be loaded by the game,
+    /// e.g. it is disabled in the load order, or parent mod is disabled.
+    /// </summary>
+    public bool IsActive { get; set; }
+    
 }

src/Abstractions/NexusMods.Abstractions.Games/IObservableSortableItemProvider.cs

@@ -0,0 +1,21 @@
+using NexusMods.Abstractions.Loadouts;
+
+namespace NexusMods.Abstractions.Games;
+
+
+/// <summary>
+/// A factory for creating providers for sortable items for specific loadouts
+/// </summary>
+public interface ISortableItemProviderFactory
+{
+    /// <summary>
+    /// Returns a provider of sortable items for a specific loadout
+    /// </summary>
+    ILoadoutSortableItemProvider GetLoadoutSortableItemProvider(LoadoutId loadoutId);
+    
+    
+    /// <summary>
+    /// Returns id of the type of the loadout
+    /// </summary>
+    Guid StaticLoadOrderTypeId { get; }
+}

src/Abstractions/NexusMods.Abstractions.Games/ISortableItem.cs

@@ -1,11 +1,13 @@
-using NexusMods.Abstractions.UI;
+using NexusMods.Abstractions.Games;
 using ReactiveUI;
 using Unit = System.Reactive.Unit;
 
-namespace NexusMods.Abstractions.Games.UI;
+namespace NexusMods.Abstractions.UI;
 
-public interface IObservableSortableItemViewModel : IViewModelInterface
+public interface ISortableItemViewModel : IViewModelInterface
 {
+    public ISortableItem SortableItem { get; }
+    
     public ReactiveCommand<Unit, Unit> MoveUp { get; }
 
     public ReactiveCommand<Unit, Unit> MoveDown { get; }
@@ -14,13 +16,9 @@ public interface IObservableSortableItemViewModel : IViewModelInterface
 
     public int SortIndex { get; }
 
-    public string GroupName { get; }
-    
-    public string Name { get; }
 
-    public bool IsEnabled { get; }
+    public string DisplayName { get; }
 
-    public ReactiveCommand<bool, Unit> SetEnabled { get; }
-    
-    public string[] InCollections { get; }
+    public string GroupName { get; }
+
 }

src/Abstractions/NexusMods.Abstractions.Games/ISortableItemProvider.cs

@@ -0,0 +1,39 @@
+using JetBrains.Annotations;
+using NexusMods.Abstractions.Loadouts;
+using NexusMods.Abstractions.Loadouts.Attributes;
+using NexusMods.MnemonicDB.Abstractions.Attributes;
+using NexusMods.MnemonicDB.Abstractions.Models;
+
+namespace NexusMods.Abstractions.Games;
+
+/// <summary>
+/// Represents an item that is sorted in a Load Order
+/// This should not be used directly, but rather be extended by the game-specific implementation.
+/// 
+/// Each implementation should provide the game specific identifier used to map entries of the Load Order to items of the loadout. 
+/// E.g. the plugin name for Skyrim plugins, or the module uuid for BG3 pak files.
+/// </summary>
+[PublicAPI]
+public partial class SortableItemModel : IModelDefinition
+{
+    private const string Namespace = "NexusMods.Loadouts.SortableItemModel";
+    
+    /// <summary>
+    /// Name of the item for display purposes.
+    /// </summary>
+    public static readonly StringAttribute Name = new(Namespace, nameof(Name));
+    
+    /// <summary>
+    /// Reference to the Load Order that this item is part of.
+    /// </summary>
+    public static readonly ReferenceAttribute<LoadOrder> ParentLoadOrder = new(Namespace, nameof(ParentLoadOrder))
+    {
+        IsIndexed = true,
+    };
+    
+    /// <summary>
+    /// The order in which this item should be loaded relative to other items in the Load Order.
+    /// </summary>
+    public static readonly Int32Attribute SortIndex = new(Namespace, nameof(SortIndex));
+    
+}

src/Abstractions/NexusMods.Abstractions.Games/ISortableItemProviderFactory.cs

@@ -26,5 +26,6 @@
         <ProjectReference Include="..\NexusMods.Abstractions.Loadouts\NexusMods.Abstractions.Loadouts.csproj" />
         <ProjectReference Include="..\NexusMods.Abstractions.NexusWebApi\NexusMods.Abstractions.NexusWebApi.csproj" />
         <ProjectReference Include="..\NexusMods.Abstractions.UI\NexusMods.Abstractions.UI.csproj" />
+        <PackageReference Include="NexusMods.MnemonicDB.SourceGenerator" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     </ItemGroup>
 </Project>