@loontail/minecraft-kit / TargetsApi

Class: TargetsApi

Defined in: src/targets/index.ts:150

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

Constructor

new TargetsApi(ctx): TargetsApi;

Defined in: src/targets/index.ts:151

Parameters

Parameter	Type
ctx	TargetsApiContext

Returns

TargetsApi

Accessors

system

Get Signature

get system(): RuntimeSystem;

Defined in: src/targets/index.ts:154

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

Returns

RuntimeSystem

Methods

create()

create(input): Target;

Defined in: src/targets/index.ts:159

Build a Target from already-resolved components.

Parameters

Parameter	Type
input	TargetCreateInput

Returns

Target

---

list()

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

Defined in: src/targets/index.ts:251

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

Parameters

Parameter	Type
input	TargetListInput

Returns

Promise<readonly DiscoveredTarget[]>

---

resolve()

resolve(input): Promise<Target>;

Defined in: src/targets/index.ts:201

Sugar API: resolve every component then assemble a target.

Parameters

Parameter	Type
input	TargetResolveInput

Returns

Promise<Target>