Table of Contents

Class MinecraftLauncher

Namespace: CmlLib.Core
Assembly: CmlLib.Core.dll

public class MinecraftLauncher

Inheritance

objectMinecraftLauncher

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

MinecraftLauncher()

public MinecraftLauncher()

MinecraftLauncher(string)

public MinecraftLauncher(string path)

Parameters

path string

MinecraftLauncher(MinecraftPath)

public MinecraftLauncher(MinecraftPath path)

Parameters

path MinecraftPath

MinecraftLauncher(MinecraftLauncherParameters)

public MinecraftLauncher(MinecraftLauncherParameters parameters)

Parameters

parameters MinecraftLauncherParameters

Properties

FileExtractors

public FileExtractorCollection FileExtractors { get; }

Property Value

FileExtractorCollection

GameInstaller

public IGameInstaller GameInstaller { get; }

Property Value

IGameInstaller

JavaPathResolver

public IJavaPathResolver JavaPathResolver { get; }

Property Value

IJavaPathResolver

MinecraftPath

public MinecraftPath MinecraftPath { get; }

Property Value

MinecraftPath

NativeLibraryExtractor

public INativeLibraryExtractor NativeLibraryExtractor { get; }

Property Value

INativeLibraryExtractor

RulesContext

public RulesEvaluatorContext RulesContext { get; set; }

Property Value

RulesEvaluatorContext

RulesEvaluator

public IRulesEvaluator RulesEvaluator { get; }

Property Value

IRulesEvaluator

VersionLoader

public IVersionLoader VersionLoader { get; }

Property Value

IVersionLoader

Versions

public VersionMetadataCollection? Versions { get; }

Property Value

VersionMetadataCollection?

Methods

BuildProcess(IVersion, MLaunchOption)

public Process BuildProcess(IVersion version, MLaunchOption launchOption)

Parameters

version IVersion

launchOption MLaunchOption

Returns

Process

BuildProcessAsync(string, MLaunchOption, CancellationToken)

public ValueTask<Process> BuildProcessAsync(string versionName, MLaunchOption launchOption, CancellationToken cancellationToken = default)

Parameters

versionName string

launchOption MLaunchOption

cancellationToken CancellationToken

Returns

ValueTask<Process>

CreateProcessAsync(string, MLaunchOption)

public ValueTask<Process> CreateProcessAsync(string versionName, MLaunchOption launchOption)

Parameters

versionName string

launchOption MLaunchOption

Returns

ValueTask<Process>

ExtractFiles(string, CancellationToken)

public ValueTask<IEnumerable<GameFile>> ExtractFiles(string versionName, CancellationToken cancellationToken = default)

Parameters

versionName string

cancellationToken CancellationToken

Returns

ValueTask<IEnumerable<GameFile>>

ExtractFiles(IVersion, CancellationToken)

public ValueTask<IEnumerable<GameFile>> ExtractFiles(IVersion version, CancellationToken cancellationToken = default)

Parameters

version IVersion

cancellationToken CancellationToken

Returns

ValueTask<IEnumerable<GameFile>>

GetAllVersionsAsync(CancellationToken)

public ValueTask<VersionMetadataCollection> GetAllVersionsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<VersionMetadataCollection>

GetDefaultJavaPath()

public string? GetDefaultJavaPath()

Returns

string?

GetJavaPath(IVersion)

public string? GetJavaPath(IVersion version)

Parameters

version IVersion

Returns

string?

GetVersionAsync(string, CancellationToken)

public ValueTask<IVersion> GetVersionAsync(string versionName, CancellationToken cancellationToken = default)

Parameters

versionName string

cancellationToken CancellationToken

Returns

ValueTask<IVersion>

InstallAndBuildProcessAsync(string, MLaunchOption, CancellationToken)

public ValueTask<Process> InstallAndBuildProcessAsync(string versionName, MLaunchOption launchOption, CancellationToken cancellationToken = default)

Parameters

versionName string

launchOption MLaunchOption

cancellationToken CancellationToken

Returns

ValueTask<Process>

InstallAndBuildProcessAsync(string, MLaunchOption, IProgress<InstallerProgressChangedEventArgs>?, IProgress<ByteProgress>?, CancellationToken)

public ValueTask<Process> InstallAndBuildProcessAsync(string versionName, MLaunchOption launchOption, IProgress<InstallerProgressChangedEventArgs>? fileProgress, IProgress<ByteProgress>? byteProgress, CancellationToken cancellationToken = default)

Parameters

versionName string

launchOption MLaunchOption

fileProgress IProgress<InstallerProgressChangedEventArgs>?

byteProgress IProgress<ByteProgress>?

cancellationToken CancellationToken

Returns

ValueTask<Process>

InstallAsync(string, CancellationToken)

public ValueTask InstallAsync(string versionName, CancellationToken cancellationToken = default)

Parameters

versionName string

cancellationToken CancellationToken

Returns

ValueTask

InstallAsync(string, IProgress<InstallerProgressChangedEventArgs>?, IProgress<ByteProgress>?, CancellationToken)

public ValueTask InstallAsync(string versionName, IProgress<InstallerProgressChangedEventArgs>? fileProgress, IProgress<ByteProgress>? byteProgress, CancellationToken cancellationToken = default)

Parameters

versionName string

fileProgress IProgress<InstallerProgressChangedEventArgs>?

byteProgress IProgress<ByteProgress>?

cancellationToken CancellationToken

Returns

ValueTask

InstallAsync(IVersion, CancellationToken)

public ValueTask InstallAsync(IVersion version, CancellationToken cancellationToken = default)

Parameters

version IVersion

cancellationToken CancellationToken

Returns

ValueTask

InstallAsync(IVersion, IProgress<InstallerProgressChangedEventArgs>?, IProgress<ByteProgress>?, CancellationToken)

public ValueTask InstallAsync(IVersion version, IProgress<InstallerProgressChangedEventArgs>? fileProgress, IProgress<ByteProgress>? byteProgress, CancellationToken cancellationToken = default)

Parameters

version IVersion

fileProgress IProgress<InstallerProgressChangedEventArgs>?

byteProgress IProgress<ByteProgress>?

cancellationToken CancellationToken

Returns

ValueTask

ByteProgressChanged

public event EventHandler<ByteProgress>? ByteProgressChanged

Event Type

EventHandler<ByteProgress>?

FileProgressChanged

public event EventHandler<InstallerProgressChangedEventArgs>? FileProgressChanged

Event Type

EventHandler<InstallerProgressChangedEventArgs>?