2.1.0 (#123)

# Patchnotes 2.1.0
The changes in this update are more than just "patches". With a new UI, a new feature, and a bunch of bug fixes, improvements and a new member on the dev team, we thought this was more of a minor update.

We would like to introduce @tsubasahane of MareCN to the team! We’re happy to work with them to bring Lightless and its features to the CN client as well as having another talented dev bring features and ideas to us. Speaking of which:

# Location Sharing (Big shout out to @tsubasahane for bringing this feature)

- Are you TIRED of scrambling to find the address of the venue you're in to share with your friends? We are introducing Location Sharing! An optional feature where you can share your location with direct pairs temporarily [30 minutes, 1 hour, 3 hours] minutes or until you turn it off for them. That's up to you! [#125](<#125>)  [#49](<Lightless-Sync/LightlessServer#49>)
- To share your location with a pair, click the three dots beside the pair and choose a duration to share with them. [#125](<#125>)  [#49](<Lightless-Sync/LightlessServer#49>)
- To view the location of someone who's shared with you, simply hover over the globe icon! [#125](<#125>)  [#49](<Lightless-Sync/LightlessServer#49>)

[1]

# Model Optimization (Mesh Decimating)
 - This new option can automatically “simplify” incoming character meshes to help performance by reducing triangle counts. You choose how strong the reduction is (default/recommended is 80%). [#131](<#131>)
 - Decimation only kicks in when a mesh is above a certain triangle threshold, and only for the items that qualify for it and you selected for. [#131](<#131>)
 - Hair meshes is always excluded, since simplifying hair meshes is very prone to breaking.
 - You can find everything under Settings → Performance → Model Optimization. [#131](<#131>)
+ ** IF YOU HAVE USED DECIMATION IN TESTING, PLEASE CLEAR YOUR CACHE ❗ **

[2]

# Animation (PAP) Validation (Safer animations)
 - Lightless now checks your currently animations to see if they work with your local skeleton/bone mod. If an animation matches, it’s included in what gets sent to other players. If it doesn’t, Lightless will skip it and write a warning to your log showing how many were skipped due to skeleton changes. Its defaulted to Unsafe (off). turn it on if you experience crashes from others users. [#131](<#131>)
 - Lightless also does the same kind of check for incoming animation files, to make sure they match the body/skeleton they were sent with. [#131](<#131>)
 - Because these checks can sometimes be a little picky, you can adjust how strict they are in Settings -> General -> Animation & Bones to reduce false positives. [#131](<#131>)

# UI Changes (Thanks to @kyuwu for UI Changes)
- The top part of the main screen has gotten a makeover. You can adjust the colors of the gradiant in the Color settings of Lightless. [#127](<#127>)

[3]

- Settings have gotten some changes as well to make this change more universal, and will use the same color settings. [#127](<#127>)
- The particle effects of the gradient are toggleable in 'Settings -> UI -> Behavior' [#127](<#127>)
- Instead of showing download/upload on bottom of Main UI, it will show VRAM usage and triangles with their optimization options next to it [#138](<#138>)

# LightFinder / ShellFinder
- UI Changes that follow our new design follow the color codes for the Gradient top as the main screen does.  [#127](<#127>)

[4]

Co-authored-by: defnotken <itsdefnotken@gmail.com>
Co-authored-by: azyges <aaaaaa@aaa.aaa>
Co-authored-by: cake <admin@cakeandbanana.nl>
Co-authored-by: Tsubasa <tsubasa@noreply.git.lightless-sync.org>
Co-authored-by: choco <choco@patat.nl>
Co-authored-by: celine <aaa@aaa.aaa>
Co-authored-by: celine <celine@noreply.git.lightless-sync.org>
Co-authored-by: Tsubasahane <wozaiha@gmail.com>
Co-authored-by: cake <cake@noreply.git.lightless-sync.org>
Reviewed-on: #123

LightlessSync/PlayerData/Pairs/IPairHandlerAdapter.cs

@@ -1,43 +1,42 @@
-    using LightlessSync.API.Data;
+using LightlessSync.API.Data;
 
-    namespace LightlessSync.PlayerData.Pairs;
+namespace LightlessSync.PlayerData.Pairs;
 
-    /// <summary>
-    ///     orchestrates the lifecycle of a paired character
-    /// </summary>
-    public interface IPairHandlerAdapter : IDisposable, IPairPerformanceSubject
-    {
-        new string Ident { get; }
-        bool Initialized { get; }
-        bool IsVisible { get; }
-        bool ScheduledForDeletion { get; set; }
-        CharacterData? LastReceivedCharacterData { get; }
-        long LastAppliedDataBytes { get; }
-        new string? PlayerName { get; }
-        string PlayerNameHash { get; }
-        uint PlayerCharacterId { get; }
-        DateTime? LastDataReceivedAt { get; }
-        DateTime? LastApplyAttemptAt { get; }
-        DateTime? LastSuccessfulApplyAt { get; }
-        string? LastFailureReason { get; }
-        IReadOnlyList<string> LastBlockingConditions { get; }
-        bool IsApplying { get; }
-        bool IsDownloading { get; }
-        int PendingDownloadCount { get; }
-        int ForbiddenDownloadCount { get; }
-        bool PendingModReapply { get; }
-        bool ModApplyDeferred { get; }
-        int MissingCriticalMods { get; }
-        int MissingNonCriticalMods { get; }
-        int MissingForbiddenMods { get; }
-        DateTime? InvisibleSinceUtc { get; }
-        DateTime? VisibilityEvictionDueAtUtc { get; }
+/// <summary>
+///     orchestrates the lifecycle of a paired character
+/// </summary>
+public interface IPairHandlerAdapter : IDisposable, IPairPerformanceSubject
+{
+    new string Ident { get; }
+    bool Initialized { get; }
+    bool IsVisible { get; }
+    bool ScheduledForDeletion { get; set; }
+    CharacterData? LastReceivedCharacterData { get; }
+    long LastAppliedDataBytes { get; }
+    new string? PlayerName { get; }
+    string PlayerNameHash { get; }
+    uint PlayerCharacterId { get; }
+    DateTime? LastDataReceivedAt { get; }
+    DateTime? LastApplyAttemptAt { get; }
+    DateTime? LastSuccessfulApplyAt { get; }
+    string? LastFailureReason { get; }
+    IReadOnlyList<string> LastBlockingConditions { get; }
+    bool IsApplying { get; }
+    bool IsDownloading { get; }
+    int PendingDownloadCount { get; }
+    int ForbiddenDownloadCount { get; }
+    bool PendingModReapply { get; }
+    bool ModApplyDeferred { get; }
+    int MissingCriticalMods { get; }
+    int MissingNonCriticalMods { get; }
+    int MissingForbiddenMods { get; }
 
     void Initialize();
-        void ApplyData(CharacterData data);
-        void ApplyLastReceivedData(bool forced = false);
-        bool FetchPerformanceMetricsFromCache();
-        void LoadCachedCharacterData(CharacterData data);
-        void SetUploading(bool uploading);
-        void SetPaused(bool paused);
-    }
+    void ApplyData(CharacterData data);
+    void ApplyLastReceivedData(bool forced = false);
+    Task EnsurePerformanceMetricsAsync(CancellationToken cancellationToken);
+    bool FetchPerformanceMetricsFromCache();
+    void LoadCachedCharacterData(CharacterData data);
+    void SetUploading(bool uploading);
+    void SetPaused(bool paused);
+}

LightlessSync/PlayerData/Pairs/IPairPerformanceSubject.cs

@@ -16,4 +16,5 @@ public interface IPairPerformanceSubject
     long LastAppliedApproximateVRAMBytes { get; set; }
     long LastAppliedApproximateEffectiveVRAMBytes { get; set; }
     long LastAppliedDataTris { get; set; }
+    long LastAppliedApproximateEffectiveTris { get; set; }
 }

LightlessSync/PlayerData/Pairs/Pair.cs

@@ -69,6 +69,7 @@ public class Pair
     public string? PlayerName => TryGetHandler()?.PlayerName ?? UserPair.User.AliasOrUID;
     public long LastAppliedDataBytes => TryGetHandler()?.LastAppliedDataBytes ?? -1;
     public long LastAppliedDataTris => TryGetHandler()?.LastAppliedDataTris ?? -1;
+    public long LastAppliedApproximateEffectiveTris => TryGetHandler()?.LastAppliedApproximateEffectiveTris ?? -1;
     public long LastAppliedApproximateVRAMBytes => TryGetHandler()?.LastAppliedApproximateVRAMBytes ?? -1;
     public long LastAppliedApproximateEffectiveVRAMBytes => TryGetHandler()?.LastAppliedApproximateEffectiveVRAMBytes ?? -1;
     public string Ident => TryGetHandler()?.Ident ?? TryGetConnection()?.Ident ?? string.Empty;
@@ -216,12 +217,6 @@ public class Pair
         if (handler is null)
             return PairDebugInfo.Empty;
 
-        var now = DateTime.UtcNow;
-        var dueAt = handler.VisibilityEvictionDueAtUtc;
-        var remainingSeconds = dueAt.HasValue
-            ? Math.Max(0, (dueAt.Value - now).TotalSeconds)
-            : (double?)null;
-
         return new PairDebugInfo(
             true,
             handler.Initialized,
@@ -230,9 +225,6 @@ public class Pair
             handler.LastDataReceivedAt,
             handler.LastApplyAttemptAt,
             handler.LastSuccessfulApplyAt,
-            handler.InvisibleSinceUtc,
-            handler.VisibilityEvictionDueAtUtc,
-            remainingSeconds,
             handler.LastFailureReason,
             handler.LastBlockingConditions,
             handler.IsApplying,

LightlessSync/PlayerData/Pairs/PairCoordinator.Users.cs

@@ -125,6 +125,7 @@ public sealed partial class PairCoordinator
             }
         }
 
+        _mediator.Publish(new PairOnlineMessage(new PairUniqueIdentifier(dto.User.UID)));
         PublishPairDataChanged();
     }
 
@@ -136,7 +137,7 @@ public sealed partial class PairCoordinator
             _pendingCharacterData.TryRemove(user.UID, out _);
             if (registrationResult.Value.CharacterIdent is not null)
             {
-                _ = _handlerRegistry.DeregisterOfflinePair(registrationResult.Value);
+                _ = _handlerRegistry.DeregisterOfflinePair(registrationResult.Value, forceDisposal: true);
             }
 
             _mediator.Publish(new ClearProfileUserDataMessage(user));

LightlessSync/PlayerData/Pairs/PairDebugInfo.cs

@@ -8,9 +8,6 @@ public sealed record PairDebugInfo(
     DateTime? LastDataReceivedAt,
     DateTime? LastApplyAttemptAt,
     DateTime? LastSuccessfulApplyAt,
-    DateTime? InvisibleSinceUtc,
-    DateTime? VisibilityEvictionDueAtUtc,
-    double? VisibilityEvictionRemainingSeconds,
     string? LastFailureReason,
     IReadOnlyList<string> BlockingConditions,
     bool IsApplying,
@@ -32,9 +29,6 @@ public sealed record PairDebugInfo(
         null,
         null,
         null,
-        null,
-        null,
-        null,
         Array.Empty<string>(),
         false,
         false,

LightlessSync/PlayerData/Pairs/PairHandlerAdapterFactory.cs

@@ -1,12 +1,15 @@
 using LightlessSync.FileCache;
 using LightlessSync.Interop.Ipc;
+using LightlessSync.LightlessConfiguration;
 using LightlessSync.PlayerData.Factories;
 using LightlessSync.Services;
 using LightlessSync.Services.ActorTracking;
 using LightlessSync.Services.Mediator;
+using LightlessSync.Services.ModelDecimation;
 using LightlessSync.Services.PairProcessing;
 using LightlessSync.Services.ServerConfiguration;
 using LightlessSync.Services.TextureCompression;
+using Dalamud.Plugin.Services;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -25,13 +28,18 @@ internal sealed class PairHandlerAdapterFactory : IPairHandlerAdapterFactory
     private readonly IServiceProvider _serviceProvider;
     private readonly IHostApplicationLifetime _lifetime;
     private readonly FileCacheManager _fileCacheManager;
+    private readonly PlayerPerformanceConfigService _playerPerformanceConfigService;
     private readonly PlayerPerformanceService _playerPerformanceService;
     private readonly PairProcessingLimiter _pairProcessingLimiter;
     private readonly ServerConfigurationManager _serverConfigManager;
     private readonly TextureDownscaleService _textureDownscaleService;
+    private readonly ModelDecimationService _modelDecimationService;
     private readonly PairStateCache _pairStateCache;
     private readonly PairPerformanceMetricsCache _pairPerformanceMetricsCache;
     private readonly PenumbraTempCollectionJanitor _tempCollectionJanitor;
+    private readonly LightlessConfigService _configService;
+    private readonly XivDataAnalyzer _modelAnalyzer;
+    private readonly IFramework _framework;
 
     public PairHandlerAdapterFactory(
         ILoggerFactory loggerFactory,
@@ -42,15 +50,20 @@ internal sealed class PairHandlerAdapterFactory : IPairHandlerAdapterFactory
         FileDownloadManagerFactory fileDownloadManagerFactory,
         PluginWarningNotificationService pluginWarningNotificationManager,
         IServiceProvider serviceProvider,
+        IFramework framework,
         IHostApplicationLifetime lifetime,
         FileCacheManager fileCacheManager,
+        PlayerPerformanceConfigService playerPerformanceConfigService,
         PlayerPerformanceService playerPerformanceService,
         PairProcessingLimiter pairProcessingLimiter,
         ServerConfigurationManager serverConfigManager,
         TextureDownscaleService textureDownscaleService,
+        ModelDecimationService modelDecimationService,
         PairStateCache pairStateCache,
         PairPerformanceMetricsCache pairPerformanceMetricsCache,
-        PenumbraTempCollectionJanitor tempCollectionJanitor)
+        PenumbraTempCollectionJanitor tempCollectionJanitor,
+        XivDataAnalyzer modelAnalyzer,
+        LightlessConfigService configService)
     {
         _loggerFactory = loggerFactory;
         _mediator = mediator;
@@ -60,15 +73,20 @@ internal sealed class PairHandlerAdapterFactory : IPairHandlerAdapterFactory
         _fileDownloadManagerFactory = fileDownloadManagerFactory;
         _pluginWarningNotificationManager = pluginWarningNotificationManager;
         _serviceProvider = serviceProvider;
+        _framework = framework;
         _lifetime = lifetime;
         _fileCacheManager = fileCacheManager;
+        _playerPerformanceConfigService = playerPerformanceConfigService;
         _playerPerformanceService = playerPerformanceService;
         _pairProcessingLimiter = pairProcessingLimiter;
         _serverConfigManager = serverConfigManager;
         _textureDownscaleService = textureDownscaleService;
+        _modelDecimationService = modelDecimationService;
         _pairStateCache = pairStateCache;
         _pairPerformanceMetricsCache = pairPerformanceMetricsCache;
         _tempCollectionJanitor = tempCollectionJanitor;
+        _modelAnalyzer = modelAnalyzer;
+        _configService = configService;
     }
 
     public IPairHandlerAdapter Create(string ident)
@@ -86,15 +104,20 @@ internal sealed class PairHandlerAdapterFactory : IPairHandlerAdapterFactory
             downloadManager,
             _pluginWarningNotificationManager,
             dalamudUtilService,
+            _framework,
             actorObjectService,
             _lifetime,
             _fileCacheManager,
+            _playerPerformanceConfigService,
             _playerPerformanceService,
             _pairProcessingLimiter,
             _serverConfigManager,
             _textureDownscaleService,
+            _modelDecimationService,
             _pairStateCache,
             _pairPerformanceMetricsCache,
-            _tempCollectionJanitor);
+            _tempCollectionJanitor,
+            _modelAnalyzer,
+            _configService);
     }
 }

LightlessSync/PlayerData/Pairs/PairHandlerRegistry.cs

@@ -89,7 +89,7 @@ public sealed class PairHandlerRegistry : IDisposable
         }
 
         if (handler.LastReceivedCharacterData is not null &&
-            (handler.LastAppliedApproximateVRAMBytes < 0 || handler.LastAppliedDataTris < 0))
+            (handler.LastAppliedApproximateVRAMBytes < 0 || handler.LastAppliedDataTris < 0 || handler.LastAppliedApproximateEffectiveTris < 0))
         {
             handler.ApplyLastReceivedData(forced: true);
         }
@@ -136,6 +136,7 @@ public sealed class PairHandlerRegistry : IDisposable
             if (TryFinalizeHandlerRemoval(handler))
             {
                 handler.Dispose();
+                _pairStateCache.Clear(registration.CharacterIdent);
             }
         }
         else if (shouldScheduleRemoval && handler is not null)
@@ -356,6 +357,7 @@ public sealed class PairHandlerRegistry : IDisposable
             finally
             {
                 _pairPerformanceMetricsCache.Clear(handler.Ident);
+                _pairStateCache.Clear(handler.Ident);
             }
         }
     }
@@ -377,6 +379,7 @@ public sealed class PairHandlerRegistry : IDisposable
         {
             handler.Dispose();
             _pairPerformanceMetricsCache.Clear(handler.Ident);
+            _pairStateCache.Clear(handler.Ident);
         }
     }
 
@@ -401,6 +404,7 @@ public sealed class PairHandlerRegistry : IDisposable
         if (TryFinalizeHandlerRemoval(handler))
         {
             handler.Dispose();
+            _pairStateCache.Clear(handler.Ident);
         }
     }
 

LightlessSync/PlayerData/Pairs/PairLedger.cs

@@ -258,7 +258,8 @@ public sealed class PairLedger : DisposableMediatorSubscriberBase
 
             if (handler.LastAppliedApproximateVRAMBytes >= 0
                 && handler.LastAppliedDataTris >= 0
-                && handler.LastAppliedApproximateEffectiveVRAMBytes >= 0)
+                && handler.LastAppliedApproximateEffectiveVRAMBytes >= 0
+                && handler.LastAppliedApproximateEffectiveTris >= 0)
             {
                 continue;
             }
@@ -270,7 +271,20 @@ public sealed class PairLedger : DisposableMediatorSubscriberBase
 
             try
             {
-                handler.ApplyLastReceivedData(forced: true);
+                _ = Task.Run(async () =>
+                {
+                    try
+                    {
+                        await handler.EnsurePerformanceMetricsAsync(CancellationToken.None).ConfigureAwait(false);
+                    }
+                    catch (Exception ex)
+                    {
+                        if (_logger.IsEnabled(LogLevel.Debug))
+                        {
+                            _logger.LogDebug(ex, "Failed to ensure performance metrics for {Ident}", handler.Ident);
+                        }
+                    }
+                });
             }
             catch (Exception ex)
             {

LightlessSync/PlayerData/Pairs/PairManager.cs

@@ -160,8 +160,9 @@ public sealed class PairManager
                 return PairOperationResult<PairRegistration>.Fail($"Pair {user.UID} not found.");
             }
 
+            var ident = connection.Ident;
             connection.SetOffline();
-            return PairOperationResult<PairRegistration>.Ok(new PairRegistration(new PairUniqueIdentifier(user.UID), connection.Ident));
+            return PairOperationResult<PairRegistration>.Ok(new PairRegistration(new PairUniqueIdentifier(user.UID), ident));
         }
     }
 
@@ -530,6 +531,7 @@ public sealed class PairManager
             return null;
         }
 
+        var ident = connection.Ident;
         if (connection.IsOnline)
         {
             connection.SetOffline();
@@ -542,7 +544,7 @@ public sealed class PairManager
             shell.Users.Remove(userId);
         }
 
-        return new PairRegistration(new PairUniqueIdentifier(userId), connection.Ident);
+        return new PairRegistration(new PairUniqueIdentifier(userId), ident);
     }
 
     public static PairConnection CreateFromFullData(UserFullPairDto dto)

LightlessSync/PlayerData/Pairs/PairModels.cs

@@ -76,6 +76,7 @@ public sealed class PairConnection
     public void SetOffline()
     {
         IsOnline = false;
+        Ident = null;
     }
 
     public void UpdatePermissions(UserPermissions own, UserPermissions other)

LightlessSync/PlayerData/Pairs/PairPerformanceMetricsCache.cs

@@ -5,7 +5,8 @@ namespace LightlessSync.PlayerData.Pairs;
 public readonly record struct PairPerformanceMetrics(
     long TriangleCount,
     long ApproximateVramBytes,
-    long ApproximateEffectiveVramBytes);
+    long ApproximateEffectiveVramBytes,
+    long ApproximateEffectiveTris);
 
 /// <summary>
 ///     caches performance metrics keyed by pair ident

LightlessSync/PlayerData/Pairs/VisibleUserDataDistributor.cs

@@ -50,6 +50,7 @@ public class VisibleUserDataDistributor : DisposableMediatorSubscriberBase
         });
 
         Mediator.Subscribe<ConnectedMessage>(this, (_) => PushToAllVisibleUsers());
+        Mediator.Subscribe<PairOnlineMessage>(this, (msg) => HandlePairOnline(msg.PairIdent));
         Mediator.Subscribe<DisconnectedMessage>(this, (_) =>
         {
             _fileTransferManager.CancelUpload();
@@ -111,6 +112,20 @@ public class VisibleUserDataDistributor : DisposableMediatorSubscriberBase
         _ = PushCharacterDataAsync(forced);
     }
 
+    private void HandlePairOnline(PairUniqueIdentifier pairIdent)
+    {
+        if (!_apiController.IsConnected || !_pairLedger.IsPairVisible(pairIdent))
+        {
+            return;
+        }
+
+        if (_pairLedger.GetHandler(pairIdent)?.UserData is { } user)
+        {
+            _usersToPushDataTo.Add(user);
+            PushCharacterData(forced: true);
+        }
+    }
+
     private async Task PushCharacterDataAsync(bool forced = false)
     {
         await _pushLock.WaitAsync(_runtimeCts.Token).ConfigureAwait(false);
@@ -152,5 +167,6 @@ public class VisibleUserDataDistributor : DisposableMediatorSubscriberBase
         }
     }
 
-    private List<UserData> GetVisibleUsers() => [.. _pairLedger.GetVisiblePairs().Select(connection => connection.User)];
+    private List<UserData> GetVisibleUsers()
+        => [.. _pairLedger.GetVisiblePairs().Where(connection => connection.IsOnline).Select(connection => connection.User)];
 }