CmlLib.Core 3.3.2

.NET 5.0 .NET Core 3.1 .NET Framework 4.6.2
There is a newer version of this package available.
See the version list below for details.
NuGet\Install-Package CmlLib.Core -Version 3.3.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package CmlLib.Core --version 3.3.2
<PackageReference Include="CmlLib.Core" Version="3.3.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CmlLib.Core --version 3.3.2
#r "nuget: CmlLib.Core, 3.3.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install CmlLib.Core as a Cake Addin
#addin nuget:?package=CmlLib.Core&version=3.3.2

// Install CmlLib.Core as a Cake Tool
#tool nuget:?package=CmlLib.Core&version=3.3.2

CmlLib.Core

Minecraft Launcher Library

<img src='https://raw.githubusercontent.com/CmlLib/CmlLib.Core/master/icon.png' width=128>

Nuget Badge GitHub license Codacy Badge

Discord

CmlLib.Core is minecraft launcher library for .NET
Support all version, with Forge

한국어 README

Features

  • Asynchronous APIs
  • Mojang Authentication
  • Microsoft Xbox Live Login
  • Download the game files from the Mojang file server
  • Launch any version (tested up to 1.17.1)
  • Launch Forge, Optifine, FabricMC, LiteLoader or any other custom version
  • Install Java runtime
  • Install Forge, LiteLoader, FabricMC
  • Launch with options (direct server connecting, screen resolution)
  • Cross-platform (windows, ubuntu, macOS)

Go to wiki for all features

Install

Install the CmlLib.Core Nuget package

or download the dll files in Releases and add references to them in your project.

Write this at the top of your source code:

using CmlLib.Core;
using CmlLib.Core.Auth;

Documentation

There are many features for custom launcher. Read wiki to use all features.
Official documentation: wiki

QuickStart

Microsoft Xbox Login

Wiki

Mojang Login

Login Process

var login = new MLogin();
var response = login.TryAutoLogin();

if (!response.IsSuccess) // failed to automatically log in
{
    var email = Console.ReadLine();
    var pw = Console.ReadLine();
    response = login.Authenticate(email, pw);

    if (!response.IsSuccess)
         throw new Exception(response.Result.ToString()); // failed to log in
}

// This session variable is the result of logging in and is used in MLaunchOption, in the Launch part below.
var session = response.Session;

Offline Login

// This session variable is the result of logging in and is used in MLaunchOption, in the Launch part below.
var session = MSession.GetOfflineSession("USERNAME");

Launch

// increase connection limit to fast download
System.Net.ServicePointManager.DefaultConnectionLimit = 256;

//var path = new MinecraftPath("game_directory_path");
var path = new MinecraftPath(); // use default directory

var launcher = new CMLauncher(path);

// show launch progress to console
launcher.FileChanged += (e) =>
{
    Console.WriteLine("[{0}] {1} - {2}/{3}", e.FileKind.ToString(), e.FileName, e.ProgressedFileCount, e.TotalFileCount);
};
launcher.ProgressChanged += (s, e) =>
{
    Console.WriteLine("{0}%", e.ProgressPercentage);
};

var versions = await launcher.GetAllVersionsAsync();
foreach (var item in versions)
{
    // show all version names
    // use this version name in CreateProcessAsync method.
    Console.WriteLine(item.Name);
}

var launchOption = new MLaunchOption
{
    MaximumRamMb = 1024,
    Session = MSession.GetOfflineSession("hello"), // Login Session. ex) Session = MSession.GetOfflineSession("hello")

    //ScreenWidth = 1600,
    //ScreenHeigth = 900,
    //ServerIp = "mc.hypixel.net"
};

//var process = await launcher.CreateProcessAsync("input version name here", launchOption);
var process = await launcher.CreateProcessAsync("1.15.2", launchOption); // vanilla
// var process = await launcher.CreateProcessAsync("1.12.2-forge1.12.2-14.23.5.2838", launchOption); // forge
// var process = await launcher.CreateProcessAsync("1.12.2-LiteLoader1.12.2"); // liteloader
// var process = await launcher.CreateProcessAsync("fabric-loader-0.11.3-1.16.5") // fabric-loader

process.Start();

Example

Sample Code

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.1
.NET Framework net462 net463 net47 net471 net472 net48
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on CmlLib.Core:

Package Downloads
CmlLib.Core.Auth.Microsoft

Minecraft login with Microsoft Xbox Live account

SunCore.Ultralight.MCLauncher

SunCore.Ultralight.MCLauncher is a library for Minecraft Launchers that uses CmlLib.Core handles hard-code process with a single Launching function.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.3.5 2,371 12/20/2021
3.3.4 264 12/13/2021
3.3.3 743 10/4/2021
3.3.2 317 9/5/2021
3.3.1 626 6/22/2021
3.3.0 287 6/14/2021
3.2.0 246 6/2/2021
3.2.0-pre3 174 5/25/2021
3.2.0-pre1 174 4/8/2021
3.1.1 535 2/11/2021
3.1.0 319 12/27/2020
3.0.0 445 8/25/2020
3.0.0-alpha3 248 8/24/2020
3.0.0-alpha 312 7/3/2020
2.0.2 406 5/31/2020
2.0.1 338 5/31/2020
2.0.0 409 5/17/2020
0.2.0 398 4/13/2020
0.1.0 373 4/6/2020