@loontail/minecraft-kit / MinecraftKit

Class: MinecraftKit

Defined in: src/kit.ts:80

Single facade for the entire library.

Example

const kit = new MinecraftKit();
const target = await kit.targets.resolve({ id, directory, minecraft: { version: '1.20.1' }, loader: { type: Loaders.VANILLA } });
const plan = await kit.install.plan(target);
await kit.install.run(plan, { onEvent: console.log });

Constructors

Constructor

new MinecraftKit(options?): MinecraftKit;

Defined in: src/kit.ts:100

Parameters

Parameter	Type
options	MinecraftKitOptions

Returns

MinecraftKit

Properties

Property	Modifier	Type	Description	Defined in
auth	readonly	MojangAuthApi	Microsoft / Mojang authentication. Runs the OAuth 2.0 Authorization-Code + PKCE flow over a loopback redirect to mint an Xbox + Minecraft session for launch.compose.	src/kit.ts:96
cache	readonly	MetadataCache	Cache surface useful for advanced consumers (e.g. clearing between operations).	src/kit.ts:98
install	readonly	InstallAspect	-	src/kit.ts:88
launch	readonly	LaunchAspect	-	src/kit.ts:91
repair	readonly	RepairSurface	-	src/kit.ts:90
targets	readonly	TargetsApi	-	src/kit.ts:87
verify	readonly	VerifyAspect	-	src/kit.ts:89
versions	readonly	{ fabric: FabricVersionsApi; forge: ForgeVersionsApi; minecraft: MinecraftVersionsApi; runtime: RuntimeVersionsApi; }	-	src/kit.ts:81
versions.fabric	readonly	FabricVersionsApi	-	src/kit.ts:83
versions.forge	readonly	ForgeVersionsApi	-	src/kit.ts:84
versions.minecraft	readonly	MinecraftVersionsApi	-	src/kit.ts:82
versions.runtime	readonly	RuntimeVersionsApi	-	src/kit.ts:85