Launcher Core Module


Provide the core function to parse Minecraft version and launch.

Usage

$3

Parse minecraft version as a resolved version, which is used for launching process. You can also read version info from it if you want.

``ts
import { Version } from "@xmcl/core";
const minecraftLocation: string;
const minecraftVersionId: string;

const resolvedVersion: ResolvedVersion = await Version.parse(minecraftLocation, minecraftVersionId);
`

$3

Get the report of the version. It can check if version missing assets/libraries.

`ts
import { MinecraftLocation, diagnose, ResolvedVersion } from "@xmcl/core";

const minecraft: MinecraftLocation;
const version: string; // version string like 1.13
const resolvedVersion: ResolvedVersion = await Version.parse(minecraft, version);

const report: MinecraftIssueReport = await diagnose(resolvedVersion.id, resolvedVersion.minecraftDirectory);

const issues: MinecraftIssues[] = report.issues;

for (let issue of issues) {
switch (issue.role) {
case "minecraftJar": // your jar has problem
case "versionJson": // your json has problem
case "library": // your lib might be missing or corrupted
case "assets": // some assets are missing or corrupted
// and so on
}
}
`

$3

Launch minecraft from a version:

`ts
import { launch } from "@xmcl/core"
const version: string; // full version id, like 1.13, or your forge version like, 1.13-forge-
const javaPath: string; // java executable path
const gamePath: string; // .minecraft path
const proc: Promise = launch({ gamePath, javaPath, version });
`

Detach from the parent process. So your launcher's exit/crash won't affact the Minecraft running.

`ts
const proc: Promise = Launcher.launch({ gamePath, javaPath, version, extraExecOption: { detached: true } });
`

#### Launching with Server Connection

For newer Minecraft versions, use the quickPlayMultiplayer option to directly connect to a server:

`ts
import { launch, createQuickPlayMultiplayer } from "@xmcl/core"

// Option 1: Use quickPlayMultiplayer directly
const proc = launch({
gamePath,
javaPath,
version,
quickPlayMultiplayer: 'play.hypixel.net:25565'
});

// Option 2: Use helper function
const proc = launch({
gamePath,
javaPath,
version,
quickPlayMultiplayer: createQuickPlayMultiplayer('mc.example.com', 8080)
});
`

For backward compatibility, the legacy server option is still supported:

`ts
// Legacy server option (still works)
const proc = launch({
gamePath,
javaPath,
version,
server: { ip: 'play.hypixel.net', port: 25565 }
});
`

Both quickPlayMultiplayer and server options can be used together for compatibility:

`ts
// Both options together for compatibility
const proc = launch({
gamePath,
javaPath,
version,
quickPlayMultiplayer: 'play.hypixel.net:25565',
server: { ip: 'play.hypixel.net', port: 25565 }
});
``