@loontail/minecraft-kit v0.8.14 / TargetsApi

Class: TargetsApi

Public Targets API surface.

Available off a kit instance as kit.targets.

Example

import { asMinecraftVersionId, Loaders, MinecraftKit } from "@loontail/minecraft-kit";

const kit = new MinecraftKit();
const target = await kit.targets.resolve({
  id: "modded",
  directory: "/games/minecraft/modded",
  minecraft: { version: asMinecraftVersionId("1.20.1") },
  loader: { type: Loaders.FABRIC },
});

Constructors

new TargetsApi()

new TargetsApi(ctx): TargetsApi

Parameters

Parameter	Type
ctx	TargetsApiContext

Returns

TargetsApi

Source

src/targets/index.ts:150

Accessors

system

get system(): RuntimeSystem

The detected host system used by resolve() when no system is supplied.

Returns

RuntimeSystem

Source

src/targets/index.ts:153

Methods

create()

create(input): Target

Build a Target from already-resolved components.

Parameters

Parameter	Type
input	TargetCreateInput

Returns

Target

Source

src/targets/index.ts:158

---

list()

list(input): Promise<readonly DiscoveredTarget[]>

Scan a root directory for Minecraft installations. Returns only what is on disk.

Parameters

Parameter	Type
input	TargetListInput

Returns

Promise<readonly DiscoveredTarget[]>

Source

src/targets/index.ts:250

---

resolve()

resolve(input): Promise<Target>

Sugar API: resolve every component then assemble a target.

Parameters

Parameter	Type
input	TargetResolveInput

Returns

Promise<Target>

Source

src/targets/index.ts:200