Updated contract

Author: meruune

Amethyst.Contract/Amethyst.Contract.csproj

@@ -5,7 +5,7 @@
     <Nullable>enable</Nullable>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <Title>Amethyst Plugin API Contract</Title>
-    <Version>2.0.0</Version>
+    <Version>2.2.0</Version>
     <Platforms>x64</Platforms>
   </PropertyGroup>
 

Amethyst.Contract/Contract.cs

@@ -129,22 +129,22 @@ public interface ITrackingDevice
     ///     "https://contoso.com/"
     /// </example>
     [DefaultValue(null)]
-    public Uri ErrorDocsUri { get; }
+    Uri ErrorDocsUri { get; }
 
     /// <summary>
     ///     This is called after the app loads the plugin
     /// </summary>
-    void OnLoad();
+    Task OnLoad();
 
     /// <summary>
     ///     This initializes/connects the device
     /// </summary>
-    void Initialize();
+    Task Initialize();
 
     /// <summary>
     ///     This is called when the device is closed
     /// </summary>
-    void Shutdown();
+    Task Shutdown();
 
     /// <summary>
     ///     This is called to update the device (each loop)
@@ -186,52 +186,52 @@ public interface IServiceEndpoint
     ///     Additional supported tracker types set
     ///     The mandatory ones are: waist, left foot, and right foot
     /// </summary>
-    public SortedSet<TrackerType> AdditionalSupportedTrackerTypes { get; }
+    SortedSet<TrackerType> AdditionalSupportedTrackerTypes { get; }
 
     /// <summary>
     ///     Mark as true to tell the user that they need to restart/
     ///     /in case they want to add more trackers after spawning
     ///     This is the case with OpenVR, where settings need to be reloaded
     /// </summary>
     [DefaultValue(false)]
-    public bool IsRestartOnChangesNeeded { get; }
+    bool IsRestartOnChangesNeeded { get; }
 
     /// <summary>
     ///     Controller input actions, for calibration and others
     ///     Also provides support for flip/freeze quick toggling
     ///     Leaving this null will result in marking the
     ///     manual calibration and input actions support as [false]
     /// </summary>
-    public InputActions ControllerInputActions { get; set; }
+    InputActions ControllerInputActions { get; set; }
 
     /// <summary>
     ///     For AutoStartAmethyst: check if it's even possible
     ///     Mark as true to state that starting your app/service
     ///     / can automatically start Amethyst at the same time
     /// </summary>
     [DefaultValue(false)]
-    public bool CanAutoStartAmethyst { get; }
+    bool CanAutoStartAmethyst { get; }
 
     /// <summary>
     ///     Check or set if starting the service should auto-start Amethyst
     ///     This is only available for a few actual cases, like OpenVR
     /// </summary>
     [DefaultValue(false)]
-    public bool AutoStartAmethyst { get; set; }
+    bool AutoStartAmethyst { get; set; }
 
     /// <summary>
     ///     Check or set if closing the service should auto-close Amethyst
     ///     This is only available for a few actual cases, like OpenVR
     /// </summary>
     [DefaultValue(true)]
-    public bool AutoCloseAmethyst { get; set; }
+    bool AutoCloseAmethyst { get; set; }
 
     /// <summary>
     ///     Check if Amethyst is shown in the service dashboard or similar
     ///     This is only available for a few actual cases, like OpenVR
     /// </summary>
     [DefaultValue(true)]
-    public bool IsAmethystVisible { get; }
+    bool IsAmethystVisible { get; }
 
     /// <summary>
     ///     Check running system name, this is important for input
@@ -240,7 +240,7 @@ public interface IServiceEndpoint
     ///     "Oculus" | "VIVE" | "Index" | "WMR" | ...
     /// </example>
     [DefaultValue("Oculus")]
-    public string TrackingSystemName { get; }
+    string TrackingSystemName { get; }
 
     /// <summary>
     ///     The link to launch when 'View Docs' is clicked while
@@ -252,26 +252,26 @@ public interface IServiceEndpoint
     ///     "https://contoso.com/"
     /// </example>
     [DefaultValue(null)]
-    public Uri ErrorDocsUri { get; }
+    Uri ErrorDocsUri { get; }
 
     /// <summary>
     ///     Keeps all supported input actions that may be received from ProcessKeyInput
     ///     You will not be able to receive actions from unsupported TrackerType either
     /// </summary>
     [DefaultValue(null)]
-    public Dictionary<TrackerType, SortedSet<IKeyInputAction>> SupportedInputActions { get; }
+    Dictionary<TrackerType, SortedSet<IKeyInputAction>> SupportedInputActions { get; }
 
     /// <summary>
     ///     Get the absolute pose of the HMD, calibrated against the play space
     ///     Return null if unknown to the service or unavailable
     ///     You'll need to provide this to support automatic calibration
     /// </summary>
-    public (Vector3 Position, Quaternion Orientation)? HeadsetPose { get; }
+    (Vector3 Position, Quaternion Orientation)? HeadsetPose { get; }
 
     /// <summary>
     ///     This is called after the app loads the plugin
     /// </summary>
-    void OnLoad();
+    Task OnLoad();
 
     /// <summary>
     ///     This is called right before the pose compose
@@ -281,12 +281,12 @@ public interface IServiceEndpoint
     /// <summary>
     ///     This initializes/connects to the service
     /// </summary>
-    int Initialize();
+    Task Initialize();
 
     /// <summary>
     ///     This is called when the service is closed
     /// </summary>
-    void Shutdown();
+    Task Shutdown();
 
     /// <summary>
     ///     Implement if your service supports custom toasts
@@ -297,39 +297,39 @@ public interface IServiceEndpoint
     /// <summary>
     ///     Request a restart of the tracking endpoint service
     /// </summary>
-    public bool? RequestServiceRestart(string reason, bool wantReply = false);
+    bool? RequestServiceRestart(string reason, bool wantReply = false);
 
     /// <summary>
     ///     Find an already-existing tracker and get its pose
     ///     For no results found return null, also check if it's from amethyst
     /// </summary>
-    public TrackerBase GetTrackerPose(string contains, bool canBeFromAmethyst = true);
+    TrackerBase GetTrackerPose(string contains, bool canBeFromAmethyst = true);
 
     /// <summary>
     ///     Set tracker states, add/spawn if not present yet
     ///     Default to the serial, update the role if needed
     ///     Returns the same vector with paired success property (or null)
     /// </summary>
-    public Task<IEnumerable<(TrackerBase Tracker, bool Success)>> SetTrackerStates(
+    Task<IEnumerable<(TrackerBase Tracker, bool Success)>> SetTrackerStates(
         IEnumerable<TrackerBase> trackerBases, bool wantReply = true);
 
     /// <summary>
     ///     Update tracker positions and physics components
     ///     Check physics against null, they're passed as optional
     ///     Returns the same vector with paired success property (or null)
     /// </summary>
-    public Task<IEnumerable<(TrackerBase Tracker, bool Success)>> UpdateTrackerPoses(
+    Task<IEnumerable<(TrackerBase Tracker, bool Success)>> UpdateTrackerPoses(
         IEnumerable<TrackerBase> trackerBases, bool wantReply = true, CancellationToken? token = null);
 
     /// <summary>
     ///     Check connection: status, serialized status, combined ping time
     /// </summary>
-    public Task<(int Status, string StatusMessage, long PingTime)> TestConnection();
+    Task<(int Status, string StatusMessage, long PingTime)> TestConnection();
 
     /// <summary>
     ///     Process a key input event sent by a device, that was assigned and found
     /// </summary>
-    public Task ProcessKeyInput(IKeyInputAction action, object? data,
+    Task ProcessKeyInput(IKeyInputAction action, object? data,
         TrackerType? receiver, CancellationToken? token = null);
 }
 
@@ -380,7 +380,7 @@ public interface IAmethystHost
     ///     Types you save must either be serializable by ToString()
     ///     or the Newtonsoft.Json (JSON.NET) serialization library
     /// </summary>
-    public IPluginSettings PluginSettings { get; }
+    IPluginSettings PluginSettings { get; }
 
     /// <summary>
     ///    Helper class that provides path-related methods,
@@ -390,7 +390,7 @@ public interface IAmethystHost
     ///    and in unpackaged mode, AppData will be created near main exe.
     ///    This is to ensure portability and prevent the need for cleanup
     /// </summary>
-    public IPathHelper PathHelper { get; }
+    IPathHelper PathHelper { get; }
 
     /// <summary>
     ///     Get the hook joint pose (typically Head, fallback to .First())
@@ -512,21 +512,21 @@ public interface IDependencyInstaller
     ///     The list of dependencies that will need to be installed,
     ///     or tools that can be optionally included, see IDependency
     /// </summary>
-    public List<IDependency> Dependencies { get; }
+    List<IDependency> Dependencies { get; }
 
     /// <summary>
     ///     The list of fixes that may need to be applied,
     ///     or tools that can be included, see the IFix class
     /// </summary>
-    public List<IFix> Fixes { get; }
+    List<IFix> Fixes { get; }
 
     /// <summary>
     ///     The localization host, use it to request your strings
     ///     Note: this property will be overwritten by Amethyst
     ///     upon the initialization of your implemented class!
     ///     You may use it ONLY after it's done constructing
     /// </summary>
-    public ILocalizationHost? Host { get; set; }
+    ILocalizationHost? Host { get; set; }
 
     /// <summary>
     ///     Use this interface to invoke AME localization methods
@@ -592,15 +592,15 @@ public interface ICoreSetupData
     ///     Note: MUST BE OF Microsoft.UI.Xaml.Controls.IconElement
     ///     Note: This icon will be auto-scaled, keep it high-res
     /// </summary>
-    public object PluginIcon { get; }
+    object PluginIcon { get; }
 
     /// <summary>
     ///     The name of the group the plugin (device/service)
     ///     will be put into during the setup. Think of it as
     ///     about the RadioButton group that links them together
     ///     Note: case-sensitive, treated the same as serials
     /// </summary>
-    public string GroupName { get; }
+    string GroupName { get; }
 
     /// <summary>
     ///     States whether the plugin is an ITrackingDevice or
@@ -609,5 +609,5 @@ public interface ICoreSetupData
     ///     and is here because MEF will be unavailable at the
     ///     point of scanning the core setup data from plugins
     /// </summary>
-    public Type PluginType { get; }
+    Type PluginType { get; }
 }

Amethyst/Amethyst.csproj

@@ -31,6 +31,7 @@
 	</ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="AsyncImageLoader.Avalonia" Version="3.4.3" />
     <PackageReference Include="Avalonia" Version="11.3.2"/>
     <PackageReference Include="Avalonia.Labs.Controls" Version="11.3.1" />
     <PackageReference Include="CommunityToolkit.Mvvm" Version="8.4.0"/>

Amethyst/App.axaml.cs

@@ -1157,7 +1157,7 @@ await File.ReadAllTextAsync((await folder.GetFileAsync("en.json"))!.Path.Absolut
     // Send a non-dismissible tip about reloading the app
     private static void OnWatcherOnChanged(object o, FileSystemEventArgs fileSystemEventArgs)
     {
-        Dispatcher.UIThread.Post(() =>
+        Dispatcher.UIThread.Post(async void () =>
         {
             Logger.Info("String resource files have changed, reloading!");
             Logger.Info($"What happened: {fileSystemEventArgs.ChangeType}");
@@ -1183,8 +1183,8 @@ private static void OnWatcherOnChanged(object o, FileSystemEventArgs fileSystemE
                 Shared.Devices.DevicesJointsValid = false;
 
                 // Reload plugins' interfaces
-                AppPlugins.TrackingDevicesList.Values.ToList().ForEach(x => x.OnLoad());
-                AppPlugins.ServiceEndpointsList.Values.ToList().ForEach(x => x.OnLoad());
+                await AppPlugins.TrackingDevicesList.Values.Reload();
+                await AppPlugins.ServiceEndpointsList.Values.Reload();
             }
 
             // Request page reloads