ILauncher.cs

using System.Drawing;

namespace GameLib.Core;

public interface ILauncher
{
    /// <summary>
    /// The options the launcher manager has been provided with
    /// </summary>
    public LauncherOptions LauncherOptions { get; }

    /// <summary>
    /// Guid of the Launcher
    /// NOTE: generated by the plugin
    /// </summary>
    public Guid Id { get; }

    /// <summary>
    /// Name of the launcher
    /// </summary>
    public string Name { get; }

    /// <summary>
    /// Logo of the launcher
    /// NOTE: size of Logo depends on the plugin
    /// </summary>
    public Image Logo { get; }

    /// <summary>
    /// <see langword="true"/> if the launcher is (properly) installed
    /// </summary>
    public bool IsInstalled { get; }

    /// <summary>
    /// <see langword="true"/> if the launcher is currently running
    /// </summary>
    public bool IsRunning { get; }

    /// <summary>
    /// The installation path of the Launcher<br/>
    /// <see langword="string.Empty"/> if not (properly) installed
    /// </summary>
    public string InstallDir { get; }

    /// <summary>
    /// The executable including the path of the Launcher<br/>
    /// <see langword="string.Empty"/> if not (properly) installed
    /// </summary>
    public string Executable { get; }

    /// <summary>
    /// The extracted icon of the launcher executable
    /// </summary>
    public Icon? ExecutableIcon { get; }

    /// <summary>
    /// The installed games of the Launcher
    /// NOTE: if no cache is available list will be empty, Refresh must be called first
    /// </summary>
    public IEnumerable<IGame> Games { get; }

    /// <summary>
    /// Starts the launcher if not already running
    /// </summary>
    /// <returns><see langword="True"/> if started successfully or already running</returns>
    public bool Start();

    /// <summary>
    /// Attempts to end the launcher
    /// </summary>
    public void Stop();

    /// <summary>
    /// Clear any cached values and reload all launcher and game data
    /// </summary>
    public void Refresh(CancellationToken cancellationToken = default);
}