CmlLib.Core 4.0.0-beta.1

This is a prerelease version of CmlLib.Core.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package CmlLib.Core --version 4.0.0-beta.1
NuGet\Install-Package CmlLib.Core -Version 4.0.0-beta.1
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.
<PackageReference Include="CmlLib.Core" Version="4.0.0-beta.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CmlLib.Core --version 4.0.0-beta.1
#r "nuget: CmlLib.Core, 4.0.0-beta.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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=4.0.0-beta.1&prerelease

// Install CmlLib.Core as a Cake Tool
#tool nuget:?package=CmlLib.Core&version=4.0.0-beta.1&prerelease

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 a Minecraft launcher library for .NET
Supports all versions, Forge, and any custom version

한국어 문서

简体中文 README

Features

  • Authenticate with Microsoft Xbox account
  • Get vanilla versions and installed versions
  • Install vanilla versions
  • Launch any vanilla version (tested up to 1.20.4)
  • Launch Forge, Optifine, FabricMC, LiteLoader or any other custom version
  • Install Java runtime
  • Install LiteLoader, FabricMC
  • Launch with options (direct server connecting, screen resolution, JVM arguments)
  • Cross-platform (Windows, Linux, macOS)

Go to the wiki for all features

Install

Install the CmlLib.Core Nuget package

QuickStart

Get All Versions

using CmlLib.Core;

var launcher = new MinecraftLauncher();
var versions = await launcher.GetAllVersionsAsync();
foreach (var version in versions)
{
  Console.WriteLine($"{version.Type} {version.Name}");
}

Launch the Game

using CmlLib.Core;
using CmlLib.Core.ProcessBuilder;

var launcher = new MinecraftLauncher();
var process = await launcher.InstallAndBuildProcessAsync("1.20.4", new MLaunchOption());
process.Start();

Launch the Game with Options

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

var path = new MinecraftPath("./my_game_dir");
var launcher = new MinecraftLauncher(path);

launcher.FileProgressChanged += (sender, args) =>
{
  Console.WriteLine($"Name: {args.Name}");
  Console.WriteLine($"Type: {args.EventType}");
  Console.WriteLine($"Total: {args.TotalTasks}");
  Console.WriteLine($"Progressed: {args.ProgressedTasks}");
};
launcher.ByteProgressChanged += (sender, args) =>
{
  Console.WriteLine($"{args.ProgressedBytes} bytes / {args.TotalBytes} bytes");
};

await launcher.InstallAsync("1.20.4");
var process = await launcher.BuildProcessAsync("1.20.4", new MLaunchOption
{
  Session = MSession.CreateOfflineSession("CmllibGamer123"),
  MaximumRamMb = 4096
});
process.Start();

Documentation

Official documentation

한국어 문서

Example

Sample Launcher

Contributors

<a href="https://github.com/cmllib/cmllib.core/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cmllib/cmllib.core" /> </a>

Made with contrib.rocks.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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.Installer.Forge

Minecraft Forge Installer

CmlLib.Core.Auth.Microsoft.Uno

Minecraft login with Microsoft Xbox account migrated to work with the UnoPlatform

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0-beta.2 43 6/9/2024
4.0.0-beta.1 109 3/29/2024
3.3.10 1,036 3/9/2024
3.3.9 554 2/1/2024
3.3.8 1,485 10/14/2023
3.3.7 2,518 6/26/2023
3.3.6 2,497 1/22/2023
3.3.5 7,281 12/20/2021
3.3.4 908 12/13/2021
3.3.3 2,207 10/4/2021
3.3.2 905 9/5/2021
3.3.1 1,320 6/22/2021
3.3.0 896 6/14/2021
3.2.0 844 6/2/2021
3.2.0-pre3 626 5/25/2021
3.2.0-pre1 626 4/8/2021
3.1.1 1,215 2/11/2021
3.1.0 927 12/27/2020
3.0.0 1,084 8/25/2020
3.0.0-alpha3 737 8/24/2020
3.0.0-alpha 834 7/3/2020
2.0.2 1,044 5/31/2020
2.0.1 945 5/31/2020
2.0.0 1,017 5/17/2020
0.2.0 1,060 4/13/2020
0.1.0 1,027 4/6/2020