CMLauncher

Wrapper class of CmlLib.Core. You can easily access many feature of this library through this class.

Basic Usage

Below codes are very basic launcher but all main features are included. Copy and paste to Console project and try it by yourself.

System.Net.ServicePointManager.DefaultConnectionLimit = 256;

var path = new MinecraftPath();
var launcher = new CMLauncher(path);

launcher.FileChanged += (e) =>
{
    Console.WriteLine("FileKind: " + e.FileKind.ToString());
    Console.WriteLine("FileName: " + e.FileName);
    Console.WriteLine("ProgressedFileCount: " + e.ProgressedFileCount);
    Console.WriteLine("TotalFileCount: " + e.TotalFileCount);
};
launcher.ProgressChanged += (s, e) =>
{
    Console.WriteLine("{0}%", e.ProgressPercentage);
};

var versions = await launcher.GetAllVersionsAsync();
foreach (var v in versions)
{
    Console.WriteLine(v.Name);
}

var process = await launcher.CreateProcessAsync("1.16.5", new MLaunchOption
{
    MaximumRamMb = 2048,
    Session = MSession.GetOfflineSession("hello123"),
});

process.Start();

Explaination

System.Net.ServicePointManager.DefaultConnectionLimit = 256;

Increase the maximum number of concurrent connections. This code would increase download speed.

var path = new MinecraftPath();
var launcher = new CMLauncher(path);

Create Minecraft directory structure and initialize launcher instance. You can change minecraft path and directory structure. See Minecraft Path

launcher.FileChanged += (e) =>
{
    Console.WriteLine("FileKind: " + e.FileKind.ToString());
    Console.WriteLine("FileName: " + e.FileName);
    Console.WriteLine("ProgressedFileCount: " + e.ProgressedFileCount);
    Console.WriteLine("TotalFileCount: " + e.TotalFileCount);
};
launcher.ProgressChanged += (s, e) =>
{
    Console.WriteLine("{0}%", e.ProgressPercentage);
};

Add event handler. It prints download progress to console. See Event Handling

var versions = await launcher.GetAllVersionsAsync();
foreach (var v in versions)
{
    Console.WriteLine(v.Name);
}

Get all version and print its names. See VersionLoader

var process = await launcher.CreateProcessAsync("1.16.5", new MLaunchOption
{
    MaximumRamMb = 2048,
    Session = MSession.GetOfflineSession("hello123"),
});

Set launch options, check game files, download game files, and return minecraft Process instance. See Launch Options for more launch options.

Offline mode

This works only when all game files is normally installed.

In this mode, you can launch game without internet connection. Set FileDownloader to null, and set VersionLoader to LocalVersionLoader.

var launcher = new CMLauncher(path);

launcher.VersionLoader = new LocalVersionLoader(launcher.MinecraftPath);
launcher.FileDownloader = null;

// ~~~

Launch without checking / downloading

This works only when all game files is normally installed.

This code launch game super fast. (< 1sec)

var process = await launcher.CreateProcessAsync("1.18.1", new MLaunchOption()
{
    // game options
}, checkAndDownload: false);
process.Start();

API References

Methods

MVersionCollection GetAllVersions()

Refresh version list and return them.

async Task GetAllVersionsAsync()

Async version of GetAllVersions().

MVersion GetVersion(string versionname)

Get MVersion instance.

async Task GetVersionAsync(string versionname)

Get MVersion instance asynchronously.

DownloadFile[] CheckLostGameFiles(MVersion version)

Check all game files and return file list that should be downloaded. It checks all game files using IFileChecker in GameFileChekers property, combines all game files that should be downloaded into array and return array.

async Task<DownloadFile[]> CheckLostGameFilesTaskAsync(MVersion version)

Asynchronous version of CheckLostGameFiles method.

async Task DownloadGameFiles(DownloadFile[] files)

Download files using FileDownloader property.

void CheckAndDownload(MVersion version)

Check all game files and download files.

async Task CheckAndDownloadAsync(MVersion version)

Asynchrounous version of CheckAndDownload method.

Process CreateProcess(string versionName, MLaunchOption option, bool checkAndDownload=true)

Find versionName version from Versions property, check game files, and return game process. If checkAndDownload argument is false, It does not check game files. This method does not start game process. You should call Start() method of process.

Process CreateProcess(MVersion version, MLaunchOption option, bool checkAndDownload=false)

Check game files of version and return game process. If checkAndDownload argument is false, It does not check game files. This method does not start game process. You should call Start() method of process.

async Task CreateProcessAsync(string versionName, MLaunchOption option, bool checkAndDownload=false)

Asynchrounous version of CreateProcess(string versionName, MLaunchOption option) method.

async Task CreateProcessAsync(MVersion version, MLaunchOption option, bool checkAndDownload=false)

Asynchrounous version of CreateProcess(MVersion version, MLaunchOption option) method.

Process CreateProcess(MLaunchOption option)

Create game process which game version is StartVersion property of option. This method does not check and download game files. This method does not start game process. You should call Start() method of process.

async Task CreateProcessAsync(MLaunchOption option)

Asynchrounous version of CreateProcess(MLaunchOption option) method.

Process CreateProcess(string mcversion, string forgeversion, MLaunchOption option)

(not stable)

Properties

MinecraftPath

Type: MinecraftPath

Versions

Type: MVersionCollection?

VersionLoader

Type: IVersionLoader

GameFileCheckers

Type: FileCheckerCollection

FileDownloader

Type: IDownloader?